highcharts.src.d.ts 4.8 MB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963964965966967968969970971972973974975976977978979980981982983984985986987988989990991992993994995996997998999100010011002100310041005100610071008100910101011101210131014101510161017101810191020102110221023102410251026102710281029103010311032103310341035103610371038103910401041104210431044104510461047104810491050105110521053105410551056105710581059106010611062106310641065106610671068106910701071107210731074107510761077107810791080108110821083108410851086108710881089109010911092109310941095109610971098109911001101110211031104110511061107110811091110111111121113111411151116111711181119112011211122112311241125112611271128112911301131113211331134113511361137113811391140114111421143114411451146114711481149115011511152115311541155115611571158115911601161116211631164116511661167116811691170117111721173117411751176117711781179118011811182118311841185118611871188118911901191119211931194119511961197119811991200120112021203120412051206120712081209121012111212121312141215121612171218121912201221122212231224122512261227122812291230123112321233123412351236123712381239124012411242124312441245124612471248124912501251125212531254125512561257125812591260126112621263126412651266126712681269127012711272127312741275127612771278127912801281128212831284128512861287128812891290129112921293129412951296129712981299130013011302130313041305130613071308130913101311131213131314131513161317131813191320132113221323132413251326132713281329133013311332133313341335133613371338133913401341134213431344134513461347134813491350135113521353135413551356135713581359136013611362136313641365136613671368136913701371137213731374137513761377137813791380138113821383138413851386138713881389139013911392139313941395139613971398139914001401140214031404140514061407140814091410141114121413141414151416141714181419142014211422142314241425142614271428142914301431143214331434143514361437143814391440144114421443144414451446144714481449145014511452145314541455145614571458145914601461146214631464146514661467146814691470147114721473147414751476147714781479148014811482148314841485148614871488148914901491149214931494149514961497149814991500150115021503150415051506150715081509151015111512151315141515151615171518151915201521152215231524152515261527152815291530153115321533153415351536153715381539154015411542154315441545154615471548154915501551155215531554155515561557155815591560156115621563156415651566156715681569157015711572157315741575157615771578157915801581158215831584158515861587158815891590159115921593159415951596159715981599160016011602160316041605160616071608160916101611161216131614161516161617161816191620162116221623162416251626162716281629163016311632163316341635163616371638163916401641164216431644164516461647164816491650165116521653165416551656165716581659166016611662166316641665166616671668166916701671167216731674167516761677167816791680168116821683168416851686168716881689169016911692169316941695169616971698169917001701170217031704170517061707170817091710171117121713171417151716171717181719172017211722172317241725172617271728172917301731173217331734173517361737173817391740174117421743174417451746174717481749175017511752175317541755175617571758175917601761176217631764176517661767176817691770177117721773177417751776177717781779178017811782178317841785178617871788178917901791179217931794179517961797179817991800180118021803180418051806180718081809181018111812181318141815181618171818181918201821182218231824182518261827182818291830183118321833183418351836183718381839184018411842184318441845184618471848184918501851185218531854185518561857185818591860186118621863186418651866186718681869187018711872187318741875187618771878187918801881188218831884188518861887188818891890189118921893189418951896189718981899190019011902190319041905190619071908190919101911191219131914191519161917191819191920192119221923192419251926192719281929193019311932193319341935193619371938193919401941194219431944194519461947194819491950195119521953195419551956195719581959196019611962196319641965196619671968196919701971197219731974197519761977197819791980198119821983198419851986198719881989199019911992199319941995199619971998199920002001200220032004200520062007200820092010201120122013201420152016201720182019202020212022202320242025202620272028202920302031203220332034203520362037203820392040204120422043204420452046204720482049205020512052205320542055205620572058205920602061206220632064206520662067206820692070207120722073207420752076207720782079208020812082208320842085208620872088208920902091209220932094209520962097209820992100210121022103210421052106210721082109211021112112211321142115211621172118211921202121212221232124212521262127212821292130213121322133213421352136213721382139214021412142214321442145214621472148214921502151215221532154215521562157215821592160216121622163216421652166216721682169217021712172217321742175217621772178217921802181218221832184218521862187218821892190219121922193219421952196219721982199220022012202220322042205220622072208220922102211221222132214221522162217221822192220222122222223222422252226222722282229223022312232223322342235223622372238223922402241224222432244224522462247224822492250225122522253225422552256225722582259226022612262226322642265226622672268226922702271227222732274227522762277227822792280228122822283228422852286228722882289229022912292229322942295229622972298229923002301230223032304230523062307230823092310231123122313231423152316231723182319232023212322232323242325232623272328232923302331233223332334233523362337233823392340234123422343234423452346234723482349235023512352235323542355235623572358235923602361236223632364236523662367236823692370237123722373237423752376237723782379238023812382238323842385238623872388238923902391239223932394239523962397239823992400240124022403240424052406240724082409241024112412241324142415241624172418241924202421242224232424242524262427242824292430243124322433243424352436243724382439244024412442244324442445244624472448244924502451245224532454245524562457245824592460246124622463246424652466246724682469247024712472247324742475247624772478247924802481248224832484248524862487248824892490249124922493249424952496249724982499250025012502250325042505250625072508250925102511251225132514251525162517251825192520252125222523252425252526252725282529253025312532253325342535253625372538253925402541254225432544254525462547254825492550255125522553255425552556255725582559256025612562256325642565256625672568256925702571257225732574257525762577257825792580258125822583258425852586258725882589259025912592259325942595259625972598259926002601260226032604260526062607260826092610261126122613261426152616261726182619262026212622262326242625262626272628262926302631263226332634263526362637263826392640264126422643264426452646264726482649265026512652265326542655265626572658265926602661266226632664266526662667266826692670267126722673267426752676267726782679268026812682268326842685268626872688268926902691269226932694269526962697269826992700270127022703270427052706270727082709271027112712271327142715271627172718271927202721272227232724272527262727272827292730273127322733273427352736273727382739274027412742274327442745274627472748274927502751275227532754275527562757275827592760276127622763276427652766276727682769277027712772277327742775277627772778277927802781278227832784278527862787278827892790279127922793279427952796279727982799280028012802280328042805280628072808280928102811281228132814281528162817281828192820282128222823282428252826282728282829283028312832283328342835283628372838283928402841284228432844284528462847284828492850285128522853285428552856285728582859286028612862286328642865286628672868286928702871287228732874287528762877287828792880288128822883288428852886288728882889289028912892289328942895289628972898289929002901290229032904290529062907290829092910291129122913291429152916291729182919292029212922292329242925292629272928292929302931293229332934293529362937293829392940294129422943294429452946294729482949295029512952295329542955295629572958295929602961296229632964296529662967296829692970297129722973297429752976297729782979298029812982298329842985298629872988298929902991299229932994299529962997299829993000300130023003300430053006300730083009301030113012301330143015301630173018301930203021302230233024302530263027302830293030303130323033303430353036303730383039304030413042304330443045304630473048304930503051305230533054305530563057305830593060306130623063306430653066306730683069307030713072307330743075307630773078307930803081308230833084308530863087308830893090309130923093309430953096309730983099310031013102310331043105310631073108310931103111311231133114311531163117311831193120312131223123312431253126312731283129313031313132313331343135313631373138313931403141314231433144314531463147314831493150315131523153315431553156315731583159316031613162316331643165316631673168316931703171317231733174317531763177317831793180318131823183318431853186318731883189319031913192319331943195319631973198319932003201320232033204320532063207320832093210321132123213321432153216321732183219322032213222322332243225322632273228322932303231323232333234323532363237323832393240324132423243324432453246324732483249325032513252325332543255325632573258325932603261326232633264326532663267326832693270327132723273327432753276327732783279328032813282328332843285328632873288328932903291329232933294329532963297329832993300330133023303330433053306330733083309331033113312331333143315331633173318331933203321332233233324332533263327332833293330333133323333333433353336333733383339334033413342334333443345334633473348334933503351335233533354335533563357335833593360336133623363336433653366336733683369337033713372337333743375337633773378337933803381338233833384338533863387338833893390339133923393339433953396339733983399340034013402340334043405340634073408340934103411341234133414341534163417341834193420342134223423342434253426342734283429343034313432343334343435343634373438343934403441344234433444344534463447344834493450345134523453345434553456345734583459346034613462346334643465346634673468346934703471347234733474347534763477347834793480348134823483348434853486348734883489349034913492349334943495349634973498349935003501350235033504350535063507350835093510351135123513351435153516351735183519352035213522352335243525352635273528352935303531353235333534353535363537353835393540354135423543354435453546354735483549355035513552355335543555355635573558355935603561356235633564356535663567356835693570357135723573357435753576357735783579358035813582358335843585358635873588358935903591359235933594359535963597359835993600360136023603360436053606360736083609361036113612361336143615361636173618361936203621362236233624362536263627362836293630363136323633363436353636363736383639364036413642364336443645364636473648364936503651365236533654365536563657365836593660366136623663366436653666366736683669367036713672367336743675367636773678367936803681368236833684368536863687368836893690369136923693369436953696369736983699370037013702370337043705370637073708370937103711371237133714371537163717371837193720372137223723372437253726372737283729373037313732373337343735373637373738373937403741374237433744374537463747374837493750375137523753375437553756375737583759376037613762376337643765376637673768376937703771377237733774377537763777377837793780378137823783378437853786378737883789379037913792379337943795379637973798379938003801380238033804380538063807380838093810381138123813381438153816381738183819382038213822382338243825382638273828382938303831383238333834383538363837383838393840384138423843384438453846384738483849385038513852385338543855385638573858385938603861386238633864386538663867386838693870387138723873387438753876387738783879388038813882388338843885388638873888388938903891389238933894389538963897389838993900390139023903390439053906390739083909391039113912391339143915391639173918391939203921392239233924392539263927392839293930393139323933393439353936393739383939394039413942394339443945394639473948394939503951395239533954395539563957395839593960396139623963396439653966396739683969397039713972397339743975397639773978397939803981398239833984398539863987398839893990399139923993399439953996399739983999400040014002400340044005400640074008400940104011401240134014401540164017401840194020402140224023402440254026402740284029403040314032403340344035403640374038403940404041404240434044404540464047404840494050405140524053405440554056405740584059406040614062406340644065406640674068406940704071407240734074407540764077407840794080408140824083408440854086408740884089409040914092409340944095409640974098409941004101410241034104410541064107410841094110411141124113411441154116411741184119412041214122412341244125412641274128412941304131413241334134413541364137413841394140414141424143414441454146414741484149415041514152415341544155415641574158415941604161416241634164416541664167416841694170417141724173417441754176417741784179418041814182418341844185418641874188418941904191419241934194419541964197419841994200420142024203420442054206420742084209421042114212421342144215421642174218421942204221422242234224422542264227422842294230423142324233423442354236423742384239424042414242424342444245424642474248424942504251425242534254425542564257425842594260426142624263426442654266426742684269427042714272427342744275427642774278427942804281428242834284428542864287428842894290429142924293429442954296429742984299430043014302430343044305430643074308430943104311431243134314431543164317431843194320432143224323432443254326432743284329433043314332433343344335433643374338433943404341434243434344434543464347434843494350435143524353435443554356435743584359436043614362436343644365436643674368436943704371437243734374437543764377437843794380438143824383438443854386438743884389439043914392439343944395439643974398439944004401440244034404440544064407440844094410441144124413441444154416441744184419442044214422442344244425442644274428442944304431443244334434443544364437443844394440444144424443444444454446444744484449445044514452445344544455445644574458445944604461446244634464446544664467446844694470447144724473447444754476447744784479448044814482448344844485448644874488448944904491449244934494449544964497449844994500450145024503450445054506450745084509451045114512451345144515451645174518451945204521452245234524452545264527452845294530453145324533453445354536453745384539454045414542454345444545454645474548454945504551455245534554455545564557455845594560456145624563456445654566456745684569457045714572457345744575457645774578457945804581458245834584458545864587458845894590459145924593459445954596459745984599460046014602460346044605460646074608460946104611461246134614461546164617461846194620462146224623462446254626462746284629463046314632463346344635463646374638463946404641464246434644464546464647464846494650465146524653465446554656465746584659466046614662466346644665466646674668466946704671467246734674467546764677467846794680468146824683468446854686468746884689469046914692469346944695469646974698469947004701470247034704470547064707470847094710471147124713471447154716471747184719472047214722472347244725472647274728472947304731473247334734473547364737473847394740474147424743474447454746474747484749475047514752475347544755475647574758475947604761476247634764476547664767476847694770477147724773477447754776477747784779478047814782478347844785478647874788478947904791479247934794479547964797479847994800480148024803480448054806480748084809481048114812481348144815481648174818481948204821482248234824482548264827482848294830483148324833483448354836483748384839484048414842484348444845484648474848484948504851485248534854485548564857485848594860486148624863486448654866486748684869487048714872487348744875487648774878487948804881488248834884488548864887488848894890489148924893489448954896489748984899490049014902490349044905490649074908490949104911491249134914491549164917491849194920492149224923492449254926492749284929493049314932493349344935493649374938493949404941494249434944494549464947494849494950495149524953495449554956495749584959496049614962496349644965496649674968496949704971497249734974497549764977497849794980498149824983498449854986498749884989499049914992499349944995499649974998499950005001500250035004500550065007500850095010501150125013501450155016501750185019502050215022502350245025502650275028502950305031503250335034503550365037503850395040504150425043504450455046504750485049505050515052505350545055505650575058505950605061506250635064506550665067506850695070507150725073507450755076507750785079508050815082508350845085508650875088508950905091509250935094509550965097509850995100510151025103510451055106510751085109511051115112511351145115511651175118511951205121512251235124512551265127512851295130513151325133513451355136513751385139514051415142514351445145514651475148514951505151515251535154515551565157515851595160516151625163516451655166516751685169517051715172517351745175517651775178517951805181518251835184518551865187518851895190519151925193519451955196519751985199520052015202520352045205520652075208520952105211521252135214521552165217521852195220522152225223522452255226522752285229523052315232523352345235523652375238523952405241524252435244524552465247524852495250525152525253525452555256525752585259526052615262526352645265526652675268526952705271527252735274527552765277527852795280528152825283528452855286528752885289529052915292529352945295529652975298529953005301530253035304530553065307530853095310531153125313531453155316531753185319532053215322532353245325532653275328532953305331533253335334533553365337533853395340534153425343534453455346534753485349535053515352535353545355535653575358535953605361536253635364536553665367536853695370537153725373537453755376537753785379538053815382538353845385538653875388538953905391539253935394539553965397539853995400540154025403540454055406540754085409541054115412541354145415541654175418541954205421542254235424542554265427542854295430543154325433543454355436543754385439544054415442544354445445544654475448544954505451545254535454545554565457545854595460546154625463546454655466546754685469547054715472547354745475547654775478547954805481548254835484548554865487548854895490549154925493549454955496549754985499550055015502550355045505550655075508550955105511551255135514551555165517551855195520552155225523552455255526552755285529553055315532553355345535553655375538553955405541554255435544554555465547554855495550555155525553555455555556555755585559556055615562556355645565556655675568556955705571557255735574557555765577557855795580558155825583558455855586558755885589559055915592559355945595559655975598559956005601560256035604560556065607560856095610561156125613561456155616561756185619562056215622562356245625562656275628562956305631563256335634563556365637563856395640564156425643564456455646564756485649565056515652565356545655565656575658565956605661566256635664566556665667566856695670567156725673567456755676567756785679568056815682568356845685568656875688568956905691569256935694569556965697569856995700570157025703570457055706570757085709571057115712571357145715571657175718571957205721572257235724572557265727572857295730573157325733573457355736573757385739574057415742574357445745574657475748574957505751575257535754575557565757575857595760576157625763576457655766576757685769577057715772577357745775577657775778577957805781578257835784578557865787578857895790579157925793579457955796579757985799580058015802580358045805580658075808580958105811581258135814581558165817581858195820582158225823582458255826582758285829583058315832583358345835583658375838583958405841584258435844584558465847584858495850585158525853585458555856585758585859586058615862586358645865586658675868586958705871587258735874587558765877587858795880588158825883588458855886588758885889589058915892589358945895589658975898589959005901590259035904590559065907590859095910591159125913591459155916591759185919592059215922592359245925592659275928592959305931593259335934593559365937593859395940594159425943594459455946594759485949595059515952595359545955595659575958595959605961596259635964596559665967596859695970597159725973597459755976597759785979598059815982598359845985598659875988598959905991599259935994599559965997599859996000600160026003600460056006600760086009601060116012601360146015601660176018601960206021602260236024602560266027602860296030603160326033603460356036603760386039604060416042604360446045604660476048604960506051605260536054605560566057605860596060606160626063606460656066606760686069607060716072607360746075607660776078607960806081608260836084608560866087608860896090609160926093609460956096609760986099610061016102610361046105610661076108610961106111611261136114611561166117611861196120612161226123612461256126612761286129613061316132613361346135613661376138613961406141614261436144614561466147614861496150615161526153615461556156615761586159616061616162616361646165616661676168616961706171617261736174617561766177617861796180618161826183618461856186618761886189619061916192619361946195619661976198619962006201620262036204620562066207620862096210621162126213621462156216621762186219622062216222622362246225622662276228622962306231623262336234623562366237623862396240624162426243624462456246624762486249625062516252625362546255625662576258625962606261626262636264626562666267626862696270627162726273627462756276627762786279628062816282628362846285628662876288628962906291629262936294629562966297629862996300630163026303630463056306630763086309631063116312631363146315631663176318631963206321632263236324632563266327632863296330633163326333633463356336633763386339634063416342634363446345634663476348634963506351635263536354635563566357635863596360636163626363636463656366636763686369637063716372637363746375637663776378637963806381638263836384638563866387638863896390639163926393639463956396639763986399640064016402640364046405640664076408640964106411641264136414641564166417641864196420642164226423642464256426642764286429643064316432643364346435643664376438643964406441644264436444644564466447644864496450645164526453645464556456645764586459646064616462646364646465646664676468646964706471647264736474647564766477647864796480648164826483648464856486648764886489649064916492649364946495649664976498649965006501650265036504650565066507650865096510651165126513651465156516651765186519652065216522652365246525652665276528652965306531653265336534653565366537653865396540654165426543654465456546654765486549655065516552655365546555655665576558655965606561656265636564656565666567656865696570657165726573657465756576657765786579658065816582658365846585658665876588658965906591659265936594659565966597659865996600660166026603660466056606660766086609661066116612661366146615661666176618661966206621662266236624662566266627662866296630663166326633663466356636663766386639664066416642664366446645664666476648664966506651665266536654665566566657665866596660666166626663666466656666666766686669667066716672667366746675667666776678667966806681668266836684668566866687668866896690669166926693669466956696669766986699670067016702670367046705670667076708670967106711671267136714671567166717671867196720672167226723672467256726672767286729673067316732673367346735673667376738673967406741674267436744674567466747674867496750675167526753675467556756675767586759676067616762676367646765676667676768676967706771677267736774677567766777677867796780678167826783678467856786678767886789679067916792679367946795679667976798679968006801680268036804680568066807680868096810681168126813681468156816681768186819682068216822682368246825682668276828682968306831683268336834683568366837683868396840684168426843684468456846684768486849685068516852685368546855685668576858685968606861686268636864686568666867686868696870687168726873687468756876687768786879688068816882688368846885688668876888688968906891689268936894689568966897689868996900690169026903690469056906690769086909691069116912691369146915691669176918691969206921692269236924692569266927692869296930693169326933693469356936693769386939694069416942694369446945694669476948694969506951695269536954695569566957695869596960696169626963696469656966696769686969697069716972697369746975697669776978697969806981698269836984698569866987698869896990699169926993699469956996699769986999700070017002700370047005700670077008700970107011701270137014701570167017701870197020702170227023702470257026702770287029703070317032703370347035703670377038703970407041704270437044704570467047704870497050705170527053705470557056705770587059706070617062706370647065706670677068706970707071707270737074707570767077707870797080708170827083708470857086708770887089709070917092709370947095709670977098709971007101710271037104710571067107710871097110711171127113711471157116711771187119712071217122712371247125712671277128712971307131713271337134713571367137713871397140714171427143714471457146714771487149715071517152715371547155715671577158715971607161716271637164716571667167716871697170717171727173717471757176717771787179718071817182718371847185718671877188718971907191719271937194719571967197719871997200720172027203720472057206720772087209721072117212721372147215721672177218721972207221722272237224722572267227722872297230723172327233723472357236723772387239724072417242724372447245724672477248724972507251725272537254725572567257725872597260726172627263726472657266726772687269727072717272727372747275727672777278727972807281728272837284728572867287728872897290729172927293729472957296729772987299730073017302730373047305730673077308730973107311731273137314731573167317731873197320732173227323732473257326732773287329733073317332733373347335733673377338733973407341734273437344734573467347734873497350735173527353735473557356735773587359736073617362736373647365736673677368736973707371737273737374737573767377737873797380738173827383738473857386738773887389739073917392739373947395739673977398739974007401740274037404740574067407740874097410741174127413741474157416741774187419742074217422742374247425742674277428742974307431743274337434743574367437743874397440744174427443744474457446744774487449745074517452745374547455745674577458745974607461746274637464746574667467746874697470747174727473747474757476747774787479748074817482748374847485748674877488748974907491749274937494749574967497749874997500750175027503750475057506750775087509751075117512751375147515751675177518751975207521752275237524752575267527752875297530753175327533753475357536753775387539754075417542754375447545754675477548754975507551755275537554755575567557755875597560756175627563756475657566756775687569757075717572757375747575757675777578757975807581758275837584758575867587758875897590759175927593759475957596759775987599760076017602760376047605760676077608760976107611761276137614761576167617761876197620762176227623762476257626762776287629763076317632763376347635763676377638763976407641764276437644764576467647764876497650765176527653765476557656765776587659766076617662766376647665766676677668766976707671767276737674767576767677767876797680768176827683768476857686768776887689769076917692769376947695769676977698769977007701770277037704770577067707770877097710771177127713771477157716771777187719772077217722772377247725772677277728772977307731773277337734773577367737773877397740774177427743774477457746774777487749775077517752775377547755775677577758775977607761776277637764776577667767776877697770777177727773777477757776777777787779778077817782778377847785778677877788778977907791779277937794779577967797779877997800780178027803780478057806780778087809781078117812781378147815781678177818781978207821782278237824782578267827782878297830783178327833783478357836783778387839784078417842784378447845784678477848784978507851785278537854785578567857785878597860786178627863786478657866786778687869787078717872787378747875787678777878787978807881788278837884788578867887788878897890789178927893789478957896789778987899790079017902790379047905790679077908790979107911791279137914791579167917791879197920792179227923792479257926792779287929793079317932793379347935793679377938793979407941794279437944794579467947794879497950795179527953795479557956795779587959796079617962796379647965796679677968796979707971797279737974797579767977797879797980798179827983798479857986798779887989799079917992799379947995799679977998799980008001800280038004800580068007800880098010801180128013801480158016801780188019802080218022802380248025802680278028802980308031803280338034803580368037803880398040804180428043804480458046804780488049805080518052805380548055805680578058805980608061806280638064806580668067806880698070807180728073807480758076807780788079808080818082808380848085808680878088808980908091809280938094809580968097809880998100810181028103810481058106810781088109811081118112811381148115811681178118811981208121812281238124812581268127812881298130813181328133813481358136813781388139814081418142814381448145814681478148814981508151815281538154815581568157815881598160816181628163816481658166816781688169817081718172817381748175817681778178817981808181818281838184818581868187818881898190819181928193819481958196819781988199820082018202820382048205820682078208820982108211821282138214821582168217821882198220822182228223822482258226822782288229823082318232823382348235823682378238823982408241824282438244824582468247824882498250825182528253825482558256825782588259826082618262826382648265826682678268826982708271827282738274827582768277827882798280828182828283828482858286828782888289829082918292829382948295829682978298829983008301830283038304830583068307830883098310831183128313831483158316831783188319832083218322832383248325832683278328832983308331833283338334833583368337833883398340834183428343834483458346834783488349835083518352835383548355835683578358835983608361836283638364836583668367836883698370837183728373837483758376837783788379838083818382838383848385838683878388838983908391839283938394839583968397839883998400840184028403840484058406840784088409841084118412841384148415841684178418841984208421842284238424842584268427842884298430843184328433843484358436843784388439844084418442844384448445844684478448844984508451845284538454845584568457845884598460846184628463846484658466846784688469847084718472847384748475847684778478847984808481848284838484848584868487848884898490849184928493849484958496849784988499850085018502850385048505850685078508850985108511851285138514851585168517851885198520852185228523852485258526852785288529853085318532853385348535853685378538853985408541854285438544854585468547854885498550855185528553855485558556855785588559856085618562856385648565856685678568856985708571857285738574857585768577857885798580858185828583858485858586858785888589859085918592859385948595859685978598859986008601860286038604860586068607860886098610861186128613861486158616861786188619862086218622862386248625862686278628862986308631863286338634863586368637863886398640864186428643864486458646864786488649865086518652865386548655865686578658865986608661866286638664866586668667866886698670867186728673867486758676867786788679868086818682868386848685868686878688868986908691869286938694869586968697869886998700870187028703870487058706870787088709871087118712871387148715871687178718871987208721872287238724872587268727872887298730873187328733873487358736873787388739874087418742874387448745874687478748874987508751875287538754875587568757875887598760876187628763876487658766876787688769877087718772877387748775877687778778877987808781878287838784878587868787878887898790879187928793879487958796879787988799880088018802880388048805880688078808880988108811881288138814881588168817881888198820882188228823882488258826882788288829883088318832883388348835883688378838883988408841884288438844884588468847884888498850885188528853885488558856885788588859886088618862886388648865886688678868886988708871887288738874887588768877887888798880888188828883888488858886888788888889889088918892889388948895889688978898889989008901890289038904890589068907890889098910891189128913891489158916891789188919892089218922892389248925892689278928892989308931893289338934893589368937893889398940894189428943894489458946894789488949895089518952895389548955895689578958895989608961896289638964896589668967896889698970897189728973897489758976897789788979898089818982898389848985898689878988898989908991899289938994899589968997899889999000900190029003900490059006900790089009901090119012901390149015901690179018901990209021902290239024902590269027902890299030903190329033903490359036903790389039904090419042904390449045904690479048904990509051905290539054905590569057905890599060906190629063906490659066906790689069907090719072907390749075907690779078907990809081908290839084908590869087908890899090909190929093909490959096909790989099910091019102910391049105910691079108910991109111911291139114911591169117911891199120912191229123912491259126912791289129913091319132913391349135913691379138913991409141914291439144914591469147914891499150915191529153915491559156915791589159916091619162916391649165916691679168916991709171917291739174917591769177917891799180918191829183918491859186918791889189919091919192919391949195919691979198919992009201920292039204920592069207920892099210921192129213921492159216921792189219922092219222922392249225922692279228922992309231923292339234923592369237923892399240924192429243924492459246924792489249925092519252925392549255925692579258925992609261926292639264926592669267926892699270927192729273927492759276927792789279928092819282928392849285928692879288928992909291929292939294929592969297929892999300930193029303930493059306930793089309931093119312931393149315931693179318931993209321932293239324932593269327932893299330933193329333933493359336933793389339934093419342934393449345934693479348934993509351935293539354935593569357935893599360936193629363936493659366936793689369937093719372937393749375937693779378937993809381938293839384938593869387938893899390939193929393939493959396939793989399940094019402940394049405940694079408940994109411941294139414941594169417941894199420942194229423942494259426942794289429943094319432943394349435943694379438943994409441944294439444944594469447944894499450945194529453945494559456945794589459946094619462946394649465946694679468946994709471947294739474947594769477947894799480948194829483948494859486948794889489949094919492949394949495949694979498949995009501950295039504950595069507950895099510951195129513951495159516951795189519952095219522952395249525952695279528952995309531953295339534953595369537953895399540954195429543954495459546954795489549955095519552955395549555955695579558955995609561956295639564956595669567956895699570957195729573957495759576957795789579958095819582958395849585958695879588958995909591959295939594959595969597959895999600960196029603960496059606960796089609961096119612961396149615961696179618961996209621962296239624962596269627962896299630963196329633963496359636963796389639964096419642964396449645964696479648964996509651965296539654965596569657965896599660966196629663966496659666966796689669967096719672967396749675967696779678967996809681968296839684968596869687968896899690969196929693969496959696969796989699970097019702970397049705970697079708970997109711971297139714971597169717971897199720972197229723972497259726972797289729973097319732973397349735973697379738973997409741974297439744974597469747974897499750975197529753975497559756975797589759976097619762976397649765976697679768976997709771977297739774977597769777977897799780978197829783978497859786978797889789979097919792979397949795979697979798979998009801980298039804980598069807980898099810981198129813981498159816981798189819982098219822982398249825982698279828982998309831983298339834983598369837983898399840984198429843984498459846984798489849985098519852985398549855985698579858985998609861986298639864986598669867986898699870987198729873987498759876987798789879988098819882988398849885988698879888988998909891989298939894989598969897989898999900990199029903990499059906990799089909991099119912991399149915991699179918991999209921992299239924992599269927992899299930993199329933993499359936993799389939994099419942994399449945994699479948994999509951995299539954995599569957995899599960996199629963996499659966996799689969997099719972997399749975997699779978997999809981998299839984998599869987998899899990999199929993999499959996999799989999100001000110002100031000410005100061000710008100091001010011100121001310014100151001610017100181001910020100211002210023100241002510026100271002810029100301003110032100331003410035100361003710038100391004010041100421004310044100451004610047100481004910050100511005210053100541005510056100571005810059100601006110062100631006410065100661006710068100691007010071100721007310074100751007610077100781007910080100811008210083100841008510086100871008810089100901009110092100931009410095100961009710098100991010010101101021010310104101051010610107101081010910110101111011210113101141011510116101171011810119101201012110122101231012410125101261012710128101291013010131101321013310134101351013610137101381013910140101411014210143101441014510146101471014810149101501015110152101531015410155101561015710158101591016010161101621016310164101651016610167101681016910170101711017210173101741017510176101771017810179101801018110182101831018410185101861018710188101891019010191101921019310194101951019610197101981019910200102011020210203102041020510206102071020810209102101021110212102131021410215102161021710218102191022010221102221022310224102251022610227102281022910230102311023210233102341023510236102371023810239102401024110242102431024410245102461024710248102491025010251102521025310254102551025610257102581025910260102611026210263102641026510266102671026810269102701027110272102731027410275102761027710278102791028010281102821028310284102851028610287102881028910290102911029210293102941029510296102971029810299103001030110302103031030410305103061030710308103091031010311103121031310314103151031610317103181031910320103211032210323103241032510326103271032810329103301033110332103331033410335103361033710338103391034010341103421034310344103451034610347103481034910350103511035210353103541035510356103571035810359103601036110362103631036410365103661036710368103691037010371103721037310374103751037610377103781037910380103811038210383103841038510386103871038810389103901039110392103931039410395103961039710398103991040010401104021040310404104051040610407104081040910410104111041210413104141041510416104171041810419104201042110422104231042410425104261042710428104291043010431104321043310434104351043610437104381043910440104411044210443104441044510446104471044810449104501045110452104531045410455104561045710458104591046010461104621046310464104651046610467104681046910470104711047210473104741047510476104771047810479104801048110482104831048410485104861048710488104891049010491104921049310494104951049610497104981049910500105011050210503105041050510506105071050810509105101051110512105131051410515105161051710518105191052010521105221052310524105251052610527105281052910530105311053210533105341053510536105371053810539105401054110542105431054410545105461054710548105491055010551105521055310554105551055610557105581055910560105611056210563105641056510566105671056810569105701057110572105731057410575105761057710578105791058010581105821058310584105851058610587105881058910590105911059210593105941059510596105971059810599106001060110602106031060410605106061060710608106091061010611106121061310614106151061610617106181061910620106211062210623106241062510626106271062810629106301063110632106331063410635106361063710638106391064010641106421064310644106451064610647106481064910650106511065210653106541065510656106571065810659106601066110662106631066410665106661066710668106691067010671106721067310674106751067610677106781067910680106811068210683106841068510686106871068810689106901069110692106931069410695106961069710698106991070010701107021070310704107051070610707107081070910710107111071210713107141071510716107171071810719107201072110722107231072410725107261072710728107291073010731107321073310734107351073610737107381073910740107411074210743107441074510746107471074810749107501075110752107531075410755107561075710758107591076010761107621076310764107651076610767107681076910770107711077210773107741077510776107771077810779107801078110782107831078410785107861078710788107891079010791107921079310794107951079610797107981079910800108011080210803108041080510806108071080810809108101081110812108131081410815108161081710818108191082010821108221082310824108251082610827108281082910830108311083210833108341083510836108371083810839108401084110842108431084410845108461084710848108491085010851108521085310854108551085610857108581085910860108611086210863108641086510866108671086810869108701087110872108731087410875108761087710878108791088010881108821088310884108851088610887108881088910890108911089210893108941089510896108971089810899109001090110902109031090410905109061090710908109091091010911109121091310914109151091610917109181091910920109211092210923109241092510926109271092810929109301093110932109331093410935109361093710938109391094010941109421094310944109451094610947109481094910950109511095210953109541095510956109571095810959109601096110962109631096410965109661096710968109691097010971109721097310974109751097610977109781097910980109811098210983109841098510986109871098810989109901099110992109931099410995109961099710998109991100011001110021100311004110051100611007110081100911010110111101211013110141101511016110171101811019110201102111022110231102411025110261102711028110291103011031110321103311034110351103611037110381103911040110411104211043110441104511046110471104811049110501105111052110531105411055110561105711058110591106011061110621106311064110651106611067110681106911070110711107211073110741107511076110771107811079110801108111082110831108411085110861108711088110891109011091110921109311094110951109611097110981109911100111011110211103111041110511106111071110811109111101111111112111131111411115111161111711118111191112011121111221112311124111251112611127111281112911130111311113211133111341113511136111371113811139111401114111142111431114411145111461114711148111491115011151111521115311154111551115611157111581115911160111611116211163111641116511166111671116811169111701117111172111731117411175111761117711178111791118011181111821118311184111851118611187111881118911190111911119211193111941119511196111971119811199112001120111202112031120411205112061120711208112091121011211112121121311214112151121611217112181121911220112211122211223112241122511226112271122811229112301123111232112331123411235112361123711238112391124011241112421124311244112451124611247112481124911250112511125211253112541125511256112571125811259112601126111262112631126411265112661126711268112691127011271112721127311274112751127611277112781127911280112811128211283112841128511286112871128811289112901129111292112931129411295112961129711298112991130011301113021130311304113051130611307113081130911310113111131211313113141131511316113171131811319113201132111322113231132411325113261132711328113291133011331113321133311334113351133611337113381133911340113411134211343113441134511346113471134811349113501135111352113531135411355113561135711358113591136011361113621136311364113651136611367113681136911370113711137211373113741137511376113771137811379113801138111382113831138411385113861138711388113891139011391113921139311394113951139611397113981139911400114011140211403114041140511406114071140811409114101141111412114131141411415114161141711418114191142011421114221142311424114251142611427114281142911430114311143211433114341143511436114371143811439114401144111442114431144411445114461144711448114491145011451114521145311454114551145611457114581145911460114611146211463114641146511466114671146811469114701147111472114731147411475114761147711478114791148011481114821148311484114851148611487114881148911490114911149211493114941149511496114971149811499115001150111502115031150411505115061150711508115091151011511115121151311514115151151611517115181151911520115211152211523115241152511526115271152811529115301153111532115331153411535115361153711538115391154011541115421154311544115451154611547115481154911550115511155211553115541155511556115571155811559115601156111562115631156411565115661156711568115691157011571115721157311574115751157611577115781157911580115811158211583115841158511586115871158811589115901159111592115931159411595115961159711598115991160011601116021160311604116051160611607116081160911610116111161211613116141161511616116171161811619116201162111622116231162411625116261162711628116291163011631116321163311634116351163611637116381163911640116411164211643116441164511646116471164811649116501165111652116531165411655116561165711658116591166011661116621166311664116651166611667116681166911670116711167211673116741167511676116771167811679116801168111682116831168411685116861168711688116891169011691116921169311694116951169611697116981169911700117011170211703117041170511706117071170811709117101171111712117131171411715117161171711718117191172011721117221172311724117251172611727117281172911730117311173211733117341173511736117371173811739117401174111742117431174411745117461174711748117491175011751117521175311754117551175611757117581175911760117611176211763117641176511766117671176811769117701177111772117731177411775117761177711778117791178011781117821178311784117851178611787117881178911790117911179211793117941179511796117971179811799118001180111802118031180411805118061180711808118091181011811118121181311814118151181611817118181181911820118211182211823118241182511826118271182811829118301183111832118331183411835118361183711838118391184011841118421184311844118451184611847118481184911850118511185211853118541185511856118571185811859118601186111862118631186411865118661186711868118691187011871118721187311874118751187611877118781187911880118811188211883118841188511886118871188811889118901189111892118931189411895118961189711898118991190011901119021190311904119051190611907119081190911910119111191211913119141191511916119171191811919119201192111922119231192411925119261192711928119291193011931119321193311934119351193611937119381193911940119411194211943119441194511946119471194811949119501195111952119531195411955119561195711958119591196011961119621196311964119651196611967119681196911970119711197211973119741197511976119771197811979119801198111982119831198411985119861198711988119891199011991119921199311994119951199611997119981199912000120011200212003120041200512006120071200812009120101201112012120131201412015120161201712018120191202012021120221202312024120251202612027120281202912030120311203212033120341203512036120371203812039120401204112042120431204412045120461204712048120491205012051120521205312054120551205612057120581205912060120611206212063120641206512066120671206812069120701207112072120731207412075120761207712078120791208012081120821208312084120851208612087120881208912090120911209212093120941209512096120971209812099121001210112102121031210412105121061210712108121091211012111121121211312114121151211612117121181211912120121211212212123121241212512126121271212812129121301213112132121331213412135121361213712138121391214012141121421214312144121451214612147121481214912150121511215212153121541215512156121571215812159121601216112162121631216412165121661216712168121691217012171121721217312174121751217612177121781217912180121811218212183121841218512186121871218812189121901219112192121931219412195121961219712198121991220012201122021220312204122051220612207122081220912210122111221212213122141221512216122171221812219122201222112222122231222412225122261222712228122291223012231122321223312234122351223612237122381223912240122411224212243122441224512246122471224812249122501225112252122531225412255122561225712258122591226012261122621226312264122651226612267122681226912270122711227212273122741227512276122771227812279122801228112282122831228412285122861228712288122891229012291122921229312294122951229612297122981229912300123011230212303123041230512306123071230812309123101231112312123131231412315123161231712318123191232012321123221232312324123251232612327123281232912330123311233212333123341233512336123371233812339123401234112342123431234412345123461234712348123491235012351123521235312354123551235612357123581235912360123611236212363123641236512366123671236812369123701237112372123731237412375123761237712378123791238012381123821238312384123851238612387123881238912390123911239212393123941239512396123971239812399124001240112402124031240412405124061240712408124091241012411124121241312414124151241612417124181241912420124211242212423124241242512426124271242812429124301243112432124331243412435124361243712438124391244012441124421244312444124451244612447124481244912450124511245212453124541245512456124571245812459124601246112462124631246412465124661246712468124691247012471124721247312474124751247612477124781247912480124811248212483124841248512486124871248812489124901249112492124931249412495124961249712498124991250012501125021250312504125051250612507125081250912510125111251212513125141251512516125171251812519125201252112522125231252412525125261252712528125291253012531125321253312534125351253612537125381253912540125411254212543125441254512546125471254812549125501255112552125531255412555125561255712558125591256012561125621256312564125651256612567125681256912570125711257212573125741257512576125771257812579125801258112582125831258412585125861258712588125891259012591125921259312594125951259612597125981259912600126011260212603126041260512606126071260812609126101261112612126131261412615126161261712618126191262012621126221262312624126251262612627126281262912630126311263212633126341263512636126371263812639126401264112642126431264412645126461264712648126491265012651126521265312654126551265612657126581265912660126611266212663126641266512666126671266812669126701267112672126731267412675126761267712678126791268012681126821268312684126851268612687126881268912690126911269212693126941269512696126971269812699127001270112702127031270412705127061270712708127091271012711127121271312714127151271612717127181271912720127211272212723127241272512726127271272812729127301273112732127331273412735127361273712738127391274012741127421274312744127451274612747127481274912750127511275212753127541275512756127571275812759127601276112762127631276412765127661276712768127691277012771127721277312774127751277612777127781277912780127811278212783127841278512786127871278812789127901279112792127931279412795127961279712798127991280012801128021280312804128051280612807128081280912810128111281212813128141281512816128171281812819128201282112822128231282412825128261282712828128291283012831128321283312834128351283612837128381283912840128411284212843128441284512846128471284812849128501285112852128531285412855128561285712858128591286012861128621286312864128651286612867128681286912870128711287212873128741287512876128771287812879128801288112882128831288412885128861288712888128891289012891128921289312894128951289612897128981289912900129011290212903129041290512906129071290812909129101291112912129131291412915129161291712918129191292012921129221292312924129251292612927129281292912930129311293212933129341293512936129371293812939129401294112942129431294412945129461294712948129491295012951129521295312954129551295612957129581295912960129611296212963129641296512966129671296812969129701297112972129731297412975129761297712978129791298012981129821298312984129851298612987129881298912990129911299212993129941299512996129971299812999130001300113002130031300413005130061300713008130091301013011130121301313014130151301613017130181301913020130211302213023130241302513026130271302813029130301303113032130331303413035130361303713038130391304013041130421304313044130451304613047130481304913050130511305213053130541305513056130571305813059130601306113062130631306413065130661306713068130691307013071130721307313074130751307613077130781307913080130811308213083130841308513086130871308813089130901309113092130931309413095130961309713098130991310013101131021310313104131051310613107131081310913110131111311213113131141311513116131171311813119131201312113122131231312413125131261312713128131291313013131131321313313134131351313613137131381313913140131411314213143131441314513146131471314813149131501315113152131531315413155131561315713158131591316013161131621316313164131651316613167131681316913170131711317213173131741317513176131771317813179131801318113182131831318413185131861318713188131891319013191131921319313194131951319613197131981319913200132011320213203132041320513206132071320813209132101321113212132131321413215132161321713218132191322013221132221322313224132251322613227132281322913230132311323213233132341323513236132371323813239132401324113242132431324413245132461324713248132491325013251132521325313254132551325613257132581325913260132611326213263132641326513266132671326813269132701327113272132731327413275132761327713278132791328013281132821328313284132851328613287132881328913290132911329213293132941329513296132971329813299133001330113302133031330413305133061330713308133091331013311133121331313314133151331613317133181331913320133211332213323133241332513326133271332813329133301333113332133331333413335133361333713338133391334013341133421334313344133451334613347133481334913350133511335213353133541335513356133571335813359133601336113362133631336413365133661336713368133691337013371133721337313374133751337613377133781337913380133811338213383133841338513386133871338813389133901339113392133931339413395133961339713398133991340013401134021340313404134051340613407134081340913410134111341213413134141341513416134171341813419134201342113422134231342413425134261342713428134291343013431134321343313434134351343613437134381343913440134411344213443134441344513446134471344813449134501345113452134531345413455134561345713458134591346013461134621346313464134651346613467134681346913470134711347213473134741347513476134771347813479134801348113482134831348413485134861348713488134891349013491134921349313494134951349613497134981349913500135011350213503135041350513506135071350813509135101351113512135131351413515135161351713518135191352013521135221352313524135251352613527135281352913530135311353213533135341353513536135371353813539135401354113542135431354413545135461354713548135491355013551135521355313554135551355613557135581355913560135611356213563135641356513566135671356813569135701357113572135731357413575135761357713578135791358013581135821358313584135851358613587135881358913590135911359213593135941359513596135971359813599136001360113602136031360413605136061360713608136091361013611136121361313614136151361613617136181361913620136211362213623136241362513626136271362813629136301363113632136331363413635136361363713638136391364013641136421364313644136451364613647136481364913650136511365213653136541365513656136571365813659136601366113662136631366413665136661366713668136691367013671136721367313674136751367613677136781367913680136811368213683136841368513686136871368813689136901369113692136931369413695136961369713698136991370013701137021370313704137051370613707137081370913710137111371213713137141371513716137171371813719137201372113722137231372413725137261372713728137291373013731137321373313734137351373613737137381373913740137411374213743137441374513746137471374813749137501375113752137531375413755137561375713758137591376013761137621376313764137651376613767137681376913770137711377213773137741377513776137771377813779137801378113782137831378413785137861378713788137891379013791137921379313794137951379613797137981379913800138011380213803138041380513806138071380813809138101381113812138131381413815138161381713818138191382013821138221382313824138251382613827138281382913830138311383213833138341383513836138371383813839138401384113842138431384413845138461384713848138491385013851138521385313854138551385613857138581385913860138611386213863138641386513866138671386813869138701387113872138731387413875138761387713878138791388013881138821388313884138851388613887138881388913890138911389213893138941389513896138971389813899139001390113902139031390413905139061390713908139091391013911139121391313914139151391613917139181391913920139211392213923139241392513926139271392813929139301393113932139331393413935139361393713938139391394013941139421394313944139451394613947139481394913950139511395213953139541395513956139571395813959139601396113962139631396413965139661396713968139691397013971139721397313974139751397613977139781397913980139811398213983139841398513986139871398813989139901399113992139931399413995139961399713998139991400014001140021400314004140051400614007140081400914010140111401214013140141401514016140171401814019140201402114022140231402414025140261402714028140291403014031140321403314034140351403614037140381403914040140411404214043140441404514046140471404814049140501405114052140531405414055140561405714058140591406014061140621406314064140651406614067140681406914070140711407214073140741407514076140771407814079140801408114082140831408414085140861408714088140891409014091140921409314094140951409614097140981409914100141011410214103141041410514106141071410814109141101411114112141131411414115141161411714118141191412014121141221412314124141251412614127141281412914130141311413214133141341413514136141371413814139141401414114142141431414414145141461414714148141491415014151141521415314154141551415614157141581415914160141611416214163141641416514166141671416814169141701417114172141731417414175141761417714178141791418014181141821418314184141851418614187141881418914190141911419214193141941419514196141971419814199142001420114202142031420414205142061420714208142091421014211142121421314214142151421614217142181421914220142211422214223142241422514226142271422814229142301423114232142331423414235142361423714238142391424014241142421424314244142451424614247142481424914250142511425214253142541425514256142571425814259142601426114262142631426414265142661426714268142691427014271142721427314274142751427614277142781427914280142811428214283142841428514286142871428814289142901429114292142931429414295142961429714298142991430014301143021430314304143051430614307143081430914310143111431214313143141431514316143171431814319143201432114322143231432414325143261432714328143291433014331143321433314334143351433614337143381433914340143411434214343143441434514346143471434814349143501435114352143531435414355143561435714358143591436014361143621436314364143651436614367143681436914370143711437214373143741437514376143771437814379143801438114382143831438414385143861438714388143891439014391143921439314394143951439614397143981439914400144011440214403144041440514406144071440814409144101441114412144131441414415144161441714418144191442014421144221442314424144251442614427144281442914430144311443214433144341443514436144371443814439144401444114442144431444414445144461444714448144491445014451144521445314454144551445614457144581445914460144611446214463144641446514466144671446814469144701447114472144731447414475144761447714478144791448014481144821448314484144851448614487144881448914490144911449214493144941449514496144971449814499145001450114502145031450414505145061450714508145091451014511145121451314514145151451614517145181451914520145211452214523145241452514526145271452814529145301453114532145331453414535145361453714538145391454014541145421454314544145451454614547145481454914550145511455214553145541455514556145571455814559145601456114562145631456414565145661456714568145691457014571145721457314574145751457614577145781457914580145811458214583145841458514586145871458814589145901459114592145931459414595145961459714598145991460014601146021460314604146051460614607146081460914610146111461214613146141461514616146171461814619146201462114622146231462414625146261462714628146291463014631146321463314634146351463614637146381463914640146411464214643146441464514646146471464814649146501465114652146531465414655146561465714658146591466014661146621466314664146651466614667146681466914670146711467214673146741467514676146771467814679146801468114682146831468414685146861468714688146891469014691146921469314694146951469614697146981469914700147011470214703147041470514706147071470814709147101471114712147131471414715147161471714718147191472014721147221472314724147251472614727147281472914730147311473214733147341473514736147371473814739147401474114742147431474414745147461474714748147491475014751147521475314754147551475614757147581475914760147611476214763147641476514766147671476814769147701477114772147731477414775147761477714778147791478014781147821478314784147851478614787147881478914790147911479214793147941479514796147971479814799148001480114802148031480414805148061480714808148091481014811148121481314814148151481614817148181481914820148211482214823148241482514826148271482814829148301483114832148331483414835148361483714838148391484014841148421484314844148451484614847148481484914850148511485214853148541485514856148571485814859148601486114862148631486414865148661486714868148691487014871148721487314874148751487614877148781487914880148811488214883148841488514886148871488814889148901489114892148931489414895148961489714898148991490014901149021490314904149051490614907149081490914910149111491214913149141491514916149171491814919149201492114922149231492414925149261492714928149291493014931149321493314934149351493614937149381493914940149411494214943149441494514946149471494814949149501495114952149531495414955149561495714958149591496014961149621496314964149651496614967149681496914970149711497214973149741497514976149771497814979149801498114982149831498414985149861498714988149891499014991149921499314994149951499614997149981499915000150011500215003150041500515006150071500815009150101501115012150131501415015150161501715018150191502015021150221502315024150251502615027150281502915030150311503215033150341503515036150371503815039150401504115042150431504415045150461504715048150491505015051150521505315054150551505615057150581505915060150611506215063150641506515066150671506815069150701507115072150731507415075150761507715078150791508015081150821508315084150851508615087150881508915090150911509215093150941509515096150971509815099151001510115102151031510415105151061510715108151091511015111151121511315114151151511615117151181511915120151211512215123151241512515126151271512815129151301513115132151331513415135151361513715138151391514015141151421514315144151451514615147151481514915150151511515215153151541515515156151571515815159151601516115162151631516415165151661516715168151691517015171151721517315174151751517615177151781517915180151811518215183151841518515186151871518815189151901519115192151931519415195151961519715198151991520015201152021520315204152051520615207152081520915210152111521215213152141521515216152171521815219152201522115222152231522415225152261522715228152291523015231152321523315234152351523615237152381523915240152411524215243152441524515246152471524815249152501525115252152531525415255152561525715258152591526015261152621526315264152651526615267152681526915270152711527215273152741527515276152771527815279152801528115282152831528415285152861528715288152891529015291152921529315294152951529615297152981529915300153011530215303153041530515306153071530815309153101531115312153131531415315153161531715318153191532015321153221532315324153251532615327153281532915330153311533215333153341533515336153371533815339153401534115342153431534415345153461534715348153491535015351153521535315354153551535615357153581535915360153611536215363153641536515366153671536815369153701537115372153731537415375153761537715378153791538015381153821538315384153851538615387153881538915390153911539215393153941539515396153971539815399154001540115402154031540415405154061540715408154091541015411154121541315414154151541615417154181541915420154211542215423154241542515426154271542815429154301543115432154331543415435154361543715438154391544015441154421544315444154451544615447154481544915450154511545215453154541545515456154571545815459154601546115462154631546415465154661546715468154691547015471154721547315474154751547615477154781547915480154811548215483154841548515486154871548815489154901549115492154931549415495154961549715498154991550015501155021550315504155051550615507155081550915510155111551215513155141551515516155171551815519155201552115522155231552415525155261552715528155291553015531155321553315534155351553615537155381553915540155411554215543155441554515546155471554815549155501555115552155531555415555155561555715558155591556015561155621556315564155651556615567155681556915570155711557215573155741557515576155771557815579155801558115582155831558415585155861558715588155891559015591155921559315594155951559615597155981559915600156011560215603156041560515606156071560815609156101561115612156131561415615156161561715618156191562015621156221562315624156251562615627156281562915630156311563215633156341563515636156371563815639156401564115642156431564415645156461564715648156491565015651156521565315654156551565615657156581565915660156611566215663156641566515666156671566815669156701567115672156731567415675156761567715678156791568015681156821568315684156851568615687156881568915690156911569215693156941569515696156971569815699157001570115702157031570415705157061570715708157091571015711157121571315714157151571615717157181571915720157211572215723157241572515726157271572815729157301573115732157331573415735157361573715738157391574015741157421574315744157451574615747157481574915750157511575215753157541575515756157571575815759157601576115762157631576415765157661576715768157691577015771157721577315774157751577615777157781577915780157811578215783157841578515786157871578815789157901579115792157931579415795157961579715798157991580015801158021580315804158051580615807158081580915810158111581215813158141581515816158171581815819158201582115822158231582415825158261582715828158291583015831158321583315834158351583615837158381583915840158411584215843158441584515846158471584815849158501585115852158531585415855158561585715858158591586015861158621586315864158651586615867158681586915870158711587215873158741587515876158771587815879158801588115882158831588415885158861588715888158891589015891158921589315894158951589615897158981589915900159011590215903159041590515906159071590815909159101591115912159131591415915159161591715918159191592015921159221592315924159251592615927159281592915930159311593215933159341593515936159371593815939159401594115942159431594415945159461594715948159491595015951159521595315954159551595615957159581595915960159611596215963159641596515966159671596815969159701597115972159731597415975159761597715978159791598015981159821598315984159851598615987159881598915990159911599215993159941599515996159971599815999160001600116002160031600416005160061600716008160091601016011160121601316014160151601616017160181601916020160211602216023160241602516026160271602816029160301603116032160331603416035160361603716038160391604016041160421604316044160451604616047160481604916050160511605216053160541605516056160571605816059160601606116062160631606416065160661606716068160691607016071160721607316074160751607616077160781607916080160811608216083160841608516086160871608816089160901609116092160931609416095160961609716098160991610016101161021610316104161051610616107161081610916110161111611216113161141611516116161171611816119161201612116122161231612416125161261612716128161291613016131161321613316134161351613616137161381613916140161411614216143161441614516146161471614816149161501615116152161531615416155161561615716158161591616016161161621616316164161651616616167161681616916170161711617216173161741617516176161771617816179161801618116182161831618416185161861618716188161891619016191161921619316194161951619616197161981619916200162011620216203162041620516206162071620816209162101621116212162131621416215162161621716218162191622016221162221622316224162251622616227162281622916230162311623216233162341623516236162371623816239162401624116242162431624416245162461624716248162491625016251162521625316254162551625616257162581625916260162611626216263162641626516266162671626816269162701627116272162731627416275162761627716278162791628016281162821628316284162851628616287162881628916290162911629216293162941629516296162971629816299163001630116302163031630416305163061630716308163091631016311163121631316314163151631616317163181631916320163211632216323163241632516326163271632816329163301633116332163331633416335163361633716338163391634016341163421634316344163451634616347163481634916350163511635216353163541635516356163571635816359163601636116362163631636416365163661636716368163691637016371163721637316374163751637616377163781637916380163811638216383163841638516386163871638816389163901639116392163931639416395163961639716398163991640016401164021640316404164051640616407164081640916410164111641216413164141641516416164171641816419164201642116422164231642416425164261642716428164291643016431164321643316434164351643616437164381643916440164411644216443164441644516446164471644816449164501645116452164531645416455164561645716458164591646016461164621646316464164651646616467164681646916470164711647216473164741647516476164771647816479164801648116482164831648416485164861648716488164891649016491164921649316494164951649616497164981649916500165011650216503165041650516506165071650816509165101651116512165131651416515165161651716518165191652016521165221652316524165251652616527165281652916530165311653216533165341653516536165371653816539165401654116542165431654416545165461654716548165491655016551165521655316554165551655616557165581655916560165611656216563165641656516566165671656816569165701657116572165731657416575165761657716578165791658016581165821658316584165851658616587165881658916590165911659216593165941659516596165971659816599166001660116602166031660416605166061660716608166091661016611166121661316614166151661616617166181661916620166211662216623166241662516626166271662816629166301663116632166331663416635166361663716638166391664016641166421664316644166451664616647166481664916650166511665216653166541665516656166571665816659166601666116662166631666416665166661666716668166691667016671166721667316674166751667616677166781667916680166811668216683166841668516686166871668816689166901669116692166931669416695166961669716698166991670016701167021670316704167051670616707167081670916710167111671216713167141671516716167171671816719167201672116722167231672416725167261672716728167291673016731167321673316734167351673616737167381673916740167411674216743167441674516746167471674816749167501675116752167531675416755167561675716758167591676016761167621676316764167651676616767167681676916770167711677216773167741677516776167771677816779167801678116782167831678416785167861678716788167891679016791167921679316794167951679616797167981679916800168011680216803168041680516806168071680816809168101681116812168131681416815168161681716818168191682016821168221682316824168251682616827168281682916830168311683216833168341683516836168371683816839168401684116842168431684416845168461684716848168491685016851168521685316854168551685616857168581685916860168611686216863168641686516866168671686816869168701687116872168731687416875168761687716878168791688016881168821688316884168851688616887168881688916890168911689216893168941689516896168971689816899169001690116902169031690416905169061690716908169091691016911169121691316914169151691616917169181691916920169211692216923169241692516926169271692816929169301693116932169331693416935169361693716938169391694016941169421694316944169451694616947169481694916950169511695216953169541695516956169571695816959169601696116962169631696416965169661696716968169691697016971169721697316974169751697616977169781697916980169811698216983169841698516986169871698816989169901699116992169931699416995169961699716998169991700017001170021700317004170051700617007170081700917010170111701217013170141701517016170171701817019170201702117022170231702417025170261702717028170291703017031170321703317034170351703617037170381703917040170411704217043170441704517046170471704817049170501705117052170531705417055170561705717058170591706017061170621706317064170651706617067170681706917070170711707217073170741707517076170771707817079170801708117082170831708417085170861708717088170891709017091170921709317094170951709617097170981709917100171011710217103171041710517106171071710817109171101711117112171131711417115171161711717118171191712017121171221712317124171251712617127171281712917130171311713217133171341713517136171371713817139171401714117142171431714417145171461714717148171491715017151171521715317154171551715617157171581715917160171611716217163171641716517166171671716817169171701717117172171731717417175171761717717178171791718017181171821718317184171851718617187171881718917190171911719217193171941719517196171971719817199172001720117202172031720417205172061720717208172091721017211172121721317214172151721617217172181721917220172211722217223172241722517226172271722817229172301723117232172331723417235172361723717238172391724017241172421724317244172451724617247172481724917250172511725217253172541725517256172571725817259172601726117262172631726417265172661726717268172691727017271172721727317274172751727617277172781727917280172811728217283172841728517286172871728817289172901729117292172931729417295172961729717298172991730017301173021730317304173051730617307173081730917310173111731217313173141731517316173171731817319173201732117322173231732417325173261732717328173291733017331173321733317334173351733617337173381733917340173411734217343173441734517346173471734817349173501735117352173531735417355173561735717358173591736017361173621736317364173651736617367173681736917370173711737217373173741737517376173771737817379173801738117382173831738417385173861738717388173891739017391173921739317394173951739617397173981739917400174011740217403174041740517406174071740817409174101741117412174131741417415174161741717418174191742017421174221742317424174251742617427174281742917430174311743217433174341743517436174371743817439174401744117442174431744417445174461744717448174491745017451174521745317454174551745617457174581745917460174611746217463174641746517466174671746817469174701747117472174731747417475174761747717478174791748017481174821748317484174851748617487174881748917490174911749217493174941749517496174971749817499175001750117502175031750417505175061750717508175091751017511175121751317514175151751617517175181751917520175211752217523175241752517526175271752817529175301753117532175331753417535175361753717538175391754017541175421754317544175451754617547175481754917550175511755217553175541755517556175571755817559175601756117562175631756417565175661756717568175691757017571175721757317574175751757617577175781757917580175811758217583175841758517586175871758817589175901759117592175931759417595175961759717598175991760017601176021760317604176051760617607176081760917610176111761217613176141761517616176171761817619176201762117622176231762417625176261762717628176291763017631176321763317634176351763617637176381763917640176411764217643176441764517646176471764817649176501765117652176531765417655176561765717658176591766017661176621766317664176651766617667176681766917670176711767217673176741767517676176771767817679176801768117682176831768417685176861768717688176891769017691176921769317694176951769617697176981769917700177011770217703177041770517706177071770817709177101771117712177131771417715177161771717718177191772017721177221772317724177251772617727177281772917730177311773217733177341773517736177371773817739177401774117742177431774417745177461774717748177491775017751177521775317754177551775617757177581775917760177611776217763177641776517766177671776817769177701777117772177731777417775177761777717778177791778017781177821778317784177851778617787177881778917790177911779217793177941779517796177971779817799178001780117802178031780417805178061780717808178091781017811178121781317814178151781617817178181781917820178211782217823178241782517826178271782817829178301783117832178331783417835178361783717838178391784017841178421784317844178451784617847178481784917850178511785217853178541785517856178571785817859178601786117862178631786417865178661786717868178691787017871178721787317874178751787617877178781787917880178811788217883178841788517886178871788817889178901789117892178931789417895178961789717898178991790017901179021790317904179051790617907179081790917910179111791217913179141791517916179171791817919179201792117922179231792417925179261792717928179291793017931179321793317934179351793617937179381793917940179411794217943179441794517946179471794817949179501795117952179531795417955179561795717958179591796017961179621796317964179651796617967179681796917970179711797217973179741797517976179771797817979179801798117982179831798417985179861798717988179891799017991179921799317994179951799617997179981799918000180011800218003180041800518006180071800818009180101801118012180131801418015180161801718018180191802018021180221802318024180251802618027180281802918030180311803218033180341803518036180371803818039180401804118042180431804418045180461804718048180491805018051180521805318054180551805618057180581805918060180611806218063180641806518066180671806818069180701807118072180731807418075180761807718078180791808018081180821808318084180851808618087180881808918090180911809218093180941809518096180971809818099181001810118102181031810418105181061810718108181091811018111181121811318114181151811618117181181811918120181211812218123181241812518126181271812818129181301813118132181331813418135181361813718138181391814018141181421814318144181451814618147181481814918150181511815218153181541815518156181571815818159181601816118162181631816418165181661816718168181691817018171181721817318174181751817618177181781817918180181811818218183181841818518186181871818818189181901819118192181931819418195181961819718198181991820018201182021820318204182051820618207182081820918210182111821218213182141821518216182171821818219182201822118222182231822418225182261822718228182291823018231182321823318234182351823618237182381823918240182411824218243182441824518246182471824818249182501825118252182531825418255182561825718258182591826018261182621826318264182651826618267182681826918270182711827218273182741827518276182771827818279182801828118282182831828418285182861828718288182891829018291182921829318294182951829618297182981829918300183011830218303183041830518306183071830818309183101831118312183131831418315183161831718318183191832018321183221832318324183251832618327183281832918330183311833218333183341833518336183371833818339183401834118342183431834418345183461834718348183491835018351183521835318354183551835618357183581835918360183611836218363183641836518366183671836818369183701837118372183731837418375183761837718378183791838018381183821838318384183851838618387183881838918390183911839218393183941839518396183971839818399184001840118402184031840418405184061840718408184091841018411184121841318414184151841618417184181841918420184211842218423184241842518426184271842818429184301843118432184331843418435184361843718438184391844018441184421844318444184451844618447184481844918450184511845218453184541845518456184571845818459184601846118462184631846418465184661846718468184691847018471184721847318474184751847618477184781847918480184811848218483184841848518486184871848818489184901849118492184931849418495184961849718498184991850018501185021850318504185051850618507185081850918510185111851218513185141851518516185171851818519185201852118522185231852418525185261852718528185291853018531185321853318534185351853618537185381853918540185411854218543185441854518546185471854818549185501855118552185531855418555185561855718558185591856018561185621856318564185651856618567185681856918570185711857218573185741857518576185771857818579185801858118582185831858418585185861858718588185891859018591185921859318594185951859618597185981859918600186011860218603186041860518606186071860818609186101861118612186131861418615186161861718618186191862018621186221862318624186251862618627186281862918630186311863218633186341863518636186371863818639186401864118642186431864418645186461864718648186491865018651186521865318654186551865618657186581865918660186611866218663186641866518666186671866818669186701867118672186731867418675186761867718678186791868018681186821868318684186851868618687186881868918690186911869218693186941869518696186971869818699187001870118702187031870418705187061870718708187091871018711187121871318714187151871618717187181871918720187211872218723187241872518726187271872818729187301873118732187331873418735187361873718738187391874018741187421874318744187451874618747187481874918750187511875218753187541875518756187571875818759187601876118762187631876418765187661876718768187691877018771187721877318774187751877618777187781877918780187811878218783187841878518786187871878818789187901879118792187931879418795187961879718798187991880018801188021880318804188051880618807188081880918810188111881218813188141881518816188171881818819188201882118822188231882418825188261882718828188291883018831188321883318834188351883618837188381883918840188411884218843188441884518846188471884818849188501885118852188531885418855188561885718858188591886018861188621886318864188651886618867188681886918870188711887218873188741887518876188771887818879188801888118882188831888418885188861888718888188891889018891188921889318894188951889618897188981889918900189011890218903189041890518906189071890818909189101891118912189131891418915189161891718918189191892018921189221892318924189251892618927189281892918930189311893218933189341893518936189371893818939189401894118942189431894418945189461894718948189491895018951189521895318954189551895618957189581895918960189611896218963189641896518966189671896818969189701897118972189731897418975189761897718978189791898018981189821898318984189851898618987189881898918990189911899218993189941899518996189971899818999190001900119002190031900419005190061900719008190091901019011190121901319014190151901619017190181901919020190211902219023190241902519026190271902819029190301903119032190331903419035190361903719038190391904019041190421904319044190451904619047190481904919050190511905219053190541905519056190571905819059190601906119062190631906419065190661906719068190691907019071190721907319074190751907619077190781907919080190811908219083190841908519086190871908819089190901909119092190931909419095190961909719098190991910019101191021910319104191051910619107191081910919110191111911219113191141911519116191171911819119191201912119122191231912419125191261912719128191291913019131191321913319134191351913619137191381913919140191411914219143191441914519146191471914819149191501915119152191531915419155191561915719158191591916019161191621916319164191651916619167191681916919170191711917219173191741917519176191771917819179191801918119182191831918419185191861918719188191891919019191191921919319194191951919619197191981919919200192011920219203192041920519206192071920819209192101921119212192131921419215192161921719218192191922019221192221922319224192251922619227192281922919230192311923219233192341923519236192371923819239192401924119242192431924419245192461924719248192491925019251192521925319254192551925619257192581925919260192611926219263192641926519266192671926819269192701927119272192731927419275192761927719278192791928019281192821928319284192851928619287192881928919290192911929219293192941929519296192971929819299193001930119302193031930419305193061930719308193091931019311193121931319314193151931619317193181931919320193211932219323193241932519326193271932819329193301933119332193331933419335193361933719338193391934019341193421934319344193451934619347193481934919350193511935219353193541935519356193571935819359193601936119362193631936419365193661936719368193691937019371193721937319374193751937619377193781937919380193811938219383193841938519386193871938819389193901939119392193931939419395193961939719398193991940019401194021940319404194051940619407194081940919410194111941219413194141941519416194171941819419194201942119422194231942419425194261942719428194291943019431194321943319434194351943619437194381943919440194411944219443194441944519446194471944819449194501945119452194531945419455194561945719458194591946019461194621946319464194651946619467194681946919470194711947219473194741947519476194771947819479194801948119482194831948419485194861948719488194891949019491194921949319494194951949619497194981949919500195011950219503195041950519506195071950819509195101951119512195131951419515195161951719518195191952019521195221952319524195251952619527195281952919530195311953219533195341953519536195371953819539195401954119542195431954419545195461954719548195491955019551195521955319554195551955619557195581955919560195611956219563195641956519566195671956819569195701957119572195731957419575195761957719578195791958019581195821958319584195851958619587195881958919590195911959219593195941959519596195971959819599196001960119602196031960419605196061960719608196091961019611196121961319614196151961619617196181961919620196211962219623196241962519626196271962819629196301963119632196331963419635196361963719638196391964019641196421964319644196451964619647196481964919650196511965219653196541965519656196571965819659196601966119662196631966419665196661966719668196691967019671196721967319674196751967619677196781967919680196811968219683196841968519686196871968819689196901969119692196931969419695196961969719698196991970019701197021970319704197051970619707197081970919710197111971219713197141971519716197171971819719197201972119722197231972419725197261972719728197291973019731197321973319734197351973619737197381973919740197411974219743197441974519746197471974819749197501975119752197531975419755197561975719758197591976019761197621976319764197651976619767197681976919770197711977219773197741977519776197771977819779197801978119782197831978419785197861978719788197891979019791197921979319794197951979619797197981979919800198011980219803198041980519806198071980819809198101981119812198131981419815198161981719818198191982019821198221982319824198251982619827198281982919830198311983219833198341983519836198371983819839198401984119842198431984419845198461984719848198491985019851198521985319854198551985619857198581985919860198611986219863198641986519866198671986819869198701987119872198731987419875198761987719878198791988019881198821988319884198851988619887198881988919890198911989219893198941989519896198971989819899199001990119902199031990419905199061990719908199091991019911199121991319914199151991619917199181991919920199211992219923199241992519926199271992819929199301993119932199331993419935199361993719938199391994019941199421994319944199451994619947199481994919950199511995219953199541995519956199571995819959199601996119962199631996419965199661996719968199691997019971199721997319974199751997619977199781997919980199811998219983199841998519986199871998819989199901999119992199931999419995199961999719998199992000020001200022000320004200052000620007200082000920010200112001220013200142001520016200172001820019200202002120022200232002420025200262002720028200292003020031200322003320034200352003620037200382003920040200412004220043200442004520046200472004820049200502005120052200532005420055200562005720058200592006020061200622006320064200652006620067200682006920070200712007220073200742007520076200772007820079200802008120082200832008420085200862008720088200892009020091200922009320094200952009620097200982009920100201012010220103201042010520106201072010820109201102011120112201132011420115201162011720118201192012020121201222012320124201252012620127201282012920130201312013220133201342013520136201372013820139201402014120142201432014420145201462014720148201492015020151201522015320154201552015620157201582015920160201612016220163201642016520166201672016820169201702017120172201732017420175201762017720178201792018020181201822018320184201852018620187201882018920190201912019220193201942019520196201972019820199202002020120202202032020420205202062020720208202092021020211202122021320214202152021620217202182021920220202212022220223202242022520226202272022820229202302023120232202332023420235202362023720238202392024020241202422024320244202452024620247202482024920250202512025220253202542025520256202572025820259202602026120262202632026420265202662026720268202692027020271202722027320274202752027620277202782027920280202812028220283202842028520286202872028820289202902029120292202932029420295202962029720298202992030020301203022030320304203052030620307203082030920310203112031220313203142031520316203172031820319203202032120322203232032420325203262032720328203292033020331203322033320334203352033620337203382033920340203412034220343203442034520346203472034820349203502035120352203532035420355203562035720358203592036020361203622036320364203652036620367203682036920370203712037220373203742037520376203772037820379203802038120382203832038420385203862038720388203892039020391203922039320394203952039620397203982039920400204012040220403204042040520406204072040820409204102041120412204132041420415204162041720418204192042020421204222042320424204252042620427204282042920430204312043220433204342043520436204372043820439204402044120442204432044420445204462044720448204492045020451204522045320454204552045620457204582045920460204612046220463204642046520466204672046820469204702047120472204732047420475204762047720478204792048020481204822048320484204852048620487204882048920490204912049220493204942049520496204972049820499205002050120502205032050420505205062050720508205092051020511205122051320514205152051620517205182051920520205212052220523205242052520526205272052820529205302053120532205332053420535205362053720538205392054020541205422054320544205452054620547205482054920550205512055220553205542055520556205572055820559205602056120562205632056420565205662056720568205692057020571205722057320574205752057620577205782057920580205812058220583205842058520586205872058820589205902059120592205932059420595205962059720598205992060020601206022060320604206052060620607206082060920610206112061220613206142061520616206172061820619206202062120622206232062420625206262062720628206292063020631206322063320634206352063620637206382063920640206412064220643206442064520646206472064820649206502065120652206532065420655206562065720658206592066020661206622066320664206652066620667206682066920670206712067220673206742067520676206772067820679206802068120682206832068420685206862068720688206892069020691206922069320694206952069620697206982069920700207012070220703207042070520706207072070820709207102071120712207132071420715207162071720718207192072020721207222072320724207252072620727207282072920730207312073220733207342073520736207372073820739207402074120742207432074420745207462074720748207492075020751207522075320754207552075620757207582075920760207612076220763207642076520766207672076820769207702077120772207732077420775207762077720778207792078020781207822078320784207852078620787207882078920790207912079220793207942079520796207972079820799208002080120802208032080420805208062080720808208092081020811208122081320814208152081620817208182081920820208212082220823208242082520826208272082820829208302083120832208332083420835208362083720838208392084020841208422084320844208452084620847208482084920850208512085220853208542085520856208572085820859208602086120862208632086420865208662086720868208692087020871208722087320874208752087620877208782087920880208812088220883208842088520886208872088820889208902089120892208932089420895208962089720898208992090020901209022090320904209052090620907209082090920910209112091220913209142091520916209172091820919209202092120922209232092420925209262092720928209292093020931209322093320934209352093620937209382093920940209412094220943209442094520946209472094820949209502095120952209532095420955209562095720958209592096020961209622096320964209652096620967209682096920970209712097220973209742097520976209772097820979209802098120982209832098420985209862098720988209892099020991209922099320994209952099620997209982099921000210012100221003210042100521006210072100821009210102101121012210132101421015210162101721018210192102021021210222102321024210252102621027210282102921030210312103221033210342103521036210372103821039210402104121042210432104421045210462104721048210492105021051210522105321054210552105621057210582105921060210612106221063210642106521066210672106821069210702107121072210732107421075210762107721078210792108021081210822108321084210852108621087210882108921090210912109221093210942109521096210972109821099211002110121102211032110421105211062110721108211092111021111211122111321114211152111621117211182111921120211212112221123211242112521126211272112821129211302113121132211332113421135211362113721138211392114021141211422114321144211452114621147211482114921150211512115221153211542115521156211572115821159211602116121162211632116421165211662116721168211692117021171211722117321174211752117621177211782117921180211812118221183211842118521186211872118821189211902119121192211932119421195211962119721198211992120021201212022120321204212052120621207212082120921210212112121221213212142121521216212172121821219212202122121222212232122421225212262122721228212292123021231212322123321234212352123621237212382123921240212412124221243212442124521246212472124821249212502125121252212532125421255212562125721258212592126021261212622126321264212652126621267212682126921270212712127221273212742127521276212772127821279212802128121282212832128421285212862128721288212892129021291212922129321294212952129621297212982129921300213012130221303213042130521306213072130821309213102131121312213132131421315213162131721318213192132021321213222132321324213252132621327213282132921330213312133221333213342133521336213372133821339213402134121342213432134421345213462134721348213492135021351213522135321354213552135621357213582135921360213612136221363213642136521366213672136821369213702137121372213732137421375213762137721378213792138021381213822138321384213852138621387213882138921390213912139221393213942139521396213972139821399214002140121402214032140421405214062140721408214092141021411214122141321414214152141621417214182141921420214212142221423214242142521426214272142821429214302143121432214332143421435214362143721438214392144021441214422144321444214452144621447214482144921450214512145221453214542145521456214572145821459214602146121462214632146421465214662146721468214692147021471214722147321474214752147621477214782147921480214812148221483214842148521486214872148821489214902149121492214932149421495214962149721498214992150021501215022150321504215052150621507215082150921510215112151221513215142151521516215172151821519215202152121522215232152421525215262152721528215292153021531215322153321534215352153621537215382153921540215412154221543215442154521546215472154821549215502155121552215532155421555215562155721558215592156021561215622156321564215652156621567215682156921570215712157221573215742157521576215772157821579215802158121582215832158421585215862158721588215892159021591215922159321594215952159621597215982159921600216012160221603216042160521606216072160821609216102161121612216132161421615216162161721618216192162021621216222162321624216252162621627216282162921630216312163221633216342163521636216372163821639216402164121642216432164421645216462164721648216492165021651216522165321654216552165621657216582165921660216612166221663216642166521666216672166821669216702167121672216732167421675216762167721678216792168021681216822168321684216852168621687216882168921690216912169221693216942169521696216972169821699217002170121702217032170421705217062170721708217092171021711217122171321714217152171621717217182171921720217212172221723217242172521726217272172821729217302173121732217332173421735217362173721738217392174021741217422174321744217452174621747217482174921750217512175221753217542175521756217572175821759217602176121762217632176421765217662176721768217692177021771217722177321774217752177621777217782177921780217812178221783217842178521786217872178821789217902179121792217932179421795217962179721798217992180021801218022180321804218052180621807218082180921810218112181221813218142181521816218172181821819218202182121822218232182421825218262182721828218292183021831218322183321834218352183621837218382183921840218412184221843218442184521846218472184821849218502185121852218532185421855218562185721858218592186021861218622186321864218652186621867218682186921870218712187221873218742187521876218772187821879218802188121882218832188421885218862188721888218892189021891218922189321894218952189621897218982189921900219012190221903219042190521906219072190821909219102191121912219132191421915219162191721918219192192021921219222192321924219252192621927219282192921930219312193221933219342193521936219372193821939219402194121942219432194421945219462194721948219492195021951219522195321954219552195621957219582195921960219612196221963219642196521966219672196821969219702197121972219732197421975219762197721978219792198021981219822198321984219852198621987219882198921990219912199221993219942199521996219972199821999220002200122002220032200422005220062200722008220092201022011220122201322014220152201622017220182201922020220212202222023220242202522026220272202822029220302203122032220332203422035220362203722038220392204022041220422204322044220452204622047220482204922050220512205222053220542205522056220572205822059220602206122062220632206422065220662206722068220692207022071220722207322074220752207622077220782207922080220812208222083220842208522086220872208822089220902209122092220932209422095220962209722098220992210022101221022210322104221052210622107221082210922110221112211222113221142211522116221172211822119221202212122122221232212422125221262212722128221292213022131221322213322134221352213622137221382213922140221412214222143221442214522146221472214822149221502215122152221532215422155221562215722158221592216022161221622216322164221652216622167221682216922170221712217222173221742217522176221772217822179221802218122182221832218422185221862218722188221892219022191221922219322194221952219622197221982219922200222012220222203222042220522206222072220822209222102221122212222132221422215222162221722218222192222022221222222222322224222252222622227222282222922230222312223222233222342223522236222372223822239222402224122242222432224422245222462224722248222492225022251222522225322254222552225622257222582225922260222612226222263222642226522266222672226822269222702227122272222732227422275222762227722278222792228022281222822228322284222852228622287222882228922290222912229222293222942229522296222972229822299223002230122302223032230422305223062230722308223092231022311223122231322314223152231622317223182231922320223212232222323223242232522326223272232822329223302233122332223332233422335223362233722338223392234022341223422234322344223452234622347223482234922350223512235222353223542235522356223572235822359223602236122362223632236422365223662236722368223692237022371223722237322374223752237622377223782237922380223812238222383223842238522386223872238822389223902239122392223932239422395223962239722398223992240022401224022240322404224052240622407224082240922410224112241222413224142241522416224172241822419224202242122422224232242422425224262242722428224292243022431224322243322434224352243622437224382243922440224412244222443224442244522446224472244822449224502245122452224532245422455224562245722458224592246022461224622246322464224652246622467224682246922470224712247222473224742247522476224772247822479224802248122482224832248422485224862248722488224892249022491224922249322494224952249622497224982249922500225012250222503225042250522506225072250822509225102251122512225132251422515225162251722518225192252022521225222252322524225252252622527225282252922530225312253222533225342253522536225372253822539225402254122542225432254422545225462254722548225492255022551225522255322554225552255622557225582255922560225612256222563225642256522566225672256822569225702257122572225732257422575225762257722578225792258022581225822258322584225852258622587225882258922590225912259222593225942259522596225972259822599226002260122602226032260422605226062260722608226092261022611226122261322614226152261622617226182261922620226212262222623226242262522626226272262822629226302263122632226332263422635226362263722638226392264022641226422264322644226452264622647226482264922650226512265222653226542265522656226572265822659226602266122662226632266422665226662266722668226692267022671226722267322674226752267622677226782267922680226812268222683226842268522686226872268822689226902269122692226932269422695226962269722698226992270022701227022270322704227052270622707227082270922710227112271222713227142271522716227172271822719227202272122722227232272422725227262272722728227292273022731227322273322734227352273622737227382273922740227412274222743227442274522746227472274822749227502275122752227532275422755227562275722758227592276022761227622276322764227652276622767227682276922770227712277222773227742277522776227772277822779227802278122782227832278422785227862278722788227892279022791227922279322794227952279622797227982279922800228012280222803228042280522806228072280822809228102281122812228132281422815228162281722818228192282022821228222282322824228252282622827228282282922830228312283222833228342283522836228372283822839228402284122842228432284422845228462284722848228492285022851228522285322854228552285622857228582285922860228612286222863228642286522866228672286822869228702287122872228732287422875228762287722878228792288022881228822288322884228852288622887228882288922890228912289222893228942289522896228972289822899229002290122902229032290422905229062290722908229092291022911229122291322914229152291622917229182291922920229212292222923229242292522926229272292822929229302293122932229332293422935229362293722938229392294022941229422294322944229452294622947229482294922950229512295222953229542295522956229572295822959229602296122962229632296422965229662296722968229692297022971229722297322974229752297622977229782297922980229812298222983229842298522986229872298822989229902299122992229932299422995229962299722998229992300023001230022300323004230052300623007230082300923010230112301223013230142301523016230172301823019230202302123022230232302423025230262302723028230292303023031230322303323034230352303623037230382303923040230412304223043230442304523046230472304823049230502305123052230532305423055230562305723058230592306023061230622306323064230652306623067230682306923070230712307223073230742307523076230772307823079230802308123082230832308423085230862308723088230892309023091230922309323094230952309623097230982309923100231012310223103231042310523106231072310823109231102311123112231132311423115231162311723118231192312023121231222312323124231252312623127231282312923130231312313223133231342313523136231372313823139231402314123142231432314423145231462314723148231492315023151231522315323154231552315623157231582315923160231612316223163231642316523166231672316823169231702317123172231732317423175231762317723178231792318023181231822318323184231852318623187231882318923190231912319223193231942319523196231972319823199232002320123202232032320423205232062320723208232092321023211232122321323214232152321623217232182321923220232212322223223232242322523226232272322823229232302323123232232332323423235232362323723238232392324023241232422324323244232452324623247232482324923250232512325223253232542325523256232572325823259232602326123262232632326423265232662326723268232692327023271232722327323274232752327623277232782327923280232812328223283232842328523286232872328823289232902329123292232932329423295232962329723298232992330023301233022330323304233052330623307233082330923310233112331223313233142331523316233172331823319233202332123322233232332423325233262332723328233292333023331233322333323334233352333623337233382333923340233412334223343233442334523346233472334823349233502335123352233532335423355233562335723358233592336023361233622336323364233652336623367233682336923370233712337223373233742337523376233772337823379233802338123382233832338423385233862338723388233892339023391233922339323394233952339623397233982339923400234012340223403234042340523406234072340823409234102341123412234132341423415234162341723418234192342023421234222342323424234252342623427234282342923430234312343223433234342343523436234372343823439234402344123442234432344423445234462344723448234492345023451234522345323454234552345623457234582345923460234612346223463234642346523466234672346823469234702347123472234732347423475234762347723478234792348023481234822348323484234852348623487234882348923490234912349223493234942349523496234972349823499235002350123502235032350423505235062350723508235092351023511235122351323514235152351623517235182351923520235212352223523235242352523526235272352823529235302353123532235332353423535235362353723538235392354023541235422354323544235452354623547235482354923550235512355223553235542355523556235572355823559235602356123562235632356423565235662356723568235692357023571235722357323574235752357623577235782357923580235812358223583235842358523586235872358823589235902359123592235932359423595235962359723598235992360023601236022360323604236052360623607236082360923610236112361223613236142361523616236172361823619236202362123622236232362423625236262362723628236292363023631236322363323634236352363623637236382363923640236412364223643236442364523646236472364823649236502365123652236532365423655236562365723658236592366023661236622366323664236652366623667236682366923670236712367223673236742367523676236772367823679236802368123682236832368423685236862368723688236892369023691236922369323694236952369623697236982369923700237012370223703237042370523706237072370823709237102371123712237132371423715237162371723718237192372023721237222372323724237252372623727237282372923730237312373223733237342373523736237372373823739237402374123742237432374423745237462374723748237492375023751237522375323754237552375623757237582375923760237612376223763237642376523766237672376823769237702377123772237732377423775237762377723778237792378023781237822378323784237852378623787237882378923790237912379223793237942379523796237972379823799238002380123802238032380423805238062380723808238092381023811238122381323814238152381623817238182381923820238212382223823238242382523826238272382823829238302383123832238332383423835238362383723838238392384023841238422384323844238452384623847238482384923850238512385223853238542385523856238572385823859238602386123862238632386423865238662386723868238692387023871238722387323874238752387623877238782387923880238812388223883238842388523886238872388823889238902389123892238932389423895238962389723898238992390023901239022390323904239052390623907239082390923910239112391223913239142391523916239172391823919239202392123922239232392423925239262392723928239292393023931239322393323934239352393623937239382393923940239412394223943239442394523946239472394823949239502395123952239532395423955239562395723958239592396023961239622396323964239652396623967239682396923970239712397223973239742397523976239772397823979239802398123982239832398423985239862398723988239892399023991239922399323994239952399623997239982399924000240012400224003240042400524006240072400824009240102401124012240132401424015240162401724018240192402024021240222402324024240252402624027240282402924030240312403224033240342403524036240372403824039240402404124042240432404424045240462404724048240492405024051240522405324054240552405624057240582405924060240612406224063240642406524066240672406824069240702407124072240732407424075240762407724078240792408024081240822408324084240852408624087240882408924090240912409224093240942409524096240972409824099241002410124102241032410424105241062410724108241092411024111241122411324114241152411624117241182411924120241212412224123241242412524126241272412824129241302413124132241332413424135241362413724138241392414024141241422414324144241452414624147241482414924150241512415224153241542415524156241572415824159241602416124162241632416424165241662416724168241692417024171241722417324174241752417624177241782417924180241812418224183241842418524186241872418824189241902419124192241932419424195241962419724198241992420024201242022420324204242052420624207242082420924210242112421224213242142421524216242172421824219242202422124222242232422424225242262422724228242292423024231242322423324234242352423624237242382423924240242412424224243242442424524246242472424824249242502425124252242532425424255242562425724258242592426024261242622426324264242652426624267242682426924270242712427224273242742427524276242772427824279242802428124282242832428424285242862428724288242892429024291242922429324294242952429624297242982429924300243012430224303243042430524306243072430824309243102431124312243132431424315243162431724318243192432024321243222432324324243252432624327243282432924330243312433224333243342433524336243372433824339243402434124342243432434424345243462434724348243492435024351243522435324354243552435624357243582435924360243612436224363243642436524366243672436824369243702437124372243732437424375243762437724378243792438024381243822438324384243852438624387243882438924390243912439224393243942439524396243972439824399244002440124402244032440424405244062440724408244092441024411244122441324414244152441624417244182441924420244212442224423244242442524426244272442824429244302443124432244332443424435244362443724438244392444024441244422444324444244452444624447244482444924450244512445224453244542445524456244572445824459244602446124462244632446424465244662446724468244692447024471244722447324474244752447624477244782447924480244812448224483244842448524486244872448824489244902449124492244932449424495244962449724498244992450024501245022450324504245052450624507245082450924510245112451224513245142451524516245172451824519245202452124522245232452424525245262452724528245292453024531245322453324534245352453624537245382453924540245412454224543245442454524546245472454824549245502455124552245532455424555245562455724558245592456024561245622456324564245652456624567245682456924570245712457224573245742457524576245772457824579245802458124582245832458424585245862458724588245892459024591245922459324594245952459624597245982459924600246012460224603246042460524606246072460824609246102461124612246132461424615246162461724618246192462024621246222462324624246252462624627246282462924630246312463224633246342463524636246372463824639246402464124642246432464424645246462464724648246492465024651246522465324654246552465624657246582465924660246612466224663246642466524666246672466824669246702467124672246732467424675246762467724678246792468024681246822468324684246852468624687246882468924690246912469224693246942469524696246972469824699247002470124702247032470424705247062470724708247092471024711247122471324714247152471624717247182471924720247212472224723247242472524726247272472824729247302473124732247332473424735247362473724738247392474024741247422474324744247452474624747247482474924750247512475224753247542475524756247572475824759247602476124762247632476424765247662476724768247692477024771247722477324774247752477624777247782477924780247812478224783247842478524786247872478824789247902479124792247932479424795247962479724798247992480024801248022480324804248052480624807248082480924810248112481224813248142481524816248172481824819248202482124822248232482424825248262482724828248292483024831248322483324834248352483624837248382483924840248412484224843248442484524846248472484824849248502485124852248532485424855248562485724858248592486024861248622486324864248652486624867248682486924870248712487224873248742487524876248772487824879248802488124882248832488424885248862488724888248892489024891248922489324894248952489624897248982489924900249012490224903249042490524906249072490824909249102491124912249132491424915249162491724918249192492024921249222492324924249252492624927249282492924930249312493224933249342493524936249372493824939249402494124942249432494424945249462494724948249492495024951249522495324954249552495624957249582495924960249612496224963249642496524966249672496824969249702497124972249732497424975249762497724978249792498024981249822498324984249852498624987249882498924990249912499224993249942499524996249972499824999250002500125002250032500425005250062500725008250092501025011250122501325014250152501625017250182501925020250212502225023250242502525026250272502825029250302503125032250332503425035250362503725038250392504025041250422504325044250452504625047250482504925050250512505225053250542505525056250572505825059250602506125062250632506425065250662506725068250692507025071250722507325074250752507625077250782507925080250812508225083250842508525086250872508825089250902509125092250932509425095250962509725098250992510025101251022510325104251052510625107251082510925110251112511225113251142511525116251172511825119251202512125122251232512425125251262512725128251292513025131251322513325134251352513625137251382513925140251412514225143251442514525146251472514825149251502515125152251532515425155251562515725158251592516025161251622516325164251652516625167251682516925170251712517225173251742517525176251772517825179251802518125182251832518425185251862518725188251892519025191251922519325194251952519625197251982519925200252012520225203252042520525206252072520825209252102521125212252132521425215252162521725218252192522025221252222522325224252252522625227252282522925230252312523225233252342523525236252372523825239252402524125242252432524425245252462524725248252492525025251252522525325254252552525625257252582525925260252612526225263252642526525266252672526825269252702527125272252732527425275252762527725278252792528025281252822528325284252852528625287252882528925290252912529225293252942529525296252972529825299253002530125302253032530425305253062530725308253092531025311253122531325314253152531625317253182531925320253212532225323253242532525326253272532825329253302533125332253332533425335253362533725338253392534025341253422534325344253452534625347253482534925350253512535225353253542535525356253572535825359253602536125362253632536425365253662536725368253692537025371253722537325374253752537625377253782537925380253812538225383253842538525386253872538825389253902539125392253932539425395253962539725398253992540025401254022540325404254052540625407254082540925410254112541225413254142541525416254172541825419254202542125422254232542425425254262542725428254292543025431254322543325434254352543625437254382543925440254412544225443254442544525446254472544825449254502545125452254532545425455254562545725458254592546025461254622546325464254652546625467254682546925470254712547225473254742547525476254772547825479254802548125482254832548425485254862548725488254892549025491254922549325494254952549625497254982549925500255012550225503255042550525506255072550825509255102551125512255132551425515255162551725518255192552025521255222552325524255252552625527255282552925530255312553225533255342553525536255372553825539255402554125542255432554425545255462554725548255492555025551255522555325554255552555625557255582555925560255612556225563255642556525566255672556825569255702557125572255732557425575255762557725578255792558025581255822558325584255852558625587255882558925590255912559225593255942559525596255972559825599256002560125602256032560425605256062560725608256092561025611256122561325614256152561625617256182561925620256212562225623256242562525626256272562825629256302563125632256332563425635256362563725638256392564025641256422564325644256452564625647256482564925650256512565225653256542565525656256572565825659256602566125662256632566425665256662566725668256692567025671256722567325674256752567625677256782567925680256812568225683256842568525686256872568825689256902569125692256932569425695256962569725698256992570025701257022570325704257052570625707257082570925710257112571225713257142571525716257172571825719257202572125722257232572425725257262572725728257292573025731257322573325734257352573625737257382573925740257412574225743257442574525746257472574825749257502575125752257532575425755257562575725758257592576025761257622576325764257652576625767257682576925770257712577225773257742577525776257772577825779257802578125782257832578425785257862578725788257892579025791257922579325794257952579625797257982579925800258012580225803258042580525806258072580825809258102581125812258132581425815258162581725818258192582025821258222582325824258252582625827258282582925830258312583225833258342583525836258372583825839258402584125842258432584425845258462584725848258492585025851258522585325854258552585625857258582585925860258612586225863258642586525866258672586825869258702587125872258732587425875258762587725878258792588025881258822588325884258852588625887258882588925890258912589225893258942589525896258972589825899259002590125902259032590425905259062590725908259092591025911259122591325914259152591625917259182591925920259212592225923259242592525926259272592825929259302593125932259332593425935259362593725938259392594025941259422594325944259452594625947259482594925950259512595225953259542595525956259572595825959259602596125962259632596425965259662596725968259692597025971259722597325974259752597625977259782597925980259812598225983259842598525986259872598825989259902599125992259932599425995259962599725998259992600026001260022600326004260052600626007260082600926010260112601226013260142601526016260172601826019260202602126022260232602426025260262602726028260292603026031260322603326034260352603626037260382603926040260412604226043260442604526046260472604826049260502605126052260532605426055260562605726058260592606026061260622606326064260652606626067260682606926070260712607226073260742607526076260772607826079260802608126082260832608426085260862608726088260892609026091260922609326094260952609626097260982609926100261012610226103261042610526106261072610826109261102611126112261132611426115261162611726118261192612026121261222612326124261252612626127261282612926130261312613226133261342613526136261372613826139261402614126142261432614426145261462614726148261492615026151261522615326154261552615626157261582615926160261612616226163261642616526166261672616826169261702617126172261732617426175261762617726178261792618026181261822618326184261852618626187261882618926190261912619226193261942619526196261972619826199262002620126202262032620426205262062620726208262092621026211262122621326214262152621626217262182621926220262212622226223262242622526226262272622826229262302623126232262332623426235262362623726238262392624026241262422624326244262452624626247262482624926250262512625226253262542625526256262572625826259262602626126262262632626426265262662626726268262692627026271262722627326274262752627626277262782627926280262812628226283262842628526286262872628826289262902629126292262932629426295262962629726298262992630026301263022630326304263052630626307263082630926310263112631226313263142631526316263172631826319263202632126322263232632426325263262632726328263292633026331263322633326334263352633626337263382633926340263412634226343263442634526346263472634826349263502635126352263532635426355263562635726358263592636026361263622636326364263652636626367263682636926370263712637226373263742637526376263772637826379263802638126382263832638426385263862638726388263892639026391263922639326394263952639626397263982639926400264012640226403264042640526406264072640826409264102641126412264132641426415264162641726418264192642026421264222642326424264252642626427264282642926430264312643226433264342643526436264372643826439264402644126442264432644426445264462644726448264492645026451264522645326454264552645626457264582645926460264612646226463264642646526466264672646826469264702647126472264732647426475264762647726478264792648026481264822648326484264852648626487264882648926490264912649226493264942649526496264972649826499265002650126502265032650426505265062650726508265092651026511265122651326514265152651626517265182651926520265212652226523265242652526526265272652826529265302653126532265332653426535265362653726538265392654026541265422654326544265452654626547265482654926550265512655226553265542655526556265572655826559265602656126562265632656426565265662656726568265692657026571265722657326574265752657626577265782657926580265812658226583265842658526586265872658826589265902659126592265932659426595265962659726598265992660026601266022660326604266052660626607266082660926610266112661226613266142661526616266172661826619266202662126622266232662426625266262662726628266292663026631266322663326634266352663626637266382663926640266412664226643266442664526646266472664826649266502665126652266532665426655266562665726658266592666026661266622666326664266652666626667266682666926670266712667226673266742667526676266772667826679266802668126682266832668426685266862668726688266892669026691266922669326694266952669626697266982669926700267012670226703267042670526706267072670826709267102671126712267132671426715267162671726718267192672026721267222672326724267252672626727267282672926730267312673226733267342673526736267372673826739267402674126742267432674426745267462674726748267492675026751267522675326754267552675626757267582675926760267612676226763267642676526766267672676826769267702677126772267732677426775267762677726778267792678026781267822678326784267852678626787267882678926790267912679226793267942679526796267972679826799268002680126802268032680426805268062680726808268092681026811268122681326814268152681626817268182681926820268212682226823268242682526826268272682826829268302683126832268332683426835268362683726838268392684026841268422684326844268452684626847268482684926850268512685226853268542685526856268572685826859268602686126862268632686426865268662686726868268692687026871268722687326874268752687626877268782687926880268812688226883268842688526886268872688826889268902689126892268932689426895268962689726898268992690026901269022690326904269052690626907269082690926910269112691226913269142691526916269172691826919269202692126922269232692426925269262692726928269292693026931269322693326934269352693626937269382693926940269412694226943269442694526946269472694826949269502695126952269532695426955269562695726958269592696026961269622696326964269652696626967269682696926970269712697226973269742697526976269772697826979269802698126982269832698426985269862698726988269892699026991269922699326994269952699626997269982699927000270012700227003270042700527006270072700827009270102701127012270132701427015270162701727018270192702027021270222702327024270252702627027270282702927030270312703227033270342703527036270372703827039270402704127042270432704427045270462704727048270492705027051270522705327054270552705627057270582705927060270612706227063270642706527066270672706827069270702707127072270732707427075270762707727078270792708027081270822708327084270852708627087270882708927090270912709227093270942709527096270972709827099271002710127102271032710427105271062710727108271092711027111271122711327114271152711627117271182711927120271212712227123271242712527126271272712827129271302713127132271332713427135271362713727138271392714027141271422714327144271452714627147271482714927150271512715227153271542715527156271572715827159271602716127162271632716427165271662716727168271692717027171271722717327174271752717627177271782717927180271812718227183271842718527186271872718827189271902719127192271932719427195271962719727198271992720027201272022720327204272052720627207272082720927210272112721227213272142721527216272172721827219272202722127222272232722427225272262722727228272292723027231272322723327234272352723627237272382723927240272412724227243272442724527246272472724827249272502725127252272532725427255272562725727258272592726027261272622726327264272652726627267272682726927270272712727227273272742727527276272772727827279272802728127282272832728427285272862728727288272892729027291272922729327294272952729627297272982729927300273012730227303273042730527306273072730827309273102731127312273132731427315273162731727318273192732027321273222732327324273252732627327273282732927330273312733227333273342733527336273372733827339273402734127342273432734427345273462734727348273492735027351273522735327354273552735627357273582735927360273612736227363273642736527366273672736827369273702737127372273732737427375273762737727378273792738027381273822738327384273852738627387273882738927390273912739227393273942739527396273972739827399274002740127402274032740427405274062740727408274092741027411274122741327414274152741627417274182741927420274212742227423274242742527426274272742827429274302743127432274332743427435274362743727438274392744027441274422744327444274452744627447274482744927450274512745227453274542745527456274572745827459274602746127462274632746427465274662746727468274692747027471274722747327474274752747627477274782747927480274812748227483274842748527486274872748827489274902749127492274932749427495274962749727498274992750027501275022750327504275052750627507275082750927510275112751227513275142751527516275172751827519275202752127522275232752427525275262752727528275292753027531275322753327534275352753627537275382753927540275412754227543275442754527546275472754827549275502755127552275532755427555275562755727558275592756027561275622756327564275652756627567275682756927570275712757227573275742757527576275772757827579275802758127582275832758427585275862758727588275892759027591275922759327594275952759627597275982759927600276012760227603276042760527606276072760827609276102761127612276132761427615276162761727618276192762027621276222762327624276252762627627276282762927630276312763227633276342763527636276372763827639276402764127642276432764427645276462764727648276492765027651276522765327654276552765627657276582765927660276612766227663276642766527666276672766827669276702767127672276732767427675276762767727678276792768027681276822768327684276852768627687276882768927690276912769227693276942769527696276972769827699277002770127702277032770427705277062770727708277092771027711277122771327714277152771627717277182771927720277212772227723277242772527726277272772827729277302773127732277332773427735277362773727738277392774027741277422774327744277452774627747277482774927750277512775227753277542775527756277572775827759277602776127762277632776427765277662776727768277692777027771277722777327774277752777627777277782777927780277812778227783277842778527786277872778827789277902779127792277932779427795277962779727798277992780027801278022780327804278052780627807278082780927810278112781227813278142781527816278172781827819278202782127822278232782427825278262782727828278292783027831278322783327834278352783627837278382783927840278412784227843278442784527846278472784827849278502785127852278532785427855278562785727858278592786027861278622786327864278652786627867278682786927870278712787227873278742787527876278772787827879278802788127882278832788427885278862788727888278892789027891278922789327894278952789627897278982789927900279012790227903279042790527906279072790827909279102791127912279132791427915279162791727918279192792027921279222792327924279252792627927279282792927930279312793227933279342793527936279372793827939279402794127942279432794427945279462794727948279492795027951279522795327954279552795627957279582795927960279612796227963279642796527966279672796827969279702797127972279732797427975279762797727978279792798027981279822798327984279852798627987279882798927990279912799227993279942799527996279972799827999280002800128002280032800428005280062800728008280092801028011280122801328014280152801628017280182801928020280212802228023280242802528026280272802828029280302803128032280332803428035280362803728038280392804028041280422804328044280452804628047280482804928050280512805228053280542805528056280572805828059280602806128062280632806428065280662806728068280692807028071280722807328074280752807628077280782807928080280812808228083280842808528086280872808828089280902809128092280932809428095280962809728098280992810028101281022810328104281052810628107281082810928110281112811228113281142811528116281172811828119281202812128122281232812428125281262812728128281292813028131281322813328134281352813628137281382813928140281412814228143281442814528146281472814828149281502815128152281532815428155281562815728158281592816028161281622816328164281652816628167281682816928170281712817228173281742817528176281772817828179281802818128182281832818428185281862818728188281892819028191281922819328194281952819628197281982819928200282012820228203282042820528206282072820828209282102821128212282132821428215282162821728218282192822028221282222822328224282252822628227282282822928230282312823228233282342823528236282372823828239282402824128242282432824428245282462824728248282492825028251282522825328254282552825628257282582825928260282612826228263282642826528266282672826828269282702827128272282732827428275282762827728278282792828028281282822828328284282852828628287282882828928290282912829228293282942829528296282972829828299283002830128302283032830428305283062830728308283092831028311283122831328314283152831628317283182831928320283212832228323283242832528326283272832828329283302833128332283332833428335283362833728338283392834028341283422834328344283452834628347283482834928350283512835228353283542835528356283572835828359283602836128362283632836428365283662836728368283692837028371283722837328374283752837628377283782837928380283812838228383283842838528386283872838828389283902839128392283932839428395283962839728398283992840028401284022840328404284052840628407284082840928410284112841228413284142841528416284172841828419284202842128422284232842428425284262842728428284292843028431284322843328434284352843628437284382843928440284412844228443284442844528446284472844828449284502845128452284532845428455284562845728458284592846028461284622846328464284652846628467284682846928470284712847228473284742847528476284772847828479284802848128482284832848428485284862848728488284892849028491284922849328494284952849628497284982849928500285012850228503285042850528506285072850828509285102851128512285132851428515285162851728518285192852028521285222852328524285252852628527285282852928530285312853228533285342853528536285372853828539285402854128542285432854428545285462854728548285492855028551285522855328554285552855628557285582855928560285612856228563285642856528566285672856828569285702857128572285732857428575285762857728578285792858028581285822858328584285852858628587285882858928590285912859228593285942859528596285972859828599286002860128602286032860428605286062860728608286092861028611286122861328614286152861628617286182861928620286212862228623286242862528626286272862828629286302863128632286332863428635286362863728638286392864028641286422864328644286452864628647286482864928650286512865228653286542865528656286572865828659286602866128662286632866428665286662866728668286692867028671286722867328674286752867628677286782867928680286812868228683286842868528686286872868828689286902869128692286932869428695286962869728698286992870028701287022870328704287052870628707287082870928710287112871228713287142871528716287172871828719287202872128722287232872428725287262872728728287292873028731287322873328734287352873628737287382873928740287412874228743287442874528746287472874828749287502875128752287532875428755287562875728758287592876028761287622876328764287652876628767287682876928770287712877228773287742877528776287772877828779287802878128782287832878428785287862878728788287892879028791287922879328794287952879628797287982879928800288012880228803288042880528806288072880828809288102881128812288132881428815288162881728818288192882028821288222882328824288252882628827288282882928830288312883228833288342883528836288372883828839288402884128842288432884428845288462884728848288492885028851288522885328854288552885628857288582885928860288612886228863288642886528866288672886828869288702887128872288732887428875288762887728878288792888028881288822888328884288852888628887288882888928890288912889228893288942889528896288972889828899289002890128902289032890428905289062890728908289092891028911289122891328914289152891628917289182891928920289212892228923289242892528926289272892828929289302893128932289332893428935289362893728938289392894028941289422894328944289452894628947289482894928950289512895228953289542895528956289572895828959289602896128962289632896428965289662896728968289692897028971289722897328974289752897628977289782897928980289812898228983289842898528986289872898828989289902899128992289932899428995289962899728998289992900029001290022900329004290052900629007290082900929010290112901229013290142901529016290172901829019290202902129022290232902429025290262902729028290292903029031290322903329034290352903629037290382903929040290412904229043290442904529046290472904829049290502905129052290532905429055290562905729058290592906029061290622906329064290652906629067290682906929070290712907229073290742907529076290772907829079290802908129082290832908429085290862908729088290892909029091290922909329094290952909629097290982909929100291012910229103291042910529106291072910829109291102911129112291132911429115291162911729118291192912029121291222912329124291252912629127291282912929130291312913229133291342913529136291372913829139291402914129142291432914429145291462914729148291492915029151291522915329154291552915629157291582915929160291612916229163291642916529166291672916829169291702917129172291732917429175291762917729178291792918029181291822918329184291852918629187291882918929190291912919229193291942919529196291972919829199292002920129202292032920429205292062920729208292092921029211292122921329214292152921629217292182921929220292212922229223292242922529226292272922829229292302923129232292332923429235292362923729238292392924029241292422924329244292452924629247292482924929250292512925229253292542925529256292572925829259292602926129262292632926429265292662926729268292692927029271292722927329274292752927629277292782927929280292812928229283292842928529286292872928829289292902929129292292932929429295292962929729298292992930029301293022930329304293052930629307293082930929310293112931229313293142931529316293172931829319293202932129322293232932429325293262932729328293292933029331293322933329334293352933629337293382933929340293412934229343293442934529346293472934829349293502935129352293532935429355293562935729358293592936029361293622936329364293652936629367293682936929370293712937229373293742937529376293772937829379293802938129382293832938429385293862938729388293892939029391293922939329394293952939629397293982939929400294012940229403294042940529406294072940829409294102941129412294132941429415294162941729418294192942029421294222942329424294252942629427294282942929430294312943229433294342943529436294372943829439294402944129442294432944429445294462944729448294492945029451294522945329454294552945629457294582945929460294612946229463294642946529466294672946829469294702947129472294732947429475294762947729478294792948029481294822948329484294852948629487294882948929490294912949229493294942949529496294972949829499295002950129502295032950429505295062950729508295092951029511295122951329514295152951629517295182951929520295212952229523295242952529526295272952829529295302953129532295332953429535295362953729538295392954029541295422954329544295452954629547295482954929550295512955229553295542955529556295572955829559295602956129562295632956429565295662956729568295692957029571295722957329574295752957629577295782957929580295812958229583295842958529586295872958829589295902959129592295932959429595295962959729598295992960029601296022960329604296052960629607296082960929610296112961229613296142961529616296172961829619296202962129622296232962429625296262962729628296292963029631296322963329634296352963629637296382963929640296412964229643296442964529646296472964829649296502965129652296532965429655296562965729658296592966029661296622966329664296652966629667296682966929670296712967229673296742967529676296772967829679296802968129682296832968429685296862968729688296892969029691296922969329694296952969629697296982969929700297012970229703297042970529706297072970829709297102971129712297132971429715297162971729718297192972029721297222972329724297252972629727297282972929730297312973229733297342973529736297372973829739297402974129742297432974429745297462974729748297492975029751297522975329754297552975629757297582975929760297612976229763297642976529766297672976829769297702977129772297732977429775297762977729778297792978029781297822978329784297852978629787297882978929790297912979229793297942979529796297972979829799298002980129802298032980429805298062980729808298092981029811298122981329814298152981629817298182981929820298212982229823298242982529826298272982829829298302983129832298332983429835298362983729838298392984029841298422984329844298452984629847298482984929850298512985229853298542985529856298572985829859298602986129862298632986429865298662986729868298692987029871298722987329874298752987629877298782987929880298812988229883298842988529886298872988829889298902989129892298932989429895298962989729898298992990029901299022990329904299052990629907299082990929910299112991229913299142991529916299172991829919299202992129922299232992429925299262992729928299292993029931299322993329934299352993629937299382993929940299412994229943299442994529946299472994829949299502995129952299532995429955299562995729958299592996029961299622996329964299652996629967299682996929970299712997229973299742997529976299772997829979299802998129982299832998429985299862998729988299892999029991299922999329994299952999629997299982999930000300013000230003300043000530006300073000830009300103001130012300133001430015300163001730018300193002030021300223002330024300253002630027300283002930030300313003230033300343003530036300373003830039300403004130042300433004430045300463004730048300493005030051300523005330054300553005630057300583005930060300613006230063300643006530066300673006830069300703007130072300733007430075300763007730078300793008030081300823008330084300853008630087300883008930090300913009230093300943009530096300973009830099301003010130102301033010430105301063010730108301093011030111301123011330114301153011630117301183011930120301213012230123301243012530126301273012830129301303013130132301333013430135301363013730138301393014030141301423014330144301453014630147301483014930150301513015230153301543015530156301573015830159301603016130162301633016430165301663016730168301693017030171301723017330174301753017630177301783017930180301813018230183301843018530186301873018830189301903019130192301933019430195301963019730198301993020030201302023020330204302053020630207302083020930210302113021230213302143021530216302173021830219302203022130222302233022430225302263022730228302293023030231302323023330234302353023630237302383023930240302413024230243302443024530246302473024830249302503025130252302533025430255302563025730258302593026030261302623026330264302653026630267302683026930270302713027230273302743027530276302773027830279302803028130282302833028430285302863028730288302893029030291302923029330294302953029630297302983029930300303013030230303303043030530306303073030830309303103031130312303133031430315303163031730318303193032030321303223032330324303253032630327303283032930330303313033230333303343033530336303373033830339303403034130342303433034430345303463034730348303493035030351303523035330354303553035630357303583035930360303613036230363303643036530366303673036830369303703037130372303733037430375303763037730378303793038030381303823038330384303853038630387303883038930390303913039230393303943039530396303973039830399304003040130402304033040430405304063040730408304093041030411304123041330414304153041630417304183041930420304213042230423304243042530426304273042830429304303043130432304333043430435304363043730438304393044030441304423044330444304453044630447304483044930450304513045230453304543045530456304573045830459304603046130462304633046430465304663046730468304693047030471304723047330474304753047630477304783047930480304813048230483304843048530486304873048830489304903049130492304933049430495304963049730498304993050030501305023050330504305053050630507305083050930510305113051230513305143051530516305173051830519305203052130522305233052430525305263052730528305293053030531305323053330534305353053630537305383053930540305413054230543305443054530546305473054830549305503055130552305533055430555305563055730558305593056030561305623056330564305653056630567305683056930570305713057230573305743057530576305773057830579305803058130582305833058430585305863058730588305893059030591305923059330594305953059630597305983059930600306013060230603306043060530606306073060830609306103061130612306133061430615306163061730618306193062030621306223062330624306253062630627306283062930630306313063230633306343063530636306373063830639306403064130642306433064430645306463064730648306493065030651306523065330654306553065630657306583065930660306613066230663306643066530666306673066830669306703067130672306733067430675306763067730678306793068030681306823068330684306853068630687306883068930690306913069230693306943069530696306973069830699307003070130702307033070430705307063070730708307093071030711307123071330714307153071630717307183071930720307213072230723307243072530726307273072830729307303073130732307333073430735307363073730738307393074030741307423074330744307453074630747307483074930750307513075230753307543075530756307573075830759307603076130762307633076430765307663076730768307693077030771307723077330774307753077630777307783077930780307813078230783307843078530786307873078830789307903079130792307933079430795307963079730798307993080030801308023080330804308053080630807308083080930810308113081230813308143081530816308173081830819308203082130822308233082430825308263082730828308293083030831308323083330834308353083630837308383083930840308413084230843308443084530846308473084830849308503085130852308533085430855308563085730858308593086030861308623086330864308653086630867308683086930870308713087230873308743087530876308773087830879308803088130882308833088430885308863088730888308893089030891308923089330894308953089630897308983089930900309013090230903309043090530906309073090830909309103091130912309133091430915309163091730918309193092030921309223092330924309253092630927309283092930930309313093230933309343093530936309373093830939309403094130942309433094430945309463094730948309493095030951309523095330954309553095630957309583095930960309613096230963309643096530966309673096830969309703097130972309733097430975309763097730978309793098030981309823098330984309853098630987309883098930990309913099230993309943099530996309973099830999310003100131002310033100431005310063100731008310093101031011310123101331014310153101631017310183101931020310213102231023310243102531026310273102831029310303103131032310333103431035310363103731038310393104031041310423104331044310453104631047310483104931050310513105231053310543105531056310573105831059310603106131062310633106431065310663106731068310693107031071310723107331074310753107631077310783107931080310813108231083310843108531086310873108831089310903109131092310933109431095310963109731098310993110031101311023110331104311053110631107311083110931110311113111231113311143111531116311173111831119311203112131122311233112431125311263112731128311293113031131311323113331134311353113631137311383113931140311413114231143311443114531146311473114831149311503115131152311533115431155311563115731158311593116031161311623116331164311653116631167311683116931170311713117231173311743117531176311773117831179311803118131182311833118431185311863118731188311893119031191311923119331194311953119631197311983119931200312013120231203312043120531206312073120831209312103121131212312133121431215312163121731218312193122031221312223122331224312253122631227312283122931230312313123231233312343123531236312373123831239312403124131242312433124431245312463124731248312493125031251312523125331254312553125631257312583125931260312613126231263312643126531266312673126831269312703127131272312733127431275312763127731278312793128031281312823128331284312853128631287312883128931290312913129231293312943129531296312973129831299313003130131302313033130431305313063130731308313093131031311313123131331314313153131631317313183131931320313213132231323313243132531326313273132831329313303133131332313333133431335313363133731338313393134031341313423134331344313453134631347313483134931350313513135231353313543135531356313573135831359313603136131362313633136431365313663136731368313693137031371313723137331374313753137631377313783137931380313813138231383313843138531386313873138831389313903139131392313933139431395313963139731398313993140031401314023140331404314053140631407314083140931410314113141231413314143141531416314173141831419314203142131422314233142431425314263142731428314293143031431314323143331434314353143631437314383143931440314413144231443314443144531446314473144831449314503145131452314533145431455314563145731458314593146031461314623146331464314653146631467314683146931470314713147231473314743147531476314773147831479314803148131482314833148431485314863148731488314893149031491314923149331494314953149631497314983149931500315013150231503315043150531506315073150831509315103151131512315133151431515315163151731518315193152031521315223152331524315253152631527315283152931530315313153231533315343153531536315373153831539315403154131542315433154431545315463154731548315493155031551315523155331554315553155631557315583155931560315613156231563315643156531566315673156831569315703157131572315733157431575315763157731578315793158031581315823158331584315853158631587315883158931590315913159231593315943159531596315973159831599316003160131602316033160431605316063160731608316093161031611316123161331614316153161631617316183161931620316213162231623316243162531626316273162831629316303163131632316333163431635316363163731638316393164031641316423164331644316453164631647316483164931650316513165231653316543165531656316573165831659316603166131662316633166431665316663166731668316693167031671316723167331674316753167631677316783167931680316813168231683316843168531686316873168831689316903169131692316933169431695316963169731698316993170031701317023170331704317053170631707317083170931710317113171231713317143171531716317173171831719317203172131722317233172431725317263172731728317293173031731317323173331734317353173631737317383173931740317413174231743317443174531746317473174831749317503175131752317533175431755317563175731758317593176031761317623176331764317653176631767317683176931770317713177231773317743177531776317773177831779317803178131782317833178431785317863178731788317893179031791317923179331794317953179631797317983179931800318013180231803318043180531806318073180831809318103181131812318133181431815318163181731818318193182031821318223182331824318253182631827318283182931830318313183231833318343183531836318373183831839318403184131842318433184431845318463184731848318493185031851318523185331854318553185631857318583185931860318613186231863318643186531866318673186831869318703187131872318733187431875318763187731878318793188031881318823188331884318853188631887318883188931890318913189231893318943189531896318973189831899319003190131902319033190431905319063190731908319093191031911319123191331914319153191631917319183191931920319213192231923319243192531926319273192831929319303193131932319333193431935319363193731938319393194031941319423194331944319453194631947319483194931950319513195231953319543195531956319573195831959319603196131962319633196431965319663196731968319693197031971319723197331974319753197631977319783197931980319813198231983319843198531986319873198831989319903199131992319933199431995319963199731998319993200032001320023200332004320053200632007320083200932010320113201232013320143201532016320173201832019320203202132022320233202432025320263202732028320293203032031320323203332034320353203632037320383203932040320413204232043320443204532046320473204832049320503205132052320533205432055320563205732058320593206032061320623206332064320653206632067320683206932070320713207232073320743207532076320773207832079320803208132082320833208432085320863208732088320893209032091320923209332094320953209632097320983209932100321013210232103321043210532106321073210832109321103211132112321133211432115321163211732118321193212032121321223212332124321253212632127321283212932130321313213232133321343213532136321373213832139321403214132142321433214432145321463214732148321493215032151321523215332154321553215632157321583215932160321613216232163321643216532166321673216832169321703217132172321733217432175321763217732178321793218032181321823218332184321853218632187321883218932190321913219232193321943219532196321973219832199322003220132202322033220432205322063220732208322093221032211322123221332214322153221632217322183221932220322213222232223322243222532226322273222832229322303223132232322333223432235322363223732238322393224032241322423224332244322453224632247322483224932250322513225232253322543225532256322573225832259322603226132262322633226432265322663226732268322693227032271322723227332274322753227632277322783227932280322813228232283322843228532286322873228832289322903229132292322933229432295322963229732298322993230032301323023230332304323053230632307323083230932310323113231232313323143231532316323173231832319323203232132322323233232432325323263232732328323293233032331323323233332334323353233632337323383233932340323413234232343323443234532346323473234832349323503235132352323533235432355323563235732358323593236032361323623236332364323653236632367323683236932370323713237232373323743237532376323773237832379323803238132382323833238432385323863238732388323893239032391323923239332394323953239632397323983239932400324013240232403324043240532406324073240832409324103241132412324133241432415324163241732418324193242032421324223242332424324253242632427324283242932430324313243232433324343243532436324373243832439324403244132442324433244432445324463244732448324493245032451324523245332454324553245632457324583245932460324613246232463324643246532466324673246832469324703247132472324733247432475324763247732478324793248032481324823248332484324853248632487324883248932490324913249232493324943249532496324973249832499325003250132502325033250432505325063250732508325093251032511325123251332514325153251632517325183251932520325213252232523325243252532526325273252832529325303253132532325333253432535325363253732538325393254032541325423254332544325453254632547325483254932550325513255232553325543255532556325573255832559325603256132562325633256432565325663256732568325693257032571325723257332574325753257632577325783257932580325813258232583325843258532586325873258832589325903259132592325933259432595325963259732598325993260032601326023260332604326053260632607326083260932610326113261232613326143261532616326173261832619326203262132622326233262432625326263262732628326293263032631326323263332634326353263632637326383263932640326413264232643326443264532646326473264832649326503265132652326533265432655326563265732658326593266032661326623266332664326653266632667326683266932670326713267232673326743267532676326773267832679326803268132682326833268432685326863268732688326893269032691326923269332694326953269632697326983269932700327013270232703327043270532706327073270832709327103271132712327133271432715327163271732718327193272032721327223272332724327253272632727327283272932730327313273232733327343273532736327373273832739327403274132742327433274432745327463274732748327493275032751327523275332754327553275632757327583275932760327613276232763327643276532766327673276832769327703277132772327733277432775327763277732778327793278032781327823278332784327853278632787327883278932790327913279232793327943279532796327973279832799328003280132802328033280432805328063280732808328093281032811328123281332814328153281632817328183281932820328213282232823328243282532826328273282832829328303283132832328333283432835328363283732838328393284032841328423284332844328453284632847328483284932850328513285232853328543285532856328573285832859328603286132862328633286432865328663286732868328693287032871328723287332874328753287632877328783287932880328813288232883328843288532886328873288832889328903289132892328933289432895328963289732898328993290032901329023290332904329053290632907329083290932910329113291232913329143291532916329173291832919329203292132922329233292432925329263292732928329293293032931329323293332934329353293632937329383293932940329413294232943329443294532946329473294832949329503295132952329533295432955329563295732958329593296032961329623296332964329653296632967329683296932970329713297232973329743297532976329773297832979329803298132982329833298432985329863298732988329893299032991329923299332994329953299632997329983299933000330013300233003330043300533006330073300833009330103301133012330133301433015330163301733018330193302033021330223302333024330253302633027330283302933030330313303233033330343303533036330373303833039330403304133042330433304433045330463304733048330493305033051330523305333054330553305633057330583305933060330613306233063330643306533066330673306833069330703307133072330733307433075330763307733078330793308033081330823308333084330853308633087330883308933090330913309233093330943309533096330973309833099331003310133102331033310433105331063310733108331093311033111331123311333114331153311633117331183311933120331213312233123331243312533126331273312833129331303313133132331333313433135331363313733138331393314033141331423314333144331453314633147331483314933150331513315233153331543315533156331573315833159331603316133162331633316433165331663316733168331693317033171331723317333174331753317633177331783317933180331813318233183331843318533186331873318833189331903319133192331933319433195331963319733198331993320033201332023320333204332053320633207332083320933210332113321233213332143321533216332173321833219332203322133222332233322433225332263322733228332293323033231332323323333234332353323633237332383323933240332413324233243332443324533246332473324833249332503325133252332533325433255332563325733258332593326033261332623326333264332653326633267332683326933270332713327233273332743327533276332773327833279332803328133282332833328433285332863328733288332893329033291332923329333294332953329633297332983329933300333013330233303333043330533306333073330833309333103331133312333133331433315333163331733318333193332033321333223332333324333253332633327333283332933330333313333233333333343333533336333373333833339333403334133342333433334433345333463334733348333493335033351333523335333354333553335633357333583335933360333613336233363333643336533366333673336833369333703337133372333733337433375333763337733378333793338033381333823338333384333853338633387333883338933390333913339233393333943339533396333973339833399334003340133402334033340433405334063340733408334093341033411334123341333414334153341633417334183341933420334213342233423334243342533426334273342833429334303343133432334333343433435334363343733438334393344033441334423344333444334453344633447334483344933450334513345233453334543345533456334573345833459334603346133462334633346433465334663346733468334693347033471334723347333474334753347633477334783347933480334813348233483334843348533486334873348833489334903349133492334933349433495334963349733498334993350033501335023350333504335053350633507335083350933510335113351233513335143351533516335173351833519335203352133522335233352433525335263352733528335293353033531335323353333534335353353633537335383353933540335413354233543335443354533546335473354833549335503355133552335533355433555335563355733558335593356033561335623356333564335653356633567335683356933570335713357233573335743357533576335773357833579335803358133582335833358433585335863358733588335893359033591335923359333594335953359633597335983359933600336013360233603336043360533606336073360833609336103361133612336133361433615336163361733618336193362033621336223362333624336253362633627336283362933630336313363233633336343363533636336373363833639336403364133642336433364433645336463364733648336493365033651336523365333654336553365633657336583365933660336613366233663336643366533666336673366833669336703367133672336733367433675336763367733678336793368033681336823368333684336853368633687336883368933690336913369233693336943369533696336973369833699337003370133702337033370433705337063370733708337093371033711337123371333714337153371633717337183371933720337213372233723337243372533726337273372833729337303373133732337333373433735337363373733738337393374033741337423374333744337453374633747337483374933750337513375233753337543375533756337573375833759337603376133762337633376433765337663376733768337693377033771337723377333774337753377633777337783377933780337813378233783337843378533786337873378833789337903379133792337933379433795337963379733798337993380033801338023380333804338053380633807338083380933810338113381233813338143381533816338173381833819338203382133822338233382433825338263382733828338293383033831338323383333834338353383633837338383383933840338413384233843338443384533846338473384833849338503385133852338533385433855338563385733858338593386033861338623386333864338653386633867338683386933870338713387233873338743387533876338773387833879338803388133882338833388433885338863388733888338893389033891338923389333894338953389633897338983389933900339013390233903339043390533906339073390833909339103391133912339133391433915339163391733918339193392033921339223392333924339253392633927339283392933930339313393233933339343393533936339373393833939339403394133942339433394433945339463394733948339493395033951339523395333954339553395633957339583395933960339613396233963339643396533966339673396833969339703397133972339733397433975339763397733978339793398033981339823398333984339853398633987339883398933990339913399233993339943399533996339973399833999340003400134002340033400434005340063400734008340093401034011340123401334014340153401634017340183401934020340213402234023340243402534026340273402834029340303403134032340333403434035340363403734038340393404034041340423404334044340453404634047340483404934050340513405234053340543405534056340573405834059340603406134062340633406434065340663406734068340693407034071340723407334074340753407634077340783407934080340813408234083340843408534086340873408834089340903409134092340933409434095340963409734098340993410034101341023410334104341053410634107341083410934110341113411234113341143411534116341173411834119341203412134122341233412434125341263412734128341293413034131341323413334134341353413634137341383413934140341413414234143341443414534146341473414834149341503415134152341533415434155341563415734158341593416034161341623416334164341653416634167341683416934170341713417234173341743417534176341773417834179341803418134182341833418434185341863418734188341893419034191341923419334194341953419634197341983419934200342013420234203342043420534206342073420834209342103421134212342133421434215342163421734218342193422034221342223422334224342253422634227342283422934230342313423234233342343423534236342373423834239342403424134242342433424434245342463424734248342493425034251342523425334254342553425634257342583425934260342613426234263342643426534266342673426834269342703427134272342733427434275342763427734278342793428034281342823428334284342853428634287342883428934290342913429234293342943429534296342973429834299343003430134302343033430434305343063430734308343093431034311343123431334314343153431634317343183431934320343213432234323343243432534326343273432834329343303433134332343333433434335343363433734338343393434034341343423434334344343453434634347343483434934350343513435234353343543435534356343573435834359343603436134362343633436434365343663436734368343693437034371343723437334374343753437634377343783437934380343813438234383343843438534386343873438834389343903439134392343933439434395343963439734398343993440034401344023440334404344053440634407344083440934410344113441234413344143441534416344173441834419344203442134422344233442434425344263442734428344293443034431344323443334434344353443634437344383443934440344413444234443344443444534446344473444834449344503445134452344533445434455344563445734458344593446034461344623446334464344653446634467344683446934470344713447234473344743447534476344773447834479344803448134482344833448434485344863448734488344893449034491344923449334494344953449634497344983449934500345013450234503345043450534506345073450834509345103451134512345133451434515345163451734518345193452034521345223452334524345253452634527345283452934530345313453234533345343453534536345373453834539345403454134542345433454434545345463454734548345493455034551345523455334554345553455634557345583455934560345613456234563345643456534566345673456834569345703457134572345733457434575345763457734578345793458034581345823458334584345853458634587345883458934590345913459234593345943459534596345973459834599346003460134602346033460434605346063460734608346093461034611346123461334614346153461634617346183461934620346213462234623346243462534626346273462834629346303463134632346333463434635346363463734638346393464034641346423464334644346453464634647346483464934650346513465234653346543465534656346573465834659346603466134662346633466434665346663466734668346693467034671346723467334674346753467634677346783467934680346813468234683346843468534686346873468834689346903469134692346933469434695346963469734698346993470034701347023470334704347053470634707347083470934710347113471234713347143471534716347173471834719347203472134722347233472434725347263472734728347293473034731347323473334734347353473634737347383473934740347413474234743347443474534746347473474834749347503475134752347533475434755347563475734758347593476034761347623476334764347653476634767347683476934770347713477234773347743477534776347773477834779347803478134782347833478434785347863478734788347893479034791347923479334794347953479634797347983479934800348013480234803348043480534806348073480834809348103481134812348133481434815348163481734818348193482034821348223482334824348253482634827348283482934830348313483234833348343483534836348373483834839348403484134842348433484434845348463484734848348493485034851348523485334854348553485634857348583485934860348613486234863348643486534866348673486834869348703487134872348733487434875348763487734878348793488034881348823488334884348853488634887348883488934890348913489234893348943489534896348973489834899349003490134902349033490434905349063490734908349093491034911349123491334914349153491634917349183491934920349213492234923349243492534926349273492834929349303493134932349333493434935349363493734938349393494034941349423494334944349453494634947349483494934950349513495234953349543495534956349573495834959349603496134962349633496434965349663496734968349693497034971349723497334974349753497634977349783497934980349813498234983349843498534986349873498834989349903499134992349933499434995349963499734998349993500035001350023500335004350053500635007350083500935010350113501235013350143501535016350173501835019350203502135022350233502435025350263502735028350293503035031350323503335034350353503635037350383503935040350413504235043350443504535046350473504835049350503505135052350533505435055350563505735058350593506035061350623506335064350653506635067350683506935070350713507235073350743507535076350773507835079350803508135082350833508435085350863508735088350893509035091350923509335094350953509635097350983509935100351013510235103351043510535106351073510835109351103511135112351133511435115351163511735118351193512035121351223512335124351253512635127351283512935130351313513235133351343513535136351373513835139351403514135142351433514435145351463514735148351493515035151351523515335154351553515635157351583515935160351613516235163351643516535166351673516835169351703517135172351733517435175351763517735178351793518035181351823518335184351853518635187351883518935190351913519235193351943519535196351973519835199352003520135202352033520435205352063520735208352093521035211352123521335214352153521635217352183521935220352213522235223352243522535226352273522835229352303523135232352333523435235352363523735238352393524035241352423524335244352453524635247352483524935250352513525235253352543525535256352573525835259352603526135262352633526435265352663526735268352693527035271352723527335274352753527635277352783527935280352813528235283352843528535286352873528835289352903529135292352933529435295352963529735298352993530035301353023530335304353053530635307353083530935310353113531235313353143531535316353173531835319353203532135322353233532435325353263532735328353293533035331353323533335334353353533635337353383533935340353413534235343353443534535346353473534835349353503535135352353533535435355353563535735358353593536035361353623536335364353653536635367353683536935370353713537235373353743537535376353773537835379353803538135382353833538435385353863538735388353893539035391353923539335394353953539635397353983539935400354013540235403354043540535406354073540835409354103541135412354133541435415354163541735418354193542035421354223542335424354253542635427354283542935430354313543235433354343543535436354373543835439354403544135442354433544435445354463544735448354493545035451354523545335454354553545635457354583545935460354613546235463354643546535466354673546835469354703547135472354733547435475354763547735478354793548035481354823548335484354853548635487354883548935490354913549235493354943549535496354973549835499355003550135502355033550435505355063550735508355093551035511355123551335514355153551635517355183551935520355213552235523355243552535526355273552835529355303553135532355333553435535355363553735538355393554035541355423554335544355453554635547355483554935550355513555235553355543555535556355573555835559355603556135562355633556435565355663556735568355693557035571355723557335574355753557635577355783557935580355813558235583355843558535586355873558835589355903559135592355933559435595355963559735598355993560035601356023560335604356053560635607356083560935610356113561235613356143561535616356173561835619356203562135622356233562435625356263562735628356293563035631356323563335634356353563635637356383563935640356413564235643356443564535646356473564835649356503565135652356533565435655356563565735658356593566035661356623566335664356653566635667356683566935670356713567235673356743567535676356773567835679356803568135682356833568435685356863568735688356893569035691356923569335694356953569635697356983569935700357013570235703357043570535706357073570835709357103571135712357133571435715357163571735718357193572035721357223572335724357253572635727357283572935730357313573235733357343573535736357373573835739357403574135742357433574435745357463574735748357493575035751357523575335754357553575635757357583575935760357613576235763357643576535766357673576835769357703577135772357733577435775357763577735778357793578035781357823578335784357853578635787357883578935790357913579235793357943579535796357973579835799358003580135802358033580435805358063580735808358093581035811358123581335814358153581635817358183581935820358213582235823358243582535826358273582835829358303583135832358333583435835358363583735838358393584035841358423584335844358453584635847358483584935850358513585235853358543585535856358573585835859358603586135862358633586435865358663586735868358693587035871358723587335874358753587635877358783587935880358813588235883358843588535886358873588835889358903589135892358933589435895358963589735898358993590035901359023590335904359053590635907359083590935910359113591235913359143591535916359173591835919359203592135922359233592435925359263592735928359293593035931359323593335934359353593635937359383593935940359413594235943359443594535946359473594835949359503595135952359533595435955359563595735958359593596035961359623596335964359653596635967359683596935970359713597235973359743597535976359773597835979359803598135982359833598435985359863598735988359893599035991359923599335994359953599635997359983599936000360013600236003360043600536006360073600836009360103601136012360133601436015360163601736018360193602036021360223602336024360253602636027360283602936030360313603236033360343603536036360373603836039360403604136042360433604436045360463604736048360493605036051360523605336054360553605636057360583605936060360613606236063360643606536066360673606836069360703607136072360733607436075360763607736078360793608036081360823608336084360853608636087360883608936090360913609236093360943609536096360973609836099361003610136102361033610436105361063610736108361093611036111361123611336114361153611636117361183611936120361213612236123361243612536126361273612836129361303613136132361333613436135361363613736138361393614036141361423614336144361453614636147361483614936150361513615236153361543615536156361573615836159361603616136162361633616436165361663616736168361693617036171361723617336174361753617636177361783617936180361813618236183361843618536186361873618836189361903619136192361933619436195361963619736198361993620036201362023620336204362053620636207362083620936210362113621236213362143621536216362173621836219362203622136222362233622436225362263622736228362293623036231362323623336234362353623636237362383623936240362413624236243362443624536246362473624836249362503625136252362533625436255362563625736258362593626036261362623626336264362653626636267362683626936270362713627236273362743627536276362773627836279362803628136282362833628436285362863628736288362893629036291362923629336294362953629636297362983629936300363013630236303363043630536306363073630836309363103631136312363133631436315363163631736318363193632036321363223632336324363253632636327363283632936330363313633236333363343633536336363373633836339363403634136342363433634436345363463634736348363493635036351363523635336354363553635636357363583635936360363613636236363363643636536366363673636836369363703637136372363733637436375363763637736378363793638036381363823638336384363853638636387363883638936390363913639236393363943639536396363973639836399364003640136402364033640436405364063640736408364093641036411364123641336414364153641636417364183641936420364213642236423364243642536426364273642836429364303643136432364333643436435364363643736438364393644036441364423644336444364453644636447364483644936450364513645236453364543645536456364573645836459364603646136462364633646436465364663646736468364693647036471364723647336474364753647636477364783647936480364813648236483364843648536486364873648836489364903649136492364933649436495364963649736498364993650036501365023650336504365053650636507365083650936510365113651236513365143651536516365173651836519365203652136522365233652436525365263652736528365293653036531365323653336534365353653636537365383653936540365413654236543365443654536546365473654836549365503655136552365533655436555365563655736558365593656036561365623656336564365653656636567365683656936570365713657236573365743657536576365773657836579365803658136582365833658436585365863658736588365893659036591365923659336594365953659636597365983659936600366013660236603366043660536606366073660836609366103661136612366133661436615366163661736618366193662036621366223662336624366253662636627366283662936630366313663236633366343663536636366373663836639366403664136642366433664436645366463664736648366493665036651366523665336654366553665636657366583665936660366613666236663366643666536666366673666836669366703667136672366733667436675366763667736678366793668036681366823668336684366853668636687366883668936690366913669236693366943669536696366973669836699367003670136702367033670436705367063670736708367093671036711367123671336714367153671636717367183671936720367213672236723367243672536726367273672836729367303673136732367333673436735367363673736738367393674036741367423674336744367453674636747367483674936750367513675236753367543675536756367573675836759367603676136762367633676436765367663676736768367693677036771367723677336774367753677636777367783677936780367813678236783367843678536786367873678836789367903679136792367933679436795367963679736798367993680036801368023680336804368053680636807368083680936810368113681236813368143681536816368173681836819368203682136822368233682436825368263682736828368293683036831368323683336834368353683636837368383683936840368413684236843368443684536846368473684836849368503685136852368533685436855368563685736858368593686036861368623686336864368653686636867368683686936870368713687236873368743687536876368773687836879368803688136882368833688436885368863688736888368893689036891368923689336894368953689636897368983689936900369013690236903369043690536906369073690836909369103691136912369133691436915369163691736918369193692036921369223692336924369253692636927369283692936930369313693236933369343693536936369373693836939369403694136942369433694436945369463694736948369493695036951369523695336954369553695636957369583695936960369613696236963369643696536966369673696836969369703697136972369733697436975369763697736978369793698036981369823698336984369853698636987369883698936990369913699236993369943699536996369973699836999370003700137002370033700437005370063700737008370093701037011370123701337014370153701637017370183701937020370213702237023370243702537026370273702837029370303703137032370333703437035370363703737038370393704037041370423704337044370453704637047370483704937050370513705237053370543705537056370573705837059370603706137062370633706437065370663706737068370693707037071370723707337074370753707637077370783707937080370813708237083370843708537086370873708837089370903709137092370933709437095370963709737098370993710037101371023710337104371053710637107371083710937110371113711237113371143711537116371173711837119371203712137122371233712437125371263712737128371293713037131371323713337134371353713637137371383713937140371413714237143371443714537146371473714837149371503715137152371533715437155371563715737158371593716037161371623716337164371653716637167371683716937170371713717237173371743717537176371773717837179371803718137182371833718437185371863718737188371893719037191371923719337194371953719637197371983719937200372013720237203372043720537206372073720837209372103721137212372133721437215372163721737218372193722037221372223722337224372253722637227372283722937230372313723237233372343723537236372373723837239372403724137242372433724437245372463724737248372493725037251372523725337254372553725637257372583725937260372613726237263372643726537266372673726837269372703727137272372733727437275372763727737278372793728037281372823728337284372853728637287372883728937290372913729237293372943729537296372973729837299373003730137302373033730437305373063730737308373093731037311373123731337314373153731637317373183731937320373213732237323373243732537326373273732837329373303733137332373333733437335373363733737338373393734037341373423734337344373453734637347373483734937350373513735237353373543735537356373573735837359373603736137362373633736437365373663736737368373693737037371373723737337374373753737637377373783737937380373813738237383373843738537386373873738837389373903739137392373933739437395373963739737398373993740037401374023740337404374053740637407374083740937410374113741237413374143741537416374173741837419374203742137422374233742437425374263742737428374293743037431374323743337434374353743637437374383743937440374413744237443374443744537446374473744837449374503745137452374533745437455374563745737458374593746037461374623746337464374653746637467374683746937470374713747237473374743747537476374773747837479374803748137482374833748437485374863748737488374893749037491374923749337494374953749637497374983749937500375013750237503375043750537506375073750837509375103751137512375133751437515375163751737518375193752037521375223752337524375253752637527375283752937530375313753237533375343753537536375373753837539375403754137542375433754437545375463754737548375493755037551375523755337554375553755637557375583755937560375613756237563375643756537566375673756837569375703757137572375733757437575375763757737578375793758037581375823758337584375853758637587375883758937590375913759237593375943759537596375973759837599376003760137602376033760437605376063760737608376093761037611376123761337614376153761637617376183761937620376213762237623376243762537626376273762837629376303763137632376333763437635376363763737638376393764037641376423764337644376453764637647376483764937650376513765237653376543765537656376573765837659376603766137662376633766437665376663766737668376693767037671376723767337674376753767637677376783767937680376813768237683376843768537686376873768837689376903769137692376933769437695376963769737698376993770037701377023770337704377053770637707377083770937710377113771237713377143771537716377173771837719377203772137722377233772437725377263772737728377293773037731377323773337734377353773637737377383773937740377413774237743377443774537746377473774837749377503775137752377533775437755377563775737758377593776037761377623776337764377653776637767377683776937770377713777237773377743777537776377773777837779377803778137782377833778437785377863778737788377893779037791377923779337794377953779637797377983779937800378013780237803378043780537806378073780837809378103781137812378133781437815378163781737818378193782037821378223782337824378253782637827378283782937830378313783237833378343783537836378373783837839378403784137842378433784437845378463784737848378493785037851378523785337854378553785637857378583785937860378613786237863378643786537866378673786837869378703787137872378733787437875378763787737878378793788037881378823788337884378853788637887378883788937890378913789237893378943789537896378973789837899379003790137902379033790437905379063790737908379093791037911379123791337914379153791637917379183791937920379213792237923379243792537926379273792837929379303793137932379333793437935379363793737938379393794037941379423794337944379453794637947379483794937950379513795237953379543795537956379573795837959379603796137962379633796437965379663796737968379693797037971379723797337974379753797637977379783797937980379813798237983379843798537986379873798837989379903799137992379933799437995379963799737998379993800038001380023800338004380053800638007380083800938010380113801238013380143801538016380173801838019380203802138022380233802438025380263802738028380293803038031380323803338034380353803638037380383803938040380413804238043380443804538046380473804838049380503805138052380533805438055380563805738058380593806038061380623806338064380653806638067380683806938070380713807238073380743807538076380773807838079380803808138082380833808438085380863808738088380893809038091380923809338094380953809638097380983809938100381013810238103381043810538106381073810838109381103811138112381133811438115381163811738118381193812038121381223812338124381253812638127381283812938130381313813238133381343813538136381373813838139381403814138142381433814438145381463814738148381493815038151381523815338154381553815638157381583815938160381613816238163381643816538166381673816838169381703817138172381733817438175381763817738178381793818038181381823818338184381853818638187381883818938190381913819238193381943819538196381973819838199382003820138202382033820438205382063820738208382093821038211382123821338214382153821638217382183821938220382213822238223382243822538226382273822838229382303823138232382333823438235382363823738238382393824038241382423824338244382453824638247382483824938250382513825238253382543825538256382573825838259382603826138262382633826438265382663826738268382693827038271382723827338274382753827638277382783827938280382813828238283382843828538286382873828838289382903829138292382933829438295382963829738298382993830038301383023830338304383053830638307383083830938310383113831238313383143831538316383173831838319383203832138322383233832438325383263832738328383293833038331383323833338334383353833638337383383833938340383413834238343383443834538346383473834838349383503835138352383533835438355383563835738358383593836038361383623836338364383653836638367383683836938370383713837238373383743837538376383773837838379383803838138382383833838438385383863838738388383893839038391383923839338394383953839638397383983839938400384013840238403384043840538406384073840838409384103841138412384133841438415384163841738418384193842038421384223842338424384253842638427384283842938430384313843238433384343843538436384373843838439384403844138442384433844438445384463844738448384493845038451384523845338454384553845638457384583845938460384613846238463384643846538466384673846838469384703847138472384733847438475384763847738478384793848038481384823848338484384853848638487384883848938490384913849238493384943849538496384973849838499385003850138502385033850438505385063850738508385093851038511385123851338514385153851638517385183851938520385213852238523385243852538526385273852838529385303853138532385333853438535385363853738538385393854038541385423854338544385453854638547385483854938550385513855238553385543855538556385573855838559385603856138562385633856438565385663856738568385693857038571385723857338574385753857638577385783857938580385813858238583385843858538586385873858838589385903859138592385933859438595385963859738598385993860038601386023860338604386053860638607386083860938610386113861238613386143861538616386173861838619386203862138622386233862438625386263862738628386293863038631386323863338634386353863638637386383863938640386413864238643386443864538646386473864838649386503865138652386533865438655386563865738658386593866038661386623866338664386653866638667386683866938670386713867238673386743867538676386773867838679386803868138682386833868438685386863868738688386893869038691386923869338694386953869638697386983869938700387013870238703387043870538706387073870838709387103871138712387133871438715387163871738718387193872038721387223872338724387253872638727387283872938730387313873238733387343873538736387373873838739387403874138742387433874438745387463874738748387493875038751387523875338754387553875638757387583875938760387613876238763387643876538766387673876838769387703877138772387733877438775387763877738778387793878038781387823878338784387853878638787387883878938790387913879238793387943879538796387973879838799388003880138802388033880438805388063880738808388093881038811388123881338814388153881638817388183881938820388213882238823388243882538826388273882838829388303883138832388333883438835388363883738838388393884038841388423884338844388453884638847388483884938850388513885238853388543885538856388573885838859388603886138862388633886438865388663886738868388693887038871388723887338874388753887638877388783887938880388813888238883388843888538886388873888838889388903889138892388933889438895388963889738898388993890038901389023890338904389053890638907389083890938910389113891238913389143891538916389173891838919389203892138922389233892438925389263892738928389293893038931389323893338934389353893638937389383893938940389413894238943389443894538946389473894838949389503895138952389533895438955389563895738958389593896038961389623896338964389653896638967389683896938970389713897238973389743897538976389773897838979389803898138982389833898438985389863898738988389893899038991389923899338994389953899638997389983899939000390013900239003390043900539006390073900839009390103901139012390133901439015390163901739018390193902039021390223902339024390253902639027390283902939030390313903239033390343903539036390373903839039390403904139042390433904439045390463904739048390493905039051390523905339054390553905639057390583905939060390613906239063390643906539066390673906839069390703907139072390733907439075390763907739078390793908039081390823908339084390853908639087390883908939090390913909239093390943909539096390973909839099391003910139102391033910439105391063910739108391093911039111391123911339114391153911639117391183911939120391213912239123391243912539126391273912839129391303913139132391333913439135391363913739138391393914039141391423914339144391453914639147391483914939150391513915239153391543915539156391573915839159391603916139162391633916439165391663916739168391693917039171391723917339174391753917639177391783917939180391813918239183391843918539186391873918839189391903919139192391933919439195391963919739198391993920039201392023920339204392053920639207392083920939210392113921239213392143921539216392173921839219392203922139222392233922439225392263922739228392293923039231392323923339234392353923639237392383923939240392413924239243392443924539246392473924839249392503925139252392533925439255392563925739258392593926039261392623926339264392653926639267392683926939270392713927239273392743927539276392773927839279392803928139282392833928439285392863928739288392893929039291392923929339294392953929639297392983929939300393013930239303393043930539306393073930839309393103931139312393133931439315393163931739318393193932039321393223932339324393253932639327393283932939330393313933239333393343933539336393373933839339393403934139342393433934439345393463934739348393493935039351393523935339354393553935639357393583935939360393613936239363393643936539366393673936839369393703937139372393733937439375393763937739378393793938039381393823938339384393853938639387393883938939390393913939239393393943939539396393973939839399394003940139402394033940439405394063940739408394093941039411394123941339414394153941639417394183941939420394213942239423394243942539426394273942839429394303943139432394333943439435394363943739438394393944039441394423944339444394453944639447394483944939450394513945239453394543945539456394573945839459394603946139462394633946439465394663946739468394693947039471394723947339474394753947639477394783947939480394813948239483394843948539486394873948839489394903949139492394933949439495394963949739498394993950039501395023950339504395053950639507395083950939510395113951239513395143951539516395173951839519395203952139522395233952439525395263952739528395293953039531395323953339534395353953639537395383953939540395413954239543395443954539546395473954839549395503955139552395533955439555395563955739558395593956039561395623956339564395653956639567395683956939570395713957239573395743957539576395773957839579395803958139582395833958439585395863958739588395893959039591395923959339594395953959639597395983959939600396013960239603396043960539606396073960839609396103961139612396133961439615396163961739618396193962039621396223962339624396253962639627396283962939630396313963239633396343963539636396373963839639396403964139642396433964439645396463964739648396493965039651396523965339654396553965639657396583965939660396613966239663396643966539666396673966839669396703967139672396733967439675396763967739678396793968039681396823968339684396853968639687396883968939690396913969239693396943969539696396973969839699397003970139702397033970439705397063970739708397093971039711397123971339714397153971639717397183971939720397213972239723397243972539726397273972839729397303973139732397333973439735397363973739738397393974039741397423974339744397453974639747397483974939750397513975239753397543975539756397573975839759397603976139762397633976439765397663976739768397693977039771397723977339774397753977639777397783977939780397813978239783397843978539786397873978839789397903979139792397933979439795397963979739798397993980039801398023980339804398053980639807398083980939810398113981239813398143981539816398173981839819398203982139822398233982439825398263982739828398293983039831398323983339834398353983639837398383983939840398413984239843398443984539846398473984839849398503985139852398533985439855398563985739858398593986039861398623986339864398653986639867398683986939870398713987239873398743987539876398773987839879398803988139882398833988439885398863988739888398893989039891398923989339894398953989639897398983989939900399013990239903399043990539906399073990839909399103991139912399133991439915399163991739918399193992039921399223992339924399253992639927399283992939930399313993239933399343993539936399373993839939399403994139942399433994439945399463994739948399493995039951399523995339954399553995639957399583995939960399613996239963399643996539966399673996839969399703997139972399733997439975399763997739978399793998039981399823998339984399853998639987399883998939990399913999239993399943999539996399973999839999400004000140002400034000440005400064000740008400094001040011400124001340014400154001640017400184001940020400214002240023400244002540026400274002840029400304003140032400334003440035400364003740038400394004040041400424004340044400454004640047400484004940050400514005240053400544005540056400574005840059400604006140062400634006440065400664006740068400694007040071400724007340074400754007640077400784007940080400814008240083400844008540086400874008840089400904009140092400934009440095400964009740098400994010040101401024010340104401054010640107401084010940110401114011240113401144011540116401174011840119401204012140122401234012440125401264012740128401294013040131401324013340134401354013640137401384013940140401414014240143401444014540146401474014840149401504015140152401534015440155401564015740158401594016040161401624016340164401654016640167401684016940170401714017240173401744017540176401774017840179401804018140182401834018440185401864018740188401894019040191401924019340194401954019640197401984019940200402014020240203402044020540206402074020840209402104021140212402134021440215402164021740218402194022040221402224022340224402254022640227402284022940230402314023240233402344023540236402374023840239402404024140242402434024440245402464024740248402494025040251402524025340254402554025640257402584025940260402614026240263402644026540266402674026840269402704027140272402734027440275402764027740278402794028040281402824028340284402854028640287402884028940290402914029240293402944029540296402974029840299403004030140302403034030440305403064030740308403094031040311403124031340314403154031640317403184031940320403214032240323403244032540326403274032840329403304033140332403334033440335403364033740338403394034040341403424034340344403454034640347403484034940350403514035240353403544035540356403574035840359403604036140362403634036440365403664036740368403694037040371403724037340374403754037640377403784037940380403814038240383403844038540386403874038840389403904039140392403934039440395403964039740398403994040040401404024040340404404054040640407404084040940410404114041240413404144041540416404174041840419404204042140422404234042440425404264042740428404294043040431404324043340434404354043640437404384043940440404414044240443404444044540446404474044840449404504045140452404534045440455404564045740458404594046040461404624046340464404654046640467404684046940470404714047240473404744047540476404774047840479404804048140482404834048440485404864048740488404894049040491404924049340494404954049640497404984049940500405014050240503405044050540506405074050840509405104051140512405134051440515405164051740518405194052040521405224052340524405254052640527405284052940530405314053240533405344053540536405374053840539405404054140542405434054440545405464054740548405494055040551405524055340554405554055640557405584055940560405614056240563405644056540566405674056840569405704057140572405734057440575405764057740578405794058040581405824058340584405854058640587405884058940590405914059240593405944059540596405974059840599406004060140602406034060440605406064060740608406094061040611406124061340614406154061640617406184061940620406214062240623406244062540626406274062840629406304063140632406334063440635406364063740638406394064040641406424064340644406454064640647406484064940650406514065240653406544065540656406574065840659406604066140662406634066440665406664066740668406694067040671406724067340674406754067640677406784067940680406814068240683406844068540686406874068840689406904069140692406934069440695406964069740698406994070040701407024070340704407054070640707407084070940710407114071240713407144071540716407174071840719407204072140722407234072440725407264072740728407294073040731407324073340734407354073640737407384073940740407414074240743407444074540746407474074840749407504075140752407534075440755407564075740758407594076040761407624076340764407654076640767407684076940770407714077240773407744077540776407774077840779407804078140782407834078440785407864078740788407894079040791407924079340794407954079640797407984079940800408014080240803408044080540806408074080840809408104081140812408134081440815408164081740818408194082040821408224082340824408254082640827408284082940830408314083240833408344083540836408374083840839408404084140842408434084440845408464084740848408494085040851408524085340854408554085640857408584085940860408614086240863408644086540866408674086840869408704087140872408734087440875408764087740878408794088040881408824088340884408854088640887408884088940890408914089240893408944089540896408974089840899409004090140902409034090440905409064090740908409094091040911409124091340914409154091640917409184091940920409214092240923409244092540926409274092840929409304093140932409334093440935409364093740938409394094040941409424094340944409454094640947409484094940950409514095240953409544095540956409574095840959409604096140962409634096440965409664096740968409694097040971409724097340974409754097640977409784097940980409814098240983409844098540986409874098840989409904099140992409934099440995409964099740998409994100041001410024100341004410054100641007410084100941010410114101241013410144101541016410174101841019410204102141022410234102441025410264102741028410294103041031410324103341034410354103641037410384103941040410414104241043410444104541046410474104841049410504105141052410534105441055410564105741058410594106041061410624106341064410654106641067410684106941070410714107241073410744107541076410774107841079410804108141082410834108441085410864108741088410894109041091410924109341094410954109641097410984109941100411014110241103411044110541106411074110841109411104111141112411134111441115411164111741118411194112041121411224112341124411254112641127411284112941130411314113241133411344113541136411374113841139411404114141142411434114441145411464114741148411494115041151411524115341154411554115641157411584115941160411614116241163411644116541166411674116841169411704117141172411734117441175411764117741178411794118041181411824118341184411854118641187411884118941190411914119241193411944119541196411974119841199412004120141202412034120441205412064120741208412094121041211412124121341214412154121641217412184121941220412214122241223412244122541226412274122841229412304123141232412334123441235412364123741238412394124041241412424124341244412454124641247412484124941250412514125241253412544125541256412574125841259412604126141262412634126441265412664126741268412694127041271412724127341274412754127641277412784127941280412814128241283412844128541286412874128841289412904129141292412934129441295412964129741298412994130041301413024130341304413054130641307413084130941310413114131241313413144131541316413174131841319413204132141322413234132441325413264132741328413294133041331413324133341334413354133641337413384133941340413414134241343413444134541346413474134841349413504135141352413534135441355413564135741358413594136041361413624136341364413654136641367413684136941370413714137241373413744137541376413774137841379413804138141382413834138441385413864138741388413894139041391413924139341394413954139641397413984139941400414014140241403414044140541406414074140841409414104141141412414134141441415414164141741418414194142041421414224142341424414254142641427414284142941430414314143241433414344143541436414374143841439414404144141442414434144441445414464144741448414494145041451414524145341454414554145641457414584145941460414614146241463414644146541466414674146841469414704147141472414734147441475414764147741478414794148041481414824148341484414854148641487414884148941490414914149241493414944149541496414974149841499415004150141502415034150441505415064150741508415094151041511415124151341514415154151641517415184151941520415214152241523415244152541526415274152841529415304153141532415334153441535415364153741538415394154041541415424154341544415454154641547415484154941550415514155241553415544155541556415574155841559415604156141562415634156441565415664156741568415694157041571415724157341574415754157641577415784157941580415814158241583415844158541586415874158841589415904159141592415934159441595415964159741598415994160041601416024160341604416054160641607416084160941610416114161241613416144161541616416174161841619416204162141622416234162441625416264162741628416294163041631416324163341634416354163641637416384163941640416414164241643416444164541646416474164841649416504165141652416534165441655416564165741658416594166041661416624166341664416654166641667416684166941670416714167241673416744167541676416774167841679416804168141682416834168441685416864168741688416894169041691416924169341694416954169641697416984169941700417014170241703417044170541706417074170841709417104171141712417134171441715417164171741718417194172041721417224172341724417254172641727417284172941730417314173241733417344173541736417374173841739417404174141742417434174441745417464174741748417494175041751417524175341754417554175641757417584175941760417614176241763417644176541766417674176841769417704177141772417734177441775417764177741778417794178041781417824178341784417854178641787417884178941790417914179241793417944179541796417974179841799418004180141802418034180441805418064180741808418094181041811418124181341814418154181641817418184181941820418214182241823418244182541826418274182841829418304183141832418334183441835418364183741838418394184041841418424184341844418454184641847418484184941850418514185241853418544185541856418574185841859418604186141862418634186441865418664186741868418694187041871418724187341874418754187641877418784187941880418814188241883418844188541886418874188841889418904189141892418934189441895418964189741898418994190041901419024190341904419054190641907419084190941910419114191241913419144191541916419174191841919419204192141922419234192441925419264192741928419294193041931419324193341934419354193641937419384193941940419414194241943419444194541946419474194841949419504195141952419534195441955419564195741958419594196041961419624196341964419654196641967419684196941970419714197241973419744197541976419774197841979419804198141982419834198441985419864198741988419894199041991419924199341994419954199641997419984199942000420014200242003420044200542006420074200842009420104201142012420134201442015420164201742018420194202042021420224202342024420254202642027420284202942030420314203242033420344203542036420374203842039420404204142042420434204442045420464204742048420494205042051420524205342054420554205642057420584205942060420614206242063420644206542066420674206842069420704207142072420734207442075420764207742078420794208042081420824208342084420854208642087420884208942090420914209242093420944209542096420974209842099421004210142102421034210442105421064210742108421094211042111421124211342114421154211642117421184211942120421214212242123421244212542126421274212842129421304213142132421334213442135421364213742138421394214042141421424214342144421454214642147421484214942150421514215242153421544215542156421574215842159421604216142162421634216442165421664216742168421694217042171421724217342174421754217642177421784217942180421814218242183421844218542186421874218842189421904219142192421934219442195421964219742198421994220042201422024220342204422054220642207422084220942210422114221242213422144221542216422174221842219422204222142222422234222442225422264222742228422294223042231422324223342234422354223642237422384223942240422414224242243422444224542246422474224842249422504225142252422534225442255422564225742258422594226042261422624226342264422654226642267422684226942270422714227242273422744227542276422774227842279422804228142282422834228442285422864228742288422894229042291422924229342294422954229642297422984229942300423014230242303423044230542306423074230842309423104231142312423134231442315423164231742318423194232042321423224232342324423254232642327423284232942330423314233242333423344233542336423374233842339423404234142342423434234442345423464234742348423494235042351423524235342354423554235642357423584235942360423614236242363423644236542366423674236842369423704237142372423734237442375423764237742378423794238042381423824238342384423854238642387423884238942390423914239242393423944239542396423974239842399424004240142402424034240442405424064240742408424094241042411424124241342414424154241642417424184241942420424214242242423424244242542426424274242842429424304243142432424334243442435424364243742438424394244042441424424244342444424454244642447424484244942450424514245242453424544245542456424574245842459424604246142462424634246442465424664246742468424694247042471424724247342474424754247642477424784247942480424814248242483424844248542486424874248842489424904249142492424934249442495424964249742498424994250042501425024250342504425054250642507425084250942510425114251242513425144251542516425174251842519425204252142522425234252442525425264252742528425294253042531425324253342534425354253642537425384253942540425414254242543425444254542546425474254842549425504255142552425534255442555425564255742558425594256042561425624256342564425654256642567425684256942570425714257242573425744257542576425774257842579425804258142582425834258442585425864258742588425894259042591425924259342594425954259642597425984259942600426014260242603426044260542606426074260842609426104261142612426134261442615426164261742618426194262042621426224262342624426254262642627426284262942630426314263242633426344263542636426374263842639426404264142642426434264442645426464264742648426494265042651426524265342654426554265642657426584265942660426614266242663426644266542666426674266842669426704267142672426734267442675426764267742678426794268042681426824268342684426854268642687426884268942690426914269242693426944269542696426974269842699427004270142702427034270442705427064270742708427094271042711427124271342714427154271642717427184271942720427214272242723427244272542726427274272842729427304273142732427334273442735427364273742738427394274042741427424274342744427454274642747427484274942750427514275242753427544275542756427574275842759427604276142762427634276442765427664276742768427694277042771427724277342774427754277642777427784277942780427814278242783427844278542786427874278842789427904279142792427934279442795427964279742798427994280042801428024280342804428054280642807428084280942810428114281242813428144281542816428174281842819428204282142822428234282442825428264282742828428294283042831428324283342834428354283642837428384283942840428414284242843428444284542846428474284842849428504285142852428534285442855428564285742858428594286042861428624286342864428654286642867428684286942870428714287242873428744287542876428774287842879428804288142882428834288442885428864288742888428894289042891428924289342894428954289642897428984289942900429014290242903429044290542906429074290842909429104291142912429134291442915429164291742918429194292042921429224292342924429254292642927429284292942930429314293242933429344293542936429374293842939429404294142942429434294442945429464294742948429494295042951429524295342954429554295642957429584295942960429614296242963429644296542966429674296842969429704297142972429734297442975429764297742978429794298042981429824298342984429854298642987429884298942990429914299242993429944299542996429974299842999430004300143002430034300443005430064300743008430094301043011430124301343014430154301643017430184301943020430214302243023430244302543026430274302843029430304303143032430334303443035430364303743038430394304043041430424304343044430454304643047430484304943050430514305243053430544305543056430574305843059430604306143062430634306443065430664306743068430694307043071430724307343074430754307643077430784307943080430814308243083430844308543086430874308843089430904309143092430934309443095430964309743098430994310043101431024310343104431054310643107431084310943110431114311243113431144311543116431174311843119431204312143122431234312443125431264312743128431294313043131431324313343134431354313643137431384313943140431414314243143431444314543146431474314843149431504315143152431534315443155431564315743158431594316043161431624316343164431654316643167431684316943170431714317243173431744317543176431774317843179431804318143182431834318443185431864318743188431894319043191431924319343194431954319643197431984319943200432014320243203432044320543206432074320843209432104321143212432134321443215432164321743218432194322043221432224322343224432254322643227432284322943230432314323243233432344323543236432374323843239432404324143242432434324443245432464324743248432494325043251432524325343254432554325643257432584325943260432614326243263432644326543266432674326843269432704327143272432734327443275432764327743278432794328043281432824328343284432854328643287432884328943290432914329243293432944329543296432974329843299433004330143302433034330443305433064330743308433094331043311433124331343314433154331643317433184331943320433214332243323433244332543326433274332843329433304333143332433334333443335433364333743338433394334043341433424334343344433454334643347433484334943350433514335243353433544335543356433574335843359433604336143362433634336443365433664336743368433694337043371433724337343374433754337643377433784337943380433814338243383433844338543386433874338843389433904339143392433934339443395433964339743398433994340043401434024340343404434054340643407434084340943410434114341243413434144341543416434174341843419434204342143422434234342443425434264342743428434294343043431434324343343434434354343643437434384343943440434414344243443434444344543446434474344843449434504345143452434534345443455434564345743458434594346043461434624346343464434654346643467434684346943470434714347243473434744347543476434774347843479434804348143482434834348443485434864348743488434894349043491434924349343494434954349643497434984349943500435014350243503435044350543506435074350843509435104351143512435134351443515435164351743518435194352043521435224352343524435254352643527435284352943530435314353243533435344353543536435374353843539435404354143542435434354443545435464354743548435494355043551435524355343554435554355643557435584355943560435614356243563435644356543566435674356843569435704357143572435734357443575435764357743578435794358043581435824358343584435854358643587435884358943590435914359243593435944359543596435974359843599436004360143602436034360443605436064360743608436094361043611436124361343614436154361643617436184361943620436214362243623436244362543626436274362843629436304363143632436334363443635436364363743638436394364043641436424364343644436454364643647436484364943650436514365243653436544365543656436574365843659436604366143662436634366443665436664366743668436694367043671436724367343674436754367643677436784367943680436814368243683436844368543686436874368843689436904369143692436934369443695436964369743698436994370043701437024370343704437054370643707437084370943710437114371243713437144371543716437174371843719437204372143722437234372443725437264372743728437294373043731437324373343734437354373643737437384373943740437414374243743437444374543746437474374843749437504375143752437534375443755437564375743758437594376043761437624376343764437654376643767437684376943770437714377243773437744377543776437774377843779437804378143782437834378443785437864378743788437894379043791437924379343794437954379643797437984379943800438014380243803438044380543806438074380843809438104381143812438134381443815438164381743818438194382043821438224382343824438254382643827438284382943830438314383243833438344383543836438374383843839438404384143842438434384443845438464384743848438494385043851438524385343854438554385643857438584385943860438614386243863438644386543866438674386843869438704387143872438734387443875438764387743878438794388043881438824388343884438854388643887438884388943890438914389243893438944389543896438974389843899439004390143902439034390443905439064390743908439094391043911439124391343914439154391643917439184391943920439214392243923439244392543926439274392843929439304393143932439334393443935439364393743938439394394043941439424394343944439454394643947439484394943950439514395243953439544395543956439574395843959439604396143962439634396443965439664396743968439694397043971439724397343974439754397643977439784397943980439814398243983439844398543986439874398843989439904399143992439934399443995439964399743998439994400044001440024400344004440054400644007440084400944010440114401244013440144401544016440174401844019440204402144022440234402444025440264402744028440294403044031440324403344034440354403644037440384403944040440414404244043440444404544046440474404844049440504405144052440534405444055440564405744058440594406044061440624406344064440654406644067440684406944070440714407244073440744407544076440774407844079440804408144082440834408444085440864408744088440894409044091440924409344094440954409644097440984409944100441014410244103441044410544106441074410844109441104411144112441134411444115441164411744118441194412044121441224412344124441254412644127441284412944130441314413244133441344413544136441374413844139441404414144142441434414444145441464414744148441494415044151441524415344154441554415644157441584415944160441614416244163441644416544166441674416844169441704417144172441734417444175441764417744178441794418044181441824418344184441854418644187441884418944190441914419244193441944419544196441974419844199442004420144202442034420444205442064420744208442094421044211442124421344214442154421644217442184421944220442214422244223442244422544226442274422844229442304423144232442334423444235442364423744238442394424044241442424424344244442454424644247442484424944250442514425244253442544425544256442574425844259442604426144262442634426444265442664426744268442694427044271442724427344274442754427644277442784427944280442814428244283442844428544286442874428844289442904429144292442934429444295442964429744298442994430044301443024430344304443054430644307443084430944310443114431244313443144431544316443174431844319443204432144322443234432444325443264432744328443294433044331443324433344334443354433644337443384433944340443414434244343443444434544346443474434844349443504435144352443534435444355443564435744358443594436044361443624436344364443654436644367443684436944370443714437244373443744437544376443774437844379443804438144382443834438444385443864438744388443894439044391443924439344394443954439644397443984439944400444014440244403444044440544406444074440844409444104441144412444134441444415444164441744418444194442044421444224442344424444254442644427444284442944430444314443244433444344443544436444374443844439444404444144442444434444444445444464444744448444494445044451444524445344454444554445644457444584445944460444614446244463444644446544466444674446844469444704447144472444734447444475444764447744478444794448044481444824448344484444854448644487444884448944490444914449244493444944449544496444974449844499445004450144502445034450444505445064450744508445094451044511445124451344514445154451644517445184451944520445214452244523445244452544526445274452844529445304453144532445334453444535445364453744538445394454044541445424454344544445454454644547445484454944550445514455244553445544455544556445574455844559445604456144562445634456444565445664456744568445694457044571445724457344574445754457644577445784457944580445814458244583445844458544586445874458844589445904459144592445934459444595445964459744598445994460044601446024460344604446054460644607446084460944610446114461244613446144461544616446174461844619446204462144622446234462444625446264462744628446294463044631446324463344634446354463644637446384463944640446414464244643446444464544646446474464844649446504465144652446534465444655446564465744658446594466044661446624466344664446654466644667446684466944670446714467244673446744467544676446774467844679446804468144682446834468444685446864468744688446894469044691446924469344694446954469644697446984469944700447014470244703447044470544706447074470844709447104471144712447134471444715447164471744718447194472044721447224472344724447254472644727447284472944730447314473244733447344473544736447374473844739447404474144742447434474444745447464474744748447494475044751447524475344754447554475644757447584475944760447614476244763447644476544766447674476844769447704477144772447734477444775447764477744778447794478044781447824478344784447854478644787447884478944790447914479244793447944479544796447974479844799448004480144802448034480444805448064480744808448094481044811448124481344814448154481644817448184481944820448214482244823448244482544826448274482844829448304483144832448334483444835448364483744838448394484044841448424484344844448454484644847448484484944850448514485244853448544485544856448574485844859448604486144862448634486444865448664486744868448694487044871448724487344874448754487644877448784487944880448814488244883448844488544886448874488844889448904489144892448934489444895448964489744898448994490044901449024490344904449054490644907449084490944910449114491244913449144491544916449174491844919449204492144922449234492444925449264492744928449294493044931449324493344934449354493644937449384493944940449414494244943449444494544946449474494844949449504495144952449534495444955449564495744958449594496044961449624496344964449654496644967449684496944970449714497244973449744497544976449774497844979449804498144982449834498444985449864498744988449894499044991449924499344994449954499644997449984499945000450014500245003450044500545006450074500845009450104501145012450134501445015450164501745018450194502045021450224502345024450254502645027450284502945030450314503245033450344503545036450374503845039450404504145042450434504445045450464504745048450494505045051450524505345054450554505645057450584505945060450614506245063450644506545066450674506845069450704507145072450734507445075450764507745078450794508045081450824508345084450854508645087450884508945090450914509245093450944509545096450974509845099451004510145102451034510445105451064510745108451094511045111451124511345114451154511645117451184511945120451214512245123451244512545126451274512845129451304513145132451334513445135451364513745138451394514045141451424514345144451454514645147451484514945150451514515245153451544515545156451574515845159451604516145162451634516445165451664516745168451694517045171451724517345174451754517645177451784517945180451814518245183451844518545186451874518845189451904519145192451934519445195451964519745198451994520045201452024520345204452054520645207452084520945210452114521245213452144521545216452174521845219452204522145222452234522445225452264522745228452294523045231452324523345234452354523645237452384523945240452414524245243452444524545246452474524845249452504525145252452534525445255452564525745258452594526045261452624526345264452654526645267452684526945270452714527245273452744527545276452774527845279452804528145282452834528445285452864528745288452894529045291452924529345294452954529645297452984529945300453014530245303453044530545306453074530845309453104531145312453134531445315453164531745318453194532045321453224532345324453254532645327453284532945330453314533245333453344533545336453374533845339453404534145342453434534445345453464534745348453494535045351453524535345354453554535645357453584535945360453614536245363453644536545366453674536845369453704537145372453734537445375453764537745378453794538045381453824538345384453854538645387453884538945390453914539245393453944539545396453974539845399454004540145402454034540445405454064540745408454094541045411454124541345414454154541645417454184541945420454214542245423454244542545426454274542845429454304543145432454334543445435454364543745438454394544045441454424544345444454454544645447454484544945450454514545245453454544545545456454574545845459454604546145462454634546445465454664546745468454694547045471454724547345474454754547645477454784547945480454814548245483454844548545486454874548845489454904549145492454934549445495454964549745498454994550045501455024550345504455054550645507455084550945510455114551245513455144551545516455174551845519455204552145522455234552445525455264552745528455294553045531455324553345534455354553645537455384553945540455414554245543455444554545546455474554845549455504555145552455534555445555455564555745558455594556045561455624556345564455654556645567455684556945570455714557245573455744557545576455774557845579455804558145582455834558445585455864558745588455894559045591455924559345594455954559645597455984559945600456014560245603456044560545606456074560845609456104561145612456134561445615456164561745618456194562045621456224562345624456254562645627456284562945630456314563245633456344563545636456374563845639456404564145642456434564445645456464564745648456494565045651456524565345654456554565645657456584565945660456614566245663456644566545666456674566845669456704567145672456734567445675456764567745678456794568045681456824568345684456854568645687456884568945690456914569245693456944569545696456974569845699457004570145702457034570445705457064570745708457094571045711457124571345714457154571645717457184571945720457214572245723457244572545726457274572845729457304573145732457334573445735457364573745738457394574045741457424574345744457454574645747457484574945750457514575245753457544575545756457574575845759457604576145762457634576445765457664576745768457694577045771457724577345774457754577645777457784577945780457814578245783457844578545786457874578845789457904579145792457934579445795457964579745798457994580045801458024580345804458054580645807458084580945810458114581245813458144581545816458174581845819458204582145822458234582445825458264582745828458294583045831458324583345834458354583645837458384583945840458414584245843458444584545846458474584845849458504585145852458534585445855458564585745858458594586045861458624586345864458654586645867458684586945870458714587245873458744587545876458774587845879458804588145882458834588445885458864588745888458894589045891458924589345894458954589645897458984589945900459014590245903459044590545906459074590845909459104591145912459134591445915459164591745918459194592045921459224592345924459254592645927459284592945930459314593245933459344593545936459374593845939459404594145942459434594445945459464594745948459494595045951459524595345954459554595645957459584595945960459614596245963459644596545966459674596845969459704597145972459734597445975459764597745978459794598045981459824598345984459854598645987459884598945990459914599245993459944599545996459974599845999460004600146002460034600446005460064600746008460094601046011460124601346014460154601646017460184601946020460214602246023460244602546026460274602846029460304603146032460334603446035460364603746038460394604046041460424604346044460454604646047460484604946050460514605246053460544605546056460574605846059460604606146062460634606446065460664606746068460694607046071460724607346074460754607646077460784607946080460814608246083460844608546086460874608846089460904609146092460934609446095460964609746098460994610046101461024610346104461054610646107461084610946110461114611246113461144611546116461174611846119461204612146122461234612446125461264612746128461294613046131461324613346134461354613646137461384613946140461414614246143461444614546146461474614846149461504615146152461534615446155461564615746158461594616046161461624616346164461654616646167461684616946170461714617246173461744617546176461774617846179461804618146182461834618446185461864618746188461894619046191461924619346194461954619646197461984619946200462014620246203462044620546206462074620846209462104621146212462134621446215462164621746218462194622046221462224622346224462254622646227462284622946230462314623246233462344623546236462374623846239462404624146242462434624446245462464624746248462494625046251462524625346254462554625646257462584625946260462614626246263462644626546266462674626846269462704627146272462734627446275462764627746278462794628046281462824628346284462854628646287462884628946290462914629246293462944629546296462974629846299463004630146302463034630446305463064630746308463094631046311463124631346314463154631646317463184631946320463214632246323463244632546326463274632846329463304633146332463334633446335463364633746338463394634046341463424634346344463454634646347463484634946350463514635246353463544635546356463574635846359463604636146362463634636446365463664636746368463694637046371463724637346374463754637646377463784637946380463814638246383463844638546386463874638846389463904639146392463934639446395463964639746398463994640046401464024640346404464054640646407464084640946410464114641246413464144641546416464174641846419464204642146422464234642446425464264642746428464294643046431464324643346434464354643646437464384643946440464414644246443464444644546446464474644846449464504645146452464534645446455464564645746458464594646046461464624646346464464654646646467464684646946470464714647246473464744647546476464774647846479464804648146482464834648446485464864648746488464894649046491464924649346494464954649646497464984649946500465014650246503465044650546506465074650846509465104651146512465134651446515465164651746518465194652046521465224652346524465254652646527465284652946530465314653246533465344653546536465374653846539465404654146542465434654446545465464654746548465494655046551465524655346554465554655646557465584655946560465614656246563465644656546566465674656846569465704657146572465734657446575465764657746578465794658046581465824658346584465854658646587465884658946590465914659246593465944659546596465974659846599466004660146602466034660446605466064660746608466094661046611466124661346614466154661646617466184661946620466214662246623466244662546626466274662846629466304663146632466334663446635466364663746638466394664046641466424664346644466454664646647466484664946650466514665246653466544665546656466574665846659466604666146662466634666446665466664666746668466694667046671466724667346674466754667646677466784667946680466814668246683466844668546686466874668846689466904669146692466934669446695466964669746698466994670046701467024670346704467054670646707467084670946710467114671246713467144671546716467174671846719467204672146722467234672446725467264672746728467294673046731467324673346734467354673646737467384673946740467414674246743467444674546746467474674846749467504675146752467534675446755467564675746758467594676046761467624676346764467654676646767467684676946770467714677246773467744677546776467774677846779467804678146782467834678446785467864678746788467894679046791467924679346794467954679646797467984679946800468014680246803468044680546806468074680846809468104681146812468134681446815468164681746818468194682046821468224682346824468254682646827468284682946830468314683246833468344683546836468374683846839468404684146842468434684446845468464684746848468494685046851468524685346854468554685646857468584685946860468614686246863468644686546866468674686846869468704687146872468734687446875468764687746878468794688046881468824688346884468854688646887468884688946890468914689246893468944689546896468974689846899469004690146902469034690446905469064690746908469094691046911469124691346914469154691646917469184691946920469214692246923469244692546926469274692846929469304693146932469334693446935469364693746938469394694046941469424694346944469454694646947469484694946950469514695246953469544695546956469574695846959469604696146962469634696446965469664696746968469694697046971469724697346974469754697646977469784697946980469814698246983469844698546986469874698846989469904699146992469934699446995469964699746998469994700047001470024700347004470054700647007470084700947010470114701247013470144701547016470174701847019470204702147022470234702447025470264702747028470294703047031470324703347034470354703647037470384703947040470414704247043470444704547046470474704847049470504705147052470534705447055470564705747058470594706047061470624706347064470654706647067470684706947070470714707247073470744707547076470774707847079470804708147082470834708447085470864708747088470894709047091470924709347094470954709647097470984709947100471014710247103471044710547106471074710847109471104711147112471134711447115471164711747118471194712047121471224712347124471254712647127471284712947130471314713247133471344713547136471374713847139471404714147142471434714447145471464714747148471494715047151471524715347154471554715647157471584715947160471614716247163471644716547166471674716847169471704717147172471734717447175471764717747178471794718047181471824718347184471854718647187471884718947190471914719247193471944719547196471974719847199472004720147202472034720447205472064720747208472094721047211472124721347214472154721647217472184721947220472214722247223472244722547226472274722847229472304723147232472334723447235472364723747238472394724047241472424724347244472454724647247472484724947250472514725247253472544725547256472574725847259472604726147262472634726447265472664726747268472694727047271472724727347274472754727647277472784727947280472814728247283472844728547286472874728847289472904729147292472934729447295472964729747298472994730047301473024730347304473054730647307473084730947310473114731247313473144731547316473174731847319473204732147322473234732447325473264732747328473294733047331473324733347334473354733647337473384733947340473414734247343473444734547346473474734847349473504735147352473534735447355473564735747358473594736047361473624736347364473654736647367473684736947370473714737247373473744737547376473774737847379473804738147382473834738447385473864738747388473894739047391473924739347394473954739647397473984739947400474014740247403474044740547406474074740847409474104741147412474134741447415474164741747418474194742047421474224742347424474254742647427474284742947430474314743247433474344743547436474374743847439474404744147442474434744447445474464744747448474494745047451474524745347454474554745647457474584745947460474614746247463474644746547466474674746847469474704747147472474734747447475474764747747478474794748047481474824748347484474854748647487474884748947490474914749247493474944749547496474974749847499475004750147502475034750447505475064750747508475094751047511475124751347514475154751647517475184751947520475214752247523475244752547526475274752847529475304753147532475334753447535475364753747538475394754047541475424754347544475454754647547475484754947550475514755247553475544755547556475574755847559475604756147562475634756447565475664756747568475694757047571475724757347574475754757647577475784757947580475814758247583475844758547586475874758847589475904759147592475934759447595475964759747598475994760047601476024760347604476054760647607476084760947610476114761247613476144761547616476174761847619476204762147622476234762447625476264762747628476294763047631476324763347634476354763647637476384763947640476414764247643476444764547646476474764847649476504765147652476534765447655476564765747658476594766047661476624766347664476654766647667476684766947670476714767247673476744767547676476774767847679476804768147682476834768447685476864768747688476894769047691476924769347694476954769647697476984769947700477014770247703477044770547706477074770847709477104771147712477134771447715477164771747718477194772047721477224772347724477254772647727477284772947730477314773247733477344773547736477374773847739477404774147742477434774447745477464774747748477494775047751477524775347754477554775647757477584775947760477614776247763477644776547766477674776847769477704777147772477734777447775477764777747778477794778047781477824778347784477854778647787477884778947790477914779247793477944779547796477974779847799478004780147802478034780447805478064780747808478094781047811478124781347814478154781647817478184781947820478214782247823478244782547826478274782847829478304783147832478334783447835478364783747838478394784047841478424784347844478454784647847478484784947850478514785247853478544785547856478574785847859478604786147862478634786447865478664786747868478694787047871478724787347874478754787647877478784787947880478814788247883478844788547886478874788847889478904789147892478934789447895478964789747898478994790047901479024790347904479054790647907479084790947910479114791247913479144791547916479174791847919479204792147922479234792447925479264792747928479294793047931479324793347934479354793647937479384793947940479414794247943479444794547946479474794847949479504795147952479534795447955479564795747958479594796047961479624796347964479654796647967479684796947970479714797247973479744797547976479774797847979479804798147982479834798447985479864798747988479894799047991479924799347994479954799647997479984799948000480014800248003480044800548006480074800848009480104801148012480134801448015480164801748018480194802048021480224802348024480254802648027480284802948030480314803248033480344803548036480374803848039480404804148042480434804448045480464804748048480494805048051480524805348054480554805648057480584805948060480614806248063480644806548066480674806848069480704807148072480734807448075480764807748078480794808048081480824808348084480854808648087480884808948090480914809248093480944809548096480974809848099481004810148102481034810448105481064810748108481094811048111481124811348114481154811648117481184811948120481214812248123481244812548126481274812848129481304813148132481334813448135481364813748138481394814048141481424814348144481454814648147481484814948150481514815248153481544815548156481574815848159481604816148162481634816448165481664816748168481694817048171481724817348174481754817648177481784817948180481814818248183481844818548186481874818848189481904819148192481934819448195481964819748198481994820048201482024820348204482054820648207482084820948210482114821248213482144821548216482174821848219482204822148222482234822448225482264822748228482294823048231482324823348234482354823648237482384823948240482414824248243482444824548246482474824848249482504825148252482534825448255482564825748258482594826048261482624826348264482654826648267482684826948270482714827248273482744827548276482774827848279482804828148282482834828448285482864828748288482894829048291482924829348294482954829648297482984829948300483014830248303483044830548306483074830848309483104831148312483134831448315483164831748318483194832048321483224832348324483254832648327483284832948330483314833248333483344833548336483374833848339483404834148342483434834448345483464834748348483494835048351483524835348354483554835648357483584835948360483614836248363483644836548366483674836848369483704837148372483734837448375483764837748378483794838048381483824838348384483854838648387483884838948390483914839248393483944839548396483974839848399484004840148402484034840448405484064840748408484094841048411484124841348414484154841648417484184841948420484214842248423484244842548426484274842848429484304843148432484334843448435484364843748438484394844048441484424844348444484454844648447484484844948450484514845248453484544845548456484574845848459484604846148462484634846448465484664846748468484694847048471484724847348474484754847648477484784847948480484814848248483484844848548486484874848848489484904849148492484934849448495484964849748498484994850048501485024850348504485054850648507485084850948510485114851248513485144851548516485174851848519485204852148522485234852448525485264852748528485294853048531485324853348534485354853648537485384853948540485414854248543485444854548546485474854848549485504855148552485534855448555485564855748558485594856048561485624856348564485654856648567485684856948570485714857248573485744857548576485774857848579485804858148582485834858448585485864858748588485894859048591485924859348594485954859648597485984859948600486014860248603486044860548606486074860848609486104861148612486134861448615486164861748618486194862048621486224862348624486254862648627486284862948630486314863248633486344863548636486374863848639486404864148642486434864448645486464864748648486494865048651486524865348654486554865648657486584865948660486614866248663486644866548666486674866848669486704867148672486734867448675486764867748678486794868048681486824868348684486854868648687486884868948690486914869248693486944869548696486974869848699487004870148702487034870448705487064870748708487094871048711487124871348714487154871648717487184871948720487214872248723487244872548726487274872848729487304873148732487334873448735487364873748738487394874048741487424874348744487454874648747487484874948750487514875248753487544875548756487574875848759487604876148762487634876448765487664876748768487694877048771487724877348774487754877648777487784877948780487814878248783487844878548786487874878848789487904879148792487934879448795487964879748798487994880048801488024880348804488054880648807488084880948810488114881248813488144881548816488174881848819488204882148822488234882448825488264882748828488294883048831488324883348834488354883648837488384883948840488414884248843488444884548846488474884848849488504885148852488534885448855488564885748858488594886048861488624886348864488654886648867488684886948870488714887248873488744887548876488774887848879488804888148882488834888448885488864888748888488894889048891488924889348894488954889648897488984889948900489014890248903489044890548906489074890848909489104891148912489134891448915489164891748918489194892048921489224892348924489254892648927489284892948930489314893248933489344893548936489374893848939489404894148942489434894448945489464894748948489494895048951489524895348954489554895648957489584895948960489614896248963489644896548966489674896848969489704897148972489734897448975489764897748978489794898048981489824898348984489854898648987489884898948990489914899248993489944899548996489974899848999490004900149002490034900449005490064900749008490094901049011490124901349014490154901649017490184901949020490214902249023490244902549026490274902849029490304903149032490334903449035490364903749038490394904049041490424904349044490454904649047490484904949050490514905249053490544905549056490574905849059490604906149062490634906449065490664906749068490694907049071490724907349074490754907649077490784907949080490814908249083490844908549086490874908849089490904909149092490934909449095490964909749098490994910049101491024910349104491054910649107491084910949110491114911249113491144911549116491174911849119491204912149122491234912449125491264912749128491294913049131491324913349134491354913649137491384913949140491414914249143491444914549146491474914849149491504915149152491534915449155491564915749158491594916049161491624916349164491654916649167491684916949170491714917249173491744917549176491774917849179491804918149182491834918449185491864918749188491894919049191491924919349194491954919649197491984919949200492014920249203492044920549206492074920849209492104921149212492134921449215492164921749218492194922049221492224922349224492254922649227492284922949230492314923249233492344923549236492374923849239492404924149242492434924449245492464924749248492494925049251492524925349254492554925649257492584925949260492614926249263492644926549266492674926849269492704927149272492734927449275492764927749278492794928049281492824928349284492854928649287492884928949290492914929249293492944929549296492974929849299493004930149302493034930449305493064930749308493094931049311493124931349314493154931649317493184931949320493214932249323493244932549326493274932849329493304933149332493334933449335493364933749338493394934049341493424934349344493454934649347493484934949350493514935249353493544935549356493574935849359493604936149362493634936449365493664936749368493694937049371493724937349374493754937649377493784937949380493814938249383493844938549386493874938849389493904939149392493934939449395493964939749398493994940049401494024940349404494054940649407494084940949410494114941249413494144941549416494174941849419494204942149422494234942449425494264942749428494294943049431494324943349434494354943649437494384943949440494414944249443494444944549446494474944849449494504945149452494534945449455494564945749458494594946049461494624946349464494654946649467494684946949470494714947249473494744947549476494774947849479494804948149482494834948449485494864948749488494894949049491494924949349494494954949649497494984949949500495014950249503495044950549506495074950849509495104951149512495134951449515495164951749518495194952049521495224952349524495254952649527495284952949530495314953249533495344953549536495374953849539495404954149542495434954449545495464954749548495494955049551495524955349554495554955649557495584955949560495614956249563495644956549566495674956849569495704957149572495734957449575495764957749578495794958049581495824958349584495854958649587495884958949590495914959249593495944959549596495974959849599496004960149602496034960449605496064960749608496094961049611496124961349614496154961649617496184961949620496214962249623496244962549626496274962849629496304963149632496334963449635496364963749638496394964049641496424964349644496454964649647496484964949650496514965249653496544965549656496574965849659496604966149662496634966449665496664966749668496694967049671496724967349674496754967649677496784967949680496814968249683496844968549686496874968849689496904969149692496934969449695496964969749698496994970049701497024970349704497054970649707497084970949710497114971249713497144971549716497174971849719497204972149722497234972449725497264972749728497294973049731497324973349734497354973649737497384973949740497414974249743497444974549746497474974849749497504975149752497534975449755497564975749758497594976049761497624976349764497654976649767497684976949770497714977249773497744977549776497774977849779497804978149782497834978449785497864978749788497894979049791497924979349794497954979649797497984979949800498014980249803498044980549806498074980849809498104981149812498134981449815498164981749818498194982049821498224982349824498254982649827498284982949830498314983249833498344983549836498374983849839498404984149842498434984449845498464984749848498494985049851498524985349854498554985649857498584985949860498614986249863498644986549866498674986849869498704987149872498734987449875498764987749878498794988049881498824988349884498854988649887498884988949890498914989249893498944989549896498974989849899499004990149902499034990449905499064990749908499094991049911499124991349914499154991649917499184991949920499214992249923499244992549926499274992849929499304993149932499334993449935499364993749938499394994049941499424994349944499454994649947499484994949950499514995249953499544995549956499574995849959499604996149962499634996449965499664996749968499694997049971499724997349974499754997649977499784997949980499814998249983499844998549986499874998849989499904999149992499934999449995499964999749998499995000050001500025000350004500055000650007500085000950010500115001250013500145001550016500175001850019500205002150022500235002450025500265002750028500295003050031500325003350034500355003650037500385003950040500415004250043500445004550046500475004850049500505005150052500535005450055500565005750058500595006050061500625006350064500655006650067500685006950070500715007250073500745007550076500775007850079500805008150082500835008450085500865008750088500895009050091500925009350094500955009650097500985009950100501015010250103501045010550106501075010850109501105011150112501135011450115501165011750118501195012050121501225012350124501255012650127501285012950130501315013250133501345013550136501375013850139501405014150142501435014450145501465014750148501495015050151501525015350154501555015650157501585015950160501615016250163501645016550166501675016850169501705017150172501735017450175501765017750178501795018050181501825018350184501855018650187501885018950190501915019250193501945019550196501975019850199502005020150202502035020450205502065020750208502095021050211502125021350214502155021650217502185021950220502215022250223502245022550226502275022850229502305023150232502335023450235502365023750238502395024050241502425024350244502455024650247502485024950250502515025250253502545025550256502575025850259502605026150262502635026450265502665026750268502695027050271502725027350274502755027650277502785027950280502815028250283502845028550286502875028850289502905029150292502935029450295502965029750298502995030050301503025030350304503055030650307503085030950310503115031250313503145031550316503175031850319503205032150322503235032450325503265032750328503295033050331503325033350334503355033650337503385033950340503415034250343503445034550346503475034850349503505035150352503535035450355503565035750358503595036050361503625036350364503655036650367503685036950370503715037250373503745037550376503775037850379503805038150382503835038450385503865038750388503895039050391503925039350394503955039650397503985039950400504015040250403504045040550406504075040850409504105041150412504135041450415504165041750418504195042050421504225042350424504255042650427504285042950430504315043250433504345043550436504375043850439504405044150442504435044450445504465044750448504495045050451504525045350454504555045650457504585045950460504615046250463504645046550466504675046850469504705047150472504735047450475504765047750478504795048050481504825048350484504855048650487504885048950490504915049250493504945049550496504975049850499505005050150502505035050450505505065050750508505095051050511505125051350514505155051650517505185051950520505215052250523505245052550526505275052850529505305053150532505335053450535505365053750538505395054050541505425054350544505455054650547505485054950550505515055250553505545055550556505575055850559505605056150562505635056450565505665056750568505695057050571505725057350574505755057650577505785057950580505815058250583505845058550586505875058850589505905059150592505935059450595505965059750598505995060050601506025060350604506055060650607506085060950610506115061250613506145061550616506175061850619506205062150622506235062450625506265062750628506295063050631506325063350634506355063650637506385063950640506415064250643506445064550646506475064850649506505065150652506535065450655506565065750658506595066050661506625066350664506655066650667506685066950670506715067250673506745067550676506775067850679506805068150682506835068450685506865068750688506895069050691506925069350694506955069650697506985069950700507015070250703507045070550706507075070850709507105071150712507135071450715507165071750718507195072050721507225072350724507255072650727507285072950730507315073250733507345073550736507375073850739507405074150742507435074450745507465074750748507495075050751507525075350754507555075650757507585075950760507615076250763507645076550766507675076850769507705077150772507735077450775507765077750778507795078050781507825078350784507855078650787507885078950790507915079250793507945079550796507975079850799508005080150802508035080450805508065080750808508095081050811508125081350814508155081650817508185081950820508215082250823508245082550826508275082850829508305083150832508335083450835508365083750838508395084050841508425084350844508455084650847508485084950850508515085250853508545085550856508575085850859508605086150862508635086450865508665086750868508695087050871508725087350874508755087650877508785087950880508815088250883508845088550886508875088850889508905089150892508935089450895508965089750898508995090050901509025090350904509055090650907509085090950910509115091250913509145091550916509175091850919509205092150922509235092450925509265092750928509295093050931509325093350934509355093650937509385093950940509415094250943509445094550946509475094850949509505095150952509535095450955509565095750958509595096050961509625096350964509655096650967509685096950970509715097250973509745097550976509775097850979509805098150982509835098450985509865098750988509895099050991509925099350994509955099650997509985099951000510015100251003510045100551006510075100851009510105101151012510135101451015510165101751018510195102051021510225102351024510255102651027510285102951030510315103251033510345103551036510375103851039510405104151042510435104451045510465104751048510495105051051510525105351054510555105651057510585105951060510615106251063510645106551066510675106851069510705107151072510735107451075510765107751078510795108051081510825108351084510855108651087510885108951090510915109251093510945109551096510975109851099511005110151102511035110451105511065110751108511095111051111511125111351114511155111651117511185111951120511215112251123511245112551126511275112851129511305113151132511335113451135511365113751138511395114051141511425114351144511455114651147511485114951150511515115251153511545115551156511575115851159511605116151162511635116451165511665116751168511695117051171511725117351174511755117651177511785117951180511815118251183511845118551186511875118851189511905119151192511935119451195511965119751198511995120051201512025120351204512055120651207512085120951210512115121251213512145121551216512175121851219512205122151222512235122451225512265122751228512295123051231512325123351234512355123651237512385123951240512415124251243512445124551246512475124851249512505125151252512535125451255512565125751258512595126051261512625126351264512655126651267512685126951270512715127251273512745127551276512775127851279512805128151282512835128451285512865128751288512895129051291512925129351294512955129651297512985129951300513015130251303513045130551306513075130851309513105131151312513135131451315513165131751318513195132051321513225132351324513255132651327513285132951330513315133251333513345133551336513375133851339513405134151342513435134451345513465134751348513495135051351513525135351354513555135651357513585135951360513615136251363513645136551366513675136851369513705137151372513735137451375513765137751378513795138051381513825138351384513855138651387513885138951390513915139251393513945139551396513975139851399514005140151402514035140451405514065140751408514095141051411514125141351414514155141651417514185141951420514215142251423514245142551426514275142851429514305143151432514335143451435514365143751438514395144051441514425144351444514455144651447514485144951450514515145251453514545145551456514575145851459514605146151462514635146451465514665146751468514695147051471514725147351474514755147651477514785147951480514815148251483514845148551486514875148851489514905149151492514935149451495514965149751498514995150051501515025150351504515055150651507515085150951510515115151251513515145151551516515175151851519515205152151522515235152451525515265152751528515295153051531515325153351534515355153651537515385153951540515415154251543515445154551546515475154851549515505155151552515535155451555515565155751558515595156051561515625156351564515655156651567515685156951570515715157251573515745157551576515775157851579515805158151582515835158451585515865158751588515895159051591515925159351594515955159651597515985159951600516015160251603516045160551606516075160851609516105161151612516135161451615516165161751618516195162051621516225162351624516255162651627516285162951630516315163251633516345163551636516375163851639516405164151642516435164451645516465164751648516495165051651516525165351654516555165651657516585165951660516615166251663516645166551666516675166851669516705167151672516735167451675516765167751678516795168051681516825168351684516855168651687516885168951690516915169251693516945169551696516975169851699517005170151702517035170451705517065170751708517095171051711517125171351714517155171651717517185171951720517215172251723517245172551726517275172851729517305173151732517335173451735517365173751738517395174051741517425174351744517455174651747517485174951750517515175251753517545175551756517575175851759517605176151762517635176451765517665176751768517695177051771517725177351774517755177651777517785177951780517815178251783517845178551786517875178851789517905179151792517935179451795517965179751798517995180051801518025180351804518055180651807518085180951810518115181251813518145181551816518175181851819518205182151822518235182451825518265182751828518295183051831518325183351834518355183651837518385183951840518415184251843518445184551846518475184851849518505185151852518535185451855518565185751858518595186051861518625186351864518655186651867518685186951870518715187251873518745187551876518775187851879518805188151882518835188451885518865188751888518895189051891518925189351894518955189651897518985189951900519015190251903519045190551906519075190851909519105191151912519135191451915519165191751918519195192051921519225192351924519255192651927519285192951930519315193251933519345193551936519375193851939519405194151942519435194451945519465194751948519495195051951519525195351954519555195651957519585195951960519615196251963519645196551966519675196851969519705197151972519735197451975519765197751978519795198051981519825198351984519855198651987519885198951990519915199251993519945199551996519975199851999520005200152002520035200452005520065200752008520095201052011520125201352014520155201652017520185201952020520215202252023520245202552026520275202852029520305203152032520335203452035520365203752038520395204052041520425204352044520455204652047520485204952050520515205252053520545205552056520575205852059520605206152062520635206452065520665206752068520695207052071520725207352074520755207652077520785207952080520815208252083520845208552086520875208852089520905209152092520935209452095520965209752098520995210052101521025210352104521055210652107521085210952110521115211252113521145211552116521175211852119521205212152122521235212452125521265212752128521295213052131521325213352134521355213652137521385213952140521415214252143521445214552146521475214852149521505215152152521535215452155521565215752158521595216052161521625216352164521655216652167521685216952170521715217252173521745217552176521775217852179521805218152182521835218452185521865218752188521895219052191521925219352194521955219652197521985219952200522015220252203522045220552206522075220852209522105221152212522135221452215522165221752218522195222052221522225222352224522255222652227522285222952230522315223252233522345223552236522375223852239522405224152242522435224452245522465224752248522495225052251522525225352254522555225652257522585225952260522615226252263522645226552266522675226852269522705227152272522735227452275522765227752278522795228052281522825228352284522855228652287522885228952290522915229252293522945229552296522975229852299523005230152302523035230452305523065230752308523095231052311523125231352314523155231652317523185231952320523215232252323523245232552326523275232852329523305233152332523335233452335523365233752338523395234052341523425234352344523455234652347523485234952350523515235252353523545235552356523575235852359523605236152362523635236452365523665236752368523695237052371523725237352374523755237652377523785237952380523815238252383523845238552386523875238852389523905239152392523935239452395523965239752398523995240052401524025240352404524055240652407524085240952410524115241252413524145241552416524175241852419524205242152422524235242452425524265242752428524295243052431524325243352434524355243652437524385243952440524415244252443524445244552446524475244852449524505245152452524535245452455524565245752458524595246052461524625246352464524655246652467524685246952470524715247252473524745247552476524775247852479524805248152482524835248452485524865248752488524895249052491524925249352494524955249652497524985249952500525015250252503525045250552506525075250852509525105251152512525135251452515525165251752518525195252052521525225252352524525255252652527525285252952530525315253252533525345253552536525375253852539525405254152542525435254452545525465254752548525495255052551525525255352554525555255652557525585255952560525615256252563525645256552566525675256852569525705257152572525735257452575525765257752578525795258052581525825258352584525855258652587525885258952590525915259252593525945259552596525975259852599526005260152602526035260452605526065260752608526095261052611526125261352614526155261652617526185261952620526215262252623526245262552626526275262852629526305263152632526335263452635526365263752638526395264052641526425264352644526455264652647526485264952650526515265252653526545265552656526575265852659526605266152662526635266452665526665266752668526695267052671526725267352674526755267652677526785267952680526815268252683526845268552686526875268852689526905269152692526935269452695526965269752698526995270052701527025270352704527055270652707527085270952710527115271252713527145271552716527175271852719527205272152722527235272452725527265272752728527295273052731527325273352734527355273652737527385273952740527415274252743527445274552746527475274852749527505275152752527535275452755527565275752758527595276052761527625276352764527655276652767527685276952770527715277252773527745277552776527775277852779527805278152782527835278452785527865278752788527895279052791527925279352794527955279652797527985279952800528015280252803528045280552806528075280852809528105281152812528135281452815528165281752818528195282052821528225282352824528255282652827528285282952830528315283252833528345283552836528375283852839528405284152842528435284452845528465284752848528495285052851528525285352854528555285652857528585285952860528615286252863528645286552866528675286852869528705287152872528735287452875528765287752878528795288052881528825288352884528855288652887528885288952890528915289252893528945289552896528975289852899529005290152902529035290452905529065290752908529095291052911529125291352914529155291652917529185291952920529215292252923529245292552926529275292852929529305293152932529335293452935529365293752938529395294052941529425294352944529455294652947529485294952950529515295252953529545295552956529575295852959529605296152962529635296452965529665296752968529695297052971529725297352974529755297652977529785297952980529815298252983529845298552986529875298852989529905299152992529935299452995529965299752998529995300053001530025300353004530055300653007530085300953010530115301253013530145301553016530175301853019530205302153022530235302453025530265302753028530295303053031530325303353034530355303653037530385303953040530415304253043530445304553046530475304853049530505305153052530535305453055530565305753058530595306053061530625306353064530655306653067530685306953070530715307253073530745307553076530775307853079530805308153082530835308453085530865308753088530895309053091530925309353094530955309653097530985309953100531015310253103531045310553106531075310853109531105311153112531135311453115531165311753118531195312053121531225312353124531255312653127531285312953130531315313253133531345313553136531375313853139531405314153142531435314453145531465314753148531495315053151531525315353154531555315653157531585315953160531615316253163531645316553166531675316853169531705317153172531735317453175531765317753178531795318053181531825318353184531855318653187531885318953190531915319253193531945319553196531975319853199532005320153202532035320453205532065320753208532095321053211532125321353214532155321653217532185321953220532215322253223532245322553226532275322853229532305323153232532335323453235532365323753238532395324053241532425324353244532455324653247532485324953250532515325253253532545325553256532575325853259532605326153262532635326453265532665326753268532695327053271532725327353274532755327653277532785327953280532815328253283532845328553286532875328853289532905329153292532935329453295532965329753298532995330053301533025330353304533055330653307533085330953310533115331253313533145331553316533175331853319533205332153322533235332453325533265332753328533295333053331533325333353334533355333653337533385333953340533415334253343533445334553346533475334853349533505335153352533535335453355533565335753358533595336053361533625336353364533655336653367533685336953370533715337253373533745337553376533775337853379533805338153382533835338453385533865338753388533895339053391533925339353394533955339653397533985339953400534015340253403534045340553406534075340853409534105341153412534135341453415534165341753418534195342053421534225342353424534255342653427534285342953430534315343253433534345343553436534375343853439534405344153442534435344453445534465344753448534495345053451534525345353454534555345653457534585345953460534615346253463534645346553466534675346853469534705347153472534735347453475534765347753478534795348053481534825348353484534855348653487534885348953490534915349253493534945349553496534975349853499535005350153502535035350453505535065350753508535095351053511535125351353514535155351653517535185351953520535215352253523535245352553526535275352853529535305353153532535335353453535535365353753538535395354053541535425354353544535455354653547535485354953550535515355253553535545355553556535575355853559535605356153562535635356453565535665356753568535695357053571535725357353574535755357653577535785357953580535815358253583535845358553586535875358853589535905359153592535935359453595535965359753598535995360053601536025360353604536055360653607536085360953610536115361253613536145361553616536175361853619536205362153622536235362453625536265362753628536295363053631536325363353634536355363653637536385363953640536415364253643536445364553646536475364853649536505365153652536535365453655536565365753658536595366053661536625366353664536655366653667536685366953670536715367253673536745367553676536775367853679536805368153682536835368453685536865368753688536895369053691536925369353694536955369653697536985369953700537015370253703537045370553706537075370853709537105371153712537135371453715537165371753718537195372053721537225372353724537255372653727537285372953730537315373253733537345373553736537375373853739537405374153742537435374453745537465374753748537495375053751537525375353754537555375653757537585375953760537615376253763537645376553766537675376853769537705377153772537735377453775537765377753778537795378053781537825378353784537855378653787537885378953790537915379253793537945379553796537975379853799538005380153802538035380453805538065380753808538095381053811538125381353814538155381653817538185381953820538215382253823538245382553826538275382853829538305383153832538335383453835538365383753838538395384053841538425384353844538455384653847538485384953850538515385253853538545385553856538575385853859538605386153862538635386453865538665386753868538695387053871538725387353874538755387653877538785387953880538815388253883538845388553886538875388853889538905389153892538935389453895538965389753898538995390053901539025390353904539055390653907539085390953910539115391253913539145391553916539175391853919539205392153922539235392453925539265392753928539295393053931539325393353934539355393653937539385393953940539415394253943539445394553946539475394853949539505395153952539535395453955539565395753958539595396053961539625396353964539655396653967539685396953970539715397253973539745397553976539775397853979539805398153982539835398453985539865398753988539895399053991539925399353994539955399653997539985399954000540015400254003540045400554006540075400854009540105401154012540135401454015540165401754018540195402054021540225402354024540255402654027540285402954030540315403254033540345403554036540375403854039540405404154042540435404454045540465404754048540495405054051540525405354054540555405654057540585405954060540615406254063540645406554066540675406854069540705407154072540735407454075540765407754078540795408054081540825408354084540855408654087540885408954090540915409254093540945409554096540975409854099541005410154102541035410454105541065410754108541095411054111541125411354114541155411654117541185411954120541215412254123541245412554126541275412854129541305413154132541335413454135541365413754138541395414054141541425414354144541455414654147541485414954150541515415254153541545415554156541575415854159541605416154162541635416454165541665416754168541695417054171541725417354174541755417654177541785417954180541815418254183541845418554186541875418854189541905419154192541935419454195541965419754198541995420054201542025420354204542055420654207542085420954210542115421254213542145421554216542175421854219542205422154222542235422454225542265422754228542295423054231542325423354234542355423654237542385423954240542415424254243542445424554246542475424854249542505425154252542535425454255542565425754258542595426054261542625426354264542655426654267542685426954270542715427254273542745427554276542775427854279542805428154282542835428454285542865428754288542895429054291542925429354294542955429654297542985429954300543015430254303543045430554306543075430854309543105431154312543135431454315543165431754318543195432054321543225432354324543255432654327543285432954330543315433254333543345433554336543375433854339543405434154342543435434454345543465434754348543495435054351543525435354354543555435654357543585435954360543615436254363543645436554366543675436854369543705437154372543735437454375543765437754378543795438054381543825438354384543855438654387543885438954390543915439254393543945439554396543975439854399544005440154402544035440454405544065440754408544095441054411544125441354414544155441654417544185441954420544215442254423544245442554426544275442854429544305443154432544335443454435544365443754438544395444054441544425444354444544455444654447544485444954450544515445254453544545445554456544575445854459544605446154462544635446454465544665446754468544695447054471544725447354474544755447654477544785447954480544815448254483544845448554486544875448854489544905449154492544935449454495544965449754498544995450054501545025450354504545055450654507545085450954510545115451254513545145451554516545175451854519545205452154522545235452454525545265452754528545295453054531545325453354534545355453654537545385453954540545415454254543545445454554546545475454854549545505455154552545535455454555545565455754558545595456054561545625456354564545655456654567545685456954570545715457254573545745457554576545775457854579545805458154582545835458454585545865458754588545895459054591545925459354594545955459654597545985459954600546015460254603546045460554606546075460854609546105461154612546135461454615546165461754618546195462054621546225462354624546255462654627546285462954630546315463254633546345463554636546375463854639546405464154642546435464454645546465464754648546495465054651546525465354654546555465654657546585465954660546615466254663546645466554666546675466854669546705467154672546735467454675546765467754678546795468054681546825468354684546855468654687546885468954690546915469254693546945469554696546975469854699547005470154702547035470454705547065470754708547095471054711547125471354714547155471654717547185471954720547215472254723547245472554726547275472854729547305473154732547335473454735547365473754738547395474054741547425474354744547455474654747547485474954750547515475254753547545475554756547575475854759547605476154762547635476454765547665476754768547695477054771547725477354774547755477654777547785477954780547815478254783547845478554786547875478854789547905479154792547935479454795547965479754798547995480054801548025480354804548055480654807548085480954810548115481254813548145481554816548175481854819548205482154822548235482454825548265482754828548295483054831548325483354834548355483654837548385483954840548415484254843548445484554846548475484854849548505485154852548535485454855548565485754858548595486054861548625486354864548655486654867548685486954870548715487254873548745487554876548775487854879548805488154882548835488454885548865488754888548895489054891548925489354894548955489654897548985489954900549015490254903549045490554906549075490854909549105491154912549135491454915549165491754918549195492054921549225492354924549255492654927549285492954930549315493254933549345493554936549375493854939549405494154942549435494454945549465494754948549495495054951549525495354954549555495654957549585495954960549615496254963549645496554966549675496854969549705497154972549735497454975549765497754978549795498054981549825498354984549855498654987549885498954990549915499254993549945499554996549975499854999550005500155002550035500455005550065500755008550095501055011550125501355014550155501655017550185501955020550215502255023550245502555026550275502855029550305503155032550335503455035550365503755038550395504055041550425504355044550455504655047550485504955050550515505255053550545505555056550575505855059550605506155062550635506455065550665506755068550695507055071550725507355074550755507655077550785507955080550815508255083550845508555086550875508855089550905509155092550935509455095550965509755098550995510055101551025510355104551055510655107551085510955110551115511255113551145511555116551175511855119551205512155122551235512455125551265512755128551295513055131551325513355134551355513655137551385513955140551415514255143551445514555146551475514855149551505515155152551535515455155551565515755158551595516055161551625516355164551655516655167551685516955170551715517255173551745517555176551775517855179551805518155182551835518455185551865518755188551895519055191551925519355194551955519655197551985519955200552015520255203552045520555206552075520855209552105521155212552135521455215552165521755218552195522055221552225522355224552255522655227552285522955230552315523255233552345523555236552375523855239552405524155242552435524455245552465524755248552495525055251552525525355254552555525655257552585525955260552615526255263552645526555266552675526855269552705527155272552735527455275552765527755278552795528055281552825528355284552855528655287552885528955290552915529255293552945529555296552975529855299553005530155302553035530455305553065530755308553095531055311553125531355314553155531655317553185531955320553215532255323553245532555326553275532855329553305533155332553335533455335553365533755338553395534055341553425534355344553455534655347553485534955350553515535255353553545535555356553575535855359553605536155362553635536455365553665536755368553695537055371553725537355374553755537655377553785537955380553815538255383553845538555386553875538855389553905539155392553935539455395553965539755398553995540055401554025540355404554055540655407554085540955410554115541255413554145541555416554175541855419554205542155422554235542455425554265542755428554295543055431554325543355434554355543655437554385543955440554415544255443554445544555446554475544855449554505545155452554535545455455554565545755458554595546055461554625546355464554655546655467554685546955470554715547255473554745547555476554775547855479554805548155482554835548455485554865548755488554895549055491554925549355494554955549655497554985549955500555015550255503555045550555506555075550855509555105551155512555135551455515555165551755518555195552055521555225552355524555255552655527555285552955530555315553255533555345553555536555375553855539555405554155542555435554455545555465554755548555495555055551555525555355554555555555655557555585555955560555615556255563555645556555566555675556855569555705557155572555735557455575555765557755578555795558055581555825558355584555855558655587555885558955590555915559255593555945559555596555975559855599556005560155602556035560455605556065560755608556095561055611556125561355614556155561655617556185561955620556215562255623556245562555626556275562855629556305563155632556335563455635556365563755638556395564055641556425564355644556455564655647556485564955650556515565255653556545565555656556575565855659556605566155662556635566455665556665566755668556695567055671556725567355674556755567655677556785567955680556815568255683556845568555686556875568855689556905569155692556935569455695556965569755698556995570055701557025570355704557055570655707557085570955710557115571255713557145571555716557175571855719557205572155722557235572455725557265572755728557295573055731557325573355734557355573655737557385573955740557415574255743557445574555746557475574855749557505575155752557535575455755557565575755758557595576055761557625576355764557655576655767557685576955770557715577255773557745577555776557775577855779557805578155782557835578455785557865578755788557895579055791557925579355794557955579655797557985579955800558015580255803558045580555806558075580855809558105581155812558135581455815558165581755818558195582055821558225582355824558255582655827558285582955830558315583255833558345583555836558375583855839558405584155842558435584455845558465584755848558495585055851558525585355854558555585655857558585585955860558615586255863558645586555866558675586855869558705587155872558735587455875558765587755878558795588055881558825588355884558855588655887558885588955890558915589255893558945589555896558975589855899559005590155902559035590455905559065590755908559095591055911559125591355914559155591655917559185591955920559215592255923559245592555926559275592855929559305593155932559335593455935559365593755938559395594055941559425594355944559455594655947559485594955950559515595255953559545595555956559575595855959559605596155962559635596455965559665596755968559695597055971559725597355974559755597655977559785597955980559815598255983559845598555986559875598855989559905599155992559935599455995559965599755998559995600056001560025600356004560055600656007560085600956010560115601256013560145601556016560175601856019560205602156022560235602456025560265602756028560295603056031560325603356034560355603656037560385603956040560415604256043560445604556046560475604856049560505605156052560535605456055560565605756058560595606056061560625606356064560655606656067560685606956070560715607256073560745607556076560775607856079560805608156082560835608456085560865608756088560895609056091560925609356094560955609656097560985609956100561015610256103561045610556106561075610856109561105611156112561135611456115561165611756118561195612056121561225612356124561255612656127561285612956130561315613256133561345613556136561375613856139561405614156142561435614456145561465614756148561495615056151561525615356154561555615656157561585615956160561615616256163561645616556166561675616856169561705617156172561735617456175561765617756178561795618056181561825618356184561855618656187561885618956190561915619256193561945619556196561975619856199562005620156202562035620456205562065620756208562095621056211562125621356214562155621656217562185621956220562215622256223562245622556226562275622856229562305623156232562335623456235562365623756238562395624056241562425624356244562455624656247562485624956250562515625256253562545625556256562575625856259562605626156262562635626456265562665626756268562695627056271562725627356274562755627656277562785627956280562815628256283562845628556286562875628856289562905629156292562935629456295562965629756298562995630056301563025630356304563055630656307563085630956310563115631256313563145631556316563175631856319563205632156322563235632456325563265632756328563295633056331563325633356334563355633656337563385633956340563415634256343563445634556346563475634856349563505635156352563535635456355563565635756358563595636056361563625636356364563655636656367563685636956370563715637256373563745637556376563775637856379563805638156382563835638456385563865638756388563895639056391563925639356394563955639656397563985639956400564015640256403564045640556406564075640856409564105641156412564135641456415564165641756418564195642056421564225642356424564255642656427564285642956430564315643256433564345643556436564375643856439564405644156442564435644456445564465644756448564495645056451564525645356454564555645656457564585645956460564615646256463564645646556466564675646856469564705647156472564735647456475564765647756478564795648056481564825648356484564855648656487564885648956490564915649256493564945649556496564975649856499565005650156502565035650456505565065650756508565095651056511565125651356514565155651656517565185651956520565215652256523565245652556526565275652856529565305653156532565335653456535565365653756538565395654056541565425654356544565455654656547565485654956550565515655256553565545655556556565575655856559565605656156562565635656456565565665656756568565695657056571565725657356574565755657656577565785657956580565815658256583565845658556586565875658856589565905659156592565935659456595565965659756598565995660056601566025660356604566055660656607566085660956610566115661256613566145661556616566175661856619566205662156622566235662456625566265662756628566295663056631566325663356634566355663656637566385663956640566415664256643566445664556646566475664856649566505665156652566535665456655566565665756658566595666056661566625666356664566655666656667566685666956670566715667256673566745667556676566775667856679566805668156682566835668456685566865668756688566895669056691566925669356694566955669656697566985669956700567015670256703567045670556706567075670856709567105671156712567135671456715567165671756718567195672056721567225672356724567255672656727567285672956730567315673256733567345673556736567375673856739567405674156742567435674456745567465674756748567495675056751567525675356754567555675656757567585675956760567615676256763567645676556766567675676856769567705677156772567735677456775567765677756778567795678056781567825678356784567855678656787567885678956790567915679256793567945679556796567975679856799568005680156802568035680456805568065680756808568095681056811568125681356814568155681656817568185681956820568215682256823568245682556826568275682856829568305683156832568335683456835568365683756838568395684056841568425684356844568455684656847568485684956850568515685256853568545685556856568575685856859568605686156862568635686456865568665686756868568695687056871568725687356874568755687656877568785687956880568815688256883568845688556886568875688856889568905689156892568935689456895568965689756898568995690056901569025690356904569055690656907569085690956910569115691256913569145691556916569175691856919569205692156922569235692456925569265692756928569295693056931569325693356934569355693656937569385693956940569415694256943569445694556946569475694856949569505695156952569535695456955569565695756958569595696056961569625696356964569655696656967569685696956970569715697256973569745697556976569775697856979569805698156982569835698456985569865698756988569895699056991569925699356994569955699656997569985699957000570015700257003570045700557006570075700857009570105701157012570135701457015570165701757018570195702057021570225702357024570255702657027570285702957030570315703257033570345703557036570375703857039570405704157042570435704457045570465704757048570495705057051570525705357054570555705657057570585705957060570615706257063570645706557066570675706857069570705707157072570735707457075570765707757078570795708057081570825708357084570855708657087570885708957090570915709257093570945709557096570975709857099571005710157102571035710457105571065710757108571095711057111571125711357114571155711657117571185711957120571215712257123571245712557126571275712857129571305713157132571335713457135571365713757138571395714057141571425714357144571455714657147571485714957150571515715257153571545715557156571575715857159571605716157162571635716457165571665716757168571695717057171571725717357174571755717657177571785717957180571815718257183571845718557186571875718857189571905719157192571935719457195571965719757198571995720057201572025720357204572055720657207572085720957210572115721257213572145721557216572175721857219572205722157222572235722457225572265722757228572295723057231572325723357234572355723657237572385723957240572415724257243572445724557246572475724857249572505725157252572535725457255572565725757258572595726057261572625726357264572655726657267572685726957270572715727257273572745727557276572775727857279572805728157282572835728457285572865728757288572895729057291572925729357294572955729657297572985729957300573015730257303573045730557306573075730857309573105731157312573135731457315573165731757318573195732057321573225732357324573255732657327573285732957330573315733257333573345733557336573375733857339573405734157342573435734457345573465734757348573495735057351573525735357354573555735657357573585735957360573615736257363573645736557366573675736857369573705737157372573735737457375573765737757378573795738057381573825738357384573855738657387573885738957390573915739257393573945739557396573975739857399574005740157402574035740457405574065740757408574095741057411574125741357414574155741657417574185741957420574215742257423574245742557426574275742857429574305743157432574335743457435574365743757438574395744057441574425744357444574455744657447574485744957450574515745257453574545745557456574575745857459574605746157462574635746457465574665746757468574695747057471574725747357474574755747657477574785747957480574815748257483574845748557486574875748857489574905749157492574935749457495574965749757498574995750057501575025750357504575055750657507575085750957510575115751257513575145751557516575175751857519575205752157522575235752457525575265752757528575295753057531575325753357534575355753657537575385753957540575415754257543575445754557546575475754857549575505755157552575535755457555575565755757558575595756057561575625756357564575655756657567575685756957570575715757257573575745757557576575775757857579575805758157582575835758457585575865758757588575895759057591575925759357594575955759657597575985759957600576015760257603576045760557606576075760857609576105761157612576135761457615576165761757618576195762057621576225762357624576255762657627576285762957630576315763257633576345763557636576375763857639576405764157642576435764457645576465764757648576495765057651576525765357654576555765657657576585765957660576615766257663576645766557666576675766857669576705767157672576735767457675576765767757678576795768057681576825768357684576855768657687576885768957690576915769257693576945769557696576975769857699577005770157702577035770457705577065770757708577095771057711577125771357714577155771657717577185771957720577215772257723577245772557726577275772857729577305773157732577335773457735577365773757738577395774057741577425774357744577455774657747577485774957750577515775257753577545775557756577575775857759577605776157762577635776457765577665776757768577695777057771577725777357774577755777657777577785777957780577815778257783577845778557786577875778857789577905779157792577935779457795577965779757798577995780057801578025780357804578055780657807578085780957810578115781257813578145781557816578175781857819578205782157822578235782457825578265782757828578295783057831578325783357834578355783657837578385783957840578415784257843578445784557846578475784857849578505785157852578535785457855578565785757858578595786057861578625786357864578655786657867578685786957870578715787257873578745787557876578775787857879578805788157882578835788457885578865788757888578895789057891578925789357894578955789657897578985789957900579015790257903579045790557906579075790857909579105791157912579135791457915579165791757918579195792057921579225792357924579255792657927579285792957930579315793257933579345793557936579375793857939579405794157942579435794457945579465794757948579495795057951579525795357954579555795657957579585795957960579615796257963579645796557966579675796857969579705797157972579735797457975579765797757978579795798057981579825798357984579855798657987579885798957990579915799257993579945799557996579975799857999580005800158002580035800458005580065800758008580095801058011580125801358014580155801658017580185801958020580215802258023580245802558026580275802858029580305803158032580335803458035580365803758038580395804058041580425804358044580455804658047580485804958050580515805258053580545805558056580575805858059580605806158062580635806458065580665806758068580695807058071580725807358074580755807658077580785807958080580815808258083580845808558086580875808858089580905809158092580935809458095580965809758098580995810058101581025810358104581055810658107581085810958110581115811258113581145811558116581175811858119581205812158122581235812458125581265812758128581295813058131581325813358134581355813658137581385813958140581415814258143581445814558146581475814858149581505815158152581535815458155581565815758158581595816058161581625816358164581655816658167581685816958170581715817258173581745817558176581775817858179581805818158182581835818458185581865818758188581895819058191581925819358194581955819658197581985819958200582015820258203582045820558206582075820858209582105821158212582135821458215582165821758218582195822058221582225822358224582255822658227582285822958230582315823258233582345823558236582375823858239582405824158242582435824458245582465824758248582495825058251582525825358254582555825658257582585825958260582615826258263582645826558266582675826858269582705827158272582735827458275582765827758278582795828058281582825828358284582855828658287582885828958290582915829258293582945829558296582975829858299583005830158302583035830458305583065830758308583095831058311583125831358314583155831658317583185831958320583215832258323583245832558326583275832858329583305833158332583335833458335583365833758338583395834058341583425834358344583455834658347583485834958350583515835258353583545835558356583575835858359583605836158362583635836458365583665836758368583695837058371583725837358374583755837658377583785837958380583815838258383583845838558386583875838858389583905839158392583935839458395583965839758398583995840058401584025840358404584055840658407584085840958410584115841258413584145841558416584175841858419584205842158422584235842458425584265842758428584295843058431584325843358434584355843658437584385843958440584415844258443584445844558446584475844858449584505845158452584535845458455584565845758458584595846058461584625846358464584655846658467584685846958470584715847258473584745847558476584775847858479584805848158482584835848458485584865848758488584895849058491584925849358494584955849658497584985849958500585015850258503585045850558506585075850858509585105851158512585135851458515585165851758518585195852058521585225852358524585255852658527585285852958530585315853258533585345853558536585375853858539585405854158542585435854458545585465854758548585495855058551585525855358554585555855658557585585855958560585615856258563585645856558566585675856858569585705857158572585735857458575585765857758578585795858058581585825858358584585855858658587585885858958590585915859258593585945859558596585975859858599586005860158602586035860458605586065860758608586095861058611586125861358614586155861658617586185861958620586215862258623586245862558626586275862858629586305863158632586335863458635586365863758638586395864058641586425864358644586455864658647586485864958650586515865258653586545865558656586575865858659586605866158662586635866458665586665866758668586695867058671586725867358674586755867658677586785867958680586815868258683586845868558686586875868858689586905869158692586935869458695586965869758698586995870058701587025870358704587055870658707587085870958710587115871258713587145871558716587175871858719587205872158722587235872458725587265872758728587295873058731587325873358734587355873658737587385873958740587415874258743587445874558746587475874858749587505875158752587535875458755587565875758758587595876058761587625876358764587655876658767587685876958770587715877258773587745877558776587775877858779587805878158782587835878458785587865878758788587895879058791587925879358794587955879658797587985879958800588015880258803588045880558806588075880858809588105881158812588135881458815588165881758818588195882058821588225882358824588255882658827588285882958830588315883258833588345883558836588375883858839588405884158842588435884458845588465884758848588495885058851588525885358854588555885658857588585885958860588615886258863588645886558866588675886858869588705887158872588735887458875588765887758878588795888058881588825888358884588855888658887588885888958890588915889258893588945889558896588975889858899589005890158902589035890458905589065890758908589095891058911589125891358914589155891658917589185891958920589215892258923589245892558926589275892858929589305893158932589335893458935589365893758938589395894058941589425894358944589455894658947589485894958950589515895258953589545895558956589575895858959589605896158962589635896458965589665896758968589695897058971589725897358974589755897658977589785897958980589815898258983589845898558986589875898858989589905899158992589935899458995589965899758998589995900059001590025900359004590055900659007590085900959010590115901259013590145901559016590175901859019590205902159022590235902459025590265902759028590295903059031590325903359034590355903659037590385903959040590415904259043590445904559046590475904859049590505905159052590535905459055590565905759058590595906059061590625906359064590655906659067590685906959070590715907259073590745907559076590775907859079590805908159082590835908459085590865908759088590895909059091590925909359094590955909659097590985909959100591015910259103591045910559106591075910859109591105911159112591135911459115591165911759118591195912059121591225912359124591255912659127591285912959130591315913259133591345913559136591375913859139591405914159142591435914459145591465914759148591495915059151591525915359154591555915659157591585915959160591615916259163591645916559166591675916859169591705917159172591735917459175591765917759178591795918059181591825918359184591855918659187591885918959190591915919259193591945919559196591975919859199592005920159202592035920459205592065920759208592095921059211592125921359214592155921659217592185921959220592215922259223592245922559226592275922859229592305923159232592335923459235592365923759238592395924059241592425924359244592455924659247592485924959250592515925259253592545925559256592575925859259592605926159262592635926459265592665926759268592695927059271592725927359274592755927659277592785927959280592815928259283592845928559286592875928859289592905929159292592935929459295592965929759298592995930059301593025930359304593055930659307593085930959310593115931259313593145931559316593175931859319593205932159322593235932459325593265932759328593295933059331593325933359334593355933659337593385933959340593415934259343593445934559346593475934859349593505935159352593535935459355593565935759358593595936059361593625936359364593655936659367593685936959370593715937259373593745937559376593775937859379593805938159382593835938459385593865938759388593895939059391593925939359394593955939659397593985939959400594015940259403594045940559406594075940859409594105941159412594135941459415594165941759418594195942059421594225942359424594255942659427594285942959430594315943259433594345943559436594375943859439594405944159442594435944459445594465944759448594495945059451594525945359454594555945659457594585945959460594615946259463594645946559466594675946859469594705947159472594735947459475594765947759478594795948059481594825948359484594855948659487594885948959490594915949259493594945949559496594975949859499595005950159502595035950459505595065950759508595095951059511595125951359514595155951659517595185951959520595215952259523595245952559526595275952859529595305953159532595335953459535595365953759538595395954059541595425954359544595455954659547595485954959550595515955259553595545955559556595575955859559595605956159562595635956459565595665956759568595695957059571595725957359574595755957659577595785957959580595815958259583595845958559586595875958859589595905959159592595935959459595595965959759598595995960059601596025960359604596055960659607596085960959610596115961259613596145961559616596175961859619596205962159622596235962459625596265962759628596295963059631596325963359634596355963659637596385963959640596415964259643596445964559646596475964859649596505965159652596535965459655596565965759658596595966059661596625966359664596655966659667596685966959670596715967259673596745967559676596775967859679596805968159682596835968459685596865968759688596895969059691596925969359694596955969659697596985969959700597015970259703597045970559706597075970859709597105971159712597135971459715597165971759718597195972059721597225972359724597255972659727597285972959730597315973259733597345973559736597375973859739597405974159742597435974459745597465974759748597495975059751597525975359754597555975659757597585975959760597615976259763597645976559766597675976859769597705977159772597735977459775597765977759778597795978059781597825978359784597855978659787597885978959790597915979259793597945979559796597975979859799598005980159802598035980459805598065980759808598095981059811598125981359814598155981659817598185981959820598215982259823598245982559826598275982859829598305983159832598335983459835598365983759838598395984059841598425984359844598455984659847598485984959850598515985259853598545985559856598575985859859598605986159862598635986459865598665986759868598695987059871598725987359874598755987659877598785987959880598815988259883598845988559886598875988859889598905989159892598935989459895598965989759898598995990059901599025990359904599055990659907599085990959910599115991259913599145991559916599175991859919599205992159922599235992459925599265992759928599295993059931599325993359934599355993659937599385993959940599415994259943599445994559946599475994859949599505995159952599535995459955599565995759958599595996059961599625996359964599655996659967599685996959970599715997259973599745997559976599775997859979599805998159982599835998459985599865998759988599895999059991599925999359994599955999659997599985999960000600016000260003600046000560006600076000860009600106001160012600136001460015600166001760018600196002060021600226002360024600256002660027600286002960030600316003260033600346003560036600376003860039600406004160042600436004460045600466004760048600496005060051600526005360054600556005660057600586005960060600616006260063600646006560066600676006860069600706007160072600736007460075600766007760078600796008060081600826008360084600856008660087600886008960090600916009260093600946009560096600976009860099601006010160102601036010460105601066010760108601096011060111601126011360114601156011660117601186011960120601216012260123601246012560126601276012860129601306013160132601336013460135601366013760138601396014060141601426014360144601456014660147601486014960150601516015260153601546015560156601576015860159601606016160162601636016460165601666016760168601696017060171601726017360174601756017660177601786017960180601816018260183601846018560186601876018860189601906019160192601936019460195601966019760198601996020060201602026020360204602056020660207602086020960210602116021260213602146021560216602176021860219602206022160222602236022460225602266022760228602296023060231602326023360234602356023660237602386023960240602416024260243602446024560246602476024860249602506025160252602536025460255602566025760258602596026060261602626026360264602656026660267602686026960270602716027260273602746027560276602776027860279602806028160282602836028460285602866028760288602896029060291602926029360294602956029660297602986029960300603016030260303603046030560306603076030860309603106031160312603136031460315603166031760318603196032060321603226032360324603256032660327603286032960330603316033260333603346033560336603376033860339603406034160342603436034460345603466034760348603496035060351603526035360354603556035660357603586035960360603616036260363603646036560366603676036860369603706037160372603736037460375603766037760378603796038060381603826038360384603856038660387603886038960390603916039260393603946039560396603976039860399604006040160402604036040460405604066040760408604096041060411604126041360414604156041660417604186041960420604216042260423604246042560426604276042860429604306043160432604336043460435604366043760438604396044060441604426044360444604456044660447604486044960450604516045260453604546045560456604576045860459604606046160462604636046460465604666046760468604696047060471604726047360474604756047660477604786047960480604816048260483604846048560486604876048860489604906049160492604936049460495604966049760498604996050060501605026050360504605056050660507605086050960510605116051260513605146051560516605176051860519605206052160522605236052460525605266052760528605296053060531605326053360534605356053660537605386053960540605416054260543605446054560546605476054860549605506055160552605536055460555605566055760558605596056060561605626056360564605656056660567605686056960570605716057260573605746057560576605776057860579605806058160582605836058460585605866058760588605896059060591605926059360594605956059660597605986059960600606016060260603606046060560606606076060860609606106061160612606136061460615606166061760618606196062060621606226062360624606256062660627606286062960630606316063260633606346063560636606376063860639606406064160642606436064460645606466064760648606496065060651606526065360654606556065660657606586065960660606616066260663606646066560666606676066860669606706067160672606736067460675606766067760678606796068060681606826068360684606856068660687606886068960690606916069260693606946069560696606976069860699607006070160702607036070460705607066070760708607096071060711607126071360714607156071660717607186071960720607216072260723607246072560726607276072860729607306073160732607336073460735607366073760738607396074060741607426074360744607456074660747607486074960750607516075260753607546075560756607576075860759607606076160762607636076460765607666076760768607696077060771607726077360774607756077660777607786077960780607816078260783607846078560786607876078860789607906079160792607936079460795607966079760798607996080060801608026080360804608056080660807608086080960810608116081260813608146081560816608176081860819608206082160822608236082460825608266082760828608296083060831608326083360834608356083660837608386083960840608416084260843608446084560846608476084860849608506085160852608536085460855608566085760858608596086060861608626086360864608656086660867608686086960870608716087260873608746087560876608776087860879608806088160882608836088460885608866088760888608896089060891608926089360894608956089660897608986089960900609016090260903609046090560906609076090860909609106091160912609136091460915609166091760918609196092060921609226092360924609256092660927609286092960930609316093260933609346093560936609376093860939609406094160942609436094460945609466094760948609496095060951609526095360954609556095660957609586095960960609616096260963609646096560966609676096860969609706097160972609736097460975609766097760978609796098060981609826098360984609856098660987609886098960990609916099260993609946099560996609976099860999610006100161002610036100461005610066100761008610096101061011610126101361014610156101661017610186101961020610216102261023610246102561026610276102861029610306103161032610336103461035610366103761038610396104061041610426104361044610456104661047610486104961050610516105261053610546105561056610576105861059610606106161062610636106461065610666106761068610696107061071610726107361074610756107661077610786107961080610816108261083610846108561086610876108861089610906109161092610936109461095610966109761098610996110061101611026110361104611056110661107611086110961110611116111261113611146111561116611176111861119611206112161122611236112461125611266112761128611296113061131611326113361134611356113661137611386113961140611416114261143611446114561146611476114861149611506115161152611536115461155611566115761158611596116061161611626116361164611656116661167611686116961170611716117261173611746117561176611776117861179611806118161182611836118461185611866118761188611896119061191611926119361194611956119661197611986119961200612016120261203612046120561206612076120861209612106121161212612136121461215612166121761218612196122061221612226122361224612256122661227612286122961230612316123261233612346123561236612376123861239612406124161242612436124461245612466124761248612496125061251612526125361254612556125661257612586125961260612616126261263612646126561266612676126861269612706127161272612736127461275612766127761278612796128061281612826128361284612856128661287612886128961290612916129261293612946129561296612976129861299613006130161302613036130461305613066130761308613096131061311613126131361314613156131661317613186131961320613216132261323613246132561326613276132861329613306133161332613336133461335613366133761338613396134061341613426134361344613456134661347613486134961350613516135261353613546135561356613576135861359613606136161362613636136461365613666136761368613696137061371613726137361374613756137661377613786137961380613816138261383613846138561386613876138861389613906139161392613936139461395613966139761398613996140061401614026140361404614056140661407614086140961410614116141261413614146141561416614176141861419614206142161422614236142461425614266142761428614296143061431614326143361434614356143661437614386143961440614416144261443614446144561446614476144861449614506145161452614536145461455614566145761458614596146061461614626146361464614656146661467614686146961470614716147261473614746147561476614776147861479614806148161482614836148461485614866148761488614896149061491614926149361494614956149661497614986149961500615016150261503615046150561506615076150861509615106151161512615136151461515615166151761518615196152061521615226152361524615256152661527615286152961530615316153261533615346153561536615376153861539615406154161542615436154461545615466154761548615496155061551615526155361554615556155661557615586155961560615616156261563615646156561566615676156861569615706157161572615736157461575615766157761578615796158061581615826158361584615856158661587615886158961590615916159261593615946159561596615976159861599616006160161602616036160461605616066160761608616096161061611616126161361614616156161661617616186161961620616216162261623616246162561626616276162861629616306163161632616336163461635616366163761638616396164061641616426164361644616456164661647616486164961650616516165261653616546165561656616576165861659616606166161662616636166461665616666166761668616696167061671616726167361674616756167661677616786167961680616816168261683616846168561686616876168861689616906169161692616936169461695616966169761698616996170061701617026170361704617056170661707617086170961710617116171261713617146171561716617176171861719617206172161722617236172461725617266172761728617296173061731617326173361734617356173661737617386173961740617416174261743617446174561746617476174861749617506175161752617536175461755617566175761758617596176061761617626176361764617656176661767617686176961770617716177261773617746177561776617776177861779617806178161782617836178461785617866178761788617896179061791617926179361794617956179661797617986179961800618016180261803618046180561806618076180861809618106181161812618136181461815618166181761818618196182061821618226182361824618256182661827618286182961830618316183261833618346183561836618376183861839618406184161842618436184461845618466184761848618496185061851618526185361854618556185661857618586185961860618616186261863618646186561866618676186861869618706187161872618736187461875618766187761878618796188061881618826188361884618856188661887618886188961890618916189261893618946189561896618976189861899619006190161902619036190461905619066190761908619096191061911619126191361914619156191661917619186191961920619216192261923619246192561926619276192861929619306193161932619336193461935619366193761938619396194061941619426194361944619456194661947619486194961950619516195261953619546195561956619576195861959619606196161962619636196461965619666196761968619696197061971619726197361974619756197661977619786197961980619816198261983619846198561986619876198861989619906199161992619936199461995619966199761998619996200062001620026200362004620056200662007620086200962010620116201262013620146201562016620176201862019620206202162022620236202462025620266202762028620296203062031620326203362034620356203662037620386203962040620416204262043620446204562046620476204862049620506205162052620536205462055620566205762058620596206062061620626206362064620656206662067620686206962070620716207262073620746207562076620776207862079620806208162082620836208462085620866208762088620896209062091620926209362094620956209662097620986209962100621016210262103621046210562106621076210862109621106211162112621136211462115621166211762118621196212062121621226212362124621256212662127621286212962130621316213262133621346213562136621376213862139621406214162142621436214462145621466214762148621496215062151621526215362154621556215662157621586215962160621616216262163621646216562166621676216862169621706217162172621736217462175621766217762178621796218062181621826218362184621856218662187621886218962190621916219262193621946219562196621976219862199622006220162202622036220462205622066220762208622096221062211622126221362214622156221662217622186221962220622216222262223622246222562226622276222862229622306223162232622336223462235622366223762238622396224062241622426224362244622456224662247622486224962250622516225262253622546225562256622576225862259622606226162262622636226462265622666226762268622696227062271622726227362274622756227662277622786227962280622816228262283622846228562286622876228862289622906229162292622936229462295622966229762298622996230062301623026230362304623056230662307623086230962310623116231262313623146231562316623176231862319623206232162322623236232462325623266232762328623296233062331623326233362334623356233662337623386233962340623416234262343623446234562346623476234862349623506235162352623536235462355623566235762358623596236062361623626236362364623656236662367623686236962370623716237262373623746237562376623776237862379623806238162382623836238462385623866238762388623896239062391623926239362394623956239662397623986239962400624016240262403624046240562406624076240862409624106241162412624136241462415624166241762418624196242062421624226242362424624256242662427624286242962430624316243262433624346243562436624376243862439624406244162442624436244462445624466244762448624496245062451624526245362454624556245662457624586245962460624616246262463624646246562466624676246862469624706247162472624736247462475624766247762478624796248062481624826248362484624856248662487624886248962490624916249262493624946249562496624976249862499625006250162502625036250462505625066250762508625096251062511625126251362514625156251662517625186251962520625216252262523625246252562526625276252862529625306253162532625336253462535625366253762538625396254062541625426254362544625456254662547625486254962550625516255262553625546255562556625576255862559625606256162562625636256462565625666256762568625696257062571625726257362574625756257662577625786257962580625816258262583625846258562586625876258862589625906259162592625936259462595625966259762598625996260062601626026260362604626056260662607626086260962610626116261262613626146261562616626176261862619626206262162622626236262462625626266262762628626296263062631626326263362634626356263662637626386263962640626416264262643626446264562646626476264862649626506265162652626536265462655626566265762658626596266062661626626266362664626656266662667626686266962670626716267262673626746267562676626776267862679626806268162682626836268462685626866268762688626896269062691626926269362694626956269662697626986269962700627016270262703627046270562706627076270862709627106271162712627136271462715627166271762718627196272062721627226272362724627256272662727627286272962730627316273262733627346273562736627376273862739627406274162742627436274462745627466274762748627496275062751627526275362754627556275662757627586275962760627616276262763627646276562766627676276862769627706277162772627736277462775627766277762778627796278062781627826278362784627856278662787627886278962790627916279262793627946279562796627976279862799628006280162802628036280462805628066280762808628096281062811628126281362814628156281662817628186281962820628216282262823628246282562826628276282862829628306283162832628336283462835628366283762838628396284062841628426284362844628456284662847628486284962850628516285262853628546285562856628576285862859628606286162862628636286462865628666286762868628696287062871628726287362874628756287662877628786287962880628816288262883628846288562886628876288862889628906289162892628936289462895628966289762898628996290062901629026290362904629056290662907629086290962910629116291262913629146291562916629176291862919629206292162922629236292462925629266292762928629296293062931629326293362934629356293662937629386293962940629416294262943629446294562946629476294862949629506295162952629536295462955629566295762958629596296062961629626296362964629656296662967629686296962970629716297262973629746297562976629776297862979629806298162982629836298462985629866298762988629896299062991629926299362994629956299662997629986299963000630016300263003630046300563006630076300863009630106301163012630136301463015630166301763018630196302063021630226302363024630256302663027630286302963030630316303263033630346303563036630376303863039630406304163042630436304463045630466304763048630496305063051630526305363054630556305663057630586305963060630616306263063630646306563066630676306863069630706307163072630736307463075630766307763078630796308063081630826308363084630856308663087630886308963090630916309263093630946309563096630976309863099631006310163102631036310463105631066310763108631096311063111631126311363114631156311663117631186311963120631216312263123631246312563126631276312863129631306313163132631336313463135631366313763138631396314063141631426314363144631456314663147631486314963150631516315263153631546315563156631576315863159631606316163162631636316463165631666316763168631696317063171631726317363174631756317663177631786317963180631816318263183631846318563186631876318863189631906319163192631936319463195631966319763198631996320063201632026320363204632056320663207632086320963210632116321263213632146321563216632176321863219632206322163222632236322463225632266322763228632296323063231632326323363234632356323663237632386323963240632416324263243632446324563246632476324863249632506325163252632536325463255632566325763258632596326063261632626326363264632656326663267632686326963270632716327263273632746327563276632776327863279632806328163282632836328463285632866328763288632896329063291632926329363294632956329663297632986329963300633016330263303633046330563306633076330863309633106331163312633136331463315633166331763318633196332063321633226332363324633256332663327633286332963330633316333263333633346333563336633376333863339633406334163342633436334463345633466334763348633496335063351633526335363354633556335663357633586335963360633616336263363633646336563366633676336863369633706337163372633736337463375633766337763378633796338063381633826338363384633856338663387633886338963390633916339263393633946339563396633976339863399634006340163402634036340463405634066340763408634096341063411634126341363414634156341663417634186341963420634216342263423634246342563426634276342863429634306343163432634336343463435634366343763438634396344063441634426344363444634456344663447634486344963450634516345263453634546345563456634576345863459634606346163462634636346463465634666346763468634696347063471634726347363474634756347663477634786347963480634816348263483634846348563486634876348863489634906349163492634936349463495634966349763498634996350063501635026350363504635056350663507635086350963510635116351263513635146351563516635176351863519635206352163522635236352463525635266352763528635296353063531635326353363534635356353663537635386353963540635416354263543635446354563546635476354863549635506355163552635536355463555635566355763558635596356063561635626356363564635656356663567635686356963570635716357263573635746357563576635776357863579635806358163582635836358463585635866358763588635896359063591635926359363594635956359663597635986359963600636016360263603636046360563606636076360863609636106361163612636136361463615636166361763618636196362063621636226362363624636256362663627636286362963630636316363263633636346363563636636376363863639636406364163642636436364463645636466364763648636496365063651636526365363654636556365663657636586365963660636616366263663636646366563666636676366863669636706367163672636736367463675636766367763678636796368063681636826368363684636856368663687636886368963690636916369263693636946369563696636976369863699637006370163702637036370463705637066370763708637096371063711637126371363714637156371663717637186371963720637216372263723637246372563726637276372863729637306373163732637336373463735637366373763738637396374063741637426374363744637456374663747637486374963750637516375263753637546375563756637576375863759637606376163762637636376463765637666376763768637696377063771637726377363774637756377663777637786377963780637816378263783637846378563786637876378863789637906379163792637936379463795637966379763798637996380063801638026380363804638056380663807638086380963810638116381263813638146381563816638176381863819638206382163822638236382463825638266382763828638296383063831638326383363834638356383663837638386383963840638416384263843638446384563846638476384863849638506385163852638536385463855638566385763858638596386063861638626386363864638656386663867638686386963870638716387263873638746387563876638776387863879638806388163882638836388463885638866388763888638896389063891638926389363894638956389663897638986389963900639016390263903639046390563906639076390863909639106391163912639136391463915639166391763918639196392063921639226392363924639256392663927639286392963930639316393263933639346393563936639376393863939639406394163942639436394463945639466394763948639496395063951639526395363954639556395663957639586395963960639616396263963639646396563966639676396863969639706397163972639736397463975639766397763978639796398063981639826398363984639856398663987639886398963990639916399263993639946399563996639976399863999640006400164002640036400464005640066400764008640096401064011640126401364014640156401664017640186401964020640216402264023640246402564026640276402864029640306403164032640336403464035640366403764038640396404064041640426404364044640456404664047640486404964050640516405264053640546405564056640576405864059640606406164062640636406464065640666406764068640696407064071640726407364074640756407664077640786407964080640816408264083640846408564086640876408864089640906409164092640936409464095640966409764098640996410064101641026410364104641056410664107641086410964110641116411264113641146411564116641176411864119641206412164122641236412464125641266412764128641296413064131641326413364134641356413664137641386413964140641416414264143641446414564146641476414864149641506415164152641536415464155641566415764158641596416064161641626416364164641656416664167641686416964170641716417264173641746417564176641776417864179641806418164182641836418464185641866418764188641896419064191641926419364194641956419664197641986419964200642016420264203642046420564206642076420864209642106421164212642136421464215642166421764218642196422064221642226422364224642256422664227642286422964230642316423264233642346423564236642376423864239642406424164242642436424464245642466424764248642496425064251642526425364254642556425664257642586425964260642616426264263642646426564266642676426864269642706427164272642736427464275642766427764278642796428064281642826428364284642856428664287642886428964290642916429264293642946429564296642976429864299643006430164302643036430464305643066430764308643096431064311643126431364314643156431664317643186431964320643216432264323643246432564326643276432864329643306433164332643336433464335643366433764338643396434064341643426434364344643456434664347643486434964350643516435264353643546435564356643576435864359643606436164362643636436464365643666436764368643696437064371643726437364374643756437664377643786437964380643816438264383643846438564386643876438864389643906439164392643936439464395643966439764398643996440064401644026440364404644056440664407644086440964410644116441264413644146441564416644176441864419644206442164422644236442464425644266442764428644296443064431644326443364434644356443664437644386443964440644416444264443644446444564446644476444864449644506445164452644536445464455644566445764458644596446064461644626446364464644656446664467644686446964470644716447264473644746447564476644776447864479644806448164482644836448464485644866448764488644896449064491644926449364494644956449664497644986449964500645016450264503645046450564506645076450864509645106451164512645136451464515645166451764518645196452064521645226452364524645256452664527645286452964530645316453264533645346453564536645376453864539645406454164542645436454464545645466454764548645496455064551645526455364554645556455664557645586455964560645616456264563645646456564566645676456864569645706457164572645736457464575645766457764578645796458064581645826458364584645856458664587645886458964590645916459264593645946459564596645976459864599646006460164602646036460464605646066460764608646096461064611646126461364614646156461664617646186461964620646216462264623646246462564626646276462864629646306463164632646336463464635646366463764638646396464064641646426464364644646456464664647646486464964650646516465264653646546465564656646576465864659646606466164662646636466464665646666466764668646696467064671646726467364674646756467664677646786467964680646816468264683646846468564686646876468864689646906469164692646936469464695646966469764698646996470064701647026470364704647056470664707647086470964710647116471264713647146471564716647176471864719647206472164722647236472464725647266472764728647296473064731647326473364734647356473664737647386473964740647416474264743647446474564746647476474864749647506475164752647536475464755647566475764758647596476064761647626476364764647656476664767647686476964770647716477264773647746477564776647776477864779647806478164782647836478464785647866478764788647896479064791647926479364794647956479664797647986479964800648016480264803648046480564806648076480864809648106481164812648136481464815648166481764818648196482064821648226482364824648256482664827648286482964830648316483264833648346483564836648376483864839648406484164842648436484464845648466484764848648496485064851648526485364854648556485664857648586485964860648616486264863648646486564866648676486864869648706487164872648736487464875648766487764878648796488064881648826488364884648856488664887648886488964890648916489264893648946489564896648976489864899649006490164902649036490464905649066490764908649096491064911649126491364914649156491664917649186491964920649216492264923649246492564926649276492864929649306493164932649336493464935649366493764938649396494064941649426494364944649456494664947649486494964950649516495264953649546495564956649576495864959649606496164962649636496464965649666496764968649696497064971649726497364974649756497664977649786497964980649816498264983649846498564986649876498864989649906499164992649936499464995649966499764998649996500065001650026500365004650056500665007650086500965010650116501265013650146501565016650176501865019650206502165022650236502465025650266502765028650296503065031650326503365034650356503665037650386503965040650416504265043650446504565046650476504865049650506505165052650536505465055650566505765058650596506065061650626506365064650656506665067650686506965070650716507265073650746507565076650776507865079650806508165082650836508465085650866508765088650896509065091650926509365094650956509665097650986509965100651016510265103651046510565106651076510865109651106511165112651136511465115651166511765118651196512065121651226512365124651256512665127651286512965130651316513265133651346513565136651376513865139651406514165142651436514465145651466514765148651496515065151651526515365154651556515665157651586515965160651616516265163651646516565166651676516865169651706517165172651736517465175651766517765178651796518065181651826518365184651856518665187651886518965190651916519265193651946519565196651976519865199652006520165202652036520465205652066520765208652096521065211652126521365214652156521665217652186521965220652216522265223652246522565226652276522865229652306523165232652336523465235652366523765238652396524065241652426524365244652456524665247652486524965250652516525265253652546525565256652576525865259652606526165262652636526465265652666526765268652696527065271652726527365274652756527665277652786527965280652816528265283652846528565286652876528865289652906529165292652936529465295652966529765298652996530065301653026530365304653056530665307653086530965310653116531265313653146531565316653176531865319653206532165322653236532465325653266532765328653296533065331653326533365334653356533665337653386533965340653416534265343653446534565346653476534865349653506535165352653536535465355653566535765358653596536065361653626536365364653656536665367653686536965370653716537265373653746537565376653776537865379653806538165382653836538465385653866538765388653896539065391653926539365394653956539665397653986539965400654016540265403654046540565406654076540865409654106541165412654136541465415654166541765418654196542065421654226542365424654256542665427654286542965430654316543265433654346543565436654376543865439654406544165442654436544465445654466544765448654496545065451654526545365454654556545665457654586545965460654616546265463654646546565466654676546865469654706547165472654736547465475654766547765478654796548065481654826548365484654856548665487654886548965490654916549265493654946549565496654976549865499655006550165502655036550465505655066550765508655096551065511655126551365514655156551665517655186551965520655216552265523655246552565526655276552865529655306553165532655336553465535655366553765538655396554065541655426554365544655456554665547655486554965550655516555265553655546555565556655576555865559655606556165562655636556465565655666556765568655696557065571655726557365574655756557665577655786557965580655816558265583655846558565586655876558865589655906559165592655936559465595655966559765598655996560065601656026560365604656056560665607656086560965610656116561265613656146561565616656176561865619656206562165622656236562465625656266562765628656296563065631656326563365634656356563665637656386563965640656416564265643656446564565646656476564865649656506565165652656536565465655656566565765658656596566065661656626566365664656656566665667656686566965670656716567265673656746567565676656776567865679656806568165682656836568465685656866568765688656896569065691656926569365694656956569665697656986569965700657016570265703657046570565706657076570865709657106571165712657136571465715657166571765718657196572065721657226572365724657256572665727657286572965730657316573265733657346573565736657376573865739657406574165742657436574465745657466574765748657496575065751657526575365754657556575665757657586575965760657616576265763657646576565766657676576865769657706577165772657736577465775657766577765778657796578065781657826578365784657856578665787657886578965790657916579265793657946579565796657976579865799658006580165802658036580465805658066580765808658096581065811658126581365814658156581665817658186581965820658216582265823658246582565826658276582865829658306583165832658336583465835658366583765838658396584065841658426584365844658456584665847658486584965850658516585265853658546585565856658576585865859658606586165862658636586465865658666586765868658696587065871658726587365874658756587665877658786587965880658816588265883658846588565886658876588865889658906589165892658936589465895658966589765898658996590065901659026590365904659056590665907659086590965910659116591265913659146591565916659176591865919659206592165922659236592465925659266592765928659296593065931659326593365934659356593665937659386593965940659416594265943659446594565946659476594865949659506595165952659536595465955659566595765958659596596065961659626596365964659656596665967659686596965970659716597265973659746597565976659776597865979659806598165982659836598465985659866598765988659896599065991659926599365994659956599665997659986599966000660016600266003660046600566006660076600866009660106601166012660136601466015660166601766018660196602066021660226602366024660256602666027660286602966030660316603266033660346603566036660376603866039660406604166042660436604466045660466604766048660496605066051660526605366054660556605666057660586605966060660616606266063660646606566066660676606866069660706607166072660736607466075660766607766078660796608066081660826608366084660856608666087660886608966090660916609266093660946609566096660976609866099661006610166102661036610466105661066610766108661096611066111661126611366114661156611666117661186611966120661216612266123661246612566126661276612866129661306613166132661336613466135661366613766138661396614066141661426614366144661456614666147661486614966150661516615266153661546615566156661576615866159661606616166162661636616466165661666616766168661696617066171661726617366174661756617666177661786617966180661816618266183661846618566186661876618866189661906619166192661936619466195661966619766198661996620066201662026620366204662056620666207662086620966210662116621266213662146621566216662176621866219662206622166222662236622466225662266622766228662296623066231662326623366234662356623666237662386623966240662416624266243662446624566246662476624866249662506625166252662536625466255662566625766258662596626066261662626626366264662656626666267662686626966270662716627266273662746627566276662776627866279662806628166282662836628466285662866628766288662896629066291662926629366294662956629666297662986629966300663016630266303663046630566306663076630866309663106631166312663136631466315663166631766318663196632066321663226632366324663256632666327663286632966330663316633266333663346633566336663376633866339663406634166342663436634466345663466634766348663496635066351663526635366354663556635666357663586635966360663616636266363663646636566366663676636866369663706637166372663736637466375663766637766378663796638066381663826638366384663856638666387663886638966390663916639266393663946639566396663976639866399664006640166402664036640466405664066640766408664096641066411664126641366414664156641666417664186641966420664216642266423664246642566426664276642866429664306643166432664336643466435664366643766438664396644066441664426644366444664456644666447664486644966450664516645266453664546645566456664576645866459664606646166462664636646466465664666646766468664696647066471664726647366474664756647666477664786647966480664816648266483664846648566486664876648866489664906649166492664936649466495664966649766498664996650066501665026650366504665056650666507665086650966510665116651266513665146651566516665176651866519665206652166522665236652466525665266652766528665296653066531665326653366534665356653666537665386653966540665416654266543665446654566546665476654866549665506655166552665536655466555665566655766558665596656066561665626656366564665656656666567665686656966570665716657266573665746657566576665776657866579665806658166582665836658466585665866658766588665896659066591665926659366594665956659666597665986659966600666016660266603666046660566606666076660866609666106661166612666136661466615666166661766618666196662066621666226662366624666256662666627666286662966630666316663266633666346663566636666376663866639666406664166642666436664466645666466664766648666496665066651666526665366654666556665666657666586665966660666616666266663666646666566666666676666866669666706667166672666736667466675666766667766678666796668066681666826668366684666856668666687666886668966690666916669266693666946669566696666976669866699667006670166702667036670466705667066670766708667096671066711667126671366714667156671666717667186671966720667216672266723667246672566726667276672866729667306673166732667336673466735667366673766738667396674066741667426674366744667456674666747667486674966750667516675266753667546675566756667576675866759667606676166762667636676466765667666676766768667696677066771667726677366774667756677666777667786677966780667816678266783667846678566786667876678866789667906679166792667936679466795667966679766798667996680066801668026680366804668056680666807668086680966810668116681266813668146681566816668176681866819668206682166822668236682466825668266682766828668296683066831668326683366834668356683666837668386683966840668416684266843668446684566846668476684866849668506685166852668536685466855668566685766858668596686066861668626686366864668656686666867668686686966870668716687266873668746687566876668776687866879668806688166882668836688466885668866688766888668896689066891668926689366894668956689666897668986689966900669016690266903669046690566906669076690866909669106691166912669136691466915669166691766918669196692066921669226692366924669256692666927669286692966930669316693266933669346693566936669376693866939669406694166942669436694466945669466694766948669496695066951669526695366954669556695666957669586695966960669616696266963669646696566966669676696866969669706697166972669736697466975669766697766978669796698066981669826698366984669856698666987669886698966990669916699266993669946699566996669976699866999670006700167002670036700467005670066700767008670096701067011670126701367014670156701667017670186701967020670216702267023670246702567026670276702867029670306703167032670336703467035670366703767038670396704067041670426704367044670456704667047670486704967050670516705267053670546705567056670576705867059670606706167062670636706467065670666706767068670696707067071670726707367074670756707667077670786707967080670816708267083670846708567086670876708867089670906709167092670936709467095670966709767098670996710067101671026710367104671056710667107671086710967110671116711267113671146711567116671176711867119671206712167122671236712467125671266712767128671296713067131671326713367134671356713667137671386713967140671416714267143671446714567146671476714867149671506715167152671536715467155671566715767158671596716067161671626716367164671656716667167671686716967170671716717267173671746717567176671776717867179671806718167182671836718467185671866718767188671896719067191671926719367194671956719667197671986719967200672016720267203672046720567206672076720867209672106721167212672136721467215672166721767218672196722067221672226722367224672256722667227672286722967230672316723267233672346723567236672376723867239672406724167242672436724467245672466724767248672496725067251672526725367254672556725667257672586725967260672616726267263672646726567266672676726867269672706727167272672736727467275672766727767278672796728067281672826728367284672856728667287672886728967290672916729267293672946729567296672976729867299673006730167302673036730467305673066730767308673096731067311673126731367314673156731667317673186731967320673216732267323673246732567326673276732867329673306733167332673336733467335673366733767338673396734067341673426734367344673456734667347673486734967350673516735267353673546735567356673576735867359673606736167362673636736467365673666736767368673696737067371673726737367374673756737667377673786737967380673816738267383673846738567386673876738867389673906739167392673936739467395673966739767398673996740067401674026740367404674056740667407674086740967410674116741267413674146741567416674176741867419674206742167422674236742467425674266742767428674296743067431674326743367434674356743667437674386743967440674416744267443674446744567446674476744867449674506745167452674536745467455674566745767458674596746067461674626746367464674656746667467674686746967470674716747267473674746747567476674776747867479674806748167482674836748467485674866748767488674896749067491674926749367494674956749667497674986749967500675016750267503675046750567506675076750867509675106751167512675136751467515675166751767518675196752067521675226752367524675256752667527675286752967530675316753267533675346753567536675376753867539675406754167542675436754467545675466754767548675496755067551675526755367554675556755667557675586755967560675616756267563675646756567566675676756867569675706757167572675736757467575675766757767578675796758067581675826758367584675856758667587675886758967590675916759267593675946759567596675976759867599676006760167602676036760467605676066760767608676096761067611676126761367614676156761667617676186761967620676216762267623676246762567626676276762867629676306763167632676336763467635676366763767638676396764067641676426764367644676456764667647676486764967650676516765267653676546765567656676576765867659676606766167662676636766467665676666766767668676696767067671676726767367674676756767667677676786767967680676816768267683676846768567686676876768867689676906769167692676936769467695676966769767698676996770067701677026770367704677056770667707677086770967710677116771267713677146771567716677176771867719677206772167722677236772467725677266772767728677296773067731677326773367734677356773667737677386773967740677416774267743677446774567746677476774867749677506775167752677536775467755677566775767758677596776067761677626776367764677656776667767677686776967770677716777267773677746777567776677776777867779677806778167782677836778467785677866778767788677896779067791677926779367794677956779667797677986779967800678016780267803678046780567806678076780867809678106781167812678136781467815678166781767818678196782067821678226782367824678256782667827678286782967830678316783267833678346783567836678376783867839678406784167842678436784467845678466784767848678496785067851678526785367854678556785667857678586785967860678616786267863678646786567866678676786867869678706787167872678736787467875678766787767878678796788067881678826788367884678856788667887678886788967890678916789267893678946789567896678976789867899679006790167902679036790467905679066790767908679096791067911679126791367914679156791667917679186791967920679216792267923679246792567926679276792867929679306793167932679336793467935679366793767938679396794067941679426794367944679456794667947679486794967950679516795267953679546795567956679576795867959679606796167962679636796467965679666796767968679696797067971679726797367974679756797667977679786797967980679816798267983679846798567986679876798867989679906799167992679936799467995679966799767998679996800068001680026800368004680056800668007680086800968010680116801268013680146801568016680176801868019680206802168022680236802468025680266802768028680296803068031680326803368034680356803668037680386803968040680416804268043680446804568046680476804868049680506805168052680536805468055680566805768058680596806068061680626806368064680656806668067680686806968070680716807268073680746807568076680776807868079680806808168082680836808468085680866808768088680896809068091680926809368094680956809668097680986809968100681016810268103681046810568106681076810868109681106811168112681136811468115681166811768118681196812068121681226812368124681256812668127681286812968130681316813268133681346813568136681376813868139681406814168142681436814468145681466814768148681496815068151681526815368154681556815668157681586815968160681616816268163681646816568166681676816868169681706817168172681736817468175681766817768178681796818068181681826818368184681856818668187681886818968190681916819268193681946819568196681976819868199682006820168202682036820468205682066820768208682096821068211682126821368214682156821668217682186821968220682216822268223682246822568226682276822868229682306823168232682336823468235682366823768238682396824068241682426824368244682456824668247682486824968250682516825268253682546825568256682576825868259682606826168262682636826468265682666826768268682696827068271682726827368274682756827668277682786827968280682816828268283682846828568286682876828868289682906829168292682936829468295682966829768298682996830068301683026830368304683056830668307683086830968310683116831268313683146831568316683176831868319683206832168322683236832468325683266832768328683296833068331683326833368334683356833668337683386833968340683416834268343683446834568346683476834868349683506835168352683536835468355683566835768358683596836068361683626836368364683656836668367683686836968370683716837268373683746837568376683776837868379683806838168382683836838468385683866838768388683896839068391683926839368394683956839668397683986839968400684016840268403684046840568406684076840868409684106841168412684136841468415684166841768418684196842068421684226842368424684256842668427684286842968430684316843268433684346843568436684376843868439684406844168442684436844468445684466844768448684496845068451684526845368454684556845668457684586845968460684616846268463684646846568466684676846868469684706847168472684736847468475684766847768478684796848068481684826848368484684856848668487684886848968490684916849268493684946849568496684976849868499685006850168502685036850468505685066850768508685096851068511685126851368514685156851668517685186851968520685216852268523685246852568526685276852868529685306853168532685336853468535685366853768538685396854068541685426854368544685456854668547685486854968550685516855268553685546855568556685576855868559685606856168562685636856468565685666856768568685696857068571685726857368574685756857668577685786857968580685816858268583685846858568586685876858868589685906859168592685936859468595685966859768598685996860068601686026860368604686056860668607686086860968610686116861268613686146861568616686176861868619686206862168622686236862468625686266862768628686296863068631686326863368634686356863668637686386863968640686416864268643686446864568646686476864868649686506865168652686536865468655686566865768658686596866068661686626866368664686656866668667686686866968670686716867268673686746867568676686776867868679686806868168682686836868468685686866868768688686896869068691686926869368694686956869668697686986869968700687016870268703687046870568706687076870868709687106871168712687136871468715687166871768718687196872068721687226872368724687256872668727687286872968730687316873268733687346873568736687376873868739687406874168742687436874468745687466874768748687496875068751687526875368754687556875668757687586875968760687616876268763687646876568766687676876868769687706877168772687736877468775687766877768778687796878068781687826878368784687856878668787687886878968790687916879268793687946879568796687976879868799688006880168802688036880468805688066880768808688096881068811688126881368814688156881668817688186881968820688216882268823688246882568826688276882868829688306883168832688336883468835688366883768838688396884068841688426884368844688456884668847688486884968850688516885268853688546885568856688576885868859688606886168862688636886468865688666886768868688696887068871688726887368874688756887668877688786887968880688816888268883688846888568886688876888868889688906889168892688936889468895688966889768898688996890068901689026890368904689056890668907689086890968910689116891268913689146891568916689176891868919689206892168922689236892468925689266892768928689296893068931689326893368934689356893668937689386893968940689416894268943689446894568946689476894868949689506895168952689536895468955689566895768958689596896068961689626896368964689656896668967689686896968970689716897268973689746897568976689776897868979689806898168982689836898468985689866898768988689896899068991689926899368994689956899668997689986899969000690016900269003690046900569006690076900869009690106901169012690136901469015690166901769018690196902069021690226902369024690256902669027690286902969030690316903269033690346903569036690376903869039690406904169042690436904469045690466904769048690496905069051690526905369054690556905669057690586905969060690616906269063690646906569066690676906869069690706907169072690736907469075690766907769078690796908069081690826908369084690856908669087690886908969090690916909269093690946909569096690976909869099691006910169102691036910469105691066910769108691096911069111691126911369114691156911669117691186911969120691216912269123691246912569126691276912869129691306913169132691336913469135691366913769138691396914069141691426914369144691456914669147691486914969150691516915269153691546915569156691576915869159691606916169162691636916469165691666916769168691696917069171691726917369174691756917669177691786917969180691816918269183691846918569186691876918869189691906919169192691936919469195691966919769198691996920069201692026920369204692056920669207692086920969210692116921269213692146921569216692176921869219692206922169222692236922469225692266922769228692296923069231692326923369234692356923669237692386923969240692416924269243692446924569246692476924869249692506925169252692536925469255692566925769258692596926069261692626926369264692656926669267692686926969270692716927269273692746927569276692776927869279692806928169282692836928469285692866928769288692896929069291692926929369294692956929669297692986929969300693016930269303693046930569306693076930869309693106931169312693136931469315693166931769318693196932069321693226932369324693256932669327693286932969330693316933269333693346933569336693376933869339693406934169342693436934469345693466934769348693496935069351693526935369354693556935669357693586935969360693616936269363693646936569366693676936869369693706937169372693736937469375693766937769378693796938069381693826938369384693856938669387693886938969390693916939269393693946939569396693976939869399694006940169402694036940469405694066940769408694096941069411694126941369414694156941669417694186941969420694216942269423694246942569426694276942869429694306943169432694336943469435694366943769438694396944069441694426944369444694456944669447694486944969450694516945269453694546945569456694576945869459694606946169462694636946469465694666946769468694696947069471694726947369474694756947669477694786947969480694816948269483694846948569486694876948869489694906949169492694936949469495694966949769498694996950069501695026950369504695056950669507695086950969510695116951269513695146951569516695176951869519695206952169522695236952469525695266952769528695296953069531695326953369534695356953669537695386953969540695416954269543695446954569546695476954869549695506955169552695536955469555695566955769558695596956069561695626956369564695656956669567695686956969570695716957269573695746957569576695776957869579695806958169582695836958469585695866958769588695896959069591695926959369594695956959669597695986959969600696016960269603696046960569606696076960869609696106961169612696136961469615696166961769618696196962069621696226962369624696256962669627696286962969630696316963269633696346963569636696376963869639696406964169642696436964469645696466964769648696496965069651696526965369654696556965669657696586965969660696616966269663696646966569666696676966869669696706967169672696736967469675696766967769678696796968069681696826968369684696856968669687696886968969690696916969269693696946969569696696976969869699697006970169702697036970469705697066970769708697096971069711697126971369714697156971669717697186971969720697216972269723697246972569726697276972869729697306973169732697336973469735697366973769738697396974069741697426974369744697456974669747697486974969750697516975269753697546975569756697576975869759697606976169762697636976469765697666976769768697696977069771697726977369774697756977669777697786977969780697816978269783697846978569786697876978869789697906979169792697936979469795697966979769798697996980069801698026980369804698056980669807698086980969810698116981269813698146981569816698176981869819698206982169822698236982469825698266982769828698296983069831698326983369834698356983669837698386983969840698416984269843698446984569846698476984869849698506985169852698536985469855698566985769858698596986069861698626986369864698656986669867698686986969870698716987269873698746987569876698776987869879698806988169882698836988469885698866988769888698896989069891698926989369894698956989669897698986989969900699016990269903699046990569906699076990869909699106991169912699136991469915699166991769918699196992069921699226992369924699256992669927699286992969930699316993269933699346993569936699376993869939699406994169942699436994469945699466994769948699496995069951699526995369954699556995669957699586995969960699616996269963699646996569966699676996869969699706997169972699736997469975699766997769978699796998069981699826998369984699856998669987699886998969990699916999269993699946999569996699976999869999700007000170002700037000470005700067000770008700097001070011700127001370014700157001670017700187001970020700217002270023700247002570026700277002870029700307003170032700337003470035700367003770038700397004070041700427004370044700457004670047700487004970050700517005270053700547005570056700577005870059700607006170062700637006470065700667006770068700697007070071700727007370074700757007670077700787007970080700817008270083700847008570086700877008870089700907009170092700937009470095700967009770098700997010070101701027010370104701057010670107701087010970110701117011270113701147011570116701177011870119701207012170122701237012470125701267012770128701297013070131701327013370134701357013670137701387013970140701417014270143701447014570146701477014870149701507015170152701537015470155701567015770158701597016070161701627016370164701657016670167701687016970170701717017270173701747017570176701777017870179701807018170182701837018470185701867018770188701897019070191701927019370194701957019670197701987019970200702017020270203702047020570206702077020870209702107021170212702137021470215702167021770218702197022070221702227022370224702257022670227702287022970230702317023270233702347023570236702377023870239702407024170242702437024470245702467024770248702497025070251702527025370254702557025670257702587025970260702617026270263702647026570266702677026870269702707027170272702737027470275702767027770278702797028070281702827028370284702857028670287702887028970290702917029270293702947029570296702977029870299703007030170302703037030470305703067030770308703097031070311703127031370314703157031670317703187031970320703217032270323703247032570326703277032870329703307033170332703337033470335703367033770338703397034070341703427034370344703457034670347703487034970350703517035270353703547035570356703577035870359703607036170362703637036470365703667036770368703697037070371703727037370374703757037670377703787037970380703817038270383703847038570386703877038870389703907039170392703937039470395703967039770398703997040070401704027040370404704057040670407704087040970410704117041270413704147041570416704177041870419704207042170422704237042470425704267042770428704297043070431704327043370434704357043670437704387043970440704417044270443704447044570446704477044870449704507045170452704537045470455704567045770458704597046070461704627046370464704657046670467704687046970470704717047270473704747047570476704777047870479704807048170482704837048470485704867048770488704897049070491704927049370494704957049670497704987049970500705017050270503705047050570506705077050870509705107051170512705137051470515705167051770518705197052070521705227052370524705257052670527705287052970530705317053270533705347053570536705377053870539705407054170542705437054470545705467054770548705497055070551705527055370554705557055670557705587055970560705617056270563705647056570566705677056870569705707057170572705737057470575705767057770578705797058070581705827058370584705857058670587705887058970590705917059270593705947059570596705977059870599706007060170602706037060470605706067060770608706097061070611706127061370614706157061670617706187061970620706217062270623706247062570626706277062870629706307063170632706337063470635706367063770638706397064070641706427064370644706457064670647706487064970650706517065270653706547065570656706577065870659706607066170662706637066470665706667066770668706697067070671706727067370674706757067670677706787067970680706817068270683706847068570686706877068870689706907069170692706937069470695706967069770698706997070070701707027070370704707057070670707707087070970710707117071270713707147071570716707177071870719707207072170722707237072470725707267072770728707297073070731707327073370734707357073670737707387073970740707417074270743707447074570746707477074870749707507075170752707537075470755707567075770758707597076070761707627076370764707657076670767707687076970770707717077270773707747077570776707777077870779707807078170782707837078470785707867078770788707897079070791707927079370794707957079670797707987079970800708017080270803708047080570806708077080870809708107081170812708137081470815708167081770818708197082070821708227082370824708257082670827708287082970830708317083270833708347083570836708377083870839708407084170842708437084470845708467084770848708497085070851708527085370854708557085670857708587085970860708617086270863708647086570866708677086870869708707087170872708737087470875708767087770878708797088070881708827088370884708857088670887708887088970890708917089270893708947089570896708977089870899709007090170902709037090470905709067090770908709097091070911709127091370914709157091670917709187091970920709217092270923709247092570926709277092870929709307093170932709337093470935709367093770938709397094070941709427094370944709457094670947709487094970950709517095270953709547095570956709577095870959709607096170962709637096470965709667096770968709697097070971709727097370974709757097670977709787097970980709817098270983709847098570986709877098870989709907099170992709937099470995709967099770998709997100071001710027100371004710057100671007710087100971010710117101271013710147101571016710177101871019710207102171022710237102471025710267102771028710297103071031710327103371034710357103671037710387103971040710417104271043710447104571046710477104871049710507105171052710537105471055710567105771058710597106071061710627106371064710657106671067710687106971070710717107271073710747107571076710777107871079710807108171082710837108471085710867108771088710897109071091710927109371094710957109671097710987109971100711017110271103711047110571106711077110871109711107111171112711137111471115711167111771118711197112071121711227112371124711257112671127711287112971130711317113271133711347113571136711377113871139711407114171142711437114471145711467114771148711497115071151711527115371154711557115671157711587115971160711617116271163711647116571166711677116871169711707117171172711737117471175711767117771178711797118071181711827118371184711857118671187711887118971190711917119271193711947119571196711977119871199712007120171202712037120471205712067120771208712097121071211712127121371214712157121671217712187121971220712217122271223712247122571226712277122871229712307123171232712337123471235712367123771238712397124071241712427124371244712457124671247712487124971250712517125271253712547125571256712577125871259712607126171262712637126471265712667126771268712697127071271712727127371274712757127671277712787127971280712817128271283712847128571286712877128871289712907129171292712937129471295712967129771298712997130071301713027130371304713057130671307713087130971310713117131271313713147131571316713177131871319713207132171322713237132471325713267132771328713297133071331713327133371334713357133671337713387133971340713417134271343713447134571346713477134871349713507135171352713537135471355713567135771358713597136071361713627136371364713657136671367713687136971370713717137271373713747137571376713777137871379713807138171382713837138471385713867138771388713897139071391713927139371394713957139671397713987139971400714017140271403714047140571406714077140871409714107141171412714137141471415714167141771418714197142071421714227142371424714257142671427714287142971430714317143271433714347143571436714377143871439714407144171442714437144471445714467144771448714497145071451714527145371454714557145671457714587145971460714617146271463714647146571466714677146871469714707147171472714737147471475714767147771478714797148071481714827148371484714857148671487714887148971490714917149271493714947149571496714977149871499715007150171502715037150471505715067150771508715097151071511715127151371514715157151671517715187151971520715217152271523715247152571526715277152871529715307153171532715337153471535715367153771538715397154071541715427154371544715457154671547715487154971550715517155271553715547155571556715577155871559715607156171562715637156471565715667156771568715697157071571715727157371574715757157671577715787157971580715817158271583715847158571586715877158871589715907159171592715937159471595715967159771598715997160071601716027160371604716057160671607716087160971610716117161271613716147161571616716177161871619716207162171622716237162471625716267162771628716297163071631716327163371634716357163671637716387163971640716417164271643716447164571646716477164871649716507165171652716537165471655716567165771658716597166071661716627166371664716657166671667716687166971670716717167271673716747167571676716777167871679716807168171682716837168471685716867168771688716897169071691716927169371694716957169671697716987169971700717017170271703717047170571706717077170871709717107171171712717137171471715717167171771718717197172071721717227172371724717257172671727717287172971730717317173271733717347173571736717377173871739717407174171742717437174471745717467174771748717497175071751717527175371754717557175671757717587175971760717617176271763717647176571766717677176871769717707177171772717737177471775717767177771778717797178071781717827178371784717857178671787717887178971790717917179271793717947179571796717977179871799718007180171802718037180471805718067180771808718097181071811718127181371814718157181671817718187181971820718217182271823718247182571826718277182871829718307183171832718337183471835718367183771838718397184071841718427184371844718457184671847718487184971850718517185271853718547185571856718577185871859718607186171862718637186471865718667186771868718697187071871718727187371874718757187671877718787187971880718817188271883718847188571886718877188871889718907189171892718937189471895718967189771898718997190071901719027190371904719057190671907719087190971910719117191271913719147191571916719177191871919719207192171922719237192471925719267192771928719297193071931719327193371934719357193671937719387193971940719417194271943719447194571946719477194871949719507195171952719537195471955719567195771958719597196071961719627196371964719657196671967719687196971970719717197271973719747197571976719777197871979719807198171982719837198471985719867198771988719897199071991719927199371994719957199671997719987199972000720017200272003720047200572006720077200872009720107201172012720137201472015720167201772018720197202072021720227202372024720257202672027720287202972030720317203272033720347203572036720377203872039720407204172042720437204472045720467204772048720497205072051720527205372054720557205672057720587205972060720617206272063720647206572066720677206872069720707207172072720737207472075720767207772078720797208072081720827208372084720857208672087720887208972090720917209272093720947209572096720977209872099721007210172102721037210472105721067210772108721097211072111721127211372114721157211672117721187211972120721217212272123721247212572126721277212872129721307213172132721337213472135721367213772138721397214072141721427214372144721457214672147721487214972150721517215272153721547215572156721577215872159721607216172162721637216472165721667216772168721697217072171721727217372174721757217672177721787217972180721817218272183721847218572186721877218872189721907219172192721937219472195721967219772198721997220072201722027220372204722057220672207722087220972210722117221272213722147221572216722177221872219722207222172222722237222472225722267222772228722297223072231722327223372234722357223672237722387223972240722417224272243722447224572246722477224872249722507225172252722537225472255722567225772258722597226072261722627226372264722657226672267722687226972270722717227272273722747227572276722777227872279722807228172282722837228472285722867228772288722897229072291722927229372294722957229672297722987229972300723017230272303723047230572306723077230872309723107231172312723137231472315723167231772318723197232072321723227232372324723257232672327723287232972330723317233272333723347233572336723377233872339723407234172342723437234472345723467234772348723497235072351723527235372354723557235672357723587235972360723617236272363723647236572366723677236872369723707237172372723737237472375723767237772378723797238072381723827238372384723857238672387723887238972390723917239272393723947239572396723977239872399724007240172402724037240472405724067240772408724097241072411724127241372414724157241672417724187241972420724217242272423724247242572426724277242872429724307243172432724337243472435724367243772438724397244072441724427244372444724457244672447724487244972450724517245272453724547245572456724577245872459724607246172462724637246472465724667246772468724697247072471724727247372474724757247672477724787247972480724817248272483724847248572486724877248872489724907249172492724937249472495724967249772498724997250072501725027250372504725057250672507725087250972510725117251272513725147251572516725177251872519725207252172522725237252472525725267252772528725297253072531725327253372534725357253672537725387253972540725417254272543725447254572546725477254872549725507255172552725537255472555725567255772558725597256072561725627256372564725657256672567725687256972570725717257272573725747257572576725777257872579725807258172582725837258472585725867258772588725897259072591725927259372594725957259672597725987259972600726017260272603726047260572606726077260872609726107261172612726137261472615726167261772618726197262072621726227262372624726257262672627726287262972630726317263272633726347263572636726377263872639726407264172642726437264472645726467264772648726497265072651726527265372654726557265672657726587265972660726617266272663726647266572666726677266872669726707267172672726737267472675726767267772678726797268072681726827268372684726857268672687726887268972690726917269272693726947269572696726977269872699727007270172702727037270472705727067270772708727097271072711727127271372714727157271672717727187271972720727217272272723727247272572726727277272872729727307273172732727337273472735727367273772738727397274072741727427274372744727457274672747727487274972750727517275272753727547275572756727577275872759727607276172762727637276472765727667276772768727697277072771727727277372774727757277672777727787277972780727817278272783727847278572786727877278872789727907279172792727937279472795727967279772798727997280072801728027280372804728057280672807728087280972810728117281272813728147281572816728177281872819728207282172822728237282472825728267282772828728297283072831728327283372834728357283672837728387283972840728417284272843728447284572846728477284872849728507285172852728537285472855728567285772858728597286072861728627286372864728657286672867728687286972870728717287272873728747287572876728777287872879728807288172882728837288472885728867288772888728897289072891728927289372894728957289672897728987289972900729017290272903729047290572906729077290872909729107291172912729137291472915729167291772918729197292072921729227292372924729257292672927729287292972930729317293272933729347293572936729377293872939729407294172942729437294472945729467294772948729497295072951729527295372954729557295672957729587295972960729617296272963729647296572966729677296872969729707297172972729737297472975729767297772978729797298072981729827298372984729857298672987729887298972990729917299272993729947299572996729977299872999730007300173002730037300473005730067300773008730097301073011730127301373014730157301673017730187301973020730217302273023730247302573026730277302873029730307303173032730337303473035730367303773038730397304073041730427304373044730457304673047730487304973050730517305273053730547305573056730577305873059730607306173062730637306473065730667306773068730697307073071730727307373074730757307673077730787307973080730817308273083730847308573086730877308873089730907309173092730937309473095730967309773098730997310073101731027310373104731057310673107731087310973110731117311273113731147311573116731177311873119731207312173122731237312473125731267312773128731297313073131731327313373134731357313673137731387313973140731417314273143731447314573146731477314873149731507315173152731537315473155731567315773158731597316073161731627316373164731657316673167731687316973170731717317273173731747317573176731777317873179731807318173182731837318473185731867318773188731897319073191731927319373194731957319673197731987319973200732017320273203732047320573206732077320873209732107321173212732137321473215732167321773218732197322073221732227322373224732257322673227732287322973230732317323273233732347323573236732377323873239732407324173242732437324473245732467324773248732497325073251732527325373254732557325673257732587325973260732617326273263732647326573266732677326873269732707327173272732737327473275732767327773278732797328073281732827328373284732857328673287732887328973290732917329273293732947329573296732977329873299733007330173302733037330473305733067330773308733097331073311733127331373314733157331673317733187331973320733217332273323733247332573326733277332873329733307333173332733337333473335733367333773338733397334073341733427334373344733457334673347733487334973350733517335273353733547335573356733577335873359733607336173362733637336473365733667336773368733697337073371733727337373374733757337673377733787337973380733817338273383733847338573386733877338873389733907339173392733937339473395733967339773398733997340073401734027340373404734057340673407734087340973410734117341273413734147341573416734177341873419734207342173422734237342473425734267342773428734297343073431734327343373434734357343673437734387343973440734417344273443734447344573446734477344873449734507345173452734537345473455734567345773458734597346073461734627346373464734657346673467734687346973470734717347273473734747347573476734777347873479734807348173482734837348473485734867348773488734897349073491734927349373494734957349673497734987349973500735017350273503735047350573506735077350873509735107351173512735137351473515735167351773518735197352073521735227352373524735257352673527735287352973530735317353273533735347353573536735377353873539735407354173542735437354473545735467354773548735497355073551735527355373554735557355673557735587355973560735617356273563735647356573566735677356873569735707357173572735737357473575735767357773578735797358073581735827358373584735857358673587735887358973590735917359273593735947359573596735977359873599736007360173602736037360473605736067360773608736097361073611736127361373614736157361673617736187361973620736217362273623736247362573626736277362873629736307363173632736337363473635736367363773638736397364073641736427364373644736457364673647736487364973650736517365273653736547365573656736577365873659736607366173662736637366473665736667366773668736697367073671736727367373674736757367673677736787367973680736817368273683736847368573686736877368873689736907369173692736937369473695736967369773698736997370073701737027370373704737057370673707737087370973710737117371273713737147371573716737177371873719737207372173722737237372473725737267372773728737297373073731737327373373734737357373673737737387373973740737417374273743737447374573746737477374873749737507375173752737537375473755737567375773758737597376073761737627376373764737657376673767737687376973770737717377273773737747377573776737777377873779737807378173782737837378473785737867378773788737897379073791737927379373794737957379673797737987379973800738017380273803738047380573806738077380873809738107381173812738137381473815738167381773818738197382073821738227382373824738257382673827738287382973830738317383273833738347383573836738377383873839738407384173842738437384473845738467384773848738497385073851738527385373854738557385673857738587385973860738617386273863738647386573866738677386873869738707387173872738737387473875738767387773878738797388073881738827388373884738857388673887738887388973890738917389273893738947389573896738977389873899739007390173902739037390473905739067390773908739097391073911739127391373914739157391673917739187391973920739217392273923739247392573926739277392873929739307393173932739337393473935739367393773938739397394073941739427394373944739457394673947739487394973950739517395273953739547395573956739577395873959739607396173962739637396473965739667396773968739697397073971739727397373974739757397673977739787397973980739817398273983739847398573986739877398873989739907399173992739937399473995739967399773998739997400074001740027400374004740057400674007740087400974010740117401274013740147401574016740177401874019740207402174022740237402474025740267402774028740297403074031740327403374034740357403674037740387403974040740417404274043740447404574046740477404874049740507405174052740537405474055740567405774058740597406074061740627406374064740657406674067740687406974070740717407274073740747407574076740777407874079740807408174082740837408474085740867408774088740897409074091740927409374094740957409674097740987409974100741017410274103741047410574106741077410874109741107411174112741137411474115741167411774118741197412074121741227412374124741257412674127741287412974130741317413274133741347413574136741377413874139741407414174142741437414474145741467414774148741497415074151741527415374154741557415674157741587415974160741617416274163741647416574166741677416874169741707417174172741737417474175741767417774178741797418074181741827418374184741857418674187741887418974190741917419274193741947419574196741977419874199742007420174202742037420474205742067420774208742097421074211742127421374214742157421674217742187421974220742217422274223742247422574226742277422874229742307423174232742337423474235742367423774238742397424074241742427424374244742457424674247742487424974250742517425274253742547425574256742577425874259742607426174262742637426474265742667426774268742697427074271742727427374274742757427674277742787427974280742817428274283742847428574286742877428874289742907429174292742937429474295742967429774298742997430074301743027430374304743057430674307743087430974310743117431274313743147431574316743177431874319743207432174322743237432474325743267432774328743297433074331743327433374334743357433674337743387433974340743417434274343743447434574346743477434874349743507435174352743537435474355743567435774358743597436074361743627436374364743657436674367743687436974370743717437274373743747437574376743777437874379743807438174382743837438474385743867438774388743897439074391743927439374394743957439674397743987439974400744017440274403744047440574406744077440874409744107441174412744137441474415744167441774418744197442074421744227442374424744257442674427744287442974430744317443274433744347443574436744377443874439744407444174442744437444474445744467444774448744497445074451744527445374454744557445674457744587445974460744617446274463744647446574466744677446874469744707447174472744737447474475744767447774478744797448074481744827448374484744857448674487744887448974490744917449274493744947449574496744977449874499745007450174502745037450474505745067450774508745097451074511745127451374514745157451674517745187451974520745217452274523745247452574526745277452874529745307453174532745337453474535745367453774538745397454074541745427454374544745457454674547745487454974550745517455274553745547455574556745577455874559745607456174562745637456474565745667456774568745697457074571745727457374574745757457674577745787457974580745817458274583745847458574586745877458874589745907459174592745937459474595745967459774598745997460074601746027460374604746057460674607746087460974610746117461274613746147461574616746177461874619746207462174622746237462474625746267462774628746297463074631746327463374634746357463674637746387463974640746417464274643746447464574646746477464874649746507465174652746537465474655746567465774658746597466074661746627466374664746657466674667746687466974670746717467274673746747467574676746777467874679746807468174682746837468474685746867468774688746897469074691746927469374694746957469674697746987469974700747017470274703747047470574706747077470874709747107471174712747137471474715747167471774718747197472074721747227472374724747257472674727747287472974730747317473274733747347473574736747377473874739747407474174742747437474474745747467474774748747497475074751747527475374754747557475674757747587475974760747617476274763747647476574766747677476874769747707477174772747737477474775747767477774778747797478074781747827478374784747857478674787747887478974790747917479274793747947479574796747977479874799748007480174802748037480474805748067480774808748097481074811748127481374814748157481674817748187481974820748217482274823748247482574826748277482874829748307483174832748337483474835748367483774838748397484074841748427484374844748457484674847748487484974850748517485274853748547485574856748577485874859748607486174862748637486474865748667486774868748697487074871748727487374874748757487674877748787487974880748817488274883748847488574886748877488874889748907489174892748937489474895748967489774898748997490074901749027490374904749057490674907749087490974910749117491274913749147491574916749177491874919749207492174922749237492474925749267492774928749297493074931749327493374934749357493674937749387493974940749417494274943749447494574946749477494874949749507495174952749537495474955749567495774958749597496074961749627496374964749657496674967749687496974970749717497274973749747497574976749777497874979749807498174982749837498474985749867498774988749897499074991749927499374994749957499674997749987499975000750017500275003750047500575006750077500875009750107501175012750137501475015750167501775018750197502075021750227502375024750257502675027750287502975030750317503275033750347503575036750377503875039750407504175042750437504475045750467504775048750497505075051750527505375054750557505675057750587505975060750617506275063750647506575066750677506875069750707507175072750737507475075750767507775078750797508075081750827508375084750857508675087750887508975090750917509275093750947509575096750977509875099751007510175102751037510475105751067510775108751097511075111751127511375114751157511675117751187511975120751217512275123751247512575126751277512875129751307513175132751337513475135751367513775138751397514075141751427514375144751457514675147751487514975150751517515275153751547515575156751577515875159751607516175162751637516475165751667516775168751697517075171751727517375174751757517675177751787517975180751817518275183751847518575186751877518875189751907519175192751937519475195751967519775198751997520075201752027520375204752057520675207752087520975210752117521275213752147521575216752177521875219752207522175222752237522475225752267522775228752297523075231752327523375234752357523675237752387523975240752417524275243752447524575246752477524875249752507525175252752537525475255752567525775258752597526075261752627526375264752657526675267752687526975270752717527275273752747527575276752777527875279752807528175282752837528475285752867528775288752897529075291752927529375294752957529675297752987529975300753017530275303753047530575306753077530875309753107531175312753137531475315753167531775318753197532075321753227532375324753257532675327753287532975330753317533275333753347533575336753377533875339753407534175342753437534475345753467534775348753497535075351753527535375354753557535675357753587535975360753617536275363753647536575366753677536875369753707537175372753737537475375753767537775378753797538075381753827538375384753857538675387753887538975390753917539275393753947539575396753977539875399754007540175402754037540475405754067540775408754097541075411754127541375414754157541675417754187541975420754217542275423754247542575426754277542875429754307543175432754337543475435754367543775438754397544075441754427544375444754457544675447754487544975450754517545275453754547545575456754577545875459754607546175462754637546475465754667546775468754697547075471754727547375474754757547675477754787547975480754817548275483754847548575486754877548875489754907549175492754937549475495754967549775498754997550075501755027550375504755057550675507755087550975510755117551275513755147551575516755177551875519755207552175522755237552475525755267552775528755297553075531755327553375534755357553675537755387553975540755417554275543755447554575546755477554875549755507555175552755537555475555755567555775558755597556075561755627556375564755657556675567755687556975570755717557275573755747557575576755777557875579755807558175582755837558475585755867558775588755897559075591755927559375594755957559675597755987559975600756017560275603756047560575606756077560875609756107561175612756137561475615756167561775618756197562075621756227562375624756257562675627756287562975630756317563275633756347563575636756377563875639756407564175642756437564475645756467564775648756497565075651756527565375654756557565675657756587565975660756617566275663756647566575666756677566875669756707567175672756737567475675756767567775678756797568075681756827568375684756857568675687756887568975690756917569275693756947569575696756977569875699757007570175702757037570475705757067570775708757097571075711757127571375714757157571675717757187571975720757217572275723757247572575726757277572875729757307573175732757337573475735757367573775738757397574075741757427574375744757457574675747757487574975750757517575275753757547575575756757577575875759757607576175762757637576475765757667576775768757697577075771757727577375774757757577675777757787577975780757817578275783757847578575786757877578875789757907579175792757937579475795757967579775798757997580075801758027580375804758057580675807758087580975810758117581275813758147581575816758177581875819758207582175822758237582475825758267582775828758297583075831758327583375834758357583675837758387583975840758417584275843758447584575846758477584875849758507585175852758537585475855758567585775858758597586075861758627586375864758657586675867758687586975870758717587275873758747587575876758777587875879758807588175882758837588475885758867588775888758897589075891758927589375894758957589675897758987589975900759017590275903759047590575906759077590875909759107591175912759137591475915759167591775918759197592075921759227592375924759257592675927759287592975930759317593275933759347593575936759377593875939759407594175942759437594475945759467594775948759497595075951759527595375954759557595675957759587595975960759617596275963759647596575966759677596875969759707597175972759737597475975759767597775978759797598075981759827598375984759857598675987759887598975990759917599275993759947599575996759977599875999760007600176002760037600476005760067600776008760097601076011760127601376014760157601676017760187601976020760217602276023760247602576026760277602876029760307603176032760337603476035760367603776038760397604076041760427604376044760457604676047760487604976050760517605276053760547605576056760577605876059760607606176062760637606476065760667606776068760697607076071760727607376074760757607676077760787607976080760817608276083760847608576086760877608876089760907609176092760937609476095760967609776098760997610076101761027610376104761057610676107761087610976110761117611276113761147611576116761177611876119761207612176122761237612476125761267612776128761297613076131761327613376134761357613676137761387613976140761417614276143761447614576146761477614876149761507615176152761537615476155761567615776158761597616076161761627616376164761657616676167761687616976170761717617276173761747617576176761777617876179761807618176182761837618476185761867618776188761897619076191761927619376194761957619676197761987619976200762017620276203762047620576206762077620876209762107621176212762137621476215762167621776218762197622076221762227622376224762257622676227762287622976230762317623276233762347623576236762377623876239762407624176242762437624476245762467624776248762497625076251762527625376254762557625676257762587625976260762617626276263762647626576266762677626876269762707627176272762737627476275762767627776278762797628076281762827628376284762857628676287762887628976290762917629276293762947629576296762977629876299763007630176302763037630476305763067630776308763097631076311763127631376314763157631676317763187631976320763217632276323763247632576326763277632876329763307633176332763337633476335763367633776338763397634076341763427634376344763457634676347763487634976350763517635276353763547635576356763577635876359763607636176362763637636476365763667636776368763697637076371763727637376374763757637676377763787637976380763817638276383763847638576386763877638876389763907639176392763937639476395763967639776398763997640076401764027640376404764057640676407764087640976410764117641276413764147641576416764177641876419764207642176422764237642476425764267642776428764297643076431764327643376434764357643676437764387643976440764417644276443764447644576446764477644876449764507645176452764537645476455764567645776458764597646076461764627646376464764657646676467764687646976470764717647276473764747647576476764777647876479764807648176482764837648476485764867648776488764897649076491764927649376494764957649676497764987649976500765017650276503765047650576506765077650876509765107651176512765137651476515765167651776518765197652076521765227652376524765257652676527765287652976530765317653276533765347653576536765377653876539765407654176542765437654476545765467654776548765497655076551765527655376554765557655676557765587655976560765617656276563765647656576566765677656876569765707657176572765737657476575765767657776578765797658076581765827658376584765857658676587765887658976590765917659276593765947659576596765977659876599766007660176602766037660476605766067660776608766097661076611766127661376614766157661676617766187661976620766217662276623766247662576626766277662876629766307663176632766337663476635766367663776638766397664076641766427664376644766457664676647766487664976650766517665276653766547665576656766577665876659766607666176662766637666476665766667666776668766697667076671766727667376674766757667676677766787667976680766817668276683766847668576686766877668876689766907669176692766937669476695766967669776698766997670076701767027670376704767057670676707767087670976710767117671276713767147671576716767177671876719767207672176722767237672476725767267672776728767297673076731767327673376734767357673676737767387673976740767417674276743767447674576746767477674876749767507675176752767537675476755767567675776758767597676076761767627676376764767657676676767767687676976770767717677276773767747677576776767777677876779767807678176782767837678476785767867678776788767897679076791767927679376794767957679676797767987679976800768017680276803768047680576806768077680876809768107681176812768137681476815768167681776818768197682076821768227682376824768257682676827768287682976830768317683276833768347683576836768377683876839768407684176842768437684476845768467684776848768497685076851768527685376854768557685676857768587685976860768617686276863768647686576866768677686876869768707687176872768737687476875768767687776878768797688076881768827688376884768857688676887768887688976890768917689276893768947689576896768977689876899769007690176902769037690476905769067690776908769097691076911769127691376914769157691676917769187691976920769217692276923769247692576926769277692876929769307693176932769337693476935769367693776938769397694076941769427694376944769457694676947769487694976950769517695276953769547695576956769577695876959769607696176962769637696476965769667696776968769697697076971769727697376974769757697676977769787697976980769817698276983769847698576986769877698876989769907699176992769937699476995769967699776998769997700077001770027700377004770057700677007770087700977010770117701277013770147701577016770177701877019770207702177022770237702477025770267702777028770297703077031770327703377034770357703677037770387703977040770417704277043770447704577046770477704877049770507705177052770537705477055770567705777058770597706077061770627706377064770657706677067770687706977070770717707277073770747707577076770777707877079770807708177082770837708477085770867708777088770897709077091770927709377094770957709677097770987709977100771017710277103771047710577106771077710877109771107711177112771137711477115771167711777118771197712077121771227712377124771257712677127771287712977130771317713277133771347713577136771377713877139771407714177142771437714477145771467714777148771497715077151771527715377154771557715677157771587715977160771617716277163771647716577166771677716877169771707717177172771737717477175771767717777178771797718077181771827718377184771857718677187771887718977190771917719277193771947719577196771977719877199772007720177202772037720477205772067720777208772097721077211772127721377214772157721677217772187721977220772217722277223772247722577226772277722877229772307723177232772337723477235772367723777238772397724077241772427724377244772457724677247772487724977250772517725277253772547725577256772577725877259772607726177262772637726477265772667726777268772697727077271772727727377274772757727677277772787727977280772817728277283772847728577286772877728877289772907729177292772937729477295772967729777298772997730077301773027730377304773057730677307773087730977310773117731277313773147731577316773177731877319773207732177322773237732477325773267732777328773297733077331773327733377334773357733677337773387733977340773417734277343773447734577346773477734877349773507735177352773537735477355773567735777358773597736077361773627736377364773657736677367773687736977370773717737277373773747737577376773777737877379773807738177382773837738477385773867738777388773897739077391773927739377394773957739677397773987739977400774017740277403774047740577406774077740877409774107741177412774137741477415774167741777418774197742077421774227742377424774257742677427774287742977430774317743277433774347743577436774377743877439774407744177442774437744477445774467744777448774497745077451774527745377454774557745677457774587745977460774617746277463774647746577466774677746877469774707747177472774737747477475774767747777478774797748077481774827748377484774857748677487774887748977490774917749277493774947749577496774977749877499775007750177502775037750477505775067750777508775097751077511775127751377514775157751677517775187751977520775217752277523775247752577526775277752877529775307753177532775337753477535775367753777538775397754077541775427754377544775457754677547775487754977550775517755277553775547755577556775577755877559775607756177562775637756477565775667756777568775697757077571775727757377574775757757677577775787757977580775817758277583775847758577586775877758877589775907759177592775937759477595775967759777598775997760077601776027760377604776057760677607776087760977610776117761277613776147761577616776177761877619776207762177622776237762477625776267762777628776297763077631776327763377634776357763677637776387763977640776417764277643776447764577646776477764877649776507765177652776537765477655776567765777658776597766077661776627766377664776657766677667776687766977670776717767277673776747767577676776777767877679776807768177682776837768477685776867768777688776897769077691776927769377694776957769677697776987769977700777017770277703777047770577706777077770877709777107771177712777137771477715777167771777718777197772077721777227772377724777257772677727777287772977730777317773277733777347773577736777377773877739777407774177742777437774477745777467774777748777497775077751777527775377754777557775677757777587775977760777617776277763777647776577766777677776877769777707777177772777737777477775777767777777778777797778077781777827778377784777857778677787777887778977790777917779277793777947779577796777977779877799778007780177802778037780477805778067780777808778097781077811778127781377814778157781677817778187781977820778217782277823778247782577826778277782877829778307783177832778337783477835778367783777838778397784077841778427784377844778457784677847778487784977850778517785277853778547785577856778577785877859778607786177862778637786477865778667786777868778697787077871778727787377874778757787677877778787787977880778817788277883778847788577886778877788877889778907789177892778937789477895778967789777898778997790077901779027790377904779057790677907779087790977910779117791277913779147791577916779177791877919779207792177922779237792477925779267792777928779297793077931779327793377934779357793677937779387793977940779417794277943779447794577946779477794877949779507795177952779537795477955779567795777958779597796077961779627796377964779657796677967779687796977970779717797277973779747797577976779777797877979779807798177982779837798477985779867798777988779897799077991779927799377994779957799677997779987799978000780017800278003780047800578006780077800878009780107801178012780137801478015780167801778018780197802078021780227802378024780257802678027780287802978030780317803278033780347803578036780377803878039780407804178042780437804478045780467804778048780497805078051780527805378054780557805678057780587805978060780617806278063780647806578066780677806878069780707807178072780737807478075780767807778078780797808078081780827808378084780857808678087780887808978090780917809278093780947809578096780977809878099781007810178102781037810478105781067810778108781097811078111781127811378114781157811678117781187811978120781217812278123781247812578126781277812878129781307813178132781337813478135781367813778138781397814078141781427814378144781457814678147781487814978150781517815278153781547815578156781577815878159781607816178162781637816478165781667816778168781697817078171781727817378174781757817678177781787817978180781817818278183781847818578186781877818878189781907819178192781937819478195781967819778198781997820078201782027820378204782057820678207782087820978210782117821278213782147821578216782177821878219782207822178222782237822478225782267822778228782297823078231782327823378234782357823678237782387823978240782417824278243782447824578246782477824878249782507825178252782537825478255782567825778258782597826078261782627826378264782657826678267782687826978270782717827278273782747827578276782777827878279782807828178282782837828478285782867828778288782897829078291782927829378294782957829678297782987829978300783017830278303783047830578306783077830878309783107831178312783137831478315783167831778318783197832078321783227832378324783257832678327783287832978330783317833278333783347833578336783377833878339783407834178342783437834478345783467834778348783497835078351783527835378354783557835678357783587835978360783617836278363783647836578366783677836878369783707837178372783737837478375783767837778378783797838078381783827838378384783857838678387783887838978390783917839278393783947839578396783977839878399784007840178402784037840478405784067840778408784097841078411784127841378414784157841678417784187841978420784217842278423784247842578426784277842878429784307843178432784337843478435784367843778438784397844078441784427844378444784457844678447784487844978450784517845278453784547845578456784577845878459784607846178462784637846478465784667846778468784697847078471784727847378474784757847678477784787847978480784817848278483784847848578486784877848878489784907849178492784937849478495784967849778498784997850078501785027850378504785057850678507785087850978510785117851278513785147851578516785177851878519785207852178522785237852478525785267852778528785297853078531785327853378534785357853678537785387853978540785417854278543785447854578546785477854878549785507855178552785537855478555785567855778558785597856078561785627856378564785657856678567785687856978570785717857278573785747857578576785777857878579785807858178582785837858478585785867858778588785897859078591785927859378594785957859678597785987859978600786017860278603786047860578606786077860878609786107861178612786137861478615786167861778618786197862078621786227862378624786257862678627786287862978630786317863278633786347863578636786377863878639786407864178642786437864478645786467864778648786497865078651786527865378654786557865678657786587865978660786617866278663786647866578666786677866878669786707867178672786737867478675786767867778678786797868078681786827868378684786857868678687786887868978690786917869278693786947869578696786977869878699787007870178702787037870478705787067870778708787097871078711787127871378714787157871678717787187871978720787217872278723787247872578726787277872878729787307873178732787337873478735787367873778738787397874078741787427874378744787457874678747787487874978750787517875278753787547875578756787577875878759787607876178762787637876478765787667876778768787697877078771787727877378774787757877678777787787877978780787817878278783787847878578786787877878878789787907879178792787937879478795787967879778798787997880078801788027880378804788057880678807788087880978810788117881278813788147881578816788177881878819788207882178822788237882478825788267882778828788297883078831788327883378834788357883678837788387883978840788417884278843788447884578846788477884878849788507885178852788537885478855788567885778858788597886078861788627886378864788657886678867788687886978870788717887278873788747887578876788777887878879788807888178882788837888478885788867888778888788897889078891788927889378894788957889678897788987889978900789017890278903789047890578906789077890878909789107891178912789137891478915789167891778918789197892078921789227892378924789257892678927789287892978930789317893278933789347893578936789377893878939789407894178942789437894478945789467894778948789497895078951789527895378954789557895678957789587895978960789617896278963789647896578966789677896878969789707897178972789737897478975789767897778978789797898078981789827898378984789857898678987789887898978990789917899278993789947899578996789977899878999790007900179002790037900479005790067900779008790097901079011790127901379014790157901679017790187901979020790217902279023790247902579026790277902879029790307903179032790337903479035790367903779038790397904079041790427904379044790457904679047790487904979050790517905279053790547905579056790577905879059790607906179062790637906479065790667906779068790697907079071790727907379074790757907679077790787907979080790817908279083790847908579086790877908879089790907909179092790937909479095790967909779098790997910079101791027910379104791057910679107791087910979110791117911279113791147911579116791177911879119791207912179122791237912479125791267912779128791297913079131791327913379134791357913679137791387913979140791417914279143791447914579146791477914879149791507915179152791537915479155791567915779158791597916079161791627916379164791657916679167791687916979170791717917279173791747917579176791777917879179791807918179182791837918479185791867918779188791897919079191791927919379194791957919679197791987919979200792017920279203792047920579206792077920879209792107921179212792137921479215792167921779218792197922079221792227922379224792257922679227792287922979230792317923279233792347923579236792377923879239792407924179242792437924479245792467924779248792497925079251792527925379254792557925679257792587925979260792617926279263792647926579266792677926879269792707927179272792737927479275792767927779278792797928079281792827928379284792857928679287792887928979290792917929279293792947929579296792977929879299793007930179302793037930479305793067930779308793097931079311793127931379314793157931679317793187931979320793217932279323793247932579326793277932879329793307933179332793337933479335793367933779338793397934079341793427934379344793457934679347793487934979350793517935279353793547935579356793577935879359793607936179362793637936479365793667936779368793697937079371793727937379374793757937679377793787937979380793817938279383793847938579386793877938879389793907939179392793937939479395793967939779398793997940079401794027940379404794057940679407794087940979410794117941279413794147941579416794177941879419794207942179422794237942479425794267942779428794297943079431794327943379434794357943679437794387943979440794417944279443794447944579446794477944879449794507945179452794537945479455794567945779458794597946079461794627946379464794657946679467794687946979470794717947279473794747947579476794777947879479794807948179482794837948479485794867948779488794897949079491794927949379494794957949679497794987949979500795017950279503795047950579506795077950879509795107951179512795137951479515795167951779518795197952079521795227952379524795257952679527795287952979530795317953279533795347953579536795377953879539795407954179542795437954479545795467954779548795497955079551795527955379554795557955679557795587955979560795617956279563795647956579566795677956879569795707957179572795737957479575795767957779578795797958079581795827958379584795857958679587795887958979590795917959279593795947959579596795977959879599796007960179602796037960479605796067960779608796097961079611796127961379614796157961679617796187961979620796217962279623796247962579626796277962879629796307963179632796337963479635796367963779638796397964079641796427964379644796457964679647796487964979650796517965279653796547965579656796577965879659796607966179662796637966479665796667966779668796697967079671796727967379674796757967679677796787967979680796817968279683796847968579686796877968879689796907969179692796937969479695796967969779698796997970079701797027970379704797057970679707797087970979710797117971279713797147971579716797177971879719797207972179722797237972479725797267972779728797297973079731797327973379734797357973679737797387973979740797417974279743797447974579746797477974879749797507975179752797537975479755797567975779758797597976079761797627976379764797657976679767797687976979770797717977279773797747977579776797777977879779797807978179782797837978479785797867978779788797897979079791797927979379794797957979679797797987979979800798017980279803798047980579806798077980879809798107981179812798137981479815798167981779818798197982079821798227982379824798257982679827798287982979830798317983279833798347983579836798377983879839798407984179842798437984479845798467984779848798497985079851798527985379854798557985679857798587985979860798617986279863798647986579866798677986879869798707987179872798737987479875798767987779878798797988079881798827988379884798857988679887798887988979890798917989279893798947989579896798977989879899799007990179902799037990479905799067990779908799097991079911799127991379914799157991679917799187991979920799217992279923799247992579926799277992879929799307993179932799337993479935799367993779938799397994079941799427994379944799457994679947799487994979950799517995279953799547995579956799577995879959799607996179962799637996479965799667996779968799697997079971799727997379974799757997679977799787997979980799817998279983799847998579986799877998879989799907999179992799937999479995799967999779998799998000080001800028000380004800058000680007800088000980010800118001280013800148001580016800178001880019800208002180022800238002480025800268002780028800298003080031800328003380034800358003680037800388003980040800418004280043800448004580046800478004880049800508005180052800538005480055800568005780058800598006080061800628006380064800658006680067800688006980070800718007280073800748007580076800778007880079800808008180082800838008480085800868008780088800898009080091800928009380094800958009680097800988009980100801018010280103801048010580106801078010880109801108011180112801138011480115801168011780118801198012080121801228012380124801258012680127801288012980130801318013280133801348013580136801378013880139801408014180142801438014480145801468014780148801498015080151801528015380154801558015680157801588015980160801618016280163801648016580166801678016880169801708017180172801738017480175801768017780178801798018080181801828018380184801858018680187801888018980190801918019280193801948019580196801978019880199802008020180202802038020480205802068020780208802098021080211802128021380214802158021680217802188021980220802218022280223802248022580226802278022880229802308023180232802338023480235802368023780238802398024080241802428024380244802458024680247802488024980250802518025280253802548025580256802578025880259802608026180262802638026480265802668026780268802698027080271802728027380274802758027680277802788027980280802818028280283802848028580286802878028880289802908029180292802938029480295802968029780298802998030080301803028030380304803058030680307803088030980310803118031280313803148031580316803178031880319803208032180322803238032480325803268032780328803298033080331803328033380334803358033680337803388033980340803418034280343803448034580346803478034880349803508035180352803538035480355803568035780358803598036080361803628036380364803658036680367803688036980370803718037280373803748037580376803778037880379803808038180382803838038480385803868038780388803898039080391803928039380394803958039680397803988039980400804018040280403804048040580406804078040880409804108041180412804138041480415804168041780418804198042080421804228042380424804258042680427804288042980430804318043280433804348043580436804378043880439804408044180442804438044480445804468044780448804498045080451804528045380454804558045680457804588045980460804618046280463804648046580466804678046880469804708047180472804738047480475804768047780478804798048080481804828048380484804858048680487804888048980490804918049280493804948049580496804978049880499805008050180502805038050480505805068050780508805098051080511805128051380514805158051680517805188051980520805218052280523805248052580526805278052880529805308053180532805338053480535805368053780538805398054080541805428054380544805458054680547805488054980550805518055280553805548055580556805578055880559805608056180562805638056480565805668056780568805698057080571805728057380574805758057680577805788057980580805818058280583805848058580586805878058880589805908059180592805938059480595805968059780598805998060080601806028060380604806058060680607806088060980610806118061280613806148061580616806178061880619806208062180622806238062480625806268062780628806298063080631806328063380634806358063680637806388063980640806418064280643806448064580646806478064880649806508065180652806538065480655806568065780658806598066080661806628066380664806658066680667806688066980670806718067280673806748067580676806778067880679806808068180682806838068480685806868068780688806898069080691806928069380694806958069680697806988069980700807018070280703807048070580706807078070880709807108071180712807138071480715807168071780718807198072080721807228072380724807258072680727807288072980730807318073280733807348073580736807378073880739807408074180742807438074480745807468074780748807498075080751807528075380754807558075680757807588075980760807618076280763807648076580766807678076880769807708077180772807738077480775807768077780778807798078080781807828078380784807858078680787807888078980790807918079280793807948079580796807978079880799808008080180802808038080480805808068080780808808098081080811808128081380814808158081680817808188081980820808218082280823808248082580826808278082880829808308083180832808338083480835808368083780838808398084080841808428084380844808458084680847808488084980850808518085280853808548085580856808578085880859808608086180862808638086480865808668086780868808698087080871808728087380874808758087680877808788087980880808818088280883808848088580886808878088880889808908089180892808938089480895808968089780898808998090080901809028090380904809058090680907809088090980910809118091280913809148091580916809178091880919809208092180922809238092480925809268092780928809298093080931809328093380934809358093680937809388093980940809418094280943809448094580946809478094880949809508095180952809538095480955809568095780958809598096080961809628096380964809658096680967809688096980970809718097280973809748097580976809778097880979809808098180982809838098480985809868098780988809898099080991809928099380994809958099680997809988099981000810018100281003810048100581006810078100881009810108101181012810138101481015810168101781018810198102081021810228102381024810258102681027810288102981030810318103281033810348103581036810378103881039810408104181042810438104481045810468104781048810498105081051810528105381054810558105681057810588105981060810618106281063810648106581066810678106881069810708107181072810738107481075810768107781078810798108081081810828108381084810858108681087810888108981090810918109281093810948109581096810978109881099811008110181102811038110481105811068110781108811098111081111811128111381114811158111681117811188111981120811218112281123811248112581126811278112881129811308113181132811338113481135811368113781138811398114081141811428114381144811458114681147811488114981150811518115281153811548115581156811578115881159811608116181162811638116481165811668116781168811698117081171811728117381174811758117681177811788117981180811818118281183811848118581186811878118881189811908119181192811938119481195811968119781198811998120081201812028120381204812058120681207812088120981210812118121281213812148121581216812178121881219812208122181222812238122481225812268122781228812298123081231812328123381234812358123681237812388123981240812418124281243812448124581246812478124881249812508125181252812538125481255812568125781258812598126081261812628126381264812658126681267812688126981270812718127281273812748127581276812778127881279812808128181282812838128481285812868128781288812898129081291812928129381294812958129681297812988129981300813018130281303813048130581306813078130881309813108131181312813138131481315813168131781318813198132081321813228132381324813258132681327813288132981330813318133281333813348133581336813378133881339813408134181342813438134481345813468134781348813498135081351813528135381354813558135681357813588135981360813618136281363813648136581366813678136881369813708137181372813738137481375813768137781378813798138081381813828138381384813858138681387813888138981390813918139281393813948139581396813978139881399814008140181402814038140481405814068140781408814098141081411814128141381414814158141681417814188141981420814218142281423814248142581426814278142881429814308143181432814338143481435814368143781438814398144081441814428144381444814458144681447814488144981450814518145281453814548145581456814578145881459814608146181462814638146481465814668146781468814698147081471814728147381474814758147681477814788147981480814818148281483814848148581486814878148881489814908149181492814938149481495814968149781498814998150081501815028150381504815058150681507815088150981510815118151281513815148151581516815178151881519815208152181522815238152481525815268152781528815298153081531815328153381534815358153681537815388153981540815418154281543815448154581546815478154881549815508155181552815538155481555815568155781558815598156081561815628156381564815658156681567815688156981570815718157281573815748157581576815778157881579815808158181582815838158481585815868158781588815898159081591815928159381594815958159681597815988159981600816018160281603816048160581606816078160881609816108161181612816138161481615816168161781618816198162081621816228162381624816258162681627816288162981630816318163281633816348163581636816378163881639816408164181642816438164481645816468164781648816498165081651816528165381654816558165681657816588165981660816618166281663816648166581666816678166881669816708167181672816738167481675816768167781678816798168081681816828168381684816858168681687816888168981690816918169281693816948169581696816978169881699817008170181702817038170481705817068170781708817098171081711817128171381714817158171681717817188171981720817218172281723817248172581726817278172881729817308173181732817338173481735817368173781738817398174081741817428174381744817458174681747817488174981750817518175281753817548175581756817578175881759817608176181762817638176481765817668176781768817698177081771817728177381774817758177681777817788177981780817818178281783817848178581786817878178881789817908179181792817938179481795817968179781798817998180081801818028180381804818058180681807818088180981810818118181281813818148181581816818178181881819818208182181822818238182481825818268182781828818298183081831818328183381834818358183681837818388183981840818418184281843818448184581846818478184881849818508185181852818538185481855818568185781858818598186081861818628186381864818658186681867818688186981870818718187281873818748187581876818778187881879818808188181882818838188481885818868188781888818898189081891818928189381894818958189681897818988189981900819018190281903819048190581906819078190881909819108191181912819138191481915819168191781918819198192081921819228192381924819258192681927819288192981930819318193281933819348193581936819378193881939819408194181942819438194481945819468194781948819498195081951819528195381954819558195681957819588195981960819618196281963819648196581966819678196881969819708197181972819738197481975819768197781978819798198081981819828198381984819858198681987819888198981990819918199281993819948199581996819978199881999820008200182002820038200482005820068200782008820098201082011820128201382014820158201682017820188201982020820218202282023820248202582026820278202882029820308203182032820338203482035820368203782038820398204082041820428204382044820458204682047820488204982050820518205282053820548205582056820578205882059820608206182062820638206482065820668206782068820698207082071820728207382074820758207682077820788207982080820818208282083820848208582086820878208882089820908209182092820938209482095820968209782098820998210082101821028210382104821058210682107821088210982110821118211282113821148211582116821178211882119821208212182122821238212482125821268212782128821298213082131821328213382134821358213682137821388213982140821418214282143821448214582146821478214882149821508215182152821538215482155821568215782158821598216082161821628216382164821658216682167821688216982170821718217282173821748217582176821778217882179821808218182182821838218482185821868218782188821898219082191821928219382194821958219682197821988219982200822018220282203822048220582206822078220882209822108221182212822138221482215822168221782218822198222082221822228222382224822258222682227822288222982230822318223282233822348223582236822378223882239822408224182242822438224482245822468224782248822498225082251822528225382254822558225682257822588225982260822618226282263822648226582266822678226882269822708227182272822738227482275822768227782278822798228082281822828228382284822858228682287822888228982290822918229282293822948229582296822978229882299823008230182302823038230482305823068230782308823098231082311823128231382314823158231682317823188231982320823218232282323823248232582326823278232882329823308233182332823338233482335823368233782338823398234082341823428234382344823458234682347823488234982350823518235282353823548235582356823578235882359823608236182362823638236482365823668236782368823698237082371823728237382374823758237682377823788237982380823818238282383823848238582386823878238882389823908239182392823938239482395823968239782398823998240082401824028240382404824058240682407824088240982410824118241282413824148241582416824178241882419824208242182422824238242482425824268242782428824298243082431824328243382434824358243682437824388243982440824418244282443824448244582446824478244882449824508245182452824538245482455824568245782458824598246082461824628246382464824658246682467824688246982470824718247282473824748247582476824778247882479824808248182482824838248482485824868248782488824898249082491824928249382494824958249682497824988249982500825018250282503825048250582506825078250882509825108251182512825138251482515825168251782518825198252082521825228252382524825258252682527825288252982530825318253282533825348253582536825378253882539825408254182542825438254482545825468254782548825498255082551825528255382554825558255682557825588255982560825618256282563825648256582566825678256882569825708257182572825738257482575825768257782578825798258082581825828258382584825858258682587825888258982590825918259282593825948259582596825978259882599826008260182602826038260482605826068260782608826098261082611826128261382614826158261682617826188261982620826218262282623826248262582626826278262882629826308263182632826338263482635826368263782638826398264082641826428264382644826458264682647826488264982650826518265282653826548265582656826578265882659826608266182662826638266482665826668266782668826698267082671826728267382674826758267682677826788267982680826818268282683826848268582686826878268882689826908269182692826938269482695826968269782698826998270082701827028270382704827058270682707827088270982710827118271282713827148271582716827178271882719827208272182722827238272482725827268272782728827298273082731827328273382734827358273682737827388273982740827418274282743827448274582746827478274882749827508275182752827538275482755827568275782758827598276082761827628276382764827658276682767827688276982770827718277282773827748277582776827778277882779827808278182782827838278482785827868278782788827898279082791827928279382794827958279682797827988279982800828018280282803828048280582806828078280882809828108281182812828138281482815828168281782818828198282082821828228282382824828258282682827828288282982830828318283282833828348283582836828378283882839828408284182842828438284482845828468284782848828498285082851828528285382854828558285682857828588285982860828618286282863828648286582866828678286882869828708287182872828738287482875828768287782878828798288082881828828288382884828858288682887828888288982890828918289282893828948289582896828978289882899829008290182902829038290482905829068290782908829098291082911829128291382914829158291682917829188291982920829218292282923829248292582926829278292882929829308293182932829338293482935829368293782938829398294082941829428294382944829458294682947829488294982950829518295282953829548295582956829578295882959829608296182962829638296482965829668296782968829698297082971829728297382974829758297682977829788297982980829818298282983829848298582986829878298882989829908299182992829938299482995829968299782998829998300083001830028300383004830058300683007830088300983010830118301283013830148301583016830178301883019830208302183022830238302483025830268302783028830298303083031830328303383034830358303683037830388303983040830418304283043830448304583046830478304883049830508305183052830538305483055830568305783058830598306083061830628306383064830658306683067830688306983070830718307283073830748307583076830778307883079830808308183082830838308483085830868308783088830898309083091830928309383094830958309683097830988309983100831018310283103831048310583106831078310883109831108311183112831138311483115831168311783118831198312083121831228312383124831258312683127831288312983130831318313283133831348313583136831378313883139831408314183142831438314483145831468314783148831498315083151831528315383154831558315683157831588315983160831618316283163831648316583166831678316883169831708317183172831738317483175831768317783178831798318083181831828318383184831858318683187831888318983190831918319283193831948319583196831978319883199832008320183202832038320483205832068320783208832098321083211832128321383214832158321683217832188321983220832218322283223832248322583226832278322883229832308323183232832338323483235832368323783238832398324083241832428324383244832458324683247832488324983250832518325283253832548325583256832578325883259832608326183262832638326483265832668326783268832698327083271832728327383274832758327683277832788327983280832818328283283832848328583286832878328883289832908329183292832938329483295832968329783298832998330083301833028330383304833058330683307833088330983310833118331283313833148331583316833178331883319833208332183322833238332483325833268332783328833298333083331833328333383334833358333683337833388333983340833418334283343833448334583346833478334883349833508335183352833538335483355833568335783358833598336083361833628336383364833658336683367833688336983370833718337283373833748337583376833778337883379833808338183382833838338483385833868338783388833898339083391833928339383394833958339683397833988339983400834018340283403834048340583406834078340883409834108341183412834138341483415834168341783418834198342083421834228342383424834258342683427834288342983430834318343283433834348343583436834378343883439834408344183442834438344483445834468344783448834498345083451834528345383454834558345683457834588345983460834618346283463834648346583466834678346883469834708347183472834738347483475834768347783478834798348083481834828348383484834858348683487834888348983490834918349283493834948349583496834978349883499835008350183502835038350483505835068350783508835098351083511835128351383514835158351683517835188351983520835218352283523835248352583526835278352883529835308353183532835338353483535835368353783538835398354083541835428354383544835458354683547835488354983550835518355283553835548355583556835578355883559835608356183562835638356483565835668356783568835698357083571835728357383574835758357683577835788357983580835818358283583835848358583586835878358883589835908359183592835938359483595835968359783598835998360083601836028360383604836058360683607836088360983610836118361283613836148361583616836178361883619836208362183622836238362483625836268362783628836298363083631836328363383634836358363683637836388363983640836418364283643836448364583646836478364883649836508365183652836538365483655836568365783658836598366083661836628366383664836658366683667836688366983670836718367283673836748367583676836778367883679836808368183682836838368483685836868368783688836898369083691836928369383694836958369683697836988369983700837018370283703837048370583706837078370883709837108371183712837138371483715837168371783718837198372083721837228372383724837258372683727837288372983730837318373283733837348373583736837378373883739837408374183742837438374483745837468374783748837498375083751837528375383754837558375683757837588375983760837618376283763837648376583766837678376883769837708377183772837738377483775837768377783778837798378083781837828378383784837858378683787837888378983790837918379283793837948379583796837978379883799838008380183802838038380483805838068380783808838098381083811838128381383814838158381683817838188381983820838218382283823838248382583826838278382883829838308383183832838338383483835838368383783838838398384083841838428384383844838458384683847838488384983850838518385283853838548385583856838578385883859838608386183862838638386483865838668386783868838698387083871838728387383874838758387683877838788387983880838818388283883838848388583886838878388883889838908389183892838938389483895838968389783898838998390083901839028390383904839058390683907839088390983910839118391283913839148391583916839178391883919839208392183922839238392483925839268392783928839298393083931839328393383934839358393683937839388393983940839418394283943839448394583946839478394883949839508395183952839538395483955839568395783958839598396083961839628396383964839658396683967839688396983970839718397283973839748397583976839778397883979839808398183982839838398483985839868398783988839898399083991839928399383994839958399683997839988399984000840018400284003840048400584006840078400884009840108401184012840138401484015840168401784018840198402084021840228402384024840258402684027840288402984030840318403284033840348403584036840378403884039840408404184042840438404484045840468404784048840498405084051840528405384054840558405684057840588405984060840618406284063840648406584066840678406884069840708407184072840738407484075840768407784078840798408084081840828408384084840858408684087840888408984090840918409284093840948409584096840978409884099841008410184102841038410484105841068410784108841098411084111841128411384114841158411684117841188411984120841218412284123841248412584126841278412884129841308413184132841338413484135841368413784138841398414084141841428414384144841458414684147841488414984150841518415284153841548415584156841578415884159841608416184162841638416484165841668416784168841698417084171841728417384174841758417684177841788417984180841818418284183841848418584186841878418884189841908419184192841938419484195841968419784198841998420084201842028420384204842058420684207842088420984210842118421284213842148421584216842178421884219842208422184222842238422484225842268422784228842298423084231842328423384234842358423684237842388423984240842418424284243842448424584246842478424884249842508425184252842538425484255842568425784258842598426084261842628426384264842658426684267842688426984270842718427284273842748427584276842778427884279842808428184282842838428484285842868428784288842898429084291842928429384294842958429684297842988429984300843018430284303843048430584306843078430884309843108431184312843138431484315843168431784318843198432084321843228432384324843258432684327843288432984330843318433284333843348433584336843378433884339843408434184342843438434484345843468434784348843498435084351843528435384354843558435684357843588435984360843618436284363843648436584366843678436884369843708437184372843738437484375843768437784378843798438084381843828438384384843858438684387843888438984390843918439284393843948439584396843978439884399844008440184402844038440484405844068440784408844098441084411844128441384414844158441684417844188441984420844218442284423844248442584426844278442884429844308443184432844338443484435844368443784438844398444084441844428444384444844458444684447844488444984450844518445284453844548445584456844578445884459844608446184462844638446484465844668446784468844698447084471844728447384474844758447684477844788447984480844818448284483844848448584486844878448884489844908449184492844938449484495844968449784498844998450084501845028450384504845058450684507845088450984510845118451284513845148451584516845178451884519845208452184522845238452484525845268452784528845298453084531845328453384534845358453684537845388453984540845418454284543845448454584546845478454884549845508455184552845538455484555845568455784558845598456084561845628456384564845658456684567845688456984570845718457284573845748457584576845778457884579845808458184582845838458484585845868458784588845898459084591845928459384594845958459684597845988459984600846018460284603846048460584606846078460884609846108461184612846138461484615846168461784618846198462084621846228462384624846258462684627846288462984630846318463284633846348463584636846378463884639846408464184642846438464484645846468464784648846498465084651846528465384654846558465684657846588465984660846618466284663846648466584666846678466884669846708467184672846738467484675846768467784678846798468084681846828468384684846858468684687846888468984690846918469284693846948469584696846978469884699847008470184702847038470484705847068470784708847098471084711847128471384714847158471684717847188471984720847218472284723847248472584726847278472884729847308473184732847338473484735847368473784738847398474084741847428474384744847458474684747847488474984750847518475284753847548475584756847578475884759847608476184762847638476484765847668476784768847698477084771847728477384774847758477684777847788477984780847818478284783847848478584786847878478884789847908479184792847938479484795847968479784798847998480084801848028480384804848058480684807848088480984810848118481284813848148481584816848178481884819848208482184822848238482484825848268482784828848298483084831848328483384834848358483684837848388483984840848418484284843848448484584846848478484884849848508485184852848538485484855848568485784858848598486084861848628486384864848658486684867848688486984870848718487284873848748487584876848778487884879848808488184882848838488484885848868488784888848898489084891848928489384894848958489684897848988489984900849018490284903849048490584906849078490884909849108491184912849138491484915849168491784918849198492084921849228492384924849258492684927849288492984930849318493284933849348493584936849378493884939849408494184942849438494484945849468494784948849498495084951849528495384954849558495684957849588495984960849618496284963849648496584966849678496884969849708497184972849738497484975849768497784978849798498084981849828498384984849858498684987849888498984990849918499284993849948499584996849978499884999850008500185002850038500485005850068500785008850098501085011850128501385014850158501685017850188501985020850218502285023850248502585026850278502885029850308503185032850338503485035850368503785038850398504085041850428504385044850458504685047850488504985050850518505285053850548505585056850578505885059850608506185062850638506485065850668506785068850698507085071850728507385074850758507685077850788507985080850818508285083850848508585086850878508885089850908509185092850938509485095850968509785098850998510085101851028510385104851058510685107851088510985110851118511285113851148511585116851178511885119851208512185122851238512485125851268512785128851298513085131851328513385134851358513685137851388513985140851418514285143851448514585146851478514885149851508515185152851538515485155851568515785158851598516085161851628516385164851658516685167851688516985170851718517285173851748517585176851778517885179851808518185182851838518485185851868518785188851898519085191851928519385194851958519685197851988519985200852018520285203852048520585206852078520885209852108521185212852138521485215852168521785218852198522085221852228522385224852258522685227852288522985230852318523285233852348523585236852378523885239852408524185242852438524485245852468524785248852498525085251852528525385254852558525685257852588525985260852618526285263852648526585266852678526885269852708527185272852738527485275852768527785278852798528085281852828528385284852858528685287852888528985290852918529285293852948529585296852978529885299853008530185302853038530485305853068530785308853098531085311853128531385314853158531685317853188531985320853218532285323853248532585326853278532885329853308533185332853338533485335853368533785338853398534085341853428534385344853458534685347853488534985350853518535285353853548535585356853578535885359853608536185362853638536485365853668536785368853698537085371853728537385374853758537685377853788537985380853818538285383853848538585386853878538885389853908539185392853938539485395853968539785398853998540085401854028540385404854058540685407854088540985410854118541285413854148541585416854178541885419854208542185422854238542485425854268542785428854298543085431854328543385434854358543685437854388543985440854418544285443854448544585446854478544885449854508545185452854538545485455854568545785458854598546085461854628546385464854658546685467854688546985470854718547285473854748547585476854778547885479854808548185482854838548485485854868548785488854898549085491854928549385494854958549685497854988549985500855018550285503855048550585506855078550885509855108551185512855138551485515855168551785518855198552085521855228552385524855258552685527855288552985530855318553285533855348553585536855378553885539855408554185542855438554485545855468554785548855498555085551855528555385554855558555685557855588555985560855618556285563855648556585566855678556885569855708557185572855738557485575855768557785578855798558085581855828558385584855858558685587855888558985590855918559285593855948559585596855978559885599856008560185602856038560485605856068560785608856098561085611856128561385614856158561685617856188561985620856218562285623856248562585626856278562885629856308563185632856338563485635856368563785638856398564085641856428564385644856458564685647856488564985650856518565285653856548565585656856578565885659856608566185662856638566485665856668566785668856698567085671856728567385674856758567685677856788567985680856818568285683856848568585686856878568885689856908569185692856938569485695856968569785698856998570085701857028570385704857058570685707857088570985710857118571285713857148571585716857178571885719857208572185722857238572485725857268572785728857298573085731857328573385734857358573685737857388573985740857418574285743857448574585746857478574885749857508575185752857538575485755857568575785758857598576085761857628576385764857658576685767857688576985770857718577285773857748577585776857778577885779857808578185782857838578485785857868578785788857898579085791857928579385794857958579685797857988579985800858018580285803858048580585806858078580885809858108581185812858138581485815858168581785818858198582085821858228582385824858258582685827858288582985830858318583285833858348583585836858378583885839858408584185842858438584485845858468584785848858498585085851858528585385854858558585685857858588585985860858618586285863858648586585866858678586885869858708587185872858738587485875858768587785878858798588085881858828588385884858858588685887858888588985890858918589285893858948589585896858978589885899859008590185902859038590485905859068590785908859098591085911859128591385914859158591685917859188591985920859218592285923859248592585926859278592885929859308593185932859338593485935859368593785938859398594085941859428594385944859458594685947859488594985950859518595285953859548595585956859578595885959859608596185962859638596485965859668596785968859698597085971859728597385974859758597685977859788597985980859818598285983859848598585986859878598885989859908599185992859938599485995859968599785998859998600086001860028600386004860058600686007860088600986010860118601286013860148601586016860178601886019860208602186022860238602486025860268602786028860298603086031860328603386034860358603686037860388603986040860418604286043860448604586046860478604886049860508605186052860538605486055860568605786058860598606086061860628606386064860658606686067860688606986070860718607286073860748607586076860778607886079860808608186082860838608486085860868608786088860898609086091860928609386094860958609686097860988609986100861018610286103861048610586106861078610886109861108611186112861138611486115861168611786118861198612086121861228612386124861258612686127861288612986130861318613286133861348613586136861378613886139861408614186142861438614486145861468614786148861498615086151861528615386154861558615686157861588615986160861618616286163861648616586166861678616886169861708617186172861738617486175861768617786178861798618086181861828618386184861858618686187861888618986190861918619286193861948619586196861978619886199862008620186202862038620486205862068620786208862098621086211862128621386214862158621686217862188621986220862218622286223862248622586226862278622886229862308623186232862338623486235862368623786238862398624086241862428624386244862458624686247862488624986250862518625286253862548625586256862578625886259862608626186262862638626486265862668626786268862698627086271862728627386274862758627686277862788627986280862818628286283862848628586286862878628886289862908629186292862938629486295862968629786298862998630086301863028630386304863058630686307863088630986310863118631286313863148631586316863178631886319863208632186322863238632486325863268632786328863298633086331863328633386334863358633686337863388633986340863418634286343863448634586346863478634886349863508635186352863538635486355863568635786358863598636086361863628636386364863658636686367863688636986370863718637286373863748637586376863778637886379863808638186382863838638486385863868638786388863898639086391863928639386394863958639686397863988639986400864018640286403864048640586406864078640886409864108641186412864138641486415864168641786418864198642086421864228642386424864258642686427864288642986430864318643286433864348643586436864378643886439864408644186442864438644486445864468644786448864498645086451864528645386454864558645686457864588645986460864618646286463864648646586466864678646886469864708647186472864738647486475864768647786478864798648086481864828648386484864858648686487864888648986490864918649286493864948649586496864978649886499865008650186502865038650486505865068650786508865098651086511865128651386514865158651686517865188651986520865218652286523865248652586526865278652886529865308653186532865338653486535865368653786538865398654086541865428654386544865458654686547865488654986550865518655286553865548655586556865578655886559865608656186562865638656486565865668656786568865698657086571865728657386574865758657686577865788657986580865818658286583865848658586586865878658886589865908659186592865938659486595865968659786598865998660086601866028660386604866058660686607866088660986610866118661286613866148661586616866178661886619866208662186622866238662486625866268662786628866298663086631866328663386634866358663686637866388663986640866418664286643866448664586646866478664886649866508665186652866538665486655866568665786658866598666086661866628666386664866658666686667866688666986670866718667286673866748667586676866778667886679866808668186682866838668486685866868668786688866898669086691866928669386694866958669686697866988669986700867018670286703867048670586706867078670886709867108671186712867138671486715867168671786718867198672086721867228672386724867258672686727867288672986730867318673286733867348673586736867378673886739867408674186742867438674486745867468674786748867498675086751867528675386754867558675686757867588675986760867618676286763867648676586766867678676886769867708677186772867738677486775867768677786778867798678086781867828678386784867858678686787867888678986790867918679286793867948679586796867978679886799868008680186802868038680486805868068680786808868098681086811868128681386814868158681686817868188681986820868218682286823868248682586826868278682886829868308683186832868338683486835868368683786838868398684086841868428684386844868458684686847868488684986850868518685286853868548685586856868578685886859868608686186862868638686486865868668686786868868698687086871868728687386874868758687686877868788687986880868818688286883868848688586886868878688886889868908689186892868938689486895868968689786898868998690086901869028690386904869058690686907869088690986910869118691286913869148691586916869178691886919869208692186922869238692486925869268692786928869298693086931869328693386934869358693686937869388693986940869418694286943869448694586946869478694886949869508695186952869538695486955869568695786958869598696086961869628696386964869658696686967869688696986970869718697286973869748697586976869778697886979869808698186982869838698486985869868698786988869898699086991869928699386994869958699686997869988699987000870018700287003870048700587006870078700887009870108701187012870138701487015870168701787018870198702087021870228702387024870258702687027870288702987030870318703287033870348703587036870378703887039870408704187042870438704487045870468704787048870498705087051870528705387054870558705687057870588705987060870618706287063870648706587066870678706887069870708707187072870738707487075870768707787078870798708087081870828708387084870858708687087870888708987090870918709287093870948709587096870978709887099871008710187102871038710487105871068710787108871098711087111871128711387114871158711687117871188711987120871218712287123871248712587126871278712887129871308713187132871338713487135871368713787138871398714087141871428714387144871458714687147871488714987150871518715287153871548715587156871578715887159871608716187162871638716487165871668716787168871698717087171871728717387174871758717687177871788717987180871818718287183871848718587186871878718887189871908719187192871938719487195871968719787198871998720087201872028720387204872058720687207872088720987210872118721287213872148721587216872178721887219872208722187222872238722487225872268722787228872298723087231872328723387234872358723687237872388723987240872418724287243872448724587246872478724887249872508725187252872538725487255872568725787258872598726087261872628726387264872658726687267872688726987270872718727287273872748727587276872778727887279872808728187282872838728487285872868728787288872898729087291872928729387294872958729687297872988729987300873018730287303873048730587306873078730887309873108731187312873138731487315873168731787318873198732087321873228732387324873258732687327873288732987330873318733287333873348733587336873378733887339873408734187342873438734487345873468734787348873498735087351873528735387354873558735687357873588735987360873618736287363873648736587366873678736887369873708737187372873738737487375873768737787378873798738087381873828738387384873858738687387873888738987390873918739287393873948739587396873978739887399874008740187402874038740487405874068740787408874098741087411874128741387414874158741687417874188741987420874218742287423874248742587426874278742887429874308743187432874338743487435874368743787438874398744087441874428744387444874458744687447874488744987450874518745287453874548745587456874578745887459874608746187462874638746487465874668746787468874698747087471874728747387474874758747687477874788747987480874818748287483874848748587486874878748887489874908749187492874938749487495874968749787498874998750087501875028750387504875058750687507875088750987510875118751287513875148751587516875178751887519875208752187522875238752487525875268752787528875298753087531875328753387534875358753687537875388753987540875418754287543875448754587546875478754887549875508755187552875538755487555875568755787558875598756087561875628756387564875658756687567875688756987570875718757287573875748757587576875778757887579875808758187582875838758487585875868758787588875898759087591875928759387594875958759687597875988759987600876018760287603876048760587606876078760887609876108761187612876138761487615876168761787618876198762087621876228762387624876258762687627876288762987630876318763287633876348763587636876378763887639876408764187642876438764487645876468764787648876498765087651876528765387654876558765687657876588765987660876618766287663876648766587666876678766887669876708767187672876738767487675876768767787678876798768087681876828768387684876858768687687876888768987690876918769287693876948769587696876978769887699877008770187702877038770487705877068770787708877098771087711877128771387714877158771687717877188771987720877218772287723877248772587726877278772887729877308773187732877338773487735877368773787738877398774087741877428774387744877458774687747877488774987750877518775287753877548775587756877578775887759877608776187762877638776487765877668776787768877698777087771877728777387774877758777687777877788777987780877818778287783877848778587786877878778887789877908779187792877938779487795877968779787798877998780087801878028780387804878058780687807878088780987810878118781287813878148781587816878178781887819878208782187822878238782487825878268782787828878298783087831878328783387834878358783687837878388783987840878418784287843878448784587846878478784887849878508785187852878538785487855878568785787858878598786087861878628786387864878658786687867878688786987870878718787287873878748787587876878778787887879878808788187882878838788487885878868788787888878898789087891878928789387894878958789687897878988789987900879018790287903879048790587906879078790887909879108791187912879138791487915879168791787918879198792087921879228792387924879258792687927879288792987930879318793287933879348793587936879378793887939879408794187942879438794487945879468794787948879498795087951879528795387954879558795687957879588795987960879618796287963879648796587966879678796887969879708797187972879738797487975879768797787978879798798087981879828798387984879858798687987879888798987990879918799287993879948799587996879978799887999880008800188002880038800488005880068800788008880098801088011880128801388014880158801688017880188801988020880218802288023880248802588026880278802888029880308803188032880338803488035880368803788038880398804088041880428804388044880458804688047880488804988050880518805288053880548805588056880578805888059880608806188062880638806488065880668806788068880698807088071880728807388074880758807688077880788807988080880818808288083880848808588086880878808888089880908809188092880938809488095880968809788098880998810088101881028810388104881058810688107881088810988110881118811288113881148811588116881178811888119881208812188122881238812488125881268812788128881298813088131881328813388134881358813688137881388813988140881418814288143881448814588146881478814888149881508815188152881538815488155881568815788158881598816088161881628816388164881658816688167881688816988170881718817288173881748817588176881778817888179881808818188182881838818488185881868818788188881898819088191881928819388194881958819688197881988819988200882018820288203882048820588206882078820888209882108821188212882138821488215882168821788218882198822088221882228822388224882258822688227882288822988230882318823288233882348823588236882378823888239882408824188242882438824488245882468824788248882498825088251882528825388254882558825688257882588825988260882618826288263882648826588266882678826888269882708827188272882738827488275882768827788278882798828088281882828828388284882858828688287882888828988290882918829288293882948829588296882978829888299883008830188302883038830488305883068830788308883098831088311883128831388314883158831688317883188831988320883218832288323883248832588326883278832888329883308833188332883338833488335883368833788338883398834088341883428834388344883458834688347883488834988350883518835288353883548835588356883578835888359883608836188362883638836488365883668836788368883698837088371883728837388374883758837688377883788837988380883818838288383883848838588386883878838888389883908839188392883938839488395883968839788398883998840088401884028840388404884058840688407884088840988410884118841288413884148841588416884178841888419884208842188422884238842488425884268842788428884298843088431884328843388434884358843688437884388843988440884418844288443884448844588446884478844888449884508845188452884538845488455884568845788458884598846088461884628846388464884658846688467884688846988470884718847288473884748847588476884778847888479884808848188482884838848488485884868848788488884898849088491884928849388494884958849688497884988849988500885018850288503885048850588506885078850888509885108851188512885138851488515885168851788518885198852088521885228852388524885258852688527885288852988530885318853288533885348853588536885378853888539885408854188542885438854488545885468854788548885498855088551885528855388554885558855688557885588855988560885618856288563885648856588566885678856888569885708857188572885738857488575885768857788578885798858088581885828858388584885858858688587885888858988590885918859288593885948859588596885978859888599886008860188602886038860488605886068860788608886098861088611886128861388614886158861688617886188861988620886218862288623886248862588626886278862888629886308863188632886338863488635886368863788638886398864088641886428864388644886458864688647886488864988650886518865288653886548865588656886578865888659886608866188662886638866488665886668866788668886698867088671886728867388674886758867688677886788867988680886818868288683886848868588686886878868888689886908869188692886938869488695886968869788698886998870088701887028870388704887058870688707887088870988710887118871288713887148871588716887178871888719887208872188722887238872488725887268872788728887298873088731887328873388734887358873688737887388873988740887418874288743887448874588746887478874888749887508875188752887538875488755887568875788758887598876088761887628876388764887658876688767887688876988770887718877288773887748877588776887778877888779887808878188782887838878488785887868878788788887898879088791887928879388794887958879688797887988879988800888018880288803888048880588806888078880888809888108881188812888138881488815888168881788818888198882088821888228882388824888258882688827888288882988830888318883288833888348883588836888378883888839888408884188842888438884488845888468884788848888498885088851888528885388854888558885688857888588885988860888618886288863888648886588866888678886888869888708887188872888738887488875888768887788878888798888088881888828888388884888858888688887888888888988890888918889288893888948889588896888978889888899889008890188902889038890488905889068890788908889098891088911889128891388914889158891688917889188891988920889218892288923889248892588926889278892888929889308893188932889338893488935889368893788938889398894088941889428894388944889458894688947889488894988950889518895288953889548895588956889578895888959889608896188962889638896488965889668896788968889698897088971889728897388974889758897688977889788897988980889818898288983889848898588986889878898888989889908899188992889938899488995889968899788998889998900089001890028900389004890058900689007890088900989010890118901289013890148901589016890178901889019890208902189022890238902489025890268902789028890298903089031890328903389034890358903689037890388903989040890418904289043890448904589046890478904889049890508905189052890538905489055890568905789058890598906089061890628906389064890658906689067890688906989070890718907289073890748907589076890778907889079890808908189082890838908489085890868908789088890898909089091890928909389094890958909689097890988909989100891018910289103891048910589106891078910889109891108911189112891138911489115891168911789118891198912089121891228912389124891258912689127891288912989130891318913289133891348913589136891378913889139891408914189142891438914489145891468914789148891498915089151891528915389154891558915689157891588915989160891618916289163891648916589166891678916889169891708917189172891738917489175891768917789178891798918089181891828918389184891858918689187891888918989190891918919289193891948919589196891978919889199892008920189202892038920489205892068920789208892098921089211892128921389214892158921689217892188921989220892218922289223892248922589226892278922889229892308923189232892338923489235892368923789238892398924089241892428924389244892458924689247892488924989250892518925289253892548925589256892578925889259892608926189262892638926489265892668926789268892698927089271892728927389274892758927689277892788927989280892818928289283892848928589286892878928889289892908929189292892938929489295892968929789298892998930089301893028930389304893058930689307893088930989310893118931289313893148931589316893178931889319893208932189322893238932489325893268932789328893298933089331893328933389334893358933689337893388933989340893418934289343893448934589346893478934889349893508935189352893538935489355893568935789358893598936089361893628936389364893658936689367893688936989370893718937289373893748937589376893778937889379893808938189382893838938489385893868938789388893898939089391893928939389394893958939689397893988939989400894018940289403894048940589406894078940889409894108941189412894138941489415894168941789418894198942089421894228942389424894258942689427894288942989430894318943289433894348943589436894378943889439894408944189442894438944489445894468944789448894498945089451894528945389454894558945689457894588945989460894618946289463894648946589466894678946889469894708947189472894738947489475894768947789478894798948089481894828948389484894858948689487894888948989490894918949289493894948949589496894978949889499895008950189502895038950489505895068950789508895098951089511895128951389514895158951689517895188951989520895218952289523895248952589526895278952889529895308953189532895338953489535895368953789538895398954089541895428954389544895458954689547895488954989550895518955289553895548955589556895578955889559895608956189562895638956489565895668956789568895698957089571895728957389574895758957689577895788957989580895818958289583895848958589586895878958889589895908959189592895938959489595895968959789598895998960089601896028960389604896058960689607896088960989610896118961289613896148961589616896178961889619896208962189622896238962489625896268962789628896298963089631896328963389634896358963689637896388963989640896418964289643896448964589646896478964889649896508965189652896538965489655896568965789658896598966089661896628966389664896658966689667896688966989670896718967289673896748967589676896778967889679896808968189682896838968489685896868968789688896898969089691896928969389694896958969689697896988969989700897018970289703897048970589706897078970889709897108971189712897138971489715897168971789718897198972089721897228972389724897258972689727897288972989730897318973289733897348973589736897378973889739897408974189742897438974489745897468974789748897498975089751897528975389754897558975689757897588975989760897618976289763897648976589766897678976889769897708977189772897738977489775897768977789778897798978089781897828978389784897858978689787897888978989790897918979289793897948979589796897978979889799898008980189802898038980489805898068980789808898098981089811898128981389814898158981689817898188981989820898218982289823898248982589826898278982889829898308983189832898338983489835898368983789838898398984089841898428984389844898458984689847898488984989850898518985289853898548985589856898578985889859898608986189862898638986489865898668986789868898698987089871898728987389874898758987689877898788987989880898818988289883898848988589886898878988889889898908989189892898938989489895898968989789898898998990089901899028990389904899058990689907899088990989910899118991289913899148991589916899178991889919899208992189922899238992489925899268992789928899298993089931899328993389934899358993689937899388993989940899418994289943899448994589946899478994889949899508995189952899538995489955899568995789958899598996089961899628996389964899658996689967899688996989970899718997289973899748997589976899778997889979899808998189982899838998489985899868998789988899898999089991899928999389994899958999689997899988999990000900019000290003900049000590006900079000890009900109001190012900139001490015900169001790018900199002090021900229002390024900259002690027900289002990030900319003290033900349003590036900379003890039900409004190042900439004490045900469004790048900499005090051900529005390054900559005690057900589005990060900619006290063900649006590066900679006890069900709007190072900739007490075900769007790078900799008090081900829008390084900859008690087900889008990090900919009290093900949009590096900979009890099901009010190102901039010490105901069010790108901099011090111901129011390114901159011690117901189011990120901219012290123901249012590126901279012890129901309013190132901339013490135901369013790138901399014090141901429014390144901459014690147901489014990150901519015290153901549015590156901579015890159901609016190162901639016490165901669016790168901699017090171901729017390174901759017690177901789017990180901819018290183901849018590186901879018890189901909019190192901939019490195901969019790198901999020090201902029020390204902059020690207902089020990210902119021290213902149021590216902179021890219902209022190222902239022490225902269022790228902299023090231902329023390234902359023690237902389023990240902419024290243902449024590246902479024890249902509025190252902539025490255902569025790258902599026090261902629026390264902659026690267902689026990270902719027290273902749027590276902779027890279902809028190282902839028490285902869028790288902899029090291902929029390294902959029690297902989029990300903019030290303903049030590306903079030890309903109031190312903139031490315903169031790318903199032090321903229032390324903259032690327903289032990330903319033290333903349033590336903379033890339903409034190342903439034490345903469034790348903499035090351903529035390354903559035690357903589035990360903619036290363903649036590366903679036890369903709037190372903739037490375903769037790378903799038090381903829038390384903859038690387903889038990390903919039290393903949039590396903979039890399904009040190402904039040490405904069040790408904099041090411904129041390414904159041690417904189041990420904219042290423904249042590426904279042890429904309043190432904339043490435904369043790438904399044090441904429044390444904459044690447904489044990450904519045290453904549045590456904579045890459904609046190462904639046490465904669046790468904699047090471904729047390474904759047690477904789047990480904819048290483904849048590486904879048890489904909049190492904939049490495904969049790498904999050090501905029050390504905059050690507905089050990510905119051290513905149051590516905179051890519905209052190522905239052490525905269052790528905299053090531905329053390534905359053690537905389053990540905419054290543905449054590546905479054890549905509055190552905539055490555905569055790558905599056090561905629056390564905659056690567905689056990570905719057290573905749057590576905779057890579905809058190582905839058490585905869058790588905899059090591905929059390594905959059690597905989059990600906019060290603906049060590606906079060890609906109061190612906139061490615906169061790618906199062090621906229062390624906259062690627906289062990630906319063290633906349063590636906379063890639906409064190642906439064490645906469064790648906499065090651906529065390654906559065690657906589065990660906619066290663906649066590666906679066890669906709067190672906739067490675906769067790678906799068090681906829068390684906859068690687906889068990690906919069290693906949069590696906979069890699907009070190702907039070490705907069070790708907099071090711907129071390714907159071690717907189071990720907219072290723907249072590726907279072890729907309073190732907339073490735907369073790738907399074090741907429074390744907459074690747907489074990750907519075290753907549075590756907579075890759907609076190762907639076490765907669076790768907699077090771907729077390774907759077690777907789077990780907819078290783907849078590786907879078890789907909079190792907939079490795907969079790798907999080090801908029080390804908059080690807908089080990810908119081290813908149081590816908179081890819908209082190822908239082490825908269082790828908299083090831908329083390834908359083690837908389083990840908419084290843908449084590846908479084890849908509085190852908539085490855908569085790858908599086090861908629086390864908659086690867908689086990870908719087290873908749087590876908779087890879908809088190882908839088490885908869088790888908899089090891908929089390894908959089690897908989089990900909019090290903909049090590906909079090890909909109091190912909139091490915909169091790918909199092090921909229092390924909259092690927909289092990930909319093290933909349093590936909379093890939909409094190942909439094490945909469094790948909499095090951909529095390954909559095690957909589095990960909619096290963909649096590966909679096890969909709097190972909739097490975909769097790978909799098090981909829098390984909859098690987909889098990990909919099290993909949099590996909979099890999910009100191002910039100491005910069100791008910099101091011910129101391014910159101691017910189101991020910219102291023910249102591026910279102891029910309103191032910339103491035910369103791038910399104091041910429104391044910459104691047910489104991050910519105291053910549105591056910579105891059910609106191062910639106491065910669106791068910699107091071910729107391074910759107691077910789107991080910819108291083910849108591086910879108891089910909109191092910939109491095910969109791098910999110091101911029110391104911059110691107911089110991110911119111291113911149111591116911179111891119911209112191122911239112491125911269112791128911299113091131911329113391134911359113691137911389113991140911419114291143911449114591146911479114891149911509115191152911539115491155911569115791158911599116091161911629116391164911659116691167911689116991170911719117291173911749117591176911779117891179911809118191182911839118491185911869118791188911899119091191911929119391194911959119691197911989119991200912019120291203912049120591206912079120891209912109121191212912139121491215912169121791218912199122091221912229122391224912259122691227912289122991230912319123291233912349123591236912379123891239912409124191242912439124491245912469124791248912499125091251912529125391254912559125691257912589125991260912619126291263912649126591266912679126891269912709127191272912739127491275912769127791278912799128091281912829128391284912859128691287912889128991290912919129291293912949129591296912979129891299913009130191302913039130491305913069130791308913099131091311913129131391314913159131691317913189131991320913219132291323913249132591326913279132891329913309133191332913339133491335913369133791338913399134091341913429134391344913459134691347913489134991350913519135291353913549135591356913579135891359913609136191362913639136491365913669136791368913699137091371913729137391374913759137691377913789137991380913819138291383913849138591386913879138891389913909139191392913939139491395913969139791398913999140091401914029140391404914059140691407914089140991410914119141291413914149141591416914179141891419914209142191422914239142491425914269142791428914299143091431914329143391434914359143691437914389143991440914419144291443914449144591446914479144891449914509145191452914539145491455914569145791458914599146091461914629146391464914659146691467914689146991470914719147291473914749147591476914779147891479914809148191482914839148491485914869148791488914899149091491914929149391494914959149691497914989149991500915019150291503915049150591506915079150891509915109151191512915139151491515915169151791518915199152091521915229152391524915259152691527915289152991530915319153291533915349153591536915379153891539915409154191542915439154491545915469154791548915499155091551915529155391554915559155691557915589155991560915619156291563915649156591566915679156891569915709157191572915739157491575915769157791578915799158091581915829158391584915859158691587915889158991590915919159291593915949159591596915979159891599916009160191602916039160491605916069160791608916099161091611916129161391614916159161691617916189161991620916219162291623916249162591626916279162891629916309163191632916339163491635916369163791638916399164091641916429164391644916459164691647916489164991650916519165291653916549165591656916579165891659916609166191662916639166491665916669166791668916699167091671916729167391674916759167691677916789167991680916819168291683916849168591686916879168891689916909169191692916939169491695916969169791698916999170091701917029170391704917059170691707917089170991710917119171291713917149171591716917179171891719917209172191722917239172491725917269172791728917299173091731917329173391734917359173691737917389173991740917419174291743917449174591746917479174891749917509175191752917539175491755917569175791758917599176091761917629176391764917659176691767917689176991770917719177291773917749177591776917779177891779917809178191782917839178491785917869178791788917899179091791917929179391794917959179691797917989179991800918019180291803918049180591806918079180891809918109181191812918139181491815918169181791818918199182091821918229182391824918259182691827918289182991830918319183291833918349183591836918379183891839918409184191842918439184491845918469184791848918499185091851918529185391854918559185691857918589185991860918619186291863918649186591866918679186891869918709187191872918739187491875918769187791878918799188091881918829188391884918859188691887918889188991890918919189291893918949189591896918979189891899919009190191902919039190491905919069190791908919099191091911919129191391914919159191691917919189191991920919219192291923919249192591926919279192891929919309193191932919339193491935919369193791938919399194091941919429194391944919459194691947919489194991950919519195291953919549195591956919579195891959919609196191962919639196491965919669196791968919699197091971919729197391974919759197691977919789197991980919819198291983919849198591986919879198891989919909199191992919939199491995919969199791998919999200092001920029200392004920059200692007920089200992010920119201292013920149201592016920179201892019920209202192022920239202492025920269202792028920299203092031920329203392034920359203692037920389203992040920419204292043920449204592046920479204892049920509205192052920539205492055920569205792058920599206092061920629206392064920659206692067920689206992070920719207292073920749207592076920779207892079920809208192082920839208492085920869208792088920899209092091920929209392094920959209692097920989209992100921019210292103921049210592106921079210892109921109211192112921139211492115921169211792118921199212092121921229212392124921259212692127921289212992130921319213292133921349213592136921379213892139921409214192142921439214492145921469214792148921499215092151921529215392154921559215692157921589215992160921619216292163921649216592166921679216892169921709217192172921739217492175921769217792178921799218092181921829218392184921859218692187921889218992190921919219292193921949219592196921979219892199922009220192202922039220492205922069220792208922099221092211922129221392214922159221692217922189221992220922219222292223922249222592226922279222892229922309223192232922339223492235922369223792238922399224092241922429224392244922459224692247922489224992250922519225292253922549225592256922579225892259922609226192262922639226492265922669226792268922699227092271922729227392274922759227692277922789227992280922819228292283922849228592286922879228892289922909229192292922939229492295922969229792298922999230092301923029230392304923059230692307923089230992310923119231292313923149231592316923179231892319923209232192322923239232492325923269232792328923299233092331923329233392334923359233692337923389233992340923419234292343923449234592346923479234892349923509235192352923539235492355923569235792358923599236092361923629236392364923659236692367923689236992370923719237292373923749237592376923779237892379923809238192382923839238492385923869238792388923899239092391923929239392394923959239692397923989239992400924019240292403924049240592406924079240892409924109241192412924139241492415924169241792418924199242092421924229242392424924259242692427924289242992430924319243292433924349243592436924379243892439924409244192442924439244492445924469244792448924499245092451924529245392454924559245692457924589245992460924619246292463924649246592466924679246892469924709247192472924739247492475924769247792478924799248092481924829248392484924859248692487924889248992490924919249292493924949249592496924979249892499925009250192502925039250492505925069250792508925099251092511925129251392514925159251692517925189251992520925219252292523925249252592526925279252892529925309253192532925339253492535925369253792538925399254092541925429254392544925459254692547925489254992550925519255292553925549255592556925579255892559925609256192562925639256492565925669256792568925699257092571925729257392574925759257692577925789257992580925819258292583925849258592586925879258892589925909259192592925939259492595925969259792598925999260092601926029260392604926059260692607926089260992610926119261292613926149261592616926179261892619926209262192622926239262492625926269262792628926299263092631926329263392634926359263692637926389263992640926419264292643926449264592646926479264892649926509265192652926539265492655926569265792658926599266092661926629266392664926659266692667926689266992670926719267292673926749267592676926779267892679926809268192682926839268492685926869268792688926899269092691926929269392694926959269692697926989269992700927019270292703927049270592706927079270892709927109271192712927139271492715927169271792718927199272092721927229272392724927259272692727927289272992730927319273292733927349273592736927379273892739927409274192742927439274492745927469274792748927499275092751927529275392754927559275692757927589275992760927619276292763927649276592766927679276892769927709277192772927739277492775927769277792778927799278092781927829278392784927859278692787927889278992790927919279292793927949279592796927979279892799928009280192802928039280492805928069280792808928099281092811928129281392814928159281692817928189281992820928219282292823928249282592826928279282892829928309283192832928339283492835928369283792838928399284092841928429284392844928459284692847928489284992850928519285292853928549285592856928579285892859928609286192862928639286492865928669286792868928699287092871928729287392874928759287692877928789287992880928819288292883928849288592886928879288892889928909289192892928939289492895928969289792898928999290092901929029290392904929059290692907929089290992910929119291292913929149291592916929179291892919929209292192922929239292492925929269292792928929299293092931929329293392934929359293692937929389293992940929419294292943929449294592946929479294892949929509295192952929539295492955929569295792958929599296092961929629296392964929659296692967929689296992970929719297292973929749297592976929779297892979929809298192982929839298492985929869298792988929899299092991929929299392994929959299692997929989299993000930019300293003930049300593006930079300893009930109301193012930139301493015930169301793018930199302093021930229302393024930259302693027930289302993030930319303293033930349303593036930379303893039930409304193042930439304493045930469304793048930499305093051930529305393054930559305693057930589305993060930619306293063930649306593066930679306893069930709307193072930739307493075930769307793078930799308093081930829308393084930859308693087930889308993090930919309293093930949309593096930979309893099931009310193102931039310493105931069310793108931099311093111931129311393114931159311693117931189311993120931219312293123931249312593126931279312893129931309313193132931339313493135931369313793138931399314093141931429314393144931459314693147931489314993150931519315293153931549315593156931579315893159931609316193162931639316493165931669316793168931699317093171931729317393174931759317693177931789317993180931819318293183931849318593186931879318893189931909319193192931939319493195931969319793198931999320093201932029320393204932059320693207932089320993210932119321293213932149321593216932179321893219932209322193222932239322493225932269322793228932299323093231932329323393234932359323693237932389323993240932419324293243932449324593246932479324893249932509325193252932539325493255932569325793258932599326093261932629326393264932659326693267932689326993270932719327293273932749327593276932779327893279932809328193282932839328493285932869328793288932899329093291932929329393294932959329693297932989329993300933019330293303933049330593306933079330893309933109331193312933139331493315933169331793318933199332093321933229332393324933259332693327933289332993330933319333293333933349333593336933379333893339933409334193342933439334493345933469334793348933499335093351933529335393354933559335693357933589335993360933619336293363933649336593366933679336893369933709337193372933739337493375933769337793378933799338093381933829338393384933859338693387933889338993390933919339293393933949339593396933979339893399934009340193402934039340493405934069340793408934099341093411934129341393414934159341693417934189341993420934219342293423934249342593426934279342893429934309343193432934339343493435934369343793438934399344093441934429344393444934459344693447934489344993450934519345293453934549345593456934579345893459934609346193462934639346493465934669346793468934699347093471934729347393474934759347693477934789347993480934819348293483934849348593486934879348893489934909349193492934939349493495934969349793498934999350093501935029350393504935059350693507935089350993510935119351293513935149351593516935179351893519935209352193522935239352493525935269352793528935299353093531935329353393534935359353693537935389353993540935419354293543935449354593546935479354893549935509355193552935539355493555935569355793558935599356093561935629356393564935659356693567935689356993570935719357293573935749357593576935779357893579935809358193582935839358493585935869358793588935899359093591935929359393594935959359693597935989359993600936019360293603936049360593606936079360893609936109361193612936139361493615936169361793618936199362093621936229362393624936259362693627936289362993630936319363293633936349363593636936379363893639936409364193642936439364493645936469364793648936499365093651936529365393654936559365693657936589365993660936619366293663936649366593666936679366893669936709367193672936739367493675936769367793678936799368093681936829368393684936859368693687936889368993690936919369293693936949369593696936979369893699937009370193702937039370493705937069370793708937099371093711937129371393714937159371693717937189371993720937219372293723937249372593726937279372893729937309373193732937339373493735937369373793738937399374093741937429374393744937459374693747937489374993750937519375293753937549375593756937579375893759937609376193762937639376493765937669376793768937699377093771937729377393774937759377693777937789377993780937819378293783937849378593786937879378893789937909379193792937939379493795937969379793798937999380093801938029380393804938059380693807938089380993810938119381293813938149381593816938179381893819938209382193822938239382493825938269382793828938299383093831938329383393834938359383693837938389383993840938419384293843938449384593846938479384893849938509385193852938539385493855938569385793858938599386093861938629386393864938659386693867938689386993870938719387293873938749387593876938779387893879938809388193882938839388493885938869388793888938899389093891938929389393894938959389693897938989389993900939019390293903939049390593906939079390893909939109391193912939139391493915939169391793918939199392093921939229392393924939259392693927939289392993930939319393293933939349393593936939379393893939939409394193942939439394493945939469394793948939499395093951939529395393954939559395693957939589395993960939619396293963939649396593966939679396893969939709397193972939739397493975939769397793978939799398093981939829398393984939859398693987939889398993990939919399293993939949399593996939979399893999940009400194002940039400494005940069400794008940099401094011940129401394014940159401694017940189401994020940219402294023940249402594026940279402894029940309403194032940339403494035940369403794038940399404094041940429404394044940459404694047940489404994050940519405294053940549405594056940579405894059940609406194062940639406494065940669406794068940699407094071940729407394074940759407694077940789407994080940819408294083940849408594086940879408894089940909409194092940939409494095940969409794098940999410094101941029410394104941059410694107941089410994110941119411294113941149411594116941179411894119941209412194122941239412494125941269412794128941299413094131941329413394134941359413694137941389413994140941419414294143941449414594146941479414894149941509415194152941539415494155941569415794158941599416094161941629416394164941659416694167941689416994170941719417294173941749417594176941779417894179941809418194182941839418494185941869418794188941899419094191941929419394194941959419694197941989419994200942019420294203942049420594206942079420894209942109421194212942139421494215942169421794218942199422094221942229422394224942259422694227942289422994230942319423294233942349423594236942379423894239942409424194242942439424494245942469424794248942499425094251942529425394254942559425694257942589425994260942619426294263942649426594266942679426894269942709427194272942739427494275942769427794278942799428094281942829428394284942859428694287942889428994290942919429294293942949429594296942979429894299943009430194302943039430494305943069430794308943099431094311943129431394314943159431694317943189431994320943219432294323943249432594326943279432894329943309433194332943339433494335943369433794338943399434094341943429434394344943459434694347943489434994350943519435294353943549435594356943579435894359943609436194362943639436494365943669436794368943699437094371943729437394374943759437694377943789437994380943819438294383943849438594386943879438894389943909439194392943939439494395943969439794398943999440094401944029440394404944059440694407944089440994410944119441294413944149441594416944179441894419944209442194422944239442494425944269442794428944299443094431944329443394434944359443694437944389443994440944419444294443944449444594446944479444894449944509445194452944539445494455944569445794458944599446094461944629446394464944659446694467944689446994470944719447294473944749447594476944779447894479944809448194482944839448494485944869448794488944899449094491944929449394494944959449694497944989449994500945019450294503945049450594506945079450894509945109451194512945139451494515945169451794518945199452094521945229452394524945259452694527945289452994530945319453294533945349453594536945379453894539945409454194542945439454494545945469454794548945499455094551945529455394554945559455694557945589455994560945619456294563945649456594566945679456894569945709457194572945739457494575945769457794578945799458094581945829458394584945859458694587945889458994590945919459294593945949459594596945979459894599946009460194602946039460494605946069460794608946099461094611946129461394614946159461694617946189461994620946219462294623946249462594626946279462894629946309463194632946339463494635946369463794638946399464094641946429464394644946459464694647946489464994650946519465294653946549465594656946579465894659946609466194662946639466494665946669466794668946699467094671946729467394674946759467694677946789467994680946819468294683946849468594686946879468894689946909469194692946939469494695946969469794698946999470094701947029470394704947059470694707947089470994710947119471294713947149471594716947179471894719947209472194722947239472494725947269472794728947299473094731947329473394734947359473694737947389473994740947419474294743947449474594746947479474894749947509475194752947539475494755947569475794758947599476094761947629476394764947659476694767947689476994770947719477294773947749477594776947779477894779947809478194782947839478494785947869478794788947899479094791947929479394794947959479694797947989479994800948019480294803948049480594806948079480894809948109481194812948139481494815948169481794818948199482094821948229482394824948259482694827948289482994830948319483294833948349483594836948379483894839948409484194842948439484494845948469484794848948499485094851948529485394854948559485694857948589485994860948619486294863948649486594866948679486894869948709487194872948739487494875948769487794878948799488094881948829488394884948859488694887948889488994890948919489294893948949489594896948979489894899949009490194902949039490494905949069490794908949099491094911949129491394914949159491694917949189491994920949219492294923949249492594926949279492894929949309493194932949339493494935949369493794938949399494094941949429494394944949459494694947949489494994950949519495294953949549495594956949579495894959949609496194962949639496494965949669496794968949699497094971949729497394974949759497694977949789497994980949819498294983949849498594986949879498894989949909499194992949939499494995949969499794998949999500095001950029500395004950059500695007950089500995010950119501295013950149501595016950179501895019950209502195022950239502495025950269502795028950299503095031950329503395034950359503695037950389503995040950419504295043950449504595046950479504895049950509505195052950539505495055950569505795058950599506095061950629506395064950659506695067950689506995070950719507295073950749507595076950779507895079950809508195082950839508495085950869508795088950899509095091950929509395094950959509695097950989509995100951019510295103951049510595106951079510895109951109511195112951139511495115951169511795118951199512095121951229512395124951259512695127951289512995130951319513295133951349513595136951379513895139951409514195142951439514495145951469514795148951499515095151951529515395154951559515695157951589515995160951619516295163951649516595166951679516895169951709517195172951739517495175951769517795178951799518095181951829518395184951859518695187951889518995190951919519295193951949519595196951979519895199952009520195202952039520495205952069520795208952099521095211952129521395214952159521695217952189521995220952219522295223952249522595226952279522895229952309523195232952339523495235952369523795238952399524095241952429524395244952459524695247952489524995250952519525295253952549525595256952579525895259952609526195262952639526495265952669526795268952699527095271952729527395274952759527695277952789527995280952819528295283952849528595286952879528895289952909529195292952939529495295952969529795298952999530095301953029530395304953059530695307953089530995310953119531295313953149531595316953179531895319953209532195322953239532495325953269532795328953299533095331953329533395334953359533695337953389533995340953419534295343953449534595346953479534895349953509535195352953539535495355953569535795358953599536095361953629536395364953659536695367953689536995370953719537295373953749537595376953779537895379953809538195382953839538495385953869538795388953899539095391953929539395394953959539695397953989539995400954019540295403954049540595406954079540895409954109541195412954139541495415954169541795418954199542095421954229542395424954259542695427954289542995430954319543295433954349543595436954379543895439954409544195442954439544495445954469544795448954499545095451954529545395454954559545695457954589545995460954619546295463954649546595466954679546895469954709547195472954739547495475954769547795478954799548095481954829548395484954859548695487954889548995490954919549295493954949549595496954979549895499955009550195502955039550495505955069550795508955099551095511955129551395514955159551695517955189551995520955219552295523955249552595526955279552895529955309553195532955339553495535955369553795538955399554095541955429554395544955459554695547955489554995550955519555295553955549555595556955579555895559955609556195562955639556495565955669556795568955699557095571955729557395574955759557695577955789557995580955819558295583955849558595586955879558895589955909559195592955939559495595955969559795598955999560095601956029560395604956059560695607956089560995610956119561295613956149561595616956179561895619956209562195622956239562495625956269562795628956299563095631956329563395634956359563695637956389563995640956419564295643956449564595646956479564895649956509565195652956539565495655956569565795658956599566095661956629566395664956659566695667956689566995670956719567295673956749567595676956779567895679956809568195682956839568495685956869568795688956899569095691956929569395694956959569695697956989569995700957019570295703957049570595706957079570895709957109571195712957139571495715957169571795718957199572095721957229572395724957259572695727957289572995730957319573295733957349573595736957379573895739957409574195742957439574495745957469574795748957499575095751957529575395754957559575695757957589575995760957619576295763957649576595766957679576895769957709577195772957739577495775957769577795778957799578095781957829578395784957859578695787957889578995790957919579295793957949579595796957979579895799958009580195802958039580495805958069580795808958099581095811958129581395814958159581695817958189581995820958219582295823958249582595826958279582895829958309583195832958339583495835958369583795838958399584095841958429584395844958459584695847958489584995850958519585295853958549585595856958579585895859958609586195862958639586495865958669586795868958699587095871958729587395874958759587695877958789587995880958819588295883958849588595886958879588895889958909589195892958939589495895958969589795898958999590095901959029590395904959059590695907959089590995910959119591295913959149591595916959179591895919959209592195922959239592495925959269592795928959299593095931959329593395934959359593695937959389593995940959419594295943959449594595946959479594895949959509595195952959539595495955959569595795958959599596095961959629596395964959659596695967959689596995970959719597295973959749597595976959779597895979959809598195982959839598495985959869598795988959899599095991959929599395994959959599695997959989599996000960019600296003960049600596006960079600896009960109601196012960139601496015960169601796018960199602096021960229602396024960259602696027960289602996030960319603296033960349603596036960379603896039960409604196042960439604496045960469604796048960499605096051960529605396054960559605696057960589605996060960619606296063960649606596066960679606896069960709607196072960739607496075960769607796078960799608096081960829608396084960859608696087960889608996090960919609296093960949609596096960979609896099961009610196102961039610496105961069610796108961099611096111961129611396114961159611696117961189611996120961219612296123961249612596126961279612896129961309613196132961339613496135961369613796138961399614096141961429614396144961459614696147961489614996150961519615296153961549615596156961579615896159961609616196162961639616496165961669616796168961699617096171961729617396174961759617696177961789617996180961819618296183961849618596186961879618896189961909619196192961939619496195961969619796198961999620096201962029620396204962059620696207962089620996210962119621296213962149621596216962179621896219962209622196222962239622496225962269622796228962299623096231962329623396234962359623696237962389623996240962419624296243962449624596246962479624896249962509625196252962539625496255962569625796258962599626096261962629626396264962659626696267962689626996270962719627296273962749627596276962779627896279962809628196282962839628496285962869628796288962899629096291962929629396294962959629696297962989629996300963019630296303963049630596306963079630896309963109631196312963139631496315963169631796318963199632096321963229632396324963259632696327963289632996330963319633296333963349633596336963379633896339963409634196342963439634496345963469634796348963499635096351963529635396354963559635696357963589635996360963619636296363963649636596366963679636896369963709637196372963739637496375963769637796378963799638096381963829638396384963859638696387963889638996390963919639296393963949639596396963979639896399964009640196402964039640496405964069640796408964099641096411964129641396414964159641696417964189641996420964219642296423964249642596426964279642896429964309643196432964339643496435964369643796438964399644096441964429644396444964459644696447964489644996450964519645296453964549645596456964579645896459964609646196462964639646496465964669646796468964699647096471964729647396474964759647696477964789647996480964819648296483964849648596486964879648896489964909649196492964939649496495964969649796498964999650096501965029650396504965059650696507965089650996510965119651296513965149651596516965179651896519965209652196522965239652496525965269652796528965299653096531965329653396534965359653696537965389653996540965419654296543965449654596546965479654896549965509655196552965539655496555965569655796558965599656096561965629656396564965659656696567965689656996570965719657296573965749657596576965779657896579965809658196582965839658496585965869658796588965899659096591965929659396594965959659696597965989659996600966019660296603966049660596606966079660896609966109661196612966139661496615966169661796618966199662096621966229662396624966259662696627966289662996630966319663296633966349663596636966379663896639966409664196642966439664496645966469664796648966499665096651966529665396654966559665696657966589665996660966619666296663966649666596666966679666896669966709667196672966739667496675966769667796678966799668096681966829668396684966859668696687966889668996690966919669296693966949669596696966979669896699967009670196702967039670496705967069670796708967099671096711967129671396714967159671696717967189671996720967219672296723967249672596726967279672896729967309673196732967339673496735967369673796738967399674096741967429674396744967459674696747967489674996750967519675296753967549675596756967579675896759967609676196762967639676496765967669676796768967699677096771967729677396774967759677696777967789677996780967819678296783967849678596786967879678896789967909679196792967939679496795967969679796798967999680096801968029680396804968059680696807968089680996810968119681296813968149681596816968179681896819968209682196822968239682496825968269682796828968299683096831968329683396834968359683696837968389683996840968419684296843968449684596846968479684896849968509685196852968539685496855968569685796858968599686096861968629686396864968659686696867968689686996870968719687296873968749687596876968779687896879968809688196882968839688496885968869688796888968899689096891968929689396894968959689696897968989689996900969019690296903969049690596906969079690896909969109691196912969139691496915969169691796918969199692096921969229692396924969259692696927969289692996930969319693296933969349693596936969379693896939969409694196942969439694496945969469694796948969499695096951969529695396954969559695696957969589695996960969619696296963969649696596966969679696896969969709697196972969739697496975969769697796978969799698096981969829698396984969859698696987969889698996990969919699296993969949699596996969979699896999970009700197002970039700497005970069700797008970099701097011970129701397014970159701697017970189701997020970219702297023970249702597026970279702897029970309703197032970339703497035970369703797038970399704097041970429704397044970459704697047970489704997050970519705297053970549705597056970579705897059970609706197062970639706497065970669706797068970699707097071970729707397074970759707697077970789707997080970819708297083970849708597086970879708897089970909709197092970939709497095970969709797098970999710097101971029710397104971059710697107971089710997110971119711297113971149711597116971179711897119971209712197122971239712497125971269712797128971299713097131971329713397134971359713697137971389713997140971419714297143971449714597146971479714897149971509715197152971539715497155971569715797158971599716097161971629716397164971659716697167971689716997170971719717297173971749717597176971779717897179971809718197182971839718497185971869718797188971899719097191971929719397194971959719697197971989719997200972019720297203972049720597206972079720897209972109721197212972139721497215972169721797218972199722097221972229722397224972259722697227972289722997230972319723297233972349723597236972379723897239972409724197242972439724497245972469724797248972499725097251972529725397254972559725697257972589725997260972619726297263972649726597266972679726897269972709727197272972739727497275972769727797278972799728097281972829728397284972859728697287972889728997290972919729297293972949729597296972979729897299973009730197302973039730497305973069730797308973099731097311973129731397314973159731697317973189731997320973219732297323973249732597326973279732897329973309733197332973339733497335973369733797338973399734097341973429734397344973459734697347973489734997350973519735297353973549735597356973579735897359973609736197362973639736497365973669736797368973699737097371973729737397374973759737697377973789737997380973819738297383973849738597386973879738897389973909739197392973939739497395973969739797398973999740097401974029740397404974059740697407974089740997410974119741297413974149741597416974179741897419974209742197422974239742497425974269742797428974299743097431974329743397434974359743697437974389743997440974419744297443974449744597446974479744897449974509745197452974539745497455974569745797458974599746097461974629746397464974659746697467974689746997470974719747297473974749747597476974779747897479974809748197482974839748497485974869748797488974899749097491974929749397494974959749697497974989749997500975019750297503975049750597506975079750897509975109751197512975139751497515975169751797518975199752097521975229752397524975259752697527975289752997530975319753297533975349753597536975379753897539975409754197542975439754497545975469754797548975499755097551975529755397554975559755697557975589755997560975619756297563975649756597566975679756897569975709757197572975739757497575975769757797578975799758097581975829758397584975859758697587975889758997590975919759297593975949759597596975979759897599976009760197602976039760497605976069760797608976099761097611976129761397614976159761697617976189761997620976219762297623976249762597626976279762897629976309763197632976339763497635976369763797638976399764097641976429764397644976459764697647976489764997650976519765297653976549765597656976579765897659976609766197662976639766497665976669766797668976699767097671976729767397674976759767697677976789767997680976819768297683976849768597686976879768897689976909769197692976939769497695976969769797698976999770097701977029770397704977059770697707977089770997710977119771297713977149771597716977179771897719977209772197722977239772497725977269772797728977299773097731977329773397734977359773697737977389773997740977419774297743977449774597746977479774897749977509775197752977539775497755977569775797758977599776097761977629776397764977659776697767977689776997770977719777297773977749777597776977779777897779977809778197782977839778497785977869778797788977899779097791977929779397794977959779697797977989779997800978019780297803978049780597806978079780897809978109781197812978139781497815978169781797818978199782097821978229782397824978259782697827978289782997830978319783297833978349783597836978379783897839978409784197842978439784497845978469784797848978499785097851978529785397854978559785697857978589785997860978619786297863978649786597866978679786897869978709787197872978739787497875978769787797878978799788097881978829788397884978859788697887978889788997890978919789297893978949789597896978979789897899979009790197902979039790497905979069790797908979099791097911979129791397914979159791697917979189791997920979219792297923979249792597926979279792897929979309793197932979339793497935979369793797938979399794097941979429794397944979459794697947979489794997950979519795297953979549795597956979579795897959979609796197962979639796497965979669796797968979699797097971979729797397974979759797697977979789797997980979819798297983979849798597986979879798897989979909799197992979939799497995979969799797998979999800098001980029800398004980059800698007980089800998010980119801298013980149801598016980179801898019980209802198022980239802498025980269802798028980299803098031980329803398034980359803698037980389803998040980419804298043980449804598046980479804898049980509805198052980539805498055980569805798058980599806098061980629806398064980659806698067980689806998070980719807298073980749807598076980779807898079980809808198082980839808498085980869808798088980899809098091980929809398094980959809698097980989809998100981019810298103981049810598106981079810898109981109811198112981139811498115981169811798118981199812098121981229812398124981259812698127981289812998130981319813298133981349813598136981379813898139981409814198142981439814498145981469814798148981499815098151981529815398154981559815698157981589815998160981619816298163981649816598166981679816898169981709817198172981739817498175981769817798178981799818098181981829818398184981859818698187981889818998190981919819298193981949819598196981979819898199982009820198202982039820498205982069820798208982099821098211982129821398214982159821698217982189821998220982219822298223982249822598226982279822898229982309823198232982339823498235982369823798238982399824098241982429824398244982459824698247982489824998250982519825298253982549825598256982579825898259982609826198262982639826498265982669826798268982699827098271982729827398274982759827698277982789827998280982819828298283982849828598286982879828898289982909829198292982939829498295982969829798298982999830098301983029830398304983059830698307983089830998310983119831298313983149831598316983179831898319983209832198322983239832498325983269832798328983299833098331983329833398334983359833698337983389833998340983419834298343983449834598346983479834898349983509835198352983539835498355983569835798358983599836098361983629836398364983659836698367983689836998370983719837298373983749837598376983779837898379983809838198382983839838498385983869838798388983899839098391983929839398394983959839698397983989839998400984019840298403984049840598406984079840898409984109841198412984139841498415984169841798418984199842098421984229842398424984259842698427984289842998430984319843298433984349843598436984379843898439984409844198442984439844498445984469844798448984499845098451984529845398454984559845698457984589845998460984619846298463984649846598466984679846898469984709847198472984739847498475984769847798478984799848098481984829848398484984859848698487984889848998490984919849298493984949849598496984979849898499985009850198502985039850498505985069850798508985099851098511985129851398514985159851698517985189851998520985219852298523985249852598526985279852898529985309853198532985339853498535985369853798538985399854098541985429854398544985459854698547985489854998550985519855298553985549855598556985579855898559985609856198562985639856498565985669856798568985699857098571985729857398574985759857698577985789857998580985819858298583985849858598586985879858898589985909859198592985939859498595985969859798598985999860098601986029860398604986059860698607986089860998610986119861298613986149861598616986179861898619986209862198622986239862498625986269862798628986299863098631986329863398634986359863698637986389863998640986419864298643986449864598646986479864898649986509865198652986539865498655986569865798658986599866098661986629866398664986659866698667986689866998670986719867298673986749867598676986779867898679986809868198682986839868498685986869868798688986899869098691986929869398694986959869698697986989869998700987019870298703987049870598706987079870898709987109871198712987139871498715987169871798718987199872098721987229872398724987259872698727987289872998730987319873298733987349873598736987379873898739987409874198742987439874498745987469874798748987499875098751987529875398754987559875698757987589875998760987619876298763987649876598766987679876898769987709877198772987739877498775987769877798778987799878098781987829878398784987859878698787987889878998790987919879298793987949879598796987979879898799988009880198802988039880498805988069880798808988099881098811988129881398814988159881698817988189881998820988219882298823988249882598826988279882898829988309883198832988339883498835988369883798838988399884098841988429884398844988459884698847988489884998850988519885298853988549885598856988579885898859988609886198862988639886498865988669886798868988699887098871988729887398874988759887698877988789887998880988819888298883988849888598886988879888898889988909889198892988939889498895988969889798898988999890098901989029890398904989059890698907989089890998910989119891298913989149891598916989179891898919989209892198922989239892498925989269892798928989299893098931989329893398934989359893698937989389893998940989419894298943989449894598946989479894898949989509895198952989539895498955989569895798958989599896098961989629896398964989659896698967989689896998970989719897298973989749897598976989779897898979989809898198982989839898498985989869898798988989899899098991989929899398994989959899698997989989899999000990019900299003990049900599006990079900899009990109901199012990139901499015990169901799018990199902099021990229902399024990259902699027990289902999030990319903299033990349903599036990379903899039990409904199042990439904499045990469904799048990499905099051990529905399054990559905699057990589905999060990619906299063990649906599066990679906899069990709907199072990739907499075990769907799078990799908099081990829908399084990859908699087990889908999090990919909299093990949909599096990979909899099991009910199102991039910499105991069910799108991099911099111991129911399114991159911699117991189911999120991219912299123991249912599126991279912899129991309913199132991339913499135991369913799138991399914099141991429914399144991459914699147991489914999150991519915299153991549915599156991579915899159991609916199162991639916499165991669916799168991699917099171991729917399174991759917699177991789917999180991819918299183991849918599186991879918899189991909919199192991939919499195991969919799198991999920099201992029920399204992059920699207992089920999210992119921299213992149921599216992179921899219992209922199222992239922499225992269922799228992299923099231992329923399234992359923699237992389923999240992419924299243992449924599246992479924899249992509925199252992539925499255992569925799258992599926099261992629926399264992659926699267992689926999270992719927299273992749927599276992779927899279992809928199282992839928499285992869928799288992899929099291992929929399294992959929699297992989929999300993019930299303993049930599306993079930899309993109931199312993139931499315993169931799318993199932099321993229932399324993259932699327993289932999330993319933299333993349933599336993379933899339993409934199342993439934499345993469934799348993499935099351993529935399354993559935699357993589935999360993619936299363993649936599366993679936899369993709937199372993739937499375993769937799378993799938099381993829938399384993859938699387993889938999390993919939299393993949939599396993979939899399994009940199402994039940499405994069940799408994099941099411994129941399414994159941699417994189941999420994219942299423994249942599426994279942899429994309943199432994339943499435994369943799438994399944099441994429944399444994459944699447994489944999450994519945299453994549945599456994579945899459994609946199462994639946499465994669946799468994699947099471994729947399474994759947699477994789947999480994819948299483994849948599486994879948899489994909949199492994939949499495994969949799498994999950099501995029950399504995059950699507995089950999510995119951299513995149951599516995179951899519995209952199522995239952499525995269952799528995299953099531995329953399534995359953699537995389953999540995419954299543995449954599546995479954899549995509955199552995539955499555995569955799558995599956099561995629956399564995659956699567995689956999570995719957299573995749957599576995779957899579995809958199582995839958499585995869958799588995899959099591995929959399594995959959699597995989959999600996019960299603996049960599606996079960899609996109961199612996139961499615996169961799618996199962099621996229962399624996259962699627996289962999630996319963299633996349963599636996379963899639996409964199642996439964499645996469964799648996499965099651996529965399654996559965699657996589965999660996619966299663996649966599666996679966899669996709967199672996739967499675996769967799678996799968099681996829968399684996859968699687996889968999690996919969299693996949969599696996979969899699997009970199702997039970499705997069970799708997099971099711997129971399714997159971699717997189971999720997219972299723997249972599726997279972899729997309973199732997339973499735997369973799738997399974099741997429974399744997459974699747997489974999750997519975299753997549975599756997579975899759997609976199762997639976499765997669976799768997699977099771997729977399774997759977699777997789977999780997819978299783997849978599786997879978899789997909979199792997939979499795997969979799798997999980099801998029980399804998059980699807998089980999810998119981299813998149981599816998179981899819998209982199822998239982499825998269982799828998299983099831998329983399834998359983699837998389983999840998419984299843998449984599846998479984899849998509985199852998539985499855998569985799858998599986099861998629986399864998659986699867998689986999870998719987299873998749987599876998779987899879998809988199882998839988499885998869988799888998899989099891998929989399894998959989699897998989989999900999019990299903999049990599906999079990899909999109991199912999139991499915999169991799918999199992099921999229992399924999259992699927999289992999930999319993299933999349993599936999379993899939999409994199942999439994499945999469994799948999499995099951999529995399954999559995699957999589995999960999619996299963999649996599966999679996899969999709997199972999739997499975999769997799978999799998099981999829998399984999859998699987999889998999990999919999299993999949999599996999979999899999100000100001100002100003100004100005100006100007100008100009100010100011100012100013100014100015100016100017100018100019100020100021100022100023100024100025100026100027100028100029100030100031100032100033100034100035100036100037100038100039100040100041100042100043100044100045100046100047100048100049100050100051100052100053100054100055100056100057100058100059100060100061100062100063100064100065100066100067100068100069100070100071100072100073100074100075100076100077100078100079100080100081100082100083100084100085100086100087100088100089100090100091100092100093100094100095100096100097100098100099100100100101100102100103100104100105100106100107100108100109100110100111100112100113100114100115100116100117100118100119100120100121100122100123100124100125100126100127100128100129100130100131100132100133100134100135100136100137100138100139100140100141100142100143100144100145100146100147100148100149100150100151100152100153100154100155100156100157100158100159100160100161100162100163100164100165100166100167100168100169100170100171100172100173100174100175100176100177100178100179100180100181100182100183100184100185100186100187100188100189100190100191100192100193100194100195100196100197100198100199100200100201100202100203100204100205100206100207100208100209100210100211100212100213100214100215100216100217100218100219100220100221100222100223100224100225100226100227100228100229100230100231100232100233100234100235100236100237100238100239100240100241100242100243100244100245100246100247100248100249100250100251100252100253100254100255100256100257100258100259100260100261100262100263100264100265100266100267100268100269100270100271100272100273100274100275100276100277100278100279100280100281100282100283100284100285100286100287100288100289100290100291100292100293100294100295100296100297100298100299100300100301100302100303100304100305100306100307100308100309100310100311100312100313100314100315100316100317100318100319100320100321100322100323100324100325100326100327100328100329100330100331100332100333100334100335100336100337100338100339100340100341100342100343100344100345100346100347100348100349100350100351100352100353100354100355100356100357100358100359100360100361100362100363100364100365100366100367100368100369100370100371100372100373100374100375100376100377100378100379100380100381100382100383100384100385100386100387100388100389100390100391100392100393100394100395100396100397100398100399100400100401100402100403100404100405100406100407100408100409100410100411100412100413100414100415100416100417100418100419100420100421100422100423100424100425100426100427100428100429100430100431100432100433100434100435100436100437100438100439100440100441100442100443100444100445100446100447100448100449100450100451100452100453100454100455100456100457100458100459100460100461100462100463100464100465100466100467100468100469100470100471100472100473100474100475100476100477100478100479100480100481100482100483100484100485100486100487100488100489100490100491100492100493100494100495100496100497100498100499100500100501100502100503100504100505100506100507100508100509100510100511100512100513100514100515100516100517100518100519100520100521100522100523100524100525100526100527100528100529100530100531100532100533100534100535100536100537100538100539100540100541100542100543100544100545100546100547100548100549100550100551100552100553100554100555100556100557100558100559100560100561100562100563100564100565100566100567100568100569100570100571100572100573100574100575100576100577100578100579100580100581100582100583100584100585100586100587100588100589100590100591100592100593100594100595100596100597100598100599100600100601100602100603100604100605100606100607100608100609100610100611100612100613100614100615100616100617100618100619100620100621100622100623100624100625100626100627100628100629100630100631100632100633100634100635100636100637100638100639100640100641100642100643100644100645100646100647100648100649100650100651100652100653100654100655100656100657100658100659100660100661100662100663100664100665100666100667100668100669100670100671100672100673100674100675100676100677100678100679100680100681100682100683100684100685100686100687100688100689100690100691100692100693100694100695100696100697100698100699100700100701100702100703100704100705100706100707100708100709100710100711100712100713100714100715100716100717100718100719100720100721100722100723100724100725100726100727100728100729100730100731100732100733100734100735100736100737100738100739100740100741100742100743100744100745100746100747100748100749100750100751100752100753100754100755100756100757100758100759100760100761100762100763100764100765100766100767100768100769100770100771100772100773100774100775100776100777100778100779100780100781100782100783100784100785100786100787100788100789100790100791100792100793100794100795100796100797100798100799100800100801100802100803100804100805100806100807100808100809100810100811100812100813100814100815100816100817100818100819100820100821100822100823100824100825100826100827100828100829100830100831100832100833100834100835100836100837100838100839100840100841100842100843100844100845100846100847100848100849100850100851100852100853100854100855100856100857100858100859100860100861100862100863100864100865100866100867100868100869100870100871100872100873100874100875100876100877100878100879100880100881100882100883100884100885100886100887100888100889100890100891100892100893100894100895100896100897100898100899100900100901100902100903100904100905100906100907100908100909100910100911100912100913100914100915100916100917100918100919100920100921100922100923100924100925100926100927100928100929100930100931100932100933100934100935100936100937100938100939100940100941100942100943100944100945100946100947100948100949100950100951100952100953100954100955100956100957100958100959100960100961100962100963100964100965100966100967100968100969100970100971100972100973100974100975100976100977100978100979100980100981100982100983100984100985100986100987100988100989100990100991100992100993100994100995100996100997100998100999101000101001101002101003101004101005101006101007101008101009101010101011101012101013101014101015101016101017101018101019101020101021101022101023101024101025101026101027101028101029101030101031101032101033101034101035101036101037101038101039101040101041101042101043101044101045101046101047101048101049101050101051101052101053101054101055101056101057101058101059101060101061101062101063101064101065101066101067101068101069101070101071101072101073101074101075101076101077101078101079101080101081101082101083101084101085101086101087101088101089101090101091101092101093101094101095101096101097101098101099101100101101101102101103101104101105101106101107101108101109101110101111101112101113101114101115101116101117101118101119101120101121101122101123101124101125101126101127101128101129101130101131101132101133101134101135101136101137101138101139101140101141101142101143101144101145101146101147101148101149101150101151101152101153101154101155101156101157101158101159101160101161101162101163101164101165101166101167101168101169101170101171101172101173101174101175101176101177101178101179101180101181101182101183101184101185101186101187101188101189101190101191101192101193101194101195101196101197101198101199101200101201101202101203101204101205101206101207101208101209101210101211101212101213101214101215101216101217101218101219101220101221101222101223101224101225101226101227101228101229101230101231101232101233101234101235101236101237101238101239101240101241101242101243101244101245101246101247101248101249101250101251101252101253101254101255101256101257101258101259101260101261101262101263101264101265101266101267101268101269101270101271101272101273101274101275101276101277101278101279101280101281101282101283101284101285101286101287101288101289101290101291101292101293101294101295101296101297101298101299101300101301101302101303101304101305101306101307101308101309101310101311101312101313101314101315101316101317101318101319101320101321101322101323101324101325101326101327101328101329101330101331101332101333101334101335101336101337101338101339101340101341101342101343101344101345101346101347101348101349101350101351101352101353101354101355101356101357101358101359101360101361101362101363101364101365101366101367101368101369101370101371101372101373101374101375101376101377101378101379101380101381101382101383101384101385101386101387101388101389101390101391101392101393101394101395101396101397101398101399101400101401101402101403101404101405101406101407101408101409101410101411101412101413101414101415101416101417101418101419101420101421101422101423101424101425101426101427101428101429101430101431101432101433101434101435101436101437101438101439101440101441101442101443101444101445101446101447101448101449101450101451101452101453101454101455101456101457101458101459101460101461101462101463101464101465101466101467101468101469101470101471101472101473101474101475101476101477101478101479101480101481101482101483101484101485101486101487101488101489101490101491101492101493101494101495101496101497101498101499101500101501101502101503101504101505101506101507101508101509101510101511101512101513101514101515101516101517101518101519101520101521101522101523101524101525101526101527101528101529101530101531101532101533101534101535101536101537101538101539101540101541101542101543101544101545101546101547101548101549101550101551101552101553101554101555101556101557101558101559101560101561101562101563101564101565101566101567101568101569101570101571101572101573101574101575101576101577101578101579101580101581101582101583101584101585101586101587101588101589101590101591101592101593101594101595101596101597101598101599101600101601101602101603101604101605101606101607101608101609101610101611101612101613101614101615101616101617101618101619101620101621101622101623101624101625101626101627101628101629101630101631101632101633101634101635101636101637101638101639101640101641101642101643101644101645101646101647101648101649101650101651101652101653101654101655101656101657101658101659101660101661101662101663101664101665101666101667101668101669101670101671101672101673101674101675101676101677101678101679101680101681101682101683101684101685101686101687101688101689101690101691101692101693101694101695101696101697101698101699101700101701101702101703101704101705101706101707101708101709101710101711101712101713101714101715101716101717101718101719101720101721101722101723101724101725101726101727101728101729101730101731101732101733101734101735101736101737101738101739101740101741101742101743101744101745101746101747101748101749101750101751101752101753101754101755101756101757101758101759101760101761101762101763101764101765101766101767101768101769101770101771101772101773101774101775101776101777101778101779101780101781101782101783101784101785101786101787101788101789101790101791101792101793101794101795101796101797101798101799101800101801101802101803101804101805101806101807101808101809101810101811101812101813101814101815101816101817101818101819101820101821101822101823101824101825101826101827101828101829101830101831101832101833101834101835101836101837101838101839101840101841101842101843101844101845101846101847101848101849101850101851101852101853101854101855101856101857101858101859101860101861101862101863101864101865101866101867101868101869101870101871101872101873101874101875101876101877101878101879101880101881101882101883101884101885101886101887101888101889101890101891101892101893101894101895101896101897101898101899101900101901101902101903101904101905101906101907101908101909101910101911101912101913101914101915101916101917101918101919101920101921101922101923101924101925101926101927101928101929101930101931101932101933101934101935101936101937101938101939101940101941101942101943101944101945101946101947101948101949101950101951101952101953101954101955101956101957101958101959101960101961101962101963101964101965101966101967101968101969101970101971101972101973101974101975101976101977101978101979101980101981101982101983101984101985101986101987101988101989101990101991101992101993101994101995101996101997101998101999102000102001102002102003102004102005102006102007102008102009102010102011102012102013102014102015102016102017102018102019102020102021102022102023102024102025102026102027102028102029102030102031102032102033102034102035102036102037102038102039102040102041102042102043102044102045102046102047102048102049102050102051102052102053102054102055102056102057102058102059102060102061102062102063102064102065102066102067102068102069102070102071102072102073102074102075102076102077102078102079102080102081102082102083102084102085102086102087102088102089102090102091102092102093102094102095102096102097102098102099102100102101102102102103102104102105102106102107102108102109102110102111102112102113102114102115102116102117102118102119102120102121102122102123102124102125102126102127102128102129102130102131102132102133102134102135102136102137102138102139102140102141102142102143102144102145102146102147102148102149102150102151102152102153102154102155102156102157102158102159102160102161102162102163102164102165102166102167102168102169102170102171102172102173102174102175102176102177102178102179102180102181102182102183102184102185102186102187102188102189102190102191102192102193102194102195102196102197102198102199102200102201102202102203102204102205102206102207102208102209102210102211102212102213102214102215102216102217102218102219102220102221102222102223102224102225102226102227102228102229102230102231102232102233102234102235102236102237102238102239102240102241102242102243102244102245102246102247102248102249102250102251102252102253102254102255102256102257102258102259102260102261102262102263102264102265102266102267102268102269102270102271102272102273102274102275102276102277102278102279102280102281102282102283102284102285102286102287102288102289102290102291102292102293102294102295102296102297102298102299102300102301102302102303102304102305102306102307102308102309102310102311102312102313102314102315102316102317102318102319102320102321102322102323102324102325102326102327102328102329102330102331102332102333102334102335102336102337102338102339102340102341102342102343102344102345102346102347102348102349102350102351102352102353102354102355102356102357102358102359102360102361102362102363102364102365102366102367102368102369102370102371102372102373102374102375102376102377102378102379102380102381102382102383102384102385102386102387102388102389102390102391102392102393102394102395102396102397102398102399102400102401102402102403102404102405102406102407102408102409102410102411102412102413102414102415102416102417102418102419102420102421102422102423102424102425102426102427102428102429102430102431102432102433102434102435102436102437102438102439102440102441102442102443102444102445102446102447102448102449102450102451102452102453102454102455102456102457102458102459102460102461102462102463102464102465102466102467102468102469102470102471102472102473102474102475102476102477102478102479102480102481102482102483102484102485102486102487102488102489102490102491102492102493102494102495102496102497102498102499102500102501102502102503102504102505102506102507102508102509102510102511102512102513102514102515102516102517102518102519102520102521102522102523102524102525102526102527102528102529102530102531102532102533102534102535102536102537102538102539102540102541102542102543102544102545102546102547102548102549102550102551102552102553102554102555102556102557102558102559102560102561102562102563102564102565102566102567102568102569102570102571102572102573102574102575102576102577102578102579102580102581102582102583102584102585102586102587102588102589102590102591102592102593102594102595102596102597102598102599102600102601102602102603102604102605102606102607102608102609102610102611102612102613102614102615102616102617102618102619102620102621102622102623102624102625102626102627102628102629102630102631102632102633102634102635102636102637102638102639102640102641102642102643102644102645102646102647102648102649102650102651102652102653102654102655102656102657102658102659102660102661102662102663102664102665102666102667102668102669102670102671102672102673102674102675102676102677102678102679102680102681102682102683102684102685102686102687102688102689102690102691102692102693102694102695102696102697102698102699102700102701102702102703102704102705102706102707102708102709102710102711102712102713102714102715102716102717102718102719102720102721102722102723102724102725102726102727102728102729102730102731102732102733102734102735102736102737102738102739102740102741102742102743102744102745102746102747102748102749102750102751102752102753102754102755102756102757102758102759102760102761102762102763102764102765102766102767102768102769102770102771102772102773102774102775102776102777102778102779102780102781102782102783102784102785102786102787102788102789102790102791102792102793102794102795102796102797102798102799102800102801102802102803102804102805102806102807102808102809102810102811102812102813102814102815102816102817102818102819102820102821102822102823102824102825102826102827102828102829102830102831102832102833102834102835102836102837102838102839102840102841102842102843102844102845102846102847102848102849102850102851102852102853102854102855102856102857102858102859102860102861102862102863102864102865102866102867102868102869102870102871102872102873102874102875102876102877102878102879102880102881102882102883102884102885102886102887102888102889102890102891102892102893102894102895102896102897102898102899102900102901102902102903102904102905102906102907102908102909102910102911102912102913102914102915102916102917102918102919102920102921102922102923102924102925102926102927102928102929102930102931102932102933102934102935102936102937102938102939102940102941102942102943102944102945102946102947102948102949102950102951102952102953102954102955102956102957102958102959102960102961102962102963102964102965102966102967102968102969102970102971102972102973102974102975102976102977102978102979102980102981102982102983102984102985102986102987102988102989102990102991102992102993102994102995102996102997102998102999103000103001103002103003103004103005103006103007103008103009103010103011103012103013103014103015103016103017103018103019103020103021103022103023103024103025103026103027103028103029103030103031103032103033103034103035103036103037103038103039103040103041103042103043103044103045103046103047103048103049103050103051103052103053103054103055103056103057103058103059103060103061103062103063103064103065103066103067103068103069103070103071103072103073103074103075103076103077103078103079103080103081103082103083103084103085103086103087103088103089103090103091103092103093103094103095103096103097103098103099103100103101103102103103103104103105103106103107103108103109103110103111103112103113103114103115103116103117103118103119103120103121103122103123103124103125103126103127103128103129103130103131103132103133103134103135103136103137103138103139103140103141103142103143103144103145103146103147103148103149103150103151103152103153103154103155103156103157103158103159103160103161103162103163103164103165103166103167103168103169103170103171103172103173103174103175103176103177103178103179103180103181103182103183103184103185103186103187103188103189103190103191103192103193103194103195103196103197103198103199103200103201103202103203103204103205103206103207103208103209103210103211103212103213103214103215103216103217103218103219103220103221103222103223103224103225103226103227103228103229103230103231103232103233103234103235103236103237103238103239103240103241103242103243103244103245103246103247103248103249103250103251103252103253103254103255103256103257103258103259103260103261103262103263103264103265103266103267103268103269103270103271103272103273103274103275103276103277103278103279103280103281103282103283103284103285103286103287103288103289103290103291103292103293103294103295103296103297103298103299103300103301103302103303103304103305103306103307103308103309103310103311103312103313103314103315103316103317103318103319103320103321103322103323103324103325103326103327103328103329103330103331103332103333103334103335103336103337103338103339103340103341103342103343103344103345103346103347103348103349103350103351103352103353103354103355103356103357103358103359103360103361103362103363103364103365103366103367103368103369103370103371103372103373103374103375103376103377103378103379103380103381103382103383103384103385103386103387103388103389103390103391103392103393103394103395103396103397103398103399103400103401103402103403103404103405103406103407103408103409103410103411103412103413103414103415103416103417103418103419103420103421103422103423103424103425103426103427103428103429103430103431103432103433103434103435103436103437103438103439103440103441103442103443103444103445103446103447103448103449103450103451103452103453103454103455103456103457103458103459103460103461103462103463103464103465103466103467103468103469103470103471103472103473103474103475103476103477103478103479103480103481103482103483103484103485103486103487103488103489103490103491103492103493103494103495103496103497103498103499103500103501103502103503103504103505103506103507103508103509103510103511103512103513103514103515103516103517103518103519103520103521103522103523103524103525103526103527103528103529103530103531103532103533103534103535103536103537103538103539103540103541103542103543103544103545103546103547103548103549103550103551103552103553103554103555103556103557103558103559103560103561103562103563103564103565103566103567103568103569103570103571103572103573103574103575103576103577103578103579103580103581103582103583103584103585103586103587103588103589103590103591103592103593103594103595103596103597103598103599103600103601103602103603103604103605103606103607103608103609103610103611103612103613103614103615103616103617103618103619103620103621103622103623103624103625103626103627103628103629103630103631103632103633103634103635103636103637103638103639103640103641103642103643103644103645103646103647103648103649103650103651103652103653103654103655103656103657103658103659103660103661103662103663103664103665103666103667103668103669103670103671103672103673103674103675103676103677103678103679103680103681103682103683103684103685103686103687103688103689103690103691103692103693103694103695103696103697103698103699103700103701103702103703103704103705103706103707103708103709103710103711103712103713103714103715103716103717103718103719103720103721103722103723103724103725103726103727103728103729103730103731103732103733103734103735103736103737103738103739103740103741103742103743103744103745103746103747103748103749103750103751103752103753103754103755103756103757103758103759103760103761103762103763103764103765103766103767103768103769103770103771103772103773103774103775103776103777103778103779103780103781103782103783103784103785103786103787103788103789103790103791103792103793103794103795103796103797103798103799103800103801103802103803103804103805103806103807103808103809103810103811103812103813103814103815103816103817103818103819103820103821103822103823103824103825103826103827103828103829103830103831103832103833103834103835103836103837103838103839103840103841103842103843103844103845103846103847103848103849103850103851103852103853103854103855103856103857103858103859103860103861103862103863103864103865103866103867103868103869103870103871103872103873103874103875103876103877103878103879103880103881103882103883103884103885103886103887103888103889103890103891103892103893103894103895103896103897103898103899103900103901103902103903103904103905103906103907103908103909103910103911103912103913103914103915103916103917103918103919103920103921103922103923103924103925103926103927103928103929103930103931103932103933103934103935103936103937103938103939103940103941103942103943103944103945103946103947103948103949103950103951103952103953103954103955103956103957103958103959103960103961103962103963103964103965103966103967103968103969103970103971103972103973103974103975103976103977103978103979103980103981103982103983103984103985103986103987103988103989103990103991103992103993103994103995103996103997103998103999104000104001104002104003104004104005104006104007104008104009104010104011104012104013104014104015104016104017104018104019104020104021104022104023104024104025104026104027104028104029104030104031104032104033104034104035104036104037104038104039104040104041104042104043104044104045104046104047104048104049104050104051104052104053104054104055104056104057104058104059104060104061104062104063104064104065104066104067104068104069104070104071104072104073104074104075104076104077104078104079104080104081104082104083104084104085104086104087104088104089104090104091104092104093104094104095104096104097104098104099104100104101104102104103104104104105104106104107104108104109104110104111104112104113104114104115104116104117104118104119104120104121104122104123104124104125104126104127104128104129104130104131104132104133104134104135104136104137104138104139104140104141104142104143104144104145104146104147104148104149104150104151104152104153104154104155104156104157104158104159104160104161104162104163104164104165104166104167104168104169104170104171104172104173104174104175104176104177104178104179104180104181104182104183104184104185104186104187104188104189104190104191104192104193104194104195104196104197104198104199104200104201104202104203104204104205104206104207104208104209104210104211104212104213104214104215104216104217104218104219104220104221104222104223104224104225104226104227104228104229104230104231104232104233104234104235104236104237104238104239104240104241104242104243104244104245104246104247104248104249104250104251104252104253104254104255104256104257104258104259104260104261104262104263104264104265104266104267104268104269104270104271104272104273104274104275104276104277104278104279104280104281104282104283104284104285104286104287104288104289104290104291104292104293104294104295104296104297104298104299104300104301104302104303104304104305104306104307104308104309104310104311104312104313104314104315104316104317104318104319104320104321104322104323104324104325104326104327104328104329104330104331104332104333104334104335104336104337104338104339104340104341104342104343104344104345104346104347104348104349104350104351104352104353104354104355104356104357104358104359104360104361104362104363104364104365104366104367104368104369104370104371104372104373104374104375104376104377104378104379104380104381104382104383104384104385104386104387104388104389104390104391104392104393104394104395104396104397104398104399104400104401104402104403104404104405104406104407104408104409104410104411104412104413104414104415104416104417104418104419104420104421104422104423104424104425104426104427104428104429104430104431104432104433104434104435104436104437104438104439104440104441104442104443104444104445104446104447104448104449104450104451104452104453104454104455104456104457104458104459104460104461104462104463104464104465104466104467104468104469104470104471104472104473104474104475104476104477104478104479104480104481104482104483104484104485104486104487104488104489104490104491104492104493104494104495104496104497104498104499104500104501104502104503104504104505104506104507104508104509104510104511104512104513104514104515104516104517104518104519104520104521104522104523104524104525104526104527104528104529104530104531104532104533104534104535104536104537104538104539104540104541104542104543104544104545104546104547104548104549104550104551104552104553104554104555104556104557104558104559104560104561104562104563104564104565104566104567104568104569104570104571104572104573104574104575104576104577104578104579104580104581104582104583104584104585104586104587104588104589104590104591104592104593104594104595104596104597104598104599104600104601104602104603104604104605104606104607104608104609104610104611104612104613104614104615104616104617104618104619104620104621104622104623104624104625104626104627104628104629104630104631104632104633104634104635104636104637104638104639104640104641104642104643104644104645104646104647104648104649104650104651104652104653104654104655104656104657104658104659104660104661104662104663104664104665104666104667104668104669104670104671104672104673104674104675104676104677104678104679104680104681104682104683104684104685104686104687104688104689104690104691104692104693104694104695104696104697104698104699104700104701104702104703104704104705104706104707104708104709104710104711104712104713104714104715104716104717104718104719104720104721104722104723104724104725104726104727104728104729104730104731104732104733104734104735104736104737104738104739104740104741104742104743104744104745104746104747104748104749104750104751104752104753104754104755104756104757104758104759104760104761104762104763104764104765104766104767104768104769104770104771104772104773104774104775104776104777104778104779104780104781104782104783104784104785104786104787104788104789104790104791104792104793104794104795104796104797104798104799104800104801104802104803104804104805104806104807104808104809104810104811104812104813104814104815104816104817104818104819104820104821104822104823104824104825104826104827104828104829104830104831104832104833104834104835104836104837104838104839104840104841104842104843104844104845104846104847104848104849104850104851104852104853104854104855104856104857104858104859104860104861104862104863104864104865104866104867104868104869104870104871104872104873104874104875104876104877104878104879104880104881104882104883104884104885104886104887104888104889104890104891104892104893104894104895104896104897104898104899104900104901104902104903104904104905104906104907104908104909104910104911104912104913104914104915104916104917104918104919104920104921104922104923104924104925104926104927104928104929104930104931104932104933104934104935104936104937104938104939104940104941104942104943104944104945104946104947104948104949104950104951104952104953104954104955104956104957104958104959104960104961104962104963104964104965104966104967104968104969104970104971104972104973104974104975104976104977104978104979104980104981104982104983104984104985104986104987104988104989104990104991104992104993104994104995104996104997104998104999105000105001105002105003105004105005105006105007105008105009105010105011105012105013105014105015105016105017105018105019105020105021105022105023105024105025105026105027105028105029105030105031105032105033105034105035105036105037105038105039105040105041105042105043105044105045105046105047105048105049105050105051105052105053105054105055105056105057105058105059105060105061105062105063105064105065105066105067105068105069105070105071105072105073105074105075105076105077105078105079105080105081105082105083105084105085105086105087105088105089105090105091105092105093105094105095105096105097105098105099105100105101105102105103105104105105105106105107105108105109105110105111105112105113105114105115105116105117105118105119105120105121105122105123105124105125105126105127105128105129105130105131105132105133105134105135105136105137105138105139105140105141105142105143105144105145105146105147105148105149105150105151105152105153105154105155105156105157105158105159105160105161105162105163105164105165105166105167105168105169105170105171105172105173105174105175105176105177105178105179105180105181105182105183105184105185105186105187105188105189105190105191105192105193105194105195105196105197105198105199105200105201105202105203105204105205105206105207105208105209105210105211105212105213105214105215105216105217105218105219105220105221105222105223105224105225105226105227105228105229105230105231105232105233105234105235105236105237105238105239105240105241105242105243105244105245105246105247105248105249105250105251105252105253105254105255105256105257105258105259105260105261105262105263105264105265105266105267105268105269105270105271105272105273105274105275105276105277105278105279105280105281105282105283105284105285105286105287105288105289105290105291105292105293105294105295105296105297105298105299105300105301105302105303105304105305105306105307105308105309105310105311105312105313105314105315105316105317105318105319105320105321105322105323105324105325105326105327105328105329105330105331105332105333105334105335105336105337105338105339105340105341105342105343105344105345105346105347105348105349105350105351105352105353105354105355105356105357105358105359105360105361105362105363105364105365105366105367105368105369105370105371105372105373105374105375105376105377105378105379105380105381105382105383105384105385105386105387105388105389105390105391105392105393105394105395105396105397105398105399105400105401105402105403105404105405105406105407105408105409105410105411105412105413105414105415105416105417105418105419105420105421105422105423105424105425105426105427105428105429105430105431105432105433105434105435105436105437105438105439105440105441105442105443105444105445105446105447105448105449105450105451105452105453105454105455105456105457105458105459105460105461105462105463105464105465105466105467105468105469105470105471105472105473105474105475105476105477105478105479105480105481105482105483105484105485105486105487105488105489105490105491105492105493105494105495105496105497105498105499105500105501105502105503105504105505105506105507105508105509105510105511105512105513105514105515105516105517105518105519105520105521105522105523105524105525105526105527105528105529105530105531105532105533105534105535105536105537105538105539105540105541105542105543105544105545105546105547105548105549105550105551105552105553105554105555105556105557105558105559105560105561105562105563105564105565105566105567105568105569105570105571105572105573105574105575105576105577105578105579105580105581105582105583105584105585105586105587105588105589105590105591105592105593105594105595105596105597105598105599105600105601105602105603105604105605105606105607105608105609105610105611105612105613105614105615105616105617105618105619105620105621105622105623105624105625105626105627105628105629105630105631105632105633105634105635105636105637105638105639105640105641105642105643105644105645105646105647105648105649105650105651105652105653105654105655105656105657105658105659105660105661105662105663105664105665105666105667105668105669105670105671105672105673105674105675105676105677105678105679105680105681105682105683105684105685105686105687105688105689105690105691105692105693105694105695105696105697105698105699105700105701105702105703105704105705105706105707105708105709105710105711105712105713105714105715105716105717105718105719105720105721105722105723105724105725105726105727105728105729105730105731105732105733105734105735105736105737105738105739105740105741105742105743105744105745105746105747105748105749105750105751105752105753105754105755105756105757105758105759105760105761105762105763105764105765105766105767105768105769105770105771105772105773105774105775105776105777105778105779105780105781105782105783105784105785105786105787105788105789105790105791105792105793105794105795105796105797105798105799105800105801105802105803105804105805105806105807105808105809105810105811105812105813105814105815105816105817105818105819105820105821105822105823105824105825105826105827105828105829105830105831105832105833105834105835105836105837105838105839105840105841105842105843105844105845105846105847105848105849105850105851105852105853105854105855105856105857105858105859105860105861105862105863105864105865105866105867105868105869105870105871105872105873105874105875105876105877105878105879105880105881105882105883105884105885105886105887105888105889105890105891105892105893105894105895105896105897105898105899105900105901105902105903105904105905105906105907105908105909105910105911105912105913105914105915105916105917105918105919105920105921105922105923105924105925105926105927105928105929105930105931105932105933105934105935105936105937105938105939105940105941105942105943105944105945105946105947105948105949105950105951105952105953105954105955105956105957105958105959105960105961105962105963105964105965105966105967105968105969105970105971105972105973105974105975105976105977105978105979105980105981105982105983105984105985105986105987105988105989105990105991105992105993105994105995105996105997105998105999106000106001106002106003106004106005106006106007106008106009106010106011106012106013106014106015106016106017106018106019106020106021106022106023106024106025106026106027106028106029106030106031106032106033106034106035106036106037106038106039106040106041106042106043106044106045106046106047106048106049106050106051106052106053106054106055106056106057106058106059106060106061106062106063106064106065106066106067106068106069106070106071106072106073106074106075106076106077106078106079106080106081106082106083106084106085106086106087106088106089106090106091106092106093106094106095106096106097106098106099106100106101106102106103106104106105106106106107106108106109106110106111106112106113106114106115106116106117106118106119106120106121106122106123106124106125106126106127106128106129106130106131106132106133106134106135106136106137106138106139106140106141106142106143106144106145106146106147106148106149106150106151106152106153106154106155106156106157106158106159106160106161106162106163106164106165106166106167106168106169106170106171106172106173106174106175106176106177106178106179106180106181106182106183106184106185106186106187106188106189106190106191106192106193106194106195106196106197106198106199106200106201106202106203106204106205106206106207106208106209106210106211106212106213106214106215106216106217106218106219106220106221106222106223106224106225106226106227106228106229106230106231106232106233106234106235106236106237106238106239106240106241106242106243106244106245106246106247106248106249106250106251106252106253106254106255106256106257106258106259106260106261106262106263106264106265106266106267106268106269106270106271106272106273106274106275106276106277106278106279106280106281106282106283106284106285106286106287106288106289106290106291106292106293106294106295106296106297106298106299106300106301106302106303106304106305106306106307106308106309106310106311106312106313106314106315106316106317106318106319106320106321106322106323106324106325106326106327106328106329106330106331106332106333106334106335106336106337106338106339106340106341106342106343106344106345106346106347106348106349106350106351106352106353106354106355106356106357106358106359106360106361106362106363106364106365106366106367106368106369106370106371106372106373106374106375106376106377106378106379106380106381106382106383106384106385106386106387106388106389106390106391106392106393106394106395106396106397106398106399106400106401106402106403106404106405106406106407106408106409106410106411106412106413106414106415106416106417106418106419106420106421106422106423106424106425106426106427106428106429106430106431106432106433106434106435106436106437106438106439106440106441106442106443106444106445106446106447106448106449106450106451106452106453106454106455106456106457106458106459106460106461106462106463106464106465106466106467106468106469106470106471106472106473106474106475106476106477106478106479106480106481106482106483106484106485106486106487106488106489106490106491106492106493106494106495106496106497106498106499106500106501106502106503106504106505106506106507106508106509106510106511106512106513106514106515106516106517106518106519106520106521106522106523106524106525106526106527106528106529106530106531106532106533106534106535106536106537106538106539106540106541106542106543106544106545106546106547106548106549106550106551106552106553106554106555106556106557106558106559106560106561106562106563106564106565106566106567106568106569106570106571106572106573106574106575106576106577106578106579106580106581106582106583106584106585106586106587106588106589106590106591106592106593106594106595106596106597106598106599106600106601106602106603106604106605106606106607106608106609106610106611106612106613106614106615106616106617106618106619106620106621106622106623106624106625106626106627106628106629106630106631106632106633106634106635106636106637106638106639106640106641106642106643106644106645106646106647106648106649106650106651106652106653106654106655106656106657106658106659106660106661106662106663106664106665106666106667106668106669106670106671106672106673106674106675106676106677106678106679106680106681106682106683106684106685106686106687106688106689106690106691106692106693106694106695106696106697106698106699106700106701106702106703106704106705106706106707106708106709106710106711106712106713106714106715106716106717106718106719106720106721106722106723106724106725106726106727106728106729106730106731106732106733106734106735106736106737106738106739106740106741106742106743106744106745106746106747106748106749106750106751106752106753106754106755106756106757106758106759106760106761106762106763106764106765106766106767106768106769106770106771106772106773106774106775106776106777106778106779106780106781106782106783106784106785106786106787106788106789106790106791106792106793106794106795106796106797106798106799106800106801106802106803106804106805106806106807106808106809106810106811106812106813106814106815106816106817106818106819106820106821106822106823106824106825106826106827106828106829106830106831106832106833106834106835106836106837106838106839106840106841106842106843106844106845106846106847106848106849106850106851106852106853106854106855106856106857106858106859106860106861106862106863106864106865106866106867106868106869106870106871106872106873106874106875106876106877106878106879106880106881106882106883106884106885106886106887106888106889106890106891106892106893106894106895106896106897106898106899106900106901106902106903106904106905106906106907106908106909106910106911106912106913106914106915106916106917106918106919106920106921106922106923106924106925106926106927106928106929106930106931106932106933106934106935106936106937106938106939106940106941106942106943106944106945106946106947106948106949106950106951106952106953106954106955106956106957106958106959106960106961106962106963106964106965106966106967106968106969106970106971106972106973106974106975106976106977106978106979106980106981106982106983106984106985106986106987106988106989106990106991106992106993106994106995106996106997106998106999107000107001107002107003107004107005107006107007107008107009107010107011107012107013107014107015107016107017107018107019107020107021107022107023107024107025107026107027107028107029107030107031107032107033107034107035107036107037107038107039107040107041107042107043107044107045107046107047107048107049107050107051107052107053107054107055107056107057107058107059107060107061107062107063107064107065107066107067107068107069107070107071107072107073107074107075107076107077107078107079107080107081107082107083107084107085107086107087107088107089107090107091107092107093107094107095107096107097107098107099107100107101107102107103107104107105107106107107107108107109107110107111107112107113107114107115107116107117107118107119107120107121107122107123107124107125107126107127107128107129107130107131107132107133107134107135107136107137107138107139107140107141107142107143107144107145107146107147107148107149107150107151107152107153107154107155107156107157107158107159107160107161107162107163107164107165107166107167107168107169107170107171107172107173107174107175107176107177107178107179107180107181107182107183107184107185107186107187107188107189107190107191107192107193107194107195107196107197107198107199107200107201107202107203107204107205107206107207107208107209107210107211107212107213107214107215107216107217107218107219107220107221107222107223107224107225107226107227107228107229107230107231107232107233107234107235107236107237107238107239107240107241107242107243107244107245107246107247107248107249107250107251107252107253107254107255107256107257107258107259107260107261107262107263107264107265107266107267107268107269107270107271107272107273107274107275107276107277107278107279107280107281107282107283107284107285107286107287107288107289107290107291107292107293107294107295107296107297107298107299107300107301107302107303107304107305107306107307107308107309107310107311107312107313107314107315107316107317107318107319107320107321107322107323107324107325107326107327107328107329107330107331107332107333107334107335107336107337107338107339107340107341107342107343107344107345107346107347107348107349107350107351107352107353107354107355107356107357107358107359107360107361107362107363107364107365107366107367107368107369107370107371107372107373107374107375107376107377107378107379107380107381107382107383107384107385107386107387107388107389107390107391107392107393107394107395107396107397107398107399107400107401107402107403107404107405107406107407107408107409107410107411107412107413107414107415107416107417107418107419107420107421107422107423107424107425107426107427107428107429107430107431107432107433107434107435107436107437107438107439107440107441107442107443107444107445107446107447107448107449107450107451107452107453107454107455107456107457107458107459107460107461107462107463107464107465107466107467107468107469107470107471107472107473107474107475107476107477107478107479107480107481107482107483107484107485107486107487107488107489107490107491107492107493107494107495107496107497107498107499107500107501107502107503107504107505107506107507107508107509107510107511107512107513107514107515107516107517107518107519107520107521107522107523107524107525107526107527107528107529107530107531107532107533107534107535107536107537107538107539107540107541107542107543107544107545107546107547107548107549107550107551107552107553107554107555107556107557107558107559107560107561107562107563107564107565107566107567107568107569107570107571107572107573107574107575107576107577107578107579107580107581107582107583107584107585107586107587107588107589107590107591107592107593107594107595107596107597107598107599107600107601107602107603107604107605107606107607107608107609107610107611107612107613107614107615107616107617107618107619107620107621107622107623107624107625107626107627107628107629107630107631107632107633107634107635107636107637107638107639107640107641107642107643107644107645107646107647107648107649107650107651107652107653107654107655107656107657107658107659107660107661107662107663107664107665107666107667107668107669107670107671107672107673107674107675107676107677107678107679107680107681107682107683107684107685107686107687107688107689107690107691107692107693107694107695107696107697107698107699107700107701107702107703107704107705107706107707107708107709107710107711107712107713107714107715107716107717107718107719107720107721107722107723107724107725107726107727107728107729107730107731107732107733107734107735107736107737107738107739107740107741107742107743107744107745107746107747107748107749107750107751107752107753107754107755107756107757107758107759107760107761107762107763107764107765107766107767107768107769107770107771107772107773107774107775107776107777107778107779107780107781107782107783107784107785107786107787107788107789107790107791107792107793107794107795107796107797107798107799107800107801107802107803107804107805107806107807107808107809107810107811107812107813107814107815107816107817107818107819107820107821107822107823107824107825107826107827107828107829107830107831107832107833107834107835107836107837107838107839107840107841107842107843107844107845107846107847107848107849107850107851107852107853107854107855107856107857107858107859107860107861107862107863107864107865107866107867107868107869107870107871107872107873107874107875107876107877107878107879107880107881107882107883107884107885107886107887107888107889107890107891107892107893107894107895107896107897107898107899107900107901107902107903107904107905107906107907107908107909107910107911107912107913107914107915107916107917107918107919107920107921107922107923107924107925107926107927107928107929107930107931107932107933107934107935107936107937107938107939107940107941107942107943107944107945107946107947107948107949107950107951107952107953107954107955107956107957107958107959107960107961107962107963107964107965107966107967107968107969107970107971107972107973107974107975107976107977107978107979107980107981107982107983107984107985107986107987107988107989107990107991107992107993107994107995107996107997107998107999108000108001108002108003108004108005108006108007108008108009108010108011108012108013108014108015108016108017108018108019108020108021108022108023108024108025108026108027108028108029108030108031108032108033108034108035108036108037108038108039108040108041108042108043108044108045108046108047108048108049108050108051108052108053108054108055108056108057108058108059108060108061108062108063108064108065108066108067108068108069108070108071108072108073108074108075108076108077108078108079108080108081108082108083108084108085108086108087108088108089108090108091108092108093108094108095108096108097108098108099108100108101108102108103108104108105108106108107108108108109108110108111108112108113108114108115108116108117108118108119108120108121108122108123108124108125108126108127108128108129108130108131108132108133108134108135108136108137108138108139108140108141108142108143108144108145108146108147108148108149108150108151108152108153108154108155108156108157108158108159108160108161108162108163108164108165108166108167108168108169108170108171108172108173108174108175108176108177108178108179108180108181108182108183108184108185108186108187108188108189108190108191108192108193108194108195108196108197108198108199108200108201108202108203108204108205108206108207108208108209108210108211108212108213108214108215108216108217108218108219108220108221108222108223108224108225108226108227108228108229108230108231108232108233108234108235108236108237108238108239108240108241108242108243108244108245108246108247108248108249108250108251108252108253108254108255108256108257108258108259108260108261108262108263108264108265108266108267108268108269108270108271108272108273108274108275108276108277108278108279108280108281108282108283108284108285108286108287108288108289108290108291108292108293108294108295108296108297108298108299108300108301108302108303108304108305108306108307108308108309108310108311108312108313108314108315108316108317108318108319108320108321108322108323108324108325108326108327108328108329108330108331108332108333108334108335108336108337108338108339108340108341108342108343108344108345108346108347108348108349108350108351108352108353108354108355108356108357108358108359108360108361108362108363108364108365108366108367108368108369108370108371108372108373108374108375108376108377108378108379108380108381108382108383108384108385108386108387108388108389108390108391108392108393108394108395108396108397108398108399108400108401108402108403108404108405108406108407108408108409108410108411108412108413108414108415108416108417108418108419108420108421108422108423108424108425108426108427108428108429108430108431108432108433108434108435108436108437108438108439108440108441108442108443108444108445108446108447108448108449108450108451108452108453108454108455108456108457108458108459108460108461108462108463108464108465108466108467108468108469108470108471108472108473108474108475108476108477108478108479108480108481108482108483108484108485108486108487108488108489108490108491108492108493108494108495108496108497108498108499108500108501108502108503108504108505108506108507108508108509108510108511108512108513108514108515108516108517108518108519108520108521108522108523108524108525108526108527108528108529108530108531108532108533108534108535108536108537108538108539108540108541108542108543108544108545108546108547108548108549108550108551108552108553108554108555108556108557108558108559108560108561108562108563108564108565108566108567108568108569108570108571108572108573108574108575108576108577108578108579108580108581108582108583108584108585108586108587108588108589108590108591108592108593108594108595108596108597108598108599108600108601108602108603108604108605108606108607108608108609108610108611108612108613108614108615108616108617108618108619108620108621108622108623108624108625108626108627108628108629108630108631108632108633108634108635108636108637108638108639108640108641108642108643108644108645108646108647108648108649108650108651108652108653108654108655108656108657108658108659108660108661108662108663108664108665108666108667108668108669108670108671108672108673108674108675108676108677108678108679108680108681108682108683108684108685108686108687108688108689108690108691108692108693108694108695108696108697108698108699108700108701108702108703108704108705108706108707108708108709108710108711108712108713108714108715108716108717108718108719108720108721108722108723108724108725108726108727108728108729108730108731108732108733108734108735108736108737108738108739108740108741108742108743108744108745108746108747108748108749108750108751108752108753108754108755108756108757108758108759108760108761108762108763108764108765108766108767108768108769108770108771108772108773108774108775108776108777108778108779108780108781108782108783108784108785108786108787108788108789108790108791108792108793108794108795108796108797108798108799108800108801108802108803108804108805108806108807108808108809108810108811108812108813108814108815108816108817108818108819108820108821108822108823108824108825108826108827108828108829108830108831108832108833108834108835108836108837108838108839108840108841108842108843108844108845108846108847108848108849108850108851108852108853108854108855108856108857108858108859108860108861108862108863108864108865108866108867108868108869108870108871108872108873108874108875108876108877108878108879108880108881108882108883108884108885108886108887108888108889108890108891108892108893108894108895108896108897108898108899108900108901108902108903108904108905108906108907108908108909108910108911108912108913108914108915108916108917108918108919108920108921108922108923108924108925108926108927108928108929108930108931108932108933108934108935108936108937108938108939108940108941108942108943108944108945108946108947108948108949108950108951108952108953108954108955108956108957108958108959108960108961108962108963108964108965108966108967108968108969108970108971108972108973108974108975108976108977108978108979108980108981108982108983108984108985108986108987108988108989108990108991108992108993108994108995108996108997108998108999109000109001109002109003109004109005109006109007109008109009109010109011109012109013109014109015109016109017109018109019109020109021109022109023109024109025109026109027109028109029109030109031109032109033109034109035109036109037109038109039109040109041109042109043109044109045109046109047109048109049109050109051109052109053109054109055109056109057109058109059109060109061109062109063109064109065109066109067109068109069109070109071109072109073109074109075109076109077109078109079109080109081109082109083109084109085109086109087109088109089109090109091109092109093109094109095109096109097109098109099109100109101109102109103109104109105109106109107109108109109109110109111109112109113109114109115109116109117109118109119109120109121109122109123109124109125109126109127109128109129109130109131109132109133109134109135109136109137109138109139109140109141109142109143109144109145109146109147109148109149109150109151109152109153109154109155109156109157109158109159109160109161109162109163109164109165109166109167109168109169109170109171109172109173109174109175109176109177109178109179109180109181109182109183109184109185109186109187109188109189109190109191109192109193109194109195109196109197109198109199109200109201109202109203109204109205109206109207109208109209109210109211109212109213109214109215109216109217109218109219109220109221109222109223109224109225109226109227109228109229109230109231109232109233109234109235109236109237109238109239109240109241109242109243109244109245109246109247109248109249109250109251109252109253109254109255109256109257109258109259109260109261109262109263109264109265109266109267109268109269109270109271109272109273109274109275109276109277109278109279109280109281109282109283109284109285109286109287109288109289109290109291109292109293109294109295109296109297109298109299109300109301109302109303109304109305109306109307109308109309109310109311109312109313109314109315109316109317109318109319109320109321109322109323109324109325109326109327109328109329109330109331109332109333109334109335109336109337109338109339109340109341109342109343109344109345109346109347109348109349109350109351109352109353109354109355109356109357109358109359109360109361109362109363109364109365109366109367109368109369109370109371109372109373109374109375109376109377109378109379109380109381109382109383109384109385109386109387109388109389109390109391109392109393109394109395109396109397109398109399109400109401109402109403109404109405109406109407109408109409109410109411109412109413109414109415109416109417109418109419109420109421109422109423109424109425109426109427109428109429109430109431109432109433109434109435109436109437109438109439109440109441109442109443109444109445109446109447109448109449109450109451109452109453109454109455109456109457109458109459109460109461109462109463109464109465109466109467109468109469109470109471109472109473109474109475109476109477109478109479109480109481109482109483109484109485109486109487109488109489109490109491109492109493109494109495109496109497109498109499109500109501109502109503109504109505109506109507109508109509109510109511109512109513109514109515109516109517109518109519109520109521109522109523109524109525109526109527109528109529109530109531109532109533109534109535109536109537109538109539109540109541109542109543109544109545109546109547109548109549109550109551109552109553109554109555109556109557109558109559109560109561109562109563109564109565109566109567109568109569109570109571109572109573109574109575109576109577109578109579109580109581109582109583109584109585109586109587109588109589109590109591109592109593109594109595109596109597109598109599109600109601109602109603109604109605109606109607109608109609109610109611109612109613109614109615109616109617109618109619109620109621109622109623109624109625109626109627109628109629109630109631109632109633109634109635109636109637109638109639109640109641109642109643109644109645109646109647109648109649109650109651109652109653109654109655109656109657109658109659109660109661109662109663109664109665109666109667109668109669109670109671109672109673109674109675109676109677109678109679109680109681109682109683109684109685109686109687109688109689109690109691109692109693109694109695109696109697109698109699109700109701109702109703109704109705109706109707109708109709109710109711109712109713109714109715109716109717109718109719109720109721109722109723109724109725109726109727109728109729109730109731109732109733109734109735109736109737109738109739109740109741109742109743109744109745109746109747109748109749109750109751109752109753109754109755109756109757109758109759109760109761109762109763109764109765109766109767109768109769109770109771109772109773109774109775109776109777109778109779109780109781109782109783109784109785109786109787109788109789109790109791109792109793109794109795109796109797109798109799109800109801109802109803109804109805109806109807109808109809109810109811109812109813109814109815109816109817109818109819109820109821109822109823109824109825109826109827109828109829109830109831109832109833109834109835109836109837109838109839109840109841109842109843109844109845109846109847109848109849109850109851109852109853109854109855109856109857109858109859109860109861109862109863109864109865109866109867109868109869109870109871109872109873109874109875109876109877109878109879109880109881109882109883109884109885109886109887109888109889109890109891109892109893109894109895109896109897109898109899109900109901109902109903109904109905109906109907109908109909109910109911109912109913109914109915109916109917109918109919109920109921109922109923109924109925109926109927109928109929109930109931109932109933109934109935109936109937109938109939109940109941109942109943109944109945109946109947109948109949109950109951109952109953109954109955109956109957109958109959109960109961109962109963109964109965109966109967109968109969109970109971109972109973109974109975109976109977109978109979109980109981109982109983109984109985109986109987109988109989109990109991109992109993109994109995109996109997109998109999110000110001110002110003110004110005110006110007110008110009110010110011110012110013110014110015110016110017110018110019110020110021110022110023110024110025110026110027110028110029110030110031110032110033110034110035110036110037110038110039110040110041110042110043110044110045110046110047110048110049110050110051110052110053110054110055110056110057110058110059110060110061110062110063110064110065110066110067110068110069110070110071110072110073110074110075110076110077110078110079110080110081110082110083110084110085110086110087110088110089110090110091110092110093110094110095110096110097110098110099110100110101110102110103110104110105110106110107110108110109110110110111110112110113110114110115110116110117110118110119110120110121110122110123110124110125110126110127110128110129110130110131110132110133110134110135110136110137110138110139110140110141110142110143110144110145110146110147110148110149110150110151110152110153110154110155110156110157110158110159110160110161110162110163110164110165110166110167110168110169110170110171110172110173110174110175110176110177110178110179110180110181110182110183110184110185110186110187110188110189110190110191110192110193110194110195110196110197110198110199110200110201110202110203110204110205110206110207110208110209110210110211110212110213110214110215110216110217110218110219110220110221110222110223110224110225110226110227110228110229110230110231110232110233110234110235110236110237110238110239110240110241110242110243110244110245110246110247110248110249110250110251110252110253110254110255110256110257110258110259110260110261110262110263110264110265110266110267110268110269110270110271110272110273110274110275110276110277110278110279110280110281110282110283110284110285110286110287110288110289110290110291110292110293110294110295110296110297110298110299110300110301110302110303110304110305110306110307110308110309110310110311110312110313110314110315110316110317110318110319110320110321110322110323110324110325110326110327110328110329110330110331110332110333110334110335110336110337110338110339110340110341110342110343110344110345110346110347110348110349110350110351110352110353110354110355110356110357110358110359110360110361110362110363110364110365110366110367110368110369110370110371110372110373110374110375110376110377110378110379110380110381110382110383110384110385110386110387110388110389110390110391110392110393110394110395110396110397110398110399110400110401110402110403110404110405110406110407110408110409110410110411110412110413110414110415110416110417110418110419110420110421110422110423110424110425110426110427110428110429110430110431110432110433110434110435110436110437110438110439110440110441110442110443110444110445110446110447110448110449110450110451110452110453110454110455110456110457110458110459110460110461110462110463110464110465110466110467110468110469110470110471110472110473110474110475110476110477110478110479110480110481110482110483110484110485110486110487110488110489110490110491110492110493110494110495110496110497110498110499110500110501110502110503110504110505110506110507110508110509110510110511110512110513110514110515110516110517110518110519110520110521110522110523110524110525110526110527110528110529110530110531110532110533110534110535110536110537110538110539110540110541110542110543110544110545110546110547110548110549110550110551110552110553110554110555110556110557110558110559110560110561110562110563110564110565110566110567110568110569110570110571110572110573110574110575110576110577110578110579110580110581110582110583110584110585110586110587110588110589110590110591110592110593110594110595110596110597110598110599110600110601110602110603110604110605110606110607110608110609110610110611110612110613110614110615110616110617110618110619110620110621110622110623110624110625110626110627110628110629110630110631110632110633110634110635110636110637110638110639110640110641110642110643110644110645110646110647110648110649110650110651110652110653110654110655110656110657110658110659110660110661110662110663110664110665110666110667110668110669110670110671110672110673110674110675110676110677110678110679110680110681110682110683110684110685110686110687110688110689110690110691110692110693110694110695110696110697110698110699110700110701110702110703110704110705110706110707110708110709110710110711110712110713110714110715110716110717110718110719110720110721110722110723110724110725110726110727110728110729110730110731110732110733110734110735110736110737110738110739110740110741110742110743110744110745110746110747110748110749110750110751110752110753110754110755110756110757110758110759110760110761110762110763110764110765110766110767110768110769110770110771110772110773110774110775110776110777110778110779110780110781110782110783110784110785110786110787110788110789110790110791110792110793110794110795110796110797110798110799110800110801110802110803110804110805110806110807110808110809110810110811110812110813110814110815110816110817110818110819110820110821110822110823110824110825110826110827110828110829110830110831110832110833110834110835110836110837110838110839110840110841110842110843110844110845110846110847110848110849110850110851110852110853110854110855110856110857110858110859110860110861110862110863110864110865110866110867110868110869110870110871110872110873110874110875110876110877110878110879110880110881110882110883110884110885110886110887110888110889110890110891110892110893110894110895110896110897110898110899110900110901110902110903110904110905110906110907110908110909110910110911110912110913110914110915110916110917110918110919110920110921110922110923110924110925110926110927110928110929110930110931110932110933110934110935110936110937110938110939110940110941110942110943110944110945110946110947110948110949110950110951110952110953110954110955110956110957110958110959110960110961110962110963110964110965110966110967110968110969110970110971110972110973110974110975110976110977110978110979110980110981110982110983110984110985110986110987110988110989110990110991110992110993110994110995110996110997110998110999111000111001111002111003111004111005111006111007111008111009111010111011111012111013111014111015111016111017111018111019111020111021111022111023111024111025111026111027111028111029111030111031111032111033111034111035111036111037111038111039111040111041111042111043111044111045111046111047111048111049111050111051111052111053111054111055111056111057111058111059111060111061111062111063111064111065111066111067111068111069111070111071111072111073111074111075111076111077111078111079111080111081111082111083111084111085111086111087111088111089111090111091111092111093111094111095111096111097111098111099111100111101111102111103111104111105111106111107111108111109111110111111111112111113111114111115111116111117111118111119111120111121111122111123111124111125111126111127111128111129111130111131111132111133111134111135111136111137111138111139111140111141111142111143111144111145111146111147111148111149111150111151111152111153111154111155111156111157111158111159111160111161111162111163111164111165111166111167111168111169111170111171111172111173111174111175111176111177111178111179111180111181111182111183111184111185111186111187111188111189111190111191111192111193111194111195111196111197111198111199111200111201111202111203111204111205111206111207111208111209111210111211111212111213111214111215111216111217111218111219111220111221111222111223111224111225111226111227111228111229111230111231111232111233111234111235111236111237111238111239111240111241111242111243111244111245111246111247111248111249111250111251111252111253111254111255111256111257111258111259111260111261111262111263111264111265111266111267111268111269111270111271111272111273111274111275111276111277111278111279111280111281111282111283111284111285111286111287111288111289111290111291111292111293111294111295111296111297111298111299111300111301111302111303111304111305111306111307111308111309111310111311111312111313111314111315111316111317111318111319111320111321111322111323111324111325111326111327111328111329111330111331111332111333111334111335111336111337111338111339111340111341111342111343111344111345111346111347111348111349111350111351111352111353111354111355111356111357111358111359111360111361111362111363111364111365111366111367111368111369111370111371111372111373111374111375111376111377111378111379111380111381111382111383111384111385111386111387111388111389111390111391111392111393111394111395111396111397111398111399111400111401111402111403111404111405111406111407111408111409111410111411111412111413111414111415111416111417111418111419111420111421111422111423111424111425111426111427111428111429111430111431111432111433111434111435111436111437111438111439111440111441111442111443111444111445111446111447111448111449111450111451111452111453111454111455111456111457111458111459111460111461111462111463111464111465111466111467111468111469111470111471111472111473111474111475111476111477111478111479111480111481111482111483111484111485111486111487111488111489111490111491111492111493111494111495111496111497111498111499111500111501111502111503111504111505111506111507111508111509111510111511111512111513111514111515111516111517111518111519111520111521111522111523111524111525111526111527111528111529111530111531111532111533111534111535111536111537111538111539111540111541111542111543111544111545111546111547111548111549111550111551111552111553111554111555111556111557111558111559111560111561111562111563111564111565111566111567111568111569111570111571111572111573111574111575111576111577111578111579111580111581111582111583111584111585111586111587111588111589111590111591111592111593111594111595111596111597111598111599111600111601111602111603111604111605111606111607111608111609111610111611111612111613111614111615111616111617111618111619111620111621111622111623111624111625111626111627111628111629111630111631111632111633111634111635111636111637111638111639111640111641111642111643111644111645111646111647111648111649111650111651111652111653111654111655111656111657111658111659111660111661111662111663111664111665111666111667111668111669111670111671111672111673111674111675111676111677111678111679111680111681111682111683111684111685111686111687111688111689111690111691111692111693111694111695111696111697111698111699111700111701111702111703111704111705111706111707111708111709111710111711111712111713111714111715111716111717111718111719111720111721111722111723111724111725111726111727111728111729111730111731111732111733111734111735111736111737111738111739111740111741111742111743111744111745111746111747111748111749111750111751111752111753111754111755111756111757111758111759111760111761111762111763111764111765111766111767111768111769111770111771111772111773111774111775111776111777111778111779111780111781111782111783111784111785111786111787111788111789111790111791111792111793111794111795111796111797111798111799111800111801111802111803111804111805111806111807111808111809111810111811111812111813111814111815111816111817111818111819111820111821111822111823111824111825111826111827111828111829111830111831111832111833111834111835111836111837111838111839111840111841111842111843111844111845111846111847111848111849111850111851111852111853111854111855111856111857111858111859111860111861111862111863111864111865111866111867111868111869111870111871111872111873111874111875111876111877111878111879111880111881111882111883111884111885111886111887111888111889111890111891111892111893111894111895111896111897111898111899111900111901111902111903111904111905111906111907111908111909111910111911111912111913111914111915111916111917111918111919111920111921111922111923111924111925111926111927111928111929111930111931111932111933111934111935111936111937111938111939111940111941111942111943111944111945111946111947111948111949111950111951111952111953111954111955111956111957111958111959111960111961111962111963111964111965111966111967111968111969111970111971111972111973111974111975111976111977111978111979111980111981111982111983111984111985111986111987111988111989111990111991111992111993111994111995111996111997111998111999112000112001112002112003112004112005112006112007112008112009112010112011112012112013112014112015112016112017112018112019112020112021112022112023112024112025112026112027112028112029112030112031112032112033112034112035112036112037112038112039112040112041112042112043112044112045112046112047112048112049112050112051112052112053112054112055112056112057112058112059112060112061112062112063112064112065112066112067112068112069112070112071112072112073112074112075112076112077112078112079112080112081112082112083112084112085112086112087112088112089112090112091112092112093112094112095112096112097112098112099112100112101112102112103112104112105112106112107112108112109112110112111112112112113112114112115112116112117112118112119112120112121112122112123112124112125112126112127112128112129112130112131112132112133112134112135112136112137112138112139112140112141112142112143112144112145112146112147112148112149112150112151112152112153112154112155112156112157112158112159112160112161112162112163112164112165112166112167112168112169112170112171112172112173112174112175112176112177112178112179112180112181112182112183112184112185112186112187112188112189112190112191112192112193112194112195112196112197112198112199112200112201112202112203112204112205112206112207112208112209112210112211112212112213112214112215112216112217112218112219112220112221112222112223112224112225112226112227112228112229112230112231112232112233112234112235112236112237112238112239112240112241112242112243112244112245112246112247112248112249112250112251112252112253112254112255112256112257112258112259112260112261112262112263112264112265112266112267112268112269112270112271112272112273112274112275112276112277112278112279112280112281112282112283112284112285112286112287112288112289112290112291112292112293112294112295112296112297112298112299112300112301112302112303112304112305112306112307112308112309112310112311112312112313112314112315112316112317112318112319112320112321112322112323112324112325112326112327112328112329112330112331112332112333112334112335112336112337112338112339112340112341112342112343112344112345112346112347112348112349112350112351112352112353112354112355112356112357112358112359112360112361112362112363112364112365112366112367112368112369112370112371112372112373112374112375112376112377112378112379112380112381112382112383112384112385112386112387112388112389112390112391112392112393112394112395112396112397112398112399112400112401112402112403112404112405112406112407112408112409112410112411112412112413112414112415112416112417112418112419112420112421112422112423112424112425112426112427112428112429112430112431112432112433112434112435112436112437112438112439112440112441112442112443112444112445112446112447112448112449112450112451112452112453112454112455112456112457112458112459112460112461112462112463112464112465112466112467112468112469112470112471112472112473112474112475112476112477112478112479112480112481112482112483112484112485112486112487112488112489112490112491112492112493112494112495112496112497112498112499112500112501112502112503112504112505112506112507112508112509112510112511112512112513112514112515112516112517112518112519112520112521112522112523112524112525112526112527112528112529112530112531112532112533112534112535112536112537112538112539112540112541112542112543112544112545112546112547112548112549112550112551112552112553112554112555112556112557112558112559112560112561112562112563112564112565112566112567112568112569112570112571112572112573112574112575112576112577112578112579112580112581112582112583112584112585112586112587112588112589112590112591112592112593112594112595112596112597112598112599112600112601112602112603112604112605112606112607112608112609112610112611112612112613112614112615112616112617112618112619112620112621112622112623112624112625112626112627112628112629112630112631112632112633112634112635112636112637112638112639112640112641112642112643112644112645112646112647112648112649112650112651112652112653112654112655112656112657112658112659112660112661112662112663112664112665112666112667112668112669112670112671112672112673112674112675112676112677112678112679112680112681112682112683112684112685112686112687112688112689112690112691112692112693112694112695112696112697112698112699112700112701112702112703112704112705112706112707112708112709112710112711112712112713112714112715112716112717112718112719112720112721112722112723112724112725112726112727112728112729112730112731112732112733112734112735112736112737112738112739112740112741112742112743112744112745112746112747112748112749112750112751112752112753112754112755112756112757112758112759112760112761112762112763112764112765112766112767112768112769112770112771112772112773112774112775112776112777112778112779112780112781112782112783112784112785112786112787112788112789112790112791112792112793112794112795112796112797112798112799112800112801112802112803112804112805112806112807112808112809112810112811112812112813112814112815112816112817112818112819112820112821112822112823112824112825112826112827112828112829112830112831112832112833112834112835112836112837112838112839112840112841112842112843112844112845112846112847112848112849112850112851112852112853112854112855112856112857112858112859112860112861112862112863112864112865112866112867112868112869112870112871112872112873112874112875112876112877112878112879112880112881112882112883112884112885112886112887112888112889112890112891112892112893112894112895112896112897112898112899112900112901112902112903112904112905112906112907112908112909112910112911112912112913112914112915112916112917112918112919112920112921112922112923112924112925112926112927112928112929112930112931112932112933112934112935112936112937112938112939112940112941112942112943112944112945112946112947112948112949112950112951112952112953112954112955112956112957112958112959112960112961112962112963112964112965112966112967112968112969112970112971112972112973112974112975112976112977112978112979112980112981112982112983112984112985112986112987112988112989112990112991112992112993112994112995112996112997112998112999113000113001113002113003113004113005113006113007113008113009113010113011113012113013113014113015113016113017113018113019113020113021113022113023113024113025113026113027113028113029113030113031113032113033113034113035113036113037113038113039113040113041113042113043113044113045113046113047113048113049113050113051113052113053113054113055113056113057113058113059113060113061113062113063113064113065113066113067113068113069113070113071113072113073113074113075113076113077113078113079113080113081113082113083113084113085113086113087113088113089113090113091113092113093113094113095113096113097113098113099113100113101113102113103113104113105113106113107113108113109113110113111113112113113113114113115113116113117113118113119113120113121113122113123113124113125113126113127113128113129113130113131113132113133113134113135113136113137113138113139113140113141113142113143113144113145113146113147113148113149113150113151113152113153113154113155113156113157113158113159113160113161113162113163113164113165113166113167113168113169113170113171113172113173113174113175113176113177113178113179113180113181113182113183113184113185113186113187113188113189113190113191113192113193113194113195113196113197113198113199113200113201113202113203113204113205113206113207113208113209113210113211113212113213113214113215113216113217113218113219113220113221113222113223113224113225113226113227113228113229113230113231113232113233113234113235113236113237113238113239113240113241113242113243113244113245113246113247113248113249113250113251113252113253113254113255113256113257113258113259113260113261113262113263113264113265113266113267113268113269113270113271113272113273113274113275113276113277113278113279113280113281113282113283113284113285113286113287113288113289113290113291113292113293113294113295113296113297113298113299113300113301113302113303113304113305113306113307113308113309113310113311113312113313113314113315113316113317113318113319113320113321113322113323113324113325113326113327113328113329113330113331113332113333113334113335113336113337113338113339113340113341113342113343113344113345113346113347113348113349113350113351113352113353113354113355113356113357113358113359113360113361113362113363113364113365113366113367113368113369113370113371113372113373113374113375113376113377113378113379113380113381113382113383113384113385113386113387113388113389113390113391113392113393113394113395113396113397113398113399113400113401113402113403113404113405113406113407113408113409113410113411113412113413113414113415113416113417113418113419113420113421113422113423113424113425113426113427113428113429113430113431113432113433113434113435113436113437113438113439113440113441113442113443113444113445113446113447113448113449113450113451113452113453113454113455113456113457113458113459113460113461113462113463113464113465113466113467113468113469113470113471113472113473113474113475113476113477113478113479113480113481113482113483113484113485113486113487113488113489113490113491113492113493113494113495113496113497113498113499113500113501113502113503113504113505113506113507113508113509113510113511113512113513113514113515113516113517113518113519113520113521113522113523113524113525113526113527113528113529113530113531113532113533113534113535113536113537113538113539113540113541113542113543113544113545113546113547113548113549113550113551113552113553113554113555113556113557113558113559113560113561113562113563113564113565113566113567113568113569113570113571113572113573113574113575113576113577113578113579113580113581113582113583113584113585113586113587113588113589113590113591113592113593113594113595113596113597113598113599113600113601113602113603113604113605113606113607113608113609113610113611113612113613113614113615113616113617113618113619113620113621113622113623113624113625113626113627113628113629113630113631113632113633113634113635113636113637113638113639113640113641113642113643113644113645113646113647113648113649113650113651113652113653113654113655113656113657113658113659113660113661113662113663113664113665113666113667113668113669113670113671113672113673113674113675113676113677113678113679113680113681113682113683113684113685113686113687113688113689113690113691113692113693113694113695113696113697113698113699113700113701113702113703113704113705113706113707113708113709113710113711113712113713113714113715113716113717113718113719113720113721113722113723113724113725113726113727113728113729113730113731113732113733113734113735113736113737113738113739113740113741113742113743113744113745113746113747113748113749113750113751113752113753113754113755113756113757113758113759113760113761113762113763113764113765113766113767113768113769113770113771113772113773113774113775113776113777113778113779113780113781113782113783113784113785113786113787113788113789113790113791113792113793113794113795113796113797113798113799113800113801113802113803113804113805113806113807113808113809113810113811113812113813113814113815113816113817113818113819113820113821113822113823113824113825113826113827113828113829113830113831113832113833113834113835113836113837113838113839113840113841113842113843113844113845113846113847113848113849113850113851113852113853113854113855113856113857113858113859113860113861113862113863113864113865113866113867113868113869113870113871113872113873113874113875113876113877113878113879113880113881113882113883113884113885113886113887113888113889113890113891113892113893113894113895113896113897113898113899113900113901113902113903113904113905113906113907113908113909113910113911113912113913113914113915113916113917113918113919113920113921113922113923113924113925113926113927113928113929113930113931113932113933113934113935113936113937113938113939113940113941113942113943113944113945113946113947113948113949113950113951113952113953113954113955113956113957113958113959113960113961113962113963113964113965113966113967113968113969113970113971113972113973113974113975113976113977113978113979113980113981113982113983113984113985113986113987113988113989113990113991113992113993113994113995113996113997113998113999114000114001114002114003114004114005114006114007114008114009114010114011114012114013114014114015114016114017114018114019114020114021114022114023114024114025114026114027114028114029114030114031114032114033114034114035114036114037114038114039114040114041114042114043114044114045114046114047114048114049114050114051114052114053114054114055114056114057114058114059114060114061114062114063114064114065114066114067114068114069114070114071114072114073114074114075114076114077114078114079114080114081114082114083114084114085114086114087114088114089114090114091114092114093114094114095114096114097114098114099114100114101114102114103114104114105114106114107114108114109114110114111114112114113114114114115114116114117114118114119114120114121114122114123114124114125114126114127114128114129114130114131114132114133114134114135114136114137114138114139114140114141114142114143114144114145114146114147114148114149114150114151114152114153114154114155114156114157114158114159114160114161114162114163114164114165114166114167114168114169114170114171114172114173114174114175114176114177114178114179114180114181114182114183114184114185114186114187114188114189114190114191114192114193114194114195114196114197114198114199114200114201114202114203114204114205114206114207114208114209114210114211114212114213114214114215114216114217114218114219114220114221114222114223114224114225114226114227114228114229114230114231114232114233114234114235114236114237114238114239114240114241114242114243114244114245114246114247114248114249114250114251114252114253114254114255114256114257114258114259114260114261114262114263114264114265114266114267114268114269114270114271114272114273114274114275114276114277114278114279114280114281114282114283114284114285114286114287114288114289114290114291114292114293114294114295114296114297114298114299114300114301114302114303114304114305114306114307114308114309114310114311114312114313114314114315114316114317114318114319114320114321114322114323114324114325114326114327114328114329114330114331114332114333114334114335114336114337114338114339114340114341114342114343114344114345114346114347114348114349114350114351114352114353114354114355114356114357114358114359114360114361114362114363114364114365114366114367114368114369114370114371114372114373114374114375114376114377114378114379114380114381114382114383114384114385114386114387114388114389114390114391114392114393114394114395114396114397114398114399114400114401114402114403114404114405114406114407114408114409114410114411114412114413114414114415114416114417114418114419114420114421114422114423114424114425114426114427114428114429114430114431114432114433114434114435114436114437114438114439114440114441114442114443114444114445114446114447114448114449114450114451114452114453114454114455114456114457114458114459114460114461114462114463114464114465114466114467114468114469114470114471114472114473114474114475114476114477114478114479114480114481114482114483114484114485114486114487114488114489114490114491114492114493114494114495114496114497114498114499114500114501114502114503114504114505114506114507114508114509114510114511114512114513114514114515114516114517114518114519114520114521114522114523114524114525114526114527114528114529114530114531114532114533114534114535114536114537114538114539114540114541114542114543114544114545114546114547114548114549114550114551114552114553114554114555114556114557114558114559114560114561114562114563114564114565114566114567114568114569114570114571114572114573114574114575114576114577114578114579114580114581114582114583114584114585114586114587114588114589114590114591114592114593114594114595114596114597114598114599114600114601114602114603114604114605114606114607114608114609114610114611114612114613114614114615114616114617114618114619114620114621114622114623114624114625114626114627114628114629114630114631114632114633114634114635114636114637114638114639114640114641114642114643114644114645114646114647114648114649114650114651114652114653114654114655114656114657114658114659114660114661114662114663114664114665114666114667114668114669114670114671114672114673114674114675114676114677114678114679114680114681114682114683114684114685114686114687114688114689114690114691114692114693114694114695114696114697114698114699114700114701114702114703114704114705114706114707114708114709114710114711114712114713114714114715114716114717114718114719114720114721114722114723114724114725114726114727114728114729114730114731114732114733114734114735114736114737114738114739114740114741114742114743114744114745114746114747114748114749114750114751114752114753114754114755114756114757114758114759114760114761114762114763114764114765114766114767114768114769114770114771114772114773114774114775114776114777114778114779114780114781114782114783114784114785114786114787114788114789114790114791114792114793114794114795114796114797114798114799114800114801114802114803114804114805114806114807114808114809114810114811114812114813114814114815114816114817114818114819114820114821114822114823114824114825114826114827114828114829114830114831114832114833114834114835114836114837114838114839114840114841114842114843114844114845114846114847114848114849114850114851114852114853114854114855114856114857114858114859114860114861114862114863114864114865114866114867114868114869114870114871114872114873114874114875114876114877114878114879114880114881114882114883114884114885114886114887114888114889114890114891114892114893114894114895114896114897114898114899114900114901114902114903114904114905114906114907114908114909114910114911114912114913114914114915114916114917114918114919114920114921114922114923114924114925114926114927114928114929114930114931114932114933114934114935114936114937114938114939114940114941114942114943114944114945114946114947114948114949114950114951114952114953114954114955114956114957114958114959114960114961114962114963114964114965114966114967114968114969114970114971114972114973114974114975114976114977114978114979114980114981114982114983114984114985114986114987114988114989114990114991114992114993114994114995114996114997114998114999115000115001115002115003115004115005115006115007115008115009115010115011115012115013115014115015115016115017115018115019115020115021115022115023115024115025115026115027115028115029115030115031115032115033115034115035115036115037115038115039115040115041115042115043115044115045115046115047115048115049115050115051115052115053115054115055115056115057115058115059115060115061115062115063115064115065115066115067115068115069115070115071115072115073115074115075115076115077115078115079115080115081115082115083115084115085115086115087115088115089115090115091115092115093115094115095115096115097115098115099115100115101115102115103115104115105115106115107115108115109115110115111115112115113115114115115115116115117115118115119115120115121115122115123115124115125115126115127115128115129115130115131115132115133115134115135115136115137115138115139115140115141115142115143115144115145115146115147115148115149115150115151115152115153115154115155115156115157115158115159115160115161115162115163115164115165115166115167115168115169115170115171115172115173115174115175115176115177115178115179115180115181115182115183115184115185115186115187115188115189115190115191115192115193115194115195115196115197115198115199115200115201115202115203115204115205115206115207115208115209115210115211115212115213115214115215115216115217115218115219115220115221115222115223115224115225115226115227115228115229115230115231115232115233115234115235115236115237115238115239115240115241115242115243115244115245115246115247115248115249115250115251115252115253115254115255115256115257115258115259115260115261115262115263115264115265115266115267115268115269115270115271115272115273115274115275115276115277115278115279115280115281115282115283115284115285115286115287115288115289115290115291115292115293115294115295115296115297115298115299115300115301115302115303115304115305115306115307115308115309115310115311115312115313115314115315115316115317115318115319115320115321115322115323115324115325115326115327115328115329115330115331115332115333115334115335115336115337115338115339115340115341115342115343115344115345115346115347115348115349115350115351115352115353115354115355115356115357115358115359115360115361115362115363115364115365115366115367115368115369115370115371115372115373115374115375115376115377115378115379115380115381115382115383115384115385115386115387115388115389115390115391115392115393115394115395115396115397115398115399115400115401115402115403115404115405115406115407115408115409115410115411115412115413115414115415115416115417115418115419115420115421115422115423115424115425115426115427115428115429115430115431115432115433115434115435115436115437115438115439115440115441115442115443115444115445115446115447115448115449115450115451115452115453115454115455115456115457115458115459115460115461115462115463115464115465115466115467115468115469115470115471115472115473115474115475115476115477115478115479115480115481115482115483115484115485115486115487115488115489115490115491115492115493115494115495115496115497115498115499115500115501115502115503115504115505115506115507115508115509115510115511115512115513115514115515115516115517115518115519115520115521115522115523115524115525115526115527115528115529115530115531115532115533115534115535115536115537115538115539115540115541115542115543115544115545115546115547115548115549115550115551115552115553115554115555115556115557115558115559115560115561115562115563115564115565115566115567115568115569115570115571115572115573115574115575115576115577115578115579115580115581115582115583115584115585115586115587115588115589115590115591115592115593115594115595115596115597115598115599115600115601115602115603115604115605115606115607115608115609115610115611115612115613115614115615115616115617115618115619115620115621115622115623115624115625115626115627115628115629115630115631115632115633115634115635115636115637115638115639115640115641115642115643115644115645115646115647115648115649115650115651115652115653115654115655115656115657115658115659115660115661115662115663115664115665115666115667115668115669115670115671115672115673115674115675115676115677115678115679115680115681115682115683115684115685115686115687115688115689115690115691115692115693115694115695115696115697115698115699115700115701115702115703115704115705115706115707115708115709115710115711115712115713115714115715115716115717115718115719115720115721115722115723115724115725115726115727115728115729115730115731115732115733115734115735115736115737115738115739115740115741115742115743115744115745115746115747115748115749115750115751115752115753115754115755115756115757115758115759115760115761115762115763115764115765115766115767115768115769115770115771115772115773115774115775115776115777115778115779115780115781115782115783115784115785115786115787115788115789115790115791115792115793115794115795115796115797115798115799115800115801115802115803115804115805115806115807115808115809115810115811115812115813115814115815115816115817115818115819115820115821115822115823115824115825115826115827115828115829115830115831115832115833115834115835115836115837115838115839115840115841115842115843115844115845115846115847115848115849115850115851115852115853115854115855115856115857115858115859115860115861115862115863115864115865115866115867115868115869115870115871115872115873115874115875115876115877115878115879115880115881115882115883115884115885115886115887115888115889115890115891115892115893115894115895115896115897115898115899115900115901115902115903115904115905115906115907115908115909115910115911115912115913115914115915115916115917115918115919115920115921115922115923115924115925115926115927115928115929115930115931115932115933115934115935115936115937115938115939115940115941115942115943115944115945115946115947115948115949115950115951115952115953115954115955115956115957115958115959115960115961115962115963115964115965115966115967115968115969115970115971115972115973115974115975115976115977115978115979115980115981115982115983115984115985115986115987115988115989115990115991115992115993115994115995115996115997115998115999116000116001116002116003116004116005116006116007116008116009116010116011116012116013116014116015116016116017116018116019116020116021116022116023116024116025116026116027116028116029116030116031116032116033116034116035116036116037116038116039116040116041116042116043116044116045116046116047116048116049116050116051116052116053116054116055116056116057116058116059116060116061116062116063116064116065116066116067116068116069116070116071116072116073116074116075116076116077116078116079116080116081116082116083116084116085116086116087116088116089116090116091116092116093116094116095116096116097116098116099116100116101116102116103116104116105116106116107116108116109116110116111116112116113116114116115116116116117116118116119116120116121116122116123116124116125116126116127116128116129116130116131116132116133116134116135116136116137116138116139116140116141116142116143116144116145116146116147116148116149116150116151116152116153116154116155116156116157116158116159116160116161116162116163116164116165116166116167116168116169116170116171116172116173116174116175116176116177116178116179116180116181116182116183116184116185116186116187116188116189116190116191116192116193116194116195116196116197116198116199116200116201116202116203116204116205116206116207116208116209116210116211116212116213116214116215116216116217116218116219116220116221116222116223116224116225116226116227116228116229116230116231116232116233116234116235116236116237116238116239116240116241116242116243116244116245116246116247116248116249116250116251116252116253116254116255116256116257116258116259116260116261116262116263116264116265116266116267116268116269116270116271116272116273116274116275116276116277116278116279116280116281116282116283116284116285116286116287116288116289116290116291116292116293116294116295116296116297116298116299116300116301116302116303116304116305116306116307116308116309116310116311116312116313116314116315116316116317116318116319116320116321116322116323116324116325116326116327116328116329116330116331116332116333116334116335116336116337116338116339116340116341116342116343116344116345116346116347116348116349116350116351116352116353116354116355116356116357116358116359116360116361116362116363116364116365116366116367116368116369116370116371116372116373116374116375116376116377116378116379116380116381116382116383116384116385116386116387116388116389116390116391116392116393116394116395116396116397116398116399116400116401116402116403116404116405116406116407116408116409116410116411116412116413116414116415116416116417116418116419116420116421116422116423116424116425116426116427116428116429116430116431116432116433116434116435116436116437116438116439116440116441116442116443116444116445116446116447116448116449116450116451116452116453116454116455116456116457116458116459116460116461116462116463116464116465116466116467116468116469116470116471116472116473116474116475116476116477116478116479116480116481116482116483116484116485116486116487116488116489116490116491116492116493116494116495116496116497116498116499116500116501116502116503116504116505116506116507116508116509116510116511116512116513116514116515116516116517116518116519116520116521116522116523116524116525116526116527116528116529116530116531116532116533116534116535116536116537116538116539116540116541116542116543116544116545116546116547116548116549116550116551116552116553116554116555116556116557116558116559116560116561116562116563116564116565116566116567116568116569116570116571116572116573116574116575116576116577116578116579116580116581116582116583116584116585116586116587116588116589116590116591116592116593116594116595116596116597116598116599116600116601116602116603116604116605116606116607116608116609116610116611116612116613116614116615116616116617116618116619116620116621116622116623116624116625116626116627116628116629116630116631116632116633116634116635116636116637116638116639116640116641116642116643116644116645116646116647116648116649116650116651116652116653116654116655116656116657116658116659116660116661116662116663116664116665116666116667116668116669116670116671116672116673116674116675116676116677116678116679116680116681116682116683116684116685116686116687116688116689116690116691116692116693116694116695116696116697116698116699116700116701116702116703116704116705116706116707116708116709116710116711116712116713116714116715116716116717116718116719116720116721116722116723116724116725116726116727116728116729116730116731116732116733116734116735116736116737116738116739116740116741116742116743116744116745116746116747116748116749116750116751116752116753116754116755116756116757116758116759116760116761116762116763116764116765116766116767116768116769116770116771116772116773116774116775116776116777116778116779116780116781116782116783116784116785116786116787116788116789116790116791116792116793116794116795116796116797116798116799116800116801116802116803116804116805116806116807116808116809116810116811116812116813116814116815116816116817116818116819116820116821116822116823116824116825116826116827116828116829116830116831116832116833116834116835116836116837116838116839116840116841116842116843116844116845116846116847116848116849116850116851116852116853116854116855116856116857116858116859116860116861116862116863116864116865116866116867116868116869116870116871116872116873116874116875116876116877116878116879116880116881116882116883116884116885116886116887116888116889116890116891116892116893116894116895116896116897116898116899116900116901116902116903116904116905116906116907116908116909116910116911116912116913116914116915116916116917116918116919116920116921116922116923116924116925116926116927116928116929116930116931116932116933116934116935116936116937116938116939116940116941116942116943116944116945116946116947116948116949116950116951116952116953116954116955116956116957116958116959116960116961116962116963116964116965116966116967116968116969116970116971116972116973116974116975116976116977116978116979116980116981116982116983116984116985116986116987116988116989116990116991116992116993116994116995116996116997116998116999117000117001117002117003117004117005117006117007117008117009117010117011117012117013117014117015117016117017117018117019117020117021117022117023117024117025117026117027117028117029117030117031117032117033117034117035117036117037117038117039117040117041117042117043117044117045117046117047117048117049117050117051117052117053117054117055117056117057117058117059117060117061117062117063117064117065117066117067117068117069117070117071117072117073117074117075117076117077117078117079117080117081117082117083117084117085117086117087117088117089117090117091117092117093117094117095117096117097117098117099117100117101117102117103117104117105117106117107117108117109117110117111117112117113117114117115117116117117117118117119117120117121117122117123117124117125117126117127117128117129117130117131117132117133117134117135117136117137117138117139117140117141117142117143117144117145117146117147117148117149117150117151117152117153117154117155117156117157117158117159117160117161117162117163117164117165117166117167117168117169117170117171117172117173117174117175117176117177117178117179117180117181117182117183117184117185117186117187117188117189117190117191117192117193117194117195117196117197117198117199117200117201117202117203117204117205117206117207117208117209117210117211117212117213117214117215117216117217117218117219117220117221117222117223117224117225117226117227117228117229117230117231117232117233117234117235117236117237117238117239117240117241117242117243117244117245117246117247117248117249117250117251117252117253117254117255117256117257117258117259117260117261117262117263117264117265117266117267117268117269117270117271117272117273117274117275117276117277117278117279117280117281117282117283117284117285117286117287117288117289117290117291117292117293117294117295117296117297117298117299117300117301117302117303117304117305117306117307117308117309117310117311117312117313117314117315117316117317117318117319117320117321117322117323117324117325117326117327117328117329117330117331117332117333117334117335117336117337117338117339117340117341117342117343117344117345117346117347117348117349117350117351117352117353117354117355117356117357117358117359117360117361117362117363117364117365117366117367117368117369117370117371117372117373117374117375117376117377117378117379117380117381117382117383117384117385117386117387117388117389117390117391117392117393117394117395117396117397117398117399117400117401117402117403117404117405117406117407117408117409117410117411117412117413117414117415117416117417117418117419117420117421117422117423117424117425117426117427117428117429117430117431117432117433117434117435117436117437117438117439117440117441117442117443117444117445117446117447117448117449117450117451117452117453117454117455117456117457117458117459117460117461117462117463117464117465117466117467117468117469117470117471117472117473117474117475117476117477117478117479117480117481117482117483117484117485117486117487117488117489117490117491117492117493117494117495117496117497117498117499117500117501117502117503117504117505117506117507117508117509117510117511117512117513117514117515117516117517117518117519117520117521117522117523117524117525117526117527117528117529117530117531117532117533117534117535117536117537117538117539117540117541117542117543117544117545117546117547117548117549117550117551117552117553117554117555117556117557117558117559117560117561117562117563117564117565117566117567117568117569117570117571117572117573117574117575117576117577117578117579117580117581117582117583117584117585117586117587117588117589117590117591117592117593117594117595117596117597117598117599117600117601117602117603117604117605117606117607117608117609117610117611117612117613117614117615117616117617117618117619117620117621117622117623117624117625117626117627117628117629117630117631117632117633117634117635117636117637117638117639117640117641117642117643117644117645117646117647117648117649117650117651117652117653117654117655117656117657117658117659117660117661117662117663117664117665117666117667117668117669117670117671117672117673117674117675117676117677117678117679117680117681117682117683117684117685117686117687117688117689117690117691117692117693117694117695117696117697117698117699117700117701117702117703117704117705117706117707117708117709117710117711117712117713117714117715117716117717117718117719117720117721117722117723117724117725117726117727117728117729117730117731117732117733117734117735117736117737117738117739117740117741117742117743117744117745117746117747117748117749117750117751117752117753117754117755117756117757117758117759117760117761117762117763117764117765117766117767117768117769117770117771117772117773117774117775117776117777117778117779117780117781117782117783117784117785117786117787117788117789117790117791117792117793117794117795117796117797117798117799117800117801117802117803117804117805117806117807117808117809117810117811117812117813117814117815117816117817117818117819117820117821117822117823117824117825117826117827117828117829117830117831117832117833117834117835117836117837117838117839117840117841117842117843117844117845117846117847117848117849117850117851117852117853117854117855117856117857117858117859117860117861117862117863117864117865117866117867117868117869117870117871117872117873117874117875117876117877117878117879117880117881117882117883117884117885117886117887117888117889117890117891117892117893117894117895117896117897117898117899117900117901117902117903117904117905117906117907117908117909117910117911117912117913117914117915117916117917117918117919117920117921117922117923117924117925117926117927117928117929117930117931117932117933117934117935117936117937117938117939117940117941117942117943117944117945117946117947117948117949117950117951117952117953117954117955117956117957117958117959117960117961117962117963117964117965117966117967117968117969117970117971117972117973117974117975117976117977117978117979117980117981117982117983117984117985117986117987117988117989117990117991117992117993117994117995117996117997117998117999118000118001118002118003118004118005118006118007118008118009118010118011118012118013118014118015118016118017118018118019118020118021118022118023118024118025118026118027118028118029118030118031118032118033118034118035118036118037118038118039118040118041118042118043118044118045118046118047118048118049118050118051118052118053118054118055118056118057118058118059118060118061118062118063118064118065118066118067118068118069118070118071118072118073118074118075118076118077118078118079118080118081118082118083118084118085118086118087118088118089118090118091118092118093118094118095118096118097118098118099118100118101118102118103118104118105118106118107118108118109118110118111118112118113118114118115118116118117118118118119118120118121118122118123118124118125118126118127118128118129118130118131118132118133118134118135118136118137118138118139118140118141118142118143118144118145118146118147118148118149118150118151118152118153118154118155118156118157118158118159118160118161118162118163118164118165118166118167118168118169118170118171118172118173118174118175118176118177118178118179118180118181118182118183118184118185118186118187118188118189118190118191118192118193118194118195118196118197118198118199118200118201118202118203118204118205118206118207118208118209118210118211118212118213118214118215118216118217118218118219118220118221118222118223118224118225118226118227118228118229118230118231118232118233118234118235118236118237118238118239118240118241118242118243118244118245118246118247118248118249118250118251118252118253118254118255118256118257118258118259118260118261118262118263118264118265118266118267118268118269118270118271118272118273118274118275118276118277118278118279118280118281118282118283118284118285118286118287118288118289118290118291118292118293118294118295118296118297118298118299118300118301118302118303118304118305118306118307118308118309118310118311118312118313118314118315118316118317118318118319118320118321118322118323118324118325118326118327118328118329118330118331118332118333118334118335118336118337118338118339118340118341118342118343118344118345118346118347118348118349118350118351118352118353118354118355118356118357118358118359118360118361118362118363118364118365118366118367118368118369118370118371118372118373118374118375118376118377118378118379118380118381118382118383118384118385118386118387118388118389118390118391118392118393118394118395118396118397118398118399118400118401118402118403118404118405118406118407118408118409118410118411118412118413118414118415118416118417118418118419118420118421118422118423118424118425118426118427118428118429118430118431118432118433118434118435118436118437118438118439118440118441118442118443118444118445118446118447118448118449118450118451118452118453118454118455118456118457118458118459118460118461118462118463118464118465118466118467118468118469118470118471118472118473118474118475118476118477118478118479118480118481118482118483118484118485118486118487118488118489118490118491118492118493118494118495118496118497118498118499118500118501118502118503118504118505118506118507118508118509118510118511118512118513118514118515118516118517118518118519118520118521118522118523118524118525118526118527118528118529118530118531118532118533118534118535118536118537118538118539118540118541118542118543118544118545118546118547118548118549118550118551118552118553118554118555118556118557118558118559118560118561118562118563118564118565118566118567118568118569118570118571118572118573118574118575118576118577118578118579118580118581118582118583118584118585118586118587118588118589118590118591118592118593118594118595118596118597118598118599118600118601118602118603118604118605118606118607118608118609118610118611118612118613118614118615118616118617118618118619118620118621118622118623118624118625118626118627118628118629118630118631118632118633118634118635118636118637118638118639118640118641118642118643118644118645118646118647118648118649118650118651118652118653118654118655118656118657118658118659118660118661118662118663118664118665118666118667118668118669118670118671118672118673118674118675118676118677118678118679118680118681118682118683118684118685118686118687118688118689118690118691118692118693118694118695118696118697118698118699118700118701118702118703118704118705118706118707118708118709118710118711118712118713118714118715118716118717118718118719118720118721118722118723118724118725118726118727118728118729118730118731118732118733118734118735118736118737118738118739118740118741118742118743118744118745118746118747118748118749118750118751118752118753118754118755118756118757118758118759118760118761118762118763118764118765118766118767118768118769118770118771118772118773118774118775118776118777118778118779118780118781118782118783118784118785118786118787118788118789118790118791118792118793118794118795118796118797118798118799118800118801118802118803118804118805118806118807118808118809118810118811118812118813118814118815118816118817118818118819118820118821118822118823118824118825118826118827118828118829118830118831118832118833118834118835118836118837118838118839118840118841118842118843118844118845118846118847118848118849118850118851118852118853118854118855118856118857118858118859118860118861118862118863118864118865118866118867118868118869118870118871118872118873118874118875118876118877118878118879118880118881118882118883118884118885118886118887118888118889118890118891118892118893118894118895118896118897118898118899118900118901118902118903118904118905118906118907118908118909118910118911118912118913118914118915118916118917118918118919118920118921118922118923118924118925118926118927118928118929118930118931118932118933118934118935118936118937118938118939118940118941118942118943118944118945118946118947118948118949118950118951118952118953118954118955118956118957118958118959118960118961118962118963118964118965118966118967118968118969118970118971118972118973118974118975118976118977118978118979118980118981118982118983118984118985118986118987118988118989118990118991118992118993118994118995118996118997118998118999119000119001119002119003119004119005119006119007119008119009119010119011119012119013119014119015119016119017119018119019119020119021119022119023119024119025119026119027119028119029119030119031119032119033119034119035119036119037119038119039119040119041119042119043119044119045119046119047119048119049119050119051119052119053119054119055119056119057119058119059119060119061119062119063119064119065119066119067119068119069119070119071119072119073119074119075119076119077119078119079119080119081119082119083119084119085119086119087119088119089119090119091119092119093119094119095119096119097119098119099119100119101119102119103119104119105119106119107119108119109119110119111119112119113119114119115119116119117119118119119119120119121119122119123119124119125119126119127119128119129119130119131119132119133119134119135119136119137119138119139119140119141119142119143119144119145119146119147119148119149119150119151119152119153119154119155119156119157119158119159119160119161119162119163119164119165119166119167119168119169119170119171119172119173119174119175119176119177119178119179119180119181119182119183119184119185119186119187119188119189119190119191119192119193119194119195119196119197119198119199119200119201119202119203119204119205119206119207119208119209119210119211119212119213119214119215119216119217119218119219119220119221119222119223119224119225119226119227119228119229119230119231119232119233119234119235119236119237119238119239119240119241119242119243119244119245119246119247119248119249119250119251119252119253119254119255119256119257119258119259119260119261119262119263119264119265119266119267119268119269119270119271119272119273119274119275119276119277119278119279119280119281119282119283119284119285119286119287119288119289119290119291119292119293119294119295119296119297119298119299119300119301119302119303119304119305119306119307119308119309119310119311119312119313119314119315119316119317119318119319119320119321119322119323119324119325119326119327119328119329119330119331119332119333119334119335119336119337119338119339119340119341119342119343119344119345119346119347119348119349119350119351119352119353119354119355119356119357119358119359119360119361119362119363119364119365119366119367119368119369119370119371119372119373119374119375119376119377119378119379119380119381119382119383119384119385119386119387119388119389119390119391119392119393119394119395119396119397119398119399119400119401119402119403119404119405119406119407119408119409119410119411119412119413119414119415119416119417119418119419119420119421119422119423119424119425119426119427119428119429119430119431119432119433119434119435119436119437119438119439119440119441119442119443119444119445119446119447119448119449119450119451119452119453119454119455119456119457119458119459119460119461119462119463119464119465119466119467119468119469119470119471119472119473119474119475119476119477119478119479119480119481119482119483119484119485119486119487119488119489119490119491119492119493119494119495119496119497119498119499119500119501119502119503119504119505119506119507119508119509119510119511119512119513119514119515119516119517119518119519119520119521119522119523119524119525119526119527119528119529119530119531119532119533119534119535119536119537119538119539119540119541119542119543119544119545119546119547119548119549119550119551119552119553119554119555119556119557119558119559119560119561119562119563119564119565119566119567119568119569119570119571119572119573119574119575119576119577119578119579119580119581119582119583119584119585119586119587119588119589119590119591119592119593119594119595119596119597119598119599119600119601119602119603119604119605119606119607119608119609119610119611119612119613119614119615119616119617119618119619119620119621119622119623119624119625119626119627119628119629119630119631119632119633119634119635119636119637119638119639119640119641119642119643119644119645119646119647119648119649119650119651119652119653119654119655119656119657119658119659119660119661119662119663119664119665119666119667119668119669119670119671119672119673119674119675119676119677119678119679119680119681119682119683119684119685119686119687119688119689119690119691119692119693119694119695119696119697119698119699119700119701119702119703119704119705119706119707119708119709119710119711119712119713119714119715119716119717119718119719119720119721119722119723119724119725119726119727119728119729119730119731119732119733119734119735119736119737119738119739119740119741119742119743119744119745119746119747119748119749119750119751119752119753119754119755119756119757119758119759119760119761119762119763119764119765119766119767119768119769119770119771119772119773119774119775119776119777119778119779119780119781119782119783119784119785119786119787119788119789119790119791119792119793119794119795119796119797119798119799119800119801119802119803119804119805119806119807119808119809119810119811119812119813119814119815119816119817119818119819119820119821119822119823119824119825119826119827119828119829119830119831119832119833119834119835119836119837119838119839119840119841119842119843119844119845119846119847119848119849119850119851119852119853119854119855119856119857119858119859119860119861119862119863119864119865119866119867119868119869119870119871119872119873119874119875119876119877119878119879119880119881119882119883119884119885119886119887119888119889119890119891119892119893119894119895119896119897119898119899119900119901119902119903119904119905119906119907119908119909119910119911119912119913119914119915119916119917119918119919119920119921119922119923119924119925119926119927119928119929119930119931119932119933119934119935119936119937119938119939119940119941119942119943119944119945119946119947119948119949119950119951119952119953119954119955119956119957119958119959119960119961119962119963119964119965119966119967119968119969119970119971119972119973119974119975119976119977119978119979119980119981119982119983119984119985119986119987119988119989119990119991119992119993119994119995119996119997119998119999120000120001120002120003120004120005120006120007120008120009120010120011120012120013120014120015120016120017120018120019120020120021120022120023120024120025120026120027120028120029120030120031120032120033120034120035120036120037120038120039120040120041120042120043120044120045120046120047120048120049120050120051120052120053120054120055120056120057120058120059120060120061120062120063120064120065120066120067120068120069120070120071120072120073120074120075120076120077120078120079120080120081120082120083120084120085120086120087120088120089120090120091120092120093120094120095120096120097120098120099120100120101120102120103120104120105120106120107120108120109120110120111120112120113120114120115120116120117120118120119120120120121120122120123120124120125120126120127120128120129120130120131120132120133120134120135120136120137120138120139120140120141120142120143120144120145120146120147120148120149120150120151120152120153120154120155120156120157120158120159120160120161120162120163120164120165120166120167120168120169120170120171120172120173120174120175120176120177120178120179120180120181120182120183120184120185120186120187120188120189120190120191120192120193120194120195120196120197120198120199120200120201120202120203120204120205120206120207120208120209120210120211120212120213120214120215120216120217120218120219120220120221120222120223120224120225120226120227120228120229120230120231120232120233120234120235120236120237120238120239120240120241120242120243120244120245120246120247120248120249120250120251120252120253120254120255120256120257120258120259120260120261120262120263120264120265120266120267120268120269120270120271120272120273120274120275120276120277120278120279120280120281120282120283120284120285120286120287120288120289120290120291120292120293120294120295120296120297120298120299120300120301120302120303120304120305120306120307120308120309120310120311120312120313120314120315120316120317120318120319120320120321120322120323120324120325120326120327120328120329120330120331120332120333120334120335120336120337120338120339120340120341120342120343120344120345120346120347120348120349120350120351120352120353120354120355120356120357120358120359120360120361120362120363120364120365120366120367120368120369120370120371120372120373120374120375120376120377120378120379120380120381120382120383120384120385120386120387120388120389120390120391120392120393120394120395120396120397120398120399120400120401120402120403120404120405120406120407120408120409120410120411120412120413120414120415120416120417120418120419120420120421120422120423120424120425120426120427120428120429120430120431120432120433120434120435120436120437120438120439120440120441120442120443120444120445120446120447120448120449120450120451120452120453120454120455120456120457120458120459120460120461120462120463120464120465120466120467120468120469120470120471120472120473120474120475120476120477120478120479120480120481120482120483120484120485120486120487120488120489120490120491120492120493120494120495120496120497120498120499120500120501120502120503120504120505120506120507120508120509120510120511120512120513120514120515120516120517120518120519120520120521120522120523120524120525120526120527120528120529120530120531120532120533120534120535120536120537120538120539120540120541120542120543120544120545120546120547120548120549120550120551120552120553120554120555120556120557120558120559120560120561120562120563120564120565120566120567120568120569120570120571120572120573120574120575120576120577120578120579120580120581120582120583120584120585120586120587120588120589120590120591120592120593120594120595120596120597120598120599120600120601120602120603120604120605120606120607120608120609120610120611120612120613120614120615120616120617120618120619120620120621120622120623120624120625120626120627120628120629120630120631120632120633120634120635120636120637120638120639120640120641120642120643120644120645120646120647120648120649120650120651120652120653120654120655120656120657120658120659120660120661120662120663120664120665120666120667120668120669120670120671120672120673120674120675120676120677120678120679120680120681120682120683120684120685120686120687120688120689120690120691120692120693120694120695120696120697120698120699120700120701120702120703120704120705120706120707120708120709120710120711120712120713120714120715120716120717120718120719120720120721120722120723120724120725120726120727120728120729120730120731120732120733120734120735120736120737120738120739120740120741120742120743120744120745120746120747120748120749120750120751120752120753120754120755120756120757120758120759120760120761120762120763120764120765120766120767120768120769120770120771120772120773120774120775120776120777120778120779120780120781120782120783120784120785120786120787120788120789120790120791120792120793120794120795120796120797120798120799120800120801120802120803120804120805120806120807120808120809120810120811120812120813120814120815120816120817120818120819120820120821120822120823120824120825120826120827120828120829120830120831120832120833120834120835120836120837120838120839120840120841120842120843120844120845120846120847120848120849120850120851120852120853120854120855120856120857120858120859120860120861120862120863120864120865120866120867120868120869120870120871120872120873120874120875120876120877120878120879120880120881120882120883120884120885120886120887120888120889120890120891120892120893120894120895120896120897120898120899120900120901120902120903120904120905120906120907120908120909120910120911120912120913120914120915120916120917120918120919120920120921120922120923120924120925120926120927120928120929120930120931120932120933120934120935120936120937120938120939120940120941120942120943120944120945120946120947120948120949120950120951120952120953120954120955120956120957120958120959120960120961120962120963120964120965120966120967120968120969120970120971120972120973120974120975120976120977120978120979120980120981120982120983120984120985120986120987120988120989120990120991120992120993120994120995120996120997120998120999121000121001121002121003121004121005121006121007121008121009121010121011121012121013121014121015121016121017121018121019121020121021121022121023121024121025121026121027121028121029121030121031121032121033121034121035121036121037121038121039121040121041121042121043121044121045121046121047121048121049121050121051121052121053121054121055121056121057121058121059121060121061121062121063121064121065121066121067121068121069121070121071121072121073121074121075121076121077121078121079121080121081121082121083121084121085121086121087121088121089121090121091121092121093121094121095121096121097121098121099121100121101121102121103121104121105121106121107121108121109121110121111121112121113121114121115121116121117121118121119121120121121121122121123121124121125121126121127121128121129121130121131121132121133121134121135121136121137121138121139121140121141121142121143121144121145121146121147121148121149121150121151121152121153121154121155121156121157121158121159121160121161121162121163121164121165121166121167121168121169121170121171121172121173121174121175121176121177121178121179121180121181121182121183121184121185121186121187121188121189121190121191121192121193121194121195121196121197121198121199121200121201121202121203121204121205121206121207121208121209121210121211121212121213121214121215121216121217121218121219121220121221121222121223121224121225121226121227121228121229121230121231121232121233121234121235121236121237121238121239121240121241121242121243121244121245121246121247121248121249121250121251121252121253121254121255121256121257121258121259121260121261121262121263121264121265121266121267121268121269121270121271121272121273121274121275121276121277121278121279121280121281121282121283121284121285121286121287121288121289121290121291121292121293121294121295121296121297121298121299121300121301121302121303121304121305121306121307121308121309121310121311121312121313121314121315121316121317121318121319121320121321121322121323121324121325121326121327121328121329121330121331121332121333121334121335121336121337121338121339121340121341121342121343121344121345121346121347121348121349121350121351121352121353121354121355121356121357121358121359121360121361121362121363121364121365121366121367121368121369121370121371121372121373121374121375121376121377121378121379121380121381121382121383121384121385121386121387121388121389121390121391121392121393121394121395121396121397121398121399121400121401121402121403121404121405121406121407121408121409121410121411121412121413121414121415121416121417121418121419121420121421121422121423121424121425121426121427121428121429121430121431121432121433121434121435121436121437121438121439121440121441121442121443121444121445121446121447121448121449121450121451121452121453121454121455121456121457121458121459121460121461121462121463121464121465121466121467121468121469121470121471121472121473121474121475121476121477121478121479121480121481121482121483121484121485121486121487121488121489121490121491121492121493121494121495121496121497121498121499121500121501121502121503121504121505121506121507121508121509121510121511121512121513121514121515121516121517121518121519121520121521121522121523121524121525121526121527121528121529121530121531121532121533121534121535121536121537121538121539121540121541121542121543121544121545121546121547121548121549121550121551121552121553121554121555121556121557121558121559121560121561121562121563121564121565121566121567121568121569121570121571121572121573121574121575121576121577121578121579121580121581121582121583121584121585121586121587121588121589121590121591121592121593121594121595121596121597121598121599121600121601121602121603121604121605121606121607121608121609121610121611121612121613121614121615121616121617121618121619121620121621121622121623121624121625121626121627121628121629121630121631121632121633121634121635121636121637121638121639121640121641121642121643121644121645121646121647121648121649121650121651121652121653121654121655121656121657121658121659121660121661121662121663121664121665121666121667121668121669121670121671121672121673121674121675121676121677121678121679121680121681121682121683121684121685121686121687121688121689121690121691121692121693121694121695121696121697121698121699121700121701121702121703121704121705121706121707121708121709121710121711121712121713121714121715121716121717121718121719121720121721121722121723121724121725121726121727121728121729121730121731121732121733121734121735121736121737121738121739121740121741121742121743121744121745121746121747121748121749121750121751121752121753121754121755121756121757121758121759121760121761121762121763121764121765121766121767121768121769121770121771121772121773121774121775121776121777121778121779121780121781121782121783121784121785121786121787121788121789121790121791121792121793121794121795121796121797121798121799121800121801121802121803121804121805121806121807121808121809121810121811121812121813121814121815121816121817121818121819121820121821121822121823121824121825121826121827121828121829121830121831121832121833121834121835121836121837121838121839121840121841121842121843121844121845121846121847121848121849121850121851121852121853121854121855121856121857121858121859121860121861121862121863121864121865121866121867121868121869121870121871121872121873121874121875121876121877121878121879121880121881121882121883121884121885121886121887121888121889121890121891121892121893121894121895121896121897121898121899121900121901121902121903121904121905121906121907121908121909121910121911121912121913121914121915121916121917121918121919121920121921121922121923121924121925121926121927121928121929121930121931121932121933121934121935121936121937121938121939121940121941121942121943121944121945121946121947121948121949121950121951121952121953121954121955121956121957121958121959121960121961121962121963121964121965121966121967121968121969121970121971121972121973121974121975121976121977121978121979121980121981121982121983121984121985121986121987121988121989121990121991121992121993121994121995121996121997121998121999122000122001122002122003122004122005122006122007122008122009122010122011122012122013122014122015122016122017122018122019122020122021122022122023122024122025122026122027122028122029122030122031122032122033122034122035122036122037122038122039122040122041122042122043122044122045122046122047122048122049122050122051122052122053122054122055122056122057122058122059122060122061122062122063122064122065122066122067122068122069122070122071122072122073122074122075122076122077122078122079122080122081122082122083122084122085122086122087122088122089122090122091122092122093122094122095122096122097122098122099122100122101122102122103122104122105122106122107122108122109122110122111122112122113122114122115122116122117122118122119122120122121122122122123122124122125122126122127122128122129122130122131122132122133122134122135122136122137122138122139122140122141122142122143122144122145122146122147122148122149122150122151122152122153122154122155122156122157122158122159122160122161122162122163122164122165122166122167122168122169122170122171122172122173122174122175122176122177122178122179122180122181122182122183122184122185122186122187122188122189122190122191122192122193122194122195122196122197122198122199122200122201122202122203122204122205122206122207122208122209122210122211122212122213122214122215122216122217122218122219122220122221122222122223122224122225122226122227122228122229122230122231122232122233122234122235122236122237122238122239122240122241122242122243122244122245122246122247122248122249122250122251122252122253122254122255122256122257122258122259122260122261122262122263122264122265122266122267122268122269122270122271122272122273122274122275122276122277122278122279122280122281122282122283122284122285122286122287122288122289122290122291122292122293122294122295122296122297122298122299122300122301122302122303122304122305122306122307122308122309122310122311122312122313122314122315122316122317122318122319122320122321122322122323122324122325122326122327122328122329122330122331122332122333122334122335122336122337122338122339122340122341122342122343122344122345122346122347122348122349122350122351122352122353122354122355122356122357122358122359122360122361122362122363122364122365122366122367122368122369122370122371122372122373122374122375122376122377122378122379122380122381122382122383122384122385122386122387122388122389122390122391122392122393122394122395122396122397122398122399122400122401122402122403122404122405122406122407122408122409122410122411122412122413122414122415122416122417122418122419122420122421122422122423122424122425122426122427122428122429122430122431122432122433122434122435122436122437122438122439122440122441122442122443122444122445122446122447122448122449122450122451122452122453122454122455122456122457122458122459122460122461122462122463122464122465122466122467122468122469122470122471122472122473122474122475122476122477122478122479122480122481122482122483122484122485122486122487122488122489122490122491122492122493122494122495122496122497122498122499122500122501122502122503122504122505122506122507122508122509122510122511122512122513122514122515122516122517122518122519122520122521122522122523122524122525122526122527122528122529122530122531122532122533122534122535122536122537122538122539122540122541122542122543122544122545122546122547122548122549122550122551122552122553122554122555122556122557122558122559122560122561122562122563122564122565122566122567122568122569122570122571122572122573122574122575122576122577122578122579122580122581122582122583122584122585122586122587122588122589122590122591122592122593122594122595122596122597122598122599122600122601122602122603122604122605122606122607122608122609122610122611122612122613122614122615122616122617122618122619122620122621122622122623122624122625122626122627122628122629122630122631122632122633122634122635122636122637122638122639122640122641122642122643122644122645122646122647122648122649122650122651122652122653122654122655122656122657122658122659122660122661122662122663122664122665122666122667122668122669122670122671122672122673122674122675122676122677122678122679122680122681122682122683122684122685122686122687122688122689122690122691122692122693122694122695122696122697122698122699122700122701122702122703122704122705122706122707122708122709122710122711122712122713122714122715122716122717122718122719122720122721122722122723122724122725122726122727122728122729122730122731122732122733122734122735122736122737122738122739122740122741122742122743122744122745122746122747122748122749122750122751122752122753122754122755122756122757122758122759122760122761122762122763122764122765122766122767122768122769122770122771122772122773122774122775122776122777122778122779122780122781122782122783122784122785122786122787122788122789122790122791122792122793122794122795122796122797122798122799122800122801122802122803122804122805122806122807122808122809122810122811122812122813122814122815122816122817122818122819122820122821122822122823122824122825122826122827122828122829122830122831122832122833122834122835122836122837122838122839122840122841122842122843122844122845122846122847122848122849122850122851122852122853122854122855122856122857122858122859122860122861122862122863122864122865122866122867122868122869122870122871122872122873122874122875122876122877122878122879122880122881122882122883122884122885122886122887122888122889122890122891122892122893122894122895122896122897122898122899122900122901122902122903122904122905122906122907122908122909122910122911122912122913122914122915122916122917122918122919122920122921122922122923122924122925122926122927122928122929122930122931122932122933122934122935122936122937122938122939122940122941122942122943122944122945122946122947122948122949122950122951122952122953122954122955122956122957122958122959122960122961122962122963122964122965122966122967122968122969122970122971122972122973122974122975122976122977122978122979122980122981122982122983122984122985122986122987122988122989122990122991122992122993122994122995122996122997122998122999123000123001123002123003123004123005123006123007123008123009123010123011123012123013123014123015123016123017123018123019123020
  1. /*!*
  2. *
  3. * Copyright (c) Highsoft AS. All rights reserved.
  4. *
  5. *!*/
  6. import * as globals from "./globals.src";
  7. /**
  8. * Formatter callback for the accessibility announcement.
  9. *
  10. * @param updatedSeries
  11. * Array of all series that received updates. If an announcement is
  12. * already queued, the series that received updates for that announcement
  13. * are also included in this array.
  14. *
  15. * @param addedSeries
  16. * This is provided if Highcharts.Chart#addSeries was called, and there
  17. * is a new series. In that case, this argument is a reference to the new
  18. * series.
  19. *
  20. * @param addedPoint
  21. * This is provided if Highcharts.Series#addPoint was called, and there
  22. * is a new point. In that case, this argument is a reference to the new
  23. * point.
  24. *
  25. * @return The function should return a string with the text to announce to the
  26. * user. Return empty string to not announce anything. Return `false` to
  27. * use the default announcement format.
  28. */
  29. export type AccessibilityAnnouncementFormatter = (updatedSeries: Array<Series>, addedSeries?: Series, addedPoint?: Point) => (false|string);
  30. /**
  31. * The horizontal alignment of an element.
  32. */
  33. export type AlignValue = ("center"|"left"|"right");
  34. /**
  35. * Creates a frame for the animated SVG element.
  36. *
  37. * @param this
  38. * The SVG element to animate.
  39. */
  40. export type AnimationStepCallbackFunction = (this: SVGElement) => void;
  41. /**
  42. * Callback to modify annotation's possitioner controls.
  43. */
  44. export type AnnotationControlPointPositionerFunction = (this: AnnotationControlPoint, target: AnnotationControllable) => PositionObject;
  45. /**
  46. * Possible directions for draggable annotations. An empty string (`''`) makes
  47. * the annotation undraggable.
  48. */
  49. export type AnnotationDraggableValue = (''|'x'|'xy'|'y');
  50. export type AxisEventCallbackFunction = (this: Axis) => void;
  51. export type AxisExtremesTriggerValue = ("navigator"|"pan"|"scrollbar"|"zoom"|"rangeSelectorButton"|"rangeSelectorInput"|"traverseUpButton");
  52. export type AxisLabelsFormatterCallbackFunction = (this: AxisLabelsFormatterContextObject<number>, that: AxisLabelsFormatterContextObject<string>) => string;
  53. /**
  54. * Options for axes.
  55. */
  56. export type AxisOptions = (XAxisOptions|YAxisOptions|ZAxisOptions);
  57. /**
  58. * Options for plot band labels on axes.
  59. */
  60. export type AxisPlotBandsLabelOptions = (XAxisPlotBandsLabelOptions|YAxisPlotBandsLabelOptions|ZAxisPlotBandsLabelOptions);
  61. /**
  62. * Options for plot bands on axes.
  63. */
  64. export type AxisPlotBandsOptions = (XAxisPlotBandsOptions|YAxisPlotBandsOptions|ZAxisPlotBandsOptions);
  65. /**
  66. * Options for plot line labels on axes.
  67. */
  68. export type AxisPlotLinesLabelOptions = (XAxisPlotLinesLabelOptions|YAxisPlotLinesLabelOptions|ZAxisPlotLinesLabelOptions);
  69. /**
  70. * Options for plot lines on axes.
  71. */
  72. export type AxisPlotLinesOptions = (XAxisPlotLinesOptions|YAxisPlotLinesOptions|ZAxisPlotLinesOptions);
  73. export type AxisPointBreakEventCallbackFunction = (this: Axis, evt: AxisPointBreakEventObject) => void;
  74. export type AxisSetExtremesEventCallbackFunction = (this: Axis, evt: AxisSetExtremesEventObject) => void;
  75. export type AxisTickPositionerCallbackFunction = (this: Axis) => AxisTickPositionsArray;
  76. export type AxisTitleAlignValue = ("high"|"low"|"middle");
  77. export type AxisTitleOptions = (XAxisTitleOptions|YAxisTitleOptions|ZAxisTitleOptions);
  78. export type AxisTypeValue = ("category"|"datetime"|"linear"|"logarithmic"|"treegrid");
  79. export type BubbleSizeByValue = ("area"|"width");
  80. export type ButtonRelativeToValue = ("plotBox"|"spacingBox");
  81. /**
  82. * Gets fired when a series is added to the chart after load time, using the
  83. * `addSeries` method. Returning `false` prevents the series from being added.
  84. *
  85. * @param this
  86. * The chart on which the event occured.
  87. *
  88. * @param event
  89. * The event that occured.
  90. */
  91. export type ChartAddSeriesCallbackFunction = (this: Chart, event: ChartAddSeriesEventObject) => void;
  92. /**
  93. * Callback for chart constructors.
  94. *
  95. * @param chart
  96. * Created chart.
  97. */
  98. export type ChartCallbackFunction = (chart: Chart) => void;
  99. /**
  100. * Gets fired when clicking on the plot background.
  101. *
  102. * @param this
  103. * The chart on which the event occured.
  104. *
  105. * @param event
  106. * The event that occured.
  107. */
  108. export type ChartClickCallbackFunction = (this: Chart, event: PointerEventObject) => void;
  109. /**
  110. * Gets fired when the chart is finished loading.
  111. *
  112. * @param this
  113. * The chart on which the event occured.
  114. *
  115. * @param event
  116. * The event that occured.
  117. */
  118. export type ChartLoadCallbackFunction = (this: Chart, event: Event) => void;
  119. /**
  120. * Fires when the chart is redrawn, either after a call to `chart.redraw()` or
  121. * after an axis, series or point is modified with the `redraw` option set to
  122. * `true`.
  123. *
  124. * @param this
  125. * The chart on which the event occured.
  126. *
  127. * @param event
  128. * The event that occured.
  129. */
  130. export type ChartRedrawCallbackFunction = (this: Chart, event: Event) => void;
  131. /**
  132. * Gets fired after initial load of the chart (directly after the `load` event),
  133. * and after each redraw (directly after the `redraw` event).
  134. *
  135. * @param this
  136. * The chart on which the event occured.
  137. *
  138. * @param event
  139. * The event that occured.
  140. */
  141. export type ChartRenderCallbackFunction = (this: Chart, event: Event) => void;
  142. /**
  143. * Gets fired when an area of the chart has been selected. The default action
  144. * for the selection event is to zoom the chart to the selected area. It can be
  145. * prevented by calling `event.preventDefault()` or return false.
  146. *
  147. * @param this
  148. * The chart on which the event occured.
  149. *
  150. * @param event
  151. * Event informations
  152. *
  153. * @return Return false to prevent the default action, usually zoom.
  154. */
  155. export type ChartSelectionCallbackFunction = (this: Chart, event: ChartSelectionContextObject) => (boolean|undefined);
  156. /**
  157. * A clipping rectangle that can be applied to one or more SVGElement instances.
  158. * It is instanciated with the SVGRenderer#clipRect function and applied with
  159. * the SVGElement#clip function.
  160. */
  161. export type ClipRectElement = SVGElement;
  162. /**
  163. * Color axis types
  164. */
  165. export type ColorAxisTypeValue = ("linear"|"logarithmic");
  166. /**
  167. * A valid color to be parsed and handled by Highcharts. Highcharts internally
  168. * supports hex colors like `#ffffff`, rgb colors like `rgb(255,255,255)` and
  169. * rgba colors like `rgba(255,255,255,1)`. Other colors may be supported by the
  170. * browsers and displayed correctly, but Highcharts is not able to process them
  171. * and apply concepts like opacity and brightening.
  172. */
  173. export type ColorString = string;
  174. /**
  175. * A valid color type than can be parsed and handled by Highcharts. It can be a
  176. * color string, a gradient object, or a pattern object.
  177. */
  178. export type ColorType = (ColorString|GradientColorObject|PatternObject);
  179. /**
  180. * All possible cursor styles.
  181. */
  182. export type CursorValue = ('alias'|'all-scroll'|'auto'|'cell'|'col-resize'|'context-menu'|'copy'|'crosshair'|'default'|'e-resize'|'ew-resize'|'grab'|'grabbing'|'help'|'move'|'n-resize'|'ne-resize'|
  183. 'nesw-resize'|'no-drop'|'none'|'not-allowed'|'ns-resize'|'nw-resize'|'nwse-resize'|'pointer'|'progress'|'row-resize'|'s-resize'|'se-resize'|'sw-resize'|'text'|'vertical-text'|'w-resize'|'wait'|
  184. 'zoom-in'|'zoom-out');
  185. /**
  186. * All possible dash styles.
  187. */
  188. export type DashStyleValue = ('Dash'|'DashDot'|'Dot'|'LongDash'|'LongDashDot'|'LongDashDotDot'|'ShortDash'|'ShortDashDot'|'ShortDashDotDot'|'ShortDot'|'Solid');
  189. /**
  190. * Callback function to modify the CSV before parsing it by the data module.
  191. *
  192. * @param csv
  193. * The CSV to modify.
  194. *
  195. * @return The CSV to parse.
  196. */
  197. export type DataBeforeParseCallbackFunction = (csv: string) => string;
  198. /**
  199. * Callback function that gets called after parsing data.
  200. *
  201. * @param chartOptions
  202. * The chart options that were used.
  203. */
  204. export type DataCompleteCallbackFunction = (chartOptions: Options) => void;
  205. export type DataGroupingApproximationValue = ("average"|"averages"|"close"|"high"|"low"|"open"|"sum");
  206. /**
  207. * Callback JavaScript function to format the data label as a string. Note that
  208. * if a `format` is defined, the format takes precedence and the formatter is
  209. * ignored.
  210. *
  211. * @param this
  212. * Data label context to format
  213. *
  214. * @param options
  215. * API options of the data label
  216. *
  217. * @return Formatted data label text
  218. */
  219. export type DataLabelsFormatterCallbackFunction = (this: PointLabelObject, options: DataLabelsOptions) => (number|string|null|undefined);
  220. /**
  221. * Values for handling data labels that flow outside the plot area.
  222. */
  223. export type DataLabelsOverflowValue = ("allow"|"justify");
  224. /**
  225. * Callback function to parse string representations of dates into JavaScript
  226. * timestamps (milliseconds since 1.1.1970).
  227. *
  228. * @return Timestamp (milliseconds since 1.1.1970) as integer for Date class.
  229. */
  230. export type DataParseDateCallbackFunction = (dateValue: string) => number;
  231. /**
  232. * Callback function to access the parsed columns, the two-dimentional input
  233. * data array directly, before they are interpreted into series data and
  234. * categories.
  235. *
  236. * @param columns
  237. * The parsed columns by the data module.
  238. *
  239. * @return Return `false` to stop completion, or call `this.complete()` to
  240. * continue async.
  241. */
  242. export type DataParsedCallbackFunction = (columns: Array<Array<any>>) => (boolean|undefined);
  243. /**
  244. * Possible types for a data item in a column or row.
  245. */
  246. export type DataValueType = (number|string|null);
  247. /**
  248. * Gets fired when a drilldown point is clicked, before the new series is added.
  249. * Note that when clicking a category label to trigger multiple series
  250. * drilldown, one `drilldown` event is triggered per point in the category.
  251. *
  252. * @param this
  253. * The chart where the event occurs.
  254. *
  255. * @param e
  256. * The drilldown event.
  257. */
  258. export type DrilldownCallbackFunction = (this: Chart, e: DrilldownEventObject) => void;
  259. /**
  260. * This gets fired after all the series have been drilled up. This is especially
  261. * usefull in a chart with multiple drilldown series.
  262. *
  263. * @param this
  264. * The chart where the event occurs.
  265. *
  266. * @param e
  267. * The final drillup event.
  268. */
  269. export type DrillupAllCallbackFunction = (this: Chart, e: DrillupAllEventObject) => void;
  270. /**
  271. * Gets fired when drilling up from a drilldown series.
  272. *
  273. * @param this
  274. * The chart where the event occurs.
  275. *
  276. * @param e
  277. * The drillup event.
  278. */
  279. export type DrillupCallbackFunction = (this: Chart, e: DrillupEventObject) => void;
  280. /**
  281. * The function callback to execute when the event is fired. The `this` context
  282. * contains the instance, that fired the event.
  283. *
  284. * @param eventArguments
  285. * Event arguments.
  286. */
  287. export type EventCallbackFunction<T> = (this: T, eventArguments?: (Event|Dictionary<any>)) => (boolean|void);
  288. /**
  289. * Function callback to execute while data rows are processed for exporting.
  290. * This allows the modification of data rows before processed into the final
  291. * format.
  292. *
  293. * @param this
  294. * Chart context where the event occured.
  295. *
  296. * @param event
  297. * Event object with data rows that can be modified.
  298. */
  299. export type ExportDataCallbackFunction = (this: Chart, event: ExportDataEventObject) => void;
  300. /**
  301. * Gets fired after a chart is printed through the context menu item or the
  302. * Chart.print method.
  303. *
  304. * @param chart
  305. * The chart on which the event occured.
  306. *
  307. * @param event
  308. * The event that occured.
  309. */
  310. export type ExportingAfterPrintCallbackFunction = (chart: Chart, event: Event) => void;
  311. /**
  312. * Gets fired before a chart is printed through the context menu item or the
  313. * Chart.print method.
  314. *
  315. * @param chart
  316. * The chart on which the event occured.
  317. *
  318. * @param event
  319. * The event that occured.
  320. */
  321. export type ExportingBeforePrintCallbackFunction = (chart: Chart, event: Event) => void;
  322. /**
  323. * Function to call if the offline-exporting module fails to export a chart on
  324. * the client side.
  325. *
  326. * @param options
  327. * The exporting options.
  328. *
  329. * @param err
  330. * The error from the module.
  331. */
  332. export type ExportingErrorCallbackFunction = (options: ExportingOptions, err: Error) => void;
  333. /**
  334. * Possible MIME types for exporting.
  335. */
  336. export type ExportingMimeTypeValue = ("application/pdf"|"image/jpeg"|"image/png"|"image/svg+xml");
  337. export type FlagsShapeValue = ("circlepin"|"flag"|"squarepin");
  338. /**
  339. * Formats data as a string. Usually the data is accessible throught the `this`
  340. * keyword.
  341. *
  342. * @param this
  343. * Context to format
  344. *
  345. * @return Formatted text
  346. */
  347. export type FormatterCallbackFunction<T> = (this: T) => string;
  348. /**
  349. * An object of key-value pairs for HTML attributes.
  350. */
  351. export type HTMLAttributes = Dictionary<(boolean|number|string|Function)>;
  352. /**
  353. * An HTML DOM element. The type is a reference to the regular HTMLElement in
  354. * the global scope.
  355. */
  356. export type HTMLDOMElement = HTMLElement;
  357. /**
  358. * Function callback when a cluster is clicked.
  359. *
  360. * @param this
  361. * The point where the event occured.
  362. *
  363. * @param event
  364. * Event arguments.
  365. */
  366. export type MarkerClusterDrillCallbackFunction = (this: Point, event: PointClickEventObject) => void;
  367. /**
  368. * Format a number and return a string based on input settings.
  369. *
  370. * @param number
  371. * The input number to format.
  372. *
  373. * @param decimals
  374. * The amount of decimals. A value of -1 preserves the amount in the
  375. * input number.
  376. *
  377. * @param decimalPoint
  378. * The decimal point, defaults to the one given in the lang options, or a
  379. * dot.
  380. *
  381. * @param thousandsSep
  382. * The thousands separator, defaults to the one given in the lang
  383. * options, or a space character.
  384. *
  385. * @return The formatted number.
  386. */
  387. export type NumberFormatterCallbackFunction = (number: number, decimals: number, decimalPoint?: string, thousandsSep?: string) => string;
  388. /**
  389. * The iterator callback.
  390. *
  391. * @param this
  392. * The context.
  393. *
  394. * @param value
  395. * The property value.
  396. *
  397. * @param key
  398. * The property key.
  399. *
  400. * @param obj
  401. * The object that objectEach is being applied to.
  402. */
  403. export type ObjectEachCallbackFunction<T> = (this: T, value: any, key: string, obj: any) => void;
  404. export type OptionsApproximationValue = ("barnes-hut"|"none");
  405. export type OptionsBoostBlendingValue = ("add"|"darken"|"multiply");
  406. export type OptionsDataClassColorValue = ("category"|"tween");
  407. export type OptionsDateFormatValue = ("dd/mm/YY"|"dd/mm/YYYY"|"mm/dd/YY"|"mm/dd/YYYY"|"YYYY/mm/dd");
  408. export type OptionsDropdownValue = ("always"|"never"|"responsive");
  409. export type OptionsFindNearestPointByValue = ("x"|"xy");
  410. export type OptionsGapUnitValue = ("relative"|"value");
  411. export type OptionsGridLineInterpolationValue = ("circle"|"polygon");
  412. export type OptionsHeaderShapeValue = ("callout"|"square");
  413. export type OptionsIntegrationValue = ("euler"|"verlet");
  414. export type OptionsLandmarkVerbosityValue = ("all"|"disabled"|"one");
  415. export type OptionsLayoutAlgorithmValue = ("squarified"|"strip"|"stripes"|"sliceAndDice");
  416. export type OptionsLayoutStartingDirectionValue = ("horizontal"|"vertical");
  417. export type OptionsLayoutValue = ("horizontal"|"proximate"|"vertical");
  418. export type OptionsLinecapValue = ("round"|"square");
  419. export type OptionsMarkerEndValue = ("arrow"|"none");
  420. export type OptionsMinorTickPositionValue = ("inside"|"outside");
  421. export type OptionsModeValue = ("normal"|"serialize");
  422. export type OptionsOnKeyValue = ("close"|"high"|"low"|"open"|"y");
  423. export type OptionsOperatorValue = ("=="|"==="|">"|">="|"<"|"<=");
  424. export type OptionsOverflowValue = ("allow"|"justify");
  425. export type OptionsPanKeyValue = ("alt"|"ctrl"|"meta"|"shift");
  426. export type OptionsPinchTypeValue = ("x"|"xy"|"y");
  427. export type OptionsPointIntervalUnitValue = ("day"|"month"|"year");
  428. export type OptionsPointValKeyValue = ("close"|"high"|"low"|"open");
  429. export type OptionsPosition3dValue = ("chart"|"flap"|"offset"|"ortho");
  430. export type OptionsRotationModeValue = ("auto"|"circular"|"parallel"|"perpendicular");
  431. export type OptionsRotationOriginValue = ("center"|"end"|"start");
  432. export type OptionsStackingValue = ("normal"|"overlap"|"percent"|"stream");
  433. export type OptionsStepValue = ("center"|"left"|"right");
  434. export type OptionsTextAlignValue = ("center"|"left"|"right");
  435. export type OptionsTickmarkPlacementValue = ("between"|"on");
  436. export type OptionsTickPositionValue = ("inside"|"outside");
  437. export type OptionsTypeValue = ("x"|"xy"|"y");
  438. export type OptionsUnitValue = ("percentage"|"pixels"|"weight");
  439. export type OptionsZoomKeyValue = ("alt"|"ctrl"|"meta"|"shift");
  440. export type OptionsZoomTypeValue = ("x"|"xy"|"y");
  441. export type PaneBackgroundShapeValue = ("arc"|"circle"|"solid");
  442. /**
  443. * The default pathfinder algorithm to use for a chart. It is possible to define
  444. * your own algorithms by adding them to the
  445. * `Highcharts.Pathfinder.prototype.algorithms` object before the chart has been
  446. * created.
  447. *
  448. * The default algorithms are as follows:
  449. *
  450. * `straight`: Draws a straight line between the connecting points. Does not
  451. * avoid other points when drawing.
  452. *
  453. * `simpleConnect`: Finds a path between the points using right angles only.
  454. * Takes only starting/ending points into account, and will not avoid other
  455. * points.
  456. *
  457. * `fastAvoid`: Finds a path between the points using right angles only. Will
  458. * attempt to avoid other points, but its focus is performance over accuracy.
  459. * Works well with less dense datasets.
  460. */
  461. export type PathfinderTypeValue = ("straight"|"fastAvoid"|"simpleConnect"|string);
  462. /**
  463. * Function callback when a series point is clicked. Return false to cancel the
  464. * action.
  465. *
  466. * @param this
  467. * The point where the event occured.
  468. *
  469. * @param event
  470. * Event arguments.
  471. */
  472. export type PointClickCallbackFunction = (this: Point, event: PointClickEventObject) => void;
  473. /**
  474. * Function callback to execute while series points are dragged. Return false to
  475. * stop the default drag action.
  476. *
  477. * @param this
  478. * Point where the event occured.
  479. *
  480. * @param event
  481. * Event arguments.
  482. */
  483. export type PointDragCallbackFunction = (this: Point, event: PointDragEventObject) => void;
  484. /**
  485. * Function callback to execute when a series point is dragged.
  486. *
  487. * @param this
  488. * Point where the event occured.
  489. *
  490. * @param event
  491. * Event arguments.
  492. */
  493. export type PointDragStartCallbackFunction = (this: Point, event: PointDragStartEventObject) => void;
  494. /**
  495. * Function callback to execute when series points are dropped.
  496. *
  497. * @param this
  498. * Point where the event occured.
  499. *
  500. * @param event
  501. * Event arguments.
  502. */
  503. export type PointDropCallbackFunction = (this: Point, event: PointDropEventObject) => void;
  504. /**
  505. * Gets fired when the legend item belonging to a point is clicked. The default
  506. * action is to toggle the visibility of the point. This can be prevented by
  507. * returning `false` or calling `event.preventDefault()`.
  508. *
  509. * @param this
  510. * The point on which the event occured.
  511. *
  512. * @param event
  513. * The event that occured.
  514. */
  515. export type PointLegendItemClickCallbackFunction = (this: Point, event: PointLegendItemClickEventObject) => void;
  516. /**
  517. * Gets fired when the mouse leaves the area close to the point.
  518. *
  519. * @param this
  520. * Point where the event occured.
  521. *
  522. * @param event
  523. * Event that occured.
  524. */
  525. export type PointMouseOutCallbackFunction = (this: Point, event: PointerEvent) => void;
  526. /**
  527. * Gets fired when the mouse enters the area close to the point.
  528. *
  529. * @param this
  530. * Point where the event occured.
  531. *
  532. * @param event
  533. * Event that occured.
  534. */
  535. export type PointMouseOverCallbackFunction = (this: Point, event: Event) => void;
  536. /**
  537. * Possible option types for a data point. Use `null` to indicate a gap.
  538. */
  539. export type PointOptionsType = (number|string|PointOptionsObject|Array<(number|string|null)>|null);
  540. /**
  541. * Gets fired when the point is removed using the `.remove()` method.
  542. *
  543. * @param this
  544. * Point where the event occured.
  545. *
  546. * @param event
  547. * Event that occured.
  548. */
  549. export type PointRemoveCallbackFunction = (this: Point, event: Event) => void;
  550. /**
  551. * Gets fired when the point is selected either programmatically or following a
  552. * click on the point.
  553. *
  554. * @param this
  555. * Point where the event occured.
  556. *
  557. * @param event
  558. * Event that occured.
  559. */
  560. export type PointSelectCallbackFunction = (this: Point, event: PointInteractionEventObject) => void;
  561. /**
  562. * Possible key values for the point state options.
  563. */
  564. export type PointStateValue = ("hover"|"inactive"|"normal"|"select");
  565. /**
  566. * Fires when the point is unselected either programmatically or following a
  567. * click on the point.
  568. *
  569. * @param this
  570. * Point where the event occured.
  571. *
  572. * @param event
  573. * Event that occured.
  574. */
  575. export type PointUnselectCallbackFunction = (this: Point, event: PointInteractionEventObject) => void;
  576. /**
  577. * Gets fired when the point is updated programmatically through the `.update()`
  578. * method.
  579. *
  580. * @param this
  581. * Point where the event occured.
  582. *
  583. * @param event
  584. * Event that occured.
  585. */
  586. export type PointUpdateCallbackFunction = (this: Point, event: PointUpdateEventObject) => void;
  587. /**
  588. * Define the time span for the button
  589. */
  590. export type RangeSelectorButtonTypeValue = ("all"|"day"|"hour"|"millisecond"|"minute"|"month"|"second"|"week"|"year"|"ytd");
  591. /**
  592. * Callback function to react on button clicks.
  593. *
  594. * @param e
  595. * Event arguments.
  596. *
  597. * @param Return
  598. * false to cancel the default button event.
  599. */
  600. export type RangeSelectorClickCallbackFunction = (e: Event, Return: (boolean|undefined)) => void;
  601. /**
  602. * Callback function to parse values entered in the input boxes and return a
  603. * valid JavaScript time as milliseconds since 1970.
  604. *
  605. * @param value
  606. * Input value to parse.
  607. *
  608. * @return Parsed JavaScript time value.
  609. */
  610. export type RangeSelectorParseCallbackFunction = (value: string) => number;
  611. /**
  612. * If a number is given, it defines the pixel length. If a percentage string is
  613. * given, like for example `'50%'`, the setting defines a length relative to a
  614. * base size, for example the size of a container.
  615. */
  616. export type RelativeSize = (number|string);
  617. /**
  618. * A callback function to gain complete control on when the responsive rule
  619. * applies.
  620. *
  621. * @param this
  622. * Chart context.
  623. *
  624. * @return Return `true` if it applies.
  625. */
  626. export type ResponsiveCallbackFunction = (this: Chart) => boolean;
  627. /**
  628. * @param evt
  629. * Mouse click event
  630. */
  631. export type ScreenReaderClickCallbackFunction = (evt: MouseEvent) => void;
  632. /**
  633. * Creates a formatted string for the screen reader module.
  634. *
  635. * @param context
  636. * Context to format
  637. *
  638. * @return Formatted string for the screen reader module.
  639. */
  640. export type ScreenReaderFormatterCallbackFunction<T> = (context: T) => string;
  641. /**
  642. * Function callback when a series has been animated.
  643. *
  644. * @param this
  645. * The series where the event occured.
  646. *
  647. * @param event
  648. * Event arguments.
  649. */
  650. export type SeriesAfterAnimateCallbackFunction = (this: Series, event: SeriesAfterAnimateEventObject) => void;
  651. /**
  652. * Function callback when the checkbox next to the series' name in the legend is
  653. * clicked.
  654. *
  655. * @param this
  656. * The series where the event occured.
  657. *
  658. * @param event
  659. * Event arguments.
  660. */
  661. export type SeriesCheckboxClickCallbackFunction = (this: Series, event: SeriesCheckboxClickEventObject) => void;
  662. /**
  663. * Function callback when a series is clicked. Return false to cancel toogle
  664. * actions.
  665. *
  666. * @param this
  667. * The series where the event occured.
  668. *
  669. * @param event
  670. * Event arguments.
  671. */
  672. export type SeriesClickCallbackFunction = (this: Series, event: SeriesClickEventObject) => void;
  673. /**
  674. * Gets fired when the series is hidden after chart generation time, either by
  675. * clicking the legend item or by calling `.hide()`.
  676. *
  677. * @param this
  678. * The series where the event occured.
  679. *
  680. * @param event
  681. * The event that occured.
  682. */
  683. export type SeriesHideCallbackFunction = (this: Series, event: Event) => void;
  684. /**
  685. * Gets fired when the legend item belonging to a series is clicked. The default
  686. * action is to toggle the visibility of the series. This can be prevented by
  687. * returning `false` or calling `event.preventDefault()`.
  688. *
  689. * @param this
  690. * The series where the event occured.
  691. *
  692. * @param event
  693. * The event that occured.
  694. */
  695. export type SeriesLegendItemClickCallbackFunction = (this: Series, event: SeriesLegendItemClickEventObject) => void;
  696. /**
  697. * The SVG value used for the `stroke-linecap` and `stroke-linejoin` of a line
  698. * graph.
  699. */
  700. export type SeriesLinecapValue = ("butt"|"round"|"square"|string);
  701. /**
  702. * Gets fired when the mouse leaves the graph.
  703. *
  704. * @param this
  705. * Series where the event occured.
  706. *
  707. * @param event
  708. * Event that occured.
  709. */
  710. export type SeriesMouseOutCallbackFunction = (this: Series, event: PointerEvent) => void;
  711. /**
  712. * Gets fired when the mouse enters the graph.
  713. *
  714. * @param this
  715. * Series where the event occured.
  716. *
  717. * @param event
  718. * Event that occured.
  719. */
  720. export type SeriesMouseOverCallbackFunction = (this: Series, event: PointerEvent) => void;
  721. /**
  722. * Formatter callback function.
  723. *
  724. * @param this
  725. * Data label context to format
  726. *
  727. * @return Formatted data label text
  728. */
  729. export type SeriesNetworkgraphDataLabelsFormatterCallbackFunction = (this: (PointLabelObject|SeriesNetworkgraphDataLabelsFormatterContextObject)) => string;
  730. /**
  731. * The possible types of series options.
  732. */
  733. export type SeriesOptionsType = SeriesOptionsRegistry[keyof SeriesOptionsRegistry];
  734. /**
  735. * Layout value for the child nodes in an organization chart. If `hanging`, this
  736. * node's children will hang below their parent, allowing a tighter packing of
  737. * nodes in the diagram.
  738. */
  739. export type SeriesOrganizationNodesLayoutValue = ("hanging"|"normal");
  740. /**
  741. * Formatter callback function.
  742. *
  743. * @param this
  744. * Data label context to format
  745. *
  746. * @return Formatted data label text
  747. */
  748. export type SeriesPackedBubbleDataLabelsFormatterCallbackFunction = (this: SeriesPackedBubbleDataLabelsFormatterContextObject) => string;
  749. /**
  750. * Formatter callback function.
  751. *
  752. * @param this
  753. * Data label context to format
  754. *
  755. * @return Formatted data label text
  756. */
  757. export type SeriesSankeyDataLabelsFormatterCallbackFunction = (this: (PointLabelObject|SeriesSankeyDataLabelsFormatterContextObject)) => (string|undefined);
  758. /**
  759. * Gets fired when the series is shown after chart generation time, either by
  760. * clicking the legend item or by calling `.show()`.
  761. *
  762. * @param this
  763. * Series where the event occured.
  764. *
  765. * @param event
  766. * Event that occured.
  767. */
  768. export type SeriesShowCallbackFunction = (this: Series, event: Event) => void;
  769. /**
  770. * Possible key values for the series state options.
  771. */
  772. export type SeriesStateValue = ("hover"|"inactive"|"normal"|"select");
  773. /**
  774. * An SVG DOM element. The type is a reference to the regular SVGElement in the
  775. * global scope.
  776. */
  777. export type SVGDOMElement = globals.GlobalSVGElement;
  778. /**
  779. * Array of path commands, that will go into the `d` attribute of an SVG
  780. * element.
  781. */
  782. export type SVGPathArray = Array<(Array<SVGPathCommand>|[SVGPathCommand, number]|[SVGPathCommand, number, number]|[SVGPathCommand, number, number, number, number]|[SVGPathCommand, number, number,
  783. number, number, number, number]|[SVGPathCommand, number, number, number, number, number, number, number])>;
  784. /**
  785. * Possible path commands in an SVG path array. Valid values are `A`, `C`, `H`,
  786. * `L`, `M`, `Q`, `S`, `T`, `V`, `Z`.
  787. */
  788. export type SVGPathCommand = ("a"|"c"|"h"|"l"|"m"|"q"|"s"|"t"|"v"|"z"|"A"|"C"|"H"|"L"|"M"|"Q"|"S"|"T"|"V"|"Z");
  789. /**
  790. * Can be one of `arc`, `callout`, `circle`, `diamond`, `square`, `triangle`,
  791. * and `triangle-down`. Symbols are used internally for point markers, button
  792. * and label borders and backgrounds, or custom shapes. Extendable by adding to
  793. * SVGRenderer#symbols.
  794. */
  795. export type SymbolKeyValue = ("arc"|"callout"|"circle"|"diamond"|"square"|"triangle"|"triangle-down");
  796. export type TilemapShapeValue = ("circle"|"diamond"|"hexagon"|"square");
  797. /**
  798. * Function of an additional date format specifier.
  799. *
  800. * @param timestamp
  801. * The time to format.
  802. *
  803. * @return The formatted portion of the date.
  804. */
  805. export type TimeFormatCallbackFunction = (timestamp: number) => string;
  806. /**
  807. * Callback JavaScript function to format the data label as a string. Note that
  808. * if a `format` is defined, the format takes precedence and the formatter is
  809. * ignored.
  810. *
  811. * @param this
  812. * Data label context to format
  813. *
  814. * @return Formatted data label text
  815. */
  816. export type TimelineDataLabelsFormatterCallbackFunction = (this: (PointLabelObject|TimelineDataLabelsFormatterContextObject)) => (number|string|null|undefined);
  817. /**
  818. * Time units used in `Time.get` and `Time.set`
  819. */
  820. export type TimeUnitValue = ("Date"|"Day"|"FullYear"|"Hours"|"Milliseconds"|"Minutes"|"Month"|"Seconds");
  821. /**
  822. * A callback to return the time zone offset for a given datetime. It takes the
  823. * timestamp in terms of milliseconds since January 1 1970, and returns the
  824. * timezone offset in minutes. This provides a hook for drawing time based
  825. * charts in specific time zones using their local DST crossover dates, with the
  826. * help of external libraries.
  827. *
  828. * @param timestamp
  829. * Timestamp in terms of milliseconds since January 1 1970.
  830. *
  831. * @return Timezone offset in minutes.
  832. */
  833. export type TimezoneOffsetCallbackFunction = (timestamp: number) => number;
  834. /**
  835. * Callback function to format the text of the tooltip from scratch.
  836. *
  837. * In case of single or shared tooltips, a string should be be returned. In case
  838. * of splitted tooltips, it should return an array where the first item is the
  839. * header, and subsequent items are mapped to the points. Return `false` to
  840. * disable tooltip for a specific point on series.
  841. *
  842. * @param this
  843. * Context to format
  844. *
  845. * @param tooltip
  846. * The tooltip instance
  847. *
  848. * @return Formatted text or false
  849. */
  850. export type TooltipFormatterCallbackFunction = (this: TooltipFormatterContextObject, tooltip: Tooltip) => (false|string|Array<(string|null|undefined)>|null|undefined);
  851. /**
  852. * A callback function to place the tooltip in a specific position.
  853. *
  854. * @param this
  855. * Tooltip context of the callback.
  856. *
  857. * @param labelWidth
  858. * Width of the tooltip.
  859. *
  860. * @param labelHeight
  861. * Height of the tooltip.
  862. *
  863. * @param point
  864. * Point information for positioning a tooltip.
  865. *
  866. * @return New position for the tooltip.
  867. */
  868. export type TooltipPositionerCallbackFunction = (this: Tooltip, labelWidth: number, labelHeight: number, point: TooltipPositionerPointObject) => PositionObject;
  869. export type TooltipShapeValue = ("callout"|"circle"|"square");
  870. export type VariablePieSizeByValue = ("area"|"radius");
  871. /**
  872. * The vertical alignment of an element.
  873. */
  874. export type VerticalAlignValue = ("bottom"|"middle"|"top");
  875. /**
  876. * Proceed function to call original (wrapped) function.
  877. *
  878. * @param arg1
  879. * Optional argument. Without any arguments defaults to first argument of
  880. * the wrapping function.
  881. *
  882. * @param arg2
  883. * Optional argument. Without any arguments defaults to second argument
  884. * of the wrapping function.
  885. *
  886. * @param arg3
  887. * Optional argument. Without any arguments defaults to third argument of
  888. * the wrapping function.
  889. *
  890. * @return Return value of the original function.
  891. */
  892. export type WrapProceedFunction = (arg1?: any, arg2?: any, arg3?: any) => any;
  893. /**
  894. * Formatter function for the text of a crosshair label.
  895. *
  896. * @param this
  897. * Axis context
  898. *
  899. * @param value
  900. * Y value of the data point
  901. */
  902. export type XAxisCrosshairLabelFormatterCallbackFunction = (this: Axis, value: number) => string;
  903. /**
  904. * (Highcharts, Highstock, Highmaps, Gantt) Options for announcing new data to
  905. * screen reader users. Useful for dynamic data applications and drilldown.
  906. *
  907. * Keep in mind that frequent announcements will not be useful to users, as they
  908. * won't have time to explore the new data. For these applications, consider
  909. * making snapshots of the data accessible, and do the announcements in batches.
  910. */
  911. export interface AccessibilityAnnounceNewDataOptionsObject {
  912. /**
  913. * (Highcharts, Highstock, Highmaps, Gantt) Optional formatter callback for
  914. * the announcement. Receives up to three arguments. The first argument is
  915. * always an array of all series that received updates. If an announcement
  916. * is already queued, the series that received updates for that announcement
  917. * are also included in this array. The second argument is provided if
  918. * `chart.addSeries` was called, and there is a new series. In that case,
  919. * this argument is a reference to the new series. The third argument,
  920. * similarly, is provided if `series.addPoint` was called, and there is a
  921. * new point. In that case, this argument is a reference to the new point.
  922. *
  923. * The function should return a string with the text to announce to the
  924. * user. Return empty string to not announce anything. Return `false` to use
  925. * the default announcement format.
  926. */
  927. announcementFormatter?: AccessibilityAnnouncementFormatter;
  928. /**
  929. * (Highcharts, Highstock, Highmaps, Gantt) Enable announcing new data to
  930. * screen reader users
  931. */
  932. enabled?: boolean;
  933. /**
  934. * (Highcharts, Highstock, Highmaps, Gantt) Choose whether or not the
  935. * announcements should interrupt the screen reader. If not enabled, the
  936. * user will be notified once idle. It is recommended not to enable this
  937. * setting unless there is a specific reason to do so.
  938. */
  939. interruptUser?: boolean;
  940. /**
  941. * (Highcharts, Highstock, Highmaps, Gantt) Minimum interval between
  942. * announcements in milliseconds. If new data arrives before this amount of
  943. * time has passed, it is queued for announcement. If another new data event
  944. * happens while an announcement is queued, the queued announcement is
  945. * dropped, and the latest announcement is queued instead. Set to 0 to allow
  946. * all announcements, but be warned that frequent announcements are
  947. * disturbing to users.
  948. */
  949. minAnnounceInterval?: number;
  950. }
  951. /**
  952. * (Highcharts, Highstock, Highmaps, Gantt) Options for configuring
  953. * accessibility for the chart. Requires the accessibility module to be loaded.
  954. * For a description of the module and information on its features, see
  955. * Highcharts Accessibility.
  956. */
  957. export interface AccessibilityOptions {
  958. /**
  959. * (Highcharts, Highstock, Highmaps, Gantt) Options for announcing new data
  960. * to screen reader users. Useful for dynamic data applications and
  961. * drilldown.
  962. *
  963. * Keep in mind that frequent announcements will not be useful to users, as
  964. * they won't have time to explore the new data. For these applications,
  965. * consider making snapshots of the data accessible, and do the
  966. * announcements in batches.
  967. */
  968. announceNewData?: AccessibilityAnnounceNewDataOptionsObject;
  969. /**
  970. * (Highcharts, Highstock, Highmaps, Gantt) A hook for adding custom
  971. * components to the accessibility module. Should be an object mapping
  972. * component names to instances of classes inheriting from the
  973. * Highcharts.AccessibilityComponent base class. Remember to add the
  974. * component to the keyboardNavigation.order for the keyboard navigation to
  975. * be usable.
  976. */
  977. customComponents?: any;
  978. /**
  979. * (Highcharts, Highstock, Highmaps, Gantt) A text description of the chart.
  980. *
  981. * **Note: Prefer using linkedDescription or caption instead.**
  982. *
  983. * If the Accessibility module is loaded, this option is included by default
  984. * as a long description of the chart in the hidden screen reader
  985. * information region.
  986. *
  987. * Note: Since Highcharts now supports captions and linked descriptions, it
  988. * is preferred to define the description using those methods, as a visible
  989. * caption/description benefits all users. If the
  990. * `accessibility.description` option is defined, the linked description is
  991. * ignored, and the caption is hidden from screen reader users.
  992. */
  993. description?: string;
  994. /**
  995. * (Highcharts, Highstock, Highmaps, Gantt) Enable accessibility
  996. * functionality for the chart.
  997. */
  998. enabled?: boolean;
  999. /**
  1000. * (Highcharts, Highstock, Highmaps, Gantt) Theme to apply to the chart when
  1001. * Windows High Contrast Mode is detected. By default, a high contrast theme
  1002. * matching the high contrast system system colors is used.
  1003. */
  1004. highContrastTheme?: any;
  1005. /**
  1006. * (Highcharts, Highstock, Highmaps, Gantt) Options for keyboard navigation.
  1007. */
  1008. keyboardNavigation?: KeyboardNavigationOptionsObject;
  1009. /**
  1010. * (Highcharts, Highstock, Highmaps, Gantt) Amount of landmarks/regions to
  1011. * create for screen reader users. More landmarks can make navigation with
  1012. * screen readers easier, but can be distracting if there are lots of charts
  1013. * on the page. Three modes are available:
  1014. *
  1015. * - `all`: Adds regions for all series, legend, menu, information region.
  1016. *
  1017. * - `one`: Adds a single landmark per chart.
  1018. *
  1019. * - `disabled`: No landmarks are added.
  1020. */
  1021. landmarkVerbosity?: OptionsLandmarkVerbosityValue;
  1022. /**
  1023. * (Highcharts, Highstock, Highmaps, Gantt) Link the chart to an HTML
  1024. * element describing the contents of the chart.
  1025. *
  1026. * It is always recommended to describe charts using visible text, to
  1027. * improve SEO as well as accessibility for users with disabilities. This
  1028. * option lets an HTML element with a description be linked to the chart, so
  1029. * that screen reader users can connect the two.
  1030. *
  1031. * By setting this option to a string, Highcharts runs the string as an HTML
  1032. * selector query on the entire document. If there is only a single match,
  1033. * this element is linked to the chart. The content of the linked element
  1034. * will be included in the chart description for screen reader users.
  1035. *
  1036. * By default, the chart looks for an adjacent sibling element with the
  1037. * `highcharts-description` class.
  1038. *
  1039. * The feature can be disabled by setting the option to an empty string, or
  1040. * overridden by providing the accessibility.description option.
  1041. * Alternatively, the HTML element to link can be passed in directly as an
  1042. * HTML node.
  1043. *
  1044. * If you need the description to be part of the exported image, consider
  1045. * using the caption feature.
  1046. *
  1047. * If you need the description to be hidden visually, use the
  1048. * accessibility.description option.
  1049. */
  1050. linkedDescription?: (string|HTMLDOMElement);
  1051. /**
  1052. * (Highcharts, Highstock, Highmaps, Gantt) Options for descriptions of
  1053. * individual data points.
  1054. */
  1055. point?: AccessibilityPointOptions;
  1056. /**
  1057. * (Highcharts, Highstock, Highmaps, Gantt) Accessibility options for the
  1058. * screen reader information sections added before and after the chart.
  1059. */
  1060. screenReaderSection?: AccessibilityScreenReaderSectionOptions;
  1061. /**
  1062. * (Highcharts, Highstock, Highmaps, Gantt) Accessibility options global to
  1063. * all data series. Individual series can also have specific accessibility
  1064. * options set.
  1065. */
  1066. series?: AccessibilitySeriesOptions;
  1067. /**
  1068. * (Highcharts, Highstock, Highmaps, Gantt) A text description of the chart
  1069. * type.
  1070. *
  1071. * If the Accessibility module is loaded, this will be included in the
  1072. * description of the chart in the screen reader information region.
  1073. *
  1074. * Highcharts will by default attempt to guess the chart type, but for more
  1075. * complex charts it is recommended to specify this property for clarity.
  1076. */
  1077. typeDescription?: string;
  1078. }
  1079. /**
  1080. * (Highcharts, Highstock, Highmaps, Gantt) Options for descriptions of
  1081. * individual data points.
  1082. */
  1083. export interface AccessibilityPointOptions {
  1084. /**
  1085. * (Highcharts, Highstock, Highmaps, Gantt) Date format to use for points on
  1086. * datetime axes when describing them to screen reader users.
  1087. *
  1088. * Defaults to the same format as in tooltip.
  1089. *
  1090. * For an overview of the replacement codes, see dateFormat.
  1091. */
  1092. dateFormat?: string;
  1093. /**
  1094. * (Highcharts, Highstock, Highmaps, Gantt) Formatter function to determine
  1095. * the date/time format used with points on datetime axes when describing
  1096. * them to screen reader users. Receives one argument, `point`, referring to
  1097. * the point to describe. Should return a date format string compatible with
  1098. * dateFormat.
  1099. */
  1100. dateFormatter?: ScreenReaderFormatterCallbackFunction<Point>;
  1101. /**
  1102. * (Highcharts, Highstock, Highmaps, Gantt) Formatter function to use
  1103. * instead of the default for point descriptions.
  1104. *
  1105. * Receives one argument, `point`, referring to the point to describe.
  1106. * Should return a string with the description of the point for a screen
  1107. * reader user. If `false` is returned, the default formatter will be used
  1108. * for that point.
  1109. *
  1110. * Note: Prefer using accessibility.point.valueDescriptionFormat instead if
  1111. * possible, as default functionality such as describing annotations will be
  1112. * preserved.
  1113. */
  1114. descriptionFormatter?: ScreenReaderFormatterCallbackFunction<Point>;
  1115. /**
  1116. * (Highcharts, Highstock, Highmaps, Gantt) Decimals to use for the values
  1117. * in the point descriptions. Uses tooltip.valueDecimals if not defined.
  1118. */
  1119. valueDecimals?: number;
  1120. /**
  1121. * (Highcharts, Highstock, Highmaps, Gantt) Format to use for describing the
  1122. * values of data points to assistive technology - including screen readers.
  1123. * The point context is available as `{point}`.
  1124. *
  1125. * Additionally, the series name, annotation info, and description added in
  1126. * `point.accessibility.description` is added by default if relevant. To
  1127. * override this, use the accessibility.point.descriptionFormatter option.
  1128. */
  1129. valueDescriptionFormat?: string;
  1130. /**
  1131. * (Highcharts, Highstock, Highmaps, Gantt) Prefix to add to the values in
  1132. * the point descriptions. Uses tooltip.valuePrefix if not defined.
  1133. */
  1134. valuePrefix?: string;
  1135. /**
  1136. * (Highcharts, Highstock, Highmaps, Gantt) Suffix to add to the values in
  1137. * the point descriptions. Uses tooltip.valueSuffix if not defined.
  1138. */
  1139. valueSuffix?: string;
  1140. }
  1141. /**
  1142. * (Highcharts, Highstock, Highmaps, Gantt) Accessibility options for the screen
  1143. * reader information sections added before and after the chart.
  1144. */
  1145. export interface AccessibilityScreenReaderSectionOptions {
  1146. /**
  1147. * (Highcharts, Highstock, Highmaps, Gantt) Format for the screen reader
  1148. * information region after the chart. Analogous to beforeChartFormat.
  1149. */
  1150. afterChartFormat?: string;
  1151. /**
  1152. * (Highcharts, Highstock, Highmaps, Gantt) A formatter function to create
  1153. * the HTML contents of the hidden screen reader information region after
  1154. * the chart. Analogous to beforeChartFormatter.
  1155. */
  1156. afterChartFormatter?: ScreenReaderFormatterCallbackFunction<Chart>;
  1157. /**
  1158. * (Highcharts, Highstock, Highmaps, Gantt) Date format to use to describe
  1159. * range of datetime axes.
  1160. *
  1161. * For an overview of the replacement codes, see dateFormat.
  1162. */
  1163. axisRangeDateFormat?: string;
  1164. /**
  1165. * (Highcharts, Highstock, Highmaps, Gantt) Format for the screen reader
  1166. * information region before the chart. Supported HTML tags are `<h1-6>`,
  1167. * `<p>`, `<div>`, `<a>`, `<ul>`, `<ol>`, `<li>`, and `<button>`. Attributes
  1168. * are not supported, except for id on `<div>`, `<a>`, and `<button>`. Id is
  1169. * required on `<a>` and `<button>` in the format `<tag id="abcd">`.
  1170. * Numbers, lower- and uppercase letters, "-" and "#" are valid characters
  1171. * in IDs.
  1172. *
  1173. * The headingTagName is an auto-detected heading (h1-h6) that corresponds
  1174. * to the heading level below the previous heading in the DOM.
  1175. */
  1176. beforeChartFormat?: string;
  1177. /**
  1178. * (Highcharts, Highstock, Highmaps, Gantt) A formatter function to create
  1179. * the HTML contents of the hidden screen reader information region before
  1180. * the chart. Receives one argument, `chart`, referring to the chart object.
  1181. * Should return a string with the HTML content of the region. By default
  1182. * this returns an automatic description of the chart based on
  1183. * beforeChartFormat.
  1184. */
  1185. beforeChartFormatter?: ScreenReaderFormatterCallbackFunction<Chart>;
  1186. /**
  1187. * (Highcharts, Highstock, Highmaps, Gantt) Function to run upon clicking
  1188. * the "Play as sound" button in the screen reader region.
  1189. *
  1190. * By default Highcharts will call the `chart.sonify` function.
  1191. */
  1192. onPlayAsSoundClick?: ScreenReaderClickCallbackFunction;
  1193. /**
  1194. * (Highcharts, Highstock, Highmaps, Gantt) Function to run upon clicking
  1195. * the "View as Data Table" link in the screen reader region.
  1196. *
  1197. * By default Highcharts will insert and set focus to a data table
  1198. * representation of the chart.
  1199. */
  1200. onViewDataTableClick?: ScreenReaderClickCallbackFunction;
  1201. }
  1202. /**
  1203. * (Highcharts, Highstock, Highmaps, Gantt) Accessibility options global to all
  1204. * data series. Individual series can also have specific accessibility options
  1205. * set.
  1206. */
  1207. export interface AccessibilitySeriesOptions {
  1208. /**
  1209. * (Highcharts, Highstock, Highmaps, Gantt) Whether or not to add series
  1210. * descriptions to charts with a single series.
  1211. */
  1212. describeSingleSeries?: boolean;
  1213. /**
  1214. * (Highcharts, Highstock, Highmaps, Gantt) Formatter function to use
  1215. * instead of the default for series descriptions. Receives one argument,
  1216. * `series`, referring to the series to describe. Should return a string
  1217. * with the description of the series for a screen reader user. If `false`
  1218. * is returned, the default formatter will be used for that series.
  1219. */
  1220. descriptionFormatter?: ScreenReaderFormatterCallbackFunction<Series>;
  1221. /**
  1222. * (Highcharts, Highstock, Highmaps, Gantt) When a series contains more
  1223. * points than this, we no longer expose information about individual points
  1224. * to screen readers.
  1225. *
  1226. * Set to `false` to disable.
  1227. */
  1228. pointDescriptionEnabledThreshold?: (boolean|number);
  1229. }
  1230. /**
  1231. * Options to align the element relative to the chart or another box.
  1232. */
  1233. export interface AlignObject {
  1234. /**
  1235. * Horizontal alignment. Can be one of `left`, `center` and `right`.
  1236. */
  1237. align?: AlignValue;
  1238. /**
  1239. * Use the `transform` attribute with translateX and translateY custom
  1240. * attributes to align this elements rather than `x` and `y` attributes.
  1241. */
  1242. alignByTranslate?: boolean;
  1243. /**
  1244. * Vertical alignment. Can be one of `top`, `middle` and `bottom`.
  1245. */
  1246. verticalAlign?: VerticalAlignValue;
  1247. /**
  1248. * Horizontal pixel offset from alignment.
  1249. */
  1250. x?: number;
  1251. /**
  1252. * Vertical pixel offset from alignment.
  1253. */
  1254. y?: number;
  1255. }
  1256. /**
  1257. * An animation configuration. Animation configurations can also be defined as
  1258. * booleans, where `false` turns off animation and `true` defaults to a duration
  1259. * of 500ms and defer of 0ms.
  1260. */
  1261. export interface AnimationOptionsObject {
  1262. /**
  1263. * A callback function to exectute when the animation finishes.
  1264. */
  1265. complete?: Function;
  1266. /**
  1267. * The animation defer in milliseconds.
  1268. */
  1269. defer?: number;
  1270. /**
  1271. * The animation duration in milliseconds.
  1272. */
  1273. duration?: number;
  1274. /**
  1275. * The name of an easing function as defined on the `Math` object.
  1276. */
  1277. easing?: (string|Function);
  1278. /**
  1279. * A callback function to execute on each step of each attribute or CSS
  1280. * property that's being animated. The first argument contains information
  1281. * about the animation and progress.
  1282. */
  1283. step?: Function;
  1284. }
  1285. export interface AnnotationControllable {
  1286. annotation: Annotation;
  1287. chart: Chart;
  1288. collection: string;
  1289. points: Array<Point>;
  1290. }
  1291. /**
  1292. * (Highcharts, Highstock, Highmaps, Gantt) Options for annotation's control
  1293. * points. Each control point inherits options from controlPointOptions object.
  1294. * Options from the controlPointOptions can be overwritten by options in a
  1295. * specific control point.
  1296. */
  1297. export interface AnnotationControlPointOptionsObject {
  1298. positioner?: AnnotationControlPointPositionerFunction;
  1299. }
  1300. /**
  1301. * (Highcharts, Highstock, Highmaps, Gantt) Accessibility options for an
  1302. * annotation label.
  1303. */
  1304. export interface AnnotationLabelAccessibilityOptionsObject {
  1305. /**
  1306. * (Highcharts, Highstock, Highmaps, Gantt) Description of an annotation
  1307. * label for screen readers and other assistive technology.
  1308. */
  1309. description?: string;
  1310. }
  1311. /**
  1312. * (Highcharts, Highstock, Highmaps, Gantt) An array of points for the shape.
  1313. * This option is available for shapes which can use multiple points such as
  1314. * path. A point can be either a point object or a point's id.
  1315. */
  1316. export interface AnnotationMockPointOptionsObject {
  1317. /**
  1318. * (Highcharts, Highstock, Highmaps, Gantt) The x position of the point.
  1319. * Units can be either in axis or chart pixel coordinates.
  1320. */
  1321. x?: number;
  1322. /**
  1323. * (Highcharts, Highstock, Highmaps, Gantt) This number defines which xAxis
  1324. * the point is connected to. It refers to either the axis id or the index
  1325. * of the axis in the xAxis array. If the option is not configured or the
  1326. * axis is not found the point's x coordinate refers to the chart pixels.
  1327. */
  1328. xAxis?: (number|string|null);
  1329. /**
  1330. * (Highcharts, Highstock, Highmaps, Gantt) The y position of the point.
  1331. * Units can be either in axis or chart pixel coordinates.
  1332. */
  1333. y?: number;
  1334. /**
  1335. * (Highcharts, Highstock, Highmaps, Gantt) This number defines which yAxis
  1336. * the point is connected to. It refers to either the axis id or the index
  1337. * of the axis in the yAxis array. If the option is not configured or the
  1338. * axis is not found the point's y coordinate refers to the chart pixels.
  1339. */
  1340. yAxis?: (number|string|null);
  1341. }
  1342. /**
  1343. * (Highcharts, Highstock, Highmaps, Gantt) Enable or disable the initial
  1344. * animation when a series is displayed for the `annotation`. The animation can
  1345. * also be set as a configuration object. Please note that this option only
  1346. * applies to the initial animation. For other animations, see chart.animation
  1347. * and the animation parameter under the API methods. The following properties
  1348. * are supported:
  1349. *
  1350. * - `defer`: The animation delay time in milliseconds.
  1351. */
  1352. export interface AnnotationsAnimationOptions {
  1353. /**
  1354. * (Highcharts, Highstock, Highmaps, Gantt) The animation delay time in
  1355. * milliseconds. Set to `0` renders annotation immediately. As `undefined`
  1356. * inherits defer time from the series.animation.defer.
  1357. */
  1358. defer?: number;
  1359. }
  1360. export interface AnnotationsCrookedLineControlPointOptions {
  1361. events?: any;
  1362. }
  1363. /**
  1364. * (Highstock) Options for annotation's labels. Each label inherits options from
  1365. * the labelOptions object. An option from the labelOptions can be overwritten
  1366. * by config for a specific label.
  1367. */
  1368. export interface AnnotationsCrookedLineLabelOptions {
  1369. /**
  1370. * (Highstock) Accessibility options for an annotation label.
  1371. */
  1372. accessibility?: AnnotationLabelAccessibilityOptionsObject;
  1373. /**
  1374. * (Highstock) The alignment of the annotation's label. If right, the right
  1375. * side of the label should be touching the point.
  1376. */
  1377. align?: AlignValue;
  1378. /**
  1379. * (Highstock) Whether to allow the annotation's labels to overlap. To make
  1380. * the labels less sensitive for overlapping, the can be set to 0.
  1381. */
  1382. allowOverlap?: boolean;
  1383. /**
  1384. * (Highstock) The background color or gradient for the annotation's label.
  1385. */
  1386. backgroundColor?: (ColorString|GradientColorObject|PatternObject);
  1387. /**
  1388. * (Highstock) The border color for the annotation's label.
  1389. */
  1390. borderColor?: ColorString;
  1391. /**
  1392. * (Highstock) The border radius in pixels for the annotaiton's label.
  1393. */
  1394. borderRadius?: number;
  1395. /**
  1396. * (Highstock) The border width in pixels for the annotation's label
  1397. */
  1398. borderWidth?: number;
  1399. /**
  1400. * (Highstock) A class name for styling by CSS.
  1401. */
  1402. className?: string;
  1403. /**
  1404. * (Highstock) Whether to hide the annotation's label that is outside the
  1405. * plot area.
  1406. */
  1407. crop?: boolean;
  1408. /**
  1409. * (Highstock) The label's pixel distance from the point.
  1410. */
  1411. distance?: number;
  1412. /**
  1413. * (Highstock) A format string for the data label.
  1414. */
  1415. format?: string;
  1416. /**
  1417. * (Highstock) Callback JavaScript function to format the annotation's
  1418. * label. Note that if a `format` or `text` are defined, the format or text
  1419. * take precedence and the formatter is ignored. `This` refers to a point
  1420. * object.
  1421. */
  1422. formatter?: FormatterCallbackFunction<Point>;
  1423. /**
  1424. * (Highstock) Whether the annotation is visible in the exported data table.
  1425. */
  1426. includeInDataExport?: boolean;
  1427. /**
  1428. * (Highstock) How to handle the annotation's label that flow outside the
  1429. * plot area. The justify option aligns the label inside the plot area.
  1430. */
  1431. overflow?: OptionsOverflowValue;
  1432. /**
  1433. * (Highstock) When either the borderWidth or the backgroundColor is set,
  1434. * this is the padding within the box.
  1435. */
  1436. padding?: number;
  1437. /**
  1438. * (Highstock) The shadow of the box. The shadow can be an object
  1439. * configuration containing `color`, `offsetX`, `offsetY`, `opacity` and
  1440. * `width`.
  1441. */
  1442. shadow?: (boolean|ShadowOptionsObject);
  1443. /**
  1444. * (Highstock) The name of a symbol to use for the border around the label.
  1445. * Symbols are predefined functions on the Renderer object.
  1446. */
  1447. shape?: string;
  1448. /**
  1449. * (Highstock) Styles for the annotation's label.
  1450. */
  1451. style?: CSSObject;
  1452. /**
  1453. * (Highstock) Alias for the format option.
  1454. */
  1455. text?: string;
  1456. /**
  1457. * (Highstock) Whether to use HTML to render the annotation's label.
  1458. */
  1459. useHTML?: boolean;
  1460. /**
  1461. * (Highstock) The vertical alignment of the annotation's label.
  1462. */
  1463. verticalAlign?: VerticalAlignValue;
  1464. /**
  1465. * (Highstock) The x position offset of the label relative to the point.
  1466. * Note that if a `distance` is defined, the distance takes precedence over
  1467. * `x` and `y` options.
  1468. */
  1469. x?: number;
  1470. /**
  1471. * (Highstock) The y position offset of the label relative to the point.
  1472. * Note that if a `distance` is defined, the distance takes precedence over
  1473. * `x` and `y` options.
  1474. */
  1475. y?: number;
  1476. }
  1477. /**
  1478. * (Highstock) A crooked line annotation.
  1479. */
  1480. export interface AnnotationsCrookedLineOptions {
  1481. controlPointOptions?: AnnotationsCrookedLineControlPointOptions;
  1482. /**
  1483. * (Highstock) Options for annotation's labels. Each label inherits options
  1484. * from the labelOptions object. An option from the labelOptions can be
  1485. * overwritten by config for a specific label.
  1486. */
  1487. labelOptions?: AnnotationsCrookedLineLabelOptions;
  1488. /**
  1489. * (Highstock) Options for annotation's shapes. Each shape inherits options
  1490. * from the shapeOptions object. An option from the shapeOptions can be
  1491. * overwritten by config for a specific shape.
  1492. */
  1493. shapeOptions?: AnnotationsCrookedLineShapeOptions;
  1494. /**
  1495. * (Highstock) Additional options for an annotation with the type.
  1496. */
  1497. typeOptions?: AnnotationsCrookedLineTypeOptions;
  1498. }
  1499. /**
  1500. * (Highstock) Options for annotation's shapes. Each shape inherits options from
  1501. * the shapeOptions object. An option from the shapeOptions can be overwritten
  1502. * by config for a specific shape.
  1503. */
  1504. export interface AnnotationsCrookedLineShapeOptions {
  1505. /**
  1506. * (Highstock) Name of the dash style to use for the shape's stroke.
  1507. */
  1508. dashStyle?: DashStyleValue;
  1509. /**
  1510. * (Highstock) The color of the shape's fill.
  1511. */
  1512. fill?: (ColorString|GradientColorObject|PatternObject);
  1513. /**
  1514. * (Highstock) The height of the shape.
  1515. */
  1516. height?: number;
  1517. /**
  1518. * (Highstock) The radius of the shape.
  1519. */
  1520. r?: number;
  1521. /**
  1522. * (Highstock) Defines additional snapping area around an annotation making
  1523. * this annotation to focus. Defined in pixels.
  1524. */
  1525. snap?: number;
  1526. /**
  1527. * (Highstock) The URL for an image to use as the annotation shape. Note,
  1528. * type has to be set to `'image'`.
  1529. */
  1530. src?: string;
  1531. /**
  1532. * (Highstock) The color of the shape's stroke.
  1533. */
  1534. stroke?: ColorString;
  1535. /**
  1536. * (Highstock) The pixel stroke width of the shape.
  1537. */
  1538. strokeWidth?: number;
  1539. /**
  1540. * (Highstock) The type of the shape, e.g. circle or rectangle.
  1541. */
  1542. type?: string;
  1543. /**
  1544. * (Highstock) The width of the shape.
  1545. */
  1546. width?: number;
  1547. }
  1548. /**
  1549. * (Highstock) Line options.
  1550. */
  1551. export interface AnnotationsCrookedLineTypeLineOptions {
  1552. fill?: string;
  1553. }
  1554. /**
  1555. * (Highstock) Additional options for an annotation with the type.
  1556. */
  1557. export interface AnnotationsCrookedLineTypeOptions {
  1558. /**
  1559. * (Highstock) Line options.
  1560. */
  1561. line?: AnnotationsCrookedLineTypeLineOptions;
  1562. points?: Array<AnnotationsCrookedLineTypePointsOptions>;
  1563. /**
  1564. * (Highstock) This number defines which xAxis the point is connected to. It
  1565. * refers to either the axis id or the index of the axis in the xAxis array.
  1566. */
  1567. xAxis?: number;
  1568. /**
  1569. * (Highstock) This number defines which yAxis the point is connected to. It
  1570. * refers to either the axis id or the index of the axis in the xAxis array.
  1571. */
  1572. yAxis?: number;
  1573. }
  1574. export interface AnnotationsCrookedLineTypePointsOptions {
  1575. controlPoint?: number;
  1576. /**
  1577. * (Highstock) The x position of the point.
  1578. */
  1579. x?: number;
  1580. /**
  1581. * (Highstock) The y position of the point.
  1582. */
  1583. y?: number;
  1584. }
  1585. export interface AnnotationsElliottWaveControlPointOptions {
  1586. events?: any;
  1587. }
  1588. /**
  1589. * (Highstock) Options for annotation's labels. Each label inherits options from
  1590. * the labelOptions object. An option from the labelOptions can be overwritten
  1591. * by config for a specific label.
  1592. */
  1593. export interface AnnotationsElliottWaveLabelOptions {
  1594. /**
  1595. * (Highstock) Accessibility options for an annotation label.
  1596. */
  1597. accessibility?: AnnotationLabelAccessibilityOptionsObject;
  1598. /**
  1599. * (Highstock) The alignment of the annotation's label. If right, the right
  1600. * side of the label should be touching the point.
  1601. */
  1602. align?: string;
  1603. /**
  1604. * (Highstock) Whether to allow the annotation's labels to overlap. To make
  1605. * the labels less sensitive for overlapping, the can be set to 0.
  1606. */
  1607. allowOverlap?: boolean;
  1608. /**
  1609. * (Highstock) The background color or gradient for the annotation's label.
  1610. */
  1611. backgroundColor?: string;
  1612. /**
  1613. * (Highstock) The border color for the annotation's label.
  1614. */
  1615. borderColor?: ColorString;
  1616. /**
  1617. * (Highstock) The border radius in pixels for the annotaiton's label.
  1618. */
  1619. borderRadius?: number;
  1620. /**
  1621. * (Highstock) The border width in pixels for the annotation's label
  1622. */
  1623. borderWidth?: number;
  1624. /**
  1625. * (Highstock) A class name for styling by CSS.
  1626. */
  1627. className?: string;
  1628. /**
  1629. * (Highstock) Whether to hide the annotation's label that is outside the
  1630. * plot area.
  1631. */
  1632. crop?: boolean;
  1633. /**
  1634. * (Highstock) The label's pixel distance from the point.
  1635. */
  1636. distance?: number;
  1637. /**
  1638. * (Highstock) A format string for the data label.
  1639. */
  1640. format?: string;
  1641. /**
  1642. * (Highstock) Callback JavaScript function to format the annotation's
  1643. * label. Note that if a `format` or `text` are defined, the format or text
  1644. * take precedence and the formatter is ignored. `This` refers to a point
  1645. * object.
  1646. */
  1647. formatter?: FormatterCallbackFunction<Point>;
  1648. /**
  1649. * (Highstock) Whether the annotation is visible in the exported data table.
  1650. */
  1651. includeInDataExport?: boolean;
  1652. /**
  1653. * (Highstock) How to handle the annotation's label that flow outside the
  1654. * plot area. The justify option aligns the label inside the plot area.
  1655. */
  1656. overflow?: OptionsOverflowValue;
  1657. /**
  1658. * (Highstock) When either the borderWidth or the backgroundColor is set,
  1659. * this is the padding within the box.
  1660. */
  1661. padding?: number;
  1662. /**
  1663. * (Highstock) The shadow of the box. The shadow can be an object
  1664. * configuration containing `color`, `offsetX`, `offsetY`, `opacity` and
  1665. * `width`.
  1666. */
  1667. shadow?: (boolean|ShadowOptionsObject);
  1668. /**
  1669. * (Highstock) The name of a symbol to use for the border around the label.
  1670. * Symbols are predefined functions on the Renderer object.
  1671. */
  1672. shape?: string;
  1673. /**
  1674. * (Highstock) Styles for the annotation's label.
  1675. */
  1676. style?: CSSObject;
  1677. /**
  1678. * (Highstock) Alias for the format option.
  1679. */
  1680. text?: string;
  1681. type?: string;
  1682. /**
  1683. * (Highstock) Whether to use HTML to render the annotation's label.
  1684. */
  1685. useHTML?: boolean;
  1686. /**
  1687. * (Highstock) The vertical alignment of the annotation's label.
  1688. */
  1689. verticalAlign?: VerticalAlignValue;
  1690. /**
  1691. * (Highstock) The x position offset of the label relative to the point.
  1692. * Note that if a `distance` is defined, the distance takes precedence over
  1693. * `x` and `y` options.
  1694. */
  1695. x?: number;
  1696. /**
  1697. * (Highstock) The y position offset of the label relative to the point.
  1698. * Note that if a `distance` is defined, the distance takes precedence over
  1699. * `x` and `y` options.
  1700. */
  1701. y?: number;
  1702. }
  1703. /**
  1704. * (Highstock) An elliott wave annotation.
  1705. */
  1706. export interface AnnotationsElliottWaveOptions {
  1707. controlPointOptions?: AnnotationsElliottWaveControlPointOptions;
  1708. /**
  1709. * (Highstock) Options for annotation's labels. Each label inherits options
  1710. * from the labelOptions object. An option from the labelOptions can be
  1711. * overwritten by config for a specific label.
  1712. */
  1713. labelOptions?: AnnotationsElliottWaveLabelOptions;
  1714. /**
  1715. * (Highstock) Options for annotation's shapes. Each shape inherits options
  1716. * from the shapeOptions object. An option from the shapeOptions can be
  1717. * overwritten by config for a specific shape.
  1718. */
  1719. shapeOptions?: AnnotationsElliottWaveShapeOptions;
  1720. /**
  1721. * (Highstock) Additional options for an annotation with the type.
  1722. */
  1723. typeOptions?: AnnotationsElliottWaveTypeOptions;
  1724. }
  1725. /**
  1726. * (Highstock) Options for annotation's shapes. Each shape inherits options from
  1727. * the shapeOptions object. An option from the shapeOptions can be overwritten
  1728. * by config for a specific shape.
  1729. */
  1730. export interface AnnotationsElliottWaveShapeOptions {
  1731. /**
  1732. * (Highstock) Name of the dash style to use for the shape's stroke.
  1733. */
  1734. dashStyle?: DashStyleValue;
  1735. /**
  1736. * (Highstock) The color of the shape's fill.
  1737. */
  1738. fill?: (ColorString|GradientColorObject|PatternObject);
  1739. /**
  1740. * (Highstock) The height of the shape.
  1741. */
  1742. height?: number;
  1743. /**
  1744. * (Highstock) The radius of the shape.
  1745. */
  1746. r?: number;
  1747. /**
  1748. * (Highstock) Defines additional snapping area around an annotation making
  1749. * this annotation to focus. Defined in pixels.
  1750. */
  1751. snap?: number;
  1752. /**
  1753. * (Highstock) The URL for an image to use as the annotation shape. Note,
  1754. * type has to be set to `'image'`.
  1755. */
  1756. src?: string;
  1757. /**
  1758. * (Highstock) The color of the shape's stroke.
  1759. */
  1760. stroke?: ColorString;
  1761. /**
  1762. * (Highstock) The pixel stroke width of the shape.
  1763. */
  1764. strokeWidth?: number;
  1765. /**
  1766. * (Highstock) The type of the shape, e.g. circle or rectangle.
  1767. */
  1768. type?: string;
  1769. /**
  1770. * (Highstock) The width of the shape.
  1771. */
  1772. width?: number;
  1773. }
  1774. /**
  1775. * (Highstock) Line options.
  1776. */
  1777. export interface AnnotationsElliottWaveTypeLineOptions {
  1778. fill?: string;
  1779. strokeWidth?: number;
  1780. }
  1781. /**
  1782. * (Highstock) Additional options for an annotation with the type.
  1783. */
  1784. export interface AnnotationsElliottWaveTypeOptions {
  1785. /**
  1786. * (Highstock) Line options.
  1787. */
  1788. line?: AnnotationsElliottWaveTypeLineOptions;
  1789. points?: Array<AnnotationsElliottWaveTypePointsOptions>;
  1790. /**
  1791. * (Highstock) This number defines which xAxis the point is connected to. It
  1792. * refers to either the axis id or the index of the axis in the xAxis array.
  1793. */
  1794. xAxis?: number;
  1795. /**
  1796. * (Highstock) This number defines which yAxis the point is connected to. It
  1797. * refers to either the axis id or the index of the axis in the xAxis array.
  1798. */
  1799. yAxis?: number;
  1800. }
  1801. /**
  1802. * (Highstock) Options for annotation's labels. Each label inherits options from
  1803. * the labelOptions object. An option from the labelOptions can be overwritten
  1804. * by config for a specific label.
  1805. */
  1806. export interface AnnotationsElliottWaveTypePointsLabelOptions {
  1807. /**
  1808. * (Highstock) Accessibility options for an annotation label.
  1809. */
  1810. accessibility?: AnnotationLabelAccessibilityOptionsObject;
  1811. /**
  1812. * (Highstock) The alignment of the annotation's label. If right, the right
  1813. * side of the label should be touching the point.
  1814. */
  1815. align?: AlignValue;
  1816. /**
  1817. * (Highstock) Whether to allow the annotation's labels to overlap. To make
  1818. * the labels less sensitive for overlapping, the can be set to 0.
  1819. */
  1820. allowOverlap?: boolean;
  1821. /**
  1822. * (Highstock) The background color or gradient for the annotation's label.
  1823. */
  1824. backgroundColor?: (ColorString|GradientColorObject|PatternObject);
  1825. /**
  1826. * (Highstock) The border color for the annotation's label.
  1827. */
  1828. borderColor?: ColorString;
  1829. /**
  1830. * (Highstock) The border radius in pixels for the annotaiton's label.
  1831. */
  1832. borderRadius?: number;
  1833. /**
  1834. * (Highstock) The border width in pixels for the annotation's label
  1835. */
  1836. borderWidth?: number;
  1837. /**
  1838. * (Highstock) A class name for styling by CSS.
  1839. */
  1840. className?: string;
  1841. /**
  1842. * (Highstock) Whether to hide the annotation's label that is outside the
  1843. * plot area.
  1844. */
  1845. crop?: boolean;
  1846. /**
  1847. * (Highstock) The label's pixel distance from the point.
  1848. */
  1849. distance?: number;
  1850. /**
  1851. * (Highstock) A format string for the data label.
  1852. */
  1853. format?: string;
  1854. /**
  1855. * (Highstock) Callback JavaScript function to format the annotation's
  1856. * label. Note that if a `format` or `text` are defined, the format or text
  1857. * take precedence and the formatter is ignored. `This` refers to a point
  1858. * object.
  1859. */
  1860. formatter?: FormatterCallbackFunction<Point>;
  1861. /**
  1862. * (Highstock) Whether the annotation is visible in the exported data table.
  1863. */
  1864. includeInDataExport?: boolean;
  1865. /**
  1866. * (Highstock) How to handle the annotation's label that flow outside the
  1867. * plot area. The justify option aligns the label inside the plot area.
  1868. */
  1869. overflow?: OptionsOverflowValue;
  1870. /**
  1871. * (Highstock) When either the borderWidth or the backgroundColor is set,
  1872. * this is the padding within the box.
  1873. */
  1874. padding?: number;
  1875. /**
  1876. * (Highstock) The shadow of the box. The shadow can be an object
  1877. * configuration containing `color`, `offsetX`, `offsetY`, `opacity` and
  1878. * `width`.
  1879. */
  1880. shadow?: (boolean|ShadowOptionsObject);
  1881. /**
  1882. * (Highstock) The name of a symbol to use for the border around the label.
  1883. * Symbols are predefined functions on the Renderer object.
  1884. */
  1885. shape?: string;
  1886. /**
  1887. * (Highstock) Styles for the annotation's label.
  1888. */
  1889. style?: CSSObject;
  1890. /**
  1891. * (Highstock) Alias for the format option.
  1892. */
  1893. text?: string;
  1894. /**
  1895. * (Highstock) Whether to use HTML to render the annotation's label.
  1896. */
  1897. useHTML?: boolean;
  1898. /**
  1899. * (Highstock) The vertical alignment of the annotation's label.
  1900. */
  1901. verticalAlign?: VerticalAlignValue;
  1902. /**
  1903. * (Highstock) The x position offset of the label relative to the point.
  1904. * Note that if a `distance` is defined, the distance takes precedence over
  1905. * `x` and `y` options.
  1906. */
  1907. x?: number;
  1908. /**
  1909. * (Highstock) The y position offset of the label relative to the point.
  1910. * Note that if a `distance` is defined, the distance takes precedence over
  1911. * `x` and `y` options.
  1912. */
  1913. y?: number;
  1914. }
  1915. export interface AnnotationsElliottWaveTypePointsOptions {
  1916. controlPoint?: number;
  1917. /**
  1918. * (Highstock) Options for annotation's labels. Each label inherits options
  1919. * from the labelOptions object. An option from the labelOptions can be
  1920. * overwritten by config for a specific label.
  1921. */
  1922. label?: AnnotationsElliottWaveTypePointsLabelOptions;
  1923. /**
  1924. * (Highstock) The x position of the point.
  1925. */
  1926. x?: number;
  1927. /**
  1928. * (Highstock) The y position of the point.
  1929. */
  1930. y?: number;
  1931. }
  1932. /**
  1933. * (Highcharts, Highstock, Highmaps, Gantt) Events available in annotations.
  1934. */
  1935. export interface AnnotationsEventsOptions {
  1936. /**
  1937. * (Highcharts, Highstock, Highmaps, Gantt) Event callback when annotation
  1938. * is added to the chart.
  1939. */
  1940. add?: EventCallbackFunction<Annotation>;
  1941. /**
  1942. * (Highcharts, Highstock, Highmaps, Gantt) Event callback when annotation
  1943. * is updated (e.g. drag and droppped or resized by control points).
  1944. */
  1945. afterUpdate?: EventCallbackFunction<Annotation>;
  1946. /**
  1947. * (Highcharts, Highstock, Highmaps, Gantt) Event callback when annotation
  1948. * is removed from the chart.
  1949. */
  1950. remove?: EventCallbackFunction<Annotation>;
  1951. }
  1952. export interface AnnotationsFibonacciControlPointOptions {
  1953. events?: any;
  1954. }
  1955. /**
  1956. * (Highstock) Options for annotation's labels. Each label inherits options from
  1957. * the labelOptions object. An option from the labelOptions can be overwritten
  1958. * by config for a specific label.
  1959. */
  1960. export interface AnnotationsFibonacciLabelOptions {
  1961. /**
  1962. * (Highstock) Accessibility options for an annotation label.
  1963. */
  1964. accessibility?: AnnotationLabelAccessibilityOptionsObject;
  1965. /**
  1966. * (Highstock) The alignment of the annotation's label. If right, the right
  1967. * side of the label should be touching the point.
  1968. */
  1969. align?: string;
  1970. /**
  1971. * (Highstock) Whether to allow the annotation's labels to overlap. To make
  1972. * the labels less sensitive for overlapping, the can be set to 0.
  1973. */
  1974. allowOverlap?: boolean;
  1975. /**
  1976. * (Highstock) The background color or gradient for the annotation's label.
  1977. */
  1978. backgroundColor?: string;
  1979. /**
  1980. * (Highstock) The border color for the annotation's label.
  1981. */
  1982. borderColor?: ColorString;
  1983. /**
  1984. * (Highstock) The border radius in pixels for the annotaiton's label.
  1985. */
  1986. borderRadius?: number;
  1987. /**
  1988. * (Highstock) The border width in pixels for the annotation's label
  1989. */
  1990. borderWidth?: number;
  1991. /**
  1992. * (Highstock) A class name for styling by CSS.
  1993. */
  1994. className?: string;
  1995. /**
  1996. * (Highstock) Whether to hide the annotation's label that is outside the
  1997. * plot area.
  1998. */
  1999. crop?: boolean;
  2000. /**
  2001. * (Highstock) The label's pixel distance from the point.
  2002. */
  2003. distance?: number;
  2004. /**
  2005. * (Highstock) A format string for the data label.
  2006. */
  2007. format?: string;
  2008. /**
  2009. * (Highstock) Callback JavaScript function to format the annotation's
  2010. * label. Note that if a `format` or `text` are defined, the format or text
  2011. * take precedence and the formatter is ignored. `This` refers to a point
  2012. * object.
  2013. */
  2014. formatter?: FormatterCallbackFunction<Point>;
  2015. /**
  2016. * (Highstock) Whether the annotation is visible in the exported data table.
  2017. */
  2018. includeInDataExport?: boolean;
  2019. /**
  2020. * (Highstock) How to handle the annotation's label that flow outside the
  2021. * plot area. The justify option aligns the label inside the plot area.
  2022. */
  2023. overflow?: OptionsOverflowValue;
  2024. /**
  2025. * (Highstock) When either the borderWidth or the backgroundColor is set,
  2026. * this is the padding within the box.
  2027. */
  2028. padding?: number;
  2029. /**
  2030. * (Highstock) The shadow of the box. The shadow can be an object
  2031. * configuration containing `color`, `offsetX`, `offsetY`, `opacity` and
  2032. * `width`.
  2033. */
  2034. shadow?: (boolean|ShadowOptionsObject);
  2035. /**
  2036. * (Highstock) The name of a symbol to use for the border around the label.
  2037. * Symbols are predefined functions on the Renderer object.
  2038. */
  2039. shape?: string;
  2040. /**
  2041. * (Highstock) Styles for the annotation's label.
  2042. */
  2043. style?: (AnnotationsFibonacciLabelStyleOptions|CSSObject);
  2044. /**
  2045. * (Highstock) Alias for the format option.
  2046. */
  2047. text?: string;
  2048. /**
  2049. * (Highstock) Whether to use HTML to render the annotation's label.
  2050. */
  2051. useHTML?: boolean;
  2052. /**
  2053. * (Highstock) The vertical alignment of the annotation's label.
  2054. */
  2055. verticalAlign?: string;
  2056. /**
  2057. * (Highstock) The x position offset of the label relative to the point.
  2058. * Note that if a `distance` is defined, the distance takes precedence over
  2059. * `x` and `y` options.
  2060. */
  2061. x?: number;
  2062. /**
  2063. * (Highstock) The y position offset of the label relative to the point.
  2064. * Note that if a `distance` is defined, the distance takes precedence over
  2065. * `x` and `y` options.
  2066. */
  2067. y?: number;
  2068. }
  2069. /**
  2070. * (Highstock) Styles for the annotation's label.
  2071. */
  2072. export interface AnnotationsFibonacciLabelStyleOptions {
  2073. color?: string;
  2074. }
  2075. /**
  2076. * (Highstock) A fibonacci annotation.
  2077. */
  2078. export interface AnnotationsFibonacciOptions {
  2079. controlPointOptions?: AnnotationsFibonacciControlPointOptions;
  2080. /**
  2081. * (Highstock) Options for annotation's labels. Each label inherits options
  2082. * from the labelOptions object. An option from the labelOptions can be
  2083. * overwritten by config for a specific label.
  2084. */
  2085. labelOptions?: AnnotationsFibonacciLabelOptions;
  2086. /**
  2087. * (Highstock) Options for annotation's shapes. Each shape inherits options
  2088. * from the shapeOptions object. An option from the shapeOptions can be
  2089. * overwritten by config for a specific shape.
  2090. */
  2091. shapeOptions?: AnnotationsFibonacciShapeOptions;
  2092. /**
  2093. * (Highstock) Additional options for an annotation with the type.
  2094. */
  2095. typeOptions?: AnnotationsFibonacciTypeOptions;
  2096. }
  2097. /**
  2098. * (Highstock) Options for annotation's shapes. Each shape inherits options from
  2099. * the shapeOptions object. An option from the shapeOptions can be overwritten
  2100. * by config for a specific shape.
  2101. */
  2102. export interface AnnotationsFibonacciShapeOptions {
  2103. /**
  2104. * (Highstock) Name of the dash style to use for the shape's stroke.
  2105. */
  2106. dashStyle?: DashStyleValue;
  2107. /**
  2108. * (Highstock) The color of the shape's fill.
  2109. */
  2110. fill?: (ColorString|GradientColorObject|PatternObject);
  2111. /**
  2112. * (Highstock) The height of the shape.
  2113. */
  2114. height?: number;
  2115. /**
  2116. * (Highstock) The radius of the shape.
  2117. */
  2118. r?: number;
  2119. /**
  2120. * (Highstock) Defines additional snapping area around an annotation making
  2121. * this annotation to focus. Defined in pixels.
  2122. */
  2123. snap?: number;
  2124. /**
  2125. * (Highstock) The URL for an image to use as the annotation shape. Note,
  2126. * type has to be set to `'image'`.
  2127. */
  2128. src?: string;
  2129. /**
  2130. * (Highstock) The color of the shape's stroke.
  2131. */
  2132. stroke?: ColorString;
  2133. /**
  2134. * (Highstock) The pixel stroke width of the shape.
  2135. */
  2136. strokeWidth?: number;
  2137. /**
  2138. * (Highstock) The type of the shape, e.g. circle or rectangle.
  2139. */
  2140. type?: string;
  2141. /**
  2142. * (Highstock) The width of the shape.
  2143. */
  2144. width?: number;
  2145. }
  2146. /**
  2147. * (Highstock) An array with options for the labels.
  2148. */
  2149. export interface AnnotationsFibonacciTypeLabelsOptions {
  2150. /**
  2151. * (Highstock) Accessibility options for an annotation label.
  2152. */
  2153. accessibility?: AnnotationLabelAccessibilityOptionsObject;
  2154. /**
  2155. * (Highstock) The alignment of the annotation's label. If right, the right
  2156. * side of the label should be touching the point.
  2157. */
  2158. align?: AlignValue;
  2159. /**
  2160. * (Highstock) Whether to allow the annotation's labels to overlap. To make
  2161. * the labels less sensitive for overlapping, the can be set to 0.
  2162. */
  2163. allowOverlap?: boolean;
  2164. /**
  2165. * (Highstock) The background color or gradient for the annotation's label.
  2166. */
  2167. backgroundColor?: (ColorString|GradientColorObject|PatternObject);
  2168. /**
  2169. * (Highstock) The border color for the annotation's label.
  2170. */
  2171. borderColor?: ColorString;
  2172. /**
  2173. * (Highstock) The border radius in pixels for the annotaiton's label.
  2174. */
  2175. borderRadius?: number;
  2176. /**
  2177. * (Highstock) The border width in pixels for the annotation's label
  2178. */
  2179. borderWidth?: number;
  2180. /**
  2181. * (Highstock) A class name for styling by CSS.
  2182. */
  2183. className?: string;
  2184. /**
  2185. * (Highstock) Whether to hide the annotation's label that is outside the
  2186. * plot area.
  2187. */
  2188. crop?: boolean;
  2189. /**
  2190. * (Highstock) The label's pixel distance from the point.
  2191. */
  2192. distance?: number;
  2193. /**
  2194. * (Highstock) A format string for the data label.
  2195. */
  2196. format?: string;
  2197. /**
  2198. * (Highstock) Callback JavaScript function to format the annotation's
  2199. * label. Note that if a `format` or `text` are defined, the format or text
  2200. * take precedence and the formatter is ignored. `This` refers to a point
  2201. * object.
  2202. */
  2203. formatter?: FormatterCallbackFunction<Point>;
  2204. /**
  2205. * (Highstock) Whether the annotation is visible in the exported data table.
  2206. */
  2207. includeInDataExport?: boolean;
  2208. /**
  2209. * (Highstock) How to handle the annotation's label that flow outside the
  2210. * plot area. The justify option aligns the label inside the plot area.
  2211. */
  2212. overflow?: OptionsOverflowValue;
  2213. /**
  2214. * (Highstock) When either the borderWidth or the backgroundColor is set,
  2215. * this is the padding within the box.
  2216. */
  2217. padding?: number;
  2218. /**
  2219. * (Highstock) The shadow of the box. The shadow can be an object
  2220. * configuration containing `color`, `offsetX`, `offsetY`, `opacity` and
  2221. * `width`.
  2222. */
  2223. shadow?: (boolean|ShadowOptionsObject);
  2224. /**
  2225. * (Highstock) The name of a symbol to use for the border around the label.
  2226. * Symbols are predefined functions on the Renderer object.
  2227. */
  2228. shape?: string;
  2229. /**
  2230. * (Highstock) Styles for the annotation's label.
  2231. */
  2232. style?: CSSObject;
  2233. /**
  2234. * (Highstock) Alias for the format option.
  2235. */
  2236. text?: string;
  2237. /**
  2238. * (Highstock) Whether to use HTML to render the annotation's label.
  2239. */
  2240. useHTML?: boolean;
  2241. /**
  2242. * (Highstock) The vertical alignment of the annotation's label.
  2243. */
  2244. verticalAlign?: VerticalAlignValue;
  2245. /**
  2246. * (Highstock) The x position offset of the label relative to the point.
  2247. * Note that if a `distance` is defined, the distance takes precedence over
  2248. * `x` and `y` options.
  2249. */
  2250. x?: number;
  2251. /**
  2252. * (Highstock) The y position offset of the label relative to the point.
  2253. * Note that if a `distance` is defined, the distance takes precedence over
  2254. * `x` and `y` options.
  2255. */
  2256. y?: number;
  2257. }
  2258. /**
  2259. * (Highstock) Line options.
  2260. */
  2261. export interface AnnotationsFibonacciTypeLineOptions {
  2262. fill?: string;
  2263. }
  2264. /**
  2265. * (Highstock) Additional options for an annotation with the type.
  2266. */
  2267. export interface AnnotationsFibonacciTypeOptions {
  2268. /**
  2269. * (Highstock) An array of background colors: Default to: (see online
  2270. * documentation for example)
  2271. */
  2272. backgroundColors?: object;
  2273. /**
  2274. * (Highstock) The height of the fibonacci in terms of yAxis.
  2275. */
  2276. height?: number;
  2277. /**
  2278. * (Highstock) An array with options for the labels.
  2279. */
  2280. labels?: Array<AnnotationsFibonacciTypeLabelsOptions>;
  2281. /**
  2282. * (Highstock) Line options.
  2283. */
  2284. line?: AnnotationsFibonacciTypeLineOptions;
  2285. /**
  2286. * (Highstock) The color of line.
  2287. */
  2288. lineColor?: string;
  2289. /**
  2290. * (Highstock) An array of colors for the lines.
  2291. */
  2292. lineColors?: object;
  2293. points?: Array<AnnotationsFibonacciTypePointsOptions>;
  2294. /**
  2295. * (Highstock) This number defines which xAxis the point is connected to. It
  2296. * refers to either the axis id or the index of the axis in the xAxis array.
  2297. */
  2298. xAxis?: number;
  2299. /**
  2300. * (Highstock) This number defines which yAxis the point is connected to. It
  2301. * refers to either the axis id or the index of the axis in the xAxis array.
  2302. */
  2303. yAxis?: number;
  2304. }
  2305. export interface AnnotationsFibonacciTypePointsOptions {
  2306. controlPoint?: number;
  2307. /**
  2308. * (Highstock) The x position of the point.
  2309. */
  2310. x?: number;
  2311. /**
  2312. * (Highstock) The y position of the point.
  2313. */
  2314. y?: number;
  2315. }
  2316. export interface AnnotationsInfinityLineControlPointOptions {
  2317. events?: any;
  2318. }
  2319. /**
  2320. * (Highstock) Options for annotation's labels. Each label inherits options from
  2321. * the labelOptions object. An option from the labelOptions can be overwritten
  2322. * by config for a specific label.
  2323. */
  2324. export interface AnnotationsInfinityLineLabelOptions {
  2325. /**
  2326. * (Highstock) Accessibility options for an annotation label.
  2327. */
  2328. accessibility?: AnnotationLabelAccessibilityOptionsObject;
  2329. /**
  2330. * (Highstock) The alignment of the annotation's label. If right, the right
  2331. * side of the label should be touching the point.
  2332. */
  2333. align?: AlignValue;
  2334. /**
  2335. * (Highstock) Whether to allow the annotation's labels to overlap. To make
  2336. * the labels less sensitive for overlapping, the can be set to 0.
  2337. */
  2338. allowOverlap?: boolean;
  2339. /**
  2340. * (Highstock) The background color or gradient for the annotation's label.
  2341. */
  2342. backgroundColor?: (ColorString|GradientColorObject|PatternObject);
  2343. /**
  2344. * (Highstock) The border color for the annotation's label.
  2345. */
  2346. borderColor?: ColorString;
  2347. /**
  2348. * (Highstock) The border radius in pixels for the annotaiton's label.
  2349. */
  2350. borderRadius?: number;
  2351. /**
  2352. * (Highstock) The border width in pixels for the annotation's label
  2353. */
  2354. borderWidth?: number;
  2355. /**
  2356. * (Highstock) A class name for styling by CSS.
  2357. */
  2358. className?: string;
  2359. /**
  2360. * (Highstock) Whether to hide the annotation's label that is outside the
  2361. * plot area.
  2362. */
  2363. crop?: boolean;
  2364. /**
  2365. * (Highstock) The label's pixel distance from the point.
  2366. */
  2367. distance?: number;
  2368. /**
  2369. * (Highstock) A format string for the data label.
  2370. */
  2371. format?: string;
  2372. /**
  2373. * (Highstock) Callback JavaScript function to format the annotation's
  2374. * label. Note that if a `format` or `text` are defined, the format or text
  2375. * take precedence and the formatter is ignored. `This` refers to a point
  2376. * object.
  2377. */
  2378. formatter?: FormatterCallbackFunction<Point>;
  2379. /**
  2380. * (Highstock) Whether the annotation is visible in the exported data table.
  2381. */
  2382. includeInDataExport?: boolean;
  2383. /**
  2384. * (Highstock) How to handle the annotation's label that flow outside the
  2385. * plot area. The justify option aligns the label inside the plot area.
  2386. */
  2387. overflow?: OptionsOverflowValue;
  2388. /**
  2389. * (Highstock) When either the borderWidth or the backgroundColor is set,
  2390. * this is the padding within the box.
  2391. */
  2392. padding?: number;
  2393. /**
  2394. * (Highstock) The shadow of the box. The shadow can be an object
  2395. * configuration containing `color`, `offsetX`, `offsetY`, `opacity` and
  2396. * `width`.
  2397. */
  2398. shadow?: (boolean|ShadowOptionsObject);
  2399. /**
  2400. * (Highstock) The name of a symbol to use for the border around the label.
  2401. * Symbols are predefined functions on the Renderer object.
  2402. */
  2403. shape?: string;
  2404. /**
  2405. * (Highstock) Styles for the annotation's label.
  2406. */
  2407. style?: CSSObject;
  2408. /**
  2409. * (Highstock) Alias for the format option.
  2410. */
  2411. text?: string;
  2412. /**
  2413. * (Highstock) Whether to use HTML to render the annotation's label.
  2414. */
  2415. useHTML?: boolean;
  2416. /**
  2417. * (Highstock) The vertical alignment of the annotation's label.
  2418. */
  2419. verticalAlign?: VerticalAlignValue;
  2420. /**
  2421. * (Highstock) The x position offset of the label relative to the point.
  2422. * Note that if a `distance` is defined, the distance takes precedence over
  2423. * `x` and `y` options.
  2424. */
  2425. x?: number;
  2426. /**
  2427. * (Highstock) The y position offset of the label relative to the point.
  2428. * Note that if a `distance` is defined, the distance takes precedence over
  2429. * `x` and `y` options.
  2430. */
  2431. y?: number;
  2432. }
  2433. /**
  2434. * (Highstock) An infinity line annotation.
  2435. */
  2436. export interface AnnotationsInfinityLineOptions {
  2437. controlPointOptions?: AnnotationsInfinityLineControlPointOptions;
  2438. /**
  2439. * (Highstock) Options for annotation's labels. Each label inherits options
  2440. * from the labelOptions object. An option from the labelOptions can be
  2441. * overwritten by config for a specific label.
  2442. */
  2443. labelOptions?: AnnotationsInfinityLineLabelOptions;
  2444. /**
  2445. * (Highstock) Options for annotation's shapes. Each shape inherits options
  2446. * from the shapeOptions object. An option from the shapeOptions can be
  2447. * overwritten by config for a specific shape.
  2448. */
  2449. shapeOptions?: AnnotationsInfinityLineShapeOptions;
  2450. /**
  2451. * (Highstock) Additional options for an annotation with the type.
  2452. */
  2453. typeOptions?: AnnotationsInfinityLineTypeOptions;
  2454. }
  2455. /**
  2456. * (Highstock) Options for annotation's shapes. Each shape inherits options from
  2457. * the shapeOptions object. An option from the shapeOptions can be overwritten
  2458. * by config for a specific shape.
  2459. */
  2460. export interface AnnotationsInfinityLineShapeOptions {
  2461. /**
  2462. * (Highstock) Name of the dash style to use for the shape's stroke.
  2463. */
  2464. dashStyle?: DashStyleValue;
  2465. /**
  2466. * (Highstock) The color of the shape's fill.
  2467. */
  2468. fill?: (ColorString|GradientColorObject|PatternObject);
  2469. /**
  2470. * (Highstock) The height of the shape.
  2471. */
  2472. height?: number;
  2473. /**
  2474. * (Highstock) The radius of the shape.
  2475. */
  2476. r?: number;
  2477. /**
  2478. * (Highstock) Defines additional snapping area around an annotation making
  2479. * this annotation to focus. Defined in pixels.
  2480. */
  2481. snap?: number;
  2482. /**
  2483. * (Highstock) The URL for an image to use as the annotation shape. Note,
  2484. * type has to be set to `'image'`.
  2485. */
  2486. src?: string;
  2487. /**
  2488. * (Highstock) The color of the shape's stroke.
  2489. */
  2490. stroke?: ColorString;
  2491. /**
  2492. * (Highstock) The pixel stroke width of the shape.
  2493. */
  2494. strokeWidth?: number;
  2495. /**
  2496. * (Highstock) The type of the shape, e.g. circle or rectangle.
  2497. */
  2498. type?: string;
  2499. /**
  2500. * (Highstock) The width of the shape.
  2501. */
  2502. width?: number;
  2503. }
  2504. /**
  2505. * (Highstock) Line options.
  2506. */
  2507. export interface AnnotationsInfinityLineTypeLineOptions {
  2508. fill?: string;
  2509. }
  2510. /**
  2511. * (Highstock) Additional options for an annotation with the type.
  2512. */
  2513. export interface AnnotationsInfinityLineTypeOptions {
  2514. /**
  2515. * (Highstock) Line options.
  2516. */
  2517. line?: AnnotationsInfinityLineTypeLineOptions;
  2518. points?: Array<AnnotationsInfinityLineTypePointsOptions>;
  2519. /**
  2520. * (Highstock) This number defines which xAxis the point is connected to. It
  2521. * refers to either the axis id or the index of the axis in the xAxis array.
  2522. */
  2523. xAxis?: number;
  2524. /**
  2525. * (Highstock) This number defines which yAxis the point is connected to. It
  2526. * refers to either the axis id or the index of the axis in the xAxis array.
  2527. */
  2528. yAxis?: number;
  2529. }
  2530. export interface AnnotationsInfinityLineTypePointsOptions {
  2531. controlPoint?: number;
  2532. /**
  2533. * (Highstock) The x position of the point.
  2534. */
  2535. x?: number;
  2536. /**
  2537. * (Highstock) The y position of the point.
  2538. */
  2539. y?: number;
  2540. }
  2541. /**
  2542. * (Highcharts, Highstock, Highmaps, Gantt) Options for annotation's labels.
  2543. * Each label inherits options from the labelOptions object. An option from the
  2544. * labelOptions can be overwritten by config for a specific label.
  2545. */
  2546. export interface AnnotationsLabelOptions {
  2547. /**
  2548. * (Highcharts, Highstock, Highmaps, Gantt) Accessibility options for an
  2549. * annotation label.
  2550. */
  2551. accessibility?: AnnotationLabelAccessibilityOptionsObject;
  2552. /**
  2553. * (Highcharts, Highstock, Highmaps, Gantt) The alignment of the
  2554. * annotation's label. If right, the right side of the label should be
  2555. * touching the point.
  2556. */
  2557. align?: AlignValue;
  2558. /**
  2559. * (Highcharts, Highstock, Highmaps, Gantt) Whether to allow the
  2560. * annotation's labels to overlap. To make the labels less sensitive for
  2561. * overlapping, the can be set to 0.
  2562. */
  2563. allowOverlap?: boolean;
  2564. /**
  2565. * (Highcharts, Highstock, Highmaps, Gantt) The background color or gradient
  2566. * for the annotation's label.
  2567. */
  2568. backgroundColor?: (ColorString|GradientColorObject|PatternObject);
  2569. /**
  2570. * (Highcharts, Highstock, Highmaps, Gantt) The border color for the
  2571. * annotation's label.
  2572. */
  2573. borderColor?: ColorString;
  2574. /**
  2575. * (Highcharts, Highstock, Highmaps, Gantt) The border radius in pixels for
  2576. * the annotaiton's label.
  2577. */
  2578. borderRadius?: number;
  2579. /**
  2580. * (Highcharts, Highstock, Highmaps, Gantt) The border width in pixels for
  2581. * the annotation's label
  2582. */
  2583. borderWidth?: number;
  2584. /**
  2585. * (Highcharts, Highstock, Highmaps, Gantt) A class name for styling by CSS.
  2586. */
  2587. className?: string;
  2588. /**
  2589. * (Highcharts, Highstock, Highmaps, Gantt) Whether to hide the annotation's
  2590. * label that is outside the plot area.
  2591. */
  2592. crop?: boolean;
  2593. /**
  2594. * (Highcharts, Highstock, Highmaps, Gantt) The label's pixel distance from
  2595. * the point.
  2596. */
  2597. distance?: number;
  2598. /**
  2599. * (Highcharts, Highstock, Highmaps, Gantt) A format string for the data
  2600. * label.
  2601. */
  2602. format?: string;
  2603. /**
  2604. * (Highcharts, Highstock, Highmaps, Gantt) Callback JavaScript function to
  2605. * format the annotation's label. Note that if a `format` or `text` are
  2606. * defined, the format or text take precedence and the formatter is ignored.
  2607. * `This` refers to a point object.
  2608. */
  2609. formatter?: FormatterCallbackFunction<Point>;
  2610. /**
  2611. * (Highcharts, Highstock, Highmaps, Gantt) Whether the annotation is
  2612. * visible in the exported data table.
  2613. */
  2614. includeInDataExport?: boolean;
  2615. /**
  2616. * (Highcharts, Highstock, Highmaps, Gantt) How to handle the annotation's
  2617. * label that flow outside the plot area. The justify option aligns the
  2618. * label inside the plot area.
  2619. */
  2620. overflow?: OptionsOverflowValue;
  2621. /**
  2622. * (Highcharts, Highstock, Highmaps, Gantt) When either the borderWidth or
  2623. * the backgroundColor is set, this is the padding within the box.
  2624. */
  2625. padding?: number;
  2626. /**
  2627. * (Highcharts, Highstock, Highmaps, Gantt) The shadow of the box. The
  2628. * shadow can be an object configuration containing `color`, `offsetX`,
  2629. * `offsetY`, `opacity` and `width`.
  2630. */
  2631. shadow?: (boolean|ShadowOptionsObject);
  2632. /**
  2633. * (Highcharts, Highstock, Highmaps, Gantt) The name of a symbol to use for
  2634. * the border around the label. Symbols are predefined functions on the
  2635. * Renderer object.
  2636. */
  2637. shape?: string;
  2638. /**
  2639. * (Highcharts, Highstock, Highmaps, Gantt) Styles for the annotation's
  2640. * label.
  2641. */
  2642. style?: CSSObject;
  2643. /**
  2644. * (Highcharts, Highstock, Highmaps, Gantt) Alias for the format option.
  2645. */
  2646. text?: string;
  2647. /**
  2648. * (Highcharts, Highstock, Highmaps, Gantt) Whether to use HTML to render
  2649. * the annotation's label.
  2650. */
  2651. useHTML?: boolean;
  2652. /**
  2653. * (Highcharts, Highstock, Highmaps, Gantt) The vertical alignment of the
  2654. * annotation's label.
  2655. */
  2656. verticalAlign?: VerticalAlignValue;
  2657. /**
  2658. * (Highcharts, Highstock, Highmaps, Gantt) The x position offset of the
  2659. * label relative to the point. Note that if a `distance` is defined, the
  2660. * distance takes precedence over `x` and `y` options.
  2661. */
  2662. x?: number;
  2663. /**
  2664. * (Highcharts, Highstock, Highmaps, Gantt) The y position offset of the
  2665. * label relative to the point. Note that if a `distance` is defined, the
  2666. * distance takes precedence over `x` and `y` options.
  2667. */
  2668. y?: number;
  2669. }
  2670. /**
  2671. * (Highcharts, Highstock, Highmaps, Gantt) An array of labels for the
  2672. * annotation. For options that apply to multiple labels, they can be added to
  2673. * the labelOptions.
  2674. */
  2675. export interface AnnotationsLabelsOptions {
  2676. /**
  2677. * (Highcharts, Highstock, Highmaps, Gantt) Accessibility options for an
  2678. * annotation label.
  2679. */
  2680. accessibility?: AnnotationLabelAccessibilityOptionsObject;
  2681. /**
  2682. * (Highcharts, Highstock, Highmaps, Gantt) The alignment of the
  2683. * annotation's label. If right, the right side of the label should be
  2684. * touching the point.
  2685. */
  2686. align?: AlignValue;
  2687. /**
  2688. * (Highcharts, Highstock, Highmaps, Gantt) Whether to allow the
  2689. * annotation's labels to overlap. To make the labels less sensitive for
  2690. * overlapping, the can be set to 0.
  2691. */
  2692. allowOverlap?: boolean;
  2693. /**
  2694. * (Highcharts, Highstock, Highmaps, Gantt) The background color or gradient
  2695. * for the annotation's label.
  2696. */
  2697. backgroundColor?: (ColorString|GradientColorObject|PatternObject);
  2698. /**
  2699. * (Highcharts, Highstock, Highmaps, Gantt) The border color for the
  2700. * annotation's label.
  2701. */
  2702. borderColor?: ColorString;
  2703. /**
  2704. * (Highcharts, Highstock, Highmaps, Gantt) The border radius in pixels for
  2705. * the annotaiton's label.
  2706. */
  2707. borderRadius?: number;
  2708. /**
  2709. * (Highcharts, Highstock, Highmaps, Gantt) The border width in pixels for
  2710. * the annotation's label
  2711. */
  2712. borderWidth?: number;
  2713. /**
  2714. * (Highcharts, Highstock, Highmaps, Gantt) A class name for styling by CSS.
  2715. */
  2716. className?: string;
  2717. /**
  2718. * (Highcharts, Highstock, Highmaps, Gantt) Whether to hide the annotation's
  2719. * label that is outside the plot area.
  2720. */
  2721. crop?: boolean;
  2722. /**
  2723. * (Highcharts, Highstock, Highmaps, Gantt) The label's pixel distance from
  2724. * the point.
  2725. */
  2726. distance?: number;
  2727. /**
  2728. * (Highcharts, Highstock, Highmaps, Gantt) A format string for the data
  2729. * label.
  2730. */
  2731. format?: string;
  2732. /**
  2733. * (Highcharts, Highstock, Highmaps, Gantt) Callback JavaScript function to
  2734. * format the annotation's label. Note that if a `format` or `text` are
  2735. * defined, the format or text take precedence and the formatter is ignored.
  2736. * `This` refers to a point object.
  2737. */
  2738. formatter?: FormatterCallbackFunction<Point>;
  2739. /**
  2740. * (Highcharts, Highstock, Highmaps, Gantt) Whether the annotation is
  2741. * visible in the exported data table.
  2742. */
  2743. includeInDataExport?: boolean;
  2744. /**
  2745. * (Highcharts, Highstock, Highmaps, Gantt) How to handle the annotation's
  2746. * label that flow outside the plot area. The justify option aligns the
  2747. * label inside the plot area.
  2748. */
  2749. overflow?: OptionsOverflowValue;
  2750. /**
  2751. * (Highcharts, Highstock, Highmaps, Gantt) When either the borderWidth or
  2752. * the backgroundColor is set, this is the padding within the box.
  2753. */
  2754. padding?: number;
  2755. /**
  2756. * (Highcharts, Highstock, Highmaps, Gantt) This option defines the point to
  2757. * which the label will be connected. It can be either the point which
  2758. * exists in the series - it is referenced by the point's id - or a new
  2759. * point with defined x, y properties and optionally axes.
  2760. */
  2761. point?: (string|AnnotationMockPointOptionsObject);
  2762. /**
  2763. * (Highcharts, Highstock, Highmaps, Gantt) The shadow of the box. The
  2764. * shadow can be an object configuration containing `color`, `offsetX`,
  2765. * `offsetY`, `opacity` and `width`.
  2766. */
  2767. shadow?: (boolean|ShadowOptionsObject);
  2768. /**
  2769. * (Highcharts, Highstock, Highmaps, Gantt) The name of a symbol to use for
  2770. * the border around the label. Symbols are predefined functions on the
  2771. * Renderer object.
  2772. */
  2773. shape?: string;
  2774. /**
  2775. * (Highcharts, Highstock, Highmaps, Gantt) Styles for the annotation's
  2776. * label.
  2777. */
  2778. style?: CSSObject;
  2779. /**
  2780. * (Highcharts, Highstock, Highmaps, Gantt) Alias for the format option.
  2781. */
  2782. text?: string;
  2783. /**
  2784. * (Highcharts, Highstock, Highmaps, Gantt) Whether to use HTML to render
  2785. * the annotation's label.
  2786. */
  2787. useHTML?: boolean;
  2788. /**
  2789. * (Highcharts, Highstock, Highmaps, Gantt) The vertical alignment of the
  2790. * annotation's label.
  2791. */
  2792. verticalAlign?: VerticalAlignValue;
  2793. /**
  2794. * (Highcharts, Highstock, Highmaps, Gantt) The x position offset of the
  2795. * label relative to the point. Note that if a `distance` is defined, the
  2796. * distance takes precedence over `x` and `y` options.
  2797. */
  2798. x?: number;
  2799. /**
  2800. * (Highcharts, Highstock, Highmaps, Gantt) The y position offset of the
  2801. * label relative to the point. Note that if a `distance` is defined, the
  2802. * distance takes precedence over `x` and `y` options.
  2803. */
  2804. y?: number;
  2805. }
  2806. export interface AnnotationsMeasureControlPointOptions {
  2807. events?: any;
  2808. }
  2809. /**
  2810. * (Highstock) A measure annotation.
  2811. */
  2812. export interface AnnotationsMeasureOptions {
  2813. controlPointOptions?: AnnotationsMeasureControlPointOptions;
  2814. /**
  2815. * (Highstock) Additional options for an annotation with the type.
  2816. */
  2817. typeOptions?: AnnotationsMeasureTypeOptions;
  2818. }
  2819. export interface AnnotationsMeasureTypeBackgroundOptions {
  2820. /**
  2821. * (Highstock) The color of the rectangle.
  2822. */
  2823. fill?: string;
  2824. /**
  2825. * (Highstock) The color of border.
  2826. */
  2827. stroke?: string;
  2828. /**
  2829. * (Highstock) The width of border.
  2830. */
  2831. strokeWidth?: number;
  2832. }
  2833. /**
  2834. * (Highstock) Configure a crosshair that is horizontally placed in middle of
  2835. * rectangle.
  2836. */
  2837. export interface AnnotationsMeasureTypeCrosshairXOptions {
  2838. /**
  2839. * (Highstock) The dash or dot style of the crosshair's line. For possible
  2840. * values, see this demonstration.
  2841. */
  2842. dashStyle?: DashStyleValue;
  2843. /**
  2844. * (Highstock) Enable or disable the horizontal crosshair.
  2845. */
  2846. enabled?: boolean;
  2847. /**
  2848. * (Highstock) The marker-end defines the arrowhead that will be drawn at
  2849. * the final vertex of the given crosshair's path.
  2850. */
  2851. markerEnd?: string;
  2852. /**
  2853. * (Highstock) The Z index of the crosshair in annotation.
  2854. */
  2855. zIndex?: number;
  2856. }
  2857. /**
  2858. * (Highstock) Configure a crosshair that is vertically placed in middle of
  2859. * rectangle.
  2860. */
  2861. export interface AnnotationsMeasureTypeCrosshairYOptions {
  2862. /**
  2863. * (Highstock) The dash or dot style of the crosshair's line. For possible
  2864. * values, see this demonstration.
  2865. */
  2866. dashStyle?: DashStyleValue;
  2867. /**
  2868. * (Highstock) Enable or disable the vertical crosshair.
  2869. */
  2870. enabled?: boolean;
  2871. /**
  2872. * (Highstock) The marker-end defines the arrowhead that will be drawn at
  2873. * the final vertex of the given crosshair's path.
  2874. */
  2875. markerEnd?: OptionsMarkerEndValue;
  2876. /**
  2877. * (Highstock) The Z index of the crosshair in annotation.
  2878. */
  2879. zIndex?: number;
  2880. }
  2881. export interface AnnotationsMeasureTypeLabelOptions {
  2882. /**
  2883. * (Highstock) Enable or disable the label text (min, max, average, bins
  2884. * values).
  2885. *
  2886. * Defaults to true.
  2887. */
  2888. enabled?: boolean;
  2889. /**
  2890. * (Highstock) Formatter function for the label text.
  2891. *
  2892. * Available data are:
  2893. *
  2894. * (see online documentation for example)
  2895. */
  2896. formatter?: Function;
  2897. /**
  2898. * (Highstock) CSS styles for the measure label.
  2899. */
  2900. style?: (AnnotationsMeasureTypeLabelStyleOptions|CSSObject);
  2901. }
  2902. /**
  2903. * (Highstock) CSS styles for the measure label.
  2904. */
  2905. export interface AnnotationsMeasureTypeLabelStyleOptions {
  2906. color?: string;
  2907. fontSize?: string;
  2908. }
  2909. /**
  2910. * (Highstock) Line options.
  2911. */
  2912. export interface AnnotationsMeasureTypeLineOptions {
  2913. fill?: string;
  2914. }
  2915. /**
  2916. * (Highstock) Additional options for an annotation with the type.
  2917. */
  2918. export interface AnnotationsMeasureTypeOptions {
  2919. background?: AnnotationsMeasureTypeBackgroundOptions;
  2920. /**
  2921. * (Highstock) Configure a crosshair that is horizontally placed in middle
  2922. * of rectangle.
  2923. */
  2924. crosshairX?: AnnotationsMeasureTypeCrosshairXOptions;
  2925. /**
  2926. * (Highstock) Configure a crosshair that is vertically placed in middle of
  2927. * rectangle.
  2928. */
  2929. crosshairY?: AnnotationsMeasureTypeCrosshairYOptions;
  2930. label?: AnnotationsMeasureTypeLabelOptions;
  2931. /**
  2932. * (Highstock) Line options.
  2933. */
  2934. line?: AnnotationsMeasureTypeLineOptions;
  2935. points?: Array<AnnotationsMeasureTypePointsOptions>;
  2936. /**
  2937. * (Highstock) Decides in what dimensions the user can resize by dragging
  2938. * the mouse. Can be one of x, y or xy.
  2939. */
  2940. selectType?: string;
  2941. /**
  2942. * (Highstock) This number defines which xAxis the point is connected to. It
  2943. * refers to either the axis id or the index of the axis in the xAxis array.
  2944. */
  2945. xAxis?: number;
  2946. /**
  2947. * (Highstock) This number defines which yAxis the point is connected to. It
  2948. * refers to either the axis id or the index of the axis in the yAxis array.
  2949. */
  2950. yAxis?: number;
  2951. }
  2952. export interface AnnotationsMeasureTypePointsOptions {
  2953. controlPoint?: number;
  2954. /**
  2955. * (Highstock) The x position of the point.
  2956. */
  2957. x?: number;
  2958. /**
  2959. * (Highstock) The y position of the point.
  2960. */
  2961. y?: number;
  2962. }
  2963. /**
  2964. * (Highcharts, Highstock, Highmaps, Gantt) A basic type of an annotation. It
  2965. * allows to add custom labels or shapes. The items can be tied to points, axis
  2966. * coordinates or chart pixel coordinates.
  2967. */
  2968. export interface AnnotationsOptions {
  2969. /**
  2970. * (Highcharts, Highstock, Highmaps, Gantt) Enable or disable the initial
  2971. * animation when a series is displayed for the `annotation`. The animation
  2972. * can also be set as a configuration object. Please note that this option
  2973. * only applies to the initial animation. For other animations, see
  2974. * chart.animation and the animation parameter under the API methods. The
  2975. * following properties are supported:
  2976. *
  2977. * - `defer`: The animation delay time in milliseconds.
  2978. */
  2979. animation?: (boolean|AnnotationsAnimationOptions|Partial<AnimationOptionsObject>);
  2980. /**
  2981. * (Highcharts, Highstock, Highmaps, Gantt) Options for annotation's control
  2982. * points. Each control point inherits options from controlPointOptions
  2983. * object. Options from the controlPointOptions can be overwritten by
  2984. * options in a specific control point.
  2985. */
  2986. controlPointOptions?: AnnotationControlPointOptionsObject;
  2987. /**
  2988. * (Highstock) A crooked line annotation.
  2989. */
  2990. crookedLine?: AnnotationsCrookedLineOptions;
  2991. /**
  2992. * (Highcharts, Highstock, Highmaps, Gantt) Allow an annotation to be
  2993. * draggable by a user. Possible values are `'x'`, `'xy'`, `'y'` and `''`
  2994. * (disabled).
  2995. */
  2996. draggable?: AnnotationDraggableValue;
  2997. /**
  2998. * (Highstock) An elliott wave annotation.
  2999. */
  3000. elliottWave?: AnnotationsElliottWaveOptions;
  3001. /**
  3002. * (Highcharts, Highstock, Highmaps, Gantt) Events available in annotations.
  3003. */
  3004. events?: AnnotationsEventsOptions;
  3005. /**
  3006. * (Highstock) A fibonacci annotation.
  3007. */
  3008. fibonacci?: AnnotationsFibonacciOptions;
  3009. /**
  3010. * (Highcharts, Highstock, Highmaps, Gantt) Sets an ID for an annotation.
  3011. * Can be user later when removing an annotation in
  3012. * Chart.removeAnnotation(id) method.
  3013. */
  3014. id?: (number|string);
  3015. /**
  3016. * (Highstock) An infinity line annotation.
  3017. */
  3018. infinityLine?: AnnotationsInfinityLineOptions;
  3019. /**
  3020. * (Highcharts, Highstock, Highmaps, Gantt) Options for annotation's labels.
  3021. * Each label inherits options from the labelOptions object. An option from
  3022. * the labelOptions can be overwritten by config for a specific label.
  3023. */
  3024. labelOptions?: AnnotationsLabelOptions;
  3025. /**
  3026. * (Highcharts, Highstock, Highmaps, Gantt) An array of labels for the
  3027. * annotation. For options that apply to multiple labels, they can be added
  3028. * to the labelOptions.
  3029. */
  3030. labels?: Array<AnnotationsLabelsOptions>;
  3031. /**
  3032. * (Highstock) A measure annotation.
  3033. */
  3034. measure?: AnnotationsMeasureOptions;
  3035. /**
  3036. * (Highstock) A pitchfork annotation.
  3037. */
  3038. pitchfork?: AnnotationsPitchforkOptions;
  3039. /**
  3040. * (Highcharts, Highstock, Highmaps, Gantt) Options for annotation's shapes.
  3041. * Each shape inherits options from the shapeOptions object. An option from
  3042. * the shapeOptions can be overwritten by config for a specific shape.
  3043. */
  3044. shapeOptions?: AnnotationsShapeOptions;
  3045. /**
  3046. * (Highcharts, Highstock, Highmaps, Gantt) An array of shapes for the
  3047. * annotation. For options that apply to multiple shapes, then can be added
  3048. * to the shapeOptions.
  3049. */
  3050. shapes?: Array<AnnotationsShapesOptions>;
  3051. /**
  3052. * (Highstock) A tunnel annotation.
  3053. */
  3054. tunnel?: AnnotationsTunnelOptions;
  3055. /**
  3056. * (Highstock) A vertical line annotation.
  3057. */
  3058. verticalLine?: AnnotationsVerticalLineOptions;
  3059. /**
  3060. * (Highcharts, Highstock, Highmaps, Gantt) Whether the annotation is
  3061. * visible.
  3062. */
  3063. visible?: boolean;
  3064. /**
  3065. * (Highcharts, Highstock, Highmaps, Gantt) The Z index of the annotation.
  3066. */
  3067. zIndex?: number;
  3068. }
  3069. export interface AnnotationsPitchforkControlPointOptions {
  3070. events?: any;
  3071. }
  3072. /**
  3073. * (Highstock) Options for annotation's labels. Each label inherits options from
  3074. * the labelOptions object. An option from the labelOptions can be overwritten
  3075. * by config for a specific label.
  3076. */
  3077. export interface AnnotationsPitchforkLabelOptions {
  3078. /**
  3079. * (Highstock) Accessibility options for an annotation label.
  3080. */
  3081. accessibility?: AnnotationLabelAccessibilityOptionsObject;
  3082. /**
  3083. * (Highstock) The alignment of the annotation's label. If right, the right
  3084. * side of the label should be touching the point.
  3085. */
  3086. align?: AlignValue;
  3087. /**
  3088. * (Highstock) Whether to allow the annotation's labels to overlap. To make
  3089. * the labels less sensitive for overlapping, the can be set to 0.
  3090. */
  3091. allowOverlap?: boolean;
  3092. /**
  3093. * (Highstock) The background color or gradient for the annotation's label.
  3094. */
  3095. backgroundColor?: (ColorString|GradientColorObject|PatternObject);
  3096. /**
  3097. * (Highstock) The border color for the annotation's label.
  3098. */
  3099. borderColor?: ColorString;
  3100. /**
  3101. * (Highstock) The border radius in pixels for the annotaiton's label.
  3102. */
  3103. borderRadius?: number;
  3104. /**
  3105. * (Highstock) The border width in pixels for the annotation's label
  3106. */
  3107. borderWidth?: number;
  3108. /**
  3109. * (Highstock) A class name for styling by CSS.
  3110. */
  3111. className?: string;
  3112. /**
  3113. * (Highstock) Whether to hide the annotation's label that is outside the
  3114. * plot area.
  3115. */
  3116. crop?: boolean;
  3117. /**
  3118. * (Highstock) The label's pixel distance from the point.
  3119. */
  3120. distance?: number;
  3121. /**
  3122. * (Highstock) A format string for the data label.
  3123. */
  3124. format?: string;
  3125. /**
  3126. * (Highstock) Callback JavaScript function to format the annotation's
  3127. * label. Note that if a `format` or `text` are defined, the format or text
  3128. * take precedence and the formatter is ignored. `This` refers to a point
  3129. * object.
  3130. */
  3131. formatter?: FormatterCallbackFunction<Point>;
  3132. /**
  3133. * (Highstock) Whether the annotation is visible in the exported data table.
  3134. */
  3135. includeInDataExport?: boolean;
  3136. /**
  3137. * (Highstock) How to handle the annotation's label that flow outside the
  3138. * plot area. The justify option aligns the label inside the plot area.
  3139. */
  3140. overflow?: OptionsOverflowValue;
  3141. /**
  3142. * (Highstock) When either the borderWidth or the backgroundColor is set,
  3143. * this is the padding within the box.
  3144. */
  3145. padding?: number;
  3146. /**
  3147. * (Highstock) The shadow of the box. The shadow can be an object
  3148. * configuration containing `color`, `offsetX`, `offsetY`, `opacity` and
  3149. * `width`.
  3150. */
  3151. shadow?: (boolean|ShadowOptionsObject);
  3152. /**
  3153. * (Highstock) The name of a symbol to use for the border around the label.
  3154. * Symbols are predefined functions on the Renderer object.
  3155. */
  3156. shape?: string;
  3157. /**
  3158. * (Highstock) Styles for the annotation's label.
  3159. */
  3160. style?: CSSObject;
  3161. /**
  3162. * (Highstock) Alias for the format option.
  3163. */
  3164. text?: string;
  3165. /**
  3166. * (Highstock) Whether to use HTML to render the annotation's label.
  3167. */
  3168. useHTML?: boolean;
  3169. /**
  3170. * (Highstock) The vertical alignment of the annotation's label.
  3171. */
  3172. verticalAlign?: VerticalAlignValue;
  3173. /**
  3174. * (Highstock) The x position offset of the label relative to the point.
  3175. * Note that if a `distance` is defined, the distance takes precedence over
  3176. * `x` and `y` options.
  3177. */
  3178. x?: number;
  3179. /**
  3180. * (Highstock) The y position offset of the label relative to the point.
  3181. * Note that if a `distance` is defined, the distance takes precedence over
  3182. * `x` and `y` options.
  3183. */
  3184. y?: number;
  3185. }
  3186. /**
  3187. * (Highstock) A pitchfork annotation.
  3188. */
  3189. export interface AnnotationsPitchforkOptions {
  3190. controlPointOptions?: AnnotationsPitchforkControlPointOptions;
  3191. /**
  3192. * (Highstock) Options for annotation's labels. Each label inherits options
  3193. * from the labelOptions object. An option from the labelOptions can be
  3194. * overwritten by config for a specific label.
  3195. */
  3196. labelOptions?: AnnotationsPitchforkLabelOptions;
  3197. /**
  3198. * (Highstock) Options for annotation's shapes. Each shape inherits options
  3199. * from the shapeOptions object. An option from the shapeOptions can be
  3200. * overwritten by config for a specific shape.
  3201. */
  3202. shapeOptions?: AnnotationsPitchforkShapeOptions;
  3203. /**
  3204. * (Highstock) Additional options for an annotation with the type.
  3205. */
  3206. typeOptions?: AnnotationsPitchforkTypeOptions;
  3207. }
  3208. /**
  3209. * (Highstock) Options for annotation's shapes. Each shape inherits options from
  3210. * the shapeOptions object. An option from the shapeOptions can be overwritten
  3211. * by config for a specific shape.
  3212. */
  3213. export interface AnnotationsPitchforkShapeOptions {
  3214. /**
  3215. * (Highstock) Name of the dash style to use for the shape's stroke.
  3216. */
  3217. dashStyle?: DashStyleValue;
  3218. /**
  3219. * (Highstock) The color of the shape's fill.
  3220. */
  3221. fill?: (ColorString|GradientColorObject|PatternObject);
  3222. /**
  3223. * (Highstock) The height of the shape.
  3224. */
  3225. height?: number;
  3226. /**
  3227. * (Highstock) The radius of the shape.
  3228. */
  3229. r?: number;
  3230. /**
  3231. * (Highstock) Defines additional snapping area around an annotation making
  3232. * this annotation to focus. Defined in pixels.
  3233. */
  3234. snap?: number;
  3235. /**
  3236. * (Highstock) The URL for an image to use as the annotation shape. Note,
  3237. * type has to be set to `'image'`.
  3238. */
  3239. src?: string;
  3240. /**
  3241. * (Highstock) The color of the shape's stroke.
  3242. */
  3243. stroke?: ColorString;
  3244. /**
  3245. * (Highstock) The pixel stroke width of the shape.
  3246. */
  3247. strokeWidth?: number;
  3248. /**
  3249. * (Highstock) The type of the shape, e.g. circle or rectangle.
  3250. */
  3251. type?: string;
  3252. /**
  3253. * (Highstock) The width of the shape.
  3254. */
  3255. width?: number;
  3256. }
  3257. /**
  3258. * (Highstock) Inner background options.
  3259. */
  3260. export interface AnnotationsPitchforkTypeInnerBackgroundOptions {
  3261. /**
  3262. * (Highstock) Name of the dash style to use for the shape's stroke.
  3263. */
  3264. dashStyle?: DashStyleValue;
  3265. /**
  3266. * (Highstock) The color of the shape's fill.
  3267. */
  3268. fill?: string;
  3269. /**
  3270. * (Highstock) Defines additional snapping area around an annotation making
  3271. * this annotation to focus. Defined in pixels.
  3272. */
  3273. snap?: number;
  3274. /**
  3275. * (Highstock) The URL for an image to use as the annotation shape. Note,
  3276. * type has to be set to `'image'`.
  3277. */
  3278. src?: string;
  3279. /**
  3280. * (Highstock) The color of the shape's stroke.
  3281. */
  3282. stroke?: ColorString;
  3283. /**
  3284. * (Highstock) The pixel stroke width of the shape.
  3285. */
  3286. strokeWidth?: number;
  3287. }
  3288. /**
  3289. * (Highstock) Line options.
  3290. */
  3291. export interface AnnotationsPitchforkTypeLineOptions {
  3292. fill?: string;
  3293. }
  3294. /**
  3295. * (Highstock) Additional options for an annotation with the type.
  3296. */
  3297. export interface AnnotationsPitchforkTypeOptions {
  3298. /**
  3299. * (Highstock) Inner background options.
  3300. */
  3301. innerBackground?: AnnotationsPitchforkTypeInnerBackgroundOptions;
  3302. /**
  3303. * (Highstock) Line options.
  3304. */
  3305. line?: AnnotationsPitchforkTypeLineOptions;
  3306. /**
  3307. * (Highstock) Outer background options.
  3308. */
  3309. outerBackground?: AnnotationsPitchforkTypeOuterBackgroundOptions;
  3310. points?: Array<AnnotationsPitchforkTypePointsOptions>;
  3311. /**
  3312. * (Highstock) This number defines which xAxis the point is connected to. It
  3313. * refers to either the axis id or the index of the axis in the xAxis array.
  3314. */
  3315. xAxis?: number;
  3316. /**
  3317. * (Highstock) This number defines which yAxis the point is connected to. It
  3318. * refers to either the axis id or the index of the axis in the xAxis array.
  3319. */
  3320. yAxis?: number;
  3321. }
  3322. /**
  3323. * (Highstock) Outer background options.
  3324. */
  3325. export interface AnnotationsPitchforkTypeOuterBackgroundOptions {
  3326. /**
  3327. * (Highstock) Name of the dash style to use for the shape's stroke.
  3328. */
  3329. dashStyle?: DashStyleValue;
  3330. /**
  3331. * (Highstock) The color of the shape's fill.
  3332. */
  3333. fill?: string;
  3334. /**
  3335. * (Highstock) Defines additional snapping area around an annotation making
  3336. * this annotation to focus. Defined in pixels.
  3337. */
  3338. snap?: number;
  3339. /**
  3340. * (Highstock) The URL for an image to use as the annotation shape. Note,
  3341. * type has to be set to `'image'`.
  3342. */
  3343. src?: string;
  3344. /**
  3345. * (Highstock) The color of the shape's stroke.
  3346. */
  3347. stroke?: ColorString;
  3348. /**
  3349. * (Highstock) The pixel stroke width of the shape.
  3350. */
  3351. strokeWidth?: number;
  3352. }
  3353. export interface AnnotationsPitchforkTypePointsOptions {
  3354. controlPoint?: number;
  3355. /**
  3356. * (Highstock) The x position of the point.
  3357. */
  3358. x?: number;
  3359. /**
  3360. * (Highstock) The y position of the point.
  3361. */
  3362. y?: number;
  3363. }
  3364. /**
  3365. * (Highcharts, Highstock, Highmaps, Gantt) Options for annotation's shapes.
  3366. * Each shape inherits options from the shapeOptions object. An option from the
  3367. * shapeOptions can be overwritten by config for a specific shape.
  3368. */
  3369. export interface AnnotationsShapeOptions {
  3370. /**
  3371. * (Highcharts, Highstock, Highmaps, Gantt) Name of the dash style to use
  3372. * for the shape's stroke.
  3373. */
  3374. dashStyle?: DashStyleValue;
  3375. /**
  3376. * (Highcharts, Highstock, Highmaps, Gantt) The color of the shape's fill.
  3377. */
  3378. fill?: (ColorString|GradientColorObject|PatternObject);
  3379. /**
  3380. * (Highcharts, Highstock, Highmaps, Gantt) The height of the shape.
  3381. */
  3382. height?: number;
  3383. /**
  3384. * (Highcharts, Highstock, Highmaps, Gantt) The radius of the shape.
  3385. */
  3386. r?: number;
  3387. /**
  3388. * (Highcharts, Highstock, Highmaps, Gantt) Defines additional snapping area
  3389. * around an annotation making this annotation to focus. Defined in pixels.
  3390. */
  3391. snap?: number;
  3392. /**
  3393. * (Highcharts, Highstock, Highmaps, Gantt) The URL for an image to use as
  3394. * the annotation shape. Note, type has to be set to `'image'`.
  3395. */
  3396. src?: string;
  3397. /**
  3398. * (Highcharts, Highstock, Highmaps, Gantt) The color of the shape's stroke.
  3399. */
  3400. stroke?: ColorString;
  3401. /**
  3402. * (Highcharts, Highstock, Highmaps, Gantt) The pixel stroke width of the
  3403. * shape.
  3404. */
  3405. strokeWidth?: number;
  3406. /**
  3407. * (Highcharts, Highstock, Highmaps, Gantt) The type of the shape, e.g.
  3408. * circle or rectangle.
  3409. */
  3410. type?: string;
  3411. /**
  3412. * (Highcharts, Highstock, Highmaps, Gantt) The width of the shape.
  3413. */
  3414. width?: number;
  3415. }
  3416. /**
  3417. * (Highcharts, Highstock, Highmaps, Gantt) An array of shapes for the
  3418. * annotation. For options that apply to multiple shapes, then can be added to
  3419. * the shapeOptions.
  3420. */
  3421. export interface AnnotationsShapesOptions {
  3422. /**
  3423. * (Highcharts, Highstock, Highmaps, Gantt) Name of the dash style to use
  3424. * for the shape's stroke.
  3425. */
  3426. dashStyle?: DashStyleValue;
  3427. /**
  3428. * (Highcharts, Highstock, Highmaps, Gantt) The color of the shape's fill.
  3429. */
  3430. fill?: (ColorString|GradientColorObject|PatternObject);
  3431. /**
  3432. * (Highcharts, Highstock, Highmaps, Gantt) The height of the shape.
  3433. */
  3434. height?: number;
  3435. /**
  3436. * (Highcharts, Highstock, Highmaps, Gantt) Id of the marker which will be
  3437. * drawn at the final vertex of the path. Custom markers can be defined in
  3438. * defs property.
  3439. */
  3440. markerEnd?: string;
  3441. /**
  3442. * (Highcharts, Highstock, Highmaps, Gantt) Id of the marker which will be
  3443. * drawn at the first vertex of the path. Custom markers can be defined in
  3444. * defs property.
  3445. */
  3446. markerStart?: string;
  3447. /**
  3448. * (Highcharts, Highstock, Highmaps, Gantt) This option defines the point to
  3449. * which the shape will be connected. It can be either the point which
  3450. * exists in the series - it is referenced by the point's id - or a new
  3451. * point with defined x, y properties and optionally axes.
  3452. */
  3453. point?: (string|AnnotationMockPointOptionsObject);
  3454. /**
  3455. * (Highcharts, Highstock, Highmaps, Gantt) An array of points for the
  3456. * shape. This option is available for shapes which can use multiple points
  3457. * such as path. A point can be either a point object or a point's id.
  3458. */
  3459. points?: Array<(string|AnnotationMockPointOptionsObject)>;
  3460. /**
  3461. * (Highcharts, Highstock, Highmaps, Gantt) The radius of the shape.
  3462. */
  3463. r?: number;
  3464. /**
  3465. * (Highcharts, Highstock, Highmaps, Gantt) Defines additional snapping area
  3466. * around an annotation making this annotation to focus. Defined in pixels.
  3467. */
  3468. snap?: number;
  3469. /**
  3470. * (Highcharts, Highstock, Highmaps, Gantt) The URL for an image to use as
  3471. * the annotation shape. Note, type has to be set to `'image'`.
  3472. */
  3473. src?: string;
  3474. /**
  3475. * (Highcharts, Highstock, Highmaps, Gantt) The color of the shape's stroke.
  3476. */
  3477. stroke?: ColorString;
  3478. /**
  3479. * (Highcharts, Highstock, Highmaps, Gantt) The pixel stroke width of the
  3480. * shape.
  3481. */
  3482. strokeWidth?: number;
  3483. /**
  3484. * (Highcharts, Highstock, Highmaps, Gantt) The type of the shape, e.g.
  3485. * circle or rectangle.
  3486. */
  3487. type?: string;
  3488. /**
  3489. * (Highcharts, Highstock, Highmaps, Gantt) The width of the shape.
  3490. */
  3491. width?: number;
  3492. }
  3493. export interface AnnotationsTunnelControlPointOptions {
  3494. events?: any;
  3495. }
  3496. /**
  3497. * (Highstock) Options for annotation's labels. Each label inherits options from
  3498. * the labelOptions object. An option from the labelOptions can be overwritten
  3499. * by config for a specific label.
  3500. */
  3501. export interface AnnotationsTunnelLabelOptions {
  3502. /**
  3503. * (Highstock) Accessibility options for an annotation label.
  3504. */
  3505. accessibility?: AnnotationLabelAccessibilityOptionsObject;
  3506. /**
  3507. * (Highstock) The alignment of the annotation's label. If right, the right
  3508. * side of the label should be touching the point.
  3509. */
  3510. align?: AlignValue;
  3511. /**
  3512. * (Highstock) Whether to allow the annotation's labels to overlap. To make
  3513. * the labels less sensitive for overlapping, the can be set to 0.
  3514. */
  3515. allowOverlap?: boolean;
  3516. /**
  3517. * (Highstock) The background color or gradient for the annotation's label.
  3518. */
  3519. backgroundColor?: (ColorString|GradientColorObject|PatternObject);
  3520. /**
  3521. * (Highstock) The border color for the annotation's label.
  3522. */
  3523. borderColor?: ColorString;
  3524. /**
  3525. * (Highstock) The border radius in pixels for the annotaiton's label.
  3526. */
  3527. borderRadius?: number;
  3528. /**
  3529. * (Highstock) The border width in pixels for the annotation's label
  3530. */
  3531. borderWidth?: number;
  3532. /**
  3533. * (Highstock) A class name for styling by CSS.
  3534. */
  3535. className?: string;
  3536. /**
  3537. * (Highstock) Whether to hide the annotation's label that is outside the
  3538. * plot area.
  3539. */
  3540. crop?: boolean;
  3541. /**
  3542. * (Highstock) The label's pixel distance from the point.
  3543. */
  3544. distance?: number;
  3545. /**
  3546. * (Highstock) A format string for the data label.
  3547. */
  3548. format?: string;
  3549. /**
  3550. * (Highstock) Callback JavaScript function to format the annotation's
  3551. * label. Note that if a `format` or `text` are defined, the format or text
  3552. * take precedence and the formatter is ignored. `This` refers to a point
  3553. * object.
  3554. */
  3555. formatter?: FormatterCallbackFunction<Point>;
  3556. /**
  3557. * (Highstock) Whether the annotation is visible in the exported data table.
  3558. */
  3559. includeInDataExport?: boolean;
  3560. /**
  3561. * (Highstock) How to handle the annotation's label that flow outside the
  3562. * plot area. The justify option aligns the label inside the plot area.
  3563. */
  3564. overflow?: OptionsOverflowValue;
  3565. /**
  3566. * (Highstock) When either the borderWidth or the backgroundColor is set,
  3567. * this is the padding within the box.
  3568. */
  3569. padding?: number;
  3570. /**
  3571. * (Highstock) The shadow of the box. The shadow can be an object
  3572. * configuration containing `color`, `offsetX`, `offsetY`, `opacity` and
  3573. * `width`.
  3574. */
  3575. shadow?: (boolean|ShadowOptionsObject);
  3576. /**
  3577. * (Highstock) The name of a symbol to use for the border around the label.
  3578. * Symbols are predefined functions on the Renderer object.
  3579. */
  3580. shape?: string;
  3581. /**
  3582. * (Highstock) Styles for the annotation's label.
  3583. */
  3584. style?: CSSObject;
  3585. /**
  3586. * (Highstock) Alias for the format option.
  3587. */
  3588. text?: string;
  3589. /**
  3590. * (Highstock) Whether to use HTML to render the annotation's label.
  3591. */
  3592. useHTML?: boolean;
  3593. /**
  3594. * (Highstock) The vertical alignment of the annotation's label.
  3595. */
  3596. verticalAlign?: VerticalAlignValue;
  3597. /**
  3598. * (Highstock) The x position offset of the label relative to the point.
  3599. * Note that if a `distance` is defined, the distance takes precedence over
  3600. * `x` and `y` options.
  3601. */
  3602. x?: number;
  3603. /**
  3604. * (Highstock) The y position offset of the label relative to the point.
  3605. * Note that if a `distance` is defined, the distance takes precedence over
  3606. * `x` and `y` options.
  3607. */
  3608. y?: number;
  3609. }
  3610. /**
  3611. * (Highstock) A tunnel annotation.
  3612. */
  3613. export interface AnnotationsTunnelOptions {
  3614. controlPointOptions?: AnnotationsTunnelControlPointOptions;
  3615. /**
  3616. * (Highstock) Options for annotation's labels. Each label inherits options
  3617. * from the labelOptions object. An option from the labelOptions can be
  3618. * overwritten by config for a specific label.
  3619. */
  3620. labelOptions?: AnnotationsTunnelLabelOptions;
  3621. /**
  3622. * (Highstock) Options for annotation's shapes. Each shape inherits options
  3623. * from the shapeOptions object. An option from the shapeOptions can be
  3624. * overwritten by config for a specific shape.
  3625. */
  3626. shapeOptions?: AnnotationsTunnelShapeOptions;
  3627. /**
  3628. * (Highstock) Additional options for an annotation with the type.
  3629. */
  3630. typeOptions?: AnnotationsTunnelTypeOptions;
  3631. }
  3632. /**
  3633. * (Highstock) Options for annotation's shapes. Each shape inherits options from
  3634. * the shapeOptions object. An option from the shapeOptions can be overwritten
  3635. * by config for a specific shape.
  3636. */
  3637. export interface AnnotationsTunnelShapeOptions {
  3638. /**
  3639. * (Highstock) Name of the dash style to use for the shape's stroke.
  3640. */
  3641. dashStyle?: DashStyleValue;
  3642. /**
  3643. * (Highstock) The color of the shape's fill.
  3644. */
  3645. fill?: (ColorString|GradientColorObject|PatternObject);
  3646. /**
  3647. * (Highstock) The height of the shape.
  3648. */
  3649. height?: number;
  3650. /**
  3651. * (Highstock) The radius of the shape.
  3652. */
  3653. r?: number;
  3654. /**
  3655. * (Highstock) Defines additional snapping area around an annotation making
  3656. * this annotation to focus. Defined in pixels.
  3657. */
  3658. snap?: number;
  3659. /**
  3660. * (Highstock) The URL for an image to use as the annotation shape. Note,
  3661. * type has to be set to `'image'`.
  3662. */
  3663. src?: string;
  3664. /**
  3665. * (Highstock) The color of the shape's stroke.
  3666. */
  3667. stroke?: ColorString;
  3668. /**
  3669. * (Highstock) The pixel stroke width of the shape.
  3670. */
  3671. strokeWidth?: number;
  3672. /**
  3673. * (Highstock) The type of the shape, e.g. circle or rectangle.
  3674. */
  3675. type?: string;
  3676. /**
  3677. * (Highstock) The width of the shape.
  3678. */
  3679. width?: number;
  3680. }
  3681. /**
  3682. * (Highstock) Background options.
  3683. */
  3684. export interface AnnotationsTunnelTypeBackgroundOptions {
  3685. fill?: string;
  3686. strokeWidth?: number;
  3687. }
  3688. /**
  3689. * (Highstock) Options for the control point which controls the annotation's
  3690. * height.
  3691. */
  3692. export interface AnnotationsTunnelTypeHeightControlPointOptions {
  3693. events?: any;
  3694. }
  3695. /**
  3696. * (Highstock) Line options.
  3697. */
  3698. export interface AnnotationsTunnelTypeLineOptions {
  3699. fill?: string;
  3700. strokeWidth?: number;
  3701. }
  3702. /**
  3703. * (Highstock) Additional options for an annotation with the type.
  3704. */
  3705. export interface AnnotationsTunnelTypeOptions {
  3706. /**
  3707. * (Highstock) Background options.
  3708. */
  3709. background?: (object|AnnotationsTunnelTypeBackgroundOptions);
  3710. /**
  3711. * (Highstock) The height of the annotation in terms of yAxis.
  3712. */
  3713. height?: number;
  3714. /**
  3715. * (Highstock) Options for the control point which controls the annotation's
  3716. * height.
  3717. */
  3718. heightControlPoint?: AnnotationsTunnelTypeHeightControlPointOptions;
  3719. /**
  3720. * (Highstock) Line options.
  3721. */
  3722. line?: AnnotationsTunnelTypeLineOptions;
  3723. points?: Array<AnnotationsTunnelTypePointsOptions>;
  3724. /**
  3725. * (Highstock) This number defines which xAxis the point is connected to. It
  3726. * refers to either the axis id or the index of the axis in the xAxis array.
  3727. */
  3728. xAxis?: number;
  3729. /**
  3730. * (Highstock) This number defines which yAxis the point is connected to. It
  3731. * refers to either the axis id or the index of the axis in the xAxis array.
  3732. */
  3733. yAxis?: number;
  3734. }
  3735. export interface AnnotationsTunnelTypePointsOptions {
  3736. controlPoint?: number;
  3737. /**
  3738. * (Highstock) The x position of the point.
  3739. */
  3740. x?: number;
  3741. /**
  3742. * (Highstock) The y position of the point.
  3743. */
  3744. y?: number;
  3745. }
  3746. /**
  3747. * (Highstock) Options for annotation's labels. Each label inherits options from
  3748. * the labelOptions object. An option from the labelOptions can be overwritten
  3749. * by config for a specific label.
  3750. */
  3751. export interface AnnotationsVerticalLineLabelOptions {
  3752. /**
  3753. * (Highstock) Accessibility options for an annotation label.
  3754. */
  3755. accessibility?: AnnotationLabelAccessibilityOptionsObject;
  3756. /**
  3757. * (Highstock) The alignment of the annotation's label. If right, the right
  3758. * side of the label should be touching the point.
  3759. */
  3760. align?: AlignValue;
  3761. /**
  3762. * (Highstock) Whether to allow the annotation's labels to overlap. To make
  3763. * the labels less sensitive for overlapping, the can be set to 0.
  3764. */
  3765. allowOverlap?: boolean;
  3766. /**
  3767. * (Highstock) The background color or gradient for the annotation's label.
  3768. */
  3769. backgroundColor?: (ColorString|GradientColorObject|PatternObject);
  3770. /**
  3771. * (Highstock) The border color for the annotation's label.
  3772. */
  3773. borderColor?: ColorString;
  3774. /**
  3775. * (Highstock) The border radius in pixels for the annotaiton's label.
  3776. */
  3777. borderRadius?: number;
  3778. /**
  3779. * (Highstock) The border width in pixels for the annotation's label
  3780. */
  3781. borderWidth?: number;
  3782. /**
  3783. * (Highstock) A class name for styling by CSS.
  3784. */
  3785. className?: string;
  3786. /**
  3787. * (Highstock) Whether to hide the annotation's label that is outside the
  3788. * plot area.
  3789. */
  3790. crop?: boolean;
  3791. /**
  3792. * (Highstock) The label's pixel distance from the point.
  3793. */
  3794. distance?: number;
  3795. /**
  3796. * (Highstock) A format string for the data label.
  3797. */
  3798. format?: string;
  3799. /**
  3800. * (Highstock) Callback JavaScript function to format the annotation's
  3801. * label. Note that if a `format` or `text` are defined, the format or text
  3802. * take precedence and the formatter is ignored. `This` refers to a point
  3803. * object.
  3804. */
  3805. formatter?: FormatterCallbackFunction<Point>;
  3806. /**
  3807. * (Highstock) Whether the annotation is visible in the exported data table.
  3808. */
  3809. includeInDataExport?: boolean;
  3810. /**
  3811. * (Highstock) How to handle the annotation's label that flow outside the
  3812. * plot area. The justify option aligns the label inside the plot area.
  3813. */
  3814. overflow?: OptionsOverflowValue;
  3815. /**
  3816. * (Highstock) When either the borderWidth or the backgroundColor is set,
  3817. * this is the padding within the box.
  3818. */
  3819. padding?: number;
  3820. /**
  3821. * (Highstock) The shadow of the box. The shadow can be an object
  3822. * configuration containing `color`, `offsetX`, `offsetY`, `opacity` and
  3823. * `width`.
  3824. */
  3825. shadow?: (boolean|ShadowOptionsObject);
  3826. /**
  3827. * (Highstock) The name of a symbol to use for the border around the label.
  3828. * Symbols are predefined functions on the Renderer object.
  3829. */
  3830. shape?: string;
  3831. /**
  3832. * (Highstock) Styles for the annotation's label.
  3833. */
  3834. style?: CSSObject;
  3835. /**
  3836. * (Highstock) Alias for the format option.
  3837. */
  3838. text?: string;
  3839. /**
  3840. * (Highstock) Whether to use HTML to render the annotation's label.
  3841. */
  3842. useHTML?: boolean;
  3843. /**
  3844. * (Highstock) The vertical alignment of the annotation's label.
  3845. */
  3846. verticalAlign?: VerticalAlignValue;
  3847. /**
  3848. * (Highstock) The x position offset of the label relative to the point.
  3849. * Note that if a `distance` is defined, the distance takes precedence over
  3850. * `x` and `y` options.
  3851. */
  3852. x?: number;
  3853. /**
  3854. * (Highstock) The y position offset of the label relative to the point.
  3855. * Note that if a `distance` is defined, the distance takes precedence over
  3856. * `x` and `y` options.
  3857. */
  3858. y?: number;
  3859. }
  3860. /**
  3861. * (Highstock) A vertical line annotation.
  3862. */
  3863. export interface AnnotationsVerticalLineOptions {
  3864. /**
  3865. * (Highstock) Options for annotation's labels. Each label inherits options
  3866. * from the labelOptions object. An option from the labelOptions can be
  3867. * overwritten by config for a specific label.
  3868. */
  3869. labelOptions?: AnnotationsVerticalLineLabelOptions;
  3870. /**
  3871. * (Highstock) Options for annotation's shapes. Each shape inherits options
  3872. * from the shapeOptions object. An option from the shapeOptions can be
  3873. * overwritten by config for a specific shape.
  3874. */
  3875. shapeOptions?: AnnotationsVerticalLineShapeOptions;
  3876. /**
  3877. * (Highstock) Additional options for an annotation with the type.
  3878. */
  3879. typeOptions?: AnnotationsVerticalLineTypeOptions;
  3880. }
  3881. /**
  3882. * (Highstock) Options for annotation's shapes. Each shape inherits options from
  3883. * the shapeOptions object. An option from the shapeOptions can be overwritten
  3884. * by config for a specific shape.
  3885. */
  3886. export interface AnnotationsVerticalLineShapeOptions {
  3887. /**
  3888. * (Highstock) Name of the dash style to use for the shape's stroke.
  3889. */
  3890. dashStyle?: DashStyleValue;
  3891. /**
  3892. * (Highstock) The color of the shape's fill.
  3893. */
  3894. fill?: (ColorString|GradientColorObject|PatternObject);
  3895. /**
  3896. * (Highstock) The height of the shape.
  3897. */
  3898. height?: number;
  3899. /**
  3900. * (Highstock) The radius of the shape.
  3901. */
  3902. r?: number;
  3903. /**
  3904. * (Highstock) Defines additional snapping area around an annotation making
  3905. * this annotation to focus. Defined in pixels.
  3906. */
  3907. snap?: number;
  3908. /**
  3909. * (Highstock) The URL for an image to use as the annotation shape. Note,
  3910. * type has to be set to `'image'`.
  3911. */
  3912. src?: string;
  3913. /**
  3914. * (Highstock) The color of the shape's stroke.
  3915. */
  3916. stroke?: ColorString;
  3917. /**
  3918. * (Highstock) The pixel stroke width of the shape.
  3919. */
  3920. strokeWidth?: number;
  3921. /**
  3922. * (Highstock) The type of the shape, e.g. circle or rectangle.
  3923. */
  3924. type?: string;
  3925. /**
  3926. * (Highstock) The width of the shape.
  3927. */
  3928. width?: number;
  3929. }
  3930. /**
  3931. * (Highstock) Connector options.
  3932. */
  3933. export interface AnnotationsVerticalLineTypeConnectorOptions {
  3934. /**
  3935. * (Highstock) Name of the dash style to use for the shape's stroke.
  3936. */
  3937. dashStyle?: DashStyleValue;
  3938. /**
  3939. * (Highstock) The color of the shape's fill.
  3940. */
  3941. fill?: (ColorString|GradientColorObject|PatternObject);
  3942. markerEnd?: string;
  3943. /**
  3944. * (Highstock) Defines additional snapping area around an annotation making
  3945. * this annotation to focus. Defined in pixels.
  3946. */
  3947. snap?: number;
  3948. /**
  3949. * (Highstock) The URL for an image to use as the annotation shape. Note,
  3950. * type has to be set to `'image'`.
  3951. */
  3952. src?: string;
  3953. /**
  3954. * (Highstock) The color of the shape's stroke.
  3955. */
  3956. stroke?: ColorString;
  3957. /**
  3958. * (Highstock) The pixel stroke width of the shape.
  3959. */
  3960. strokeWidth?: number;
  3961. }
  3962. /**
  3963. * (Highstock) Label options.
  3964. */
  3965. export interface AnnotationsVerticalLineTypeLabelOptions {
  3966. /**
  3967. * (Highstock) Accessibility options for an annotation label.
  3968. */
  3969. accessibility?: AnnotationLabelAccessibilityOptionsObject;
  3970. /**
  3971. * (Highstock) The alignment of the annotation's label. If right, the right
  3972. * side of the label should be touching the point.
  3973. */
  3974. align?: AlignValue;
  3975. /**
  3976. * (Highstock) Whether to allow the annotation's labels to overlap. To make
  3977. * the labels less sensitive for overlapping, the can be set to 0.
  3978. */
  3979. allowOverlap?: boolean;
  3980. /**
  3981. * (Highstock) The background color or gradient for the annotation's label.
  3982. */
  3983. backgroundColor?: string;
  3984. /**
  3985. * (Highstock) The border color for the annotation's label.
  3986. */
  3987. borderColor?: ColorString;
  3988. /**
  3989. * (Highstock) The border radius in pixels for the annotaiton's label.
  3990. */
  3991. borderRadius?: number;
  3992. /**
  3993. * (Highstock) The border width in pixels for the annotation's label
  3994. */
  3995. borderWidth?: number;
  3996. /**
  3997. * (Highstock) A class name for styling by CSS.
  3998. */
  3999. className?: string;
  4000. /**
  4001. * (Highstock) Whether to hide the annotation's label that is outside the
  4002. * plot area.
  4003. */
  4004. crop?: boolean;
  4005. /**
  4006. * (Highstock) The label's pixel distance from the point.
  4007. */
  4008. distance?: number;
  4009. /**
  4010. * (Highstock) A format string for the data label.
  4011. */
  4012. format?: string;
  4013. /**
  4014. * (Highstock) Callback JavaScript function to format the annotation's
  4015. * label. Note that if a `format` or `text` are defined, the format or text
  4016. * take precedence and the formatter is ignored. `This` refers to a point
  4017. * object.
  4018. */
  4019. formatter?: FormatterCallbackFunction<Point>;
  4020. /**
  4021. * (Highstock) Whether the annotation is visible in the exported data table.
  4022. */
  4023. includeInDataExport?: boolean;
  4024. offset?: number;
  4025. /**
  4026. * (Highstock) How to handle the annotation's label that flow outside the
  4027. * plot area. The justify option aligns the label inside the plot area.
  4028. */
  4029. overflow?: OptionsOverflowValue;
  4030. /**
  4031. * (Highstock) When either the borderWidth or the backgroundColor is set,
  4032. * this is the padding within the box.
  4033. */
  4034. padding?: number;
  4035. /**
  4036. * (Highstock) The shadow of the box. The shadow can be an object
  4037. * configuration containing `color`, `offsetX`, `offsetY`, `opacity` and
  4038. * `width`.
  4039. */
  4040. shadow?: (boolean|ShadowOptionsObject);
  4041. /**
  4042. * (Highstock) The name of a symbol to use for the border around the label.
  4043. * Symbols are predefined functions on the Renderer object.
  4044. */
  4045. shape?: string;
  4046. /**
  4047. * (Highstock) Styles for the annotation's label.
  4048. */
  4049. style?: CSSObject;
  4050. /**
  4051. * (Highstock) Alias for the format option.
  4052. */
  4053. text?: string;
  4054. /**
  4055. * (Highstock) Whether to use HTML to render the annotation's label.
  4056. */
  4057. useHTML?: boolean;
  4058. /**
  4059. * (Highstock) The vertical alignment of the annotation's label.
  4060. */
  4061. verticalAlign?: VerticalAlignValue;
  4062. /**
  4063. * (Highstock) The x position offset of the label relative to the point.
  4064. * Note that if a `distance` is defined, the distance takes precedence over
  4065. * `x` and `y` options.
  4066. */
  4067. x?: number;
  4068. /**
  4069. * (Highstock) The y position offset of the label relative to the point.
  4070. * Note that if a `distance` is defined, the distance takes precedence over
  4071. * `x` and `y` options.
  4072. */
  4073. y?: number;
  4074. }
  4075. /**
  4076. * (Highstock) Line options.
  4077. */
  4078. export interface AnnotationsVerticalLineTypeLineOptions {
  4079. fill?: string;
  4080. }
  4081. /**
  4082. * (Highstock) Additional options for an annotation with the type.
  4083. */
  4084. export interface AnnotationsVerticalLineTypeOptions {
  4085. /**
  4086. * (Highstock) Connector options.
  4087. */
  4088. connector?: AnnotationsVerticalLineTypeConnectorOptions;
  4089. /**
  4090. * (Highstock) Label options.
  4091. */
  4092. label?: AnnotationsVerticalLineTypeLabelOptions;
  4093. /**
  4094. * (Highstock) Line options.
  4095. */
  4096. line?: AnnotationsVerticalLineTypeLineOptions;
  4097. points?: Array<AnnotationsVerticalLineTypePointsOptions>;
  4098. /**
  4099. * (Highstock) This number defines which xAxis the point is connected to. It
  4100. * refers to either the axis id or the index of the axis in the xAxis array.
  4101. */
  4102. xAxis?: number;
  4103. /**
  4104. * (Highstock) This number defines which yAxis the point is connected to. It
  4105. * refers to either the axis id or the index of the axis in the xAxis array.
  4106. */
  4107. yAxis?: number;
  4108. }
  4109. export interface AnnotationsVerticalLineTypePointsOptions {
  4110. controlPoint?: number;
  4111. /**
  4112. * (Highstock) The x position of the point.
  4113. */
  4114. x?: number;
  4115. /**
  4116. * (Highstock) The y position of the point.
  4117. */
  4118. y?: number;
  4119. }
  4120. /**
  4121. * Serialized form of an SVG/HTML definition, including children.
  4122. */
  4123. export interface ASTNode {
  4124. attributes?: SVGAttributes;
  4125. children?: Array<ASTNode>;
  4126. tagName?: string;
  4127. textContent?: string;
  4128. }
  4129. /**
  4130. * (Highcharts) Accessibility options for an axis. Requires the accessibility
  4131. * module.
  4132. */
  4133. export interface AxisAccessibilityOptionsObject {
  4134. /**
  4135. * (Highcharts) Description for an axis to expose to screen reader users.
  4136. */
  4137. description?: string;
  4138. /**
  4139. * (Highcharts) Enable axis accessibility features, including axis
  4140. * information in the screen reader information region. If this is disabled
  4141. * on the xAxis, the x values are not exposed to screen readers for the
  4142. * individual data points by default.
  4143. */
  4144. enabled?: boolean;
  4145. /**
  4146. * (Highcharts) Range description for an axis. Overrides the default range
  4147. * description. Set to empty to disable range description for this axis.
  4148. */
  4149. rangeDescription?: string;
  4150. }
  4151. /**
  4152. * (Highstock) A label on the axis next to the crosshair.
  4153. *
  4154. * In styled mode, the label is styled with the `.highcharts-crosshair-label`
  4155. * class.
  4156. */
  4157. export interface AxisCrosshairLabelOptions {
  4158. /**
  4159. * (Highstock) Alignment of the label compared to the axis. Defaults to
  4160. * `"left"` for right-side axes, `"right"` for left-side axes and `"center"`
  4161. * for horizontal axes.
  4162. */
  4163. align?: AlignValue;
  4164. /**
  4165. * (Highstock) The background color for the label. Defaults to the related
  4166. * series color, or `#666666` if that is not available.
  4167. */
  4168. backgroundColor?: ColorType;
  4169. /**
  4170. * (Highstock) The border color for the crosshair label
  4171. */
  4172. borderColor?: ColorType;
  4173. /**
  4174. * (Highstock) The border corner radius of the crosshair label.
  4175. */
  4176. borderRadius?: number;
  4177. /**
  4178. * (Highstock) The border width for the crosshair label.
  4179. */
  4180. borderWidth?: number;
  4181. /**
  4182. * (Highstock) Flag to enable crosshair's label.
  4183. */
  4184. enabled?: boolean;
  4185. /**
  4186. * (Highstock) A format string for the crosshair label. Defaults to
  4187. * `{value}` for numeric axes and `{value:%b %d, %Y}` for datetime axes.
  4188. */
  4189. format?: string;
  4190. /**
  4191. * (Highstock) Formatter function for the label text.
  4192. */
  4193. formatter?: XAxisCrosshairLabelFormatterCallbackFunction;
  4194. /**
  4195. * (Highstock) Padding inside the crosshair label.
  4196. */
  4197. padding?: number;
  4198. /**
  4199. * (Highstock) The shape to use for the label box.
  4200. */
  4201. shape?: string;
  4202. /**
  4203. * (Highstock) Text styles for the crosshair label.
  4204. */
  4205. style?: CSSObject;
  4206. }
  4207. /**
  4208. * (Highcharts, Highstock, Highmaps, Gantt) Configure a crosshair that follows
  4209. * either the mouse pointer or the hovered point.
  4210. *
  4211. * In styled mode, the crosshairs are styled in the `.highcharts-crosshair`,
  4212. * `.highcharts-crosshair-thin` or `.highcharts-xaxis-category` classes.
  4213. */
  4214. export interface AxisCrosshairOptions {
  4215. /**
  4216. * (Highcharts, Highstock, Highmaps, Gantt) A class name for the crosshair,
  4217. * especially as a hook for styling.
  4218. */
  4219. className?: string;
  4220. /**
  4221. * (Highcharts, Highstock, Highmaps, Gantt) The color of the crosshair.
  4222. * Defaults to `#cccccc` for numeric and datetime axes, and
  4223. * `rgba(204,214,235,0.25)` for category axes, where the crosshair by
  4224. * default highlights the whole category.
  4225. */
  4226. color?: ColorType;
  4227. /**
  4228. * (Highcharts, Highstock, Highmaps, Gantt) The dash style for the
  4229. * crosshair. See plotOptions.series.dashStyle for possible values.
  4230. */
  4231. dashStyle?: DashStyleValue;
  4232. /**
  4233. * (Highstock) A label on the axis next to the crosshair.
  4234. *
  4235. * In styled mode, the label is styled with the
  4236. * `.highcharts-crosshair-label` class.
  4237. */
  4238. label?: AxisCrosshairLabelOptions;
  4239. /**
  4240. * (Highcharts, Highstock, Highmaps, Gantt) Whether the crosshair should
  4241. * snap to the point or follow the pointer independent of points.
  4242. */
  4243. snap?: boolean;
  4244. /**
  4245. * (Highcharts, Highstock, Highmaps, Gantt) The pixel width of the
  4246. * crosshair. Defaults to 1 for numeric or datetime axes, and for one
  4247. * category width for category axes.
  4248. */
  4249. width?: number;
  4250. /**
  4251. * (Highcharts, Highstock, Highmaps, Gantt) The Z index of the crosshair.
  4252. * Higher Z indices allow drawing the crosshair on top of the series or
  4253. * behind the grid lines.
  4254. */
  4255. zIndex?: number;
  4256. }
  4257. /**
  4258. * (Gantt) Show an indicator on the axis for the current date and time. Can be a
  4259. * boolean or a configuration object similar to xAxis.plotLines.
  4260. */
  4261. export interface AxisCurrentDateIndicatorOptions {
  4262. /**
  4263. * (Highstock) Flag to decide if plotLine should be rendered across all
  4264. * panes.
  4265. */
  4266. acrossPanes?: boolean;
  4267. /**
  4268. * (Gantt) A custom class name, in addition to the default
  4269. * `highcharts-plot-line`, to apply to each individual line.
  4270. */
  4271. className?: string;
  4272. /**
  4273. * (Gantt) The color of the line.
  4274. */
  4275. color?: ColorString;
  4276. /**
  4277. * (Gantt) The dashing or dot style for the plot line. For possible values
  4278. * see this overview.
  4279. */
  4280. dashStyle?: DashStyleValue;
  4281. /**
  4282. * (Gantt) An object defining mouse events for the plot line. Supported
  4283. * properties are `click`, `mouseover`, `mouseout`, `mousemove`.
  4284. */
  4285. events?: (ColorAxisCurrentDateIndicatorEventsOptions|NavigatorXAxisCurrentDateIndicatorEventsOptions|XAxisCurrentDateIndicatorEventsOptions|ZAxisCurrentDateIndicatorEventsOptions);
  4286. /**
  4287. * (Gantt) An id used for identifying the plot line in Axis.removePlotLine.
  4288. */
  4289. id?: string;
  4290. /**
  4291. * (Gantt) Text labels for the plot bands
  4292. */
  4293. label?: (ColorAxisCurrentDateIndicatorLabelOptions|NavigatorXAxisCurrentDateIndicatorLabelOptions|XAxisCurrentDateIndicatorLabelOptions|ZAxisCurrentDateIndicatorLabelOptions);
  4294. /**
  4295. * (Gantt) The width or thickness of the plot line.
  4296. */
  4297. width?: number;
  4298. /**
  4299. * (Gantt) The z index of the plot line within the chart.
  4300. */
  4301. zIndex?: number;
  4302. }
  4303. /**
  4304. * (Highcharts, Highstock, Gantt) For a datetime axis, the scale will
  4305. * automatically adjust to the appropriate unit. This member gives the default
  4306. * string representations used for each unit. For intermediate values, different
  4307. * units may be used, for example the `day` unit can be used on midnight and
  4308. * `hour` unit be used for intermediate values on the same axis.
  4309. *
  4310. * For an overview of the replacement codes, see dateFormat.
  4311. *
  4312. * Defaults to: (see online documentation for example)
  4313. */
  4314. export interface AxisDateTimeLabelFormatsOptions {
  4315. day?: (string|AxisDateTimeLabelFormatsOptionsObject);
  4316. hour?: (string|AxisDateTimeLabelFormatsOptionsObject);
  4317. millisecond?: (string|AxisDateTimeLabelFormatsOptionsObject);
  4318. minute?: (string|AxisDateTimeLabelFormatsOptionsObject);
  4319. month?: (string|AxisDateTimeLabelFormatsOptionsObject);
  4320. second?: (string|AxisDateTimeLabelFormatsOptionsObject);
  4321. week?: (string|AxisDateTimeLabelFormatsOptionsObject);
  4322. year?: (string|AxisDateTimeLabelFormatsOptionsObject);
  4323. }
  4324. export interface AxisDateTimeLabelFormatsOptionsObject {
  4325. main?: string;
  4326. range?: boolean;
  4327. }
  4328. export interface AxisLabelsFormatterContextObject<T> {
  4329. axis: Axis;
  4330. chart: Chart;
  4331. isFirst: boolean;
  4332. isLast: boolean;
  4333. pos: number;
  4334. value: T;
  4335. }
  4336. /**
  4337. * Options for the path on the Axis to be calculated.
  4338. */
  4339. export interface AxisPlotLinePathOptionsObject {
  4340. /**
  4341. * Used in Highstock. When `true`, plot paths (crosshair, plotLines,
  4342. * gridLines) will be rendered on all axes when defined on the first axis.
  4343. */
  4344. acrossPanes?: boolean;
  4345. /**
  4346. * If `false`, the function will return null when it falls outside the axis
  4347. * bounds. If `true`, the function will return a path aligned to the plot
  4348. * area sides if it falls outside. If `pass`, it will return a path outside.
  4349. */
  4350. force?: (boolean|string);
  4351. /**
  4352. * Line width used for calculation crisp line coordinates. Defaults to 1.
  4353. */
  4354. lineWidth?: number;
  4355. /**
  4356. * Use old coordinates (for resizing and rescaling). If not set, defaults to
  4357. * `false`.
  4358. */
  4359. old?: boolean;
  4360. /**
  4361. * Used in Polar axes. Reverse the positions for concatenation of polygonal
  4362. * plot bands
  4363. */
  4364. reverse?: boolean;
  4365. /**
  4366. * If given, return the plot line path of a pixel position on the axis.
  4367. */
  4368. translatedValue?: number;
  4369. /**
  4370. * Axis value.
  4371. */
  4372. value?: number;
  4373. }
  4374. export interface AxisPointBreakEventObject {
  4375. brk: Dictionary<number>;
  4376. point: Point;
  4377. preventDefault: Function;
  4378. target: SVGElement;
  4379. type: ("pointBreak"|"pointInBreak");
  4380. }
  4381. export interface AxisSetExtremesEventObject extends ExtremesObject {
  4382. preventDefault: Function;
  4383. target: SVGElement;
  4384. trigger: (string|AxisExtremesTriggerValue);
  4385. type: "setExtremes";
  4386. }
  4387. /**
  4388. * Time ticks.
  4389. */
  4390. export interface AxisTickPositionsArray extends Array<number> {
  4391. info?: TimeTicksInfoObject;
  4392. }
  4393. /**
  4394. * Bounding box of an element.
  4395. */
  4396. export interface BBoxObject extends PositionObject {
  4397. /**
  4398. * Height of the bounding box.
  4399. */
  4400. height: number;
  4401. /**
  4402. * Width of the bounding box.
  4403. */
  4404. width: number;
  4405. /**
  4406. * Horizontal position of the bounding box.
  4407. */
  4408. x: number;
  4409. /**
  4410. * Vertical position of the bounding box.
  4411. */
  4412. y: number;
  4413. }
  4414. /**
  4415. * (Highcharts, Highstock) Debugging options for boost. Useful for benchmarking,
  4416. * and general timing.
  4417. */
  4418. export interface BoostDebugOptions {
  4419. /**
  4420. * (Highcharts, Highstock) Show the number of points skipped through
  4421. * culling.
  4422. *
  4423. * When set to true, the number of points skipped in series processing is
  4424. * outputted. Points are skipped if they are closer than 1 pixel from each
  4425. * other.
  4426. */
  4427. showSkipSummary?: boolean;
  4428. /**
  4429. * (Highcharts, Highstock) Time the WebGL to SVG buffer copy
  4430. *
  4431. * After rendering, the result is copied to an image which is injected into
  4432. * the SVG.
  4433. *
  4434. * If this property is set to true, the time it takes for the buffer copy to
  4435. * complete is outputted.
  4436. */
  4437. timeBufferCopy?: boolean;
  4438. /**
  4439. * (Highcharts, Highstock) Time the building of the k-d tree.
  4440. *
  4441. * This outputs the time spent building the k-d tree used for markers etc.
  4442. *
  4443. * Note that the k-d tree is built async, and runs post-rendering.
  4444. * Following, it does not affect the performance of the rendering itself.
  4445. */
  4446. timeKDTree?: boolean;
  4447. /**
  4448. * (Highcharts, Highstock) Time the series rendering.
  4449. *
  4450. * This outputs the time spent on actual rendering in the console when set
  4451. * to true.
  4452. */
  4453. timeRendering?: boolean;
  4454. /**
  4455. * (Highcharts, Highstock) Time the series processing.
  4456. *
  4457. * This outputs the time spent on transforming the series data to vertex
  4458. * buffers when set to true.
  4459. */
  4460. timeSeriesProcessing?: boolean;
  4461. /**
  4462. * (Highcharts, Highstock) Time the the WebGL setup.
  4463. *
  4464. * This outputs the time spent on setting up the WebGL context, creating
  4465. * shaders, and textures.
  4466. */
  4467. timeSetup?: boolean;
  4468. }
  4469. /**
  4470. * (Highcharts, Highstock) Options for the Boost module. The Boost module allows
  4471. * certain series types to be rendered by WebGL instead of the default SVG. This
  4472. * allows hundreds of thousands of data points to be rendered in milliseconds.
  4473. * In addition to the WebGL rendering it saves time by skipping processing and
  4474. * inspection of the data wherever possible. This introduces some limitations to
  4475. * what features are available in boost mode. See the docs for details.
  4476. *
  4477. * In addition to the global `boost` option, each series has a boostThreshold
  4478. * that defines when the boost should kick in.
  4479. *
  4480. * Requires the `modules/boost.js` module.
  4481. */
  4482. export interface BoostOptions {
  4483. /**
  4484. * (Highcharts, Highstock) If set to true, the whole chart will be boosted
  4485. * if one of the series crosses its threshold, and all the series can be
  4486. * boosted.
  4487. */
  4488. allowForce?: boolean;
  4489. /**
  4490. * (Highcharts, Highstock) Debugging options for boost. Useful for
  4491. * benchmarking, and general timing.
  4492. */
  4493. debug?: BoostDebugOptions;
  4494. /**
  4495. * (Highcharts, Highstock) Enable or disable boost on a chart.
  4496. */
  4497. enabled?: boolean;
  4498. /**
  4499. * (Highcharts, Highstock) Set the series threshold for when the boost
  4500. * should kick in globally.
  4501. *
  4502. * Setting to e.g. 20 will cause the whole chart to enter boost mode if
  4503. * there are 20 or more series active. When the chart is in boost mode,
  4504. * every series in it will be rendered to a common canvas. This offers a
  4505. * significant speed improvment in charts with a very high amount of series.
  4506. */
  4507. seriesThreshold?: (number|null);
  4508. /**
  4509. * (Highcharts, Highstock) Enable or disable GPU translations. GPU
  4510. * translations are faster than doing the translation in JavaScript.
  4511. *
  4512. * This option may cause rendering issues with certain datasets. Namely, if
  4513. * your dataset has large numbers with small increments (such as
  4514. * timestamps), it won't work correctly. This is due to floating point
  4515. * precission.
  4516. */
  4517. useGPUTranslations?: boolean;
  4518. /**
  4519. * (Highcharts, Highstock) Enable or disable pre-allocation of vertex
  4520. * buffers.
  4521. *
  4522. * Enabling this will make it so that the binary data arrays required for
  4523. * storing the series data will be allocated prior to transforming the data
  4524. * to a WebGL-compatible format.
  4525. *
  4526. * This saves a copy operation on the order of O(n) and so is significantly
  4527. * more performant. However, this is currently an experimental option, and
  4528. * may cause visual artifacts with some datasets.
  4529. *
  4530. * As such, care should be taken when using this setting to make sure that
  4531. * it doesn't cause any rendering glitches with the given use-case.
  4532. */
  4533. usePreallocated?: boolean;
  4534. }
  4535. export interface BubbleLegendFormatterContextObject {
  4536. /**
  4537. * The center y position of the range.
  4538. */
  4539. center: number;
  4540. /**
  4541. * The radius of the bubble range.
  4542. */
  4543. radius: number;
  4544. /**
  4545. * The bubble value.
  4546. */
  4547. value: number;
  4548. }
  4549. /**
  4550. * The chart caption. The caption has an `update` method that allows modifying
  4551. * the options directly or indirectly via `chart.update`.
  4552. */
  4553. export interface CaptionObject extends SVGElement {
  4554. /**
  4555. * Modify options for the caption.
  4556. *
  4557. * @param captionOptions
  4558. * Options to modify.
  4559. *
  4560. * @param redraw
  4561. * Whether to redraw the chart after the caption is altered. If doing
  4562. * more operations on the chart, it is a good idea to set redraw to
  4563. * false and call Chart#redraw after.
  4564. */
  4565. update(captionOptions: CaptionOptions, redraw?: boolean): void;
  4566. }
  4567. /**
  4568. * (Highcharts, Highstock, Highmaps, Gantt) The chart's caption, which will
  4569. * render below the chart and will be part of exported charts. The caption can
  4570. * be updated after chart initialization through the `Chart.update` or
  4571. * `Chart.caption.update` methods.
  4572. */
  4573. export interface CaptionOptions {
  4574. /**
  4575. * (Highcharts, Highstock, Highmaps, Gantt) The horizontal alignment of the
  4576. * caption. Can be one of "left", "center" and "right".
  4577. */
  4578. align?: AlignValue;
  4579. /**
  4580. * (Highcharts, Highstock, Highmaps, Gantt) When the caption is floating,
  4581. * the plot area will not move to make space for it.
  4582. */
  4583. floating?: boolean;
  4584. /**
  4585. * (Highcharts, Highstock, Highmaps, Gantt) The margin between the caption
  4586. * and the plot area.
  4587. */
  4588. margin?: number;
  4589. /**
  4590. * (Highcharts, Highstock, Highmaps, Gantt) CSS styles for the caption.
  4591. *
  4592. * In styled mode, the caption style is given in the `.highcharts-caption`
  4593. * class.
  4594. */
  4595. style?: CSSObject;
  4596. /**
  4597. * (Highcharts, Highstock, Highmaps, Gantt) The caption text of the chart.
  4598. */
  4599. text?: string;
  4600. /**
  4601. * (Highcharts, Highstock, Highmaps, Gantt) Whether to use HTML to render
  4602. * the text.
  4603. */
  4604. useHTML?: boolean;
  4605. /**
  4606. * (Highcharts, Highstock, Highmaps, Gantt) The vertical alignment of the
  4607. * caption. Can be one of `"top"`, `"middle"` and `"bottom"`. When middle,
  4608. * the caption behaves as floating.
  4609. */
  4610. verticalAlign?: VerticalAlignValue;
  4611. /**
  4612. * (Highcharts, Highstock, Highmaps, Gantt) The x position of the caption
  4613. * relative to the alignment within `chart.spacingLeft` and
  4614. * `chart.spacingRight`.
  4615. */
  4616. x?: number;
  4617. /**
  4618. * (Highcharts, Highstock, Highmaps, Gantt) The y position of the caption
  4619. * relative to the alignment within `chart.spacingTop` and
  4620. * `chart.spacingBottom`.
  4621. */
  4622. y?: number;
  4623. }
  4624. /**
  4625. * (Highcharts) The back side of the frame around a 3D chart.
  4626. */
  4627. export interface Chart3dFrameBackOptions {
  4628. /**
  4629. * (Highcharts) The color of the panel.
  4630. */
  4631. color?: (ColorString|GradientColorObject|PatternObject);
  4632. /**
  4633. * (Highcharts) The thickness of the panel.
  4634. */
  4635. size?: number;
  4636. /**
  4637. * (Highcharts) Whether to display the frame. Possible values are `true`,
  4638. * `false`, `"auto"` to display only the frames behind the data, and
  4639. * `"default"` to display faces behind the data based on the axis layout,
  4640. * ignoring the point of view.
  4641. */
  4642. visible?: ("auto"|"default"|boolean);
  4643. }
  4644. /**
  4645. * (Highcharts) The bottom of the frame around a 3D chart.
  4646. */
  4647. export interface Chart3dFrameBottomOptions {
  4648. /**
  4649. * (Highcharts) The color of the panel.
  4650. */
  4651. color?: (ColorString|GradientColorObject|PatternObject);
  4652. /**
  4653. * (Highcharts) The thickness of the panel.
  4654. */
  4655. size?: number;
  4656. /**
  4657. * (Highcharts) Whether to display the frame. Possible values are `true`,
  4658. * `false`, `"auto"` to display only the frames behind the data, and
  4659. * `"default"` to display faces behind the data based on the axis layout,
  4660. * ignoring the point of view.
  4661. */
  4662. visible?: ("auto"|"default"|boolean);
  4663. }
  4664. /**
  4665. * (Highcharts) The front of the frame around a 3D chart.
  4666. */
  4667. export interface Chart3dFrameFrontOptions {
  4668. /**
  4669. * (Highcharts) The color of the panel.
  4670. */
  4671. color?: (ColorString|GradientColorObject|PatternObject);
  4672. /**
  4673. * (Highcharts) The thickness of the panel.
  4674. */
  4675. size?: number;
  4676. /**
  4677. * (Highcharts) Whether to display the frame. Possible values are `true`,
  4678. * `false`, `"auto"` to display only the frames behind the data, and
  4679. * `"default"` to display faces behind the data based on the axis layout,
  4680. * ignoring the point of view.
  4681. */
  4682. visible?: ("auto"|"default"|boolean);
  4683. }
  4684. /**
  4685. * (Highcharts) The left side of the frame around a 3D chart.
  4686. */
  4687. export interface Chart3dFrameLeftOptions {
  4688. /**
  4689. * (Highcharts) The color of the panel.
  4690. */
  4691. color?: (ColorString|GradientColorObject|PatternObject);
  4692. /**
  4693. * (Highcharts) The thickness of the panel.
  4694. */
  4695. size?: number;
  4696. /**
  4697. * (Highcharts) Whether to display the frame. Possible values are `true`,
  4698. * `false`, `"auto"` to display only the frames behind the data, and
  4699. * `"default"` to display faces behind the data based on the axis layout,
  4700. * ignoring the point of view.
  4701. */
  4702. visible?: ("auto"|"default"|boolean);
  4703. }
  4704. /**
  4705. * (Highcharts) Provides the option to draw a frame around the charts by
  4706. * defining a bottom, front and back panel.
  4707. */
  4708. export interface Chart3dFrameOptions {
  4709. /**
  4710. * (Highcharts) The back side of the frame around a 3D chart.
  4711. */
  4712. back?: Chart3dFrameBackOptions;
  4713. /**
  4714. * (Highcharts) The bottom of the frame around a 3D chart.
  4715. */
  4716. bottom?: Chart3dFrameBottomOptions;
  4717. /**
  4718. * (Highcharts) The front of the frame around a 3D chart.
  4719. */
  4720. front?: Chart3dFrameFrontOptions;
  4721. /**
  4722. * (Highcharts) The left side of the frame around a 3D chart.
  4723. */
  4724. left?: Chart3dFrameLeftOptions;
  4725. /**
  4726. * (Highcharts) The right of the frame around a 3D chart.
  4727. */
  4728. right?: Chart3dFrameRightOptions;
  4729. /**
  4730. * (Highcharts) General pixel thickness for the frame faces.
  4731. */
  4732. size?: number;
  4733. /**
  4734. * (Highcharts) The top of the frame around a 3D chart.
  4735. */
  4736. top?: Chart3dFrameTopOptions;
  4737. /**
  4738. * (Highcharts) Whether the frames are visible.
  4739. */
  4740. visible?: string;
  4741. }
  4742. /**
  4743. * (Highcharts) The right of the frame around a 3D chart.
  4744. */
  4745. export interface Chart3dFrameRightOptions {
  4746. /**
  4747. * (Highcharts) The color of the panel.
  4748. */
  4749. color?: (ColorString|GradientColorObject|PatternObject);
  4750. /**
  4751. * (Highcharts) The thickness of the panel.
  4752. */
  4753. size?: number;
  4754. /**
  4755. * (Highcharts) Whether to display the frame. Possible values are `true`,
  4756. * `false`, `"auto"` to display only the frames behind the data, and
  4757. * `"default"` to display faces behind the data based on the axis layout,
  4758. * ignoring the point of view.
  4759. */
  4760. visible?: ("auto"|"default"|boolean);
  4761. }
  4762. /**
  4763. * (Highcharts) The top of the frame around a 3D chart.
  4764. */
  4765. export interface Chart3dFrameTopOptions {
  4766. /**
  4767. * (Highcharts) The color of the panel.
  4768. */
  4769. color?: (ColorString|GradientColorObject|PatternObject);
  4770. /**
  4771. * (Highcharts) The thickness of the panel.
  4772. */
  4773. size?: number;
  4774. /**
  4775. * (Highcharts) Whether to display the frame. Possible values are `true`,
  4776. * `false`, `"auto"` to display only the frames behind the data, and
  4777. * `"default"` to display faces behind the data based on the axis layout,
  4778. * ignoring the point of view.
  4779. */
  4780. visible?: ("auto"|"default"|boolean);
  4781. }
  4782. /**
  4783. * (Highcharts) Options to render charts in 3 dimensions. This feature requires
  4784. * `highcharts-3d.js`, found in the download package or online at
  4785. * code.highcharts.com/highcharts-3d.js.
  4786. */
  4787. export interface Chart3dOptions {
  4788. /**
  4789. * (Highcharts) One of the two rotation angles for the chart.
  4790. */
  4791. alpha?: number;
  4792. /**
  4793. * (Highcharts) Set it to `"auto"` to automatically move the labels to the
  4794. * best edge.
  4795. */
  4796. axisLabelPosition?: ("auto"|null);
  4797. /**
  4798. * (Highcharts) One of the two rotation angles for the chart.
  4799. */
  4800. beta?: number;
  4801. /**
  4802. * (Highcharts) The total depth of the chart.
  4803. */
  4804. depth?: number;
  4805. /**
  4806. * (Highcharts) Wether to render the chart using the 3D functionality.
  4807. */
  4808. enabled?: boolean;
  4809. /**
  4810. * (Highcharts) Whether the 3d box should automatically adjust to the chart
  4811. * plot area.
  4812. */
  4813. fitToPlot?: boolean;
  4814. /**
  4815. * (Highcharts) Provides the option to draw a frame around the charts by
  4816. * defining a bottom, front and back panel.
  4817. */
  4818. frame?: Chart3dFrameOptions;
  4819. /**
  4820. * (Highcharts) Defines the distance the viewer is standing in front of the
  4821. * chart, this setting is important to calculate the perspective effect in
  4822. * column and scatter charts. It is not used for 3D pie charts.
  4823. */
  4824. viewDistance?: number;
  4825. }
  4826. /**
  4827. * Contains common event information. Through the `options` property you can
  4828. * access the series options that were passed to the `addSeries` method.
  4829. */
  4830. export interface ChartAddSeriesEventObject {
  4831. /**
  4832. * The series options that were passed to the `addSeries` method.
  4833. */
  4834. options: SeriesOptionsType;
  4835. /**
  4836. * Prevents the default behaviour of the event.
  4837. */
  4838. preventDefault: Function;
  4839. /**
  4840. * The event target.
  4841. */
  4842. target: Chart;
  4843. /**
  4844. * The event type.
  4845. */
  4846. type: "addSeries";
  4847. }
  4848. /**
  4849. * Contains an axes of the clicked spot.
  4850. */
  4851. export interface ChartClickEventAxisObject {
  4852. /**
  4853. * Axis at the clicked spot.
  4854. */
  4855. axis: Axis;
  4856. /**
  4857. * Axis value at the clicked spot.
  4858. */
  4859. value: number;
  4860. }
  4861. /**
  4862. * Contains information about the clicked spot on the chart. Remember the unit
  4863. * of a datetime axis is milliseconds since 1970-01-01 00:00:00.
  4864. */
  4865. export interface ChartClickEventObject extends PointerEventObject {
  4866. /**
  4867. * Information about the x-axis on the clicked spot.
  4868. */
  4869. xAxis: Array<ChartClickEventAxisObject>;
  4870. /**
  4871. * Information about the y-axis on the clicked spot.
  4872. */
  4873. yAxis: Array<ChartClickEventAxisObject>;
  4874. /**
  4875. * Information about the z-axis on the clicked spot.
  4876. */
  4877. zAxis?: Array<ChartClickEventAxisObject>;
  4878. }
  4879. /**
  4880. * (Highcharts, Highstock, Highmaps, Gantt) Event listeners for the chart.
  4881. */
  4882. export interface ChartEventsOptions {
  4883. /**
  4884. * (Highcharts, Highstock, Highmaps, Gantt) Fires when a series is added to
  4885. * the chart after load time, using the `addSeries` method. One parameter,
  4886. * `event`, is passed to the function, containing common event information.
  4887. * Through `event.options` you can access the series options that were
  4888. * passed to the `addSeries` method. Returning false prevents the series
  4889. * from being added.
  4890. */
  4891. addSeries?: ChartAddSeriesCallbackFunction;
  4892. /**
  4893. * (Highcharts, Highstock, Highmaps, Gantt) Fires after a chart is printed
  4894. * through the context menu item or the `Chart.print` method.
  4895. */
  4896. afterPrint?: ExportingAfterPrintCallbackFunction;
  4897. /**
  4898. * (Highcharts, Highstock, Highmaps, Gantt) Fires before a chart is printed
  4899. * through the context menu item or the `Chart.print` method.
  4900. */
  4901. beforePrint?: ExportingBeforePrintCallbackFunction;
  4902. /**
  4903. * (Highcharts, Highstock, Highmaps, Gantt) Fires when clicking on the plot
  4904. * background. One parameter, `event`, is passed to the function, containing
  4905. * common event information.
  4906. *
  4907. * Information on the clicked spot can be found through `event.xAxis` and
  4908. * `event.yAxis`, which are arrays containing the axes of each dimension and
  4909. * each axis' value at the clicked spot. The primary axes are
  4910. * `event.xAxis[0]` and `event.yAxis[0]`. Remember the unit of a datetime
  4911. * axis is milliseconds since 1970-01-01 00:00:00. (see online documentation
  4912. * for example)
  4913. */
  4914. click?: ChartClickCallbackFunction;
  4915. /**
  4916. * (Highcharts, Highmaps) Fires when a drilldown point is clicked, before
  4917. * the new series is added. This event is also utilized for async drilldown,
  4918. * where the seriesOptions are not added by option, but rather loaded async.
  4919. * Note that when clicking a category label to trigger multiple series
  4920. * drilldown, one `drilldown` event is triggered per point in the category.
  4921. *
  4922. * Event arguments:
  4923. *
  4924. * - `category`: If a category label was clicked, which index.
  4925. *
  4926. * - `originalEvent`: The original browser event (usually click) that
  4927. * triggered the drilldown.
  4928. *
  4929. * - `point`: The originating point.
  4930. *
  4931. * - `points`: If a category label was clicked, this array holds all points
  4932. * corresponding to the category.
  4933. *
  4934. * - `seriesOptions`: Options for the new series.
  4935. */
  4936. drilldown?: DrilldownCallbackFunction;
  4937. /**
  4938. * (Highcharts, Highmaps) Fires when drilling up from a drilldown series.
  4939. */
  4940. drillup?: DrillupCallbackFunction;
  4941. /**
  4942. * (Highcharts, Highmaps) In a chart with multiple drilldown series, this
  4943. * event fires after all the series have been drilled up.
  4944. */
  4945. drillupall?: DrillupAllCallbackFunction;
  4946. /**
  4947. * (Highcharts, Highstock, Highmaps, Gantt) Callback that fires while
  4948. * exporting data. This allows the modification of data rows before
  4949. * processed into the final format.
  4950. */
  4951. exportData?: ExportDataCallbackFunction;
  4952. /**
  4953. * (Highcharts, Highstock, Highmaps, Gantt) Fires when the chart is finished
  4954. * loading. Since v4.2.2, it also waits for images to be loaded, for example
  4955. * from point markers. One parameter, `event`, is passed to the function,
  4956. * containing common event information.
  4957. *
  4958. * There is also a second parameter to the chart constructor where a
  4959. * callback function can be passed to be executed on chart.load.
  4960. */
  4961. load?: ChartLoadCallbackFunction;
  4962. /**
  4963. * (Highcharts, Highstock, Highmaps, Gantt) Fires when the chart is redrawn,
  4964. * either after a call to `chart.redraw()` or after an axis, series or point
  4965. * is modified with the `redraw` option set to `true`. One parameter,
  4966. * `event`, is passed to the function, containing common event information.
  4967. */
  4968. redraw?: ChartRedrawCallbackFunction;
  4969. /**
  4970. * (Highcharts, Highstock, Highmaps, Gantt) Fires after initial load of the
  4971. * chart (directly after the `load` event), and after each redraw (directly
  4972. * after the `redraw` event).
  4973. */
  4974. render?: ChartRenderCallbackFunction;
  4975. /**
  4976. * (Highcharts, Highstock, Highmaps, Gantt) Fires when an area of the chart
  4977. * has been selected. Selection is enabled by setting the chart's zoomType.
  4978. * One parameter, `event`, is passed to the function, containing common
  4979. * event information. The default action for the selection event is to zoom
  4980. * the chart to the selected area. It can be prevented by calling
  4981. * `event.preventDefault()` or return false.
  4982. *
  4983. * Information on the selected area can be found through `event.xAxis` and
  4984. * `event.yAxis`, which are arrays containing the axes of each dimension and
  4985. * each axis' min and max values. The primary axes are `event.xAxis[0]` and
  4986. * `event.yAxis[0]`. Remember the unit of a datetime axis is milliseconds
  4987. * since 1970-01-01 00:00:00. (see online documentation for example)
  4988. */
  4989. selection?: ChartSelectionCallbackFunction;
  4990. }
  4991. /**
  4992. * (Highcharts, Highstock, Highmaps, Gantt) General options for the chart.
  4993. */
  4994. export interface ChartOptions {
  4995. /**
  4996. * (Highcharts, Highstock, Gantt) When using multiple axis, the ticks of two
  4997. * or more opposite axes will automatically be aligned by adding ticks to
  4998. * the axis or axes with the least ticks, as if `tickAmount` were specified.
  4999. *
  5000. * This can be prevented by setting `alignTicks` to false. If the grid lines
  5001. * look messy, it's a good idea to hide them for the secondary axis by
  5002. * setting `gridLineWidth` to 0.
  5003. *
  5004. * If `startOnTick` or `endOnTick` in an Axis options are set to false, then
  5005. * the `alignTicks ` will be disabled for the Axis.
  5006. *
  5007. * Disabled for logarithmic axes.
  5008. */
  5009. alignTicks?: boolean;
  5010. /**
  5011. * (Highcharts, Highstock, Highmaps, Gantt) Set the overall animation for
  5012. * all chart updating. Animation can be disabled throughout the chart by
  5013. * setting it to false here. It can be overridden for each individual API
  5014. * method as a function parameter. The only animation not affected by this
  5015. * option is the initial series animation, see plotOptions.series.animation.
  5016. *
  5017. * The animation can either be set as a boolean or a configuration object.
  5018. * If `true`, it will use the 'swing' jQuery easing and a duration of 500
  5019. * ms. If used as a configuration object, the following properties are
  5020. * supported:
  5021. *
  5022. * - `defer`: The animation delay time in milliseconds.
  5023. *
  5024. * - `duration`: The duration of the animation in milliseconds.
  5025. *
  5026. * - `easing`: A string reference to an easing function set on the `Math`
  5027. * object. See the easing demo.
  5028. *
  5029. * When zooming on a series with less than 100 points, the chart redraw will
  5030. * be done with animation, but in case of more data points, it is necessary
  5031. * to set this option to ensure animation on zoom.
  5032. */
  5033. animation?: (boolean|Partial<AnimationOptionsObject>);
  5034. /**
  5035. * (Highcharts, Highstock, Highmaps, Gantt) The background color or gradient
  5036. * for the outer chart area.
  5037. */
  5038. backgroundColor?: (ColorString|GradientColorObject|PatternObject);
  5039. /**
  5040. * (Highcharts, Highstock, Highmaps, Gantt) The color of the outer chart
  5041. * border.
  5042. */
  5043. borderColor?: (ColorString|GradientColorObject|PatternObject);
  5044. /**
  5045. * (Highcharts, Highstock, Highmaps, Gantt) The corner radius of the outer
  5046. * chart border.
  5047. */
  5048. borderRadius?: number;
  5049. /**
  5050. * (Highcharts, Highstock, Highmaps, Gantt) The pixel width of the outer
  5051. * chart border.
  5052. */
  5053. borderWidth?: number;
  5054. /**
  5055. * (Highcharts, Highstock, Highmaps, Gantt) A CSS class name to apply to the
  5056. * charts container `div`, allowing unique CSS styling for each chart.
  5057. */
  5058. className?: string;
  5059. /**
  5060. * (Highcharts, Highstock, Highmaps, Gantt) In styled mode, this sets how
  5061. * many colors the class names should rotate between. With ten colors,
  5062. * series (or points) are given class names like `highcharts-color-0`,
  5063. * `highcharts-color-0` [...] `highcharts-color-9`. The equivalent in
  5064. * non-styled mode is to set colors using the colors setting.
  5065. */
  5066. colorCount?: number;
  5067. /**
  5068. * (Highcharts, Highstock, Highmaps, Gantt) Whether to display errors on the
  5069. * chart. When `false`, the errors will be shown only in the console.
  5070. */
  5071. displayErrors?: boolean;
  5072. /**
  5073. * (Highcharts, Highstock, Highmaps, Gantt) Event listeners for the chart.
  5074. */
  5075. events?: ChartEventsOptions;
  5076. /**
  5077. * (Highcharts, Highstock, Highmaps, Gantt) An explicit height for the
  5078. * chart. If a _number_, the height is given in pixels. If given a
  5079. * _percentage string_ (for example `'56%'`), the height is given as the
  5080. * percentage of the actual chart width. This allows for preserving the
  5081. * aspect ratio across responsive sizes.
  5082. *
  5083. * By default (when `null`) the height is calculated from the offset height
  5084. * of the containing element, or 400 pixels if the containing element's
  5085. * height is 0.
  5086. */
  5087. height?: (number|string|null);
  5088. /**
  5089. * (Highcharts, Highstock, Gantt) If true, the axes will scale to the
  5090. * remaining visible series once one series is hidden. If false, hiding and
  5091. * showing a series will not affect the axes or the other series. For
  5092. * stacks, once one series within the stack is hidden, the rest of the stack
  5093. * will close in around it even if the axis is not affected.
  5094. */
  5095. ignoreHiddenSeries?: boolean;
  5096. /**
  5097. * (Highcharts, Highstock, Gantt) Whether to invert the axes so that the x
  5098. * axis is vertical and y axis is horizontal. When `true`, the x axis is
  5099. * reversed by default.
  5100. */
  5101. inverted?: boolean;
  5102. /**
  5103. * (Highmaps) Default `mapData` for all series. If set to a string, it
  5104. * functions as an index into the `Highcharts.maps` array. Otherwise it is
  5105. * interpreted as map data.
  5106. */
  5107. map?: (string|GeoJSON|Array<any>);
  5108. /**
  5109. * (Highmaps) Set lat/lon transformation definitions for the chart. If not
  5110. * defined, these are extracted from the map data.
  5111. */
  5112. mapTransforms?: any;
  5113. /**
  5114. * (Highcharts, Highstock, Highmaps, Gantt) The margin between the outer
  5115. * edge of the chart and the plot area. The numbers in the array designate
  5116. * top, right, bottom and left respectively. Use the options `marginTop`,
  5117. * `marginRight`, `marginBottom` and `marginLeft` for shorthand setting of
  5118. * one option.
  5119. *
  5120. * By default there is no margin. The actual space is dynamically calculated
  5121. * from the offset of axis labels, axis title, title, subtitle and legend in
  5122. * addition to the `spacingTop`, `spacingRight`, `spacingBottom` and
  5123. * `spacingLeft` options.
  5124. */
  5125. margin?: (number|Array<number>);
  5126. /**
  5127. * (Highcharts, Highstock, Highmaps, Gantt) The margin between the bottom
  5128. * outer edge of the chart and the plot area. Use this to set a fixed pixel
  5129. * value for the margin as opposed to the default dynamic margin. See also
  5130. * `spacingBottom`.
  5131. */
  5132. marginBottom?: number;
  5133. /**
  5134. * (Highcharts, Highstock, Highmaps, Gantt) The margin between the left
  5135. * outer edge of the chart and the plot area. Use this to set a fixed pixel
  5136. * value for the margin as opposed to the default dynamic margin. See also
  5137. * `spacingLeft`.
  5138. */
  5139. marginLeft?: number;
  5140. /**
  5141. * (Highcharts, Highstock, Highmaps, Gantt) The margin between the right
  5142. * outer edge of the chart and the plot area. Use this to set a fixed pixel
  5143. * value for the margin as opposed to the default dynamic margin. See also
  5144. * `spacingRight`.
  5145. */
  5146. marginRight?: number;
  5147. /**
  5148. * (Highcharts, Highstock, Highmaps, Gantt) The margin between the top outer
  5149. * edge of the chart and the plot area. Use this to set a fixed pixel value
  5150. * for the margin as opposed to the default dynamic margin. See also
  5151. * `spacingTop`.
  5152. */
  5153. marginTop?: number;
  5154. /**
  5155. * (Highcharts, Highstock, Highmaps, Gantt) Callback function to override
  5156. * the default function that formats all the numbers in the chart. Returns a
  5157. * string with the formatted number.
  5158. */
  5159. numberFormatter?: NumberFormatterCallbackFunction;
  5160. /**
  5161. * (Highcharts) Options to render charts in 3 dimensions. This feature
  5162. * requires `highcharts-3d.js`, found in the download package or online at
  5163. * code.highcharts.com/highcharts-3d.js.
  5164. */
  5165. options3d?: Chart3dOptions;
  5166. /**
  5167. * (Highcharts, Gantt) Allows setting a key to switch between zooming and
  5168. * panning. Can be one of `alt`, `ctrl`, `meta` (the command key on Mac and
  5169. * Windows key on Windows) or `shift`. The keys are mapped directly to the
  5170. * key properties of the click event argument (`event.altKey`,
  5171. * `event.ctrlKey`, `event.metaKey` and `event.shiftKey`).
  5172. */
  5173. panKey?: OptionsPanKeyValue;
  5174. /**
  5175. * (Highcharts, Highstock, Gantt) Allow panning in a chart. Best used with
  5176. * panKey to combine zooming and panning.
  5177. *
  5178. * On touch devices, when the tooltip.followTouchMove option is `true`
  5179. * (default), panning requires two fingers. To allow panning with one
  5180. * finger, set `followTouchMove` to `false`.
  5181. */
  5182. panning?: ChartPanningOptions;
  5183. /**
  5184. * (Highcharts) Common options for all yAxes rendered in a parallel
  5185. * coordinates plot. This feature requires
  5186. * `modules/parallel-coordinates.js`.
  5187. *
  5188. * The default options are: (see online documentation for example)
  5189. */
  5190. parallelAxes?: (ChartParallelAxesOptions|Array<ChartParallelAxesOptions>);
  5191. /**
  5192. * (Highcharts) Flag to render charts as a parallel coordinates plot. In a
  5193. * parallel coordinates plot (||-coords) by default all required yAxes are
  5194. * generated and the legend is disabled. This feature requires
  5195. * `modules/parallel-coordinates.js`.
  5196. */
  5197. parallelCoordinates?: boolean;
  5198. /**
  5199. * (Highcharts, Highstock, Gantt) Equivalent to zoomType, but for multitouch
  5200. * gestures only. By default, the `pinchType` is the same as the `zoomType`
  5201. * setting. However, pinching can be enabled separately in some cases, for
  5202. * example in stock charts where a mouse drag pans the chart, while pinching
  5203. * is enabled. When tooltip.followTouchMove is true, pinchType only applies
  5204. * to two-finger touches.
  5205. */
  5206. pinchType?: OptionsPinchTypeValue;
  5207. /**
  5208. * (Highcharts, Highstock, Highmaps, Gantt) The background color or gradient
  5209. * for the plot area.
  5210. */
  5211. plotBackgroundColor?: (ColorString|GradientColorObject|PatternObject);
  5212. /**
  5213. * (Highcharts, Highstock, Highmaps, Gantt) The URL for an image to use as
  5214. * the plot background. To set an image as the background for the entire
  5215. * chart, set a CSS background image to the container element. Note that for
  5216. * the image to be applied to exported charts, its URL needs to be
  5217. * accessible by the export server.
  5218. */
  5219. plotBackgroundImage?: string;
  5220. /**
  5221. * (Highcharts, Highstock, Highmaps, Gantt) The color of the inner chart or
  5222. * plot area border.
  5223. */
  5224. plotBorderColor?: (ColorString|GradientColorObject|PatternObject);
  5225. /**
  5226. * (Highcharts, Highstock, Highmaps, Gantt) The pixel width of the plot area
  5227. * border.
  5228. */
  5229. plotBorderWidth?: number;
  5230. /**
  5231. * (Highcharts, Highstock, Highmaps, Gantt) Whether to apply a drop shadow
  5232. * to the plot area. Requires that plotBackgroundColor be set. The shadow
  5233. * can be an object configuration containing `color`, `offsetX`, `offsetY`,
  5234. * `opacity` and `width`.
  5235. */
  5236. plotShadow?: (boolean|CSSObject);
  5237. /**
  5238. * (Highcharts) When true, cartesian charts like line, spline, area and
  5239. * column are transformed into the polar coordinate system. This produces
  5240. * _polar charts_, also known as _radar charts_.
  5241. */
  5242. polar?: boolean;
  5243. /**
  5244. * (Highmaps) Allows to manually load the proj4 library from Highcharts
  5245. * options instead of the `window`. In case of loading the library from a
  5246. * `script` tag, this option is not needed, it will be loaded from there by
  5247. * default.
  5248. */
  5249. proj4?: Function;
  5250. /**
  5251. * (Highcharts, Highstock, Highmaps, Gantt) Whether to reflow the chart to
  5252. * fit the width of the container div on resizing the window.
  5253. */
  5254. reflow?: boolean;
  5255. /**
  5256. * (Highcharts, Highstock, Highmaps, Gantt) The HTML element where the chart
  5257. * will be rendered. If it is a string, the element by that id is used. The
  5258. * HTML element can also be passed by direct reference, or as the first
  5259. * argument of the chart constructor, in which case the option is not
  5260. * needed.
  5261. */
  5262. renderTo?: (string|HTMLDOMElement);
  5263. /**
  5264. * (Highcharts, Highstock, Highmaps, Gantt) The button that appears after a
  5265. * selection zoom, allowing the user to reset zoom.
  5266. */
  5267. resetZoomButton?: ChartResetZoomButtonOptions;
  5268. /**
  5269. * (Highcharts, Gantt) Options for a scrollable plot area. This feature
  5270. * provides a minimum size for the plot area of the chart. If the size gets
  5271. * smaller than this, typically on mobile devices, a native browser
  5272. * scrollbar is presented. This scrollbar provides smooth scrolling for the
  5273. * contents of the plot area, whereas the title, legend and unaffected axes
  5274. * are fixed.
  5275. *
  5276. * Since v7.1.2, a scrollable plot area can be defined for either horizontal
  5277. * or vertical scrolling, depending on whether the `minWidth` or `minHeight`
  5278. * option is set.
  5279. */
  5280. scrollablePlotArea?: ChartScrollablePlotAreaOptions;
  5281. /**
  5282. * (Highcharts, Highstock, Highmaps, Gantt) The background color of the
  5283. * marker square when selecting (zooming in on) an area of the chart.
  5284. */
  5285. selectionMarkerFill?: (ColorString|GradientColorObject|PatternObject);
  5286. /**
  5287. * (Highcharts, Highstock, Highmaps, Gantt) Whether to apply a drop shadow
  5288. * to the outer chart area. Requires that backgroundColor be set. The shadow
  5289. * can be an object configuration containing `color`, `offsetX`, `offsetY`,
  5290. * `opacity` and `width`.
  5291. */
  5292. shadow?: (boolean|CSSObject);
  5293. /**
  5294. * (Highcharts, Gantt) Whether to show the axes initially. This only applies
  5295. * to empty charts where series are added dynamically, as axes are
  5296. * automatically added to cartesian series.
  5297. */
  5298. showAxes?: boolean;
  5299. /**
  5300. * (Highcharts, Highstock, Highmaps, Gantt) The distance between the outer
  5301. * edge of the chart and the content, like title or legend, or axis title
  5302. * and labels if present. The numbers in the array designate top, right,
  5303. * bottom and left respectively. Use the options spacingTop, spacingRight,
  5304. * spacingBottom and spacingLeft options for shorthand setting of one
  5305. * option.
  5306. */
  5307. spacing?: Array<number>;
  5308. /**
  5309. * (Highcharts, Highstock, Highmaps, Gantt) The space between the bottom
  5310. * edge of the chart and the content (plot area, axis title and labels,
  5311. * title, subtitle or legend in top position).
  5312. */
  5313. spacingBottom?: number;
  5314. /**
  5315. * (Highcharts, Highstock, Highmaps, Gantt) The space between the left edge
  5316. * of the chart and the content (plot area, axis title and labels, title,
  5317. * subtitle or legend in top position).
  5318. */
  5319. spacingLeft?: number;
  5320. /**
  5321. * (Highcharts, Highstock, Highmaps, Gantt) The space between the right edge
  5322. * of the chart and the content (plot area, axis title and labels, title,
  5323. * subtitle or legend in top position).
  5324. */
  5325. spacingRight?: number;
  5326. /**
  5327. * (Highcharts, Highstock, Highmaps, Gantt) The space between the top edge
  5328. * of the chart and the content (plot area, axis title and labels, title,
  5329. * subtitle or legend in top position).
  5330. */
  5331. spacingTop?: number;
  5332. /**
  5333. * (Highcharts, Highstock, Highmaps, Gantt) Additional CSS styles to apply
  5334. * inline to the container `div`. Note that since the default font styles
  5335. * are applied in the renderer, it is ignorant of the individual chart
  5336. * options and must be set globally.
  5337. */
  5338. style?: CSSObject;
  5339. /**
  5340. * (Highcharts, Highstock, Highmaps, Gantt) Whether to apply styled mode.
  5341. * When in styled mode, no presentational attributes or CSS are applied to
  5342. * the chart SVG. Instead, CSS rules are required to style the chart. The
  5343. * default style sheet is available from
  5344. * `https://code.highcharts.com/css/highcharts.css`.
  5345. */
  5346. styledMode?: boolean;
  5347. /**
  5348. * (Highcharts, Highstock, Highmaps, Gantt) The default series type for the
  5349. * chart. Can be any of the chart types listed under plotOptions and series
  5350. * or can be a series provided by an additional module.
  5351. *
  5352. * In TypeScript this option has no effect in sense of typing and instead
  5353. * the `type` option must always be set in the series.
  5354. */
  5355. type?: string;
  5356. /**
  5357. * (Highcharts, Highstock, Highmaps, Gantt) An explicit width for the chart.
  5358. * By default (when `null`) the width is calculated from the offset width of
  5359. * the containing element.
  5360. */
  5361. width?: (number|string|null);
  5362. /**
  5363. * (Highcharts, Highstock, Gantt) Enables zooming by a single touch, in
  5364. * combination with chart.zoomType. When enabled, two-finger pinch will
  5365. * still work as set up by chart.pinchType. However, `zoomBySingleTouch`
  5366. * will interfere with touch-dragging the chart to read the tooltip. And
  5367. * especially when vertical zooming is enabled, it will make it hard to
  5368. * scroll vertically on the page.
  5369. */
  5370. zoomBySingleTouch?: boolean;
  5371. /**
  5372. * (Highcharts, Highstock, Highmaps, Gantt) Set a key to hold when dragging
  5373. * to zoom the chart. This is useful to avoid zooming while moving points.
  5374. * Should be set different than chart.panKey.
  5375. */
  5376. zoomKey?: OptionsZoomKeyValue;
  5377. /**
  5378. * (Highcharts, Highstock, Gantt) Decides in what dimensions the user can
  5379. * zoom by dragging the mouse. Can be one of `x`, `y` or `xy`.
  5380. */
  5381. zoomType?: OptionsZoomTypeValue;
  5382. }
  5383. /**
  5384. * (Highcharts, Highstock, Gantt) Allow panning in a chart. Best used with
  5385. * panKey to combine zooming and panning.
  5386. *
  5387. * On touch devices, when the tooltip.followTouchMove option is `true`
  5388. * (default), panning requires two fingers. To allow panning with one finger,
  5389. * set `followTouchMove` to `false`.
  5390. */
  5391. export interface ChartPanningOptions {
  5392. /**
  5393. * (Highcharts, Highstock, Gantt) Enable or disable chart panning.
  5394. */
  5395. enabled?: boolean;
  5396. /**
  5397. * (Highcharts, Highstock, Gantt) Decides in what dimensions the user can
  5398. * pan the chart. Can be one of `x`, `y`, or `xy`.
  5399. */
  5400. type?: OptionsTypeValue;
  5401. }
  5402. /**
  5403. * (Highcharts) Event handlers for the axis.
  5404. */
  5405. export interface ChartParallelAxesEventsOptions {
  5406. /**
  5407. * (Highcharts, Gantt) An event fired after the breaks have rendered.
  5408. */
  5409. afterBreaks?: AxisEventCallbackFunction;
  5410. /**
  5411. * (Highcharts) As opposed to the `setExtremes` event, this event fires
  5412. * after the final min and max values are computed and corrected for
  5413. * `minRange`.
  5414. *
  5415. * Fires when the minimum and maximum is set for the axis, either by calling
  5416. * the `.setExtremes()` method or by selecting an area in the chart. One
  5417. * parameter, `event`, is passed to the function, containing common event
  5418. * information.
  5419. *
  5420. * The new user set minimum and maximum values can be found by `event.min`
  5421. * and `event.max`. These reflect the axis minimum and maximum in axis
  5422. * values. The actual data extremes are found in `event.dataMin` and
  5423. * `event.dataMax`.
  5424. */
  5425. afterSetExtremes?: AxisSetExtremesEventCallbackFunction;
  5426. /**
  5427. * (Highcharts, Gantt) An event fired when a break from this axis occurs on
  5428. * a point.
  5429. */
  5430. pointBreak?: AxisPointBreakEventCallbackFunction;
  5431. /**
  5432. * (Highcharts, Highstock, Gantt) An event fired when a point falls inside a
  5433. * break from this axis.
  5434. */
  5435. pointInBreak?: AxisPointBreakEventCallbackFunction;
  5436. /**
  5437. * (Highcharts) Fires when the minimum and maximum is set for the axis,
  5438. * either by calling the `.setExtremes()` method or by selecting an area in
  5439. * the chart. One parameter, `event`, is passed to the function, containing
  5440. * common event information.
  5441. *
  5442. * The new user set minimum and maximum values can be found by `event.min`
  5443. * and `event.max`. These reflect the axis minimum and maximum in data
  5444. * values. When an axis is zoomed all the way out from the "Reset zoom"
  5445. * button, `event.min` and `event.max` are null, and the new extremes are
  5446. * set based on `this.dataMin` and `this.dataMax`.
  5447. */
  5448. setExtremes?: AxisSetExtremesEventCallbackFunction;
  5449. }
  5450. /**
  5451. * (Gantt) Set grid options for the axis labels. Requires Highcharts Gantt.
  5452. */
  5453. export interface ChartParallelAxesGridOptions {
  5454. /**
  5455. * (Gantt) Set border color for the label grid lines.
  5456. */
  5457. borderColor?: ColorString;
  5458. /**
  5459. * (Gantt) Set border width of the label grid lines.
  5460. */
  5461. borderWidth?: number;
  5462. /**
  5463. * (Gantt) Set cell height for grid axis labels. By default this is
  5464. * calculated from font size. This option only applies to horizontal axes.
  5465. */
  5466. cellHeight?: number;
  5467. /**
  5468. * (Gantt) Set specific options for each column (or row for horizontal axes)
  5469. * in the grid. Each extra column/row is its own axis, and the axis options
  5470. * can be set here.
  5471. */
  5472. columns?: Array<XAxisOptions>;
  5473. /**
  5474. * (Gantt) Enable grid on the axis labels. Defaults to true for Gantt
  5475. * charts.
  5476. */
  5477. enabled?: boolean;
  5478. }
  5479. /**
  5480. * (Gantt) Set options on specific levels in a tree grid axis. Takes precedence
  5481. * over labels options.
  5482. */
  5483. export interface ChartParallelAxesLabelsLevelsOptions {
  5484. /**
  5485. * (Gantt) Specify the level which the options within this object applies
  5486. * to.
  5487. */
  5488. level?: number;
  5489. style?: CSSObject;
  5490. }
  5491. /**
  5492. * (Highcharts) The axis labels show the number or category for each tick.
  5493. *
  5494. * Since v8.0.0: Labels are animated in categorized x-axis with updating data if
  5495. * `tickInterval` and `step` is set to 1.
  5496. */
  5497. export interface ChartParallelAxesLabelsOptions {
  5498. /**
  5499. * (Highcharts) What part of the string the given position is anchored to.
  5500. * Can be one of `"left"`, `"center"` or `"right"`. The exact position also
  5501. * depends on the `labels.x` setting.
  5502. *
  5503. * Angular gauges and solid gauges defaults to `"center"`. Solid gauges with
  5504. * two labels have additional option `"auto"` for automatic horizontal and
  5505. * vertical alignment.
  5506. */
  5507. align?: string;
  5508. /**
  5509. * (Highcharts, Highstock, Gantt) For horizontal axes, the allowed degrees
  5510. * of label rotation to prevent overlapping labels. If there is enough
  5511. * space, labels are not rotated. As the chart gets narrower, it will start
  5512. * rotating the labels -45 degrees, then remove every second label and try
  5513. * again with rotations 0 and -45 etc. Set it to `false` to disable
  5514. * rotation, which will cause the labels to word-wrap if possible.
  5515. */
  5516. autoRotation?: (false|Array<number>);
  5517. /**
  5518. * (Highcharts, Gantt) When each category width is more than this many
  5519. * pixels, we don't apply auto rotation. Instead, we lay out the axis label
  5520. * with word wrap. A lower limit makes sense when the label contains
  5521. * multiple short words that don't extend the available horizontal space for
  5522. * each label.
  5523. */
  5524. autoRotationLimit?: number;
  5525. /**
  5526. * (Highcharts) Angular gauges and solid gauges only. The label's pixel
  5527. * distance from the perimeter of the plot area.
  5528. *
  5529. * Since v7.1.2: If it's a percentage string, it is interpreted the same as
  5530. * series.radius, so label can be aligned under the gauge's shape.
  5531. */
  5532. distance?: (number|string);
  5533. /**
  5534. * (Highcharts) Enable or disable the axis labels.
  5535. */
  5536. enabled?: boolean;
  5537. /**
  5538. * (Highcharts) A format string for the axis label. See format string for
  5539. * example usage.
  5540. *
  5541. * Note: The default value is not specified due to the dynamic nature of the
  5542. * default implementation.
  5543. */
  5544. format?: string;
  5545. /**
  5546. * (Highcharts) Callback JavaScript function to format the label. The value
  5547. * is given by `this.value`. Additional properties for `this` are `axis`,
  5548. * `chart`, `isFirst` and `isLast`. The value of the default label formatter
  5549. * can be retrieved by calling `this.axis.defaultLabelFormatter.call(this)`
  5550. * within the function.
  5551. *
  5552. * Defaults to: (see online documentation for example)
  5553. */
  5554. formatter?: AxisLabelsFormatterCallbackFunction;
  5555. /**
  5556. * (Gantt) The number of pixels to indent the labels per level in a treegrid
  5557. * axis.
  5558. */
  5559. indentation?: number;
  5560. /**
  5561. * (Gantt) Set options on specific levels in a tree grid axis. Takes
  5562. * precedence over labels options.
  5563. */
  5564. levels?: Array<ChartParallelAxesLabelsLevelsOptions>;
  5565. /**
  5566. * (Highcharts) How to handle overflowing labels on horizontal axis. If set
  5567. * to `"allow"`, it will not be aligned at all. By default it `"justify"`
  5568. * labels inside the chart area. If there is room to move it, it will be
  5569. * aligned to the edge, else it will be removed.
  5570. */
  5571. overflow?: OptionsOverflowValue;
  5572. /**
  5573. * (Highcharts, Gantt) The pixel padding for axis labels, to ensure white
  5574. * space between them.
  5575. */
  5576. padding?: number;
  5577. /**
  5578. * (Highcharts) Defines how the labels are be repositioned according to the
  5579. * 3D chart orientation.
  5580. *
  5581. * - `'offset'`: Maintain a fixed horizontal/vertical distance from the tick
  5582. * marks, despite the chart orientation. This is the backwards compatible
  5583. * behavior, and causes skewing of X and Z axes.
  5584. *
  5585. * - `'chart'`: Preserve 3D position relative to the chart. This looks nice,
  5586. * but hard to read if the text isn't forward-facing.
  5587. *
  5588. * - `'flap'`: Rotated text along the axis to compensate for the chart
  5589. * orientation. This tries to maintain text as legible as possible on all
  5590. * orientations.
  5591. *
  5592. * - `'ortho'`: Rotated text along the axis direction so that the labels are
  5593. * orthogonal to the axis. This is very similar to `'flap'`, but prevents
  5594. * skewing the labels (X and Y scaling are still present).
  5595. */
  5596. position3d?: OptionsPosition3dValue;
  5597. /**
  5598. * (Highcharts, Gantt) Whether to reserve space for the labels. By default,
  5599. * space is reserved for the labels in these cases:
  5600. *
  5601. * * On all horizontal axes.
  5602. *
  5603. * * On vertical axes if `label.align` is `right` on a left-side axis or
  5604. * `left` on a right-side axis.
  5605. *
  5606. * * On vertical axes if `label.align` is `center`.
  5607. *
  5608. * This can be turned off when for example the labels are rendered inside
  5609. * the plot area instead of outside.
  5610. */
  5611. reserveSpace?: boolean;
  5612. /**
  5613. * (Highcharts) Rotation of the labels in degrees.
  5614. */
  5615. rotation?: number;
  5616. /**
  5617. * (Highcharts) If enabled, the axis labels will skewed to follow the
  5618. * perspective.
  5619. *
  5620. * This will fix overlapping labels and titles, but texts become less
  5621. * legible due to the distortion.
  5622. *
  5623. * The final appearance depends heavily on `labels.position3d`.
  5624. */
  5625. skew3d?: boolean;
  5626. /**
  5627. * (Highcharts) Horizontal axes only. The number of lines to spread the
  5628. * labels over to make room or tighter labels.
  5629. */
  5630. staggerLines?: number;
  5631. /**
  5632. * (Highcharts) To show only every _n_'th label on the axis, set the step to
  5633. * _n_. Setting the step to 2 shows every other label.
  5634. *
  5635. * By default, the step is calculated automatically to avoid overlap. To
  5636. * prevent this, set it to 1\. This usually only happens on a category axis,
  5637. * and is often a sign that you have chosen the wrong axis type.
  5638. *
  5639. * Read more at Axis docs => What axis should I use?
  5640. */
  5641. step?: number;
  5642. /**
  5643. * (Highcharts) CSS styles for the label. Use `whiteSpace: 'nowrap'` to
  5644. * prevent wrapping of category labels. Use `textOverflow: 'none'` to
  5645. * prevent ellipsis (dots).
  5646. *
  5647. * In styled mode, the labels are styled with the `.highcharts-axis-labels`
  5648. * class.
  5649. */
  5650. style?: CSSObject;
  5651. /**
  5652. * (Gantt) The symbol for the collapse and expand icon in a treegrid.
  5653. */
  5654. symbol?: ChartParallelAxesLabelsSymbolOptions;
  5655. /**
  5656. * (Highcharts) Whether to use HTML to render the labels.
  5657. */
  5658. useHTML?: boolean;
  5659. /**
  5660. * (Highcharts) The x position offset of all labels relative to the tick
  5661. * positions on the axis. Defaults to -15 for left axis, 15 for right axis.
  5662. */
  5663. x?: number;
  5664. /**
  5665. * (Highcharts) The y position offset of all labels relative to the tick
  5666. * positions on the axis. For polar and radial axis consider the use of the
  5667. * distance option.
  5668. */
  5669. y?: number;
  5670. /**
  5671. * (Highcharts) The Z index for the axis labels.
  5672. */
  5673. zIndex?: number;
  5674. }
  5675. /**
  5676. * (Gantt) The symbol for the collapse and expand icon in a treegrid.
  5677. */
  5678. export interface ChartParallelAxesLabelsSymbolOptions {
  5679. height?: number;
  5680. padding?: number;
  5681. /**
  5682. * (Gantt) The symbol type. Points to a definition function in the
  5683. * `Highcharts.Renderer.symbols` collection.
  5684. */
  5685. type?: SymbolKeyValue;
  5686. width?: number;
  5687. x?: number;
  5688. y?: number;
  5689. }
  5690. /**
  5691. * (Highcharts) Common options for all yAxes rendered in a parallel coordinates
  5692. * plot. This feature requires `modules/parallel-coordinates.js`.
  5693. *
  5694. * The default options are: (see online documentation for example)
  5695. */
  5696. export interface ChartParallelAxesOptions {
  5697. /**
  5698. * (Highcharts) Accessibility options for an axis. Requires the
  5699. * accessibility module.
  5700. */
  5701. accessibility?: AxisAccessibilityOptionsObject;
  5702. /**
  5703. * (Highcharts, Highstock, Gantt) When using multiple axis, the ticks of two
  5704. * or more opposite axes will automatically be aligned by adding ticks to
  5705. * the axis or axes with the least ticks, as if `tickAmount` were specified.
  5706. *
  5707. * This can be prevented by setting `alignTicks` to false. If the grid lines
  5708. * look messy, it's a good idea to hide them for the secondary axis by
  5709. * setting `gridLineWidth` to 0.
  5710. *
  5711. * If `startOnTick` or `endOnTick` in an Axis options are set to false, then
  5712. * the `alignTicks ` will be disabled for the Axis.
  5713. *
  5714. * Disabled for logarithmic axes.
  5715. */
  5716. alignTicks?: boolean;
  5717. /**
  5718. * (Highcharts) Whether to allow decimals in this axis' ticks. When counting
  5719. * integers, like persons or hits on a web page, decimals should be avoided
  5720. * in the labels.
  5721. */
  5722. allowDecimals?: boolean;
  5723. /**
  5724. * (Highcharts, Gantt) If categories are present for the xAxis, names are
  5725. * used instead of numbers for that axis.
  5726. *
  5727. * Since Highcharts 3.0, categories can also be extracted by giving each
  5728. * point a name and setting axis type to `category`. However, if you have
  5729. * multiple series, best practice remains defining the `categories` array.
  5730. *
  5731. * Example: `categories: ['Apples', 'Bananas', 'Oranges']`
  5732. */
  5733. categories?: Array<string>;
  5734. /**
  5735. * (Highcharts, Highstock, Gantt) The highest allowed value for
  5736. * automatically computed axis extremes.
  5737. */
  5738. ceiling?: number;
  5739. /**
  5740. * (Highcharts) A class name that opens for styling the axis by CSS,
  5741. * especially in Highcharts styled mode. The class name is applied to group
  5742. * elements for the grid, axis elements and labels.
  5743. */
  5744. className?: string;
  5745. /**
  5746. * (Highcharts) Configure a crosshair that follows either the mouse pointer
  5747. * or the hovered point.
  5748. *
  5749. * In styled mode, the crosshairs are styled in the `.highcharts-crosshair`,
  5750. * `.highcharts-crosshair-thin` or `.highcharts-xaxis-category` classes.
  5751. */
  5752. crosshair?: (boolean|AxisCrosshairOptions);
  5753. /**
  5754. * (Highcharts, Highstock, Gantt) For a datetime axis, the scale will
  5755. * automatically adjust to the appropriate unit. This member gives the
  5756. * default string representations used for each unit. For intermediate
  5757. * values, different units may be used, for example the `day` unit can be
  5758. * used on midnight and `hour` unit be used for intermediate values on the
  5759. * same axis.
  5760. *
  5761. * For an overview of the replacement codes, see dateFormat.
  5762. *
  5763. * Defaults to: (see online documentation for example)
  5764. */
  5765. dateTimeLabelFormats?: AxisDateTimeLabelFormatsOptions;
  5766. /**
  5767. * (Highcharts) Whether to force the axis to end on a tick. Use this option
  5768. * with the `maxPadding` option to control the axis end.
  5769. *
  5770. * This option is always disabled, when panning type is either `y` or `xy`.
  5771. */
  5772. endOnTick?: boolean;
  5773. /**
  5774. * (Highcharts) Event handlers for the axis.
  5775. */
  5776. events?: ChartParallelAxesEventsOptions;
  5777. /**
  5778. * (Highcharts, Highstock, Gantt) The lowest allowed value for automatically
  5779. * computed axis extremes.
  5780. */
  5781. floor?: number;
  5782. /**
  5783. * (Gantt) Set grid options for the axis labels. Requires Highcharts Gantt.
  5784. */
  5785. grid?: ChartParallelAxesGridOptions;
  5786. /**
  5787. * (Highcharts, Highstock, Gantt) The Z index of the grid lines.
  5788. */
  5789. gridZIndex?: number;
  5790. /**
  5791. * (Highcharts, Highstock) The height of the Y axis. If it's a number, it is
  5792. * interpreted as pixels.
  5793. *
  5794. * Since Highcharts 2: If it's a percentage string, it is interpreted as
  5795. * percentages of the total plot height.
  5796. */
  5797. height?: (number|string);
  5798. /**
  5799. * (Highcharts) The axis labels show the number or category for each tick.
  5800. *
  5801. * Since v8.0.0: Labels are animated in categorized x-axis with updating
  5802. * data if `tickInterval` and `step` is set to 1.
  5803. */
  5804. labels?: ChartParallelAxesLabelsOptions;
  5805. /**
  5806. * (Highcharts, Highstock) The left position as the horizontal axis. If it's
  5807. * a number, it is interpreted as pixel position relative to the chart.
  5808. *
  5809. * Since Highcharts v5.0.13: If it's a percentage string, it is interpreted
  5810. * as percentages of the plot width, offset from plot area left.
  5811. */
  5812. left?: (number|string);
  5813. /**
  5814. * (Highcharts) The color of the line marking the axis itself.
  5815. *
  5816. * In styled mode, the line stroke is given in the `.highcharts-axis-line`
  5817. * or `.highcharts-xaxis-line` class.
  5818. */
  5819. lineColor?: ColorType;
  5820. /**
  5821. * (Highcharts) The width of the line marking the axis itself.
  5822. *
  5823. * In styled mode, the stroke width is given in the `.highcharts-axis-line`
  5824. * or `.highcharts-xaxis-line` class.
  5825. */
  5826. lineWidth?: number;
  5827. /**
  5828. * (Highcharts, Highstock, Gantt) Index of another axis that this axis is
  5829. * linked to. When an axis is linked to a master axis, it will take the same
  5830. * extremes as the master, but as assigned by min or max or by setExtremes.
  5831. * It can be used to show additional info, or to ease reading the chart by
  5832. * duplicating the scales.
  5833. */
  5834. linkedTo?: number;
  5835. /**
  5836. * (Highcharts) If there are multiple axes on the same side of the chart,
  5837. * the pixel margin between the axes. Defaults to 0 on vertical axes, 15 on
  5838. * horizontal axes.
  5839. */
  5840. margin?: number;
  5841. /**
  5842. * (Highcharts) The maximum value of the axis. If `null`, the max value is
  5843. * automatically calculated.
  5844. *
  5845. * If the endOnTick option is true, the `max` value might be rounded up.
  5846. *
  5847. * If a tickAmount is set, the axis may be extended beyond the set max in
  5848. * order to reach the given number of ticks. The same may happen in a chart
  5849. * with multiple axes, determined by chart. alignTicks, where a `tickAmount`
  5850. * is applied internally.
  5851. */
  5852. max?: (number|null);
  5853. /**
  5854. * (Highstock) Maximal size of a resizable axis. Could be set as a percent
  5855. * of plot area or pixel size.
  5856. */
  5857. maxLength?: (number|string);
  5858. /**
  5859. * (Highcharts, Highstock, Gantt) Padding of the max value relative to the
  5860. * length of the axis. A padding of 0.05 will make a 100px axis 5px longer.
  5861. * This is useful when you don't want the highest data value to appear on
  5862. * the edge of the plot area. When the axis' `max` option is set or a max
  5863. * extreme is set using `axis.setExtremes()`, the maxPadding will be
  5864. * ignored.
  5865. *
  5866. * Also the `softThreshold` option takes precedence over `maxPadding`, so if
  5867. * the data is tangent to the threshold, `maxPadding` may not apply unless
  5868. * `softThreshold` is set to false.
  5869. */
  5870. maxPadding?: number;
  5871. /**
  5872. * (Highstock, Gantt) Maximum range which can be set using the navigator's
  5873. * handles. Opposite of xAxis.minRange.
  5874. */
  5875. maxRange?: number;
  5876. /**
  5877. * (Highcharts) The minimum value of the axis. If `null` the min value is
  5878. * automatically calculated.
  5879. *
  5880. * If the startOnTick option is true (default), the `min` value might be
  5881. * rounded down.
  5882. *
  5883. * The automatically calculated minimum value is also affected by floor,
  5884. * softMin, minPadding, minRange as well as series.threshold and
  5885. * series.softThreshold.
  5886. */
  5887. min?: (number|null);
  5888. /**
  5889. * (Highstock) Minimal size of a resizable axis. Could be set as a percent
  5890. * of plot area or pixel size.
  5891. */
  5892. minLength?: (number|string);
  5893. /**
  5894. * (Highcharts) Color for the minor tick marks.
  5895. */
  5896. minorTickColor?: ColorType;
  5897. /**
  5898. * (Highcharts) Specific tick interval in axis units for the minor ticks. On
  5899. * a linear axis, if `"auto"`, the minor tick interval is calculated as a
  5900. * fifth of the tickInterval. If `null` or `undefined`, minor ticks are not
  5901. * shown.
  5902. *
  5903. * On logarithmic axes, the unit is the power of the value. For example,
  5904. * setting the minorTickInterval to 1 puts one tick on each of 0.1, 1, 10,
  5905. * 100 etc. Setting the minorTickInterval to 0.1 produces 9 ticks between 1
  5906. * and 10, 10 and 100 etc.
  5907. *
  5908. * If user settings dictate minor ticks to become too dense, they don't make
  5909. * sense, and will be ignored to prevent performance problems.
  5910. */
  5911. minorTickInterval?: (number|string|null);
  5912. /**
  5913. * (Highcharts) The pixel length of the minor tick marks.
  5914. */
  5915. minorTickLength?: number;
  5916. /**
  5917. * (Highcharts) The position of the minor tick marks relative to the axis
  5918. * line. Can be one of `inside` and `outside`.
  5919. */
  5920. minorTickPosition?: OptionsMinorTickPositionValue;
  5921. /**
  5922. * (Highcharts) Enable or disable minor ticks. Unless minorTickInterval is
  5923. * set, the tick interval is calculated as a fifth of the `tickInterval`.
  5924. *
  5925. * On a logarithmic axis, minor ticks are laid out based on a best guess,
  5926. * attempting to enter approximately 5 minor ticks between each major tick.
  5927. *
  5928. * Prior to v6.0.0, ticks were unabled in auto layout by setting
  5929. * `minorTickInterval` to `"auto"`.
  5930. */
  5931. minorTicks?: boolean;
  5932. /**
  5933. * (Highcharts) The pixel width of the minor tick mark.
  5934. */
  5935. minorTickWidth?: number;
  5936. /**
  5937. * (Highcharts, Highstock, Gantt) Padding of the min value relative to the
  5938. * length of the axis. A padding of 0.05 will make a 100px axis 5px longer.
  5939. * This is useful when you don't want the lowest data value to appear on the
  5940. * edge of the plot area. When the axis' `min` option is set or a max
  5941. * extreme is set using `axis.setExtremes()`, the maxPadding will be
  5942. * ignored.
  5943. *
  5944. * Also the `softThreshold` option takes precedence over `minPadding`, so if
  5945. * the data is tangent to the threshold, `minPadding` may not apply unless
  5946. * `softThreshold` is set to false.
  5947. */
  5948. minPadding?: number;
  5949. /**
  5950. * (Highcharts) The minimum range to display on this axis. The entire axis
  5951. * will not be allowed to span over a smaller interval than this. For
  5952. * example, for a datetime axis the main unit is milliseconds. If minRange
  5953. * is set to 3600000, you can't zoom in more than to one hour.
  5954. *
  5955. * The default minRange for the x axis is five times the smallest interval
  5956. * between any of the data points.
  5957. *
  5958. * On a logarithmic axis, the unit for the minimum range is the power. So a
  5959. * minRange of 1 means that the axis can be zoomed to 10-100, 100-1000,
  5960. * 1000-10000 etc.
  5961. *
  5962. * **Note**: The `minPadding`, `maxPadding`, `startOnTick` and `endOnTick`
  5963. * settings also affect how the extremes of the axis are computed.
  5964. */
  5965. minRange?: number;
  5966. /**
  5967. * (Highcharts) The minimum tick interval allowed in axis values. For
  5968. * example on zooming in on an axis with daily data, this can be used to
  5969. * prevent the axis from showing hours. Defaults to the closest distance
  5970. * between two points on the axis.
  5971. */
  5972. minTickInterval?: number;
  5973. /**
  5974. * (Highcharts) The distance in pixels from the plot area to the axis line.
  5975. * A positive offset moves the axis with it's line, labels and ticks away
  5976. * from the plot area. This is typically used when two or more axes are
  5977. * displayed on the same side of the plot. With multiple axes the offset is
  5978. * dynamically adjusted to avoid collision, this can be overridden by
  5979. * setting offset explicitly.
  5980. */
  5981. offset?: number;
  5982. /**
  5983. * (Highstock, Highcharts, Gantt) Whether to display the axis on the
  5984. * opposite side of the normal. The normal is on the left side for vertical
  5985. * axes and bottom for horizontal, so the opposite sides will be right and
  5986. * top respectively. This is typically used with dual or multiple axes.
  5987. */
  5988. opposite?: boolean;
  5989. /**
  5990. * (Highcharts) Refers to the index in the panes array. Used for circular
  5991. * gauges and polar charts. When the option is not set then first pane will
  5992. * be used.
  5993. */
  5994. pane?: number;
  5995. /**
  5996. * (Highstock) The zoomed range to display when only defining one or none of
  5997. * `min` or `max`. For example, to show the latest month, a range of one
  5998. * month can be set.
  5999. */
  6000. range?: number;
  6001. /**
  6002. * (Highstock) Options for axis resizing. It adds a thick line between panes
  6003. * which the user can drag in order to resize the panes.
  6004. */
  6005. resize?: ChartParallelAxesResizeOptions;
  6006. /**
  6007. * (Highcharts) Whether to reverse the axis so that the highest number is
  6008. * closest to the origin.
  6009. */
  6010. reversed?: boolean;
  6011. /**
  6012. * (Highcharts, Highstock) If `true`, the first series in a stack will be
  6013. * drawn on top in a positive, non-reversed Y axis. If `false`, the first
  6014. * series is in the base of the stack.
  6015. */
  6016. reversedStacks?: boolean;
  6017. /**
  6018. * (Highcharts) Whether to show the axis line and title when the axis has no
  6019. * data.
  6020. */
  6021. showEmpty?: boolean;
  6022. /**
  6023. * (Highcharts) Whether to show the first tick label.
  6024. */
  6025. showFirstLabel?: boolean;
  6026. /**
  6027. * (Highcharts, Highstock, Gantt) Whether to show the last tick label.
  6028. * Defaults to `true` on cartesian charts, and `false` on polar charts.
  6029. */
  6030. showLastLabel?: boolean;
  6031. /**
  6032. * (Highcharts, Highstock, Gantt) A soft maximum for the axis. If the series
  6033. * data maximum is less than this, the axis will stay at this maximum, but
  6034. * if the series data maximum is higher, the axis will flex to show all
  6035. * data.
  6036. *
  6037. * **Note**: The series.softThreshold option takes precedence over this
  6038. * option.
  6039. */
  6040. softMax?: number;
  6041. /**
  6042. * (Highcharts, Highstock, Gantt) A soft minimum for the axis. If the series
  6043. * data minimum is greater than this, the axis will stay at this minimum,
  6044. * but if the series data minimum is lower, the axis will flex to show all
  6045. * data.
  6046. *
  6047. * **Note**: The series.softThreshold option takes precedence over this
  6048. * option.
  6049. */
  6050. softMin?: number;
  6051. /**
  6052. * (Highcharts, Highstock, Gantt) For datetime axes, this decides where to
  6053. * put the tick between weeks. 0 = Sunday, 1 = Monday.
  6054. */
  6055. startOfWeek?: number;
  6056. /**
  6057. * (Highcharts, Highstock, Gantt) Whether to force the axis to start on a
  6058. * tick. Use this option with the `maxPadding` option to control the axis
  6059. * start.
  6060. *
  6061. * This option is always disabled, when panning type is either `y` or `xy`.
  6062. */
  6063. startOnTick?: boolean;
  6064. /**
  6065. * (Gantt) For vertical axes only. Setting the static scale ensures that
  6066. * each tick unit is translated into a fixed pixel height. For example,
  6067. * setting the static scale to 24 results in each Y axis category taking up
  6068. * 24 pixels, and the height of the chart adjusts. Adding or removing items
  6069. * will make the chart resize.
  6070. */
  6071. staticScale?: number;
  6072. /**
  6073. * (Highcharts, Highstock, Gantt) The amount of ticks to draw on the axis.
  6074. * This opens up for aligning the ticks of multiple charts or panes within a
  6075. * chart. This option overrides the `tickPixelInterval` option.
  6076. *
  6077. * This option only has an effect on linear axes. Datetime, logarithmic or
  6078. * category axes are not affected.
  6079. */
  6080. tickAmount?: number;
  6081. /**
  6082. * (Highcharts) Color for the main tick marks.
  6083. *
  6084. * In styled mode, the stroke is given in the `.highcharts-tick` class.
  6085. */
  6086. tickColor?: ColorType;
  6087. /**
  6088. * (Highcharts) The interval of the tick marks in axis units. When
  6089. * `undefined`, the tick interval is computed to approximately follow the
  6090. * tickPixelInterval on linear and datetime axes. On categorized axes, a
  6091. * `undefined` tickInterval will default to 1, one category. Note that
  6092. * datetime axes are based on milliseconds, so for example an interval of
  6093. * one day is expressed as `24 * 3600 * 1000`.
  6094. *
  6095. * On logarithmic axes, the tickInterval is based on powers, so a
  6096. * tickInterval of 1 means one tick on each of 0.1, 1, 10, 100 etc. A
  6097. * tickInterval of 2 means a tick of 0.1, 10, 1000 etc. A tickInterval of
  6098. * 0.2 puts a tick on 0.1, 0.2, 0.4, 0.6, 0.8, 1, 2, 4, 6, 8, 10, 20, 40
  6099. * etc.
  6100. *
  6101. * If the tickInterval is too dense for labels to be drawn, Highcharts may
  6102. * remove ticks.
  6103. *
  6104. * If the chart has multiple axes, the alignTicks option may interfere with
  6105. * the `tickInterval` setting.
  6106. */
  6107. tickInterval?: number;
  6108. /**
  6109. * (Highcharts) The pixel length of the main tick marks.
  6110. */
  6111. tickLength?: number;
  6112. /**
  6113. * (Highcharts, Gantt) For categorized axes only. If `on` the tick mark is
  6114. * placed in the center of the category, if `between` the tick mark is
  6115. * placed between categories. The default is `between` if the `tickInterval`
  6116. * is 1, else `on`.
  6117. */
  6118. tickmarkPlacement?: OptionsTickmarkPlacementValue;
  6119. /**
  6120. * (Highcharts) If tickInterval is `null` this option sets the approximate
  6121. * pixel interval of the tick marks. Not applicable to categorized axis.
  6122. *
  6123. * The tick interval is also influenced by the minTickInterval option, that,
  6124. * by default prevents ticks from being denser than the data points.
  6125. */
  6126. tickPixelInterval?: number;
  6127. /**
  6128. * (Highcharts) The position of the major tick marks relative to the axis
  6129. * line. Can be one of `inside` and `outside`.
  6130. */
  6131. tickPosition?: OptionsTickPositionValue;
  6132. /**
  6133. * (Highcharts) A callback function returning array defining where the ticks
  6134. * are laid out on the axis. This overrides the default behaviour of
  6135. * tickPixelInterval and tickInterval. The automatic tick positions are
  6136. * accessible through `this.tickPositions` and can be modified by the
  6137. * callback.
  6138. */
  6139. tickPositioner?: AxisTickPositionerCallbackFunction;
  6140. /**
  6141. * (Highcharts) An array defining where the ticks are laid out on the axis.
  6142. * This overrides the default behaviour of tickPixelInterval and
  6143. * tickInterval.
  6144. */
  6145. tickPositions?: Array<number>;
  6146. /**
  6147. * (Highcharts, Highstock, Gantt) The pixel width of the major tick marks.
  6148. */
  6149. tickWidth?: number;
  6150. /**
  6151. * (Highcharts) Titles for yAxes are taken from xAxis.categories. All
  6152. * options for `xAxis.labels` applies to parallel coordinates titles. For
  6153. * example, to style categories, use xAxis.labels.style.
  6154. */
  6155. title?: ChartParallelAxesTitleOptions;
  6156. /**
  6157. * (Highcharts) Parallel coordinates only. Format that will be used for
  6158. * point.y and available in tooltip.pointFormat as `{point.formattedValue}`.
  6159. * If not set, `{point.formattedValue}` will use other options, in this
  6160. * order:
  6161. *
  6162. * 1. yAxis.labels.format will be used if set
  6163. *
  6164. * 2. If yAxis is a category, then category name will be displayed
  6165. *
  6166. * 3. If yAxis is a datetime, then value will use the same format as yAxis
  6167. * labels
  6168. *
  6169. * 4. If yAxis is linear/logarithmic type, then simple value will be used
  6170. */
  6171. tooltipValueFormat?: string;
  6172. /**
  6173. * (Highcharts, Highstock) The top position of the Y axis. If it's a number,
  6174. * it is interpreted as pixel position relative to the chart.
  6175. *
  6176. * Since Highcharts 2: If it's a percentage string, it is interpreted as
  6177. * percentages of the plot height, offset from plot area top.
  6178. */
  6179. top?: (number|string);
  6180. /**
  6181. * (Highcharts, Gantt) The type of axis. Can be one of `linear`,
  6182. * `logarithmic`, `datetime`, `category` or `treegrid`. Defaults to
  6183. * `treegrid` for Gantt charts, `linear` for other chart types.
  6184. *
  6185. * In a datetime axis, the numbers are given in milliseconds, and tick marks
  6186. * are placed on appropriate values, like full hours or days. In a category
  6187. * or treegrid axis, the point names of the chart's series are used for
  6188. * categories, if a categories array is not defined.
  6189. */
  6190. type?: AxisTypeValue;
  6191. /**
  6192. * (Highcharts, Gantt) Applies only when the axis `type` is `category`. When
  6193. * `uniqueNames` is true, points are placed on the X axis according to their
  6194. * names. If the same point name is repeated in the same or another series,
  6195. * the point is placed on the same X position as other points of the same
  6196. * name. When `uniqueNames` is false, the points are laid out in increasing
  6197. * X positions regardless of their names, and the X axis category will take
  6198. * the name of the last point in each position.
  6199. */
  6200. uniqueNames?: boolean;
  6201. /**
  6202. * (Highcharts, Highstock, Gantt) Datetime axis only. An array determining
  6203. * what time intervals the ticks are allowed to fall on. Each array item is
  6204. * an array where the first value is the time unit and the second value
  6205. * another array of allowed multiples.
  6206. *
  6207. * Defaults to: (see online documentation for example)
  6208. */
  6209. units?: Array<[string, (Array<number>|null)]>;
  6210. /**
  6211. * (Highcharts, Highstock, Gantt) Whether axis, including axis title, line,
  6212. * ticks and labels, should be visible.
  6213. */
  6214. visible?: boolean;
  6215. /**
  6216. * (Highcharts, Highstock) The width as the horizontal axis. If it's a
  6217. * number, it is interpreted as pixels.
  6218. *
  6219. * Since Highcharts v5.0.13: If it's a percentage string, it is interpreted
  6220. * as percentages of the total plot width.
  6221. */
  6222. width?: (number|string);
  6223. /**
  6224. * (Highcharts) Whether to zoom axis. If `chart.zoomType` is set, the option
  6225. * allows to disable zooming on an individual axis.
  6226. */
  6227. zoomEnabled?: boolean;
  6228. }
  6229. /**
  6230. * (Highstock) Contains two arrays of axes that are controlled by control line
  6231. * of the axis.
  6232. */
  6233. export interface ChartParallelAxesResizeControlledAxisOptions {
  6234. /**
  6235. * (Highstock) Array of axes that should move out of the way of resizing
  6236. * being done for the current axis. If not set, the next axis will be used.
  6237. */
  6238. next?: Array<(number|string)>;
  6239. /**
  6240. * (Highstock) Array of axes that should move with the current axis while
  6241. * resizing.
  6242. */
  6243. prev?: Array<(number|string)>;
  6244. }
  6245. /**
  6246. * (Highstock) Options for axis resizing. It adds a thick line between panes
  6247. * which the user can drag in order to resize the panes.
  6248. */
  6249. export interface ChartParallelAxesResizeOptions {
  6250. /**
  6251. * (Highstock) Contains two arrays of axes that are controlled by control
  6252. * line of the axis.
  6253. */
  6254. controlledAxis?: ChartParallelAxesResizeControlledAxisOptions;
  6255. /**
  6256. * (Highstock) Cursor style for the control line.
  6257. *
  6258. * In styled mode use class `highcharts-axis-resizer` instead.
  6259. */
  6260. cursor?: string;
  6261. /**
  6262. * (Highstock) Enable or disable resize by drag for the axis.
  6263. */
  6264. enabled?: boolean;
  6265. /**
  6266. * (Highstock) Color of the control line.
  6267. *
  6268. * In styled mode use class `highcharts-axis-resizer` instead.
  6269. */
  6270. lineColor?: ColorString;
  6271. /**
  6272. * (Highstock) Dash style of the control line.
  6273. *
  6274. * In styled mode use class `highcharts-axis-resizer` instead.
  6275. */
  6276. lineDashStyle?: string;
  6277. /**
  6278. * (Highstock) Width of the control line.
  6279. *
  6280. * In styled mode use class `highcharts-axis-resizer` instead.
  6281. */
  6282. lineWidth?: number;
  6283. /**
  6284. * (Highstock) Horizontal offset of the control line.
  6285. */
  6286. x?: number;
  6287. /**
  6288. * (Highstock) Vertical offset of the control line.
  6289. */
  6290. y?: number;
  6291. }
  6292. /**
  6293. * (Highcharts) Titles for yAxes are taken from xAxis.categories. All options
  6294. * for `xAxis.labels` applies to parallel coordinates titles. For example, to
  6295. * style categories, use xAxis.labels.style.
  6296. */
  6297. export interface ChartParallelAxesTitleOptions {
  6298. reserveSpace?: boolean;
  6299. text?: string;
  6300. /**
  6301. * (Highcharts) Alignment of the text, can be `"left"`, `"right"` or
  6302. * `"center"`. Default alignment depends on the title.align:
  6303. *
  6304. * Horizontal axes:
  6305. *
  6306. * - for `align` = `"low"`, `textAlign` is set to `left`
  6307. *
  6308. * - for `align` = `"middle"`, `textAlign` is set to `center`
  6309. *
  6310. * - for `align` = `"high"`, `textAlign` is set to `right`
  6311. *
  6312. * Vertical axes:
  6313. *
  6314. * - for `align` = `"low"` and `opposite` = `true`, `textAlign` is set to
  6315. * `right`
  6316. *
  6317. * - for `align` = `"low"` and `opposite` = `false`, `textAlign` is set to
  6318. * `left`
  6319. *
  6320. * - for `align` = `"middle"`, `textAlign` is set to `center`
  6321. *
  6322. * - for `align` = `"high"` and `opposite` = `true` `textAlign` is set to
  6323. * `left`
  6324. *
  6325. * - for `align` = `"high"` and `opposite` = `false` `textAlign` is set to
  6326. * `right`
  6327. */
  6328. textAlign?: AlignValue;
  6329. }
  6330. /**
  6331. * Chart position and scale.
  6332. */
  6333. export interface ChartPositionObject {
  6334. left: number;
  6335. scaleX: number;
  6336. scaleY: number;
  6337. top: number;
  6338. }
  6339. /**
  6340. * (Highcharts, Highstock, Highmaps, Gantt) The button that appears after a
  6341. * selection zoom, allowing the user to reset zoom.
  6342. */
  6343. export interface ChartResetZoomButtonOptions {
  6344. /**
  6345. * (Highcharts, Highstock, Highmaps, Gantt) The position of the button.
  6346. */
  6347. position?: (AlignObject|ChartResetZoomButtonPositionOptions);
  6348. /**
  6349. * (Highcharts, Highstock, Highmaps, Gantt) What frame the button placement
  6350. * should be related to. Can be either `plotBox` or `spacingBox`.
  6351. */
  6352. relativeTo?: ButtonRelativeToValue;
  6353. /**
  6354. * (Highcharts, Highstock, Highmaps, Gantt) A collection of attributes for
  6355. * the button. The object takes SVG attributes like `fill`, `stroke`,
  6356. * `stroke-width` or `r`, the border radius. The theme also supports
  6357. * `style`, a collection of CSS properties for the text. Equivalent
  6358. * attributes for the hover state are given in `theme.states.hover`.
  6359. */
  6360. theme?: SVGAttributes;
  6361. }
  6362. /**
  6363. * (Highcharts, Highstock, Highmaps, Gantt) The position of the button.
  6364. */
  6365. export interface ChartResetZoomButtonPositionOptions {
  6366. /**
  6367. * (Highcharts, Highstock, Highmaps, Gantt) The horizontal alignment of the
  6368. * button.
  6369. */
  6370. align?: string;
  6371. /**
  6372. * (Highcharts, Highstock, Highmaps, Gantt) The vertical alignment of the
  6373. * button.
  6374. */
  6375. verticalAlign?: VerticalAlignValue;
  6376. /**
  6377. * (Highcharts, Highstock, Highmaps, Gantt) The horizontal offset of the
  6378. * button.
  6379. */
  6380. x?: number;
  6381. /**
  6382. * (Highcharts, Highstock, Highmaps, Gantt) The vertical offset of the
  6383. * button.
  6384. */
  6385. y?: number;
  6386. }
  6387. /**
  6388. * (Highcharts, Gantt) Options for a scrollable plot area. This feature provides
  6389. * a minimum size for the plot area of the chart. If the size gets smaller than
  6390. * this, typically on mobile devices, a native browser scrollbar is presented.
  6391. * This scrollbar provides smooth scrolling for the contents of the plot area,
  6392. * whereas the title, legend and unaffected axes are fixed.
  6393. *
  6394. * Since v7.1.2, a scrollable plot area can be defined for either horizontal or
  6395. * vertical scrolling, depending on whether the `minWidth` or `minHeight` option
  6396. * is set.
  6397. */
  6398. export interface ChartScrollablePlotAreaOptions {
  6399. /**
  6400. * (Highcharts, Gantt) The minimum height for the plot area. If it gets
  6401. * smaller than this, the plot area will become scrollable.
  6402. */
  6403. minHeight?: number;
  6404. /**
  6405. * (Highcharts, Gantt) The minimum width for the plot area. If it gets
  6406. * smaller than this, the plot area will become scrollable.
  6407. */
  6408. minWidth?: number;
  6409. /**
  6410. * (Highcharts, Gantt) The opacity of mask applied on one of the sides of
  6411. * the plot area.
  6412. */
  6413. opacity?: number;
  6414. /**
  6415. * (Highcharts, Gantt) The initial scrolling position of the scrollable plot
  6416. * area. Ranges from 0 to 1, where 0 aligns the plot area to the left and 1
  6417. * aligns it to the right. Typically we would use 1 if the chart has right
  6418. * aligned Y axes.
  6419. */
  6420. scrollPositionX?: number;
  6421. /**
  6422. * (Highcharts, Gantt) The initial scrolling position of the scrollable plot
  6423. * area. Ranges from 0 to 1, where 0 aligns the plot area to the top and 1
  6424. * aligns it to the bottom.
  6425. */
  6426. scrollPositionY?: number;
  6427. }
  6428. /**
  6429. * Axis context of the selection.
  6430. */
  6431. export interface ChartSelectionAxisContextObject {
  6432. /**
  6433. * The selected Axis.
  6434. */
  6435. axis: Axis;
  6436. /**
  6437. * The maximum axis value, either automatic or set manually.
  6438. */
  6439. max: number;
  6440. /**
  6441. * The minimum axis value, either automatic or set manually.
  6442. */
  6443. min: number;
  6444. }
  6445. /**
  6446. * The primary axes are `xAxis[0]` and `yAxis[0]`. Remember the unit of a
  6447. * datetime axis is milliseconds since 1970-01-01 00:00:00.
  6448. */
  6449. export interface ChartSelectionContextObject extends Event {
  6450. /**
  6451. * Arrays containing the axes of each dimension and each axis' min and max
  6452. * values.
  6453. */
  6454. xAxis: Array<ChartSelectionAxisContextObject>;
  6455. /**
  6456. * Arrays containing the axes of each dimension and each axis' min and max
  6457. * values.
  6458. */
  6459. yAxis: Array<ChartSelectionAxisContextObject>;
  6460. }
  6461. /**
  6462. * Interface description for a class.
  6463. */
  6464. export interface Class<T> extends Function {
  6465. /**
  6466. * Class costructor.
  6467. *
  6468. * @param args
  6469. * Constructor arguments.
  6470. *
  6471. * @return Class instance.
  6472. */
  6473. new(...args: Array<any>): T;
  6474. }
  6475. /**
  6476. * (Gantt) An object defining mouse events for the plot line. Supported
  6477. * properties are `click`, `mouseover`, `mouseout`, `mousemove`.
  6478. */
  6479. export interface ColorAxisCurrentDateIndicatorEventsOptions {
  6480. /**
  6481. * (Gantt) Click event on a plot band.
  6482. */
  6483. click?: EventCallbackFunction<PlotLineOrBand>;
  6484. /**
  6485. * (Gantt) Mouse move event on a plot band.
  6486. */
  6487. mousemove?: EventCallbackFunction<PlotLineOrBand>;
  6488. /**
  6489. * (Gantt) Mouse out event on the corner of a plot band.
  6490. */
  6491. mouseout?: EventCallbackFunction<PlotLineOrBand>;
  6492. /**
  6493. * (Gantt) Mouse over event on a plot band.
  6494. */
  6495. mouseover?: EventCallbackFunction<PlotLineOrBand>;
  6496. }
  6497. /**
  6498. * (Gantt) Text labels for the plot bands
  6499. */
  6500. export interface ColorAxisCurrentDateIndicatorLabelOptions {
  6501. /**
  6502. * (Gantt) Horizontal alignment of the label. Can be one of "left", "center"
  6503. * or "right".
  6504. */
  6505. align?: AlignValue;
  6506. /**
  6507. * (Gantt) Format of the label. This options is passed as the fist argument
  6508. * to dateFormat function.
  6509. */
  6510. format?: string;
  6511. /**
  6512. * (Gantt) Callback JavaScript function to format the label. Useful
  6513. * properties like the value of plot line or the range of plot band (`from`
  6514. * & `to` properties) can be found in `this.options` object.
  6515. */
  6516. formatter?: FormatterCallbackFunction<PlotLineOrBand>;
  6517. /**
  6518. * (Gantt) Rotation of the text label in degrees. Defaults to 0 for
  6519. * horizontal plot lines and 90 for vertical lines.
  6520. */
  6521. rotation?: number;
  6522. /**
  6523. * (Gantt) CSS styles for the text label.
  6524. *
  6525. * In styled mode, the labels are styled by the
  6526. * `.highcharts-plot-line-label` class.
  6527. */
  6528. style?: CSSObject;
  6529. /**
  6530. * (Gantt) The text itself. A subset of HTML is supported.
  6531. */
  6532. text?: string;
  6533. /**
  6534. * (Gantt) The text alignment for the label. While `align` determines where
  6535. * the texts anchor point is placed within the plot band, `textAlign`
  6536. * determines how the text is aligned against its anchor point. Possible
  6537. * values are "left", "center" and "right". Defaults to the same as the
  6538. * `align` option.
  6539. */
  6540. textAlign?: AlignValue;
  6541. /**
  6542. * (Gantt) Whether to use HTML to render the labels.
  6543. */
  6544. useHTML?: boolean;
  6545. /**
  6546. * (Gantt) Vertical alignment of the label relative to the plot line. Can be
  6547. * one of "top", "middle" or "bottom".
  6548. */
  6549. verticalAlign?: VerticalAlignValue;
  6550. /**
  6551. * (Gantt) Horizontal position relative the alignment. Default varies by
  6552. * orientation.
  6553. */
  6554. x?: number;
  6555. /**
  6556. * (Gantt) Vertical position of the text baseline relative to the alignment.
  6557. * Default varies by orientation.
  6558. */
  6559. y?: number;
  6560. }
  6561. /**
  6562. * (Highcharts, Highstock, Highmaps) An array of data classes or ranges for the
  6563. * choropleth map. If none given, the color axis is scalar and values are
  6564. * distributed as a gradient between the minimum and maximum colors.
  6565. */
  6566. export interface ColorAxisDataClassesOptions {
  6567. /**
  6568. * (Highcharts, Highstock, Highmaps) The color of each data class. If not
  6569. * set, the color is pulled from the global or chart-specific colors array.
  6570. * In styled mode, this option is ignored. Instead, use colors defined in
  6571. * CSS.
  6572. */
  6573. color?: (ColorString|GradientColorObject|PatternObject);
  6574. /**
  6575. * (Highcharts, Highstock, Highmaps) The start of the value range that the
  6576. * data class represents, relating to the point value.
  6577. *
  6578. * The range of each `dataClass` is closed in both ends, but can be
  6579. * overridden by the next `dataClass`.
  6580. */
  6581. from?: number;
  6582. /**
  6583. * (Highcharts, Highstock, Highmaps) The name of the data class as it
  6584. * appears in the legend. If no name is given, it is automatically created
  6585. * based on the `from` and `to` values. For full programmatic control,
  6586. * legend.labelFormatter can be used. In the formatter, `this.from` and
  6587. * `this.to` can be accessed.
  6588. */
  6589. name?: string;
  6590. /**
  6591. * (Highcharts, Highstock, Highmaps) The end of the value range that the
  6592. * data class represents, relating to the point value.
  6593. *
  6594. * The range of each `dataClass` is closed in both ends, but can be
  6595. * overridden by the next `dataClass`.
  6596. */
  6597. to?: number;
  6598. }
  6599. /**
  6600. * (Highcharts, Highstock, Highmaps) Event handlers for the axis.
  6601. */
  6602. export interface ColorAxisEventsOptions {
  6603. /**
  6604. * (Highcharts, Highstock, Highmaps) As opposed to the `setExtremes` event,
  6605. * this event fires after the final min and max values are computed and
  6606. * corrected for `minRange`.
  6607. *
  6608. * Fires when the minimum and maximum is set for the axis, either by calling
  6609. * the `.setExtremes()` method or by selecting an area in the chart. One
  6610. * parameter, `event`, is passed to the function, containing common event
  6611. * information.
  6612. *
  6613. * The new user set minimum and maximum values can be found by `event.min`
  6614. * and `event.max`. These reflect the axis minimum and maximum in axis
  6615. * values. The actual data extremes are found in `event.dataMin` and
  6616. * `event.dataMax`.
  6617. */
  6618. afterSetExtremes?: AxisSetExtremesEventCallbackFunction;
  6619. /**
  6620. * (Highcharts, Highstock, Highmaps) Fires when the legend item belonging to
  6621. * the colorAxis is clicked. One parameter, `event`, is passed to the
  6622. * function.
  6623. */
  6624. legendItemClick?: Function;
  6625. /**
  6626. * (Highcharts, Highstock, Highmaps) Fires when the minimum and maximum is
  6627. * set for the axis, either by calling the `.setExtremes()` method or by
  6628. * selecting an area in the chart. One parameter, `event`, is passed to the
  6629. * function, containing common event information.
  6630. *
  6631. * The new user set minimum and maximum values can be found by `event.min`
  6632. * and `event.max`. These reflect the axis minimum and maximum in data
  6633. * values. When an axis is zoomed all the way out from the "Reset zoom"
  6634. * button, `event.min` and `event.max` are null, and the new extremes are
  6635. * set based on `this.dataMin` and `this.dataMax`.
  6636. */
  6637. setExtremes?: AxisSetExtremesEventCallbackFunction;
  6638. }
  6639. /**
  6640. * (Gantt) Set grid options for the axis labels. Requires Highcharts Gantt.
  6641. */
  6642. export interface ColorAxisGridOptions {
  6643. /**
  6644. * (Gantt) Set border color for the label grid lines.
  6645. */
  6646. borderColor?: ColorString;
  6647. /**
  6648. * (Gantt) Set border width of the label grid lines.
  6649. */
  6650. borderWidth?: number;
  6651. /**
  6652. * (Gantt) Set cell height for grid axis labels. By default this is
  6653. * calculated from font size. This option only applies to horizontal axes.
  6654. */
  6655. cellHeight?: number;
  6656. /**
  6657. * (Gantt) Set specific options for each column (or row for horizontal axes)
  6658. * in the grid. Each extra column/row is its own axis, and the axis options
  6659. * can be set here.
  6660. */
  6661. columns?: Array<XAxisOptions>;
  6662. /**
  6663. * (Gantt) Enable grid on the axis labels. Defaults to true for Gantt
  6664. * charts.
  6665. */
  6666. enabled?: boolean;
  6667. }
  6668. /**
  6669. * (Highcharts, Highstock, Highmaps) The axis labels show the number for each
  6670. * tick.
  6671. *
  6672. * For more live examples on label options, see xAxis.labels in the Highcharts
  6673. * API.
  6674. */
  6675. export interface ColorAxisLabelsOptions {
  6676. /**
  6677. * (Highcharts, Highstock, Highmaps) What part of the string the given
  6678. * position is anchored to. If `left`, the left side of the string is at the
  6679. * axis position. Can be one of `"left"`, `"center"` or `"right"`. Defaults
  6680. * to an intelligent guess based on which side of the chart the axis is on
  6681. * and the rotation of the label.
  6682. */
  6683. align?: AlignValue;
  6684. /**
  6685. * (Highcharts, Highstock, Gantt) For horizontal axes, the allowed degrees
  6686. * of label rotation to prevent overlapping labels. If there is enough
  6687. * space, labels are not rotated. As the chart gets narrower, it will start
  6688. * rotating the labels -45 degrees, then remove every second label and try
  6689. * again with rotations 0 and -45 etc. Set it to `false` to disable
  6690. * rotation, which will cause the labels to word-wrap if possible.
  6691. */
  6692. autoRotation?: (false|Array<number>);
  6693. /**
  6694. * (Highcharts, Gantt) When each category width is more than this many
  6695. * pixels, we don't apply auto rotation. Instead, we lay out the axis label
  6696. * with word wrap. A lower limit makes sense when the label contains
  6697. * multiple short words that don't extend the available horizontal space for
  6698. * each label.
  6699. */
  6700. autoRotationLimit?: number;
  6701. /**
  6702. * (Highcharts, Gantt) Polar charts only. The label's pixel distance from
  6703. * the perimeter of the plot area.
  6704. */
  6705. distance?: number;
  6706. /**
  6707. * (Highcharts, Highstock, Highmaps) Enable or disable the axis labels.
  6708. */
  6709. enabled?: boolean;
  6710. /**
  6711. * (Highcharts, Highstock, Highmaps) A format string for the axis label. See
  6712. * format string for example usage.
  6713. *
  6714. * Note: The default value is not specified due to the dynamic nature of the
  6715. * default implementation.
  6716. */
  6717. format?: string;
  6718. /**
  6719. * (Highcharts, Highstock, Highmaps) Callback JavaScript function to format
  6720. * the label. The value is given by `this.value`. Additional properties for
  6721. * `this` are `axis`, `chart`, `isFirst` and `isLast`. The value of the
  6722. * default label formatter can be retrieved by calling
  6723. * `this.axis.defaultLabelFormatter.call(this)` within the function.
  6724. *
  6725. * Defaults to: (see online documentation for example)
  6726. */
  6727. formatter?: AxisLabelsFormatterCallbackFunction;
  6728. /**
  6729. * (Gantt) The number of pixels to indent the labels per level in a treegrid
  6730. * axis.
  6731. */
  6732. indentation?: number;
  6733. /**
  6734. * (Highcharts, Highstock, Highmaps) How to handle overflowing labels on
  6735. * horizontal color axis. If set to `"allow"`, it will not be aligned at
  6736. * all. By default it `"justify"` labels inside the chart area. If there is
  6737. * room to move it, it will be aligned to the edge, else it will be removed.
  6738. */
  6739. overflow?: OptionsOverflowValue;
  6740. /**
  6741. * (Highcharts, Gantt) The pixel padding for axis labels, to ensure white
  6742. * space between them.
  6743. */
  6744. padding?: number;
  6745. /**
  6746. * (Highcharts) Defines how the labels are be repositioned according to the
  6747. * 3D chart orientation.
  6748. *
  6749. * - `'offset'`: Maintain a fixed horizontal/vertical distance from the tick
  6750. * marks, despite the chart orientation. This is the backwards compatible
  6751. * behavior, and causes skewing of X and Z axes.
  6752. *
  6753. * - `'chart'`: Preserve 3D position relative to the chart. This looks nice,
  6754. * but hard to read if the text isn't forward-facing.
  6755. *
  6756. * - `'flap'`: Rotated text along the axis to compensate for the chart
  6757. * orientation. This tries to maintain text as legible as possible on all
  6758. * orientations.
  6759. *
  6760. * - `'ortho'`: Rotated text along the axis direction so that the labels are
  6761. * orthogonal to the axis. This is very similar to `'flap'`, but prevents
  6762. * skewing the labels (X and Y scaling are still present).
  6763. */
  6764. position3d?: OptionsPosition3dValue;
  6765. /**
  6766. * (Highcharts, Gantt) Whether to reserve space for the labels. By default,
  6767. * space is reserved for the labels in these cases:
  6768. *
  6769. * * On all horizontal axes.
  6770. *
  6771. * * On vertical axes if `label.align` is `right` on a left-side axis or
  6772. * `left` on a right-side axis.
  6773. *
  6774. * * On vertical axes if `label.align` is `center`.
  6775. *
  6776. * This can be turned off when for example the labels are rendered inside
  6777. * the plot area instead of outside.
  6778. */
  6779. reserveSpace?: boolean;
  6780. /**
  6781. * (Highcharts, Highstock, Highmaps) Rotation of the labels in degrees.
  6782. */
  6783. rotation?: number;
  6784. /**
  6785. * (Highcharts) If enabled, the axis labels will skewed to follow the
  6786. * perspective.
  6787. *
  6788. * This will fix overlapping labels and titles, but texts become less
  6789. * legible due to the distortion.
  6790. *
  6791. * The final appearance depends heavily on `labels.position3d`.
  6792. */
  6793. skew3d?: boolean;
  6794. /**
  6795. * (Highcharts, Highstock, Highmaps) Horizontal axes only. The number of
  6796. * lines to spread the labels over to make room or tighter labels.
  6797. */
  6798. staggerLines?: number;
  6799. /**
  6800. * (Highcharts, Highstock, Highmaps) To show only every _n_'th label on the
  6801. * axis, set the step to _n_. Setting the step to 2 shows every other label.
  6802. *
  6803. * By default, the step is calculated automatically to avoid overlap. To
  6804. * prevent this, set it to 1\. This usually only happens on a category axis,
  6805. * and is often a sign that you have chosen the wrong axis type.
  6806. *
  6807. * Read more at Axis docs => What axis should I use?
  6808. */
  6809. step?: number;
  6810. /**
  6811. * (Highcharts, Highstock, Highmaps) CSS styles for the label. Use
  6812. * `whiteSpace: 'nowrap'` to prevent wrapping of category labels. Use
  6813. * `textOverflow: 'none'` to prevent ellipsis (dots).
  6814. *
  6815. * In styled mode, the labels are styled with the `.highcharts-axis-labels`
  6816. * class.
  6817. */
  6818. style?: CSSObject;
  6819. /**
  6820. * (Highcharts, Highstock, Highmaps) Whether to use HTML to render the
  6821. * labels.
  6822. */
  6823. useHTML?: boolean;
  6824. /**
  6825. * (Highcharts, Highstock, Highmaps) The x position offset of all labels
  6826. * relative to the tick positions on the axis.
  6827. */
  6828. x?: number;
  6829. /**
  6830. * (Highcharts, Highstock, Highmaps) The y position offset of all labels
  6831. * relative to the tick positions on the axis. The default makes it adapt to
  6832. * the font size of the bottom axis.
  6833. */
  6834. y?: number;
  6835. /**
  6836. * (Highcharts, Highstock, Highmaps) The Z index for the axis labels.
  6837. */
  6838. zIndex?: number;
  6839. }
  6840. /**
  6841. * (Highcharts, Highstock, Highmaps) A color axis for series. Visually, the
  6842. * color axis will appear as a gradient or as separate items inside the legend,
  6843. * depending on whether the axis is scalar or based on data classes.
  6844. *
  6845. * For supported color formats, see the docs article about colors.
  6846. *
  6847. * A scalar color axis is represented by a gradient. The colors either range
  6848. * between the minColor and the maxColor, or for more fine grained control the
  6849. * colors can be defined in stops. Often times, the color axis needs to be
  6850. * adjusted to get the right color spread for the data. In addition to stops,
  6851. * consider using a logarithmic axis type, or setting min and max to avoid the
  6852. * colors being determined by outliers.
  6853. *
  6854. * When dataClasses are used, the ranges are subdivided into separate classes
  6855. * like categories based on their values. This can be used for ranges between
  6856. * two values, but also for a true category. However, when your data is
  6857. * categorized, it may be as convenient to add each category to a separate
  6858. * series.
  6859. *
  6860. * Color axis does not work with: `sankey`, `sunburst`, `dependencywheel`,
  6861. * `networkgraph`, `wordcloud`, `venn`, `gauge` and `solidgauge` series types.
  6862. *
  6863. * Since v7.2.0 `colorAxis` can also be an array of options objects.
  6864. *
  6865. * See the Axis object for programmatic access to the axis.
  6866. */
  6867. export interface ColorAxisOptions {
  6868. /**
  6869. * (Highcharts, Highstock, Highmaps) Accessibility options for an axis.
  6870. * Requires the accessibility module.
  6871. */
  6872. accessibility?: AxisAccessibilityOptionsObject;
  6873. /**
  6874. * (Highcharts, Highstock, Highmaps) Whether to allow decimals on the color
  6875. * axis.
  6876. */
  6877. allowDecimals?: boolean;
  6878. /**
  6879. * (Highcharts) In a polar chart, this is the angle of the Y axis in
  6880. * degrees, where 0 is up and 90 is right. The angle determines the position
  6881. * of the axis line and the labels, though the coordinate system is
  6882. * unaffected. Since v8.0.0 this option is also applicable for X axis
  6883. * (inverted polar).
  6884. */
  6885. angle?: number;
  6886. /**
  6887. * (Highcharts, Highstock, Gantt) The highest allowed value for
  6888. * automatically computed axis extremes.
  6889. */
  6890. ceiling?: number;
  6891. /**
  6892. * (Highcharts, Highstock, Highmaps) A class name that opens for styling the
  6893. * axis by CSS, especially in Highcharts styled mode. The class name is
  6894. * applied to group elements for the grid, axis elements and labels.
  6895. */
  6896. className?: string;
  6897. /**
  6898. * (Gantt) Show an indicator on the axis for the current date and time. Can
  6899. * be a boolean or a configuration object similar to xAxis.plotLines.
  6900. */
  6901. currentDateIndicator?: (boolean|AxisCurrentDateIndicatorOptions);
  6902. /**
  6903. * (Highcharts, Highstock, Highmaps) Determines how to set each data class'
  6904. * color if no individual color is set. The default value, `tween`, computes
  6905. * intermediate colors between `minColor` and `maxColor`. The other possible
  6906. * value, `category`, pulls colors from the global or chart specific colors
  6907. * array.
  6908. */
  6909. dataClassColor?: OptionsDataClassColorValue;
  6910. /**
  6911. * (Highcharts, Highstock, Highmaps) An array of data classes or ranges for
  6912. * the choropleth map. If none given, the color axis is scalar and values
  6913. * are distributed as a gradient between the minimum and maximum colors.
  6914. */
  6915. dataClasses?: Array<ColorAxisDataClassesOptions>;
  6916. /**
  6917. * (Highcharts, Highstock, Highmaps) Whether to force the axis to end on a
  6918. * tick. Use this option with the maxPadding option to control the axis end.
  6919. */
  6920. endOnTick?: boolean;
  6921. /**
  6922. * (Highcharts, Highstock, Highmaps) Event handlers for the axis.
  6923. */
  6924. events?: ColorAxisEventsOptions;
  6925. /**
  6926. * (Highcharts, Highstock, Gantt) The lowest allowed value for automatically
  6927. * computed axis extremes.
  6928. */
  6929. floor?: number;
  6930. /**
  6931. * (Gantt) Set grid options for the axis labels. Requires Highcharts Gantt.
  6932. */
  6933. grid?: ColorAxisGridOptions;
  6934. /**
  6935. * (Highcharts, Highstock, Highmaps) Color of the grid lines extending from
  6936. * the axis across the gradient.
  6937. */
  6938. gridLineColor?: (ColorString|GradientColorObject|PatternObject);
  6939. /**
  6940. * (Highcharts, Highstock, Highmaps) The dash or dot style of the grid
  6941. * lines. For possible values, see this demonstration.
  6942. */
  6943. gridLineDashStyle?: DashStyleValue;
  6944. /**
  6945. * (Highcharts) Polar charts only. Whether the grid lines should draw as a
  6946. * polygon with straight lines between categories, or as circles. Can be
  6947. * either `circle` or `polygon`. Since v8.0.0 this option is also applicable
  6948. * for X axis (inverted polar).
  6949. */
  6950. gridLineInterpolation?: OptionsGridLineInterpolationValue;
  6951. /**
  6952. * (Highcharts, Highstock, Highmaps) The width of the grid lines extending
  6953. * from the axis across the gradient of a scalar color axis.
  6954. */
  6955. gridLineWidth?: number;
  6956. /**
  6957. * (Highcharts, Highstock, Gantt) The Z index of the grid lines.
  6958. */
  6959. gridZIndex?: number;
  6960. /**
  6961. * (Highcharts, Highstock, Highmaps) An id for the axis. This can be used
  6962. * after render time to get a pointer to the axis object through
  6963. * `chart.get()`.
  6964. */
  6965. id?: string;
  6966. /**
  6967. * (Highcharts, Highstock, Highmaps) The axis labels show the number for
  6968. * each tick.
  6969. *
  6970. * For more live examples on label options, see xAxis.labels in the
  6971. * Highcharts API.
  6972. */
  6973. labels?: ColorAxisLabelsOptions;
  6974. /**
  6975. * (Highcharts, Highstock, Highmaps) The layout of the color axis. Can be
  6976. * `'horizontal'` or `'vertical'`. If none given, the color axis has the
  6977. * same layout as the legend.
  6978. */
  6979. layout?: (string|undefined);
  6980. /**
  6981. * (Highcharts, Highstock, Highmaps) The color of the line marking the axis
  6982. * itself.
  6983. *
  6984. * In styled mode, the line stroke is given in the `.highcharts-axis-line`
  6985. * or `.highcharts-xaxis-line` class.
  6986. */
  6987. lineColor?: ColorType;
  6988. /**
  6989. * (Highcharts, Highstock, Highmaps) If there are multiple axes on the same
  6990. * side of the chart, the pixel margin between the axes. Defaults to 0 on
  6991. * vertical axes, 15 on horizontal axes.
  6992. */
  6993. margin?: number;
  6994. /**
  6995. * (Highcharts, Highstock, Highmaps) The triangular marker on a scalar color
  6996. * axis that points to the value of the hovered area. To disable the marker,
  6997. * set `marker: null`.
  6998. */
  6999. marker?: PointMarkerOptionsObject;
  7000. /**
  7001. * (Highcharts, Highstock, Highmaps) The maximum value of the axis in terms
  7002. * of map point values. If `null`, the max value is automatically
  7003. * calculated. If the `endOnTick` option is true, the max value might be
  7004. * rounded up.
  7005. */
  7006. max?: number;
  7007. /**
  7008. * (Highcharts, Highstock, Highmaps) The color to represent the maximum of
  7009. * the color axis. Unless dataClasses or stops are set, the gradient ends at
  7010. * this value.
  7011. *
  7012. * If dataClasses are set, the color is based on minColor and maxColor
  7013. * unless a color is set for each data class, or the dataClassColor is set.
  7014. */
  7015. maxColor?: (ColorString|GradientColorObject|PatternObject);
  7016. /**
  7017. * (Highcharts, Highstock, Highmaps) Padding of the max value relative to
  7018. * the length of the axis. A padding of 0.05 will make a 100px axis 5px
  7019. * longer.
  7020. */
  7021. maxPadding?: number;
  7022. /**
  7023. * (Highstock, Gantt) Maximum range which can be set using the navigator's
  7024. * handles. Opposite of xAxis.minRange.
  7025. */
  7026. maxRange?: number;
  7027. /**
  7028. * (Highcharts, Highstock, Highmaps) The minimum value of the axis in terms
  7029. * of map point values. If `null`, the min value is automatically
  7030. * calculated. If the `startOnTick` option is true, the min value might be
  7031. * rounded down.
  7032. */
  7033. min?: number;
  7034. /**
  7035. * (Highcharts, Highstock, Highmaps) The color to represent the minimum of
  7036. * the color axis. Unless dataClasses or stops are set, the gradient starts
  7037. * at this value.
  7038. *
  7039. * If dataClasses are set, the color is based on minColor and maxColor
  7040. * unless a color is set for each data class, or the dataClassColor is set.
  7041. */
  7042. minColor?: (ColorString|GradientColorObject|PatternObject);
  7043. /**
  7044. * (Highcharts, Highstock, Highmaps) Color of the minor, secondary grid
  7045. * lines.
  7046. *
  7047. * In styled mode, the stroke width is given in the
  7048. * `.highcharts-minor-grid-line` class.
  7049. */
  7050. minorGridLineColor?: ColorType;
  7051. /**
  7052. * (Highcharts, Highstock, Highmaps) The dash or dot style of the minor grid
  7053. * lines. For possible values, see this demonstration.
  7054. */
  7055. minorGridLineDashStyle?: DashStyleValue;
  7056. /**
  7057. * (Highcharts, Highstock, Highmaps) Width of the minor, secondary grid
  7058. * lines.
  7059. *
  7060. * In styled mode, the stroke width is given in the `.highcharts-grid-line`
  7061. * class.
  7062. */
  7063. minorGridLineWidth?: number;
  7064. /**
  7065. * (Highcharts, Highstock, Highmaps) Color for the minor tick marks.
  7066. */
  7067. minorTickColor?: ColorType;
  7068. /**
  7069. * (Highcharts, Highstock, Highmaps) Specific tick interval in axis units
  7070. * for the minor ticks. On a linear axis, if `"auto"`, the minor tick
  7071. * interval is calculated as a fifth of the tickInterval. If `null` or
  7072. * `undefined`, minor ticks are not shown.
  7073. *
  7074. * On logarithmic axes, the unit is the power of the value. For example,
  7075. * setting the minorTickInterval to 1 puts one tick on each of 0.1, 1, 10,
  7076. * 100 etc. Setting the minorTickInterval to 0.1 produces 9 ticks between 1
  7077. * and 10, 10 and 100 etc.
  7078. *
  7079. * If user settings dictate minor ticks to become too dense, they don't make
  7080. * sense, and will be ignored to prevent performance problems.
  7081. */
  7082. minorTickInterval?: (number|string|null);
  7083. /**
  7084. * (Highcharts, Highstock, Highmaps) The pixel length of the minor tick
  7085. * marks.
  7086. */
  7087. minorTickLength?: number;
  7088. /**
  7089. * (Highcharts, Highstock, Highmaps) The position of the minor tick marks
  7090. * relative to the axis line. Can be one of `inside` and `outside`.
  7091. */
  7092. minorTickPosition?: OptionsMinorTickPositionValue;
  7093. /**
  7094. * (Highcharts, Highstock, Highmaps) Enable or disable minor ticks. Unless
  7095. * minorTickInterval is set, the tick interval is calculated as a fifth of
  7096. * the `tickInterval`.
  7097. *
  7098. * On a logarithmic axis, minor ticks are laid out based on a best guess,
  7099. * attempting to enter approximately 5 minor ticks between each major tick.
  7100. *
  7101. * Prior to v6.0.0, ticks were unabled in auto layout by setting
  7102. * `minorTickInterval` to `"auto"`.
  7103. */
  7104. minorTicks?: boolean;
  7105. /**
  7106. * (Highcharts, Highstock, Highmaps) The pixel width of the minor tick mark.
  7107. */
  7108. minorTickWidth?: number;
  7109. /**
  7110. * (Highcharts, Highstock, Highmaps) Padding of the min value relative to
  7111. * the length of the axis. A padding of 0.05 will make a 100px axis 5px
  7112. * longer.
  7113. */
  7114. minPadding?: number;
  7115. /**
  7116. * (Highstock) In an ordinal axis, the points are equally spaced in the
  7117. * chart regardless of the actual time or x distance between them. This
  7118. * means that missing data periods (e.g. nights or weekends for a stock
  7119. * chart) will not take up space in the chart. Having `ordinal: false` will
  7120. * show any gaps created by the `gapSize` setting proportionate to their
  7121. * duration.
  7122. *
  7123. * In stock charts the X axis is ordinal by default, unless the boost module
  7124. * is used and at least one of the series' data length exceeds the
  7125. * boostThreshold.
  7126. */
  7127. ordinal?: boolean;
  7128. /**
  7129. * (Highstock) Additional range on the right side of the xAxis. Works
  7130. * similar to `xAxis.maxPadding`, but value is set in milliseconds. Can be
  7131. * set for both main `xAxis` and the navigator's `xAxis`.
  7132. */
  7133. overscroll?: number;
  7134. /**
  7135. * (Highstock) The zoomed range to display when only defining one or none of
  7136. * `min` or `max`. For example, to show the latest month, a range of one
  7137. * month can be set.
  7138. */
  7139. range?: number;
  7140. /**
  7141. * (Highcharts, Highstock, Highmaps) Whether to reverse the axis so that the
  7142. * highest number is closest to the origin. Defaults to `false` in a
  7143. * horizontal legend and `true` in a vertical legend, where the smallest
  7144. * value starts on top.
  7145. */
  7146. reversed?: boolean;
  7147. /**
  7148. * (Highstock) An optional scrollbar to display on the X axis in response to
  7149. * limiting the minimum and maximum of the axis values.
  7150. *
  7151. * In styled mode, all the presentational options for the scrollbar are
  7152. * replaced by the classes `.highcharts-scrollbar-thumb`,
  7153. * `.highcharts-scrollbar-arrow`, `.highcharts-scrollbar-button`,
  7154. * `.highcharts-scrollbar-rifles` and `.highcharts-scrollbar-track`.
  7155. */
  7156. scrollbar?: ColorAxisScrollbarOptions;
  7157. /**
  7158. * (Highcharts, Highstock, Highmaps) Whether to show the first tick label.
  7159. */
  7160. showFirstLabel?: boolean;
  7161. /**
  7162. * (Highcharts, Highstock, Highmaps) Whether to display the colorAxis in the
  7163. * legend.
  7164. */
  7165. showInLegend?: boolean;
  7166. /**
  7167. * (Highcharts, Highstock, Gantt) Whether to show the last tick label.
  7168. * Defaults to `true` on cartesian charts, and `false` on polar charts.
  7169. */
  7170. showLastLabel?: boolean;
  7171. /**
  7172. * (Highcharts, Highstock, Gantt) A soft maximum for the axis. If the series
  7173. * data maximum is less than this, the axis will stay at this maximum, but
  7174. * if the series data maximum is higher, the axis will flex to show all
  7175. * data.
  7176. */
  7177. softMax?: number;
  7178. /**
  7179. * (Highcharts, Highstock, Gantt) A soft minimum for the axis. If the series
  7180. * data minimum is greater than this, the axis will stay at this minimum,
  7181. * but if the series data minimum is lower, the axis will flex to show all
  7182. * data.
  7183. */
  7184. softMin?: number;
  7185. /**
  7186. * (Highcharts, Highstock, Gantt) For datetime axes, this decides where to
  7187. * put the tick between weeks. 0 = Sunday, 1 = Monday.
  7188. */
  7189. startOfWeek?: number;
  7190. /**
  7191. * (Highcharts, Highstock, Highmaps) Whether to force the axis to start on a
  7192. * tick. Use this option with the `maxPadding` option to control the axis
  7193. * start.
  7194. */
  7195. startOnTick?: boolean;
  7196. /**
  7197. * (Highcharts, Highstock, Highmaps) Color stops for the gradient of a
  7198. * scalar color axis. Use this in cases where a linear gradient between a
  7199. * `minColor` and `maxColor` is not sufficient. The stops is an array of
  7200. * tuples, where the first item is a float between 0 and 1 assigning the
  7201. * relative position in the gradient, and the second item is the color.
  7202. */
  7203. stops?: Array<[number, ColorString]>;
  7204. /**
  7205. * (Highcharts, Highstock, Gantt) The amount of ticks to draw on the axis.
  7206. * This opens up for aligning the ticks of multiple charts or panes within a
  7207. * chart. This option overrides the `tickPixelInterval` option.
  7208. *
  7209. * This option only has an effect on linear axes. Datetime, logarithmic or
  7210. * category axes are not affected.
  7211. */
  7212. tickAmount?: number;
  7213. /**
  7214. * (Highcharts, Highstock, Highmaps) Color for the main tick marks.
  7215. *
  7216. * In styled mode, the stroke is given in the `.highcharts-tick` class.
  7217. */
  7218. tickColor?: ColorType;
  7219. /**
  7220. * (Highcharts, Highstock, Highmaps) The interval of the tick marks in axis
  7221. * units. When `null`, the tick interval is computed to approximately follow
  7222. * the `tickPixelInterval`.
  7223. */
  7224. tickInterval?: number;
  7225. /**
  7226. * (Highcharts, Highstock, Highmaps) The pixel length of the main tick marks
  7227. * on the color axis.
  7228. */
  7229. tickLength?: number;
  7230. /**
  7231. * (Highcharts, Gantt) For categorized axes only. If `on` the tick mark is
  7232. * placed in the center of the category, if `between` the tick mark is
  7233. * placed between categories. The default is `between` if the `tickInterval`
  7234. * is 1, else `on`.
  7235. */
  7236. tickmarkPlacement?: OptionsTickmarkPlacementValue;
  7237. /**
  7238. * (Highcharts, Highstock, Highmaps) If tickInterval is `null` this option
  7239. * sets the approximate pixel interval of the tick marks.
  7240. */
  7241. tickPixelInterval?: number;
  7242. /**
  7243. * (Highcharts, Highstock, Highmaps) The position of the major tick marks
  7244. * relative to the axis line. Can be one of `inside` and `outside`.
  7245. */
  7246. tickPosition?: OptionsTickPositionValue;
  7247. /**
  7248. * (Highcharts, Highstock, Highmaps) A callback function returning array
  7249. * defining where the ticks are laid out on the axis. This overrides the
  7250. * default behaviour of tickPixelInterval and tickInterval. The automatic
  7251. * tick positions are accessible through `this.tickPositions` and can be
  7252. * modified by the callback.
  7253. */
  7254. tickPositioner?: AxisTickPositionerCallbackFunction;
  7255. /**
  7256. * (Highcharts, Highstock, Highmaps) An array defining where the ticks are
  7257. * laid out on the axis. This overrides the default behaviour of
  7258. * tickPixelInterval and tickInterval.
  7259. */
  7260. tickPositions?: Array<number>;
  7261. /**
  7262. * (Highcharts, Highstock, Highmaps) The pixel width of the major tick
  7263. * marks. Defaults to 0 on category axes, otherwise 1.
  7264. *
  7265. * In styled mode, the stroke width is given in the `.highcharts-tick`
  7266. * class, but in order for the element to be generated on category axes, the
  7267. * option must be explicitly set to 1.
  7268. */
  7269. tickWidth?: (number|undefined);
  7270. /**
  7271. * (Highcharts, Highstock, Highmaps) The type of interpolation to use for
  7272. * the color axis. Can be `linear` or `logarithmic`.
  7273. */
  7274. type?: ColorAxisTypeValue;
  7275. /**
  7276. * (Highcharts, Gantt) Applies only when the axis `type` is `category`. When
  7277. * `uniqueNames` is true, points are placed on the X axis according to their
  7278. * names. If the same point name is repeated in the same or another series,
  7279. * the point is placed on the same X position as other points of the same
  7280. * name. When `uniqueNames` is false, the points are laid out in increasing
  7281. * X positions regardless of their names, and the X axis category will take
  7282. * the name of the last point in each position.
  7283. */
  7284. uniqueNames?: boolean;
  7285. /**
  7286. * (Highcharts, Highstock, Gantt) Datetime axis only. An array determining
  7287. * what time intervals the ticks are allowed to fall on. Each array item is
  7288. * an array where the first value is the time unit and the second value
  7289. * another array of allowed multiples.
  7290. *
  7291. * Defaults to: (see online documentation for example)
  7292. */
  7293. units?: Array<[string, (Array<number>|null)]>;
  7294. /**
  7295. * (Highcharts, Highstock, Gantt) Whether axis, including axis title, line,
  7296. * ticks and labels, should be visible.
  7297. */
  7298. visible?: boolean;
  7299. }
  7300. /**
  7301. * (Highstock) An optional scrollbar to display on the X axis in response to
  7302. * limiting the minimum and maximum of the axis values.
  7303. *
  7304. * In styled mode, all the presentational options for the scrollbar are replaced
  7305. * by the classes `.highcharts-scrollbar-thumb`, `.highcharts-scrollbar-arrow`,
  7306. * `.highcharts-scrollbar-button`, `.highcharts-scrollbar-rifles` and
  7307. * `.highcharts-scrollbar-track`.
  7308. */
  7309. export interface ColorAxisScrollbarOptions {
  7310. /**
  7311. * (Highstock) The background color of the scrollbar itself.
  7312. */
  7313. barBackgroundColor?: (ColorString|GradientColorObject|PatternObject);
  7314. /**
  7315. * (Highstock) The color of the scrollbar's border.
  7316. */
  7317. barBorderColor?: (ColorString|GradientColorObject|PatternObject);
  7318. /**
  7319. * (Highstock) The border rounding radius of the bar.
  7320. */
  7321. barBorderRadius?: number;
  7322. /**
  7323. * (Highstock) The width of the bar's border.
  7324. */
  7325. barBorderWidth?: number;
  7326. /**
  7327. * (Highstock) The color of the small arrow inside the scrollbar buttons.
  7328. */
  7329. buttonArrowColor?: (ColorString|GradientColorObject|PatternObject);
  7330. /**
  7331. * (Highstock) The color of scrollbar buttons.
  7332. */
  7333. buttonBackgroundColor?: (ColorString|GradientColorObject|PatternObject);
  7334. /**
  7335. * (Highstock) The color of the border of the scrollbar buttons.
  7336. */
  7337. buttonBorderColor?: (ColorString|GradientColorObject|PatternObject);
  7338. /**
  7339. * (Highstock) The corner radius of the scrollbar buttons.
  7340. */
  7341. buttonBorderRadius?: number;
  7342. /**
  7343. * (Highstock) The border width of the scrollbar buttons.
  7344. */
  7345. buttonBorderWidth?: number;
  7346. /**
  7347. * (Highstock) Enable or disable the scrollbar.
  7348. */
  7349. enabled?: boolean;
  7350. /**
  7351. * (Highstock) The height of the scrollbar. The height also applies to the
  7352. * width of the scroll arrows so that they are always squares. Defaults to
  7353. * 20 for touch devices and 14 for mouse devices.
  7354. */
  7355. height?: number;
  7356. /**
  7357. * (Highstock) Whether to redraw the main chart as the scrollbar or the
  7358. * navigator zoomed window is moved. Defaults to `true` for modern browsers
  7359. * and `false` for legacy IE browsers as well as mobile devices.
  7360. */
  7361. liveRedraw?: boolean;
  7362. /**
  7363. * (Highstock) The margin between the scrollbar and its axis when the
  7364. * scrollbar is applied directly to an axis.
  7365. */
  7366. margin?: number;
  7367. /**
  7368. * (Highstock) The minimum width of the scrollbar.
  7369. */
  7370. minWidth?: number;
  7371. /**
  7372. * (Highstock) The color of the small rifles in the middle of the scrollbar.
  7373. */
  7374. rifleColor?: (ColorString|GradientColorObject|PatternObject);
  7375. /**
  7376. * (Highstock) Whether to show or hide the scrollbar when the scrolled
  7377. * content is zoomed out to it full extent.
  7378. */
  7379. showFull?: boolean;
  7380. /**
  7381. * (Highstock) The color of the track background.
  7382. */
  7383. trackBackgroundColor?: (ColorString|GradientColorObject|PatternObject);
  7384. /**
  7385. * (Highstock) The color of the border of the scrollbar track.
  7386. */
  7387. trackBorderColor?: (ColorString|GradientColorObject|PatternObject);
  7388. /**
  7389. * (Highstock) The corner radius of the border of the scrollbar track.
  7390. */
  7391. trackBorderRadius?: number;
  7392. /**
  7393. * (Highstock) The width of the border of the scrollbar track.
  7394. */
  7395. trackBorderWidth?: number;
  7396. /**
  7397. * (Highstock) The z index of the scrollbar group.
  7398. */
  7399. zIndex?: number;
  7400. }
  7401. export interface ConnectorsAnimationOptionsObject {
  7402. reversed?: boolean;
  7403. }
  7404. /**
  7405. * (Gantt) Marker options specific to the end markers for this chart's
  7406. * Pathfinder connectors. Overrides the generic marker options.
  7407. */
  7408. export interface ConnectorsEndMarkerOptions {
  7409. /**
  7410. * (Gantt) Horizontal alignment of the markers relative to the points.
  7411. */
  7412. align?: (string|AlignValue);
  7413. /**
  7414. * (Gantt) Set the color of the connector markers. By default this is the
  7415. * same as the connector color.
  7416. */
  7417. color?: (ColorString|GradientColorObject|PatternObject);
  7418. /**
  7419. * (Gantt) Enable markers for the connectors.
  7420. */
  7421. enabled?: boolean;
  7422. /**
  7423. * (Gantt) Set the height of the connector markers. If not supplied, this is
  7424. * inferred from the marker radius.
  7425. */
  7426. height?: number;
  7427. /**
  7428. * (Gantt) Whether or not to draw the markers inside the points.
  7429. */
  7430. inside?: boolean;
  7431. /**
  7432. * (Gantt) Set the line/border color of the connector markers. By default
  7433. * this is the same as the marker color.
  7434. */
  7435. lineColor?: ColorString;
  7436. /**
  7437. * (Gantt) Set the line/border width of the pathfinder markers.
  7438. */
  7439. lineWidth?: number;
  7440. /**
  7441. * (Gantt) Set the radius of the connector markers. The default is
  7442. * automatically computed based on the algorithmMargin setting.
  7443. *
  7444. * Setting marker.width and marker.height will override this setting.
  7445. */
  7446. radius?: number;
  7447. /**
  7448. * (Gantt) Set the symbol of the connector end markers.
  7449. */
  7450. symbol?: string;
  7451. /**
  7452. * (Gantt) Vertical alignment of the markers relative to the points.
  7453. */
  7454. verticalAlign?: VerticalAlignValue;
  7455. /**
  7456. * (Gantt) Set the width of the connector markers. If not supplied, this is
  7457. * inferred from the marker radius.
  7458. */
  7459. width?: number;
  7460. }
  7461. /**
  7462. * (Gantt) Marker options for this chart's Pathfinder connectors. Note that this
  7463. * option is overridden by the `startMarker` and `endMarker` options.
  7464. */
  7465. export interface ConnectorsMarkerOptions {
  7466. /**
  7467. * (Gantt) Horizontal alignment of the markers relative to the points.
  7468. */
  7469. align?: AlignValue;
  7470. /**
  7471. * (Gantt) Set the color of the connector markers. By default this is the
  7472. * same as the connector color.
  7473. */
  7474. color?: (ColorString|GradientColorObject|PatternObject);
  7475. /**
  7476. * (Gantt) Enable markers for the connectors.
  7477. */
  7478. enabled?: boolean;
  7479. /**
  7480. * (Gantt) Set the height of the connector markers. If not supplied, this is
  7481. * inferred from the marker radius.
  7482. */
  7483. height?: number;
  7484. /**
  7485. * (Gantt) Whether or not to draw the markers inside the points.
  7486. */
  7487. inside?: boolean;
  7488. /**
  7489. * (Gantt) Set the line/border color of the connector markers. By default
  7490. * this is the same as the marker color.
  7491. */
  7492. lineColor?: ColorString;
  7493. /**
  7494. * (Gantt) Set the line/border width of the pathfinder markers.
  7495. */
  7496. lineWidth?: number;
  7497. /**
  7498. * (Gantt) Set the radius of the connector markers. The default is
  7499. * automatically computed based on the algorithmMargin setting.
  7500. *
  7501. * Setting marker.width and marker.height will override this setting.
  7502. */
  7503. radius?: number;
  7504. /**
  7505. * (Gantt) Vertical alignment of the markers relative to the points.
  7506. */
  7507. verticalAlign?: VerticalAlignValue;
  7508. /**
  7509. * (Gantt) Set the width of the connector markers. If not supplied, this is
  7510. * inferred from the marker radius.
  7511. */
  7512. width?: number;
  7513. }
  7514. /**
  7515. * (Gantt) The Pathfinder module allows you to define connections between any
  7516. * two points, represented as lines - optionally with markers for the start
  7517. * and/or end points. Multiple algorithms are available for calculating how the
  7518. * connecting lines are drawn.
  7519. *
  7520. * Connector functionality requires Highcharts Gantt to be loaded. In Gantt
  7521. * charts, the connectors are used to draw dependencies between tasks.
  7522. */
  7523. export interface ConnectorsOptions {
  7524. /**
  7525. * (Gantt) Set the default pathfinder margin to use, in pixels. Some
  7526. * Pathfinder algorithms attempt to avoid obstacles, such as other points in
  7527. * the chart. These algorithms use this margin to determine how close lines
  7528. * can be to an obstacle. The default is to compute this automatically from
  7529. * the size of the obstacles in the chart.
  7530. *
  7531. * To draw connecting lines close to existing points, set this to a low
  7532. * number. For more space around existing points, set this number higher.
  7533. */
  7534. algorithmMargin?: number;
  7535. /**
  7536. * (Gantt) Set the default dash style for this chart's connecting lines.
  7537. */
  7538. dashStyle?: string;
  7539. /**
  7540. * (Gantt) Enable connectors for this chart. Requires Highcharts Gantt.
  7541. */
  7542. enabled?: boolean;
  7543. /**
  7544. * (Gantt) Marker options specific to the end markers for this chart's
  7545. * Pathfinder connectors. Overrides the generic marker options.
  7546. */
  7547. endMarker?: ConnectorsEndMarkerOptions;
  7548. /**
  7549. * (Gantt) Set the default color for this chart's Pathfinder connecting
  7550. * lines. Defaults to the color of the point being connected.
  7551. */
  7552. lineColor?: ColorString;
  7553. /**
  7554. * (Gantt) Set the default pixel width for this chart's Pathfinder
  7555. * connecting lines.
  7556. */
  7557. lineWidth?: number;
  7558. /**
  7559. * (Gantt) Marker options for this chart's Pathfinder connectors. Note that
  7560. * this option is overridden by the `startMarker` and `endMarker` options.
  7561. */
  7562. marker?: ConnectorsMarkerOptions;
  7563. /**
  7564. * (Gantt) Marker options specific to the start markers for this chart's
  7565. * Pathfinder connectors. Overrides the generic marker options.
  7566. */
  7567. startMarker?: ConnectorsStartMarkerOptions;
  7568. /**
  7569. * (Gantt) Set the default pathfinder algorithm to use for this chart. It is
  7570. * possible to define your own algorithms by adding them to the
  7571. * Highcharts.Pathfinder.prototype.algorithms object before the chart has
  7572. * been created.
  7573. *
  7574. * The default algorithms are as follows:
  7575. *
  7576. * `straight`: Draws a straight line between the connecting points. Does not
  7577. * avoid other points when drawing.
  7578. *
  7579. * `simpleConnect`: Finds a path between the points using right angles only.
  7580. * Takes only starting/ending points into account, and will not avoid other
  7581. * points.
  7582. *
  7583. * `fastAvoid`: Finds a path between the points using right angles only.
  7584. * Will attempt to avoid other points, but its focus is performance over
  7585. * accuracy. Works well with less dense datasets.
  7586. *
  7587. * Default value: `straight` is used as default for most series types, while
  7588. * `simpleConnect` is used as default for Gantt series, to show dependencies
  7589. * between points.
  7590. */
  7591. type?: PathfinderTypeValue;
  7592. }
  7593. /**
  7594. * (Gantt) Marker options specific to the start markers for this chart's
  7595. * Pathfinder connectors. Overrides the generic marker options.
  7596. */
  7597. export interface ConnectorsStartMarkerOptions {
  7598. /**
  7599. * (Gantt) Horizontal alignment of the markers relative to the points.
  7600. */
  7601. align?: (string|AlignValue);
  7602. /**
  7603. * (Gantt) Set the color of the connector markers. By default this is the
  7604. * same as the connector color.
  7605. */
  7606. color?: (ColorString|GradientColorObject|PatternObject);
  7607. /**
  7608. * (Gantt) Enable markers for the connectors.
  7609. */
  7610. enabled?: boolean;
  7611. fill?: string;
  7612. /**
  7613. * (Gantt) Set the height of the connector markers. If not supplied, this is
  7614. * inferred from the marker radius.
  7615. */
  7616. height?: number;
  7617. /**
  7618. * (Gantt) Whether or not to draw the markers inside the points.
  7619. */
  7620. inside?: boolean;
  7621. /**
  7622. * (Gantt) Set the line/border color of the connector markers. By default
  7623. * this is the same as the marker color.
  7624. */
  7625. lineColor?: ColorString;
  7626. /**
  7627. * (Gantt) Set the line/border width of the pathfinder markers.
  7628. */
  7629. lineWidth?: number;
  7630. /**
  7631. * (Gantt) Set the radius of the connector markers. The default is
  7632. * automatically computed based on the algorithmMargin setting.
  7633. *
  7634. * Setting marker.width and marker.height will override this setting.
  7635. */
  7636. radius?: number;
  7637. /**
  7638. * (Gantt) Set the symbol of the connector start markers.
  7639. */
  7640. symbol?: string;
  7641. /**
  7642. * (Gantt) Vertical alignment of the markers relative to the points.
  7643. */
  7644. verticalAlign?: VerticalAlignValue;
  7645. /**
  7646. * (Gantt) Set the width of the connector markers. If not supplied, this is
  7647. * inferred from the marker radius.
  7648. */
  7649. width?: number;
  7650. }
  7651. /**
  7652. * (Highcharts, Highstock, Highmaps, Gantt) Highchart by default puts a credits
  7653. * label in the lower right corner of the chart. This can be changed using these
  7654. * options.
  7655. */
  7656. export interface CreditsOptions {
  7657. /**
  7658. * (Highcharts, Highstock, Highmaps, Gantt) Whether to show the credits
  7659. * text.
  7660. */
  7661. enabled?: boolean;
  7662. /**
  7663. * (Highcharts, Highstock, Highmaps, Gantt) The URL for the credits label.
  7664. */
  7665. href?: string;
  7666. /**
  7667. * (Highmaps) Credits for map source to be concatenated with conventional
  7668. * credit text. By default this is a format string that collects copyright
  7669. * information from the map if available.
  7670. */
  7671. mapText?: string;
  7672. /**
  7673. * (Highmaps) Detailed credits for map source to be displayed on hover of
  7674. * credits text. By default this is a format string that collects copyright
  7675. * information from the map if available.
  7676. */
  7677. mapTextFull?: string;
  7678. /**
  7679. * (Highcharts, Highstock, Highmaps, Gantt) Position configuration for the
  7680. * credits label.
  7681. */
  7682. position?: AlignObject;
  7683. /**
  7684. * (Highcharts, Highstock, Highmaps, Gantt) CSS styles for the credits
  7685. * label.
  7686. */
  7687. style?: CSSObject;
  7688. /**
  7689. * (Highcharts, Highstock, Highmaps, Gantt) The text for the credits label.
  7690. */
  7691. text?: string;
  7692. }
  7693. /**
  7694. * A style object with camel case property names to define visual appearance of
  7695. * a SVG element or HTML element. The properties can be whatever styles are
  7696. * supported on the given SVG or HTML element.
  7697. */
  7698. export interface CSSObject {
  7699. [key: string]: (boolean|number|string|undefined);
  7700. /**
  7701. * Background style for the element.
  7702. */
  7703. background?: string;
  7704. /**
  7705. * Background color of the element.
  7706. */
  7707. backgroundColor?: ColorString;
  7708. /**
  7709. * Border style for the element.
  7710. */
  7711. border?: string;
  7712. /**
  7713. * Radius of the element border.
  7714. */
  7715. borderRadius?: number;
  7716. /**
  7717. * Color used in the element. The 'contrast' option is a Highcharts custom
  7718. * property that results in black or white, depending on the background of
  7719. * the element.
  7720. */
  7721. color?: ('contrast'|ColorString);
  7722. /**
  7723. * Style of the mouse cursor when resting over the element.
  7724. */
  7725. cursor?: CursorValue;
  7726. /**
  7727. * Font family of the element text. Multiple values have to be in decreasing
  7728. * preference order and separated by comma.
  7729. */
  7730. fontFamily?: string;
  7731. /**
  7732. * Font size of the element text.
  7733. */
  7734. fontSize?: string;
  7735. /**
  7736. * Font weight of the element text.
  7737. */
  7738. fontWeight?: string;
  7739. /**
  7740. * Height of the element.
  7741. */
  7742. height?: number;
  7743. /**
  7744. * Width of the element border.
  7745. */
  7746. lineWidth?: number;
  7747. /**
  7748. * Opacity of the element.
  7749. */
  7750. opacity?: number;
  7751. /**
  7752. * Space around the element content.
  7753. */
  7754. padding?: string;
  7755. /**
  7756. * Behaviour of the element when the mouse cursor rests over it.
  7757. */
  7758. pointerEvents?: string;
  7759. /**
  7760. * Positioning of the element.
  7761. */
  7762. position?: string;
  7763. /**
  7764. * Alignment of the element text.
  7765. */
  7766. textAlign?: string;
  7767. /**
  7768. * Additional decoration of the element text.
  7769. */
  7770. textDecoration?: string;
  7771. /**
  7772. * Outline style of the element text.
  7773. */
  7774. textOutline?: string;
  7775. /**
  7776. * Line break style of the element text. Highcharts SVG elements support
  7777. * `ellipsis` when a `width` is set.
  7778. */
  7779. textOverflow?: string;
  7780. /**
  7781. * Top spacing of the element relative to the parent element.
  7782. */
  7783. top?: string;
  7784. /**
  7785. * Animated transition of selected element properties.
  7786. */
  7787. transition?: string;
  7788. /**
  7789. * Line break style of the element text.
  7790. */
  7791. whiteSpace?: string;
  7792. /**
  7793. * Width of the element.
  7794. */
  7795. width?: number;
  7796. }
  7797. export interface DataGroupingInfoObject {
  7798. length: number;
  7799. options?: SeriesOptionsType;
  7800. start: number;
  7801. }
  7802. /**
  7803. * (Highstock) A custom data grouping object for each button.
  7804. */
  7805. export interface DataGroupingOptionsObject {
  7806. /**
  7807. * (Highstock) The method of approximation inside a group. When for example
  7808. * 30 days are grouped into one month, this determines what value should
  7809. * represent the group. Possible values are "average", "averages", "open",
  7810. * "high", "low", "close" and "sum". For OHLC and candlestick series the
  7811. * approximation is "ohlc" by default, which finds the open, high, low and
  7812. * close values within all the grouped data. For ranges, the approximation
  7813. * is "range", which finds the low and high values. For multi-dimensional
  7814. * data, like ranges and OHLC, "averages" will compute the average for each
  7815. * dimension.
  7816. *
  7817. * Custom aggregate methods can be added by assigning a callback function as
  7818. * the approximation. This function takes a numeric array as the argument
  7819. * and should return a single numeric value or `null`. Note that the numeric
  7820. * array will never contain null values, only true numbers. Instead, if null
  7821. * values are present in the raw data, the numeric array will have an
  7822. * `.hasNulls` property set to `true`. For single-value data sets the data
  7823. * is available in the first argument of the callback function. For OHLC
  7824. * data sets, all the open values are in the first argument, all high values
  7825. * in the second etc.
  7826. *
  7827. * Since v4.2.7, grouping meta data is available in the approximation
  7828. * callback from `this.dataGroupInfo`. It can be used to extract information
  7829. * from the raw data.
  7830. *
  7831. * Defaults to `average` for line-type series, `sum` for columns, `range`
  7832. * for range series and `ohlc` for OHLC and candlestick.
  7833. */
  7834. approximation?: (string|DataGroupingApproximationValue|Function);
  7835. /**
  7836. * (Highstock) Datetime formats for the header of the tooltip in a stock
  7837. * chart. The format can vary within a chart depending on the currently
  7838. * selected time range and the current data grouping.
  7839. *
  7840. * The default formats are: (see online documentation for example)
  7841. *
  7842. * For each of these array definitions, the first item is the format used
  7843. * when the active time span is one unit. For instance, if the current data
  7844. * applies to one week, the first item of the week array is used. The second
  7845. * and third items are used when the active time span is more than two
  7846. * units. For instance, if the current data applies to two weeks, the second
  7847. * and third item of the week array are used, and applied to the start and
  7848. * end date of the time span.
  7849. */
  7850. dateTimeLabelFormats?: object;
  7851. /**
  7852. * (Highstock) Enable or disable data grouping.
  7853. */
  7854. enabled?: boolean;
  7855. /**
  7856. * (Highstock) When data grouping is forced, it runs no matter how small the
  7857. * intervals are. This can be handy for example when the sum should be
  7858. * calculated for values appearing at random times within each hour.
  7859. */
  7860. forced?: boolean;
  7861. /**
  7862. * (Highstock) By default only points within the visible range are grouped.
  7863. * Enabling this option will force data grouping to calculate all grouped
  7864. * points for a given dataset. That option prevents for example a column
  7865. * series from calculating a grouped point partially. The effect is similar
  7866. * to Series.getExtremesFromAll but does not affect yAxis extremes.
  7867. */
  7868. groupAll?: boolean;
  7869. /**
  7870. * (Highstock) The approximate pixel width of each group. If for example a
  7871. * series with 30 points is displayed over a 600 pixel wide plot area, no
  7872. * grouping is performed. If however the series contains so many points that
  7873. * the spacing is less than the groupPixelWidth, Highcharts will try to
  7874. * group it into appropriate groups so that each is more or less two pixels
  7875. * wide. If multiple series with different group pixel widths are drawn on
  7876. * the same x axis, all series will take the greatest width. For example,
  7877. * line series have 2px default group width, while column series have 10px.
  7878. * If combined, both the line and the column will have 10px by default.
  7879. */
  7880. groupPixelWidth?: number;
  7881. /**
  7882. * (Highstock) Normally, a group is indexed by the start of that group, so
  7883. * for example when 30 daily values are grouped into one month, that month's
  7884. * x value will be the 1st of the month. This apparently shifts the data to
  7885. * the left. When the smoothed option is true, this is compensated for. The
  7886. * data is shifted to the middle of the group, and min and max values are
  7887. * preserved. Internally, this is used in the Navigator series.
  7888. */
  7889. smoothed?: boolean;
  7890. /**
  7891. * (Highstock) An array determining what time intervals the data is allowed
  7892. * to be grouped to. Each array item is an array where the first value is
  7893. * the time unit and the second value another array of allowed multiples.
  7894. *
  7895. * Defaults to: (see online documentation for example)
  7896. */
  7897. units?: Array<[string, (Array<number>|null)]>;
  7898. }
  7899. /**
  7900. * (Highcharts, Highstock, Gantt) A declarative filter to control of which data
  7901. * labels to display. The declarative filter is designed for use when callback
  7902. * functions are not available, like when the chart options require a pure JSON
  7903. * structure or for use with graphical editors. For programmatic control, use
  7904. * the `formatter` instead, and return `undefined` to disable a single data
  7905. * label.
  7906. */
  7907. export interface DataLabelsFilterOptionsObject {
  7908. /**
  7909. * (Highcharts, Highstock, Gantt) The operator to compare by. Can be one of
  7910. * `>`, `<`, `>=`, `<=`, `==`, and `===`.
  7911. */
  7912. operator?: OptionsOperatorValue;
  7913. /**
  7914. * (Highcharts, Highstock, Gantt) The point property to filter by. Point
  7915. * options are passed directly to properties, additionally there are `y`
  7916. * value, `percentage` and others listed under Highcharts.Point members.
  7917. */
  7918. property?: string;
  7919. /**
  7920. * (Highcharts, Highstock, Gantt) The value to compare against.
  7921. */
  7922. value?: number;
  7923. }
  7924. /**
  7925. * (Highcharts, Highstock, Gantt) Individual data label for each point. The
  7926. * options are the same as the ones for plotOptions.series.dataLabels.
  7927. */
  7928. export interface DataLabelsOptions {
  7929. /**
  7930. * (Highcharts, Highstock, Gantt) The alignment of the data label compared
  7931. * to the point. If `right`, the right side of the label should be touching
  7932. * the point. For points with an extent, like columns, the alignments also
  7933. * dictates how to align it inside the box, as given with the inside option.
  7934. * Can be one of `left`, `center` or `right`.
  7935. */
  7936. align?: (AlignValue|null);
  7937. /**
  7938. * (Highcharts, Highstock, Gantt) Whether to allow data labels to overlap.
  7939. * To make the labels less sensitive for overlapping, the dataLabels.padding
  7940. * can be set to 0.
  7941. */
  7942. allowOverlap?: boolean;
  7943. /**
  7944. * (Highcharts, Highstock, Gantt) Enable or disable the initial animation
  7945. * when a series is displayed for the `dataLabels`. The animation can also
  7946. * be set as a configuration object. Please note that this option only
  7947. * applies to the initial animation. For other animations, see
  7948. * chart.animation and the animation parameter under the API methods. The
  7949. * following properties are supported:
  7950. *
  7951. * - `defer`: The animation delay time in milliseconds.
  7952. */
  7953. animation?: (boolean|SeriesAreaDataDataLabelsAnimationOptions|SeriesArearangeDataDataLabelsAnimationOptions|SeriesAreasplineDataDataLabelsAnimationOptions|
  7954. SeriesAreasplinerangeDataDataLabelsAnimationOptions|SeriesBarDataDataLabelsAnimationOptions|SeriesBoxplotDataDataLabelsAnimationOptions|SeriesBubbleDataDataLabelsAnimationOptions|
  7955. SeriesBulletDataDataLabelsAnimationOptions|SeriesCandlestickDataDataLabelsAnimationOptions|SeriesColumnDataDataLabelsAnimationOptions|SeriesColumnpyramidDataDataLabelsAnimationOptions|
  7956. SeriesColumnrangeDataDataLabelsAnimationOptions|SeriesCylinderDataDataLabelsAnimationOptions|SeriesDumbbellDataDataLabelsAnimationOptions|SeriesFunnelDataDataLabelsAnimationOptions|
  7957. SeriesGaugeDataDataLabelsAnimationOptions|SeriesHeatmapDataDataLabelsAnimationOptions|SeriesItemDataDataLabelsAnimationOptions|SeriesLineDataDataLabelsAnimationOptions|
  7958. SeriesLollipopDataDataLabelsAnimationOptions|SeriesNetworkgraphDataDataLabelsAnimationOptions|SeriesOhlcDataDataLabelsAnimationOptions|SeriesOrganizationDataDataLabelsAnimationOptions|
  7959. SeriesPackedbubbleDataDataLabelsAnimationOptions|SeriesParetoDataDataLabelsAnimationOptions|SeriesPieDataDataLabelsAnimationOptions|SeriesPolygonDataDataLabelsAnimationOptions|
  7960. SeriesPyramidDataDataLabelsAnimationOptions|SeriesSankeyDataDataLabelsAnimationOptions|SeriesScatter3dDataDataLabelsAnimationOptions|SeriesScatterDataDataLabelsAnimationOptions|
  7961. SeriesSolidgaugeDataDataLabelsAnimationOptions|SeriesSplineDataDataLabelsAnimationOptions|SeriesStreamgraphDataDataLabelsAnimationOptions|SeriesSunburstDataDataLabelsAnimationOptions|
  7962. SeriesTilemapDataDataLabelsAnimationOptions|SeriesTimelineDataDataLabelsAnimationOptions|SeriesTreemapDataDataLabelsAnimationOptions|SeriesVariablepieDataDataLabelsAnimationOptions|
  7963. SeriesVariwideDataDataLabelsAnimationOptions|SeriesVectorDataDataLabelsAnimationOptions|SeriesVennDataDataLabelsAnimationOptions|SeriesWaterfallDataDataLabelsAnimationOptions|
  7964. SeriesWindbarbDataDataLabelsAnimationOptions|SeriesWordcloudDataDataLabelsAnimationOptions|SeriesXrangeDataDataLabelsAnimationOptions|Partial<AnimationOptionsObject>);
  7965. /**
  7966. * (Highcharts, Highstock, Gantt) The background color or gradient for the
  7967. * data label.
  7968. */
  7969. backgroundColor?: (ColorString|GradientColorObject|PatternObject);
  7970. /**
  7971. * (Highcharts, Highstock, Gantt) The border color for the data label.
  7972. * Defaults to `undefined`.
  7973. */
  7974. borderColor?: (ColorString|GradientColorObject|PatternObject);
  7975. /**
  7976. * (Highcharts, Highstock, Gantt) The border radius in pixels for the data
  7977. * label.
  7978. */
  7979. borderRadius?: number;
  7980. /**
  7981. * (Highcharts, Highstock, Gantt) The border width in pixels for the data
  7982. * label.
  7983. */
  7984. borderWidth?: number;
  7985. /**
  7986. * (Highcharts, Highstock, Gantt) A class name for the data label.
  7987. * Particularly in styled mode, this can be used to give each series' or
  7988. * point's data label unique styling. In addition to this option, a default
  7989. * color class name is added so that we can give the labels a contrast text
  7990. * shadow.
  7991. */
  7992. className?: string;
  7993. /**
  7994. * (Highcharts, Highstock, Gantt) The text color for the data labels.
  7995. * Defaults to `undefined`. For certain series types, like column or map,
  7996. * the data labels can be drawn inside the points. In this case the data
  7997. * label will be drawn with maximum contrast by default. Additionally, it
  7998. * will be given a `text-outline` style with the opposite color, to further
  7999. * increase the contrast. This can be overridden by setting the
  8000. * `text-outline` style to `none` in the `dataLabels.style` option.
  8001. */
  8002. color?: (ColorString|GradientColorObject|PatternObject);
  8003. /**
  8004. * (Highcharts, Highstock, Gantt) Whether to hide data labels that are
  8005. * outside the plot area. By default, the data label is moved inside the
  8006. * plot area according to the overflow option.
  8007. */
  8008. crop?: boolean;
  8009. /**
  8010. * (Highcharts, Highstock, Gantt) Whether to defer displaying the data
  8011. * labels until the initial series animation has finished. Setting to
  8012. * `false` renders the data label immediately. If set to `true` inherits the
  8013. * defer time set in plotOptions.series.animation.
  8014. */
  8015. defer?: boolean;
  8016. /**
  8017. * (Highcharts, Highstock, Gantt) Enable or disable the data labels.
  8018. */
  8019. enabled?: boolean;
  8020. /**
  8021. * (Highcharts, Highstock, Gantt) A declarative filter to control of which
  8022. * data labels to display. The declarative filter is designed for use when
  8023. * callback functions are not available, like when the chart options require
  8024. * a pure JSON structure or for use with graphical editors. For programmatic
  8025. * control, use the `formatter` instead, and return `undefined` to disable a
  8026. * single data label.
  8027. */
  8028. filter?: DataLabelsFilterOptionsObject;
  8029. /**
  8030. * (Highcharts, Highstock, Gantt) A format string for the data label.
  8031. * Available variables are the same as for `formatter`.
  8032. */
  8033. format?: string;
  8034. /**
  8035. * (Highcharts, Highstock, Gantt) Callback JavaScript function to format the
  8036. * data label. Note that if a `format` is defined, the format takes
  8037. * precedence and the formatter is ignored.
  8038. */
  8039. formatter?: DataLabelsFormatterCallbackFunction;
  8040. /**
  8041. * (Highcharts, Highstock, Gantt) For points with an extent, like columns or
  8042. * map areas, whether to align the data label inside the box or to the
  8043. * actual value point. Defaults to `false` in most cases, `true` in stacked
  8044. * columns.
  8045. */
  8046. inside?: boolean;
  8047. /**
  8048. * (Highcharts, Highstock, Gantt) Format for points with the value of null.
  8049. * Works analogously to format. `nullFormat` can be applied only to series
  8050. * which support displaying null points.
  8051. */
  8052. nullFormat?: (boolean|string);
  8053. /**
  8054. * (Highcharts, Highstock, Gantt) Callback JavaScript function that defines
  8055. * formatting for points with the value of null. Works analogously to
  8056. * formatter. `nullPointFormatter` can be applied only to series which
  8057. * support displaying null points.
  8058. */
  8059. nullFormatter?: DataLabelsFormatterCallbackFunction;
  8060. /**
  8061. * (Highcharts, Highstock, Gantt) How to handle data labels that flow
  8062. * outside the plot area. The default is `"justify"`, which aligns them
  8063. * inside the plot area. For columns and bars, this means it will be moved
  8064. * inside the bar. To display data labels outside the plot area, set `crop`
  8065. * to `false` and `overflow` to `"allow"`.
  8066. */
  8067. overflow?: DataLabelsOverflowValue;
  8068. /**
  8069. * (Highcharts, Highstock, Gantt) When either the `borderWidth` or the
  8070. * `backgroundColor` is set, this is the padding within the box.
  8071. */
  8072. padding?: number;
  8073. /**
  8074. * (Highcharts, Highstock, Gantt) Aligns data labels relative to points. If
  8075. * `center` alignment is not possible, it defaults to `right`.
  8076. */
  8077. position?: AlignValue;
  8078. /**
  8079. * (Highcharts, Highstock, Gantt) Text rotation in degrees. Note that due to
  8080. * a more complex structure, backgrounds, borders and padding will be lost
  8081. * on a rotated data label.
  8082. */
  8083. rotation?: number;
  8084. /**
  8085. * (Highcharts, Highstock, Gantt) The shadow of the box. Works best with
  8086. * `borderWidth` or `backgroundColor`. Since 2.3 the shadow can be an object
  8087. * configuration containing `color`, `offsetX`, `offsetY`, `opacity` and
  8088. * `width`.
  8089. */
  8090. shadow?: (boolean|ShadowOptionsObject);
  8091. /**
  8092. * (Highcharts, Highstock, Gantt) The name of a symbol to use for the border
  8093. * around the label. Symbols are predefined functions on the Renderer
  8094. * object.
  8095. */
  8096. shape?: string;
  8097. /**
  8098. * (Highcharts, Highstock, Gantt) Styles for the label. The default `color`
  8099. * setting is `"contrast"`, which is a pseudo color that Highcharts picks up
  8100. * and applies the maximum contrast to the underlying point item, for
  8101. * example the bar in a bar chart.
  8102. *
  8103. * The `textOutline` is a pseudo property that applies an outline of the
  8104. * given width with the given color, which by default is the maximum
  8105. * contrast to the text. So a bright text color will result in a black text
  8106. * outline for maximum readability on a mixed background. In some cases,
  8107. * especially with grayscale text, the text outline doesn't work well, in
  8108. * which cases it can be disabled by setting it to `"none"`. When `useHTML`
  8109. * is true, the `textOutline` will not be picked up. In this, case, the same
  8110. * effect can be acheived through the `text-shadow` CSS property.
  8111. *
  8112. * For some series types, where each point has an extent, like for example
  8113. * tree maps, the data label may overflow the point. There are two
  8114. * strategies for handling overflow. By default, the text will wrap to
  8115. * multiple lines. The other strategy is to set `style.textOverflow` to
  8116. * `ellipsis`, which will keep the text on one line plus it will break
  8117. * inside long words.
  8118. */
  8119. style?: CSSObject;
  8120. /**
  8121. * (Highcharts, Highstock, Gantt) Options for a label text which should
  8122. * follow marker's shape. Border and background are disabled for a label
  8123. * that follows a path.
  8124. *
  8125. * **Note:** Only SVG-based renderer supports this option. Setting `useHTML`
  8126. * to true will disable this option.
  8127. */
  8128. textPath?: DataLabelsTextPathOptionsObject;
  8129. /**
  8130. * (Highcharts, Highstock, Gantt) Whether to use HTML to render the labels.
  8131. */
  8132. useHTML?: boolean;
  8133. /**
  8134. * (Highcharts, Highstock, Gantt) The vertical alignment of a data label.
  8135. * Can be one of `top`, `middle` or `bottom`. The default value depends on
  8136. * the data, for instance in a column chart, the label is above positive
  8137. * values and below negative values.
  8138. */
  8139. verticalAlign?: (VerticalAlignValue|null);
  8140. /**
  8141. * (Highcharts, Highstock, Gantt) The x position offset of the label
  8142. * relative to the point in pixels.
  8143. */
  8144. x?: number;
  8145. /**
  8146. * (Highcharts, Highstock) X offset of the higher data labels relative to
  8147. * the point value.
  8148. */
  8149. xHigh?: number;
  8150. /**
  8151. * (Highcharts, Highstock) X offset of the lower data labels relative to the
  8152. * point value.
  8153. */
  8154. xLow?: number;
  8155. /**
  8156. * (Highcharts, Highstock, Gantt) The y position offset of the label
  8157. * relative to the point in pixels.
  8158. */
  8159. y?: number;
  8160. /**
  8161. * (Highcharts, Highstock) Y offset of the higher data labels relative to
  8162. * the point value.
  8163. */
  8164. yHigh?: number;
  8165. /**
  8166. * (Highcharts, Highstock) Y offset of the lower data labels relative to the
  8167. * point value.
  8168. */
  8169. yLow?: number;
  8170. /**
  8171. * (Highcharts, Highstock, Gantt) The Z index of the data labels. The
  8172. * default Z index puts it above the series. Use a Z index of 2 to display
  8173. * it behind the series.
  8174. */
  8175. z?: number;
  8176. }
  8177. /**
  8178. * (Highcharts, Highstock, Gantt) Options for a label text which should follow
  8179. * marker's shape. Border and background are disabled for a label that follows a
  8180. * path.
  8181. *
  8182. * **Note:** Only SVG-based renderer supports this option. Setting `useHTML` to
  8183. * true will disable this option.
  8184. */
  8185. export interface DataLabelsTextPathOptionsObject {
  8186. /**
  8187. * (Highcharts, Highstock, Gantt) Presentation attributes for the text path.
  8188. */
  8189. attributes?: SVGAttributes;
  8190. /**
  8191. * (Highcharts, Highstock, Gantt) Enable or disable `textPath` option for
  8192. * link's or marker's data labels.
  8193. */
  8194. enabled?: boolean;
  8195. }
  8196. /**
  8197. * (Highcharts, Highstock, Highmaps, Gantt) The Data module provides a
  8198. * simplified interface for adding data to a chart from sources like CVS, HTML
  8199. * tables or grid views. See also the tutorial article on the Data module.
  8200. *
  8201. * It requires the `modules/data.js` file to be loaded.
  8202. *
  8203. * Please note that the default way of adding data in Highcharts, without the
  8204. * need of a module, is through the series._type_.data option.
  8205. */
  8206. export interface DataOptions {
  8207. /**
  8208. * (Highcharts, Highstock, Highmaps, Gantt) A callback function to modify
  8209. * the CSV before parsing it. Return the modified string.
  8210. */
  8211. beforeParse?: DataBeforeParseCallbackFunction;
  8212. /**
  8213. * (Highcharts, Highstock, Highmaps, Gantt) A two-dimensional array
  8214. * representing the input data on tabular form. This input can be used when
  8215. * the data is already parsed, for example from a grid view component. Each
  8216. * cell can be a string or number. If not switchRowsAndColumns is set, the
  8217. * columns are interpreted as series.
  8218. */
  8219. columns?: Array<Array<DataValueType>>;
  8220. /**
  8221. * (Highcharts, Highstock, Highmaps, Gantt) A URL to a remote JSON dataset,
  8222. * structured as a column array. Will be fetched when the chart is created
  8223. * using Ajax.
  8224. */
  8225. columnsURL?: string;
  8226. /**
  8227. * (Highcharts, Highstock, Highmaps, Gantt) The callback that is evaluated
  8228. * when the data is finished loading, optionally from an external source,
  8229. * and parsed. The first argument passed is a finished chart options object,
  8230. * containing the series. These options can be extended with additional
  8231. * options and passed directly to the chart constructor.
  8232. */
  8233. complete?: DataCompleteCallbackFunction;
  8234. /**
  8235. * (Highcharts, Highstock, Highmaps, Gantt) A comma delimited string to be
  8236. * parsed. Related options are startRow, endRow, startColumn and endColumn
  8237. * to delimit what part of the table is used. The lineDelimiter and
  8238. * itemDelimiter options define the CSV delimiter formats.
  8239. *
  8240. * The built-in CSV parser doesn't support all flavours of CSV, so in some
  8241. * cases it may be necessary to use an external CSV parser. See this example
  8242. * of parsing CSV through the MIT licensed Papa Parse library.
  8243. */
  8244. csv?: string;
  8245. /**
  8246. * (Highcharts, Highstock, Highmaps, Gantt) An URL to a remote CSV dataset.
  8247. * Will be fetched when the chart is created using Ajax.
  8248. */
  8249. csvURL?: string;
  8250. /**
  8251. * (Highcharts, Highstock, Highmaps, Gantt) Sets the refresh rate for data
  8252. * polling when importing remote dataset by setting data.csvURL,
  8253. * data.rowsURL, data.columnsURL, or data.googleSpreadsheetKey.
  8254. *
  8255. * Note that polling must be enabled by setting data.enablePolling to true.
  8256. *
  8257. * The value is the number of seconds between pollings. It cannot be set to
  8258. * less than 1 second.
  8259. */
  8260. dataRefreshRate?: number;
  8261. /**
  8262. * (Highcharts, Highstock, Highmaps, Gantt) Which of the predefined date
  8263. * formats in Date.prototype.dateFormats to use to parse date values.
  8264. * Defaults to a best guess based on what format gives valid and ordered
  8265. * dates. Valid options include: `YYYY/mm/dd`, `dd/mm/YYYY`, `mm/dd/YYYY`,
  8266. * `dd/mm/YY`, `mm/dd/YY`.
  8267. */
  8268. dateFormat?: OptionsDateFormatValue;
  8269. /**
  8270. * (Highcharts, Highstock, Highmaps, Gantt) The decimal point used for
  8271. * parsing numbers in the CSV.
  8272. *
  8273. * If both this and data.delimiter is set to `undefined`, the parser will
  8274. * attempt to deduce the decimal point automatically.
  8275. */
  8276. decimalPoint?: string;
  8277. /**
  8278. * (Highcharts, Highstock, Highmaps, Gantt) Enables automatic refetching of
  8279. * remote datasets every _n_ seconds (defined by setting
  8280. * data.dataRefreshRate).
  8281. *
  8282. * Only works when either data.csvURL, data.rowsURL, data.columnsURL, or
  8283. * data.googleSpreadsheetKey.
  8284. */
  8285. enablePolling?: boolean;
  8286. /**
  8287. * (Highcharts, Highstock, Highmaps, Gantt) In tabular input data, the last
  8288. * column (indexed by 0) to use. Defaults to the last column containing
  8289. * data.
  8290. */
  8291. endColumn?: number;
  8292. /**
  8293. * (Highcharts, Highstock, Highmaps, Gantt) In tabular input data, the last
  8294. * row (indexed by 0) to use. Defaults to the last row containing data.
  8295. */
  8296. endRow?: number;
  8297. /**
  8298. * (Highcharts, Highstock, Gantt) Whether to use the first row in the data
  8299. * set as series names.
  8300. */
  8301. firstRowAsNames?: boolean;
  8302. /**
  8303. * (Highcharts, Highstock, Highmaps, Gantt) The key for a Google Spreadsheet
  8304. * to load. See general information on GS.
  8305. */
  8306. googleSpreadsheetKey?: string;
  8307. /**
  8308. * (Highcharts, Highstock, Highmaps, Gantt) The Google Spreadsheet worksheet
  8309. * to use in combination with googleSpreadsheetKey. The available id's from
  8310. * your sheet can be read from
  8311. * `https://spreadsheets.google.com/feeds/worksheets/{key}/public/basic`.
  8312. */
  8313. googleSpreadsheetWorksheet?: string;
  8314. /**
  8315. * (Highcharts, Highstock, Highmaps, Gantt) Item or cell delimiter for
  8316. * parsing CSV. Defaults to the tab character `\t` if a tab character is
  8317. * found in the CSV string, if not it defaults to `,`.
  8318. *
  8319. * If this is set to false or undefined, the parser will attempt to deduce
  8320. * the delimiter automatically.
  8321. */
  8322. itemDelimiter?: string;
  8323. /**
  8324. * (Highcharts, Highstock, Highmaps, Gantt) Line delimiter for parsing CSV.
  8325. */
  8326. lineDelimiter?: string;
  8327. /**
  8328. * (Highcharts, Highstock, Highmaps, Gantt) A callback function to access
  8329. * the parsed columns, the two-dimentional input data array directly, before
  8330. * they are interpreted into series data and categories. Return `false` to
  8331. * stop completion, or call `this.complete()` to continue async.
  8332. */
  8333. parsed?: DataParsedCallbackFunction;
  8334. /**
  8335. * (Highcharts, Highstock, Highmaps, Gantt) A callback function to parse
  8336. * string representations of dates into JavaScript timestamps. Should return
  8337. * an integer timestamp on success.
  8338. */
  8339. parseDate?: DataParseDateCallbackFunction;
  8340. /**
  8341. * (Highcharts, Highstock, Highmaps, Gantt) The same as the columns input
  8342. * option, but defining rows intead of columns.
  8343. */
  8344. rows?: Array<Array<DataValueType>>;
  8345. /**
  8346. * (Highcharts, Highstock, Highmaps, Gantt) A URL to a remote JSON dataset,
  8347. * structured as a row array. Will be fetched when the chart is created
  8348. * using Ajax.
  8349. */
  8350. rowsURL?: string;
  8351. /**
  8352. * (Highcharts, Highstock, Highmaps, Gantt) An array containing dictionaries
  8353. * for each series. A dictionary exists of Point property names as the key
  8354. * and the CSV column index as the value.
  8355. */
  8356. seriesMapping?: Array<Dictionary<number>>;
  8357. /**
  8358. * (Highcharts, Highstock, Highmaps, Gantt) In tabular input data, the first
  8359. * column (indexed by 0) to use.
  8360. */
  8361. startColumn?: number;
  8362. /**
  8363. * (Highcharts, Highstock, Highmaps, Gantt) In tabular input data, the first
  8364. * row (indexed by 0) to use.
  8365. */
  8366. startRow?: number;
  8367. /**
  8368. * (Highcharts, Highstock, Highmaps, Gantt) Switch rows and columns of the
  8369. * input data, so that `this.columns` effectively becomes the rows of the
  8370. * data set, and the rows are interpreted as series.
  8371. */
  8372. switchRowsAndColumns?: boolean;
  8373. /**
  8374. * (Highcharts, Highstock, Highmaps, Gantt) An HTML table or the id of such
  8375. * to be parsed as input data. Related options are `startRow`, `endRow`,
  8376. * `startColumn` and `endColumn` to delimit what part of the table is used.
  8377. */
  8378. table?: (string|HTMLElement);
  8379. }
  8380. /**
  8381. * Options for `dataSorting`.
  8382. */
  8383. export interface DataSortingOptionsObject {
  8384. /**
  8385. * Enable or disable data sorting for the series.
  8386. */
  8387. enabled?: boolean;
  8388. /**
  8389. * Whether to allow matching points by name in an update.
  8390. */
  8391. matchByName?: boolean;
  8392. /**
  8393. * Determines what data value should be used to sort by.
  8394. */
  8395. sortKey?: string;
  8396. }
  8397. export interface DefsArrowAttributesOptions {
  8398. display?: string;
  8399. id?: string;
  8400. markerHeight?: number;
  8401. markerWidth?: number;
  8402. refX?: number;
  8403. refY?: number;
  8404. }
  8405. export interface DefsArrowOptions {
  8406. attributes?: DefsArrowAttributesOptions;
  8407. children?: Array<DefsOptions>;
  8408. tagName?: string;
  8409. }
  8410. /**
  8411. * (Highcharts, Highstock, Highmaps, Gantt) Options for configuring markers for
  8412. * annotations.
  8413. *
  8414. * An example of the arrow marker: (see online documentation for example)
  8415. */
  8416. export interface DefsOptions {
  8417. arrow?: (ASTNode|DefsArrowOptions);
  8418. "reverse-arrow"?: (ASTNode|DefsReverseArrowOptions);
  8419. }
  8420. export interface DefsReverseArrowAttributesOptions {
  8421. display?: string;
  8422. id?: string;
  8423. markerHeight?: number;
  8424. markerWidth?: number;
  8425. refX?: number;
  8426. refY?: number;
  8427. }
  8428. export interface DefsReverseArrowOptions {
  8429. attributes?: DefsReverseArrowAttributesOptions;
  8430. tagName?: string;
  8431. }
  8432. /**
  8433. * Generic dictionary in TypeScript notation. Use the native `Record<string,
  8434. * any>` instead.
  8435. */
  8436. export interface Dictionary<T> {
  8437. [key: string]: T;
  8438. }
  8439. /**
  8440. * (Highcharts, Highstock, Gantt) Style options for the guide box default state.
  8441. */
  8442. export interface DragDropGuideBoxOptionsObject {
  8443. /**
  8444. * (Highcharts, Highstock, Gantt) CSS class name of the guide box in this
  8445. * state. Defaults to `highcharts-drag-box-default`.
  8446. */
  8447. className?: string;
  8448. /**
  8449. * (Highcharts, Highstock, Gantt) Guide box fill color.
  8450. */
  8451. color?: (ColorString|GradientColorObject|PatternObject);
  8452. /**
  8453. * (Highcharts, Highstock, Gantt) Guide box cursor.
  8454. */
  8455. cursor?: string;
  8456. /**
  8457. * (Highcharts, Highstock, Gantt) Color of the border around the guide box.
  8458. */
  8459. lineColor?: ColorString;
  8460. /**
  8461. * (Highcharts, Highstock, Gantt) Width of the line around the guide box.
  8462. */
  8463. lineWidth?: number;
  8464. /**
  8465. * (Highcharts, Highstock, Gantt) Guide box zIndex.
  8466. */
  8467. zIndex?: number;
  8468. }
  8469. /**
  8470. * (Highcharts, Highstock, Gantt) Options for the drag handles.
  8471. */
  8472. export interface DragDropHandleOptionsObject {
  8473. /**
  8474. * (Highcharts, Highstock, Gantt) The class name of the drag handles.
  8475. * Defaults to `highcharts-drag-handle`.
  8476. */
  8477. className?: string;
  8478. /**
  8479. * (Highcharts, Highstock, Gantt) The fill color of the drag handles.
  8480. */
  8481. color?: (ColorString|GradientColorObject|PatternObject);
  8482. /**
  8483. * (Highcharts, Highstock, Gantt) The mouse cursor to use for the drag
  8484. * handles. By default this is intelligently switching between `ew-resize`
  8485. * and `ns-resize` depending on the direction the point is being dragged.
  8486. */
  8487. cursor?: string;
  8488. /**
  8489. * (Highcharts, Highstock, Gantt) The line color of the drag handles.
  8490. */
  8491. lineColor?: ColorString;
  8492. /**
  8493. * (Highcharts, Highstock, Gantt) The line width for the drag handles.
  8494. */
  8495. lineWidth?: number;
  8496. /**
  8497. * (Highcharts, Highstock, Gantt) Function to define the SVG path to use for
  8498. * the drag handles. Takes the point as argument. Should return an SVG path
  8499. * in array format. The SVG path is automatically positioned on the point.
  8500. */
  8501. pathFormatter?: Function;
  8502. /**
  8503. * (Highcharts, Highstock, Gantt) The z index for the drag handles.
  8504. */
  8505. zIndex?: number;
  8506. }
  8507. /**
  8508. * Current drag and drop position.
  8509. */
  8510. export interface DragDropPositionObject {
  8511. /**
  8512. * Chart x position
  8513. */
  8514. chartX: number;
  8515. /**
  8516. * Chart y position
  8517. */
  8518. chartY: number;
  8519. /**
  8520. * Drag and drop guide box.
  8521. */
  8522. guideBox?: BBoxObject;
  8523. /**
  8524. * Updated point data.
  8525. */
  8526. points: Dictionary<Dictionary<number>>;
  8527. /**
  8528. * Delta of previous x position.
  8529. */
  8530. prevdX?: number;
  8531. /**
  8532. * Delta of previous y position.
  8533. */
  8534. prevdY?: number;
  8535. }
  8536. /**
  8537. * (Highcharts, Highmaps) Additional styles to apply to the data label of a
  8538. * point that has drilldown data. By default it is underlined and blue to invite
  8539. * to interaction.
  8540. *
  8541. * In styled mode, active data label styles can be applied with the
  8542. * `.highcharts-drilldown-data-label` class.
  8543. */
  8544. export interface DrilldownActiveDataLabelStyleOptions {
  8545. color?: string;
  8546. cursor?: string;
  8547. fontWeight?: string;
  8548. textDecoration?: string;
  8549. }
  8550. /**
  8551. * (Highcharts, Highmaps) Options for the drill up button that appears when
  8552. * drilling down on a series. The text for the button is defined in
  8553. * lang.drillUpText.
  8554. */
  8555. export interface DrilldownDrillUpButtonOptions {
  8556. /**
  8557. * (Highcharts, Highmaps) Positioning options for the button within the
  8558. * `relativeTo` box. Available properties are `x`, `y`, `align` and
  8559. * `verticalAlign`.
  8560. */
  8561. position?: (AlignObject|DrilldownDrillUpButtonPositionOptions);
  8562. /**
  8563. * (Highcharts, Highmaps) What box to align the button to. Can be either
  8564. * `plotBox` or `spacingBox`.
  8565. */
  8566. relativeTo?: ButtonRelativeToValue;
  8567. /**
  8568. * (Highcharts, Highmaps) A collection of attributes for the button. The
  8569. * object takes SVG attributes like `fill`, `stroke`, `stroke-width` or `r`,
  8570. * the border radius. The theme also supports `style`, a collection of CSS
  8571. * properties for the text. Equivalent attributes for the hover state are
  8572. * given in `theme.states.hover`.
  8573. *
  8574. * In styled mode, drill-up button styles can be applied with the
  8575. * `.highcharts-drillup-button` class.
  8576. */
  8577. theme?: object;
  8578. }
  8579. /**
  8580. * (Highcharts, Highmaps) Positioning options for the button within the
  8581. * `relativeTo` box. Available properties are `x`, `y`, `align` and
  8582. * `verticalAlign`.
  8583. */
  8584. export interface DrilldownDrillUpButtonPositionOptions {
  8585. /**
  8586. * (Highcharts, Highmaps) Horizontal alignment.
  8587. */
  8588. align?: AlignValue;
  8589. /**
  8590. * (Highcharts, Highmaps) Vertical alignment of the button.
  8591. */
  8592. verticalAlign?: VerticalAlignValue;
  8593. /**
  8594. * (Highcharts, Highmaps) The X offset of the button.
  8595. */
  8596. x?: number;
  8597. /**
  8598. * (Highcharts, Highmaps) The Y offset of the button.
  8599. */
  8600. y?: number;
  8601. }
  8602. /**
  8603. * The event arguments when a drilldown point is clicked.
  8604. */
  8605. export interface DrilldownEventObject {
  8606. /**
  8607. * If a category label was clicked, which index.
  8608. */
  8609. category?: number;
  8610. /**
  8611. * The original browser event (usually click) that triggered the drilldown.
  8612. */
  8613. originalEvent?: Event;
  8614. /**
  8615. * The originating point.
  8616. */
  8617. point: Point;
  8618. /**
  8619. * If a category label was clicked, this array holds all points
  8620. * corresponding to the category. Otherwise it is set to false.
  8621. */
  8622. points?: (boolean|Array<Point>);
  8623. /**
  8624. * Prevents the default behaviour of the event.
  8625. */
  8626. preventDefault: Function;
  8627. /**
  8628. * Options for the new series. If the event is utilized for async drilldown,
  8629. * the seriesOptions are not added, but rather loaded async.
  8630. */
  8631. seriesOptions?: SeriesOptionsType;
  8632. /**
  8633. * The event target.
  8634. */
  8635. target: Chart;
  8636. /**
  8637. * The event type.
  8638. */
  8639. type: "drilldown";
  8640. }
  8641. /**
  8642. * (Highcharts, Highmaps) Options for drill down, the concept of inspecting
  8643. * increasingly high resolution data through clicking on chart items like
  8644. * columns or pie slices.
  8645. *
  8646. * The drilldown feature requires the drilldown.js file to be loaded, found in
  8647. * the modules directory of the download package, or online at
  8648. * code.highcharts.com/modules/drilldown.js.
  8649. */
  8650. export interface DrilldownOptions {
  8651. /**
  8652. * (Highcharts, Highmaps) Additional styles to apply to the X axis label for
  8653. * a point that has drilldown data. By default it is underlined and blue to
  8654. * invite to interaction.
  8655. *
  8656. * In styled mode, active label styles can be set with the
  8657. * `.highcharts-drilldown-axis-label` class.
  8658. */
  8659. activeAxisLabelStyle?: CSSObject;
  8660. /**
  8661. * (Highcharts, Highmaps) Additional styles to apply to the data label of a
  8662. * point that has drilldown data. By default it is underlined and blue to
  8663. * invite to interaction.
  8664. *
  8665. * In styled mode, active data label styles can be applied with the
  8666. * `.highcharts-drilldown-data-label` class.
  8667. */
  8668. activeDataLabelStyle?: (CSSObject|DrilldownActiveDataLabelStyleOptions);
  8669. /**
  8670. * (Highcharts) When this option is false, clicking a single point will
  8671. * drill down all points in the same category, equivalent to clicking the X
  8672. * axis label.
  8673. */
  8674. allowPointDrilldown?: boolean;
  8675. /**
  8676. * (Highcharts, Highmaps) Set the animation for all drilldown animations.
  8677. * Animation of a drilldown occurs when drilling between a column point and
  8678. * a column series, or a pie slice and a full pie series. Drilldown can
  8679. * still be used between series and points of different types, but animation
  8680. * will not occur.
  8681. *
  8682. * The animation can either be set as a boolean or a configuration object.
  8683. * If `true`, it will use the 'swing' jQuery easing and a duration of 500
  8684. * ms. If used as a configuration object, the following properties are
  8685. * supported:
  8686. *
  8687. * - `duration`: The duration of the animation in milliseconds.
  8688. *
  8689. * - `easing`: A string reference to an easing function set on the `Math`
  8690. * object. See the easing demo.
  8691. */
  8692. animation?: (boolean|Partial<AnimationOptionsObject>);
  8693. /**
  8694. * (Highcharts, Highmaps) Options for the drill up button that appears when
  8695. * drilling down on a series. The text for the button is defined in
  8696. * lang.drillUpText.
  8697. */
  8698. drillUpButton?: DrilldownDrillUpButtonOptions;
  8699. /**
  8700. * (Highcharts, Highmaps) An array of series configurations for the drill
  8701. * down. Each series configuration uses the same syntax as the series option
  8702. * set. These drilldown series are hidden by default. The drilldown series
  8703. * is linked to the parent series' point by its `id`.
  8704. */
  8705. series?: Array<SeriesOptionsType>;
  8706. }
  8707. /**
  8708. * The event arguments when all the series have been drilled up.
  8709. */
  8710. export interface DrillupAllEventObject {
  8711. /**
  8712. * Prevents the default behaviour of the event.
  8713. */
  8714. preventDefault: Function;
  8715. /**
  8716. * The event target.
  8717. */
  8718. target: Chart;
  8719. /**
  8720. * The event type.
  8721. */
  8722. type: "drillupall";
  8723. }
  8724. /**
  8725. * The event arguments when drilling up from a drilldown series.
  8726. */
  8727. export interface DrillupEventObject {
  8728. /**
  8729. * Prevents the default behaviour of the event.
  8730. */
  8731. preventDefault: Function;
  8732. /**
  8733. * Options for the new series.
  8734. */
  8735. seriesOptions?: SeriesOptionsType;
  8736. /**
  8737. * The event target.
  8738. */
  8739. target: Chart;
  8740. /**
  8741. * The event type.
  8742. */
  8743. type: "drillup";
  8744. }
  8745. /**
  8746. * The event options for adding function callback.
  8747. */
  8748. export interface EventOptionsObject {
  8749. /**
  8750. * The order the event handler should be called. This opens for having one
  8751. * handler be called before another, independent of in which order they were
  8752. * added.
  8753. */
  8754. order: number;
  8755. /**
  8756. * Whether an event should be passive or not. When set to `true`, the
  8757. * function specified by listener will never call `preventDefault()`.
  8758. */
  8759. passive: boolean;
  8760. }
  8761. /**
  8762. * Contains information about the export data event.
  8763. */
  8764. export interface ExportDataEventObject {
  8765. /**
  8766. * Contains the data rows for the current export task and can be modified.
  8767. */
  8768. dataRows: Array<Array<string>>;
  8769. }
  8770. /**
  8771. * (Highcharts, Highstock, Highmaps, Gantt) Accessibility options for the
  8772. * exporting menu. Requires the Accessibility module.
  8773. */
  8774. export interface ExportingAccessibilityOptions {
  8775. /**
  8776. * (Highcharts, Highstock, Highmaps, Gantt) Enable accessibility support for
  8777. * the export menu.
  8778. */
  8779. enabled?: boolean;
  8780. }
  8781. /**
  8782. * (Highcharts, Highstock, Highmaps, Gantt) A configuration object for the
  8783. * button theme. The object accepts SVG properties like `stroke-width`, `stroke`
  8784. * and `fill`. Tri-state button styles are supported by the `states.hover` and
  8785. * `states.select` objects.
  8786. */
  8787. export interface ExportingButtonsContextButtonThemeOptions {
  8788. /**
  8789. * (Highcharts, Highstock, Highmaps, Gantt) The default fill exists only to
  8790. * capture hover events.
  8791. */
  8792. fill?: (ColorString|GradientColorObject|PatternObject);
  8793. /**
  8794. * (Highcharts, Highstock, Highmaps, Gantt) Padding for the button.
  8795. */
  8796. padding?: number;
  8797. /**
  8798. * (Highcharts, Highstock, Highmaps, Gantt) Default stroke for the buttons.
  8799. */
  8800. stroke?: ColorString;
  8801. }
  8802. /**
  8803. * (Highcharts, Highstock, Highmaps, Gantt) Options for the export related
  8804. * buttons, print and export. In addition to the default buttons listed here,
  8805. * custom buttons can be added. See navigation.buttonOptions for general
  8806. * options.
  8807. */
  8808. export interface ExportingButtonsOptions {
  8809. /**
  8810. * (Highcharts, Highstock, Highmaps, Gantt) Options for the export button.
  8811. *
  8812. * In styled mode, export button styles can be applied with the
  8813. * `.highcharts-contextbutton` class.
  8814. */
  8815. contextButton?: ExportingButtonsOptionsObject;
  8816. }
  8817. /**
  8818. * (Highcharts, Highstock, Highmaps, Gantt) Options for the export button.
  8819. *
  8820. * In styled mode, export button styles can be applied with the
  8821. * `.highcharts-contextbutton` class.
  8822. */
  8823. export interface ExportingButtonsOptionsObject {
  8824. /**
  8825. * (Highcharts, Highstock, Highmaps, Gantt) Alignment for the buttons.
  8826. */
  8827. align?: AlignValue;
  8828. /**
  8829. * (Highcharts, Highstock, Highmaps, Gantt) The pixel spacing between
  8830. * buttons.
  8831. */
  8832. buttonSpacing?: number;
  8833. /**
  8834. * (Highcharts, Highstock, Highmaps, Gantt) The class name of the context
  8835. * button.
  8836. */
  8837. className?: string;
  8838. /**
  8839. * (Highcharts, Highstock, Highmaps, Gantt) Whether to enable buttons.
  8840. */
  8841. enabled?: boolean;
  8842. /**
  8843. * (Highcharts, Highstock, Highmaps, Gantt) Pixel height of the buttons.
  8844. */
  8845. height?: number;
  8846. /**
  8847. * (Highcharts, Highstock, Highmaps, Gantt) The class name of the menu
  8848. * appearing from the button.
  8849. */
  8850. menuClassName?: string;
  8851. /**
  8852. * (Highcharts, Highstock, Highmaps, Gantt) A collection of strings pointing
  8853. * to config options for the menu items. The config options are defined in
  8854. * the `menuItemDefinitions` option.
  8855. *
  8856. * By default, there is the "View in full screen" and "Print" menu items,
  8857. * plus one menu item for each of the available export types.
  8858. */
  8859. menuItems?: Array<string>;
  8860. /**
  8861. * (Highcharts, Highstock, Highmaps, Gantt) A click handler callback to use
  8862. * on the button directly instead of the popup menu.
  8863. */
  8864. onclick?: Function;
  8865. /**
  8866. * (Highcharts, Highstock, Highmaps, Gantt) The symbol for the button.
  8867. * Points to a definition function in the `Highcharts.Renderer.symbols`
  8868. * collection. The default `exportIcon` function is part of the exporting
  8869. * module. Possible values are "circle", "square", "diamond", "triangle",
  8870. * "triangle-down", "menu", "menuball" or custom shape.
  8871. */
  8872. symbol?: ("menu"|"menuball"|"exportIcon"|string|SymbolKeyValue);
  8873. /**
  8874. * (Highcharts, Highstock, Highmaps, Gantt) See
  8875. * navigation.buttonOptions.symbolFill.
  8876. */
  8877. symbolFill?: ColorString;
  8878. /**
  8879. * (Highcharts, Highstock, Highmaps, Gantt) The pixel size of the symbol on
  8880. * the button.
  8881. */
  8882. symbolSize?: number;
  8883. /**
  8884. * (Highcharts, Highstock, Highmaps, Gantt) The color of the symbol's stroke
  8885. * or line.
  8886. */
  8887. symbolStroke?: ColorString;
  8888. /**
  8889. * (Highcharts, Highstock, Highmaps, Gantt) The pixel stroke width of the
  8890. * symbol on the button.
  8891. */
  8892. symbolStrokeWidth?: number;
  8893. /**
  8894. * (Highcharts, Highstock, Highmaps, Gantt) The x position of the center of
  8895. * the symbol inside the button.
  8896. */
  8897. symbolX?: number;
  8898. /**
  8899. * (Highcharts, Highstock, Highmaps, Gantt) The y position of the center of
  8900. * the symbol inside the button.
  8901. */
  8902. symbolY?: number;
  8903. /**
  8904. * (Highcharts, Highstock, Highmaps, Gantt) A text string to add to the
  8905. * individual button.
  8906. */
  8907. text?: string;
  8908. /**
  8909. * (Highcharts, Highstock, Highmaps, Gantt) A configuration object for the
  8910. * button theme. The object accepts SVG properties like `stroke-width`,
  8911. * `stroke` and `fill`. Tri-state button styles are supported by the
  8912. * `states.hover` and `states.select` objects.
  8913. */
  8914. theme?: ExportingButtonsContextButtonThemeOptions;
  8915. /**
  8916. * (Highcharts, Highstock, Highmaps, Gantt) The key to a lang option setting
  8917. * that is used for the button's title tooltip. When the key is
  8918. * `contextButtonTitle`, it refers to lang.contextButtonTitle that defaults
  8919. * to "Chart context menu".
  8920. */
  8921. titleKey?: string;
  8922. /**
  8923. * (Highcharts, Highstock, Highmaps, Gantt) The vertical alignment of the
  8924. * buttons. Can be one of `"top"`, `"middle"` or `"bottom"`.
  8925. */
  8926. verticalAlign?: VerticalAlignValue;
  8927. /**
  8928. * (Highcharts, Highstock, Highmaps, Gantt) The pixel width of the button.
  8929. */
  8930. width?: number;
  8931. /**
  8932. * (Highcharts, Highstock, Highmaps, Gantt) The horizontal position of the
  8933. * button relative to the `align` option.
  8934. */
  8935. x?: number;
  8936. /**
  8937. * (Highcharts, Highstock, Highmaps, Gantt) The vertical offset of the
  8938. * button's position relative to its `verticalAlign`.
  8939. */
  8940. y?: number;
  8941. }
  8942. /**
  8943. * (Highcharts, Highstock, Highmaps, Gantt) Options for annotations in the
  8944. * export-data table.
  8945. */
  8946. export interface ExportingCsvAnnotationsOptions {
  8947. /**
  8948. * (Highcharts, Highstock, Highmaps, Gantt) The way to mark the separator
  8949. * for annotations combined in one export-data table cell.
  8950. */
  8951. itemDelimiter?: string;
  8952. /**
  8953. * (Highcharts, Highstock, Highmaps, Gantt) When several labels are assigned
  8954. * to a specific point, they will be displayed in one field in the table.
  8955. */
  8956. join?: boolean;
  8957. }
  8958. /**
  8959. * (Highcharts, Highstock, Highmaps, Gantt) Options for exporting data to CSV or
  8960. * ExCel, or displaying the data in a HTML table or a JavaScript structure.
  8961. *
  8962. * This module adds data export options to the export menu and provides
  8963. * functions like `Chart.getCSV`, `Chart.getTable`, `Chart.getDataRows` and
  8964. * `Chart.viewData`.
  8965. *
  8966. * The XLS converter is limited and only creates a HTML string that is passed
  8967. * for download, which works but creates a warning before opening. The
  8968. * workaround for this is to use a third party XLSX converter, as demonstrated
  8969. * in the sample below.
  8970. */
  8971. export interface ExportingCsvOptions {
  8972. /**
  8973. * (Highcharts, Highstock, Highmaps, Gantt) Options for annotations in the
  8974. * export-data table.
  8975. */
  8976. annotations?: ExportingCsvAnnotationsOptions;
  8977. /**
  8978. * (Highcharts, Highstock, Highmaps, Gantt) Formatter callback for the
  8979. * column headers. Parameters are:
  8980. *
  8981. * - `item` - The series or axis object)
  8982. *
  8983. * - `key` - The point key, for example y or z
  8984. *
  8985. * - `keyLength` - The amount of value keys for this item, for example a
  8986. * range series has the keys `low` and `high` so the key length is 2.
  8987. *
  8988. * If useMultiLevelHeaders is true, columnHeaderFormatter by default returns
  8989. * an object with columnTitle and topLevelColumnTitle for each key. Columns
  8990. * with the same topLevelColumnTitle have their titles merged into a single
  8991. * cell with colspan for table/Excel export.
  8992. *
  8993. * If `useMultiLevelHeaders` is false, or for CSV export, it returns the
  8994. * series name, followed by the key if there is more than one key.
  8995. *
  8996. * For the axis it returns the axis title or "Category" or "DateTime" by
  8997. * default.
  8998. *
  8999. * Return `false` to use Highcharts' proposed header.
  9000. */
  9001. columnHeaderFormatter?: (Function|null);
  9002. /**
  9003. * (Highcharts, Highstock, Highmaps, Gantt) Which date format to use for
  9004. * exported dates on a datetime X axis. See `Highcharts.dateFormat`.
  9005. */
  9006. dateFormat?: string;
  9007. /**
  9008. * (Highcharts, Highstock, Highmaps, Gantt) Which decimal point to use for
  9009. * exported CSV. Defaults to the same as the browser locale, typically `.`
  9010. * (English) or `,` (German, French etc).
  9011. */
  9012. decimalPoint?: (string|null);
  9013. /**
  9014. * (Highcharts, Highstock, Highmaps, Gantt) The item delimiter in the
  9015. * exported data. Use `;` for direct exporting to Excel. Defaults to a best
  9016. * guess based on the browser locale. If the locale _decimal point_ is `,`,
  9017. * the `itemDelimiter` defaults to `;`, otherwise the `itemDelimiter`
  9018. * defaults to `,`.
  9019. */
  9020. itemDelimiter?: (string|null);
  9021. /**
  9022. * (Highcharts, Highstock, Highmaps, Gantt) The line delimiter in the
  9023. * exported data, defaults to a newline.
  9024. */
  9025. lineDelimiter?: string;
  9026. }
  9027. /**
  9028. * Definition for a menu item in the context menu.
  9029. */
  9030. export interface ExportingMenuObject {
  9031. /**
  9032. * The click handler for the menu item.
  9033. */
  9034. onclick?: EventCallbackFunction<Chart>;
  9035. /**
  9036. * Indicates a separator line instead of an item.
  9037. */
  9038. separator?: boolean;
  9039. /**
  9040. * The text for the menu item.
  9041. */
  9042. text?: string;
  9043. /**
  9044. * If internationalization is required, the key to a language string.
  9045. */
  9046. textKey?: string;
  9047. }
  9048. /**
  9049. * (Highcharts, Highstock, Highmaps, Gantt) Options for the exporting module.
  9050. * For an overview on the matter, see the docs.
  9051. */
  9052. export interface ExportingOptions {
  9053. /**
  9054. * (Highcharts, Highstock, Highmaps, Gantt) Accessibility options for the
  9055. * exporting menu. Requires the Accessibility module.
  9056. */
  9057. accessibility?: ExportingAccessibilityOptions;
  9058. /**
  9059. * (Highcharts, Highstock, Highmaps, Gantt) Experimental setting to allow
  9060. * HTML inside the chart (added through the `useHTML` options), directly in
  9061. * the exported image. This allows you to preserve complicated HTML
  9062. * structures like tables or bi-directional text in exported charts.
  9063. *
  9064. * Disclaimer: The HTML is rendered in a `foreignObject` tag in the
  9065. * generated SVG. The official export server is based on PhantomJS, which
  9066. * supports this, but other SVG clients, like Batik, does not support it.
  9067. * This also applies to downloaded SVG that you want to open in a desktop
  9068. * client.
  9069. */
  9070. allowHTML?: boolean;
  9071. /**
  9072. * (Highcharts, Highstock, Highmaps, Gantt) Options for the export related
  9073. * buttons, print and export. In addition to the default buttons listed
  9074. * here, custom buttons can be added. See navigation.buttonOptions for
  9075. * general options.
  9076. */
  9077. buttons?: (ExportingButtonsOptions|Dictionary<ExportingButtonsOptionsObject>);
  9078. /**
  9079. * (Highcharts, Highstock, Highmaps, Gantt) Additional chart options to be
  9080. * merged into the chart before exporting to an image format. This does not
  9081. * apply to printing the chart via the export menu.
  9082. *
  9083. * For example, a common use case is to add data labels to improve
  9084. * readability of the exported chart, or to add a printer-friendly color
  9085. * scheme to exported PDFs.
  9086. */
  9087. chartOptions?: Options;
  9088. /**
  9089. * (Highcharts, Highstock, Highmaps, Gantt) Options for exporting data to
  9090. * CSV or ExCel, or displaying the data in a HTML table or a JavaScript
  9091. * structure.
  9092. *
  9093. * This module adds data export options to the export menu and provides
  9094. * functions like `Chart.getCSV`, `Chart.getTable`, `Chart.getDataRows` and
  9095. * `Chart.viewData`.
  9096. *
  9097. * The XLS converter is limited and only creates a HTML string that is
  9098. * passed for download, which works but creates a warning before opening.
  9099. * The workaround for this is to use a third party XLSX converter, as
  9100. * demonstrated in the sample below.
  9101. */
  9102. csv?: ExportingCsvOptions;
  9103. /**
  9104. * (Highcharts, Highstock, Highmaps, Gantt) Whether to enable the exporting
  9105. * module. Disabling the module will hide the context button, but API
  9106. * methods will still be available.
  9107. */
  9108. enabled?: boolean;
  9109. /**
  9110. * (Highcharts, Highstock, Highmaps, Gantt) Function to call if the
  9111. * offline-exporting module fails to export a chart on the client side, and
  9112. * fallbackToExportServer is disabled. If left undefined, an exception is
  9113. * thrown instead. Receives two parameters, the exporting options, and the
  9114. * error from the module.
  9115. */
  9116. error?: ExportingErrorCallbackFunction;
  9117. /**
  9118. * (Highcharts, Highstock, Highmaps, Gantt) Whether or not to fall back to
  9119. * the export server if the offline-exporting module is unable to export the
  9120. * chart on the client side. This happens for certain browsers, and certain
  9121. * features (e.g. allowHTML), depending on the image type exporting to. For
  9122. * very complex charts, it is possible that export can fail in browsers that
  9123. * don't support Blob objects, due to data URL length limits. It is
  9124. * recommended to define the exporting.error handler if disabling fallback,
  9125. * in order to notify users in case export fails.
  9126. */
  9127. fallbackToExportServer?: boolean;
  9128. /**
  9129. * (Highcharts, Highstock, Highmaps, Gantt) The filename, without extension,
  9130. * to use for the exported chart.
  9131. */
  9132. filename?: string;
  9133. /**
  9134. * (Highcharts, Highstock, Highmaps, Gantt) An object containing additional
  9135. * key value data for the POST form that sends the SVG to the export server.
  9136. * For example, a `target` can be set to make sure the generated image is
  9137. * received in another frame, or a custom `enctype` or `encoding` can be
  9138. * set.
  9139. */
  9140. formAttributes?: HTMLAttributes;
  9141. /**
  9142. * (Highcharts, Highstock, Highmaps, Gantt) Path where Highcharts will look
  9143. * for export module dependencies to load on demand if they don't already
  9144. * exist on `window`. Should currently point to location of CanVG library,
  9145. * RGBColor.js, jsPDF and svg2pdf.js, required for client side export in
  9146. * certain browsers.
  9147. */
  9148. libURL?: string;
  9149. /**
  9150. * (Highcharts, Highstock, Highmaps, Gantt) An object consisting of
  9151. * definitions for the menu items in the context menu. Each key value pair
  9152. * has a `key` that is referenced in the menuItems setting, and a `value`,
  9153. * which is an object with the following properties:
  9154. *
  9155. * - **onclick:** The click handler for the menu item
  9156. *
  9157. * - **text:** The text for the menu item
  9158. *
  9159. * - **textKey:** If internationalization is required, the key to a language
  9160. * string
  9161. *
  9162. * Custom text for the "exitFullScreen" can be set only in lang options (it
  9163. * is not a separate button).
  9164. */
  9165. menuItemDefinitions?: Dictionary<ExportingMenuObject>;
  9166. /**
  9167. * (Highcharts, Highstock, Highmaps, Gantt) When printing the chart from the
  9168. * menu item in the burger menu, if the on-screen chart exceeds this width,
  9169. * it is resized. After printing or cancelled, it is restored. The default
  9170. * width makes the chart fit into typical paper format. Note that this does
  9171. * not affect the chart when printing the web page as a whole.
  9172. */
  9173. printMaxWidth?: number;
  9174. /**
  9175. * (Highcharts, Highstock, Highmaps, Gantt) Defines the scale or zoom factor
  9176. * for the exported image compared to the on-screen display. While for
  9177. * instance a 600px wide chart may look good on a website, it will look bad
  9178. * in print. The default scale of 2 makes this chart export to a 1200px PNG
  9179. * or JPG.
  9180. */
  9181. scale?: number;
  9182. /**
  9183. * (Highcharts, Highstock, Highmaps, Gantt) Show a HTML table below the
  9184. * chart with the chart's current data.
  9185. */
  9186. showTable?: boolean;
  9187. /**
  9188. * (Highcharts, Highstock, Highmaps, Gantt) Analogous to sourceWidth.
  9189. */
  9190. sourceHeight?: number;
  9191. /**
  9192. * (Highcharts, Highstock, Highmaps, Gantt) The width of the original chart
  9193. * when exported, unless an explicit chart.width is set, or a pixel width is
  9194. * set on the container. The width exported raster image is then multiplied
  9195. * by scale.
  9196. */
  9197. sourceWidth?: number;
  9198. /**
  9199. * (Highcharts, Highstock, Highmaps, Gantt) Caption for the data table. Same
  9200. * as chart title by default. Set to `false` to disable.
  9201. */
  9202. tableCaption?: (boolean|string);
  9203. /**
  9204. * (Highcharts, Highstock, Highmaps, Gantt) Default MIME type for exporting
  9205. * if `chart.exportChart()` is called without specifying a `type` option.
  9206. * Possible values are `image/png`, `image/jpeg`, `application/pdf` and
  9207. * `image/svg+xml`.
  9208. */
  9209. type?: ExportingMimeTypeValue;
  9210. /**
  9211. * (Highcharts, Highstock, Highmaps, Gantt) The URL for the server module
  9212. * converting the SVG string to an image format. By default this points to
  9213. * Highchart's free web service.
  9214. */
  9215. url?: string;
  9216. /**
  9217. * (Highcharts, Highstock, Highmaps, Gantt) Use multi level headers in data
  9218. * table. If csv.columnHeaderFormatter is defined, it has to return objects
  9219. * in order for multi level headers to work.
  9220. */
  9221. useMultiLevelHeaders?: boolean;
  9222. /**
  9223. * (Highcharts, Highstock, Highmaps, Gantt) If using multi level table
  9224. * headers, use rowspans for headers that have only one level.
  9225. */
  9226. useRowspanHeaders?: boolean;
  9227. /**
  9228. * (Highcharts, Highstock, Highmaps, Gantt) The pixel width of charts
  9229. * exported to PNG or JPG. As of Highcharts 3.0, the default pixel width is
  9230. * a function of the chart.width or exporting.sourceWidth and the
  9231. * exporting.scale.
  9232. */
  9233. width?: number;
  9234. }
  9235. /**
  9236. * The returned object literal from the Highcharts.Axis#getExtremes function.
  9237. */
  9238. export interface ExtremesObject {
  9239. /**
  9240. * The maximum value of the axis' associated series.
  9241. */
  9242. dataMax: number;
  9243. /**
  9244. * The minimum value of the axis' associated series.
  9245. */
  9246. dataMin: number;
  9247. /**
  9248. * The maximum axis value, either automatic or set manually. If the `max`
  9249. * option is not set, `maxPadding` is 0 and `endOnTick` is false, this value
  9250. * will be the same as `dataMax`.
  9251. */
  9252. max: number;
  9253. /**
  9254. * The minimum axis value, either automatic or set manually. If the `min`
  9255. * option is not set, `minPadding` is 0 and `startOnTick` is false, this
  9256. * value will be the same as `dataMin`.
  9257. */
  9258. min: number;
  9259. /**
  9260. * The user defined maximum, either from the `max` option or from a zoom or
  9261. * `setExtremes` action.
  9262. */
  9263. userMax: number;
  9264. /**
  9265. * The user defined minimum, either from the `min` option or from a zoom or
  9266. * `setExtremes` action.
  9267. */
  9268. userMin: number;
  9269. }
  9270. /**
  9271. * The font metrics.
  9272. */
  9273. export interface FontMetricsObject {
  9274. /**
  9275. * The baseline relative to the top of the box.
  9276. */
  9277. b: number;
  9278. /**
  9279. * The font size.
  9280. */
  9281. f: number;
  9282. /**
  9283. * The line height.
  9284. */
  9285. h: number;
  9286. }
  9287. /**
  9288. * (Gantt) Data for a Gantt series.
  9289. */
  9290. export interface GanttPointOptionsObject {
  9291. /**
  9292. * (Gantt) Accessibility options for a data point.
  9293. */
  9294. accessibility?: PointAccessibilityOptionsObject;
  9295. /**
  9296. * (Gantt) Whether the grid node belonging to this point should start as
  9297. * collapsed. Used in axes of type treegrid.
  9298. */
  9299. collapsed?: boolean;
  9300. /**
  9301. * (Highcharts, Highstock, Gantt) Individual color for the point. By default
  9302. * the color is pulled from the global `colors` array.
  9303. *
  9304. * In styled mode, the `color` option doesn't take effect. Instead, use
  9305. * `colorIndex`.
  9306. */
  9307. color?: (ColorString|GradientColorObject|PatternObject);
  9308. /**
  9309. * (Highcharts, Gantt) A specific color index to use for the point, so its
  9310. * graphic representations are given the class name `highcharts-color-{n}`.
  9311. * In styled mode this will change the color of the graphic. In non-styled
  9312. * mode, the color by is set by the `fill` attribute, so the change in class
  9313. * name won't have a visual effect by default.
  9314. */
  9315. colorIndex?: number;
  9316. /**
  9317. * (Gantt) Progress indicator, how much of the task completed. If it is a
  9318. * number, the `fill` will be applied automatically.
  9319. */
  9320. completed?: (number|XrangePointPartialFillOptionsObject);
  9321. /**
  9322. * (Gantt) A reserved subspace to store options and values for customized
  9323. * functionality. Here you can add additional data for your own event
  9324. * callbacks and formatter callbacks.
  9325. */
  9326. custom?: Dictionary<any>;
  9327. /**
  9328. * (Gantt) The ID of the point (task) that this point depends on in Gantt
  9329. * charts. Aliases connect. Can also be an object, specifying further
  9330. * connecting options between the points. Multiple connections can be
  9331. * specified by providing an array.
  9332. */
  9333. dependency?: (string|XrangePointConnectorsOptionsObject|Array<(string|XrangePointConnectorsOptionsObject)>);
  9334. /**
  9335. * (Gantt) A description of the point to add to the screen reader
  9336. * information about the point.
  9337. */
  9338. description?: string;
  9339. /**
  9340. * (Gantt) Point specific options for the draggable-points module. Overrides
  9341. * options on `series.dragDrop`.
  9342. */
  9343. dragDrop?: SeriesLineDataDragDropOptions;
  9344. /**
  9345. * (Highcharts) The `id` of a series in the drilldown.series array to use
  9346. * for a drilldown for this point.
  9347. */
  9348. drilldown?: string;
  9349. /**
  9350. * (Gantt) The end time of a task.
  9351. */
  9352. end?: number;
  9353. /**
  9354. * (Highcharts, Highstock, Gantt) An id for the point. This can be used
  9355. * after render time to get a pointer to the point object through
  9356. * `chart.get()`.
  9357. */
  9358. id?: string;
  9359. /**
  9360. * (Gantt) The rank for this point's data label in case of collision. If two
  9361. * data labels are about to overlap, only the one with the highest
  9362. * `labelrank` will be drawn.
  9363. */
  9364. labelrank?: number;
  9365. /**
  9366. * (Highcharts, Highstock) Options for the point markers of line-like
  9367. * series.
  9368. */
  9369. marker?: PointMarkerOptionsObject;
  9370. /**
  9371. * (Gantt) Whether this point is a milestone. If so, only the `start` option
  9372. * is handled, while `end` is ignored.
  9373. */
  9374. milestone?: boolean;
  9375. /**
  9376. * (Gantt) The name of a task. If a `treegrid` y-axis is used (default in
  9377. * Gantt charts), this will be picked up automatically, and used to
  9378. * calculate the y-value.
  9379. */
  9380. name?: string;
  9381. /**
  9382. * (Gantt) The ID of the parent point (task) of this point in Gantt charts.
  9383. */
  9384. parent?: string;
  9385. /**
  9386. * (Gantt) The start time of a task.
  9387. */
  9388. start?: number;
  9389. /**
  9390. * (Gantt) The Y value of a task.
  9391. */
  9392. y?: number;
  9393. }
  9394. /**
  9395. * Represents the loose structure of a geographic JSON file.
  9396. */
  9397. export interface GeoJSON {
  9398. /**
  9399. * Full copyright note of the geographic data.
  9400. */
  9401. copyright?: string;
  9402. /**
  9403. * Short copyright note of the geographic data suitable for watermarks.
  9404. */
  9405. copyrightShort?: string;
  9406. /**
  9407. * Additional meta information based on the coordinate reference system.
  9408. */
  9409. crs?: Dictionary<any>;
  9410. /**
  9411. * Data sets of geographic features.
  9412. */
  9413. features: Array<GeoJSONFeature>;
  9414. /**
  9415. * Map projections and transformations to be used when calculating between
  9416. * lat/lon and chart values. Required for lat/lon support on maps. Allows
  9417. * resizing, rotating, and moving portions of a map within its projected
  9418. * coordinate system while still retaining lat/lon support. If using lat/lon
  9419. * on a portion of the map that does not match a `hitZone`, the definition
  9420. * with the key `default` is used.
  9421. */
  9422. "hc-transform"?: Dictionary<GeoJSONTranslation>;
  9423. /**
  9424. * Title of the geographic data.
  9425. */
  9426. title?: string;
  9427. /**
  9428. * Type of the geographic data. Type of an optimized map collection is
  9429. * `FeatureCollection`.
  9430. */
  9431. type?: string;
  9432. /**
  9433. * Version of the geographic data.
  9434. */
  9435. version?: string;
  9436. }
  9437. /**
  9438. * Data set of a geographic feature.
  9439. */
  9440. export interface GeoJSONFeature extends Dictionary<any> {
  9441. /**
  9442. * Data type of the geographic feature.
  9443. */
  9444. type: string;
  9445. }
  9446. /**
  9447. * Describes the map projection and transformations applied to a portion of a
  9448. * map.
  9449. */
  9450. export interface GeoJSONTranslation {
  9451. /**
  9452. * The coordinate reference system used to generate this portion of the map.
  9453. */
  9454. crs: string;
  9455. /**
  9456. * Define the portion of the map that this defintion applies to. Defined as
  9457. * a GeoJSON polygon feature object, with `type` and `coordinates`
  9458. * properties.
  9459. */
  9460. hitZone?: Dictionary<any>;
  9461. /**
  9462. * Property for internal use for maps generated by Highsoft.
  9463. */
  9464. jsonmarginX?: number;
  9465. /**
  9466. * Property for internal use for maps generated by Highsoft.
  9467. */
  9468. jsonmarginY?: number;
  9469. /**
  9470. * Property for internal use for maps generated by Highsoft.
  9471. */
  9472. jsonres?: number;
  9473. /**
  9474. * Specifies clockwise rotation of the coordinates after the projection, but
  9475. * before scaling and panning. Defined in radians, relative to the
  9476. * coordinate system origin.
  9477. */
  9478. rotation?: number;
  9479. /**
  9480. * The scaling factor applied to the projected coordinates.
  9481. */
  9482. scale?: number;
  9483. /**
  9484. * Property for internal use for maps generated by Highsoft.
  9485. */
  9486. xoffset?: number;
  9487. /**
  9488. * X offset of projected coordinates after scaling.
  9489. */
  9490. xpan?: number;
  9491. /**
  9492. * Property for internal use for maps generated by Highsoft.
  9493. */
  9494. yoffset?: number;
  9495. /**
  9496. * Y offset of projected coordinates after scaling.
  9497. */
  9498. ypan?: number;
  9499. }
  9500. export interface GlobalOptions {
  9501. /**
  9502. * (Highcharts, Highstock, Highmaps, Gantt) Path to the pattern image
  9503. * required by VML browsers in order to draw radial gradients.
  9504. */
  9505. VMLRadialGradientURL?: string;
  9506. }
  9507. /**
  9508. * Gradient options instead of a solid color.
  9509. */
  9510. export interface GradientColorObject {
  9511. /**
  9512. * Holds an object that defines the start position and the end position
  9513. * relative to the shape.
  9514. */
  9515. linearGradient?: LinearGradientColorObject;
  9516. /**
  9517. * Holds an object that defines the center position and the radius.
  9518. */
  9519. radialGradient?: RadialGradientColorObject;
  9520. /**
  9521. * The first item in each tuple is the position in the gradient, where 0 is
  9522. * the start of the gradient and 1 is the end of the gradient. Multiple
  9523. * stops can be applied. The second item is the color for each stop. This
  9524. * color can also be given in the rgba format.
  9525. */
  9526. stops: Array<GradientColorStopObject>;
  9527. }
  9528. /**
  9529. * Color stop tuple.
  9530. */
  9531. export interface GradientColorStopObject {
  9532. 0: number;
  9533. 1: ColorString;
  9534. color?: Color;
  9535. }
  9536. /**
  9537. * (Highcharts, Highstock, Highmaps, Gantt) Options for the focus border drawn
  9538. * around elements while navigating through them.
  9539. */
  9540. export interface KeyboardNavigationFocusBorderOptionsObject {
  9541. /**
  9542. * (Highcharts, Highstock, Highmaps, Gantt) Enable/disable focus border for
  9543. * chart.
  9544. */
  9545. enabled?: boolean;
  9546. /**
  9547. * (Highcharts, Highstock, Highmaps, Gantt) Hide the browser's default focus
  9548. * indicator.
  9549. */
  9550. hideBrowserFocusOutline?: boolean;
  9551. /**
  9552. * (Highcharts, Highstock, Highmaps, Gantt) Focus border margin around the
  9553. * elements.
  9554. */
  9555. margin?: number;
  9556. /**
  9557. * (Highcharts, Highstock, Highmaps, Gantt) Style options for the focus
  9558. * border drawn around elements while navigating through them. Note that
  9559. * some browsers in addition draw their own borders for focused elements.
  9560. * These automatic borders can not be styled by Highcharts.
  9561. *
  9562. * In styled mode, the border is given the `.highcharts-focus-border` class.
  9563. */
  9564. style?: CSSObject;
  9565. }
  9566. /**
  9567. * (Highcharts, Highstock, Highmaps, Gantt) Options for keyboard navigation.
  9568. */
  9569. export interface KeyboardNavigationOptionsObject {
  9570. /**
  9571. * (Highcharts, Highstock, Highmaps, Gantt) Enable keyboard navigation for
  9572. * the chart.
  9573. */
  9574. enabled?: boolean;
  9575. /**
  9576. * (Highcharts, Highstock, Highmaps, Gantt) Options for the focus border
  9577. * drawn around elements while navigating through them.
  9578. */
  9579. focusBorder?: KeyboardNavigationFocusBorderOptionsObject;
  9580. /**
  9581. * (Highcharts, Highstock, Highmaps, Gantt) Order of tab navigation in the
  9582. * chart. Determines which elements are tabbed to first. Available elements
  9583. * are: `series`, `zoom`, `rangeSelector`, `chartMenu`, `legend`. In
  9584. * addition, any custom components can be added here.
  9585. */
  9586. order?: Array<string>;
  9587. /**
  9588. * (Highcharts, Highstock, Highmaps, Gantt) Options for the keyboard
  9589. * navigation of data points and series.
  9590. */
  9591. seriesNavigation?: KeyboardNavigationSeriesNavigationOptionsObject;
  9592. /**
  9593. * (Highcharts, Highstock, Highmaps, Gantt) Whether or not to wrap around
  9594. * when reaching the end of arrow-key navigation for an element in the
  9595. * chart.
  9596. */
  9597. wrapAround?: boolean;
  9598. }
  9599. /**
  9600. * (Highcharts, Highstock, Highmaps, Gantt) Options for the keyboard navigation
  9601. * of data points and series.
  9602. */
  9603. export interface KeyboardNavigationSeriesNavigationOptionsObject {
  9604. /**
  9605. * (Highcharts, Highstock, Highmaps, Gantt) Set the keyboard navigation mode
  9606. * for the chart. Can be "normal" or "serialize". In normal mode, left/right
  9607. * arrow keys move between points in a series, while up/down arrow keys move
  9608. * between series. Up/down navigation acts intelligently to figure out which
  9609. * series makes sense to move to from any given point.
  9610. *
  9611. * In "serialize" mode, points are instead navigated as a single list.
  9612. * Left/right behaves as in "normal" mode. Up/down arrow keys will behave
  9613. * like left/right. This can be useful for unifying navigation behavior
  9614. * with/without screen readers enabled.
  9615. */
  9616. mode?: OptionsModeValue;
  9617. /**
  9618. * (Highcharts, Highstock, Highmaps, Gantt) When a series contains more
  9619. * points than this, we no longer allow keyboard navigation for it.
  9620. *
  9621. * Set to `false` to disable.
  9622. */
  9623. pointNavigationEnabledThreshold?: (boolean|number);
  9624. /**
  9625. * (Highcharts, Highstock, Highmaps, Gantt) Skip null points when navigating
  9626. * through points with the keyboard.
  9627. */
  9628. skipNullPoints?: boolean;
  9629. }
  9630. /**
  9631. * Containing the position of a box that should be avoided by labels.
  9632. */
  9633. export interface LabelIntersectBoxObject {
  9634. bottom: number;
  9635. left: number;
  9636. right: number;
  9637. top: number;
  9638. }
  9639. /**
  9640. * (Highcharts, Highstock, Highmaps, Gantt) Default announcement for new data in
  9641. * charts. If addPoint or addSeries is used, and only one series/point is added,
  9642. * the `newPointAnnounce` and `newSeriesAnnounce` strings are used. The
  9643. * `...Single` versions will be used if there is only one chart on the page, and
  9644. * the `...Multiple` versions will be used if there are multiple charts on the
  9645. * page. For all other new data events, the `newDataAnnounce` string will be
  9646. * used.
  9647. */
  9648. export interface LangAccessibilityAnnounceNewDataOptions {
  9649. newDataAnnounce?: string;
  9650. newPointAnnounceMultiple?: string;
  9651. newPointAnnounceSingle?: string;
  9652. newSeriesAnnounceMultiple?: string;
  9653. newSeriesAnnounceSingle?: string;
  9654. }
  9655. /**
  9656. * (Highcharts, Highstock, Highmaps, Gantt) Axis description format strings.
  9657. */
  9658. export interface LangAccessibilityAxisOptions {
  9659. rangeCategories?: string;
  9660. rangeFromTo?: string;
  9661. timeRangeDays?: string;
  9662. timeRangeHours?: string;
  9663. timeRangeMinutes?: string;
  9664. timeRangeSeconds?: string;
  9665. xAxisDescriptionPlural?: string;
  9666. xAxisDescriptionSingular?: string;
  9667. yAxisDescriptionPlural?: string;
  9668. yAxisDescriptionSingular?: string;
  9669. }
  9670. /**
  9671. * (Highcharts, Highstock, Highmaps, Gantt) Chart type description strings. This
  9672. * is added to the chart information region.
  9673. *
  9674. * If there is only a single series type used in the chart, we use the format
  9675. * string for the series type, or default if missing. There is one format string
  9676. * for cases where there is only a single series in the chart, and one for
  9677. * multiple series of the same type.
  9678. */
  9679. export interface LangAccessibilityChartTypesOptions {
  9680. barMultiple?: string;
  9681. barSingle?: string;
  9682. boxplotMultiple?: string;
  9683. boxplotSingle?: string;
  9684. bubbleMultiple?: string;
  9685. bubbleSingle?: string;
  9686. columnMultiple?: string;
  9687. columnSingle?: string;
  9688. combinationChart?: string;
  9689. defaultMultiple?: string;
  9690. defaultSingle?: string;
  9691. emptyChart?: string;
  9692. lineMultiple?: string;
  9693. lineSingle?: string;
  9694. mapTypeDescription?: string;
  9695. pieMultiple?: string;
  9696. pieSingle?: string;
  9697. scatterMultiple?: string;
  9698. scatterSingle?: string;
  9699. splineMultiple?: string;
  9700. splineSingle?: string;
  9701. unknownMap?: string;
  9702. }
  9703. /**
  9704. * (Highcharts, Highstock, Highmaps, Gantt) Exporting menu format strings for
  9705. * accessibility module.
  9706. */
  9707. export interface LangAccessibilityExportingOptions {
  9708. chartMenuLabel?: string;
  9709. exportRegionLabel?: string;
  9710. menuButtonLabel?: string;
  9711. }
  9712. /**
  9713. * (Highcharts, Highstock, Highmaps, Gantt) Language options for accessibility
  9714. * of the legend.
  9715. */
  9716. export interface LangAccessibilityLegendOptions {
  9717. legendItem?: string;
  9718. legendLabel?: string;
  9719. legendLabelNoTitle?: string;
  9720. }
  9721. /**
  9722. * (Highcharts, Highstock, Highmaps, Gantt) Configure the accessibility strings
  9723. * in the chart. Requires the accessibility module to be loaded. For a
  9724. * description of the module and information on its features, see Highcharts
  9725. * Accessibility.
  9726. *
  9727. * For more dynamic control over the accessibility functionality, see
  9728. * accessibility.pointDescriptionFormatter,
  9729. * accessibility.seriesDescriptionFormatter, and
  9730. * accessibility.screenReaderSectionFormatter.
  9731. */
  9732. export interface LangAccessibilityOptions {
  9733. /**
  9734. * (Highcharts, Highstock, Highmaps, Gantt) Default announcement for new
  9735. * data in charts. If addPoint or addSeries is used, and only one
  9736. * series/point is added, the `newPointAnnounce` and `newSeriesAnnounce`
  9737. * strings are used. The `...Single` versions will be used if there is only
  9738. * one chart on the page, and the `...Multiple` versions will be used if
  9739. * there are multiple charts on the page. For all other new data events, the
  9740. * `newDataAnnounce` string will be used.
  9741. */
  9742. announceNewData?: LangAccessibilityAnnounceNewDataOptions;
  9743. /**
  9744. * (Highcharts, Highstock, Highmaps, Gantt) Axis description format strings.
  9745. */
  9746. axis?: LangAccessibilityAxisOptions;
  9747. chartContainerLabel?: string;
  9748. /**
  9749. * (Highcharts, Highstock, Highmaps, Gantt) Chart type description strings.
  9750. * This is added to the chart information region.
  9751. *
  9752. * If there is only a single series type used in the chart, we use the
  9753. * format string for the series type, or default if missing. There is one
  9754. * format string for cases where there is only a single series in the chart,
  9755. * and one for multiple series of the same type.
  9756. */
  9757. chartTypes?: LangAccessibilityChartTypesOptions;
  9758. credits?: string;
  9759. defaultChartTitle?: string;
  9760. drillUpButton?: string;
  9761. /**
  9762. * (Highcharts, Highstock, Highmaps, Gantt) Exporting menu format strings
  9763. * for accessibility module.
  9764. */
  9765. exporting?: LangAccessibilityExportingOptions;
  9766. /**
  9767. * (Highcharts, Highstock, Highmaps, Gantt) Set a label on the container
  9768. * wrapping the SVG.
  9769. */
  9770. graphicContainerLabel?: string;
  9771. /**
  9772. * (Highcharts, Highstock, Highmaps, Gantt) Language options for
  9773. * accessibility of the legend.
  9774. */
  9775. legend?: LangAccessibilityLegendOptions;
  9776. /**
  9777. * (Highcharts, Highstock, Highmaps, Gantt) Range selector language options
  9778. * for accessibility.
  9779. */
  9780. rangeSelector?: LangAccessibilityRangeSelectorOptions;
  9781. /**
  9782. * (Highcharts, Highstock, Highmaps, Gantt) Language options for the screen
  9783. * reader information sections added before and after the charts.
  9784. */
  9785. screenReaderSection?: LangAccessibilityScreenReaderSectionOptions;
  9786. /**
  9787. * (Highcharts, Highstock, Highmaps, Gantt) Lang configuration for different
  9788. * series types. For more dynamic control over the series element
  9789. * descriptions, see accessibility.seriesDescriptionFormatter.
  9790. */
  9791. series?: LangAccessibilitySeriesOptions;
  9792. /**
  9793. * (Highcharts, Highstock, Highmaps, Gantt) Descriptions of lesser known
  9794. * series types. The relevant description is added to the screen reader
  9795. * information region when these series types are used.
  9796. */
  9797. seriesTypeDescriptions?: LangAccessibilitySeriesTypeDescriptionsOptions;
  9798. /**
  9799. * (Highcharts, Highstock, Highmaps, Gantt) Language options for
  9800. * sonification.
  9801. */
  9802. sonification?: LangAccessibilitySonificationOptions;
  9803. svgContainerLabel?: string;
  9804. /**
  9805. * (Highcharts, Highstock, Highmaps, Gantt) Title element text for the chart
  9806. * SVG element. Leave this empty to disable adding the title element.
  9807. * Browsers will display this content when hovering over elements in the
  9808. * chart. Assistive technology may use this element to label the chart.
  9809. */
  9810. svgContainerTitle?: string;
  9811. /**
  9812. * (Highcharts, Highstock, Highmaps, Gantt) Accessibility language options
  9813. * for the data table.
  9814. */
  9815. table?: LangAccessibilityTableOptions;
  9816. /**
  9817. * (Highcharts, Highstock, Highmaps, Gantt) Thousands separator to use when
  9818. * formatting numbers for screen readers. Note that many screen readers will
  9819. * not handle space as a thousands separator, and will consider "11 700" as
  9820. * two numbers.
  9821. *
  9822. * Set to `null` to use the separator defined in lang.thousandsSep.
  9823. */
  9824. thousandsSep?: string;
  9825. /**
  9826. * (Highcharts, Highstock, Highmaps, Gantt) Chart and map zoom accessibility
  9827. * language options.
  9828. */
  9829. zoom?: LangAccessibilityZoomOptions;
  9830. }
  9831. /**
  9832. * (Highcharts, Highstock, Highmaps, Gantt) Range selector language options for
  9833. * accessibility.
  9834. */
  9835. export interface LangAccessibilityRangeSelectorOptions {
  9836. clickButtonAnnouncement?: string;
  9837. dropdownLabel?: string;
  9838. maxInputLabel?: string;
  9839. minInputLabel?: string;
  9840. }
  9841. /**
  9842. * (Highcharts, Highstock, Highmaps, Gantt) Language options for annotation
  9843. * descriptions.
  9844. */
  9845. export interface LangAccessibilityScreenReaderSectionAnnotationsOptions {
  9846. descriptionMultiplePoints?: string;
  9847. descriptionNoPoints?: string;
  9848. descriptionSinglePoint?: string;
  9849. heading?: string;
  9850. }
  9851. /**
  9852. * (Highcharts, Highstock, Highmaps, Gantt) Language options for the screen
  9853. * reader information sections added before and after the charts.
  9854. */
  9855. export interface LangAccessibilityScreenReaderSectionOptions {
  9856. afterRegionLabel?: string;
  9857. /**
  9858. * (Highcharts, Highstock, Highmaps, Gantt) Language options for annotation
  9859. * descriptions.
  9860. */
  9861. annotations?: LangAccessibilityScreenReaderSectionAnnotationsOptions;
  9862. beforeRegionLabel?: string;
  9863. /**
  9864. * (Highcharts, Highstock, Highmaps, Gantt) Label for the end of the chart.
  9865. * Announced by screen readers.
  9866. */
  9867. endOfChartMarker?: string;
  9868. }
  9869. /**
  9870. * (Highcharts, Highstock, Highmaps, Gantt) Lang configuration for different
  9871. * series types. For more dynamic control over the series element descriptions,
  9872. * see accessibility.seriesDescriptionFormatter.
  9873. */
  9874. export interface LangAccessibilitySeriesOptions {
  9875. /**
  9876. * (Highcharts, Highstock, Highmaps, Gantt) User supplied description text.
  9877. * This is added in the point comment description by default if present.
  9878. */
  9879. description?: string;
  9880. /**
  9881. * (Highcharts, Highstock, Highmaps, Gantt) Description for the value of
  9882. * null points.
  9883. */
  9884. nullPointValue?: string;
  9885. /**
  9886. * (Highcharts, Highstock, Highmaps, Gantt) Description for annotations on a
  9887. * point, as it is made available to assistive technology.
  9888. */
  9889. pointAnnotationsDescription?: string;
  9890. /**
  9891. * (Highcharts, Highstock, Highmaps, Gantt) Lang configuration for the
  9892. * series main summary. Each series type has two modes:
  9893. *
  9894. * 1. This series type is the only series type used in the chart
  9895. *
  9896. * 2. This is a combination chart with multiple series types
  9897. *
  9898. * If a definition does not exist for the specific series type and mode, the
  9899. * 'default' lang definitions are used.
  9900. */
  9901. summary?: LangAccessibilitySeriesSummaryOptions;
  9902. /**
  9903. * (Highcharts, Highstock, Highmaps, Gantt) xAxis description for series if
  9904. * there are multiple xAxes in the chart.
  9905. */
  9906. xAxisDescription?: string;
  9907. /**
  9908. * (Highcharts, Highstock, Highmaps, Gantt) yAxis description for series if
  9909. * there are multiple yAxes in the chart.
  9910. */
  9911. yAxisDescription?: string;
  9912. }
  9913. /**
  9914. * (Highcharts, Highstock, Highmaps, Gantt) Lang configuration for the series
  9915. * main summary. Each series type has two modes:
  9916. *
  9917. * 1. This series type is the only series type used in the chart
  9918. *
  9919. * 2. This is a combination chart with multiple series types
  9920. *
  9921. * If a definition does not exist for the specific series type and mode, the
  9922. * 'default' lang definitions are used.
  9923. */
  9924. export interface LangAccessibilitySeriesSummaryOptions {
  9925. bar?: string;
  9926. barCombination?: string;
  9927. boxplot?: string;
  9928. boxplotCombination?: string;
  9929. bubble?: string;
  9930. bubbleCombination?: string;
  9931. column?: string;
  9932. columnCombination?: string;
  9933. default?: string;
  9934. defaultCombination?: string;
  9935. line?: string;
  9936. lineCombination?: string;
  9937. map?: string;
  9938. mapbubble?: string;
  9939. mapbubbleCombination?: string;
  9940. mapCombination?: string;
  9941. mapline?: string;
  9942. maplineCombination?: string;
  9943. pie?: string;
  9944. pieCombination?: string;
  9945. scatter?: string;
  9946. scatterCombination?: string;
  9947. spline?: string;
  9948. splineCombination?: string;
  9949. }
  9950. /**
  9951. * (Highcharts, Highstock, Highmaps, Gantt) Descriptions of lesser known series
  9952. * types. The relevant description is added to the screen reader information
  9953. * region when these series types are used.
  9954. */
  9955. export interface LangAccessibilitySeriesTypeDescriptionsOptions {
  9956. arearange?: string;
  9957. areasplinerange?: string;
  9958. boxplot?: string;
  9959. bubble?: string;
  9960. columnrange?: string;
  9961. errorbar?: string;
  9962. funnel?: string;
  9963. pyramid?: string;
  9964. waterfall?: string;
  9965. }
  9966. /**
  9967. * (Highcharts, Highstock, Highmaps, Gantt) Language options for sonification.
  9968. */
  9969. export interface LangAccessibilitySonificationOptions {
  9970. playAsSoundButtonText?: string;
  9971. playAsSoundClickAnnouncement?: string;
  9972. }
  9973. /**
  9974. * (Highcharts, Highstock, Highmaps, Gantt) Accessibility language options for
  9975. * the data table.
  9976. */
  9977. export interface LangAccessibilityTableOptions {
  9978. tableSummary?: string;
  9979. viewAsDataTableButtonText?: string;
  9980. }
  9981. /**
  9982. * (Highcharts, Highstock, Highmaps, Gantt) Chart and map zoom accessibility
  9983. * language options.
  9984. */
  9985. export interface LangAccessibilityZoomOptions {
  9986. mapZoomIn?: string;
  9987. mapZoomOut?: string;
  9988. resetZoomButton?: string;
  9989. }
  9990. /**
  9991. * (Highcharts, Highstock, Highmaps, Gantt) The text for exported table.
  9992. */
  9993. export interface LangExportDataOptions {
  9994. /**
  9995. * (Highcharts, Highstock, Highmaps, Gantt) The annotation column title.
  9996. */
  9997. annotationHeader?: string;
  9998. /**
  9999. * (Highcharts, Highstock, Highmaps, Gantt) The category column title when
  10000. * axis type set to "datetime".
  10001. */
  10002. categoryDatetimeHeader?: string;
  10003. /**
  10004. * (Highcharts, Highstock, Highmaps, Gantt) The category column title.
  10005. */
  10006. categoryHeader?: string;
  10007. }
  10008. /**
  10009. * (Highcharts, Highstock) Configure the Popup strings in the chart. Requires
  10010. * the `annotations.js` or `annotations-advanced.src.js` module to be loaded.
  10011. */
  10012. export interface LangNavigationOptions {
  10013. /**
  10014. * (Highcharts, Highstock) Translations for all field names used in popup.
  10015. */
  10016. popup?: LangNavigationPopupOptions;
  10017. }
  10018. /**
  10019. * (Highcharts, Highstock) Translations for all field names used in popup.
  10020. */
  10021. export interface LangNavigationPopupOptions {
  10022. addButton?: string;
  10023. arrowLine?: string;
  10024. arrowRay?: string;
  10025. arrowSegment?: string;
  10026. background?: string;
  10027. backgroundColor?: string;
  10028. backgroundColors?: string;
  10029. borderColor?: string;
  10030. borderRadius?: string;
  10031. borderWidth?: string;
  10032. circle?: string;
  10033. color?: string;
  10034. connector?: string;
  10035. crooked3?: string;
  10036. crooked5?: string;
  10037. crosshairX?: string;
  10038. crosshairY?: string;
  10039. editButton?: string;
  10040. elliott3?: string;
  10041. elliott5?: string;
  10042. fibonacci?: string;
  10043. fill?: string;
  10044. flags?: string;
  10045. fontSize?: string;
  10046. format?: string;
  10047. height?: string;
  10048. horizontalLine?: string;
  10049. infinityLine?: string;
  10050. innerBackground?: string;
  10051. label?: string;
  10052. labelOptions?: string;
  10053. labels?: string;
  10054. line?: string;
  10055. lines?: string;
  10056. measure?: string;
  10057. measureX?: string;
  10058. measureXY?: string;
  10059. measureY?: string;
  10060. name?: string;
  10061. outerBackground?: string;
  10062. padding?: string;
  10063. parallelChannel?: string;
  10064. pitchfork?: string;
  10065. ray?: string;
  10066. rectangle?: string;
  10067. removeButton?: string;
  10068. saveButton?: string;
  10069. segment?: string;
  10070. series?: string;
  10071. shapeOptions?: string;
  10072. shapes?: string;
  10073. simpleShapes?: string;
  10074. stroke?: string;
  10075. strokeWidth?: string;
  10076. style?: string;
  10077. title?: string;
  10078. tunnel?: string;
  10079. typeOptions?: string;
  10080. verticalArrow?: string;
  10081. verticalCounter?: string;
  10082. verticalLabel?: string;
  10083. verticalLine?: string;
  10084. volume?: string;
  10085. }
  10086. /**
  10087. * (Highcharts, Highstock, Highmaps, Gantt) Language object. The language object
  10088. * is global and it can't be set on each chart initialization. Instead, use
  10089. * `Highcharts.setOptions` to set it before any chart is initialized. (see
  10090. * online documentation for example)
  10091. */
  10092. export interface LangOptions {
  10093. /**
  10094. * (Highcharts, Highstock, Highmaps, Gantt) Configure the accessibility
  10095. * strings in the chart. Requires the accessibility module to be loaded. For
  10096. * a description of the module and information on its features, see
  10097. * Highcharts Accessibility.
  10098. *
  10099. * For more dynamic control over the accessibility functionality, see
  10100. * accessibility.pointDescriptionFormatter,
  10101. * accessibility.seriesDescriptionFormatter, and
  10102. * accessibility.screenReaderSectionFormatter.
  10103. */
  10104. accessibility?: LangAccessibilityOptions;
  10105. /**
  10106. * (Highcharts, Highstock, Highmaps, Gantt) Exporting module menu. The
  10107. * tooltip title for the context menu holding print and export menu items.
  10108. */
  10109. contextButtonTitle?: string;
  10110. /**
  10111. * (Highcharts, Highstock, Highmaps, Gantt) The default decimal point used
  10112. * in the `Highcharts.numberFormat` method unless otherwise specified in the
  10113. * function arguments.
  10114. */
  10115. decimalPoint?: string;
  10116. /**
  10117. * (Highcharts, Highstock, Highmaps, Gantt) The text for the menu item.
  10118. */
  10119. downloadCSV?: string;
  10120. /**
  10121. * (Highcharts, Highstock, Highmaps, Gantt) Exporting module only. The text
  10122. * for the JPEG download menu item.
  10123. */
  10124. downloadJPEG?: string;
  10125. /**
  10126. * (Highcharts, Highstock, Highmaps, Gantt) Exporting module only. The text
  10127. * for the PDF download menu item.
  10128. */
  10129. downloadPDF?: string;
  10130. /**
  10131. * (Highcharts, Highstock, Highmaps, Gantt) Exporting module only. The text
  10132. * for the PNG download menu item.
  10133. */
  10134. downloadPNG?: string;
  10135. /**
  10136. * (Highcharts, Highstock, Highmaps, Gantt) Exporting module only. The text
  10137. * for the SVG download menu item.
  10138. */
  10139. downloadSVG?: string;
  10140. /**
  10141. * (Highcharts, Highstock, Highmaps, Gantt) The text for the menu item.
  10142. */
  10143. downloadXLS?: string;
  10144. /**
  10145. * (Highcharts, Highmaps) The text for the button that appears when drilling
  10146. * down, linking back to the parent series. The parent series' name is
  10147. * inserted for `{series.name}`.
  10148. */
  10149. drillUpText?: string;
  10150. /**
  10151. * (Highcharts, Highstock, Highmaps, Gantt) Exporting module only. The text
  10152. * for the menu item to exit the chart from full screen.
  10153. */
  10154. exitFullscreen?: string;
  10155. /**
  10156. * (Highcharts, Highstock, Highmaps, Gantt) The text for exported table.
  10157. */
  10158. exportData?: LangExportDataOptions;
  10159. /**
  10160. * (Highcharts, Highstock, Highmaps, Gantt) The text for the menu item.
  10161. */
  10162. hideData?: string;
  10163. /**
  10164. * (Highcharts, Highstock) What to show in a date field for invalid dates.
  10165. * Defaults to an empty string.
  10166. */
  10167. invalidDate?: string;
  10168. /**
  10169. * (Highcharts, Highstock, Highmaps, Gantt) The loading text that appears
  10170. * when the chart is set into the loading state following a call to
  10171. * `chart.showLoading`.
  10172. */
  10173. loading?: string;
  10174. /**
  10175. * (Highcharts, Highstock, Highmaps, Gantt) An array containing the months
  10176. * names. Corresponds to the `%B` format in `Highcharts.dateFormat()`.
  10177. */
  10178. months?: Array<string>;
  10179. /**
  10180. * (Highcharts, Highstock) Configure the Popup strings in the chart.
  10181. * Requires the `annotations.js` or `annotations-advanced.src.js` module to
  10182. * be loaded.
  10183. */
  10184. navigation?: LangNavigationOptions;
  10185. /**
  10186. * (Highcharts, Highstock) The text to display when the chart contains no
  10187. * data.
  10188. */
  10189. noData?: string;
  10190. /**
  10191. * (Highcharts, Highstock, Highmaps, Gantt) The magnitude of numericSymbols
  10192. * replacements. Use 10000 for Japanese, Korean and various Chinese locales,
  10193. * which use symbols for 10^4, 10^8 and 10^12.
  10194. */
  10195. numericSymbolMagnitude?: number;
  10196. /**
  10197. * (Highcharts, Highstock, Highmaps, Gantt) Metric prefixes used to shorten
  10198. * high numbers in axis labels. Replacing any of the positions with `null`
  10199. * causes the full number to be written. Setting `numericSymbols` to `null`
  10200. * disables shortening altogether.
  10201. */
  10202. numericSymbols?: Array<string>;
  10203. /**
  10204. * (Highcharts, Highstock, Highmaps, Gantt) Exporting module only. The text
  10205. * for the menu item to print the chart.
  10206. */
  10207. printChart?: string;
  10208. /**
  10209. * (Highstock, Gantt) The text for the label for the "from" input box in the
  10210. * range selector. Since v9.0, this string is empty as the label is not
  10211. * rendered by default.
  10212. */
  10213. rangeSelectorFrom?: string;
  10214. /**
  10215. * (Highstock, Gantt) The text for the label for the "to" input box in the
  10216. * range selector.
  10217. */
  10218. rangeSelectorTo?: string;
  10219. /**
  10220. * (Highstock, Gantt) The text for the label for the range selector buttons.
  10221. */
  10222. rangeSelectorZoom?: string;
  10223. /**
  10224. * (Highcharts, Highstock, Highmaps, Gantt) The text for the label appearing
  10225. * when a chart is zoomed.
  10226. */
  10227. resetZoom?: string;
  10228. /**
  10229. * (Highcharts, Highstock, Highmaps, Gantt) The tooltip title for the label
  10230. * appearing when a chart is zoomed.
  10231. */
  10232. resetZoomTitle?: string;
  10233. /**
  10234. * (Highcharts, Highstock, Highmaps, Gantt) An array containing the months
  10235. * names in abbreviated form. Corresponds to the `%b` format in
  10236. * `Highcharts.dateFormat()`.
  10237. */
  10238. shortMonths?: Array<string>;
  10239. /**
  10240. * (Highcharts, Highstock, Highmaps, Gantt) Short week days, starting
  10241. * Sunday. If not specified, Highcharts uses the first three letters of the
  10242. * `lang.weekdays` option.
  10243. */
  10244. shortWeekdays?: Array<string>;
  10245. /**
  10246. * (Highstock) Configure the stockTools GUI titles(hints) in the chart.
  10247. * Requires the `stock-tools.js` module to be loaded.
  10248. */
  10249. stockTools?: LangStockToolsOptions;
  10250. /**
  10251. * (Highcharts, Highstock, Highmaps, Gantt) The default thousands separator
  10252. * used in the `Highcharts.numberFormat` method unless otherwise specified
  10253. * in the function arguments. Defaults to a single space character, which is
  10254. * recommended in ISO 31-0 and works across Anglo-American and continental
  10255. * European languages.
  10256. */
  10257. thousandsSep?: string;
  10258. /**
  10259. * (Highcharts, Highstock, Highmaps, Gantt) The text for the menu item.
  10260. */
  10261. viewData?: string;
  10262. /**
  10263. * (Highcharts, Highstock, Highmaps, Gantt) Exporting module only. The text
  10264. * for the menu item to view the chart in full screen.
  10265. */
  10266. viewFullscreen?: string;
  10267. /**
  10268. * (Highcharts, Highstock, Highmaps, Gantt) An array containing the weekday
  10269. * names.
  10270. */
  10271. weekdays?: Array<string>;
  10272. /**
  10273. * (Highmaps) The title appearing on hovering the zoom in button. The text
  10274. * itself defaults to "+" and can be changed in the button options.
  10275. */
  10276. zoomIn?: string;
  10277. /**
  10278. * (Highmaps) The title appearing on hovering the zoom out button. The text
  10279. * itself defaults to "-" and can be changed in the button options.
  10280. */
  10281. zoomOut?: string;
  10282. }
  10283. export interface LangStockToolsGuiOptions {
  10284. advanced?: string;
  10285. arrowLine?: string;
  10286. arrowRay?: string;
  10287. arrowSegment?: string;
  10288. circle?: string;
  10289. crooked3?: string;
  10290. crooked5?: string;
  10291. crookedLines?: string;
  10292. currentPriceIndicator?: string;
  10293. elliott3?: string;
  10294. elliott5?: string;
  10295. fibonacci?: string;
  10296. flagCirclepin?: string;
  10297. flagDiamondpin?: string;
  10298. flags?: string;
  10299. flagSimplepin?: string;
  10300. flagSquarepin?: string;
  10301. fullScreen?: string;
  10302. horizontalLine?: string;
  10303. indicators?: string;
  10304. infinityLine?: string;
  10305. label?: string;
  10306. line?: string;
  10307. lines?: string;
  10308. measure?: string;
  10309. measureX?: string;
  10310. measureXY?: string;
  10311. measureY?: string;
  10312. parallelChannel?: string;
  10313. pitchfork?: string;
  10314. ray?: string;
  10315. rectangle?: string;
  10316. saveChart?: string;
  10317. segment?: string;
  10318. simpleShapes?: string;
  10319. toggleAnnotations?: string;
  10320. typeCandlestick?: string;
  10321. typeChange?: string;
  10322. typeLine?: string;
  10323. typeOHLC?: string;
  10324. verticalArrow?: string;
  10325. verticalCounter?: string;
  10326. verticalLabel?: string;
  10327. verticalLabels?: string;
  10328. verticalLine?: string;
  10329. zoomChange?: string;
  10330. zoomX?: string;
  10331. zoomXY?: string;
  10332. zoomY?: string;
  10333. }
  10334. /**
  10335. * (Highstock) Configure the stockTools GUI titles(hints) in the chart. Requires
  10336. * the `stock-tools.js` module to be loaded.
  10337. */
  10338. export interface LangStockToolsOptions {
  10339. gui?: LangStockToolsGuiOptions;
  10340. }
  10341. /**
  10342. * (Highcharts, Highstock, Highmaps, Gantt) Options for keyboard navigation for
  10343. * the legend.
  10344. */
  10345. export interface LegendAccessibilityKeyboardNavigationOptions {
  10346. /**
  10347. * (Highcharts, Highstock, Highmaps, Gantt) Enable keyboard navigation for
  10348. * the legend.
  10349. */
  10350. enabled?: boolean;
  10351. }
  10352. /**
  10353. * (Highcharts, Highstock, Highmaps, Gantt) Accessibility options for the
  10354. * legend. Requires the Accessibility module.
  10355. */
  10356. export interface LegendAccessibilityOptions {
  10357. /**
  10358. * (Highcharts, Highstock, Highmaps, Gantt) Enable accessibility support for
  10359. * the legend.
  10360. */
  10361. enabled?: boolean;
  10362. /**
  10363. * (Highcharts, Highstock, Highmaps, Gantt) Options for keyboard navigation
  10364. * for the legend.
  10365. */
  10366. keyboardNavigation?: LegendAccessibilityKeyboardNavigationOptions;
  10367. }
  10368. /**
  10369. * (Highcharts, Highstock, Highmaps) Options for the bubble legend labels.
  10370. */
  10371. export interface LegendBubbleLegendLabelsOptions {
  10372. /**
  10373. * (Highcharts, Highstock, Highmaps) The alignment of the labels compared to
  10374. * the bubble legend. Can be one of `left`, `center` or `right`.
  10375. */
  10376. align?: AlignValue;
  10377. /**
  10378. * (Highcharts, Highstock, Highmaps) Whether to allow data labels to
  10379. * overlap.
  10380. */
  10381. allowOverlap?: boolean;
  10382. /**
  10383. * (Highcharts, Highstock, Highmaps) An additional class name to apply to
  10384. * the bubble legend label graphical elements. This option does not replace
  10385. * default class names of the graphical element.
  10386. */
  10387. className?: string;
  10388. /**
  10389. * (Highcharts, Highstock, Highmaps) A format string for the bubble legend
  10390. * labels. Available variables are the same as for `formatter`.
  10391. */
  10392. format?: string;
  10393. /**
  10394. * (Highcharts, Highstock, Highmaps) Available `this` properties are:
  10395. *
  10396. * - `this.value`: The bubble value.
  10397. *
  10398. * - `this.radius`: The radius of the bubble range.
  10399. *
  10400. * - `this.center`: The center y position of the range.
  10401. */
  10402. formatter?: FormatterCallbackFunction<BubbleLegendFormatterContextObject>;
  10403. /**
  10404. * (Highcharts, Highstock, Highmaps) CSS styles for the labels.
  10405. */
  10406. style?: CSSObject;
  10407. /**
  10408. * (Highcharts, Highstock, Highmaps) The x position offset of the label
  10409. * relative to the connector.
  10410. */
  10411. x?: number;
  10412. /**
  10413. * (Highcharts, Highstock, Highmaps) The y position offset of the label
  10414. * relative to the connector.
  10415. */
  10416. y?: number;
  10417. }
  10418. /**
  10419. * (Highcharts, Highstock, Highmaps) The bubble legend is an additional element
  10420. * in legend which presents the scale of the bubble series. Individual bubble
  10421. * ranges can be defined by user or calculated from series. In the case of
  10422. * automatically calculated ranges, a 1px margin of error is permitted.
  10423. */
  10424. export interface LegendBubbleLegendOptions {
  10425. /**
  10426. * (Highcharts, Highstock, Highmaps) The color of the ranges borders, can be
  10427. * also defined for an individual range.
  10428. */
  10429. borderColor?: (ColorString|GradientColorObject|PatternObject);
  10430. /**
  10431. * (Highcharts, Highstock, Highmaps) The width of the ranges borders in
  10432. * pixels, can be also defined for an individual range.
  10433. */
  10434. borderWidth?: number;
  10435. /**
  10436. * (Highcharts, Highstock, Highmaps) An additional class name to apply to
  10437. * the bubble legend' circle graphical elements. This option does not
  10438. * replace default class names of the graphical element.
  10439. */
  10440. className?: string;
  10441. /**
  10442. * (Highcharts, Highstock, Highmaps) The main color of the bubble legend.
  10443. * Applies to ranges, if individual color is not defined.
  10444. */
  10445. color?: (ColorString|GradientColorObject|PatternObject);
  10446. /**
  10447. * (Highcharts, Highstock, Highmaps) An additional class name to apply to
  10448. * the bubble legend's connector graphical elements. This option does not
  10449. * replace default class names of the graphical element.
  10450. */
  10451. connectorClassName?: string;
  10452. /**
  10453. * (Highcharts, Highstock, Highmaps) The color of the connector, can be also
  10454. * defined for an individual range.
  10455. */
  10456. connectorColor?: (ColorString|GradientColorObject|PatternObject);
  10457. /**
  10458. * (Highcharts, Highstock, Highmaps) The length of the connectors in pixels.
  10459. * If labels are centered, the distance is reduced to 0.
  10460. */
  10461. connectorDistance?: number;
  10462. /**
  10463. * (Highcharts, Highstock, Highmaps) The width of the connectors in pixels.
  10464. */
  10465. connectorWidth?: number;
  10466. /**
  10467. * (Highcharts, Highstock, Highmaps) Enable or disable the bubble legend.
  10468. */
  10469. enabled?: boolean;
  10470. /**
  10471. * (Highcharts, Highstock, Highmaps) Options for the bubble legend labels.
  10472. */
  10473. labels?: LegendBubbleLegendLabelsOptions;
  10474. /**
  10475. * (Highcharts, Highstock, Highmaps) The position of the bubble legend in
  10476. * the legend.
  10477. */
  10478. legendIndex?: number;
  10479. /**
  10480. * (Highcharts, Highstock, Highmaps) Miximum bubble legend range size. If
  10481. * values for ranges are not specified, the `minSize` and the `maxSize` are
  10482. * calculated from bubble series.
  10483. */
  10484. maxSize?: number;
  10485. /**
  10486. * (Highcharts, Highstock, Highmaps) Minimum bubble legend range size. If
  10487. * values for ranges are not specified, the `minSize` and the `maxSize` are
  10488. * calculated from bubble series.
  10489. */
  10490. minSize?: number;
  10491. /**
  10492. * (Highcharts, Highstock, Highmaps) Options for specific range. One range
  10493. * consists of bubble, label and connector.
  10494. */
  10495. ranges?: Array<LegendBubbleLegendRangesOptions>;
  10496. /**
  10497. * (Highcharts, Highstock, Highmaps) Whether the bubble legend range value
  10498. * should be represented by the area or the width of the bubble. The
  10499. * default, area, corresponds best to the human perception of the size of
  10500. * each bubble.
  10501. */
  10502. sizeBy?: BubbleSizeByValue;
  10503. /**
  10504. * (Highcharts, Highstock, Highmaps) When this is true, the absolute value
  10505. * of z determines the size of the bubble. This means that with the default
  10506. * zThreshold of 0, a bubble of value -1 will have the same size as a bubble
  10507. * of value 1, while a bubble of value 0 will have a smaller size according
  10508. * to minSize.
  10509. */
  10510. sizeByAbsoluteValue?: boolean;
  10511. /**
  10512. * (Highcharts, Highstock, Highmaps) Define the visual z index of the bubble
  10513. * legend.
  10514. */
  10515. zIndex?: number;
  10516. /**
  10517. * (Highcharts, Highstock, Highmaps) Ranges with with lower value than
  10518. * zThreshold, are skipped.
  10519. */
  10520. zThreshold?: number;
  10521. }
  10522. /**
  10523. * (Highcharts, Highstock, Highmaps) Options for specific range. One range
  10524. * consists of bubble, label and connector.
  10525. */
  10526. export interface LegendBubbleLegendRangesOptions {
  10527. /**
  10528. * (Highcharts, Highstock, Highmaps) The color of the border for individual
  10529. * range.
  10530. */
  10531. borderColor?: (ColorString|GradientColorObject|PatternObject);
  10532. /**
  10533. * (Highcharts, Highstock, Highmaps) The color of the bubble for individual
  10534. * range.
  10535. */
  10536. color?: (ColorString|GradientColorObject|PatternObject);
  10537. /**
  10538. * (Highcharts, Highstock, Highmaps) The color of the connector for
  10539. * individual range.
  10540. */
  10541. connectorColor?: (ColorString|GradientColorObject|PatternObject);
  10542. /**
  10543. * (Highcharts, Highstock, Highmaps) Range size value, similar to bubble Z
  10544. * data.
  10545. */
  10546. value?: number;
  10547. }
  10548. /**
  10549. * (Highcharts, Highstock, Highmaps, Gantt) Options for the paging or navigation
  10550. * appearing when the legend is overflown. Navigation works well on screen, but
  10551. * not in static exported images. One way of working around that is to increase
  10552. * the chart height in export.
  10553. */
  10554. export interface LegendNavigationOptions {
  10555. /**
  10556. * (Highcharts, Highstock, Highmaps, Gantt) The color for the active up or
  10557. * down arrow in the legend page navigation.
  10558. */
  10559. activeColor?: (ColorString|GradientColorObject|PatternObject);
  10560. /**
  10561. * (Highcharts, Highstock, Highmaps, Gantt) How to animate the pages when
  10562. * navigating up or down. A value of `true` applies the default navigation
  10563. * given in the `chart.animation` option. Additional options can be given as
  10564. * an object containing values for easing and duration.
  10565. */
  10566. animation?: (boolean|Partial<AnimationOptionsObject>);
  10567. /**
  10568. * (Highcharts, Highstock, Highmaps, Gantt) The pixel size of the up and
  10569. * down arrows in the legend paging navigation.
  10570. */
  10571. arrowSize?: number;
  10572. /**
  10573. * (Highcharts, Highstock, Highmaps, Gantt) Whether to enable the legend
  10574. * navigation. In most cases, disabling the navigation results in an
  10575. * unwanted overflow.
  10576. *
  10577. * See also the adapt chart to legend plugin for a solution to extend the
  10578. * chart height to make room for the legend, optionally in exported charts
  10579. * only.
  10580. */
  10581. enabled?: boolean;
  10582. /**
  10583. * (Highcharts, Highstock, Highmaps, Gantt) The color of the inactive up or
  10584. * down arrow in the legend page navigation. .
  10585. */
  10586. inactiveColor?: (ColorString|GradientColorObject|PatternObject);
  10587. /**
  10588. * (Highcharts, Highstock, Highmaps, Gantt) Text styles for the legend page
  10589. * navigation.
  10590. */
  10591. style?: CSSObject;
  10592. }
  10593. /**
  10594. * (Highcharts, Highstock, Highmaps, Gantt) The legend is a box containing a
  10595. * symbol and name for each series item or point item in the chart. Each series
  10596. * (or points in case of pie charts) is represented by a symbol and its name in
  10597. * the legend.
  10598. *
  10599. * It is possible to override the symbol creator function and create custom
  10600. * legend symbols.
  10601. */
  10602. export interface LegendOptions {
  10603. /**
  10604. * (Highcharts, Highstock, Highmaps, Gantt) Accessibility options for the
  10605. * legend. Requires the Accessibility module.
  10606. */
  10607. accessibility?: LegendAccessibilityOptions;
  10608. /**
  10609. * (Highcharts, Highstock, Highmaps, Gantt) The horizontal alignment of the
  10610. * legend box within the chart area. Valid values are `left`, `center` and
  10611. * `right`.
  10612. *
  10613. * In the case that the legend is aligned in a corner position, the `layout`
  10614. * option will determine whether to place it above/below or on the side of
  10615. * the plot area.
  10616. */
  10617. align?: AlignValue;
  10618. /**
  10619. * (Highcharts, Highstock, Highmaps, Gantt) If the layout is `horizontal`
  10620. * and the legend items span over two lines or more, whether to align the
  10621. * items into vertical columns. Setting this to `false` makes room for more
  10622. * items, but will look more messy.
  10623. */
  10624. alignColumns?: boolean;
  10625. /**
  10626. * (Highcharts, Highstock, Highmaps, Gantt) The background color of the
  10627. * legend.
  10628. */
  10629. backgroundColor?: (ColorString|GradientColorObject|PatternObject);
  10630. /**
  10631. * (Highcharts, Highstock, Highmaps, Gantt) The color of the drawn border
  10632. * around the legend.
  10633. */
  10634. borderColor?: (ColorString|GradientColorObject|PatternObject);
  10635. /**
  10636. * (Highcharts, Highstock, Highmaps, Gantt) The border corner radius of the
  10637. * legend.
  10638. */
  10639. borderRadius?: number;
  10640. /**
  10641. * (Highcharts, Highstock, Highmaps, Gantt) The width of the drawn border
  10642. * around the legend.
  10643. */
  10644. borderWidth?: number;
  10645. /**
  10646. * (Highcharts, Highstock, Highmaps) The bubble legend is an additional
  10647. * element in legend which presents the scale of the bubble series.
  10648. * Individual bubble ranges can be defined by user or calculated from
  10649. * series. In the case of automatically calculated ranges, a 1px margin of
  10650. * error is permitted.
  10651. */
  10652. bubbleLegend?: LegendBubbleLegendOptions;
  10653. /**
  10654. * (Highcharts, Highstock, Highmaps, Gantt) Enable or disable the legend.
  10655. * There is also a series-specific option, showInLegend, that can hide the
  10656. * series from the legend. In some series types this is `false` by default,
  10657. * so it must set to `true` in order to show the legend for the series.
  10658. */
  10659. enabled?: boolean;
  10660. /**
  10661. * (Highcharts, Highstock, Highmaps, Gantt) When the legend is floating, the
  10662. * plot area ignores it and is allowed to be placed below it.
  10663. */
  10664. floating?: boolean;
  10665. /**
  10666. * (Highcharts, Highstock, Highmaps, Gantt) Default styling for the checkbox
  10667. * next to a legend item when `showCheckbox` is true.
  10668. */
  10669. itemCheckboxStyle?: CSSObject;
  10670. /**
  10671. * (Highcharts, Highstock, Highmaps, Gantt) In a legend with horizontal
  10672. * layout, the itemDistance defines the pixel distance between each item.
  10673. */
  10674. itemDistance?: number;
  10675. /**
  10676. * (Highcharts, Highstock, Highmaps, Gantt) CSS styles for each legend item
  10677. * when the corresponding series or point is hidden. Only a subset of CSS is
  10678. * supported, notably those options related to text. Properties are
  10679. * inherited from `style` unless overridden here.
  10680. */
  10681. itemHiddenStyle?: CSSObject;
  10682. /**
  10683. * (Highcharts, Highstock, Highmaps, Gantt) CSS styles for each legend item
  10684. * in hover mode. Only a subset of CSS is supported, notably those options
  10685. * related to text. Properties are inherited from `style` unless overridden
  10686. * here.
  10687. */
  10688. itemHoverStyle?: CSSObject;
  10689. /**
  10690. * (Highcharts, Highstock, Highmaps, Gantt) The pixel bottom margin for each
  10691. * legend item.
  10692. */
  10693. itemMarginBottom?: number;
  10694. /**
  10695. * (Highcharts, Highstock, Highmaps, Gantt) The pixel top margin for each
  10696. * legend item.
  10697. */
  10698. itemMarginTop?: number;
  10699. /**
  10700. * (Highcharts, Highstock, Highmaps, Gantt) CSS styles for each legend item.
  10701. * Only a subset of CSS is supported, notably those options related to text.
  10702. * The default `textOverflow` property makes long texts truncate. Set it to
  10703. * `undefined` to wrap text instead. A `width` property can be added to
  10704. * control the text width.
  10705. */
  10706. itemStyle?: CSSObject;
  10707. /**
  10708. * (Highcharts, Highstock, Highmaps, Gantt) The width for each legend item.
  10709. * By default the items are laid out successively. In a horizontal layout,
  10710. * if the items are laid out across two rows or more, they will be
  10711. * vertically aligned depending on the legend.alignColumns option.
  10712. */
  10713. itemWidth?: number;
  10714. /**
  10715. * (Highcharts, Highstock, Highmaps, Gantt) A format string for each legend
  10716. * label. Available variables relates to properties on the series, or the
  10717. * point in case of pies.
  10718. */
  10719. labelFormat?: string;
  10720. /**
  10721. * (Highcharts, Highstock, Highmaps, Gantt) Callback function to format each
  10722. * of the series' labels. The `this` keyword refers to the series object, or
  10723. * the point object in case of pie charts. By default the series or point
  10724. * name is printed.
  10725. */
  10726. labelFormatter?: FormatterCallbackFunction<(Point|Series)>;
  10727. /**
  10728. * (Highcharts, Highstock, Highmaps, Gantt) The layout of the legend items.
  10729. * Can be one of `horizontal` or `vertical` or `proximate`. When
  10730. * `proximate`, the legend items will be placed as close as possible to the
  10731. * graphs they're representing, except in inverted charts or when the legend
  10732. * position doesn't allow it.
  10733. */
  10734. layout?: OptionsLayoutValue;
  10735. /**
  10736. * (Highcharts, Highstock, Highmaps, Gantt) If the plot area sized is
  10737. * calculated automatically and the legend is not floating, the legend
  10738. * margin is the space between the legend and the axis labels or plot area.
  10739. */
  10740. margin?: number;
  10741. /**
  10742. * (Highcharts, Highstock, Highmaps, Gantt) Maximum pixel height for the
  10743. * legend. When the maximum height is extended, navigation will show.
  10744. */
  10745. maxHeight?: number;
  10746. /**
  10747. * (Highcharts, Highstock, Highmaps, Gantt) Options for the paging or
  10748. * navigation appearing when the legend is overflown. Navigation works well
  10749. * on screen, but not in static exported images. One way of working around
  10750. * that is to increase the chart height in export.
  10751. */
  10752. navigation?: LegendNavigationOptions;
  10753. /**
  10754. * (Highcharts, Highstock, Highmaps, Gantt) The inner padding of the legend
  10755. * box.
  10756. */
  10757. padding?: number;
  10758. /**
  10759. * (Highcharts, Highstock, Highmaps, Gantt) Whether to reverse the order of
  10760. * the legend items compared to the order of the series or points as defined
  10761. * in the configuration object.
  10762. */
  10763. reversed?: boolean;
  10764. /**
  10765. * (Highcharts, Highstock, Highmaps, Gantt) Whether to show the symbol on
  10766. * the right side of the text rather than the left side. This is common in
  10767. * Arabic and Hebraic.
  10768. */
  10769. rtl?: boolean;
  10770. /**
  10771. * (Highcharts, Highstock, Highmaps, Gantt) Whether to apply a drop shadow
  10772. * to the legend. A `backgroundColor` also needs to be applied for this to
  10773. * take effect. The shadow can be an object configuration containing
  10774. * `color`, `offsetX`, `offsetY`, `opacity` and `width`.
  10775. */
  10776. shadow?: (boolean|CSSObject);
  10777. /**
  10778. * (Highcharts, Highstock, Highmaps, Gantt) When this is true, the legend
  10779. * symbol width will be the same as the symbol height, which in turn
  10780. * defaults to the font size of the legend items.
  10781. */
  10782. squareSymbol?: boolean;
  10783. /**
  10784. * (Highcharts, Highstock, Highmaps, Gantt) The pixel height of the symbol
  10785. * for series types that use a rectangle in the legend. Defaults to the font
  10786. * size of legend items.
  10787. */
  10788. symbolHeight?: number;
  10789. /**
  10790. * (Highcharts, Highstock, Highmaps, Gantt) The pixel padding between the
  10791. * legend item symbol and the legend item text.
  10792. */
  10793. symbolPadding?: number;
  10794. /**
  10795. * (Highcharts, Highstock, Highmaps, Gantt) The border radius of the symbol
  10796. * for series types that use a rectangle in the legend. Defaults to half the
  10797. * `symbolHeight`.
  10798. */
  10799. symbolRadius?: number;
  10800. /**
  10801. * (Highcharts, Highstock, Highmaps, Gantt) The pixel width of the legend
  10802. * item symbol. When the `squareSymbol` option is set, this defaults to the
  10803. * `symbolHeight`, otherwise 16.
  10804. */
  10805. symbolWidth?: number;
  10806. /**
  10807. * (Highcharts, Highstock, Highmaps, Gantt) A title to be added on top of
  10808. * the legend.
  10809. */
  10810. title?: LegendTitleOptions;
  10811. /**
  10812. * (Highcharts, Highstock, Highmaps, Gantt) Whether to use HTML to render
  10813. * the legend item texts.
  10814. *
  10815. * Prior to 4.1.7, when using HTML, legend.navigation was disabled.
  10816. */
  10817. useHTML?: boolean;
  10818. /**
  10819. * (Highcharts, Highstock, Highmaps, Gantt) The vertical alignment of the
  10820. * legend box. Can be one of `top`, `middle` or `bottom`. Vertical position
  10821. * can be further determined by the `y` option.
  10822. *
  10823. * In the case that the legend is aligned in a corner position, the `layout`
  10824. * option will determine whether to place it above/below or on the side of
  10825. * the plot area.
  10826. *
  10827. * When the layout option is `proximate`, the `verticalAlign` option doesn't
  10828. * apply.
  10829. */
  10830. verticalAlign?: VerticalAlignValue;
  10831. /**
  10832. * (Highcharts, Highstock, Highmaps, Gantt) The width of the legend box. If
  10833. * a number is set, it translates to pixels. Since v7.0.2 it allows setting
  10834. * a percent string of the full chart width, for example `40%`.
  10835. *
  10836. * Defaults to the full chart width for legends below or above the chart,
  10837. * half the chart width for legends to the left and right.
  10838. */
  10839. width?: (number|string);
  10840. /**
  10841. * (Highcharts, Highstock, Highmaps, Gantt) The x offset of the legend
  10842. * relative to its horizontal alignment `align` within chart.spacingLeft and
  10843. * chart.spacingRight. Negative x moves it to the left, positive x moves it
  10844. * to the right.
  10845. */
  10846. x?: number;
  10847. /**
  10848. * (Highcharts, Highstock, Highmaps, Gantt) The vertical offset of the
  10849. * legend relative to it's vertical alignment `verticalAlign` within
  10850. * chart.spacingTop and chart.spacingBottom. Negative y moves it up,
  10851. * positive y moves it down.
  10852. */
  10853. y?: number;
  10854. }
  10855. /**
  10856. * (Highcharts, Highstock, Highmaps, Gantt) A title to be added on top of the
  10857. * legend.
  10858. */
  10859. export interface LegendTitleOptions {
  10860. /**
  10861. * (Highcharts, Highstock, Highmaps, Gantt) Generic CSS styles for the
  10862. * legend title.
  10863. */
  10864. style?: CSSObject;
  10865. /**
  10866. * (Highcharts, Highstock, Highmaps, Gantt) A text or HTML string for the
  10867. * title.
  10868. */
  10869. text?: string;
  10870. }
  10871. /**
  10872. * Defines the start position and the end position for a gradient relative to
  10873. * the shape. Start position (x1, y1) and end position (x2, y2) are relative to
  10874. * the shape, where 0 means top/left and 1 is bottom/right.
  10875. */
  10876. export interface LinearGradientColorObject {
  10877. /**
  10878. * Start horizontal position of the gradient. Float ranges 0-1.
  10879. */
  10880. x1: number;
  10881. /**
  10882. * End horizontal position of the gradient. Float ranges 0-1.
  10883. */
  10884. x2: number;
  10885. /**
  10886. * Start vertical position of the gradient. Float ranges 0-1.
  10887. */
  10888. y1: number;
  10889. /**
  10890. * End vertical position of the gradient. Float ranges 0-1.
  10891. */
  10892. y2: number;
  10893. }
  10894. /**
  10895. * (Highcharts, Highstock, Highmaps, Gantt) The loading options control the
  10896. * appearance of the loading screen that covers the plot area on chart
  10897. * operations. This screen only appears after an explicit call to
  10898. * `chart.showLoading()`. It is a utility for developers to communicate to the
  10899. * end user that something is going on, for example while retrieving new data
  10900. * via an XHR connection. The "Loading..." text itself is not part of this
  10901. * configuration object, but part of the `lang` object.
  10902. */
  10903. export interface LoadingOptions {
  10904. /**
  10905. * (Highcharts, Highstock, Highmaps, Gantt) The duration in milliseconds of
  10906. * the fade out effect.
  10907. */
  10908. hideDuration?: number;
  10909. /**
  10910. * (Highcharts, Highstock, Highmaps, Gantt) CSS styles for the loading label
  10911. * `span`.
  10912. */
  10913. labelStyle?: CSSObject;
  10914. /**
  10915. * (Highcharts, Highstock, Highmaps, Gantt) The duration in milliseconds of
  10916. * the fade in effect.
  10917. */
  10918. showDuration?: number;
  10919. /**
  10920. * (Highcharts, Highstock, Highmaps, Gantt) CSS styles for the loading
  10921. * screen that covers the plot area.
  10922. *
  10923. * In styled mode, the loading label is styled with the
  10924. * `.highcharts-loading` class.
  10925. */
  10926. style?: CSSObject;
  10927. }
  10928. /**
  10929. * (Highmaps) General options for the map navigation buttons. Individual options
  10930. * can be given from the mapNavigation.buttons option set.
  10931. */
  10932. export interface MapNavigationButtonOptions {
  10933. /**
  10934. * (Highmaps) The alignment of the navigation buttons.
  10935. */
  10936. align?: AlignValue;
  10937. /**
  10938. * (Highmaps) What box to align the buttons to. Possible values are
  10939. * `plotBox` and `spacingBox`.
  10940. */
  10941. alignTo?: ButtonRelativeToValue;
  10942. /**
  10943. * (Highmaps) The pixel height of the map navigation buttons.
  10944. */
  10945. height?: number;
  10946. /**
  10947. * (Highmaps) Padding for the navigation buttons.
  10948. */
  10949. padding?: number;
  10950. /**
  10951. * (Highmaps) Text styles for the map navigation buttons.
  10952. */
  10953. style?: CSSObject;
  10954. /**
  10955. * (Highmaps) A configuration object for the button theme. The object
  10956. * accepts SVG properties like `stroke-width`, `stroke` and `fill`.
  10957. * Tri-state button styles are supported by the `states.hover` and
  10958. * `states.select` objects.
  10959. */
  10960. theme?: SVGAttributes;
  10961. /**
  10962. * (Highmaps) The vertical alignment of the buttons. Individual alignment
  10963. * can be adjusted by each button's `y` offset.
  10964. */
  10965. verticalAlign?: VerticalAlignValue;
  10966. /**
  10967. * (Highmaps) The width of the map navigation buttons.
  10968. */
  10969. width?: number;
  10970. /**
  10971. * (Highmaps) The X offset of the buttons relative to its `align` setting.
  10972. */
  10973. x?: number;
  10974. }
  10975. /**
  10976. * (Highmaps) The individual buttons for the map navigation. This usually
  10977. * includes the zoom in and zoom out buttons. Properties for each button is
  10978. * inherited from mapNavigation.buttonOptions, while individual options can be
  10979. * overridden. But default, the `onclick`, `text` and `y` options are
  10980. * individual.
  10981. */
  10982. export interface MapNavigationButtonsOptions {
  10983. /**
  10984. * (Highmaps) Options for the zoom in button. Properties for the zoom in and
  10985. * zoom out buttons are inherited from mapNavigation.buttonOptions, while
  10986. * individual options can be overridden. By default, the `onclick`, `text`
  10987. * and `y` options are individual.
  10988. */
  10989. zoomIn?: MapNavigationButtonsZoomInOptions;
  10990. /**
  10991. * (Highmaps) Options for the zoom out button. Properties for the zoom in
  10992. * and zoom out buttons are inherited from mapNavigation.buttonOptions,
  10993. * while individual options can be overridden. By default, the `onclick`,
  10994. * `text` and `y` options are individual.
  10995. */
  10996. zoomOut?: MapNavigationButtonsZoomOutOptions;
  10997. }
  10998. /**
  10999. * (Highmaps) Options for the zoom in button. Properties for the zoom in and
  11000. * zoom out buttons are inherited from mapNavigation.buttonOptions, while
  11001. * individual options can be overridden. By default, the `onclick`, `text` and
  11002. * `y` options are individual.
  11003. */
  11004. export interface MapNavigationButtonsZoomInOptions {
  11005. /**
  11006. * (Highmaps) The alignment of the navigation buttons.
  11007. */
  11008. align?: AlignValue;
  11009. /**
  11010. * (Highmaps) What box to align the buttons to. Possible values are
  11011. * `plotBox` and `spacingBox`.
  11012. */
  11013. alignTo?: ButtonRelativeToValue;
  11014. /**
  11015. * (Highmaps) The pixel height of the map navigation buttons.
  11016. */
  11017. height?: number;
  11018. /**
  11019. * (Highmaps) Click handler for the button.
  11020. */
  11021. onclick?: Function;
  11022. /**
  11023. * (Highmaps) Padding for the navigation buttons.
  11024. */
  11025. padding?: number;
  11026. /**
  11027. * (Highmaps) Text styles for the map navigation buttons.
  11028. */
  11029. style?: CSSObject;
  11030. /**
  11031. * (Highmaps) The text for the button. The tooltip (title) is a language
  11032. * option given by lang.zoomIn.
  11033. */
  11034. text?: string;
  11035. /**
  11036. * (Highmaps) A configuration object for the button theme. The object
  11037. * accepts SVG properties like `stroke-width`, `stroke` and `fill`.
  11038. * Tri-state button styles are supported by the `states.hover` and
  11039. * `states.select` objects.
  11040. */
  11041. theme?: SVGAttributes;
  11042. /**
  11043. * (Highmaps) The vertical alignment of the buttons. Individual alignment
  11044. * can be adjusted by each button's `y` offset.
  11045. */
  11046. verticalAlign?: VerticalAlignValue;
  11047. /**
  11048. * (Highmaps) The width of the map navigation buttons.
  11049. */
  11050. width?: number;
  11051. /**
  11052. * (Highmaps) The X offset of the buttons relative to its `align` setting.
  11053. */
  11054. x?: number;
  11055. /**
  11056. * (Highmaps) The position of the zoomIn button relative to the vertical
  11057. * alignment.
  11058. */
  11059. y?: number;
  11060. }
  11061. /**
  11062. * (Highmaps) Options for the zoom out button. Properties for the zoom in and
  11063. * zoom out buttons are inherited from mapNavigation.buttonOptions, while
  11064. * individual options can be overridden. By default, the `onclick`, `text` and
  11065. * `y` options are individual.
  11066. */
  11067. export interface MapNavigationButtonsZoomOutOptions {
  11068. /**
  11069. * (Highmaps) The alignment of the navigation buttons.
  11070. */
  11071. align?: AlignValue;
  11072. /**
  11073. * (Highmaps) What box to align the buttons to. Possible values are
  11074. * `plotBox` and `spacingBox`.
  11075. */
  11076. alignTo?: ButtonRelativeToValue;
  11077. /**
  11078. * (Highmaps) The pixel height of the map navigation buttons.
  11079. */
  11080. height?: number;
  11081. /**
  11082. * (Highmaps) Click handler for the button.
  11083. */
  11084. onclick?: Function;
  11085. /**
  11086. * (Highmaps) Padding for the navigation buttons.
  11087. */
  11088. padding?: number;
  11089. /**
  11090. * (Highmaps) Text styles for the map navigation buttons.
  11091. */
  11092. style?: CSSObject;
  11093. /**
  11094. * (Highmaps) The text for the button. The tooltip (title) is a language
  11095. * option given by lang.zoomOut.
  11096. */
  11097. text?: string;
  11098. /**
  11099. * (Highmaps) A configuration object for the button theme. The object
  11100. * accepts SVG properties like `stroke-width`, `stroke` and `fill`.
  11101. * Tri-state button styles are supported by the `states.hover` and
  11102. * `states.select` objects.
  11103. */
  11104. theme?: SVGAttributes;
  11105. /**
  11106. * (Highmaps) The vertical alignment of the buttons. Individual alignment
  11107. * can be adjusted by each button's `y` offset.
  11108. */
  11109. verticalAlign?: VerticalAlignValue;
  11110. /**
  11111. * (Highmaps) The width of the map navigation buttons.
  11112. */
  11113. width?: number;
  11114. /**
  11115. * (Highmaps) The X offset of the buttons relative to its `align` setting.
  11116. */
  11117. x?: number;
  11118. /**
  11119. * (Highmaps) The position of the zoomOut button relative to the vertical
  11120. * alignment.
  11121. */
  11122. y?: number;
  11123. }
  11124. export interface MapNavigationOptions {
  11125. /**
  11126. * (Highmaps) General options for the map navigation buttons. Individual
  11127. * options can be given from the mapNavigation.buttons option set.
  11128. */
  11129. buttonOptions?: MapNavigationButtonOptions;
  11130. /**
  11131. * (Highmaps) The individual buttons for the map navigation. This usually
  11132. * includes the zoom in and zoom out buttons. Properties for each button is
  11133. * inherited from mapNavigation.buttonOptions, while individual options can
  11134. * be overridden. But default, the `onclick`, `text` and `y` options are
  11135. * individual.
  11136. */
  11137. buttons?: MapNavigationButtonsOptions;
  11138. /**
  11139. * (Highmaps) Whether to enable navigation buttons. By default it inherits
  11140. * the enabled setting.
  11141. */
  11142. enableButtons?: boolean;
  11143. /**
  11144. * (Highmaps) Whether to enable map navigation. The default is not to enable
  11145. * navigation, as many choropleth maps are simple and don't need it.
  11146. * Additionally, when touch zoom and mousewheel zoom is enabled, it breaks
  11147. * the default behaviour of these interactions in the website, and the
  11148. * implementer should be aware of this.
  11149. *
  11150. * Individual interactions can be enabled separately, namely buttons,
  11151. * multitouch zoom, double click zoom, double click zoom to element and
  11152. * mousewheel zoom.
  11153. */
  11154. enabled?: boolean;
  11155. /**
  11156. * (Highmaps) Enables zooming in on an area on double clicking in the map.
  11157. * By default it inherits the enabled setting.
  11158. */
  11159. enableDoubleClickZoom?: boolean;
  11160. /**
  11161. * (Highmaps) Whether to zoom in on an area when that area is double
  11162. * clicked.
  11163. */
  11164. enableDoubleClickZoomTo?: boolean;
  11165. /**
  11166. * (Highmaps) Enables zooming by mouse wheel. By default it inherits the
  11167. * enabled setting.
  11168. */
  11169. enableMouseWheelZoom?: boolean;
  11170. /**
  11171. * (Highmaps) Whether to enable multitouch zooming. Note that if the chart
  11172. * covers the viewport, this prevents the user from using multitouch and
  11173. * touchdrag on the web page, so you should make sure the user is not
  11174. * trapped inside the chart. By default it inherits the enabled setting.
  11175. */
  11176. enableTouchZoom?: boolean;
  11177. /**
  11178. * (Highmaps) Sensitivity of mouse wheel or trackpad scrolling. 1 is no
  11179. * sensitivity, while with 2, one mousewheel delta will zoom in 50%.
  11180. */
  11181. mouseWheelSensitivity?: number;
  11182. }
  11183. /**
  11184. * (Highcharts, Highstock, Highmaps, Gantt) Enable or disable the initial
  11185. * animation when a series is displayed for the `annotation`. The animation can
  11186. * also be set as a configuration object. Please note that this option only
  11187. * applies to the initial animation. For other animations, see chart.animation
  11188. * and the animation parameter under the API methods. The following properties
  11189. * are supported:
  11190. *
  11191. * - `defer`: The animation delay time in milliseconds.
  11192. */
  11193. export interface NavigationAnnotationsAnimationOptions {
  11194. /**
  11195. * (Highcharts, Highstock, Highmaps, Gantt) The animation delay time in
  11196. * milliseconds. Set to `0` renders annotation immediately. As `undefined`
  11197. * inherits defer time from the series.animation.defer.
  11198. */
  11199. defer?: number;
  11200. }
  11201. /**
  11202. * (Highcharts, Highstock, Highmaps, Gantt) Events available in annotations.
  11203. */
  11204. export interface NavigationAnnotationsEventsOptions {
  11205. /**
  11206. * (Highcharts, Highstock, Highmaps, Gantt) Event callback when annotation
  11207. * is added to the chart.
  11208. */
  11209. add?: EventCallbackFunction<Annotation>;
  11210. /**
  11211. * (Highcharts, Highstock, Highmaps, Gantt) Event callback when annotation
  11212. * is updated (e.g. drag and droppped or resized by control points).
  11213. */
  11214. afterUpdate?: EventCallbackFunction<Annotation>;
  11215. /**
  11216. * (Highcharts, Highstock, Highmaps, Gantt) Event callback when annotation
  11217. * is removed from the chart.
  11218. */
  11219. remove?: EventCallbackFunction<Annotation>;
  11220. }
  11221. /**
  11222. * (Highcharts, Highstock, Highmaps, Gantt) Options for annotation's labels.
  11223. * Each label inherits options from the labelOptions object. An option from the
  11224. * labelOptions can be overwritten by config for a specific label.
  11225. */
  11226. export interface NavigationAnnotationsLabelOptions {
  11227. /**
  11228. * (Highcharts, Highstock, Highmaps, Gantt) Accessibility options for an
  11229. * annotation label.
  11230. */
  11231. accessibility?: AnnotationLabelAccessibilityOptionsObject;
  11232. /**
  11233. * (Highcharts, Highstock, Highmaps, Gantt) The alignment of the
  11234. * annotation's label. If right, the right side of the label should be
  11235. * touching the point.
  11236. */
  11237. align?: AlignValue;
  11238. /**
  11239. * (Highcharts, Highstock, Highmaps, Gantt) Whether to allow the
  11240. * annotation's labels to overlap. To make the labels less sensitive for
  11241. * overlapping, the can be set to 0.
  11242. */
  11243. allowOverlap?: boolean;
  11244. /**
  11245. * (Highcharts, Highstock, Highmaps, Gantt) The background color or gradient
  11246. * for the annotation's label.
  11247. */
  11248. backgroundColor?: (ColorString|GradientColorObject|PatternObject);
  11249. /**
  11250. * (Highcharts, Highstock, Highmaps, Gantt) The border color for the
  11251. * annotation's label.
  11252. */
  11253. borderColor?: ColorString;
  11254. /**
  11255. * (Highcharts, Highstock, Highmaps, Gantt) The border radius in pixels for
  11256. * the annotaiton's label.
  11257. */
  11258. borderRadius?: number;
  11259. /**
  11260. * (Highcharts, Highstock, Highmaps, Gantt) The border width in pixels for
  11261. * the annotation's label
  11262. */
  11263. borderWidth?: number;
  11264. /**
  11265. * (Highcharts, Highstock, Highmaps, Gantt) A class name for styling by CSS.
  11266. */
  11267. className?: string;
  11268. /**
  11269. * (Highcharts, Highstock, Highmaps, Gantt) Whether to hide the annotation's
  11270. * label that is outside the plot area.
  11271. */
  11272. crop?: boolean;
  11273. /**
  11274. * (Highcharts, Highstock, Highmaps, Gantt) The label's pixel distance from
  11275. * the point.
  11276. */
  11277. distance?: number;
  11278. /**
  11279. * (Highcharts, Highstock, Highmaps, Gantt) A format string for the data
  11280. * label.
  11281. */
  11282. format?: string;
  11283. /**
  11284. * (Highcharts, Highstock, Highmaps, Gantt) Callback JavaScript function to
  11285. * format the annotation's label. Note that if a `format` or `text` are
  11286. * defined, the format or text take precedence and the formatter is ignored.
  11287. * `This` refers to a point object.
  11288. */
  11289. formatter?: FormatterCallbackFunction<Point>;
  11290. /**
  11291. * (Highcharts, Highstock, Highmaps, Gantt) Whether the annotation is
  11292. * visible in the exported data table.
  11293. */
  11294. includeInDataExport?: boolean;
  11295. /**
  11296. * (Highcharts, Highstock, Highmaps, Gantt) How to handle the annotation's
  11297. * label that flow outside the plot area. The justify option aligns the
  11298. * label inside the plot area.
  11299. */
  11300. overflow?: OptionsOverflowValue;
  11301. /**
  11302. * (Highcharts, Highstock, Highmaps, Gantt) When either the borderWidth or
  11303. * the backgroundColor is set, this is the padding within the box.
  11304. */
  11305. padding?: number;
  11306. /**
  11307. * (Highcharts, Highstock, Highmaps, Gantt) The shadow of the box. The
  11308. * shadow can be an object configuration containing `color`, `offsetX`,
  11309. * `offsetY`, `opacity` and `width`.
  11310. */
  11311. shadow?: (boolean|ShadowOptionsObject);
  11312. /**
  11313. * (Highcharts, Highstock, Highmaps, Gantt) The name of a symbol to use for
  11314. * the border around the label. Symbols are predefined functions on the
  11315. * Renderer object.
  11316. */
  11317. shape?: string;
  11318. /**
  11319. * (Highcharts, Highstock, Highmaps, Gantt) Styles for the annotation's
  11320. * label.
  11321. */
  11322. style?: CSSObject;
  11323. /**
  11324. * (Highcharts, Highstock, Highmaps, Gantt) Alias for the format option.
  11325. */
  11326. text?: string;
  11327. /**
  11328. * (Highcharts, Highstock, Highmaps, Gantt) Whether to use HTML to render
  11329. * the annotation's label.
  11330. */
  11331. useHTML?: boolean;
  11332. /**
  11333. * (Highcharts, Highstock, Highmaps, Gantt) The vertical alignment of the
  11334. * annotation's label.
  11335. */
  11336. verticalAlign?: VerticalAlignValue;
  11337. /**
  11338. * (Highcharts, Highstock, Highmaps, Gantt) The x position offset of the
  11339. * label relative to the point. Note that if a `distance` is defined, the
  11340. * distance takes precedence over `x` and `y` options.
  11341. */
  11342. x?: number;
  11343. /**
  11344. * (Highcharts, Highstock, Highmaps, Gantt) The y position offset of the
  11345. * label relative to the point. Note that if a `distance` is defined, the
  11346. * distance takes precedence over `x` and `y` options.
  11347. */
  11348. y?: number;
  11349. }
  11350. /**
  11351. * (Highcharts, Highstock, Highmaps, Gantt) An array of labels for the
  11352. * annotation. For options that apply to multiple labels, they can be added to
  11353. * the labelOptions.
  11354. */
  11355. export interface NavigationAnnotationsLabelsOptions {
  11356. /**
  11357. * (Highcharts, Highstock, Highmaps, Gantt) Accessibility options for an
  11358. * annotation label.
  11359. */
  11360. accessibility?: AnnotationLabelAccessibilityOptionsObject;
  11361. /**
  11362. * (Highcharts, Highstock, Highmaps, Gantt) The alignment of the
  11363. * annotation's label. If right, the right side of the label should be
  11364. * touching the point.
  11365. */
  11366. align?: AlignValue;
  11367. /**
  11368. * (Highcharts, Highstock, Highmaps, Gantt) Whether to allow the
  11369. * annotation's labels to overlap. To make the labels less sensitive for
  11370. * overlapping, the can be set to 0.
  11371. */
  11372. allowOverlap?: boolean;
  11373. /**
  11374. * (Highcharts, Highstock, Highmaps, Gantt) The background color or gradient
  11375. * for the annotation's label.
  11376. */
  11377. backgroundColor?: (ColorString|GradientColorObject|PatternObject);
  11378. /**
  11379. * (Highcharts, Highstock, Highmaps, Gantt) The border color for the
  11380. * annotation's label.
  11381. */
  11382. borderColor?: ColorString;
  11383. /**
  11384. * (Highcharts, Highstock, Highmaps, Gantt) The border radius in pixels for
  11385. * the annotaiton's label.
  11386. */
  11387. borderRadius?: number;
  11388. /**
  11389. * (Highcharts, Highstock, Highmaps, Gantt) The border width in pixels for
  11390. * the annotation's label
  11391. */
  11392. borderWidth?: number;
  11393. /**
  11394. * (Highcharts, Highstock, Highmaps, Gantt) A class name for styling by CSS.
  11395. */
  11396. className?: string;
  11397. /**
  11398. * (Highcharts, Highstock, Highmaps, Gantt) Whether to hide the annotation's
  11399. * label that is outside the plot area.
  11400. */
  11401. crop?: boolean;
  11402. /**
  11403. * (Highcharts, Highstock, Highmaps, Gantt) The label's pixel distance from
  11404. * the point.
  11405. */
  11406. distance?: number;
  11407. /**
  11408. * (Highcharts, Highstock, Highmaps, Gantt) A format string for the data
  11409. * label.
  11410. */
  11411. format?: string;
  11412. /**
  11413. * (Highcharts, Highstock, Highmaps, Gantt) Callback JavaScript function to
  11414. * format the annotation's label. Note that if a `format` or `text` are
  11415. * defined, the format or text take precedence and the formatter is ignored.
  11416. * `This` refers to a point object.
  11417. */
  11418. formatter?: FormatterCallbackFunction<Point>;
  11419. /**
  11420. * (Highcharts, Highstock, Highmaps, Gantt) Whether the annotation is
  11421. * visible in the exported data table.
  11422. */
  11423. includeInDataExport?: boolean;
  11424. /**
  11425. * (Highcharts, Highstock, Highmaps, Gantt) How to handle the annotation's
  11426. * label that flow outside the plot area. The justify option aligns the
  11427. * label inside the plot area.
  11428. */
  11429. overflow?: OptionsOverflowValue;
  11430. /**
  11431. * (Highcharts, Highstock, Highmaps, Gantt) When either the borderWidth or
  11432. * the backgroundColor is set, this is the padding within the box.
  11433. */
  11434. padding?: number;
  11435. /**
  11436. * (Highcharts, Highstock, Highmaps, Gantt) This option defines the point to
  11437. * which the label will be connected. It can be either the point which
  11438. * exists in the series - it is referenced by the point's id - or a new
  11439. * point with defined x, y properties and optionally axes.
  11440. */
  11441. point?: (string|AnnotationMockPointOptionsObject);
  11442. /**
  11443. * (Highcharts, Highstock, Highmaps, Gantt) The shadow of the box. The
  11444. * shadow can be an object configuration containing `color`, `offsetX`,
  11445. * `offsetY`, `opacity` and `width`.
  11446. */
  11447. shadow?: (boolean|ShadowOptionsObject);
  11448. /**
  11449. * (Highcharts, Highstock, Highmaps, Gantt) The name of a symbol to use for
  11450. * the border around the label. Symbols are predefined functions on the
  11451. * Renderer object.
  11452. */
  11453. shape?: string;
  11454. /**
  11455. * (Highcharts, Highstock, Highmaps, Gantt) Styles for the annotation's
  11456. * label.
  11457. */
  11458. style?: CSSObject;
  11459. /**
  11460. * (Highcharts, Highstock, Highmaps, Gantt) Alias for the format option.
  11461. */
  11462. text?: string;
  11463. /**
  11464. * (Highcharts, Highstock, Highmaps, Gantt) Whether to use HTML to render
  11465. * the annotation's label.
  11466. */
  11467. useHTML?: boolean;
  11468. /**
  11469. * (Highcharts, Highstock, Highmaps, Gantt) The vertical alignment of the
  11470. * annotation's label.
  11471. */
  11472. verticalAlign?: VerticalAlignValue;
  11473. /**
  11474. * (Highcharts, Highstock, Highmaps, Gantt) The x position offset of the
  11475. * label relative to the point. Note that if a `distance` is defined, the
  11476. * distance takes precedence over `x` and `y` options.
  11477. */
  11478. x?: number;
  11479. /**
  11480. * (Highcharts, Highstock, Highmaps, Gantt) The y position offset of the
  11481. * label relative to the point. Note that if a `distance` is defined, the
  11482. * distance takes precedence over `x` and `y` options.
  11483. */
  11484. y?: number;
  11485. }
  11486. /**
  11487. * (Highcharts, Highstock, Highmaps, Gantt) Additional options to be merged into
  11488. * all annotations.
  11489. */
  11490. export interface NavigationAnnotationsOptions {
  11491. /**
  11492. * (Highcharts, Highstock, Highmaps, Gantt) Enable or disable the initial
  11493. * animation when a series is displayed for the `annotation`. The animation
  11494. * can also be set as a configuration object. Please note that this option
  11495. * only applies to the initial animation. For other animations, see
  11496. * chart.animation and the animation parameter under the API methods. The
  11497. * following properties are supported:
  11498. *
  11499. * - `defer`: The animation delay time in milliseconds.
  11500. */
  11501. animation?: (boolean|NavigationAnnotationsAnimationOptions|Partial<AnimationOptionsObject>);
  11502. /**
  11503. * (Highcharts, Highstock, Highmaps, Gantt) Options for annotation's control
  11504. * points. Each control point inherits options from controlPointOptions
  11505. * object. Options from the controlPointOptions can be overwritten by
  11506. * options in a specific control point.
  11507. */
  11508. controlPointOptions?: AnnotationControlPointOptionsObject;
  11509. /**
  11510. * (Highcharts, Highstock, Highmaps, Gantt) Allow an annotation to be
  11511. * draggable by a user. Possible values are `'x'`, `'xy'`, `'y'` and `''`
  11512. * (disabled).
  11513. */
  11514. draggable?: AnnotationDraggableValue;
  11515. /**
  11516. * (Highcharts, Highstock, Highmaps, Gantt) Events available in annotations.
  11517. */
  11518. events?: NavigationAnnotationsEventsOptions;
  11519. /**
  11520. * (Highcharts, Highstock, Highmaps, Gantt) Sets an ID for an annotation.
  11521. * Can be user later when removing an annotation in
  11522. * Chart.removeAnnotation(id) method.
  11523. */
  11524. id?: (number|string);
  11525. /**
  11526. * (Highcharts, Highstock, Highmaps, Gantt) Options for annotation's labels.
  11527. * Each label inherits options from the labelOptions object. An option from
  11528. * the labelOptions can be overwritten by config for a specific label.
  11529. */
  11530. labelOptions?: NavigationAnnotationsLabelOptions;
  11531. /**
  11532. * (Highcharts, Highstock, Highmaps, Gantt) An array of labels for the
  11533. * annotation. For options that apply to multiple labels, they can be added
  11534. * to the labelOptions.
  11535. */
  11536. labels?: Array<NavigationAnnotationsLabelsOptions>;
  11537. /**
  11538. * (Highcharts, Highstock, Highmaps, Gantt) Options for annotation's shapes.
  11539. * Each shape inherits options from the shapeOptions object. An option from
  11540. * the shapeOptions can be overwritten by config for a specific shape.
  11541. */
  11542. shapeOptions?: NavigationAnnotationsShapeOptions;
  11543. /**
  11544. * (Highcharts, Highstock, Highmaps, Gantt) An array of shapes for the
  11545. * annotation. For options that apply to multiple shapes, then can be added
  11546. * to the shapeOptions.
  11547. */
  11548. shapes?: Array<NavigationAnnotationsShapesOptions>;
  11549. /**
  11550. * (Highcharts, Highstock, Highmaps, Gantt) Whether the annotation is
  11551. * visible.
  11552. */
  11553. visible?: boolean;
  11554. /**
  11555. * (Highcharts, Highstock, Highmaps, Gantt) The Z index of the annotation.
  11556. */
  11557. zIndex?: number;
  11558. }
  11559. /**
  11560. * (Highcharts, Highstock, Highmaps, Gantt) Options for annotation's shapes.
  11561. * Each shape inherits options from the shapeOptions object. An option from the
  11562. * shapeOptions can be overwritten by config for a specific shape.
  11563. */
  11564. export interface NavigationAnnotationsShapeOptions {
  11565. /**
  11566. * (Highcharts, Highstock, Highmaps, Gantt) Name of the dash style to use
  11567. * for the shape's stroke.
  11568. */
  11569. dashStyle?: DashStyleValue;
  11570. /**
  11571. * (Highcharts, Highstock, Highmaps, Gantt) The color of the shape's fill.
  11572. */
  11573. fill?: (ColorString|GradientColorObject|PatternObject);
  11574. /**
  11575. * (Highcharts, Highstock, Highmaps, Gantt) The height of the shape.
  11576. */
  11577. height?: number;
  11578. /**
  11579. * (Highcharts, Highstock, Highmaps, Gantt) The radius of the shape.
  11580. */
  11581. r?: number;
  11582. /**
  11583. * (Highcharts, Highstock, Highmaps, Gantt) Defines additional snapping area
  11584. * around an annotation making this annotation to focus. Defined in pixels.
  11585. */
  11586. snap?: number;
  11587. /**
  11588. * (Highcharts, Highstock, Highmaps, Gantt) The URL for an image to use as
  11589. * the annotation shape. Note, type has to be set to `'image'`.
  11590. */
  11591. src?: string;
  11592. /**
  11593. * (Highcharts, Highstock, Highmaps, Gantt) The color of the shape's stroke.
  11594. */
  11595. stroke?: ColorString;
  11596. /**
  11597. * (Highcharts, Highstock, Highmaps, Gantt) The pixel stroke width of the
  11598. * shape.
  11599. */
  11600. strokeWidth?: number;
  11601. /**
  11602. * (Highcharts, Highstock, Highmaps, Gantt) The type of the shape, e.g.
  11603. * circle or rectangle.
  11604. */
  11605. type?: string;
  11606. /**
  11607. * (Highcharts, Highstock, Highmaps, Gantt) The width of the shape.
  11608. */
  11609. width?: number;
  11610. }
  11611. /**
  11612. * (Highcharts, Highstock, Highmaps, Gantt) An array of shapes for the
  11613. * annotation. For options that apply to multiple shapes, then can be added to
  11614. * the shapeOptions.
  11615. */
  11616. export interface NavigationAnnotationsShapesOptions {
  11617. /**
  11618. * (Highcharts, Highstock, Highmaps, Gantt) Name of the dash style to use
  11619. * for the shape's stroke.
  11620. */
  11621. dashStyle?: DashStyleValue;
  11622. /**
  11623. * (Highcharts, Highstock, Highmaps, Gantt) The color of the shape's fill.
  11624. */
  11625. fill?: (ColorString|GradientColorObject|PatternObject);
  11626. /**
  11627. * (Highcharts, Highstock, Highmaps, Gantt) The height of the shape.
  11628. */
  11629. height?: number;
  11630. /**
  11631. * (Highcharts, Highstock, Highmaps, Gantt) Id of the marker which will be
  11632. * drawn at the final vertex of the path. Custom markers can be defined in
  11633. * defs property.
  11634. */
  11635. markerEnd?: string;
  11636. /**
  11637. * (Highcharts, Highstock, Highmaps, Gantt) Id of the marker which will be
  11638. * drawn at the first vertex of the path. Custom markers can be defined in
  11639. * defs property.
  11640. */
  11641. markerStart?: string;
  11642. /**
  11643. * (Highcharts, Highstock, Highmaps, Gantt) This option defines the point to
  11644. * which the shape will be connected. It can be either the point which
  11645. * exists in the series - it is referenced by the point's id - or a new
  11646. * point with defined x, y properties and optionally axes.
  11647. */
  11648. point?: (string|AnnotationMockPointOptionsObject);
  11649. /**
  11650. * (Highcharts, Highstock, Highmaps, Gantt) An array of points for the
  11651. * shape. This option is available for shapes which can use multiple points
  11652. * such as path. A point can be either a point object or a point's id.
  11653. */
  11654. points?: Array<(string|AnnotationMockPointOptionsObject)>;
  11655. /**
  11656. * (Highcharts, Highstock, Highmaps, Gantt) The radius of the shape.
  11657. */
  11658. r?: number;
  11659. /**
  11660. * (Highcharts, Highstock, Highmaps, Gantt) Defines additional snapping area
  11661. * around an annotation making this annotation to focus. Defined in pixels.
  11662. */
  11663. snap?: number;
  11664. /**
  11665. * (Highcharts, Highstock, Highmaps, Gantt) The URL for an image to use as
  11666. * the annotation shape. Note, type has to be set to `'image'`.
  11667. */
  11668. src?: string;
  11669. /**
  11670. * (Highcharts, Highstock, Highmaps, Gantt) The color of the shape's stroke.
  11671. */
  11672. stroke?: ColorString;
  11673. /**
  11674. * (Highcharts, Highstock, Highmaps, Gantt) The pixel stroke width of the
  11675. * shape.
  11676. */
  11677. strokeWidth?: number;
  11678. /**
  11679. * (Highcharts, Highstock, Highmaps, Gantt) The type of the shape, e.g.
  11680. * circle or rectangle.
  11681. */
  11682. type?: string;
  11683. /**
  11684. * (Highcharts, Highstock, Highmaps, Gantt) The width of the shape.
  11685. */
  11686. width?: number;
  11687. }
  11688. /**
  11689. * (Highcharts, Highstock) Bindings definitions for custom HTML buttons. Each
  11690. * binding implements simple event-driven interface:
  11691. *
  11692. * - `className`: classname used to bind event to
  11693. *
  11694. * - `init`: initial event, fired on button click
  11695. *
  11696. * - `start`: fired on first click on a chart
  11697. *
  11698. * - `steps`: array of sequential events fired one after another on each of
  11699. * users clicks
  11700. *
  11701. * - `end`: last event to be called after last step event
  11702. */
  11703. export interface NavigationBindingsOptions {
  11704. /**
  11705. * (Highstock) A line with arrow annotation. Includes `start` and one event
  11706. * in `steps` array.
  11707. */
  11708. arrowInfinityLine?: NavigationBindingsOptionsObject;
  11709. /**
  11710. * (Highstock) A ray with an arrow annotation bindings. Includes `start` and
  11711. * one event in `steps` array.
  11712. */
  11713. arrowRay?: NavigationBindingsOptionsObject;
  11714. /**
  11715. * (Highstock) A segment with an arrow annotation bindings. Includes `start`
  11716. * and one event in `steps` array.
  11717. */
  11718. arrowSegment?: NavigationBindingsOptionsObject;
  11719. /**
  11720. * (Highcharts, Highstock) A circle annotation bindings. Includes `start`
  11721. * and one event in `steps` array.
  11722. */
  11723. circleAnnotation?: NavigationBindingsOptionsObject;
  11724. /**
  11725. * (Highstock) Crooked line (three points) annotation bindings. Includes
  11726. * `start` and two events in `steps` (for second and third points in crooked
  11727. * line) array.
  11728. */
  11729. crooked3?: NavigationBindingsOptionsObject;
  11730. /**
  11731. * (Highstock) Crooked line (five points) annotation bindings. Includes
  11732. * `start` and four events in `steps` (for all consequent points in crooked
  11733. * line) array.
  11734. */
  11735. crooked5?: NavigationBindingsOptionsObject;
  11736. /**
  11737. * (Highstock) Hides/shows two price indicators:
  11738. *
  11739. * - last price in the dataset
  11740. *
  11741. * - last price in the selected range
  11742. */
  11743. currentPriceIndicator?: NavigationBindingsOptionsObject;
  11744. /**
  11745. * (Highstock) Elliott wave (three points) annotation bindings. Includes
  11746. * `start` and two events in `steps` (for second and third points) array.
  11747. */
  11748. elliott3?: NavigationBindingsOptionsObject;
  11749. /**
  11750. * (Highstock) Elliott wave (five points) annotation bindings. Includes
  11751. * `start` and four event in `steps` (for all consequent points in Elliott
  11752. * wave) array.
  11753. */
  11754. elliott5?: NavigationBindingsOptionsObject;
  11755. /**
  11756. * (Highstock) A fibonacci annotation bindings. Includes `start` and two
  11757. * events in `steps` array (updates second point, then height).
  11758. */
  11759. fibonacci?: NavigationBindingsOptionsObject;
  11760. /**
  11761. * (Highstock) A flag series bindings. Includes `start` event. On click,
  11762. * finds the closest point and marks it with a flag with `'circlepin'`
  11763. * shape.
  11764. */
  11765. flagCirclepin?: NavigationBindingsOptionsObject;
  11766. /**
  11767. * (Highstock) A flag series bindings. Includes `start` event. On click,
  11768. * finds the closest point and marks it with a flag with `'diamondpin'`
  11769. * shape.
  11770. */
  11771. flagDiamondpin?: NavigationBindingsOptionsObject;
  11772. /**
  11773. * (Highstock) A flag series bindings. Includes `start` event. On click,
  11774. * finds the closest point and marks it with a flag without pin shape.
  11775. */
  11776. flagSimplepin?: NavigationBindingsOptionsObject;
  11777. /**
  11778. * (Highstock) A flag series bindings. Includes `start` event. On click,
  11779. * finds the closest point and marks it with a flag with `'squarepin'`
  11780. * shape.
  11781. */
  11782. flagSquarepin?: NavigationBindingsOptionsObject;
  11783. /**
  11784. * (Highstock) Displays chart in fullscreen.
  11785. *
  11786. * **Note**: Fullscreen is not supported on iPhone due to iOS limitations.
  11787. */
  11788. fullScreen?: NavigationBindingsOptionsObject;
  11789. /**
  11790. * (Highstock) A horizontal line annotation. Includes `start` event.
  11791. */
  11792. horizontalLine?: NavigationBindingsOptionsObject;
  11793. /**
  11794. * (Highstock) Indicators bindings. Includes `init` event to show a popup.
  11795. *
  11796. * Note: In order to show base series from the chart in the popup's dropdown
  11797. * each series requires series.id to be defined.
  11798. */
  11799. indicators?: NavigationBindingsOptionsObject;
  11800. /**
  11801. * (Highstock) A line annotation. Includes `start` and one event in `steps`
  11802. * array.
  11803. */
  11804. infinityLine?: NavigationBindingsOptionsObject;
  11805. /**
  11806. * (Highcharts, Highstock) A label annotation bindings. Includes `start`
  11807. * event only.
  11808. */
  11809. labelAnnotation?: NavigationBindingsOptionsObject;
  11810. /**
  11811. * (Highstock) A measure (x-dimension) annotation bindings. Includes `start`
  11812. * and one event in `steps` array.
  11813. */
  11814. measureX?: NavigationBindingsOptionsObject;
  11815. /**
  11816. * (Highstock) A measure (xy-dimension) annotation bindings. Includes
  11817. * `start` and one event in `steps` array.
  11818. */
  11819. measureXY?: NavigationBindingsOptionsObject;
  11820. /**
  11821. * (Highstock) A measure (y-dimension) annotation bindings. Includes `start`
  11822. * and one event in `steps` array.
  11823. */
  11824. measureY?: NavigationBindingsOptionsObject;
  11825. /**
  11826. * (Highstock) A parallel channel (tunnel) annotation bindings. Includes
  11827. * `start` and two events in `steps` array (updates second point, then
  11828. * height).
  11829. */
  11830. parallelChannel?: NavigationBindingsOptionsObject;
  11831. /**
  11832. * (Highstock) An Andrew's pitchfork annotation bindings. Includes `start`
  11833. * and two events in `steps` array (sets second and third control points).
  11834. */
  11835. pitchfork?: NavigationBindingsOptionsObject;
  11836. /**
  11837. * (Highstock) A ray annotation bindings. Includes `start` and one event in
  11838. * `steps` array.
  11839. */
  11840. ray?: NavigationBindingsOptionsObject;
  11841. /**
  11842. * (Highcharts, Highstock) A rectangle annotation bindings. Includes `start`
  11843. * and one event in `steps` array.
  11844. */
  11845. rectangleAnnotation?: NavigationBindingsOptionsObject;
  11846. /**
  11847. * (Highstock) Save a chart in localStorage under `highcharts-chart` key.
  11848. * Stored items:
  11849. *
  11850. * - annotations
  11851. *
  11852. * - indicators (with yAxes)
  11853. *
  11854. * - flags
  11855. */
  11856. saveChart?: NavigationBindingsOptionsObject;
  11857. /**
  11858. * (Highstock) A segment annotation bindings. Includes `start` and one event
  11859. * in `steps` array.
  11860. */
  11861. segment?: NavigationBindingsOptionsObject;
  11862. /**
  11863. * (Highstock) Changes main series to `'candlestick'` type.
  11864. */
  11865. seriesTypeCandlestick?: NavigationBindingsOptionsObject;
  11866. /**
  11867. * (Highstock) Changes main series to `'line'` type.
  11868. */
  11869. seriesTypeLine?: NavigationBindingsOptionsObject;
  11870. /**
  11871. * (Highstock) Changes main series to `'ohlc'` type.
  11872. */
  11873. seriesTypeOhlc?: NavigationBindingsOptionsObject;
  11874. /**
  11875. * (Highstock) Hides/shows all annotations on a chart.
  11876. */
  11877. toggleAnnotations?: NavigationBindingsOptionsObject;
  11878. /**
  11879. * (Highstock) A vertical arrow annotation bindings. Includes `start` event.
  11880. * On click, finds the closest point and marks it with an arrow. Green arrow
  11881. * when pointing from above, red when pointing from below the point.
  11882. */
  11883. verticalArrow?: NavigationBindingsOptionsObject;
  11884. /**
  11885. * (Highstock) A vertical counter annotation bindings. Includes `start`
  11886. * event. On click, finds the closest point and marks it with a numeric
  11887. * annotation - incrementing counter on each add.
  11888. */
  11889. verticalCounter?: NavigationBindingsOptionsObject;
  11890. /**
  11891. * (Highstock) A vertical arrow annotation bindings. Includes `start` event.
  11892. * On click, finds the closest point and marks it with an arrow and a label
  11893. * with value.
  11894. */
  11895. verticalLabel?: NavigationBindingsOptionsObject;
  11896. /**
  11897. * (Highstock) A vertical line annotation. Includes `start` event.
  11898. */
  11899. verticalLine?: NavigationBindingsOptionsObject;
  11900. /**
  11901. * (Highstock) Enables zooming in xAxis on a chart. Includes `start` event
  11902. * which changes chart.zoomType.
  11903. */
  11904. zoomX?: NavigationBindingsOptionsObject;
  11905. /**
  11906. * (Highstock) Enables zooming in xAxis and yAxis on a chart. Includes
  11907. * `start` event which changes chart.zoomType.
  11908. */
  11909. zoomXY?: NavigationBindingsOptionsObject;
  11910. /**
  11911. * (Highstock) Enables zooming in yAxis on a chart. Includes `start` event
  11912. * which changes chart.zoomType.
  11913. */
  11914. zoomY?: NavigationBindingsOptionsObject;
  11915. }
  11916. /**
  11917. * A config object for navigation bindings in annotations.
  11918. */
  11919. export interface NavigationBindingsOptionsObject {
  11920. /**
  11921. * ClassName of the element for a binding.
  11922. */
  11923. className?: string;
  11924. /**
  11925. * Last event to be fired after last step event.
  11926. */
  11927. end?: Function;
  11928. /**
  11929. * Initial event, fired on a button click.
  11930. */
  11931. init?: Function;
  11932. /**
  11933. * Event fired on first click on a chart.
  11934. */
  11935. start?: Function;
  11936. /**
  11937. * Last event to be fired after last step event. Array of step events to be
  11938. * called sequentially after each user click.
  11939. */
  11940. steps?: Array<Function>;
  11941. }
  11942. /**
  11943. * (Highcharts, Highstock, Highmaps, Gantt) A collection of options for buttons
  11944. * appearing in the exporting module.
  11945. *
  11946. * In styled mode, the buttons are styled with the `.highcharts-contextbutton`
  11947. * and `.highcharts-button-symbol` classes.
  11948. */
  11949. export interface NavigationButtonOptions {
  11950. /**
  11951. * (Highcharts, Highstock, Highmaps, Gantt) Alignment for the buttons.
  11952. */
  11953. align?: AlignValue;
  11954. /**
  11955. * (Highcharts, Highstock, Highmaps, Gantt) The pixel spacing between
  11956. * buttons.
  11957. */
  11958. buttonSpacing?: number;
  11959. /**
  11960. * (Highcharts, Highstock, Highmaps, Gantt) Whether to enable buttons.
  11961. */
  11962. enabled?: boolean;
  11963. /**
  11964. * (Highcharts, Highstock, Highmaps, Gantt) Pixel height of the buttons.
  11965. */
  11966. height?: number;
  11967. /**
  11968. * (Highcharts, Highstock, Highmaps, Gantt) Fill color for the symbol within
  11969. * the button.
  11970. */
  11971. symbolFill?: (ColorString|GradientColorObject|PatternObject);
  11972. /**
  11973. * (Highcharts, Highstock, Highmaps, Gantt) The pixel size of the symbol on
  11974. * the button.
  11975. */
  11976. symbolSize?: number;
  11977. /**
  11978. * (Highcharts, Highstock, Highmaps, Gantt) The color of the symbol's stroke
  11979. * or line.
  11980. */
  11981. symbolStroke?: ColorString;
  11982. /**
  11983. * (Highcharts, Highstock, Highmaps, Gantt) The pixel stroke width of the
  11984. * symbol on the button.
  11985. */
  11986. symbolStrokeWidth?: number;
  11987. /**
  11988. * (Highcharts, Highstock, Highmaps, Gantt) The x position of the center of
  11989. * the symbol inside the button.
  11990. */
  11991. symbolX?: number;
  11992. /**
  11993. * (Highcharts, Highstock, Highmaps, Gantt) The y position of the center of
  11994. * the symbol inside the button.
  11995. */
  11996. symbolY?: number;
  11997. /**
  11998. * (Highcharts, Highstock, Highmaps, Gantt) A text string to add to the
  11999. * individual button.
  12000. */
  12001. text?: string;
  12002. /**
  12003. * (Highcharts, Highstock, Highmaps, Gantt) A configuration object for the
  12004. * button theme. The object accepts SVG properties like `stroke-width`,
  12005. * `stroke` and `fill`. Tri-state button styles are supported by the
  12006. * `states.hover` and `states.select` objects.
  12007. */
  12008. theme?: NavigationButtonThemeOptions;
  12009. /**
  12010. * (Highcharts, Highstock, Highmaps, Gantt) The vertical alignment of the
  12011. * buttons. Can be one of `"top"`, `"middle"` or `"bottom"`.
  12012. */
  12013. verticalAlign?: VerticalAlignValue;
  12014. /**
  12015. * (Highcharts, Highstock, Highmaps, Gantt) The pixel width of the button.
  12016. */
  12017. width?: number;
  12018. /**
  12019. * (Highcharts, Highstock, Highmaps, Gantt) The vertical offset of the
  12020. * button's position relative to its `verticalAlign`.
  12021. */
  12022. y?: number;
  12023. }
  12024. /**
  12025. * (Highcharts, Highstock, Highmaps, Gantt) A configuration object for the
  12026. * button theme. The object accepts SVG properties like `stroke-width`, `stroke`
  12027. * and `fill`. Tri-state button styles are supported by the `states.hover` and
  12028. * `states.select` objects.
  12029. */
  12030. export interface NavigationButtonThemeOptions {
  12031. /**
  12032. * (Highcharts, Highstock, Highmaps, Gantt) The default fill exists only to
  12033. * capture hover events.
  12034. */
  12035. fill?: (ColorString|GradientColorObject|PatternObject);
  12036. /**
  12037. * (Highcharts, Highstock, Highmaps, Gantt) Padding for the button.
  12038. */
  12039. padding?: number;
  12040. /**
  12041. * (Highcharts, Highstock, Highmaps, Gantt) Default stroke for the buttons.
  12042. */
  12043. stroke?: ColorString;
  12044. }
  12045. /**
  12046. * (Highcharts, Highstock) Events to communicate between Stock Tools and custom
  12047. * GUI.
  12048. */
  12049. export interface NavigationEventsOptions {
  12050. /**
  12051. * (Highcharts, Highstock) A `closePopup` event. Fired when Popup should be
  12052. * hidden, for example when clicking on an annotation again.
  12053. */
  12054. closePopup?: Function;
  12055. /**
  12056. * (Highcharts, Highstock) Event fired when button state should change, for
  12057. * example after adding an annotation.
  12058. */
  12059. deselectButton?: Function;
  12060. /**
  12061. * (Highcharts, Highstock) Event fired on a button click.
  12062. */
  12063. selectButton?: Function;
  12064. /**
  12065. * (Highcharts, Highstock) A `showPopup` event. Fired when selecting for
  12066. * example an annotation.
  12067. */
  12068. showPopup?: Function;
  12069. }
  12070. /**
  12071. * (Highcharts, Highstock, Highmaps, Gantt) A collection of options for buttons
  12072. * and menus appearing in the exporting module.
  12073. */
  12074. export interface NavigationOptions {
  12075. /**
  12076. * (Highcharts, Highstock, Highmaps, Gantt) Additional options to be merged
  12077. * into all annotations.
  12078. */
  12079. annotationsOptions?: (AnnotationsOptions|NavigationAnnotationsOptions);
  12080. /**
  12081. * (Highcharts, Highstock) Bindings definitions for custom HTML buttons.
  12082. * Each binding implements simple event-driven interface:
  12083. *
  12084. * - `className`: classname used to bind event to
  12085. *
  12086. * - `init`: initial event, fired on button click
  12087. *
  12088. * - `start`: fired on first click on a chart
  12089. *
  12090. * - `steps`: array of sequential events fired one after another on each of
  12091. * users clicks
  12092. *
  12093. * - `end`: last event to be called after last step event
  12094. */
  12095. bindings?: (NavigationBindingsOptions|Dictionary<NavigationBindingsOptionsObject>);
  12096. /**
  12097. * (Highcharts, Highstock, Highmaps, Gantt) A CSS class name where all
  12098. * bindings will be attached to. Multiple charts on the same page should
  12099. * have separate class names to prevent duplicating events.
  12100. *
  12101. * Default value of versions < 7.0.4 `highcharts-bindings-wrapper`
  12102. */
  12103. bindingsClassName?: string;
  12104. /**
  12105. * (Highcharts, Highstock, Highmaps, Gantt) A collection of options for
  12106. * buttons appearing in the exporting module.
  12107. *
  12108. * In styled mode, the buttons are styled with the
  12109. * `.highcharts-contextbutton` and `.highcharts-button-symbol` classes.
  12110. */
  12111. buttonOptions?: NavigationButtonOptions;
  12112. /**
  12113. * (Highcharts, Highstock) Events to communicate between Stock Tools and
  12114. * custom GUI.
  12115. */
  12116. events?: NavigationEventsOptions;
  12117. /**
  12118. * (Highcharts, Highstock, Highmaps, Gantt) Path where Highcharts will look
  12119. * for icons. Change this to use icons from a different server.
  12120. */
  12121. iconsURL?: string;
  12122. /**
  12123. * (Highcharts, Highstock, Highmaps, Gantt) CSS styles for the hover state
  12124. * of the individual items within the popup menu appearing by default when
  12125. * the export icon is clicked. The menu items are rendered in HTML.
  12126. */
  12127. menuItemHoverStyle?: CSSObject;
  12128. /**
  12129. * (Highcharts, Highstock, Highmaps, Gantt) CSS styles for the individual
  12130. * items within the popup menu appearing by default when the export icon is
  12131. * clicked. The menu items are rendered in HTML. Font size defaults to
  12132. * `11px` on desktop and `14px` on touch devices.
  12133. */
  12134. menuItemStyle?: CSSObject;
  12135. /**
  12136. * (Highcharts, Highstock, Highmaps, Gantt) CSS styles for the popup menu
  12137. * appearing by default when the export icon is clicked. This menu is
  12138. * rendered in HTML.
  12139. */
  12140. menuStyle?: CSSObject;
  12141. }
  12142. /**
  12143. * (Highstock, Gantt) Options for the handles for dragging the zoomed area.
  12144. */
  12145. export interface NavigatorHandlesOptions {
  12146. /**
  12147. * (Highstock, Gantt) The fill for the handle.
  12148. */
  12149. backgroundColor?: (ColorString|GradientColorObject|PatternObject);
  12150. /**
  12151. * (Highstock, Gantt) The stroke for the handle border and the stripes
  12152. * inside.
  12153. */
  12154. borderColor?: (ColorString|GradientColorObject|PatternObject);
  12155. /**
  12156. * (Highstock, Gantt) Allows to enable/disable handles.
  12157. */
  12158. enabled?: boolean;
  12159. /**
  12160. * (Highstock, Gantt) Height for handles.
  12161. */
  12162. height?: number;
  12163. /**
  12164. * (Highstock, Gantt) The width for the handle border and the stripes
  12165. * inside.
  12166. */
  12167. lineWidth?: object;
  12168. /**
  12169. * (Highstock, Gantt) Array to define shapes of handles. 0-index for left,
  12170. * 1-index for right.
  12171. *
  12172. * Additionally, the URL to a graphic can be given on this form:
  12173. * `url(graphic.png)`. Note that for the image to be applied to exported
  12174. * charts, its URL needs to be accessible by the export server.
  12175. *
  12176. * Custom callbacks for symbol path generation can also be added to
  12177. * `Highcharts.SVGRenderer.prototype.symbols`. The callback is then used by
  12178. * its method name, as shown in the demo.
  12179. */
  12180. symbols?: Array<string>;
  12181. /**
  12182. * (Highstock, Gantt) Width for handles.
  12183. */
  12184. width?: number;
  12185. }
  12186. /**
  12187. * (Highstock, Gantt) The navigator is a small series below the main series,
  12188. * displaying a view of the entire data set. It provides tools to zoom in and
  12189. * out on parts of the data as well as panning across the dataset.
  12190. */
  12191. export interface NavigatorOptions {
  12192. /**
  12193. * (Highstock, Gantt) Whether the navigator and scrollbar should adapt to
  12194. * updated data in the base X axis. When loading data async, as in the demo
  12195. * below, this should be `false`. Otherwise new data will trigger navigator
  12196. * redraw, which will cause unwanted looping. In the demo below, the data in
  12197. * the navigator is set only once. On navigating, only the main chart
  12198. * content is updated.
  12199. */
  12200. adaptToUpdatedData?: boolean;
  12201. /**
  12202. * (Highstock, Gantt) Enable or disable the navigator.
  12203. */
  12204. enabled?: boolean;
  12205. /**
  12206. * (Highstock, Gantt) Options for the handles for dragging the zoomed area.
  12207. */
  12208. handles?: NavigatorHandlesOptions;
  12209. /**
  12210. * (Highstock, Gantt) The height of the navigator.
  12211. */
  12212. height?: number;
  12213. /**
  12214. * (Highstock, Gantt) The distance from the nearest element, the X axis or X
  12215. * axis labels.
  12216. */
  12217. margin?: number;
  12218. /**
  12219. * (Highstock, Gantt) The color of the mask covering the areas of the
  12220. * navigator series that are currently not visible in the main series. The
  12221. * default color is bluish with an opacity of 0.3 to see the series below.
  12222. */
  12223. maskFill?: (ColorString|GradientColorObject|PatternObject);
  12224. /**
  12225. * (Highstock, Gantt) Whether the mask should be inside the range marking
  12226. * the zoomed range, or outside. In Highstock 1.x it was always `false`.
  12227. */
  12228. maskInside?: boolean;
  12229. /**
  12230. * (Highstock, Gantt) When the chart is inverted, whether to draw the
  12231. * navigator on the opposite side.
  12232. */
  12233. opposite?: boolean;
  12234. /**
  12235. * (Highstock, Gantt) The color of the line marking the currently zoomed
  12236. * area in the navigator.
  12237. */
  12238. outlineColor?: (ColorString|GradientColorObject|PatternObject);
  12239. /**
  12240. * (Highstock, Gantt) The width of the line marking the currently zoomed
  12241. * area in the navigator.
  12242. */
  12243. outlineWidth?: number;
  12244. /**
  12245. * (Highstock, Gantt) Options for the navigator series. Available options
  12246. * are the same as any series, documented at plotOptions and series.
  12247. *
  12248. * Unless data is explicitly defined on navigator.series, the data is
  12249. * borrowed from the first series in the chart.
  12250. *
  12251. * Default series options for the navigator series are: (see online
  12252. * documentation for example)
  12253. */
  12254. series?: (NavigatorSeriesOptions|SeriesOptionsType|Array<NavigatorSeriesOptions>|Array<SeriesOptionsType>);
  12255. /**
  12256. * (Highstock, Gantt) Options for the navigator X axis. Default series
  12257. * options for the navigator xAxis are: (see online documentation for
  12258. * example)
  12259. */
  12260. xAxis?: (NavigatorXAxisOptions|Array<NavigatorXAxisOptions>);
  12261. /**
  12262. * (Highstock, Gantt) Options for the navigator Y axis. Default series
  12263. * options for the navigator yAxis are: (see online documentation for
  12264. * example)
  12265. */
  12266. yAxis?: (NavigatorYAxisOptions|Array<NavigatorYAxisOptions>);
  12267. }
  12268. /**
  12269. * (Highcharts, Highstock, Highmaps, Gantt) Enable or disable the initial
  12270. * animation when a series is displayed for the `dataLabels`. The animation can
  12271. * also be set as a configuration object. Please note that this option only
  12272. * applies to the initial animation. For other animations, see chart.animation
  12273. * and the animation parameter under the API methods. The following properties
  12274. * are supported:
  12275. *
  12276. * - `defer`: The animation delay time in milliseconds.
  12277. */
  12278. export interface NavigatorSeriesDataLabelsAnimationOptions {
  12279. /**
  12280. * (Highcharts, Highstock, Highmaps, Gantt) The animation delay time in
  12281. * milliseconds. Set to `0` renders dataLabel immediately. As `undefined`
  12282. * inherits defer time from the series.animation.defer.
  12283. */
  12284. defer?: number;
  12285. }
  12286. /**
  12287. * (Highcharts, Highstock, Highmaps, Gantt) Data label options for the navigator
  12288. * series. Data labels are disabled by default on the navigator series.
  12289. */
  12290. export interface NavigatorSeriesDataLabelsOptions {
  12291. /**
  12292. * (Highcharts, Highstock, Highmaps, Gantt) The alignment of the data label
  12293. * compared to the point. If `right`, the right side of the label should be
  12294. * touching the point. For points with an extent, like columns, the
  12295. * alignments also dictates how to align it inside the box, as given with
  12296. * the inside option. Can be one of `left`, `center` or `right`.
  12297. */
  12298. align?: (AlignValue|null);
  12299. /**
  12300. * (Highcharts, Highstock, Highmaps, Gantt) Whether to allow data labels to
  12301. * overlap. To make the labels less sensitive for overlapping, the
  12302. * dataLabels.padding can be set to 0.
  12303. */
  12304. allowOverlap?: boolean;
  12305. /**
  12306. * (Highcharts, Highstock, Highmaps, Gantt) Enable or disable the initial
  12307. * animation when a series is displayed for the `dataLabels`. The animation
  12308. * can also be set as a configuration object. Please note that this option
  12309. * only applies to the initial animation. For other animations, see
  12310. * chart.animation and the animation parameter under the API methods. The
  12311. * following properties are supported:
  12312. *
  12313. * - `defer`: The animation delay time in milliseconds.
  12314. */
  12315. animation?: (boolean|NavigatorSeriesDataLabelsAnimationOptions|Partial<AnimationOptionsObject>);
  12316. /**
  12317. * (Highcharts, Highstock, Highmaps, Gantt) The background color or gradient
  12318. * for the data label.
  12319. */
  12320. backgroundColor?: (ColorString|GradientColorObject|PatternObject);
  12321. /**
  12322. * (Highcharts, Highstock, Highmaps, Gantt) The border color for the data
  12323. * label. Defaults to `undefined`.
  12324. */
  12325. borderColor?: (ColorString|GradientColorObject|PatternObject);
  12326. /**
  12327. * (Highcharts, Highstock, Highmaps, Gantt) The border radius in pixels for
  12328. * the data label.
  12329. */
  12330. borderRadius?: number;
  12331. /**
  12332. * (Highcharts, Highstock, Highmaps, Gantt) The border width in pixels for
  12333. * the data label.
  12334. */
  12335. borderWidth?: number;
  12336. /**
  12337. * (Highcharts, Highstock, Highmaps, Gantt) A class name for the data label.
  12338. * Particularly in styled mode, this can be used to give each series' or
  12339. * point's data label unique styling. In addition to this option, a default
  12340. * color class name is added so that we can give the labels a contrast text
  12341. * shadow.
  12342. */
  12343. className?: string;
  12344. /**
  12345. * (Highcharts, Highstock, Highmaps, Gantt) The text color for the data
  12346. * labels. Defaults to `undefined`. For certain series types, like column or
  12347. * map, the data labels can be drawn inside the points. In this case the
  12348. * data label will be drawn with maximum contrast by default. Additionally,
  12349. * it will be given a `text-outline` style with the opposite color, to
  12350. * further increase the contrast. This can be overridden by setting the
  12351. * `text-outline` style to `none` in the `dataLabels.style` option.
  12352. */
  12353. color?: (ColorString|GradientColorObject|PatternObject);
  12354. /**
  12355. * (Highcharts, Highstock, Highmaps, Gantt) Whether to hide data labels that
  12356. * are outside the plot area. By default, the data label is moved inside the
  12357. * plot area according to the overflow option.
  12358. */
  12359. crop?: boolean;
  12360. /**
  12361. * (Highcharts, Highstock, Gantt) Whether to defer displaying the data
  12362. * labels until the initial series animation has finished. Setting to
  12363. * `false` renders the data label immediately. If set to `true` inherits the
  12364. * defer time set in plotOptions.series.animation.
  12365. */
  12366. defer?: boolean;
  12367. /**
  12368. * (Highcharts, Highstock, Highmaps, Gantt) Enable or disable the data
  12369. * labels.
  12370. */
  12371. enabled?: boolean;
  12372. /**
  12373. * (Highcharts, Highstock, Highmaps, Gantt) A declarative filter to control
  12374. * of which data labels to display. The declarative filter is designed for
  12375. * use when callback functions are not available, like when the chart
  12376. * options require a pure JSON structure or for use with graphical editors.
  12377. * For programmatic control, use the `formatter` instead, and return
  12378. * `undefined` to disable a single data label.
  12379. */
  12380. filter?: DataLabelsFilterOptionsObject;
  12381. /**
  12382. * (Highcharts, Highstock, Highmaps, Gantt) A format string for the data
  12383. * label. Available variables are the same as for `formatter`.
  12384. */
  12385. format?: string;
  12386. /**
  12387. * (Highcharts, Highstock, Highmaps, Gantt) Callback JavaScript function to
  12388. * format the data label. Note that if a `format` is defined, the format
  12389. * takes precedence and the formatter is ignored.
  12390. */
  12391. formatter?: DataLabelsFormatterCallbackFunction;
  12392. /**
  12393. * (Highcharts, Highstock, Highmaps, Gantt) For points with an extent, like
  12394. * columns or map areas, whether to align the data label inside the box or
  12395. * to the actual value point. Defaults to `false` in most cases, `true` in
  12396. * stacked columns.
  12397. */
  12398. inside?: boolean;
  12399. /**
  12400. * (Highcharts, Highstock, Highmaps, Gantt) Format for points with the value
  12401. * of null. Works analogously to format. `nullFormat` can be applied only to
  12402. * series which support displaying null points.
  12403. */
  12404. nullFormat?: (boolean|string);
  12405. /**
  12406. * (Highcharts, Highstock, Highmaps, Gantt) Callback JavaScript function
  12407. * that defines formatting for points with the value of null. Works
  12408. * analogously to formatter. `nullPointFormatter` can be applied only to
  12409. * series which support displaying null points.
  12410. */
  12411. nullFormatter?: DataLabelsFormatterCallbackFunction;
  12412. /**
  12413. * (Highcharts, Highstock, Highmaps, Gantt) How to handle data labels that
  12414. * flow outside the plot area. The default is `"justify"`, which aligns them
  12415. * inside the plot area. For columns and bars, this means it will be moved
  12416. * inside the bar. To display data labels outside the plot area, set `crop`
  12417. * to `false` and `overflow` to `"allow"`.
  12418. */
  12419. overflow?: DataLabelsOverflowValue;
  12420. /**
  12421. * (Highcharts, Highstock, Highmaps, Gantt) When either the `borderWidth` or
  12422. * the `backgroundColor` is set, this is the padding within the box.
  12423. */
  12424. padding?: number;
  12425. /**
  12426. * (Highcharts, Highstock, Highmaps, Gantt) Aligns data labels relative to
  12427. * points. If `center` alignment is not possible, it defaults to `right`.
  12428. */
  12429. position?: AlignValue;
  12430. /**
  12431. * (Highcharts, Highstock, Highmaps, Gantt) Text rotation in degrees. Note
  12432. * that due to a more complex structure, backgrounds, borders and padding
  12433. * will be lost on a rotated data label.
  12434. */
  12435. rotation?: number;
  12436. /**
  12437. * (Highcharts, Highstock, Highmaps, Gantt) The shadow of the box. Works
  12438. * best with `borderWidth` or `backgroundColor`. Since 2.3 the shadow can be
  12439. * an object configuration containing `color`, `offsetX`, `offsetY`,
  12440. * `opacity` and `width`.
  12441. */
  12442. shadow?: (boolean|ShadowOptionsObject);
  12443. /**
  12444. * (Highcharts, Highstock, Highmaps, Gantt) The name of a symbol to use for
  12445. * the border around the label. Symbols are predefined functions on the
  12446. * Renderer object.
  12447. */
  12448. shape?: string;
  12449. /**
  12450. * (Highcharts, Highstock, Highmaps, Gantt) Styles for the label. The
  12451. * default `color` setting is `"contrast"`, which is a pseudo color that
  12452. * Highcharts picks up and applies the maximum contrast to the underlying
  12453. * point item, for example the bar in a bar chart.
  12454. *
  12455. * The `textOutline` is a pseudo property that applies an outline of the
  12456. * given width with the given color, which by default is the maximum
  12457. * contrast to the text. So a bright text color will result in a black text
  12458. * outline for maximum readability on a mixed background. In some cases,
  12459. * especially with grayscale text, the text outline doesn't work well, in
  12460. * which cases it can be disabled by setting it to `"none"`. When `useHTML`
  12461. * is true, the `textOutline` will not be picked up. In this, case, the same
  12462. * effect can be acheived through the `text-shadow` CSS property.
  12463. *
  12464. * For some series types, where each point has an extent, like for example
  12465. * tree maps, the data label may overflow the point. There are two
  12466. * strategies for handling overflow. By default, the text will wrap to
  12467. * multiple lines. The other strategy is to set `style.textOverflow` to
  12468. * `ellipsis`, which will keep the text on one line plus it will break
  12469. * inside long words.
  12470. */
  12471. style?: CSSObject;
  12472. /**
  12473. * (Highcharts, Highstock, Highmaps, Gantt) Options for a label text which
  12474. * should follow marker's shape. Border and background are disabled for a
  12475. * label that follows a path.
  12476. *
  12477. * **Note:** Only SVG-based renderer supports this option. Setting `useHTML`
  12478. * to true will disable this option.
  12479. */
  12480. textPath?: DataLabelsTextPathOptionsObject;
  12481. /**
  12482. * (Highcharts, Highstock, Highmaps, Gantt) Whether to use HTML to render
  12483. * the labels.
  12484. */
  12485. useHTML?: boolean;
  12486. /**
  12487. * (Highcharts, Highstock, Highmaps, Gantt) The vertical alignment of a data
  12488. * label. Can be one of `top`, `middle` or `bottom`. The default value
  12489. * depends on the data, for instance in a column chart, the label is above
  12490. * positive values and below negative values.
  12491. */
  12492. verticalAlign?: (VerticalAlignValue|null);
  12493. /**
  12494. * (Highcharts, Highstock, Highmaps, Gantt) The x position offset of the
  12495. * label relative to the point in pixels.
  12496. */
  12497. x?: number;
  12498. /**
  12499. * (Highcharts, Highstock, Highmaps, Gantt) The y position offset of the
  12500. * label relative to the point in pixels.
  12501. */
  12502. y?: number;
  12503. /**
  12504. * (Highcharts, Highstock, Highmaps, Gantt) The Z index of the data labels.
  12505. * The default Z index puts it above the series. Use a Z index of 2 to
  12506. * display it behind the series.
  12507. */
  12508. z?: number;
  12509. zIndex?: number;
  12510. }
  12511. export interface NavigatorSeriesMarkerOptions {
  12512. enabled?: boolean;
  12513. }
  12514. /**
  12515. * (Highstock, Gantt) Options for the navigator series. Available options are
  12516. * the same as any series, documented at plotOptions and series.
  12517. *
  12518. * Unless data is explicitly defined on navigator.series, the data is borrowed
  12519. * from the first series in the chart.
  12520. *
  12521. * Default series options for the navigator series are: (see online
  12522. * documentation for example)
  12523. */
  12524. export interface NavigatorSeriesOptions {
  12525. className?: string;
  12526. /**
  12527. * (Highstock, Gantt) Sets the fill color of the navigator series.
  12528. */
  12529. color?: (ColorString|GradientColorObject|PatternObject);
  12530. /**
  12531. * (Highstock) Unless data is explicitly defined, the data is borrowed from
  12532. * the first series in the chart.
  12533. */
  12534. data?: Array<(number|Array<(number|string|null)>|object|null)>;
  12535. /**
  12536. * (Highstock) Data grouping options for the navigator series.
  12537. */
  12538. dataGrouping?: DataGroupingOptionsObject;
  12539. /**
  12540. * (Highcharts, Highstock, Highmaps, Gantt) Data label options for the
  12541. * navigator series. Data labels are disabled by default on the navigator
  12542. * series.
  12543. */
  12544. dataLabels?: (NavigatorSeriesDataLabelsOptions|Array<NavigatorSeriesDataLabelsOptions>);
  12545. /**
  12546. * (Highstock, Gantt) The fill opacity of the navigator series.
  12547. */
  12548. fillOpacity?: number;
  12549. id?: string;
  12550. /**
  12551. * (Highstock, Gantt) Line color for the navigator series. Allows setting
  12552. * the color while disallowing the default candlestick setting.
  12553. */
  12554. lineColor?: (ColorString|null);
  12555. /**
  12556. * (Highstock, Gantt) The pixel line width of the navigator series.
  12557. */
  12558. lineWidth?: number;
  12559. marker?: NavigatorSeriesMarkerOptions;
  12560. /**
  12561. * (Highstock) Since Highstock v8, default value is the same as default
  12562. * `pointRange` defined for a specific type (e.g. `null` for column type).
  12563. *
  12564. * In Highstock version < 8, defaults to 0.
  12565. */
  12566. pointRange?: (number|null);
  12567. /**
  12568. * (Highstock, Gantt) The threshold option. Setting it to 0 will make the
  12569. * default navigator area series draw its area from the 0 value and up.
  12570. */
  12571. threshold?: (number|null);
  12572. /**
  12573. * (Highstock, Gantt) The type of the navigator series.
  12574. *
  12575. * Heads up: In column-type navigator, zooming is limited to at least one
  12576. * point with its `pointRange`.
  12577. */
  12578. type?: string;
  12579. }
  12580. /**
  12581. * (Highcharts, Highstock, Gantt) An array defining breaks in the axis, the
  12582. * sections defined will be left out and all the points shifted closer to each
  12583. * other.
  12584. */
  12585. export interface NavigatorXAxisBreaksOptions {
  12586. /**
  12587. * (Highcharts, Highstock, Gantt) A number indicating how much space should
  12588. * be left between the start and the end of the break. The break size is
  12589. * given in axis units, so for instance on a `datetime` axis, a break size
  12590. * of 3600000 would indicate the equivalent of an hour.
  12591. */
  12592. breakSize?: number;
  12593. /**
  12594. * (Highcharts, Highstock, Gantt) The point where the break starts.
  12595. */
  12596. from?: number;
  12597. /**
  12598. * (Highcharts, Highstock, Gantt) Defines an interval after which the break
  12599. * appears again. By default the breaks do not repeat.
  12600. */
  12601. repeat?: number;
  12602. /**
  12603. * (Highcharts, Highstock, Gantt) The point where the break ends.
  12604. */
  12605. to?: number;
  12606. }
  12607. /**
  12608. * (Gantt) An object defining mouse events for the plot line. Supported
  12609. * properties are `click`, `mouseover`, `mouseout`, `mousemove`.
  12610. */
  12611. export interface NavigatorXAxisCurrentDateIndicatorEventsOptions {
  12612. /**
  12613. * (Gantt) Click event on a plot band.
  12614. */
  12615. click?: EventCallbackFunction<PlotLineOrBand>;
  12616. /**
  12617. * (Gantt) Mouse move event on a plot band.
  12618. */
  12619. mousemove?: EventCallbackFunction<PlotLineOrBand>;
  12620. /**
  12621. * (Gantt) Mouse out event on the corner of a plot band.
  12622. */
  12623. mouseout?: EventCallbackFunction<PlotLineOrBand>;
  12624. /**
  12625. * (Gantt) Mouse over event on a plot band.
  12626. */
  12627. mouseover?: EventCallbackFunction<PlotLineOrBand>;
  12628. }
  12629. /**
  12630. * (Gantt) Text labels for the plot bands
  12631. */
  12632. export interface NavigatorXAxisCurrentDateIndicatorLabelOptions {
  12633. /**
  12634. * (Gantt) Horizontal alignment of the label. Can be one of "left", "center"
  12635. * or "right".
  12636. */
  12637. align?: AlignValue;
  12638. /**
  12639. * (Gantt) Format of the label. This options is passed as the fist argument
  12640. * to dateFormat function.
  12641. */
  12642. format?: string;
  12643. /**
  12644. * (Gantt) Callback JavaScript function to format the label. Useful
  12645. * properties like the value of plot line or the range of plot band (`from`
  12646. * & `to` properties) can be found in `this.options` object.
  12647. */
  12648. formatter?: FormatterCallbackFunction<PlotLineOrBand>;
  12649. /**
  12650. * (Gantt) Rotation of the text label in degrees. Defaults to 0 for
  12651. * horizontal plot lines and 90 for vertical lines.
  12652. */
  12653. rotation?: number;
  12654. /**
  12655. * (Gantt) CSS styles for the text label.
  12656. *
  12657. * In styled mode, the labels are styled by the
  12658. * `.highcharts-plot-line-label` class.
  12659. */
  12660. style?: CSSObject;
  12661. /**
  12662. * (Gantt) The text itself. A subset of HTML is supported.
  12663. */
  12664. text?: string;
  12665. /**
  12666. * (Gantt) The text alignment for the label. While `align` determines where
  12667. * the texts anchor point is placed within the plot band, `textAlign`
  12668. * determines how the text is aligned against its anchor point. Possible
  12669. * values are "left", "center" and "right". Defaults to the same as the
  12670. * `align` option.
  12671. */
  12672. textAlign?: AlignValue;
  12673. /**
  12674. * (Gantt) Whether to use HTML to render the labels.
  12675. */
  12676. useHTML?: boolean;
  12677. /**
  12678. * (Gantt) Vertical alignment of the label relative to the plot line. Can be
  12679. * one of "top", "middle" or "bottom".
  12680. */
  12681. verticalAlign?: VerticalAlignValue;
  12682. /**
  12683. * (Gantt) Horizontal position relative the alignment. Default varies by
  12684. * orientation.
  12685. */
  12686. x?: number;
  12687. /**
  12688. * (Gantt) Vertical position of the text baseline relative to the alignment.
  12689. * Default varies by orientation.
  12690. */
  12691. y?: number;
  12692. }
  12693. /**
  12694. * (Highstock, Gantt) Event handlers for the axis.
  12695. */
  12696. export interface NavigatorXAxisEventsOptions {
  12697. /**
  12698. * (Highcharts, Gantt) An event fired after the breaks have rendered.
  12699. */
  12700. afterBreaks?: AxisEventCallbackFunction;
  12701. /**
  12702. * (Highstock, Gantt) As opposed to the `setExtremes` event, this event
  12703. * fires after the final min and max values are computed and corrected for
  12704. * `minRange`.
  12705. *
  12706. * Fires when the minimum and maximum is set for the axis, either by calling
  12707. * the `.setExtremes()` method or by selecting an area in the chart. One
  12708. * parameter, `event`, is passed to the function, containing common event
  12709. * information.
  12710. *
  12711. * The new user set minimum and maximum values can be found by `event.min`
  12712. * and `event.max`. These reflect the axis minimum and maximum in axis
  12713. * values. The actual data extremes are found in `event.dataMin` and
  12714. * `event.dataMax`.
  12715. */
  12716. afterSetExtremes?: AxisSetExtremesEventCallbackFunction;
  12717. /**
  12718. * (Highcharts, Gantt) An event fired when a break from this axis occurs on
  12719. * a point.
  12720. */
  12721. pointBreak?: AxisPointBreakEventCallbackFunction;
  12722. /**
  12723. * (Highcharts, Highstock, Gantt) An event fired when a point falls inside a
  12724. * break from this axis.
  12725. */
  12726. pointInBreak?: AxisPointBreakEventCallbackFunction;
  12727. /**
  12728. * (Highstock, Gantt) Fires when the minimum and maximum is set for the
  12729. * axis, either by calling the `.setExtremes()` method or by selecting an
  12730. * area in the chart. One parameter, `event`, is passed to the function,
  12731. * containing common event information.
  12732. *
  12733. * The new user set minimum and maximum values can be found by `event.min`
  12734. * and `event.max`. These reflect the axis minimum and maximum in data
  12735. * values. When an axis is zoomed all the way out from the "Reset zoom"
  12736. * button, `event.min` and `event.max` are null, and the new extremes are
  12737. * set based on `this.dataMin` and `this.dataMax`.
  12738. */
  12739. setExtremes?: AxisSetExtremesEventCallbackFunction;
  12740. }
  12741. /**
  12742. * (Gantt) Set grid options for the axis labels. Requires Highcharts Gantt.
  12743. */
  12744. export interface NavigatorXAxisGridOptions {
  12745. /**
  12746. * (Gantt) Set border color for the label grid lines.
  12747. */
  12748. borderColor?: ColorString;
  12749. /**
  12750. * (Gantt) Set border width of the label grid lines.
  12751. */
  12752. borderWidth?: number;
  12753. /**
  12754. * (Gantt) Set cell height for grid axis labels. By default this is
  12755. * calculated from font size. This option only applies to horizontal axes.
  12756. */
  12757. cellHeight?: number;
  12758. /**
  12759. * (Gantt) Set specific options for each column (or row for horizontal axes)
  12760. * in the grid. Each extra column/row is its own axis, and the axis options
  12761. * can be set here.
  12762. */
  12763. columns?: Array<XAxisOptions>;
  12764. /**
  12765. * (Gantt) Enable grid on the axis labels. Defaults to true for Gantt
  12766. * charts.
  12767. */
  12768. enabled?: boolean;
  12769. }
  12770. /**
  12771. * (Highstock, Gantt) The axis labels show the number or category for each tick.
  12772. *
  12773. * Since v8.0.0: Labels are animated in categorized x-axis with updating data if
  12774. * `tickInterval` and `step` is set to 1.
  12775. */
  12776. export interface NavigatorXAxisLabelsOptions {
  12777. /**
  12778. * (Highstock, Gantt) What part of the string the given position is anchored
  12779. * to. If `left`, the left side of the string is at the axis position. Can
  12780. * be one of `"left"`, `"center"` or `"right"`. Defaults to an intelligent
  12781. * guess based on which side of the chart the axis is on and the rotation of
  12782. * the label.
  12783. */
  12784. align?: string;
  12785. /**
  12786. * (Highcharts, Highstock, Gantt) For horizontal axes, the allowed degrees
  12787. * of label rotation to prevent overlapping labels. If there is enough
  12788. * space, labels are not rotated. As the chart gets narrower, it will start
  12789. * rotating the labels -45 degrees, then remove every second label and try
  12790. * again with rotations 0 and -45 etc. Set it to `false` to disable
  12791. * rotation, which will cause the labels to word-wrap if possible.
  12792. */
  12793. autoRotation?: (false|Array<number>);
  12794. /**
  12795. * (Highcharts, Gantt) When each category width is more than this many
  12796. * pixels, we don't apply auto rotation. Instead, we lay out the axis label
  12797. * with word wrap. A lower limit makes sense when the label contains
  12798. * multiple short words that don't extend the available horizontal space for
  12799. * each label.
  12800. */
  12801. autoRotationLimit?: number;
  12802. /**
  12803. * (Highcharts, Gantt) Polar charts only. The label's pixel distance from
  12804. * the perimeter of the plot area.
  12805. */
  12806. distance?: number;
  12807. /**
  12808. * (Highstock, Gantt) Enable or disable the axis labels.
  12809. */
  12810. enabled?: boolean;
  12811. /**
  12812. * (Highstock, Gantt) A format string for the axis label. See format string
  12813. * for example usage.
  12814. *
  12815. * Note: The default value is not specified due to the dynamic nature of the
  12816. * default implementation.
  12817. */
  12818. format?: string;
  12819. /**
  12820. * (Highstock, Gantt) Callback JavaScript function to format the label. The
  12821. * value is given by `this.value`. Additional properties for `this` are
  12822. * `axis`, `chart`, `isFirst` and `isLast`. The value of the default label
  12823. * formatter can be retrieved by calling
  12824. * `this.axis.defaultLabelFormatter.call(this)` within the function.
  12825. *
  12826. * Defaults to: (see online documentation for example)
  12827. */
  12828. formatter?: AxisLabelsFormatterCallbackFunction;
  12829. /**
  12830. * (Gantt) The number of pixels to indent the labels per level in a treegrid
  12831. * axis.
  12832. */
  12833. indentation?: number;
  12834. /**
  12835. * (Highstock, Gantt) How to handle overflowing labels on horizontal axis.
  12836. * If set to `"allow"`, it will not be aligned at all. By default it
  12837. * `"justify"` labels inside the chart area. If there is room to move it, it
  12838. * will be aligned to the edge, else it will be removed.
  12839. */
  12840. overflow?: OptionsOverflowValue;
  12841. /**
  12842. * (Highcharts, Gantt) The pixel padding for axis labels, to ensure white
  12843. * space between them.
  12844. */
  12845. padding?: number;
  12846. /**
  12847. * (Highcharts) Defines how the labels are be repositioned according to the
  12848. * 3D chart orientation.
  12849. *
  12850. * - `'offset'`: Maintain a fixed horizontal/vertical distance from the tick
  12851. * marks, despite the chart orientation. This is the backwards compatible
  12852. * behavior, and causes skewing of X and Z axes.
  12853. *
  12854. * - `'chart'`: Preserve 3D position relative to the chart. This looks nice,
  12855. * but hard to read if the text isn't forward-facing.
  12856. *
  12857. * - `'flap'`: Rotated text along the axis to compensate for the chart
  12858. * orientation. This tries to maintain text as legible as possible on all
  12859. * orientations.
  12860. *
  12861. * - `'ortho'`: Rotated text along the axis direction so that the labels are
  12862. * orthogonal to the axis. This is very similar to `'flap'`, but prevents
  12863. * skewing the labels (X and Y scaling are still present).
  12864. */
  12865. position3d?: OptionsPosition3dValue;
  12866. /**
  12867. * (Highcharts, Gantt) Whether to reserve space for the labels. By default,
  12868. * space is reserved for the labels in these cases:
  12869. *
  12870. * * On all horizontal axes.
  12871. *
  12872. * * On vertical axes if `label.align` is `right` on a left-side axis or
  12873. * `left` on a right-side axis.
  12874. *
  12875. * * On vertical axes if `label.align` is `center`.
  12876. *
  12877. * This can be turned off when for example the labels are rendered inside
  12878. * the plot area instead of outside.
  12879. */
  12880. reserveSpace?: boolean;
  12881. /**
  12882. * (Highstock, Gantt) Rotation of the labels in degrees.
  12883. */
  12884. rotation?: number;
  12885. /**
  12886. * (Highcharts) If enabled, the axis labels will skewed to follow the
  12887. * perspective.
  12888. *
  12889. * This will fix overlapping labels and titles, but texts become less
  12890. * legible due to the distortion.
  12891. *
  12892. * The final appearance depends heavily on `labels.position3d`.
  12893. */
  12894. skew3d?: boolean;
  12895. /**
  12896. * (Highstock, Gantt) Horizontal axes only. The number of lines to spread
  12897. * the labels over to make room or tighter labels.
  12898. */
  12899. staggerLines?: number;
  12900. /**
  12901. * (Highstock, Gantt) To show only every _n_'th label on the axis, set the
  12902. * step to _n_. Setting the step to 2 shows every other label.
  12903. *
  12904. * By default, the step is calculated automatically to avoid overlap. To
  12905. * prevent this, set it to 1\. This usually only happens on a category axis,
  12906. * and is often a sign that you have chosen the wrong axis type.
  12907. *
  12908. * Read more at Axis docs => What axis should I use?
  12909. */
  12910. step?: number;
  12911. /**
  12912. * (Highstock, Gantt) CSS styles for the label. Use `whiteSpace: 'nowrap'`
  12913. * to prevent wrapping of category labels. Use `textOverflow: 'none'` to
  12914. * prevent ellipsis (dots).
  12915. *
  12916. * In styled mode, the labels are styled with the `.highcharts-axis-labels`
  12917. * class.
  12918. */
  12919. style?: CSSObject;
  12920. /**
  12921. * (Highstock, Gantt) Whether to use HTML to render the labels.
  12922. */
  12923. useHTML?: boolean;
  12924. /**
  12925. * (Highstock, Gantt) The x position offset of all labels relative to the
  12926. * tick positions on the axis.
  12927. */
  12928. x?: number;
  12929. /**
  12930. * (Highstock, Gantt) The y position offset of all labels relative to the
  12931. * tick positions on the axis. The default makes it adapt to the font size
  12932. * of the bottom axis.
  12933. */
  12934. y?: number;
  12935. /**
  12936. * (Highstock, Gantt) The Z index for the axis labels.
  12937. */
  12938. zIndex?: number;
  12939. }
  12940. /**
  12941. * (Highstock, Gantt) Options for the navigator X axis. Default series options
  12942. * for the navigator xAxis are: (see online documentation for example)
  12943. */
  12944. export interface NavigatorXAxisOptions {
  12945. /**
  12946. * (Highstock, Gantt) Accessibility options for an axis. Requires the
  12947. * accessibility module.
  12948. */
  12949. accessibility?: AxisAccessibilityOptionsObject;
  12950. /**
  12951. * (Highcharts, Highstock, Gantt) When using multiple axis, the ticks of two
  12952. * or more opposite axes will automatically be aligned by adding ticks to
  12953. * the axis or axes with the least ticks, as if `tickAmount` were specified.
  12954. *
  12955. * This can be prevented by setting `alignTicks` to false. If the grid lines
  12956. * look messy, it's a good idea to hide them for the secondary axis by
  12957. * setting `gridLineWidth` to 0.
  12958. *
  12959. * If `startOnTick` or `endOnTick` in an Axis options are set to false, then
  12960. * the `alignTicks ` will be disabled for the Axis.
  12961. *
  12962. * Disabled for logarithmic axes.
  12963. */
  12964. alignTicks?: boolean;
  12965. /**
  12966. * (Highstock, Gantt) Whether to allow decimals in this axis' ticks. When
  12967. * counting integers, like persons or hits on a web page, decimals should be
  12968. * avoided in the labels.
  12969. */
  12970. allowDecimals?: boolean;
  12971. /**
  12972. * (Highstock, Gantt) When using an alternate grid color, a band is painted
  12973. * across the plot area between every other grid line.
  12974. */
  12975. alternateGridColor?: ColorType;
  12976. /**
  12977. * (Highcharts) In a polar chart, this is the angle of the Y axis in
  12978. * degrees, where 0 is up and 90 is right. The angle determines the position
  12979. * of the axis line and the labels, though the coordinate system is
  12980. * unaffected. Since v8.0.0 this option is also applicable for X axis
  12981. * (inverted polar).
  12982. */
  12983. angle?: number;
  12984. /**
  12985. * (Highcharts, Highstock, Gantt) An array defining breaks in the axis, the
  12986. * sections defined will be left out and all the points shifted closer to
  12987. * each other.
  12988. */
  12989. breaks?: Array<NavigatorXAxisBreaksOptions>;
  12990. /**
  12991. * (Highcharts, Gantt) If categories are present for the xAxis, names are
  12992. * used instead of numbers for that axis.
  12993. *
  12994. * Since Highcharts 3.0, categories can also be extracted by giving each
  12995. * point a name and setting axis type to `category`. However, if you have
  12996. * multiple series, best practice remains defining the `categories` array.
  12997. *
  12998. * Example: `categories: ['Apples', 'Bananas', 'Oranges']`
  12999. */
  13000. categories?: Array<string>;
  13001. /**
  13002. * (Highcharts, Highstock, Gantt) The highest allowed value for
  13003. * automatically computed axis extremes.
  13004. */
  13005. ceiling?: number;
  13006. /**
  13007. * (Highstock, Gantt) A class name that opens for styling the axis by CSS,
  13008. * especially in Highcharts styled mode. The class name is applied to group
  13009. * elements for the grid, axis elements and labels.
  13010. */
  13011. className?: string;
  13012. /**
  13013. * (Highstock, Gantt) Configure a crosshair that follows either the mouse
  13014. * pointer or the hovered point.
  13015. *
  13016. * In styled mode, the crosshairs are styled in the `.highcharts-crosshair`,
  13017. * `.highcharts-crosshair-thin` or `.highcharts-xaxis-category` classes.
  13018. */
  13019. crosshair?: (boolean|AxisCrosshairOptions);
  13020. /**
  13021. * (Gantt) Show an indicator on the axis for the current date and time. Can
  13022. * be a boolean or a configuration object similar to xAxis.plotLines.
  13023. */
  13024. currentDateIndicator?: (boolean|AxisCurrentDateIndicatorOptions);
  13025. /**
  13026. * (Highcharts, Highstock, Gantt) For a datetime axis, the scale will
  13027. * automatically adjust to the appropriate unit. This member gives the
  13028. * default string representations used for each unit. For intermediate
  13029. * values, different units may be used, for example the `day` unit can be
  13030. * used on midnight and `hour` unit be used for intermediate values on the
  13031. * same axis.
  13032. *
  13033. * For an overview of the replacement codes, see dateFormat.
  13034. *
  13035. * Defaults to: (see online documentation for example)
  13036. */
  13037. dateTimeLabelFormats?: AxisDateTimeLabelFormatsOptions;
  13038. /**
  13039. * (Highstock, Gantt) Whether to force the axis to end on a tick. Use this
  13040. * option with the `maxPadding` option to control the axis end.
  13041. */
  13042. endOnTick?: boolean;
  13043. /**
  13044. * (Highstock, Gantt) Event handlers for the axis.
  13045. */
  13046. events?: NavigatorXAxisEventsOptions;
  13047. /**
  13048. * (Highcharts, Highstock, Gantt) The lowest allowed value for automatically
  13049. * computed axis extremes.
  13050. */
  13051. floor?: number;
  13052. /**
  13053. * (Gantt) Set grid options for the axis labels. Requires Highcharts Gantt.
  13054. */
  13055. grid?: NavigatorXAxisGridOptions;
  13056. /**
  13057. * (Highstock, Gantt) Color of the grid lines extending the ticks across the
  13058. * plot area.
  13059. *
  13060. * In styled mode, the stroke is given in the `.highcharts-grid-line` class.
  13061. */
  13062. gridLineColor?: string;
  13063. /**
  13064. * (Highstock, Gantt) The dash or dot style of the grid lines. For possible
  13065. * values, see this demonstration.
  13066. */
  13067. gridLineDashStyle?: DashStyleValue;
  13068. /**
  13069. * (Highcharts) Polar charts only. Whether the grid lines should draw as a
  13070. * polygon with straight lines between categories, or as circles. Can be
  13071. * either `circle` or `polygon`. Since v8.0.0 this option is also applicable
  13072. * for X axis (inverted polar).
  13073. */
  13074. gridLineInterpolation?: OptionsGridLineInterpolationValue;
  13075. /**
  13076. * (Highstock, Gantt) The width of the grid lines extending the ticks across
  13077. * the plot area.
  13078. *
  13079. * In styled mode, the stroke width is given in the `.highcharts-grid-line`
  13080. * class.
  13081. */
  13082. gridLineWidth?: number;
  13083. /**
  13084. * (Highcharts, Highstock, Gantt) The Z index of the grid lines.
  13085. */
  13086. gridZIndex?: number;
  13087. /**
  13088. * (Highcharts, Highstock) The height as the vertical axis. If it's a
  13089. * number, it is interpreted as pixels.
  13090. *
  13091. * Since Highcharts 2: If it's a percentage string, it is interpreted as
  13092. * percentages of the total plot height.
  13093. */
  13094. height?: (number|string);
  13095. /**
  13096. * (Highstock, Gantt) An id for the axis. This can be used after render time
  13097. * to get a pointer to the axis object through `chart.get()`.
  13098. */
  13099. id?: string;
  13100. /**
  13101. * (Highstock, Gantt) The axis labels show the number or category for each
  13102. * tick.
  13103. *
  13104. * Since v8.0.0: Labels are animated in categorized x-axis with updating
  13105. * data if `tickInterval` and `step` is set to 1.
  13106. */
  13107. labels?: NavigatorXAxisLabelsOptions;
  13108. /**
  13109. * (Highcharts, Highstock) The left position as the horizontal axis. If it's
  13110. * a number, it is interpreted as pixel position relative to the chart.
  13111. *
  13112. * Since Highcharts v5.0.13: If it's a percentage string, it is interpreted
  13113. * as percentages of the plot width, offset from plot area left.
  13114. */
  13115. left?: (number|string);
  13116. /**
  13117. * (Highstock, Gantt) The color of the line marking the axis itself.
  13118. *
  13119. * In styled mode, the line stroke is given in the `.highcharts-axis-line`
  13120. * or `.highcharts-xaxis-line` class.
  13121. */
  13122. lineColor?: ColorType;
  13123. /**
  13124. * (Highstock, Gantt) The width of the line marking the axis itself.
  13125. *
  13126. * In styled mode, the stroke width is given in the `.highcharts-axis-line`
  13127. * or `.highcharts-xaxis-line` class.
  13128. */
  13129. lineWidth?: number;
  13130. /**
  13131. * (Highstock, Gantt) If there are multiple axes on the same side of the
  13132. * chart, the pixel margin between the axes. Defaults to 0 on vertical axes,
  13133. * 15 on horizontal axes.
  13134. */
  13135. margin?: number;
  13136. /**
  13137. * (Highstock, Gantt) The maximum value of the axis. If `null`, the max
  13138. * value is automatically calculated.
  13139. *
  13140. * If the endOnTick option is true, the `max` value might be rounded up.
  13141. *
  13142. * If a tickAmount is set, the axis may be extended beyond the set max in
  13143. * order to reach the given number of ticks. The same may happen in a chart
  13144. * with multiple axes, determined by chart. alignTicks, where a `tickAmount`
  13145. * is applied internally.
  13146. */
  13147. max?: (number|null);
  13148. /**
  13149. * (Highstock, Gantt) Padding of the max value relative to the length of the
  13150. * axis. A padding of 0.05 will make a 100px axis 5px longer. This is useful
  13151. * when you don't want the highest data value to appear on the edge of the
  13152. * plot area. When the axis' `max` option is set or a max extreme is set
  13153. * using `axis.setExtremes()`, the maxPadding will be ignored.
  13154. */
  13155. maxPadding?: number;
  13156. /**
  13157. * (Highstock, Gantt) The minimum value of the axis. If `null` the min value
  13158. * is automatically calculated.
  13159. *
  13160. * If the startOnTick option is true (default), the `min` value might be
  13161. * rounded down.
  13162. *
  13163. * The automatically calculated minimum value is also affected by floor,
  13164. * softMin, minPadding, minRange as well as series.threshold and
  13165. * series.softThreshold.
  13166. */
  13167. min?: (number|null);
  13168. /**
  13169. * (Highstock, Gantt) Color of the minor, secondary grid lines.
  13170. *
  13171. * In styled mode, the stroke width is given in the
  13172. * `.highcharts-minor-grid-line` class.
  13173. */
  13174. minorGridLineColor?: ColorType;
  13175. /**
  13176. * (Highstock, Gantt) The dash or dot style of the minor grid lines. For
  13177. * possible values, see this demonstration.
  13178. */
  13179. minorGridLineDashStyle?: DashStyleValue;
  13180. /**
  13181. * (Highstock, Gantt) Width of the minor, secondary grid lines.
  13182. *
  13183. * In styled mode, the stroke width is given in the `.highcharts-grid-line`
  13184. * class.
  13185. */
  13186. minorGridLineWidth?: number;
  13187. /**
  13188. * (Highstock, Gantt) Color for the minor tick marks.
  13189. */
  13190. minorTickColor?: ColorType;
  13191. /**
  13192. * (Highstock, Gantt) Specific tick interval in axis units for the minor
  13193. * ticks. On a linear axis, if `"auto"`, the minor tick interval is
  13194. * calculated as a fifth of the tickInterval. If `null` or `undefined`,
  13195. * minor ticks are not shown.
  13196. *
  13197. * On logarithmic axes, the unit is the power of the value. For example,
  13198. * setting the minorTickInterval to 1 puts one tick on each of 0.1, 1, 10,
  13199. * 100 etc. Setting the minorTickInterval to 0.1 produces 9 ticks between 1
  13200. * and 10, 10 and 100 etc.
  13201. *
  13202. * If user settings dictate minor ticks to become too dense, they don't make
  13203. * sense, and will be ignored to prevent performance problems.
  13204. */
  13205. minorTickInterval?: (number|string|null);
  13206. /**
  13207. * (Highstock, Gantt) The pixel length of the minor tick marks.
  13208. */
  13209. minorTickLength?: number;
  13210. /**
  13211. * (Highstock, Gantt) The position of the minor tick marks relative to the
  13212. * axis line. Can be one of `inside` and `outside`.
  13213. */
  13214. minorTickPosition?: OptionsMinorTickPositionValue;
  13215. /**
  13216. * (Highstock, Gantt) Enable or disable minor ticks. Unless
  13217. * minorTickInterval is set, the tick interval is calculated as a fifth of
  13218. * the `tickInterval`.
  13219. *
  13220. * On a logarithmic axis, minor ticks are laid out based on a best guess,
  13221. * attempting to enter approximately 5 minor ticks between each major tick.
  13222. *
  13223. * Prior to v6.0.0, ticks were unabled in auto layout by setting
  13224. * `minorTickInterval` to `"auto"`.
  13225. */
  13226. minorTicks?: boolean;
  13227. /**
  13228. * (Highstock, Gantt) The pixel width of the minor tick mark.
  13229. */
  13230. minorTickWidth?: number;
  13231. /**
  13232. * (Highcharts, Highstock, Gantt) Padding of the min value relative to the
  13233. * length of the axis. A padding of 0.05 will make a 100px axis 5px longer.
  13234. * This is useful when you don't want the lowest data value to appear on the
  13235. * edge of the plot area. When the axis' `min` option is set or a min
  13236. * extreme is set using `axis.setExtremes()`, the minPadding will be
  13237. * ignored.
  13238. */
  13239. minPadding?: number;
  13240. /**
  13241. * (Highstock, Gantt) The minimum tick interval allowed in axis values. For
  13242. * example on zooming in on an axis with daily data, this can be used to
  13243. * prevent the axis from showing hours. Defaults to the closest distance
  13244. * between two points on the axis.
  13245. */
  13246. minTickInterval?: number;
  13247. /**
  13248. * (Highstock, Gantt) The distance in pixels from the plot area to the axis
  13249. * line. A positive offset moves the axis with it's line, labels and ticks
  13250. * away from the plot area. This is typically used when two or more axes are
  13251. * displayed on the same side of the plot. With multiple axes the offset is
  13252. * dynamically adjusted to avoid collision, this can be overridden by
  13253. * setting offset explicitly.
  13254. */
  13255. offset?: number;
  13256. /**
  13257. * (Highstock) In an ordinal axis, the points are equally spaced in the
  13258. * chart regardless of the actual time or x distance between them. This
  13259. * means that missing data periods (e.g. nights or weekends for a stock
  13260. * chart) will not take up space in the chart. Having `ordinal: false` will
  13261. * show any gaps created by the `gapSize` setting proportionate to their
  13262. * duration.
  13263. *
  13264. * In stock charts the X axis is ordinal by default, unless the boost module
  13265. * is used and at least one of the series' data length exceeds the
  13266. * boostThreshold.
  13267. */
  13268. ordinal?: boolean;
  13269. /**
  13270. * (Highstock) Additional range on the right side of the xAxis. Works
  13271. * similar to xAxis.maxPadding, but value is set in milliseconds. Can be set
  13272. * for both, main xAxis and navigator's xAxis.
  13273. */
  13274. overscroll?: number;
  13275. /**
  13276. * (Highcharts) Refers to the index in the panes array. Used for circular
  13277. * gauges and polar charts. When the option is not set then first pane will
  13278. * be used.
  13279. */
  13280. pane?: number;
  13281. /**
  13282. * (Highcharts, Highstock, Gantt) An array of colored bands stretching
  13283. * across the plot area marking an interval on the axis.
  13284. *
  13285. * In styled mode, the plot bands are styled by the `.highcharts-plot-band`
  13286. * class in addition to the `className` option.
  13287. */
  13288. plotBands?: Array<NavigatorXAxisPlotBandsOptions>;
  13289. /**
  13290. * (Highcharts, Highstock, Gantt) An array of lines stretching across the
  13291. * plot area, marking a specific value on one of the axes.
  13292. *
  13293. * In styled mode, the plot lines are styled by the `.highcharts-plot-line`
  13294. * class in addition to the `className` option.
  13295. */
  13296. plotLines?: Array<NavigatorXAxisPlotLinesOptions>;
  13297. /**
  13298. * (Highstock, Gantt) Whether to reverse the axis so that the highest number
  13299. * is closest to the origin. If the chart is inverted, the x axis is
  13300. * reversed by default.
  13301. */
  13302. reversed?: boolean;
  13303. /**
  13304. * (Highcharts, Highstock) This option determines how stacks should be
  13305. * ordered within a group. For example reversed xAxis also reverses stacks,
  13306. * so first series comes last in a group. To keep order like for
  13307. * non-reversed xAxis enable this option.
  13308. */
  13309. reversedStacks?: boolean;
  13310. /**
  13311. * (Highstock, Gantt) Whether to show the first tick label.
  13312. */
  13313. showFirstLabel?: boolean;
  13314. /**
  13315. * (Highcharts, Highstock, Gantt) Whether to show the last tick label.
  13316. * Defaults to `true` on cartesian charts, and `false` on polar charts.
  13317. */
  13318. showLastLabel?: boolean;
  13319. /**
  13320. * (Highcharts, Highstock, Gantt) A soft maximum for the axis. If the series
  13321. * data maximum is less than this, the axis will stay at this maximum, but
  13322. * if the series data maximum is higher, the axis will flex to show all
  13323. * data.
  13324. */
  13325. softMax?: number;
  13326. /**
  13327. * (Highcharts, Highstock, Gantt) A soft minimum for the axis. If the series
  13328. * data minimum is greater than this, the axis will stay at this minimum,
  13329. * but if the series data minimum is lower, the axis will flex to show all
  13330. * data.
  13331. */
  13332. softMin?: number;
  13333. /**
  13334. * (Highcharts, Highstock, Gantt) For datetime axes, this decides where to
  13335. * put the tick between weeks. 0 = Sunday, 1 = Monday.
  13336. */
  13337. startOfWeek?: number;
  13338. /**
  13339. * (Highstock, Gantt) Whether to force the axis to start on a tick. Use this
  13340. * option with the `minPadding` option to control the axis start.
  13341. */
  13342. startOnTick?: boolean;
  13343. /**
  13344. * (Highcharts, Highstock, Gantt) The amount of ticks to draw on the axis.
  13345. * This opens up for aligning the ticks of multiple charts or panes within a
  13346. * chart. This option overrides the `tickPixelInterval` option.
  13347. *
  13348. * This option only has an effect on linear axes. Datetime, logarithmic or
  13349. * category axes are not affected.
  13350. */
  13351. tickAmount?: number;
  13352. /**
  13353. * (Highstock, Gantt) Color for the main tick marks.
  13354. *
  13355. * In styled mode, the stroke is given in the `.highcharts-tick` class.
  13356. */
  13357. tickColor?: ColorType;
  13358. /**
  13359. * (Highstock, Gantt) The interval of the tick marks in axis units. When
  13360. * `undefined`, the tick interval is computed to approximately follow the
  13361. * tickPixelInterval on linear and datetime axes. On categorized axes, a
  13362. * `undefined` tickInterval will default to 1, one category. Note that
  13363. * datetime axes are based on milliseconds, so for example an interval of
  13364. * one day is expressed as `24 * 3600 * 1000`.
  13365. *
  13366. * On logarithmic axes, the tickInterval is based on powers, so a
  13367. * tickInterval of 1 means one tick on each of 0.1, 1, 10, 100 etc. A
  13368. * tickInterval of 2 means a tick of 0.1, 10, 1000 etc. A tickInterval of
  13369. * 0.2 puts a tick on 0.1, 0.2, 0.4, 0.6, 0.8, 1, 2, 4, 6, 8, 10, 20, 40
  13370. * etc.
  13371. *
  13372. * If the tickInterval is too dense for labels to be drawn, Highcharts may
  13373. * remove ticks.
  13374. *
  13375. * If the chart has multiple axes, the alignTicks option may interfere with
  13376. * the `tickInterval` setting.
  13377. */
  13378. tickInterval?: number;
  13379. /**
  13380. * (Highstock, Gantt) The pixel length of the main tick marks.
  13381. */
  13382. tickLength?: number;
  13383. /**
  13384. * (Highcharts, Gantt) For categorized axes only. If `on` the tick mark is
  13385. * placed in the center of the category, if `between` the tick mark is
  13386. * placed between categories. The default is `between` if the `tickInterval`
  13387. * is 1, else `on`.
  13388. */
  13389. tickmarkPlacement?: OptionsTickmarkPlacementValue;
  13390. /**
  13391. * (Highstock, Gantt) If tickInterval is `null` this option sets the
  13392. * approximate pixel interval of the tick marks. Not applicable to
  13393. * categorized axis.
  13394. *
  13395. * The tick interval is also influenced by the minTickInterval option, that,
  13396. * by default prevents ticks from being denser than the data points.
  13397. */
  13398. tickPixelInterval?: number;
  13399. /**
  13400. * (Highstock, Gantt) The position of the major tick marks relative to the
  13401. * axis line. Can be one of `inside` and `outside`.
  13402. */
  13403. tickPosition?: OptionsTickPositionValue;
  13404. /**
  13405. * (Highstock, Gantt) A callback function returning array defining where the
  13406. * ticks are laid out on the axis. This overrides the default behaviour of
  13407. * tickPixelInterval and tickInterval. The automatic tick positions are
  13408. * accessible through `this.tickPositions` and can be modified by the
  13409. * callback.
  13410. */
  13411. tickPositioner?: AxisTickPositionerCallbackFunction;
  13412. /**
  13413. * (Highstock, Gantt) An array defining where the ticks are laid out on the
  13414. * axis. This overrides the default behaviour of tickPixelInterval and
  13415. * tickInterval.
  13416. */
  13417. tickPositions?: Array<number>;
  13418. /**
  13419. * (Highstock, Gantt) The pixel width of the major tick marks. Defaults to 0
  13420. * on category axes, otherwise 1.
  13421. *
  13422. * In styled mode, the stroke width is given in the `.highcharts-tick`
  13423. * class, but in order for the element to be generated on category axes, the
  13424. * option must be explicitly set to 1.
  13425. */
  13426. tickWidth?: (number|undefined);
  13427. /**
  13428. * (Highstock, Gantt) The axis title, showing next to the axis line.
  13429. */
  13430. title?: NavigatorXAxisTitleOptions;
  13431. /**
  13432. * (Highcharts, Highstock) The top position as the vertical axis. If it's a
  13433. * number, it is interpreted as pixel position relative to the chart.
  13434. *
  13435. * Since Highcharts 2: If it's a percentage string, it is interpreted as
  13436. * percentages of the plot height, offset from plot area top.
  13437. */
  13438. top?: (number|string);
  13439. /**
  13440. * (Highcharts, Gantt) The type of axis. Can be one of `linear`,
  13441. * `logarithmic`, `datetime` or `category`. In a datetime axis, the numbers
  13442. * are given in milliseconds, and tick marks are placed on appropriate
  13443. * values like full hours or days. In a category axis, the point names of
  13444. * the chart's series are used for categories, if not a categories array is
  13445. * defined.
  13446. */
  13447. type?: AxisTypeValue;
  13448. /**
  13449. * (Highcharts, Gantt) Applies only when the axis `type` is `category`. When
  13450. * `uniqueNames` is true, points are placed on the X axis according to their
  13451. * names. If the same point name is repeated in the same or another series,
  13452. * the point is placed on the same X position as other points of the same
  13453. * name. When `uniqueNames` is false, the points are laid out in increasing
  13454. * X positions regardless of their names, and the X axis category will take
  13455. * the name of the last point in each position.
  13456. */
  13457. uniqueNames?: boolean;
  13458. /**
  13459. * (Highcharts, Highstock, Gantt) Datetime axis only. An array determining
  13460. * what time intervals the ticks are allowed to fall on. Each array item is
  13461. * an array where the first value is the time unit and the second value
  13462. * another array of allowed multiples.
  13463. *
  13464. * Defaults to: (see online documentation for example)
  13465. */
  13466. units?: Array<[string, (Array<number>|null)]>;
  13467. /**
  13468. * (Highcharts, Highstock, Gantt) Whether axis, including axis title, line,
  13469. * ticks and labels, should be visible.
  13470. */
  13471. visible?: boolean;
  13472. /**
  13473. * (Highcharts, Highstock) The width as the horizontal axis. If it's a
  13474. * number, it is interpreted as pixels.
  13475. *
  13476. * Since Highcharts v5.0.13: If it's a percentage string, it is interpreted
  13477. * as percentages of the total plot width.
  13478. */
  13479. width?: (number|string);
  13480. /**
  13481. * (Highstock, Gantt) Whether to zoom axis. If `chart.zoomType` is set, the
  13482. * option allows to disable zooming on an individual axis.
  13483. */
  13484. zoomEnabled?: boolean;
  13485. }
  13486. /**
  13487. * (Highcharts, Highstock, Gantt) An object defining mouse events for the plot
  13488. * band. Supported properties are `click`, `mouseover`, `mouseout`, `mousemove`.
  13489. */
  13490. export interface NavigatorXAxisPlotBandsEventsOptions {
  13491. /**
  13492. * (Highcharts, Highstock, Gantt) Click event on a plot band.
  13493. */
  13494. click?: EventCallbackFunction<PlotLineOrBand>;
  13495. /**
  13496. * (Highcharts, Highstock, Gantt) Mouse move event on a plot band.
  13497. */
  13498. mousemove?: EventCallbackFunction<PlotLineOrBand>;
  13499. /**
  13500. * (Highcharts, Highstock, Gantt) Mouse out event on the corner of a plot
  13501. * band.
  13502. */
  13503. mouseout?: EventCallbackFunction<PlotLineOrBand>;
  13504. /**
  13505. * (Highcharts, Highstock, Gantt) Mouse over event on a plot band.
  13506. */
  13507. mouseover?: EventCallbackFunction<PlotLineOrBand>;
  13508. }
  13509. /**
  13510. * (Highcharts, Highstock, Gantt) Text labels for the plot bands
  13511. */
  13512. export interface NavigatorXAxisPlotBandsLabelOptions {
  13513. /**
  13514. * (Highcharts, Highstock, Gantt) Horizontal alignment of the label. Can be
  13515. * one of "left", "center" or "right".
  13516. */
  13517. align?: AlignValue;
  13518. /**
  13519. * (Highcharts, Highstock, Gantt) Rotation of the text label in degrees .
  13520. */
  13521. rotation?: number;
  13522. /**
  13523. * (Highcharts, Highstock, Gantt) CSS styles for the text label.
  13524. *
  13525. * In styled mode, the labels are styled by the
  13526. * `.highcharts-plot-band-label` class.
  13527. */
  13528. style?: CSSObject;
  13529. /**
  13530. * (Highcharts, Highstock, Gantt) The string text itself. A subset of HTML
  13531. * is supported.
  13532. */
  13533. text?: string;
  13534. /**
  13535. * (Highcharts, Highstock, Gantt) The text alignment for the label. While
  13536. * `align` determines where the texts anchor point is placed within the plot
  13537. * band, `textAlign` determines how the text is aligned against its anchor
  13538. * point. Possible values are "left", "center" and "right". Defaults to the
  13539. * same as the `align` option.
  13540. */
  13541. textAlign?: AlignValue;
  13542. /**
  13543. * (Highcharts, Highstock, Gantt) Whether to use HTML to render the labels.
  13544. */
  13545. useHTML?: boolean;
  13546. /**
  13547. * (Highcharts, Highstock, Gantt) Vertical alignment of the label relative
  13548. * to the plot band. Can be one of "top", "middle" or "bottom".
  13549. */
  13550. verticalAlign?: VerticalAlignValue;
  13551. /**
  13552. * (Highcharts, Highstock, Gantt) Horizontal position relative the
  13553. * alignment. Default varies by orientation.
  13554. */
  13555. x?: number;
  13556. /**
  13557. * (Highcharts, Highstock, Gantt) Vertical position of the text baseline
  13558. * relative to the alignment. Default varies by orientation.
  13559. */
  13560. y?: number;
  13561. }
  13562. /**
  13563. * (Highcharts, Highstock, Gantt) An array of colored bands stretching across
  13564. * the plot area marking an interval on the axis.
  13565. *
  13566. * In styled mode, the plot bands are styled by the `.highcharts-plot-band`
  13567. * class in addition to the `className` option.
  13568. */
  13569. export interface NavigatorXAxisPlotBandsOptions {
  13570. /**
  13571. * (Highstock) Flag to decide if plotBand should be rendered across all
  13572. * panes.
  13573. */
  13574. acrossPanes?: boolean;
  13575. /**
  13576. * (Highcharts, Highstock, Gantt) Border color for the plot band. Also
  13577. * requires `borderWidth` to be set.
  13578. */
  13579. borderColor?: ColorString;
  13580. /**
  13581. * (Highcharts, Highstock, Gantt) Border width for the plot band. Also
  13582. * requires `borderColor` to be set.
  13583. */
  13584. borderWidth?: number;
  13585. /**
  13586. * (Highcharts, Highstock, Gantt) A custom class name, in addition to the
  13587. * default `highcharts-plot-band`, to apply to each individual band.
  13588. */
  13589. className?: string;
  13590. /**
  13591. * (Highcharts, Highstock, Gantt) The color of the plot band.
  13592. */
  13593. color?: (ColorString|GradientColorObject|PatternObject);
  13594. /**
  13595. * (Highcharts, Highstock, Gantt) An object defining mouse events for the
  13596. * plot band. Supported properties are `click`, `mouseover`, `mouseout`,
  13597. * `mousemove`.
  13598. */
  13599. events?: NavigatorXAxisPlotBandsEventsOptions;
  13600. /**
  13601. * (Highcharts, Highstock, Gantt) The start position of the plot band in
  13602. * axis units.
  13603. */
  13604. from?: number;
  13605. /**
  13606. * (Highcharts, Highstock, Gantt) An id used for identifying the plot band
  13607. * in Axis.removePlotBand.
  13608. */
  13609. id?: string;
  13610. /**
  13611. * (Highcharts, Highstock, Gantt) Text labels for the plot bands
  13612. */
  13613. label?: NavigatorXAxisPlotBandsLabelOptions;
  13614. /**
  13615. * (Highcharts, Highstock, Gantt) The end position of the plot band in axis
  13616. * units.
  13617. */
  13618. to?: number;
  13619. /**
  13620. * (Highcharts, Highstock, Gantt) The z index of the plot band within the
  13621. * chart, relative to other elements. Using the same z index as another
  13622. * element may give unpredictable results, as the last rendered element will
  13623. * be on top. Values from 0 to 20 make sense.
  13624. */
  13625. zIndex?: number;
  13626. }
  13627. /**
  13628. * (Highcharts, Highstock, Gantt) An object defining mouse events for the plot
  13629. * line. Supported properties are `click`, `mouseover`, `mouseout`, `mousemove`.
  13630. */
  13631. export interface NavigatorXAxisPlotLinesEventsOptions {
  13632. /**
  13633. * (Highcharts, Highstock, Gantt) Click event on a plot band.
  13634. */
  13635. click?: EventCallbackFunction<PlotLineOrBand>;
  13636. /**
  13637. * (Highcharts, Highstock, Gantt) Mouse move event on a plot band.
  13638. */
  13639. mousemove?: EventCallbackFunction<PlotLineOrBand>;
  13640. /**
  13641. * (Highcharts, Highstock, Gantt) Mouse out event on the corner of a plot
  13642. * band.
  13643. */
  13644. mouseout?: EventCallbackFunction<PlotLineOrBand>;
  13645. /**
  13646. * (Highcharts, Highstock, Gantt) Mouse over event on a plot band.
  13647. */
  13648. mouseover?: EventCallbackFunction<PlotLineOrBand>;
  13649. }
  13650. /**
  13651. * (Highcharts, Highstock, Gantt) Text labels for the plot bands
  13652. */
  13653. export interface NavigatorXAxisPlotLinesLabelOptions {
  13654. /**
  13655. * (Highcharts, Highstock, Gantt) Horizontal alignment of the label. Can be
  13656. * one of "left", "center" or "right".
  13657. */
  13658. align?: AlignValue;
  13659. /**
  13660. * (Highcharts, Highstock, Gantt) Callback JavaScript function to format the
  13661. * label. Useful properties like the value of plot line or the range of plot
  13662. * band (`from` & `to` properties) can be found in `this.options` object.
  13663. */
  13664. formatter?: FormatterCallbackFunction<PlotLineOrBand>;
  13665. /**
  13666. * (Highcharts, Highstock, Gantt) Rotation of the text label in degrees.
  13667. * Defaults to 0 for horizontal plot lines and 90 for vertical lines.
  13668. */
  13669. rotation?: number;
  13670. /**
  13671. * (Highcharts, Highstock, Gantt) CSS styles for the text label.
  13672. *
  13673. * In styled mode, the labels are styled by the
  13674. * `.highcharts-plot-line-label` class.
  13675. */
  13676. style?: CSSObject;
  13677. /**
  13678. * (Highcharts, Highstock, Gantt) The text itself. A subset of HTML is
  13679. * supported.
  13680. */
  13681. text?: string;
  13682. /**
  13683. * (Highcharts, Highstock, Gantt) The text alignment for the label. While
  13684. * `align` determines where the texts anchor point is placed within the plot
  13685. * band, `textAlign` determines how the text is aligned against its anchor
  13686. * point. Possible values are "left", "center" and "right". Defaults to the
  13687. * same as the `align` option.
  13688. */
  13689. textAlign?: AlignValue;
  13690. /**
  13691. * (Highcharts, Highstock, Gantt) Whether to use HTML to render the labels.
  13692. */
  13693. useHTML?: boolean;
  13694. /**
  13695. * (Highcharts, Highstock, Gantt) Vertical alignment of the label relative
  13696. * to the plot line. Can be one of "top", "middle" or "bottom".
  13697. */
  13698. verticalAlign?: VerticalAlignValue;
  13699. /**
  13700. * (Highcharts, Highstock, Gantt) Horizontal position relative the
  13701. * alignment. Default varies by orientation.
  13702. */
  13703. x?: number;
  13704. /**
  13705. * (Highcharts, Highstock, Gantt) Vertical position of the text baseline
  13706. * relative to the alignment. Default varies by orientation.
  13707. */
  13708. y?: number;
  13709. }
  13710. /**
  13711. * (Highcharts, Highstock, Gantt) An array of lines stretching across the plot
  13712. * area, marking a specific value on one of the axes.
  13713. *
  13714. * In styled mode, the plot lines are styled by the `.highcharts-plot-line`
  13715. * class in addition to the `className` option.
  13716. */
  13717. export interface NavigatorXAxisPlotLinesOptions {
  13718. /**
  13719. * (Highstock) Flag to decide if plotLine should be rendered across all
  13720. * panes.
  13721. */
  13722. acrossPanes?: boolean;
  13723. /**
  13724. * (Highcharts, Highstock, Gantt) A custom class name, in addition to the
  13725. * default `highcharts-plot-line`, to apply to each individual line.
  13726. */
  13727. className?: string;
  13728. /**
  13729. * (Highcharts, Highstock, Gantt) The color of the line.
  13730. */
  13731. color?: ColorString;
  13732. /**
  13733. * (Highcharts, Highstock, Gantt) The dashing or dot style for the plot
  13734. * line. For possible values see this overview.
  13735. */
  13736. dashStyle?: DashStyleValue;
  13737. /**
  13738. * (Highcharts, Highstock, Gantt) An object defining mouse events for the
  13739. * plot line. Supported properties are `click`, `mouseover`, `mouseout`,
  13740. * `mousemove`.
  13741. */
  13742. events?: NavigatorXAxisPlotLinesEventsOptions;
  13743. /**
  13744. * (Highcharts, Highstock, Gantt) An id used for identifying the plot line
  13745. * in Axis.removePlotLine.
  13746. */
  13747. id?: string;
  13748. /**
  13749. * (Highcharts, Highstock, Gantt) Text labels for the plot bands
  13750. */
  13751. label?: NavigatorXAxisPlotLinesLabelOptions;
  13752. /**
  13753. * (Highcharts, Highstock, Gantt) The position of the line in axis units.
  13754. */
  13755. value?: number;
  13756. /**
  13757. * (Highcharts, Highstock, Gantt) The width or thickness of the plot line.
  13758. */
  13759. width?: number;
  13760. /**
  13761. * (Highcharts, Highstock, Gantt) The z index of the plot line within the
  13762. * chart.
  13763. */
  13764. zIndex?: number;
  13765. }
  13766. /**
  13767. * (Highstock, Gantt) The axis title, showing next to the axis line.
  13768. */
  13769. export interface NavigatorXAxisTitleOptions {
  13770. /**
  13771. * (Highstock, Gantt) Alignment of the title relative to the axis values.
  13772. * Possible values are "low", "middle" or "high".
  13773. */
  13774. align?: AxisTitleAlignValue;
  13775. /**
  13776. * (Highstock, Gantt) The pixel distance between the axis labels or line and
  13777. * the title. Defaults to 0 for horizontal axes, 10 for vertical
  13778. */
  13779. margin?: number;
  13780. /**
  13781. * (Highstock, Gantt) The distance of the axis title from the axis line. By
  13782. * default, this distance is computed from the offset width of the labels,
  13783. * the labels' distance from the axis and the title's margin. However when
  13784. * the offset option is set, it overrides all this.
  13785. */
  13786. offset?: number;
  13787. /**
  13788. * (Highcharts) Defines how the title is repositioned according to the 3D
  13789. * chart orientation.
  13790. *
  13791. * - `'offset'`: Maintain a fixed horizontal/vertical distance from the tick
  13792. * marks, despite the chart orientation. This is the backwards compatible
  13793. * behavior, and causes skewing of X and Z axes.
  13794. *
  13795. * - `'chart'`: Preserve 3D position relative to the chart. This looks nice,
  13796. * but hard to read if the text isn't forward-facing.
  13797. *
  13798. * - `'flap'`: Rotated text along the axis to compensate for the chart
  13799. * orientation. This tries to maintain text as legible as possible on all
  13800. * orientations.
  13801. *
  13802. * - `'ortho'`: Rotated text along the axis direction so that the labels are
  13803. * orthogonal to the axis. This is very similar to `'flap'`, but prevents
  13804. * skewing the labels (X and Y scaling are still present).
  13805. *
  13806. * - `undefined`: Will use the config from `labels.position3d`
  13807. */
  13808. position3d?: ("chart"|"flap"|"offset"|"ortho"|null);
  13809. /**
  13810. * (Highcharts, Highstock, Gantt) Whether to reserve space for the title
  13811. * when laying out the axis.
  13812. */
  13813. reserveSpace?: boolean;
  13814. /**
  13815. * (Highstock, Gantt) The rotation of the text in degrees. 0 is horizontal,
  13816. * 270 is vertical reading from bottom to top.
  13817. */
  13818. rotation?: number;
  13819. /**
  13820. * (Highcharts) If enabled, the axis title will skewed to follow the
  13821. * perspective.
  13822. *
  13823. * This will fix overlapping labels and titles, but texts become less
  13824. * legible due to the distortion.
  13825. *
  13826. * The final appearance depends heavily on `title.position3d`.
  13827. *
  13828. * A `null` value will use the config from `labels.skew3d`.
  13829. */
  13830. skew3d?: (boolean|null);
  13831. /**
  13832. * (Highstock, Gantt) CSS styles for the title. If the title text is longer
  13833. * than the axis length, it will wrap to multiple lines by default. This can
  13834. * be customized by setting `textOverflow: 'ellipsis'`, by setting a
  13835. * specific `width` or by setting `whiteSpace: 'nowrap'`.
  13836. *
  13837. * In styled mode, the stroke width is given in the `.highcharts-axis-title`
  13838. * class.
  13839. */
  13840. style?: CSSObject;
  13841. /**
  13842. * (Highstock, Gantt) The actual text of the axis title. It can contain
  13843. * basic HTML tags like `b`, `i` and `span` with style.
  13844. */
  13845. text?: (string|null);
  13846. /**
  13847. * (Highstock, Gantt) Alignment of the text, can be `"left"`, `"right"` or
  13848. * `"center"`. Default alignment depends on the title.align:
  13849. *
  13850. * Horizontal axes:
  13851. *
  13852. * - for `align` = `"low"`, `textAlign` is set to `left`
  13853. *
  13854. * - for `align` = `"middle"`, `textAlign` is set to `center`
  13855. *
  13856. * - for `align` = `"high"`, `textAlign` is set to `right`
  13857. *
  13858. * Vertical axes:
  13859. *
  13860. * - for `align` = `"low"` and `opposite` = `true`, `textAlign` is set to
  13861. * `right`
  13862. *
  13863. * - for `align` = `"low"` and `opposite` = `false`, `textAlign` is set to
  13864. * `left`
  13865. *
  13866. * - for `align` = `"middle"`, `textAlign` is set to `center`
  13867. *
  13868. * - for `align` = `"high"` and `opposite` = `true` `textAlign` is set to
  13869. * `left`
  13870. *
  13871. * - for `align` = `"high"` and `opposite` = `false` `textAlign` is set to
  13872. * `right`
  13873. */
  13874. textAlign?: AlignValue;
  13875. /**
  13876. * (Highcharts, Highstock, Gantt) Whether to use HTML to render the axis
  13877. * title.
  13878. */
  13879. useHTML?: boolean;
  13880. /**
  13881. * (Highcharts, Highstock, Gantt) Horizontal pixel offset of the title
  13882. * position.
  13883. */
  13884. x?: number;
  13885. /**
  13886. * (Highcharts, Highstock, Gantt) Vertical pixel offset of the title
  13887. * position.
  13888. */
  13889. y?: number;
  13890. }
  13891. /**
  13892. * (Highcharts, Highstock, Gantt) An array defining breaks in the axis, the
  13893. * sections defined will be left out and all the points shifted closer to each
  13894. * other.
  13895. */
  13896. export interface NavigatorYAxisBreaksOptions {
  13897. /**
  13898. * (Highcharts, Highstock, Gantt) A number indicating how much space should
  13899. * be left between the start and the end of the break. The break size is
  13900. * given in axis units, so for instance on a `datetime` axis, a break size
  13901. * of 3600000 would indicate the equivalent of an hour.
  13902. */
  13903. breakSize?: number;
  13904. /**
  13905. * (Highcharts, Highstock, Gantt) The point where the break starts.
  13906. */
  13907. from?: number;
  13908. /**
  13909. * (Highcharts, Highstock, Gantt) Defines an interval after which the break
  13910. * appears again. By default the breaks do not repeat.
  13911. */
  13912. repeat?: number;
  13913. /**
  13914. * (Highcharts, Highstock, Gantt) The point where the break ends.
  13915. */
  13916. to?: number;
  13917. }
  13918. /**
  13919. * (Highstock, Gantt) Event handlers for the axis.
  13920. */
  13921. export interface NavigatorYAxisEventsOptions {
  13922. /**
  13923. * (Highcharts, Gantt) An event fired after the breaks have rendered.
  13924. */
  13925. afterBreaks?: AxisEventCallbackFunction;
  13926. /**
  13927. * (Highstock, Gantt) As opposed to the `setExtremes` event, this event
  13928. * fires after the final min and max values are computed and corrected for
  13929. * `minRange`.
  13930. *
  13931. * Fires when the minimum and maximum is set for the axis, either by calling
  13932. * the `.setExtremes()` method or by selecting an area in the chart. One
  13933. * parameter, `event`, is passed to the function, containing common event
  13934. * information.
  13935. *
  13936. * The new user set minimum and maximum values can be found by `event.min`
  13937. * and `event.max`. These reflect the axis minimum and maximum in axis
  13938. * values. The actual data extremes are found in `event.dataMin` and
  13939. * `event.dataMax`.
  13940. */
  13941. afterSetExtremes?: AxisSetExtremesEventCallbackFunction;
  13942. /**
  13943. * (Highcharts, Gantt) An event fired when a break from this axis occurs on
  13944. * a point.
  13945. */
  13946. pointBreak?: AxisPointBreakEventCallbackFunction;
  13947. /**
  13948. * (Highcharts, Highstock, Gantt) An event fired when a point falls inside a
  13949. * break from this axis.
  13950. */
  13951. pointInBreak?: AxisPointBreakEventCallbackFunction;
  13952. /**
  13953. * (Highstock, Gantt) Fires when the minimum and maximum is set for the
  13954. * axis, either by calling the `.setExtremes()` method or by selecting an
  13955. * area in the chart. One parameter, `event`, is passed to the function,
  13956. * containing common event information.
  13957. *
  13958. * The new user set minimum and maximum values can be found by `event.min`
  13959. * and `event.max`. These reflect the axis minimum and maximum in data
  13960. * values. When an axis is zoomed all the way out from the "Reset zoom"
  13961. * button, `event.min` and `event.max` are null, and the new extremes are
  13962. * set based on `this.dataMin` and `this.dataMax`.
  13963. */
  13964. setExtremes?: AxisSetExtremesEventCallbackFunction;
  13965. }
  13966. /**
  13967. * (Gantt) Set grid options for the axis labels. Requires Highcharts Gantt.
  13968. */
  13969. export interface NavigatorYAxisGridOptions {
  13970. /**
  13971. * (Gantt) Set border color for the label grid lines.
  13972. */
  13973. borderColor?: ColorString;
  13974. /**
  13975. * (Gantt) Set border width of the label grid lines.
  13976. */
  13977. borderWidth?: number;
  13978. /**
  13979. * (Gantt) Set cell height for grid axis labels. By default this is
  13980. * calculated from font size. This option only applies to horizontal axes.
  13981. */
  13982. cellHeight?: number;
  13983. /**
  13984. * (Gantt) Set specific options for each column (or row for horizontal axes)
  13985. * in the grid. Each extra column/row is its own axis, and the axis options
  13986. * can be set here.
  13987. */
  13988. columns?: Array<XAxisOptions>;
  13989. /**
  13990. * (Gantt) Enable grid on the axis labels. Defaults to true for Gantt
  13991. * charts.
  13992. */
  13993. enabled?: boolean;
  13994. }
  13995. /**
  13996. * (Gantt) Set options on specific levels in a tree grid axis. Takes precedence
  13997. * over labels options.
  13998. */
  13999. export interface NavigatorYAxisLabelsLevelsOptions {
  14000. /**
  14001. * (Gantt) Specify the level which the options within this object applies
  14002. * to.
  14003. */
  14004. level?: number;
  14005. style?: CSSObject;
  14006. }
  14007. /**
  14008. * (Highstock, Gantt) The axis labels show the number or category for each tick.
  14009. *
  14010. * Since v8.0.0: Labels are animated in categorized x-axis with updating data if
  14011. * `tickInterval` and `step` is set to 1.
  14012. */
  14013. export interface NavigatorYAxisLabelsOptions {
  14014. /**
  14015. * (Highstock, Gantt) What part of the string the given position is anchored
  14016. * to. Can be one of `"left"`, `"center"` or `"right"`. The exact position
  14017. * also depends on the `labels.x` setting.
  14018. *
  14019. * Angular gauges and solid gauges defaults to `"center"`. Solid gauges with
  14020. * two labels have additional option `"auto"` for automatic horizontal and
  14021. * vertical alignment.
  14022. */
  14023. align?: AlignValue;
  14024. /**
  14025. * (Highcharts, Highstock, Gantt) For horizontal axes, the allowed degrees
  14026. * of label rotation to prevent overlapping labels. If there is enough
  14027. * space, labels are not rotated. As the chart gets narrower, it will start
  14028. * rotating the labels -45 degrees, then remove every second label and try
  14029. * again with rotations 0 and -45 etc. Set it to `false` to disable
  14030. * rotation, which will cause the labels to word-wrap if possible.
  14031. */
  14032. autoRotation?: (false|Array<number>);
  14033. /**
  14034. * (Highcharts, Gantt) When each category width is more than this many
  14035. * pixels, we don't apply auto rotation. Instead, we lay out the axis label
  14036. * with word wrap. A lower limit makes sense when the label contains
  14037. * multiple short words that don't extend the available horizontal space for
  14038. * each label.
  14039. */
  14040. autoRotationLimit?: number;
  14041. /**
  14042. * (Highcharts) Angular gauges and solid gauges only. The label's pixel
  14043. * distance from the perimeter of the plot area.
  14044. *
  14045. * Since v7.1.2: If it's a percentage string, it is interpreted the same as
  14046. * series.radius, so label can be aligned under the gauge's shape.
  14047. */
  14048. distance?: (number|string);
  14049. /**
  14050. * (Highstock, Gantt) Enable or disable the axis labels.
  14051. */
  14052. enabled?: boolean;
  14053. /**
  14054. * (Highstock, Gantt) A format string for the axis label. See format string
  14055. * for example usage.
  14056. *
  14057. * Note: The default value is not specified due to the dynamic nature of the
  14058. * default implementation.
  14059. */
  14060. format?: string;
  14061. /**
  14062. * (Highstock, Gantt) Callback JavaScript function to format the label. The
  14063. * value is given by `this.value`. Additional properties for `this` are
  14064. * `axis`, `chart`, `isFirst` and `isLast`. The value of the default label
  14065. * formatter can be retrieved by calling
  14066. * `this.axis.defaultLabelFormatter.call(this)` within the function.
  14067. *
  14068. * Defaults to: (see online documentation for example)
  14069. */
  14070. formatter?: AxisLabelsFormatterCallbackFunction;
  14071. /**
  14072. * (Gantt) The number of pixels to indent the labels per level in a treegrid
  14073. * axis.
  14074. */
  14075. indentation?: number;
  14076. /**
  14077. * (Gantt) Set options on specific levels in a tree grid axis. Takes
  14078. * precedence over labels options.
  14079. */
  14080. levels?: Array<NavigatorYAxisLabelsLevelsOptions>;
  14081. /**
  14082. * (Highstock, Gantt) How to handle overflowing labels on horizontal axis.
  14083. * If set to `"allow"`, it will not be aligned at all. By default it
  14084. * `"justify"` labels inside the chart area. If there is room to move it, it
  14085. * will be aligned to the edge, else it will be removed.
  14086. */
  14087. overflow?: OptionsOverflowValue;
  14088. /**
  14089. * (Highcharts, Gantt) The pixel padding for axis labels, to ensure white
  14090. * space between them.
  14091. */
  14092. padding?: number;
  14093. /**
  14094. * (Highcharts) Defines how the labels are be repositioned according to the
  14095. * 3D chart orientation.
  14096. *
  14097. * - `'offset'`: Maintain a fixed horizontal/vertical distance from the tick
  14098. * marks, despite the chart orientation. This is the backwards compatible
  14099. * behavior, and causes skewing of X and Z axes.
  14100. *
  14101. * - `'chart'`: Preserve 3D position relative to the chart. This looks nice,
  14102. * but hard to read if the text isn't forward-facing.
  14103. *
  14104. * - `'flap'`: Rotated text along the axis to compensate for the chart
  14105. * orientation. This tries to maintain text as legible as possible on all
  14106. * orientations.
  14107. *
  14108. * - `'ortho'`: Rotated text along the axis direction so that the labels are
  14109. * orthogonal to the axis. This is very similar to `'flap'`, but prevents
  14110. * skewing the labels (X and Y scaling are still present).
  14111. */
  14112. position3d?: OptionsPosition3dValue;
  14113. /**
  14114. * (Highcharts, Gantt) Whether to reserve space for the labels. By default,
  14115. * space is reserved for the labels in these cases:
  14116. *
  14117. * * On all horizontal axes.
  14118. *
  14119. * * On vertical axes if `label.align` is `right` on a left-side axis or
  14120. * `left` on a right-side axis.
  14121. *
  14122. * * On vertical axes if `label.align` is `center`.
  14123. *
  14124. * This can be turned off when for example the labels are rendered inside
  14125. * the plot area instead of outside.
  14126. */
  14127. reserveSpace?: boolean;
  14128. /**
  14129. * (Highstock, Gantt) Rotation of the labels in degrees.
  14130. */
  14131. rotation?: number;
  14132. /**
  14133. * (Highcharts) If enabled, the axis labels will skewed to follow the
  14134. * perspective.
  14135. *
  14136. * This will fix overlapping labels and titles, but texts become less
  14137. * legible due to the distortion.
  14138. *
  14139. * The final appearance depends heavily on `labels.position3d`.
  14140. */
  14141. skew3d?: boolean;
  14142. /**
  14143. * (Highstock, Gantt) Horizontal axes only. The number of lines to spread
  14144. * the labels over to make room or tighter labels.
  14145. */
  14146. staggerLines?: number;
  14147. /**
  14148. * (Highstock, Gantt) To show only every _n_'th label on the axis, set the
  14149. * step to _n_. Setting the step to 2 shows every other label.
  14150. *
  14151. * By default, the step is calculated automatically to avoid overlap. To
  14152. * prevent this, set it to 1\. This usually only happens on a category axis,
  14153. * and is often a sign that you have chosen the wrong axis type.
  14154. *
  14155. * Read more at Axis docs => What axis should I use?
  14156. */
  14157. step?: number;
  14158. /**
  14159. * (Highstock, Gantt) CSS styles for the label. Use `whiteSpace: 'nowrap'`
  14160. * to prevent wrapping of category labels. Use `textOverflow: 'none'` to
  14161. * prevent ellipsis (dots).
  14162. *
  14163. * In styled mode, the labels are styled with the `.highcharts-axis-labels`
  14164. * class.
  14165. */
  14166. style?: CSSObject;
  14167. /**
  14168. * (Gantt) The symbol for the collapse and expand icon in a treegrid.
  14169. */
  14170. symbol?: NavigatorYAxisLabelsSymbolOptions;
  14171. /**
  14172. * (Highstock, Gantt) Whether to use HTML to render the labels.
  14173. */
  14174. useHTML?: boolean;
  14175. /**
  14176. * (Highstock, Gantt) The x position offset of all labels relative to the
  14177. * tick positions on the axis. Defaults to -15 for left axis, 15 for right
  14178. * axis.
  14179. */
  14180. x?: number;
  14181. /**
  14182. * (Highstock, Gantt) The y position offset of all labels relative to the
  14183. * tick positions on the axis. For polar and radial axis consider the use of
  14184. * the distance option.
  14185. */
  14186. y?: number;
  14187. /**
  14188. * (Highstock, Gantt) The Z index for the axis labels.
  14189. */
  14190. zIndex?: number;
  14191. }
  14192. /**
  14193. * (Gantt) The symbol for the collapse and expand icon in a treegrid.
  14194. */
  14195. export interface NavigatorYAxisLabelsSymbolOptions {
  14196. height?: number;
  14197. padding?: number;
  14198. /**
  14199. * (Gantt) The symbol type. Points to a definition function in the
  14200. * `Highcharts.Renderer.symbols` collection.
  14201. */
  14202. type?: SymbolKeyValue;
  14203. width?: number;
  14204. x?: number;
  14205. y?: number;
  14206. }
  14207. /**
  14208. * (Highstock, Gantt) Options for the navigator Y axis. Default series options
  14209. * for the navigator yAxis are: (see online documentation for example)
  14210. */
  14211. export interface NavigatorYAxisOptions {
  14212. /**
  14213. * (Highstock, Gantt) Accessibility options for an axis. Requires the
  14214. * accessibility module.
  14215. */
  14216. accessibility?: AxisAccessibilityOptionsObject;
  14217. /**
  14218. * (Highcharts, Highstock, Gantt) When using multiple axis, the ticks of two
  14219. * or more opposite axes will automatically be aligned by adding ticks to
  14220. * the axis or axes with the least ticks, as if `tickAmount` were specified.
  14221. *
  14222. * This can be prevented by setting `alignTicks` to false. If the grid lines
  14223. * look messy, it's a good idea to hide them for the secondary axis by
  14224. * setting `gridLineWidth` to 0.
  14225. *
  14226. * If `startOnTick` or `endOnTick` in an Axis options are set to false, then
  14227. * the `alignTicks ` will be disabled for the Axis.
  14228. *
  14229. * Disabled for logarithmic axes.
  14230. */
  14231. alignTicks?: boolean;
  14232. /**
  14233. * (Highstock, Gantt) Whether to allow decimals in this axis' ticks. When
  14234. * counting integers, like persons or hits on a web page, decimals should be
  14235. * avoided in the labels.
  14236. */
  14237. allowDecimals?: boolean;
  14238. /**
  14239. * (Highstock, Gantt) When using an alternate grid color, a band is painted
  14240. * across the plot area between every other grid line.
  14241. */
  14242. alternateGridColor?: ColorType;
  14243. /**
  14244. * (Highcharts) In a polar chart, this is the angle of the Y axis in
  14245. * degrees, where 0 is up and 90 is right. The angle determines the position
  14246. * of the axis line and the labels, though the coordinate system is
  14247. * unaffected. Since v8.0.0 this option is also applicable for X axis
  14248. * (inverted polar).
  14249. */
  14250. angle?: number;
  14251. /**
  14252. * (Highcharts, Highstock, Gantt) An array defining breaks in the axis, the
  14253. * sections defined will be left out and all the points shifted closer to
  14254. * each other.
  14255. */
  14256. breaks?: Array<NavigatorYAxisBreaksOptions>;
  14257. /**
  14258. * (Highcharts, Gantt) If categories are present for the xAxis, names are
  14259. * used instead of numbers for that axis.
  14260. *
  14261. * Since Highcharts 3.0, categories can also be extracted by giving each
  14262. * point a name and setting axis type to `category`. However, if you have
  14263. * multiple series, best practice remains defining the `categories` array.
  14264. *
  14265. * Example: `categories: ['Apples', 'Bananas', 'Oranges']`
  14266. */
  14267. categories?: Array<string>;
  14268. /**
  14269. * (Highcharts, Highstock, Gantt) The highest allowed value for
  14270. * automatically computed axis extremes.
  14271. */
  14272. ceiling?: number;
  14273. /**
  14274. * (Highstock, Gantt) A class name that opens for styling the axis by CSS,
  14275. * especially in Highcharts styled mode. The class name is applied to group
  14276. * elements for the grid, axis elements and labels.
  14277. */
  14278. className?: string;
  14279. /**
  14280. * (Highstock, Gantt) Configure a crosshair that follows either the mouse
  14281. * pointer or the hovered point.
  14282. *
  14283. * In styled mode, the crosshairs are styled in the `.highcharts-crosshair`,
  14284. * `.highcharts-crosshair-thin` or `.highcharts-xaxis-category` classes.
  14285. */
  14286. crosshair?: (boolean|AxisCrosshairOptions);
  14287. /**
  14288. * (Highcharts, Highstock, Gantt) For a datetime axis, the scale will
  14289. * automatically adjust to the appropriate unit. This member gives the
  14290. * default string representations used for each unit. For intermediate
  14291. * values, different units may be used, for example the `day` unit can be
  14292. * used on midnight and `hour` unit be used for intermediate values on the
  14293. * same axis.
  14294. *
  14295. * For an overview of the replacement codes, see dateFormat.
  14296. *
  14297. * Defaults to: (see online documentation for example)
  14298. */
  14299. dateTimeLabelFormats?: AxisDateTimeLabelFormatsOptions;
  14300. /**
  14301. * (Highstock, Gantt) Whether to force the axis to end on a tick. Use this
  14302. * option with the `maxPadding` option to control the axis end.
  14303. *
  14304. * This option is always disabled, when panning type is either `y` or `xy`.
  14305. */
  14306. endOnTick?: boolean;
  14307. /**
  14308. * (Highstock, Gantt) Event handlers for the axis.
  14309. */
  14310. events?: NavigatorYAxisEventsOptions;
  14311. /**
  14312. * (Highcharts, Highstock, Gantt) The lowest allowed value for automatically
  14313. * computed axis extremes.
  14314. */
  14315. floor?: number;
  14316. /**
  14317. * (Gantt) Set grid options for the axis labels. Requires Highcharts Gantt.
  14318. */
  14319. grid?: NavigatorYAxisGridOptions;
  14320. /**
  14321. * (Highstock, Gantt) Color of the grid lines extending the ticks across the
  14322. * plot area.
  14323. *
  14324. * In styled mode, the stroke is given in the `.highcharts-grid-line` class.
  14325. */
  14326. gridLineColor?: ColorType;
  14327. /**
  14328. * (Highstock, Gantt) The dash or dot style of the grid lines. For possible
  14329. * values, see this demonstration.
  14330. */
  14331. gridLineDashStyle?: DashStyleValue;
  14332. /**
  14333. * (Highcharts) Polar charts only. Whether the grid lines should draw as a
  14334. * polygon with straight lines between categories, or as circles. Can be
  14335. * either `circle` or `polygon`. Since v8.0.0 this option is also applicable
  14336. * for X axis (inverted polar).
  14337. */
  14338. gridLineInterpolation?: OptionsGridLineInterpolationValue;
  14339. /**
  14340. * (Highstock, Gantt) The width of the grid lines extending the ticks across
  14341. * the plot area.
  14342. *
  14343. * In styled mode, the stroke width is given in the `.highcharts-grid-line`
  14344. * class.
  14345. */
  14346. gridLineWidth?: number;
  14347. /**
  14348. * (Highcharts, Highstock, Gantt) The Z index of the grid lines.
  14349. */
  14350. gridZIndex?: number;
  14351. /**
  14352. * (Highstock, Gantt) An id for the axis. This can be used after render time
  14353. * to get a pointer to the axis object through `chart.get()`.
  14354. */
  14355. id?: string;
  14356. /**
  14357. * (Highstock, Gantt) The axis labels show the number or category for each
  14358. * tick.
  14359. *
  14360. * Since v8.0.0: Labels are animated in categorized x-axis with updating
  14361. * data if `tickInterval` and `step` is set to 1.
  14362. */
  14363. labels?: NavigatorYAxisLabelsOptions;
  14364. /**
  14365. * (Highcharts, Highstock) The left position as the horizontal axis. If it's
  14366. * a number, it is interpreted as pixel position relative to the chart.
  14367. *
  14368. * Since Highcharts v5.0.13: If it's a percentage string, it is interpreted
  14369. * as percentages of the plot width, offset from plot area left.
  14370. */
  14371. left?: (number|string);
  14372. /**
  14373. * (Highstock, Gantt) The color of the line marking the axis itself.
  14374. *
  14375. * In styled mode, the line stroke is given in the `.highcharts-axis-line`
  14376. * or `.highcharts-xaxis-line` class.
  14377. */
  14378. lineColor?: ColorType;
  14379. /**
  14380. * (Highstock, Gantt) The width of the line marking the axis itself.
  14381. *
  14382. * In styled mode, the stroke width is given in the `.highcharts-axis-line`
  14383. * or `.highcharts-xaxis-line` class.
  14384. */
  14385. lineWidth?: number;
  14386. /**
  14387. * (Highstock, Gantt) If there are multiple axes on the same side of the
  14388. * chart, the pixel margin between the axes. Defaults to 0 on vertical axes,
  14389. * 15 on horizontal axes.
  14390. */
  14391. margin?: number;
  14392. /**
  14393. * (Highstock, Gantt) The maximum value of the axis. If `null`, the max
  14394. * value is automatically calculated.
  14395. *
  14396. * If the endOnTick option is true, the `max` value might be rounded up.
  14397. *
  14398. * If a tickAmount is set, the axis may be extended beyond the set max in
  14399. * order to reach the given number of ticks. The same may happen in a chart
  14400. * with multiple axes, determined by chart. alignTicks, where a `tickAmount`
  14401. * is applied internally.
  14402. */
  14403. max?: (number|null);
  14404. /**
  14405. * (Highcharts) Solid gauge only. Unless stops are set, the color to
  14406. * represent the maximum value of the Y axis.
  14407. */
  14408. maxColor?: ColorType;
  14409. /**
  14410. * (Highcharts, Highstock, Gantt) Padding of the max value relative to the
  14411. * length of the axis. A padding of 0.05 will make a 100px axis 5px longer.
  14412. * This is useful when you don't want the highest data value to appear on
  14413. * the edge of the plot area. When the axis' `max` option is set or a max
  14414. * extreme is set using `axis.setExtremes()`, the maxPadding will be
  14415. * ignored.
  14416. *
  14417. * Also the `softThreshold` option takes precedence over `maxPadding`, so if
  14418. * the data is tangent to the threshold, `maxPadding` may not apply unless
  14419. * `softThreshold` is set to false.
  14420. */
  14421. maxPadding?: number;
  14422. /**
  14423. * (Highstock, Gantt) The minimum value of the axis. If `null` the min value
  14424. * is automatically calculated.
  14425. *
  14426. * If the startOnTick option is true (default), the `min` value might be
  14427. * rounded down.
  14428. *
  14429. * The automatically calculated minimum value is also affected by floor,
  14430. * softMin, minPadding, minRange as well as series.threshold and
  14431. * series.softThreshold.
  14432. */
  14433. min?: (number|null);
  14434. /**
  14435. * (Highcharts) Solid gauge only. Unless stops are set, the color to
  14436. * represent the minimum value of the Y axis.
  14437. */
  14438. minColor?: ColorType;
  14439. /**
  14440. * (Highstock, Gantt) Color of the minor, secondary grid lines.
  14441. *
  14442. * In styled mode, the stroke width is given in the
  14443. * `.highcharts-minor-grid-line` class.
  14444. */
  14445. minorGridLineColor?: ColorType;
  14446. /**
  14447. * (Highstock, Gantt) The dash or dot style of the minor grid lines. For
  14448. * possible values, see this demonstration.
  14449. */
  14450. minorGridLineDashStyle?: DashStyleValue;
  14451. /**
  14452. * (Highstock, Gantt) Width of the minor, secondary grid lines.
  14453. *
  14454. * In styled mode, the stroke width is given in the `.highcharts-grid-line`
  14455. * class.
  14456. */
  14457. minorGridLineWidth?: number;
  14458. /**
  14459. * (Highstock, Gantt) Color for the minor tick marks.
  14460. */
  14461. minorTickColor?: ColorType;
  14462. /**
  14463. * (Highstock, Gantt) Specific tick interval in axis units for the minor
  14464. * ticks. On a linear axis, if `"auto"`, the minor tick interval is
  14465. * calculated as a fifth of the tickInterval. If `null` or `undefined`,
  14466. * minor ticks are not shown.
  14467. *
  14468. * On logarithmic axes, the unit is the power of the value. For example,
  14469. * setting the minorTickInterval to 1 puts one tick on each of 0.1, 1, 10,
  14470. * 100 etc. Setting the minorTickInterval to 0.1 produces 9 ticks between 1
  14471. * and 10, 10 and 100 etc.
  14472. *
  14473. * If user settings dictate minor ticks to become too dense, they don't make
  14474. * sense, and will be ignored to prevent performance problems.
  14475. */
  14476. minorTickInterval?: (number|string|null);
  14477. /**
  14478. * (Highstock, Gantt) The pixel length of the minor tick marks.
  14479. */
  14480. minorTickLength?: number;
  14481. /**
  14482. * (Highstock, Gantt) The position of the minor tick marks relative to the
  14483. * axis line. Can be one of `inside` and `outside`.
  14484. */
  14485. minorTickPosition?: OptionsMinorTickPositionValue;
  14486. /**
  14487. * (Highstock, Gantt) Enable or disable minor ticks. Unless
  14488. * minorTickInterval is set, the tick interval is calculated as a fifth of
  14489. * the `tickInterval`.
  14490. *
  14491. * On a logarithmic axis, minor ticks are laid out based on a best guess,
  14492. * attempting to enter approximately 5 minor ticks between each major tick.
  14493. *
  14494. * Prior to v6.0.0, ticks were unabled in auto layout by setting
  14495. * `minorTickInterval` to `"auto"`.
  14496. */
  14497. minorTicks?: boolean;
  14498. /**
  14499. * (Highstock, Gantt) The pixel width of the minor tick mark.
  14500. */
  14501. minorTickWidth?: number;
  14502. /**
  14503. * (Highcharts, Highstock, Gantt) Padding of the min value relative to the
  14504. * length of the axis. A padding of 0.05 will make a 100px axis 5px longer.
  14505. * This is useful when you don't want the lowest data value to appear on the
  14506. * edge of the plot area. When the axis' `min` option is set or a max
  14507. * extreme is set using `axis.setExtremes()`, the maxPadding will be
  14508. * ignored.
  14509. *
  14510. * Also the `softThreshold` option takes precedence over `minPadding`, so if
  14511. * the data is tangent to the threshold, `minPadding` may not apply unless
  14512. * `softThreshold` is set to false.
  14513. */
  14514. minPadding?: number;
  14515. /**
  14516. * (Highstock, Gantt) The minimum tick interval allowed in axis values. For
  14517. * example on zooming in on an axis with daily data, this can be used to
  14518. * prevent the axis from showing hours. Defaults to the closest distance
  14519. * between two points on the axis.
  14520. */
  14521. minTickInterval?: number;
  14522. /**
  14523. * (Highstock, Gantt) The distance in pixels from the plot area to the axis
  14524. * line. A positive offset moves the axis with it's line, labels and ticks
  14525. * away from the plot area. This is typically used when two or more axes are
  14526. * displayed on the same side of the plot. With multiple axes the offset is
  14527. * dynamically adjusted to avoid collision, this can be overridden by
  14528. * setting offset explicitly.
  14529. */
  14530. offset?: number;
  14531. /**
  14532. * (Highstock, Highcharts, Gantt) Whether to display the axis on the
  14533. * opposite side of the normal. The normal is on the left side for vertical
  14534. * axes and bottom for horizontal, so the opposite sides will be right and
  14535. * top respectively. This is typically used with dual or multiple axes.
  14536. */
  14537. opposite?: boolean;
  14538. /**
  14539. * (Highcharts) Refers to the index in the panes array. Used for circular
  14540. * gauges and polar charts. When the option is not set then first pane will
  14541. * be used.
  14542. */
  14543. pane?: number;
  14544. /**
  14545. * (Highcharts, Highstock, Gantt) An array of colored bands stretching
  14546. * across the plot area marking an interval on the axis.
  14547. *
  14548. * In styled mode, the plot bands are styled by the `.highcharts-plot-band`
  14549. * class in addition to the `className` option.
  14550. */
  14551. plotBands?: Array<NavigatorYAxisPlotBandsOptions>;
  14552. /**
  14553. * (Highcharts, Highstock, Gantt) An array of lines stretching across the
  14554. * plot area, marking a specific value on one of the axes.
  14555. *
  14556. * In styled mode, the plot lines are styled by the `.highcharts-plot-line`
  14557. * class in addition to the `className` option.
  14558. */
  14559. plotLines?: Array<NavigatorYAxisPlotLinesOptions>;
  14560. /**
  14561. * (Highstock, Gantt) Whether to reverse the axis so that the highest number
  14562. * is closest to the origin.
  14563. */
  14564. reversed?: boolean;
  14565. /**
  14566. * (Highcharts, Highstock) If `true`, the first series in a stack will be
  14567. * drawn on top in a positive, non-reversed Y axis. If `false`, the first
  14568. * series is in the base of the stack.
  14569. */
  14570. reversedStacks?: boolean;
  14571. /**
  14572. * (Highstock, Gantt) Whether to show the first tick label.
  14573. */
  14574. showFirstLabel?: boolean;
  14575. /**
  14576. * (Highcharts, Highstock, Gantt) Whether to show the last tick label.
  14577. * Defaults to `true` on cartesian charts, and `false` on polar charts.
  14578. */
  14579. showLastLabel?: boolean;
  14580. /**
  14581. * (Highcharts, Highstock, Gantt) A soft maximum for the axis. If the series
  14582. * data maximum is less than this, the axis will stay at this maximum, but
  14583. * if the series data maximum is higher, the axis will flex to show all
  14584. * data.
  14585. *
  14586. * **Note**: The series.softThreshold option takes precedence over this
  14587. * option.
  14588. */
  14589. softMax?: number;
  14590. /**
  14591. * (Highcharts, Highstock, Gantt) A soft minimum for the axis. If the series
  14592. * data minimum is greater than this, the axis will stay at this minimum,
  14593. * but if the series data minimum is lower, the axis will flex to show all
  14594. * data.
  14595. *
  14596. * **Note**: The series.softThreshold option takes precedence over this
  14597. * option.
  14598. */
  14599. softMin?: number;
  14600. /**
  14601. * (Highcharts) The stack labels show the total value for each bar in a
  14602. * stacked column or bar chart. The label will be placed on top of positive
  14603. * columns and below negative columns. In case of an inverted column chart
  14604. * or a bar chart the label is placed to the right of positive bars and to
  14605. * the left of negative bars.
  14606. */
  14607. stackLabels?: NavigatorYAxisStackLabelsOptions;
  14608. /**
  14609. * (Highcharts, Highstock, Gantt) For datetime axes, this decides where to
  14610. * put the tick between weeks. 0 = Sunday, 1 = Monday.
  14611. */
  14612. startOfWeek?: number;
  14613. /**
  14614. * (Highcharts, Highstock, Gantt) Whether to force the axis to start on a
  14615. * tick. Use this option with the `maxPadding` option to control the axis
  14616. * start.
  14617. *
  14618. * This option is always disabled, when panning type is either `y` or `xy`.
  14619. */
  14620. startOnTick?: boolean;
  14621. /**
  14622. * (Gantt) For vertical axes only. Setting the static scale ensures that
  14623. * each tick unit is translated into a fixed pixel height. For example,
  14624. * setting the static scale to 24 results in each Y axis category taking up
  14625. * 24 pixels, and the height of the chart adjusts. Adding or removing items
  14626. * will make the chart resize.
  14627. */
  14628. staticScale?: number;
  14629. /**
  14630. * (Highcharts) Solid gauge series only. Color stops for the solid gauge.
  14631. * Use this in cases where a linear gradient between a `minColor` and
  14632. * `maxColor` is not sufficient. The stops is an array of tuples, where the
  14633. * first item is a float between 0 and 1 assigning the relative position in
  14634. * the gradient, and the second item is the color.
  14635. *
  14636. * For solid gauges, the Y axis also inherits the concept of data classes
  14637. * from the Highmaps color axis.
  14638. */
  14639. stops?: Array<[number, ColorType]>;
  14640. /**
  14641. * (Highcharts, Highstock, Gantt) The amount of ticks to draw on the axis.
  14642. * This opens up for aligning the ticks of multiple charts or panes within a
  14643. * chart. This option overrides the `tickPixelInterval` option.
  14644. *
  14645. * This option only has an effect on linear axes. Datetime, logarithmic or
  14646. * category axes are not affected.
  14647. */
  14648. tickAmount?: number;
  14649. /**
  14650. * (Highstock, Gantt) Color for the main tick marks.
  14651. *
  14652. * In styled mode, the stroke is given in the `.highcharts-tick` class.
  14653. */
  14654. tickColor?: ColorType;
  14655. /**
  14656. * (Highstock, Gantt) The interval of the tick marks in axis units. When
  14657. * `undefined`, the tick interval is computed to approximately follow the
  14658. * tickPixelInterval on linear and datetime axes. On categorized axes, a
  14659. * `undefined` tickInterval will default to 1, one category. Note that
  14660. * datetime axes are based on milliseconds, so for example an interval of
  14661. * one day is expressed as `24 * 3600 * 1000`.
  14662. *
  14663. * On logarithmic axes, the tickInterval is based on powers, so a
  14664. * tickInterval of 1 means one tick on each of 0.1, 1, 10, 100 etc. A
  14665. * tickInterval of 2 means a tick of 0.1, 10, 1000 etc. A tickInterval of
  14666. * 0.2 puts a tick on 0.1, 0.2, 0.4, 0.6, 0.8, 1, 2, 4, 6, 8, 10, 20, 40
  14667. * etc.
  14668. *
  14669. * If the tickInterval is too dense for labels to be drawn, Highcharts may
  14670. * remove ticks.
  14671. *
  14672. * If the chart has multiple axes, the alignTicks option may interfere with
  14673. * the `tickInterval` setting.
  14674. */
  14675. tickInterval?: number;
  14676. /**
  14677. * (Highstock, Gantt) The pixel length of the main tick marks.
  14678. */
  14679. tickLength?: number;
  14680. /**
  14681. * (Highcharts, Gantt) For categorized axes only. If `on` the tick mark is
  14682. * placed in the center of the category, if `between` the tick mark is
  14683. * placed between categories. The default is `between` if the `tickInterval`
  14684. * is 1, else `on`.
  14685. */
  14686. tickmarkPlacement?: OptionsTickmarkPlacementValue;
  14687. /**
  14688. * (Highstock, Gantt) If tickInterval is `null` this option sets the
  14689. * approximate pixel interval of the tick marks. Not applicable to
  14690. * categorized axis.
  14691. *
  14692. * The tick interval is also influenced by the minTickInterval option, that,
  14693. * by default prevents ticks from being denser than the data points.
  14694. */
  14695. tickPixelInterval?: number;
  14696. /**
  14697. * (Highstock, Gantt) The position of the major tick marks relative to the
  14698. * axis line. Can be one of `inside` and `outside`.
  14699. */
  14700. tickPosition?: OptionsTickPositionValue;
  14701. /**
  14702. * (Highstock, Gantt) A callback function returning array defining where the
  14703. * ticks are laid out on the axis. This overrides the default behaviour of
  14704. * tickPixelInterval and tickInterval. The automatic tick positions are
  14705. * accessible through `this.tickPositions` and can be modified by the
  14706. * callback.
  14707. */
  14708. tickPositioner?: AxisTickPositionerCallbackFunction;
  14709. /**
  14710. * (Highstock, Gantt) An array defining where the ticks are laid out on the
  14711. * axis. This overrides the default behaviour of tickPixelInterval and
  14712. * tickInterval.
  14713. */
  14714. tickPositions?: Array<number>;
  14715. /**
  14716. * (Highcharts, Highstock, Gantt) The pixel width of the major tick marks.
  14717. */
  14718. tickWidth?: number;
  14719. /**
  14720. * (Highstock, Gantt) The axis title, showing next to the axis line.
  14721. */
  14722. title?: NavigatorYAxisTitleOptions;
  14723. /**
  14724. * (Highcharts) Parallel coordinates only. Format that will be used for
  14725. * point.y and available in tooltip.pointFormat as `{point.formattedValue}`.
  14726. * If not set, `{point.formattedValue}` will use other options, in this
  14727. * order:
  14728. *
  14729. * 1. yAxis.labels.format will be used if set
  14730. *
  14731. * 2. If yAxis is a category, then category name will be displayed
  14732. *
  14733. * 3. If yAxis is a datetime, then value will use the same format as yAxis
  14734. * labels
  14735. *
  14736. * 4. If yAxis is linear/logarithmic type, then simple value will be used
  14737. */
  14738. tooltipValueFormat?: string;
  14739. /**
  14740. * (Highcharts, Gantt) The type of axis. Can be one of `linear`,
  14741. * `logarithmic`, `datetime`, `category` or `treegrid`. Defaults to
  14742. * `treegrid` for Gantt charts, `linear` for other chart types.
  14743. *
  14744. * In a datetime axis, the numbers are given in milliseconds, and tick marks
  14745. * are placed on appropriate values, like full hours or days. In a category
  14746. * or treegrid axis, the point names of the chart's series are used for
  14747. * categories, if a categories array is not defined.
  14748. */
  14749. type?: AxisTypeValue;
  14750. /**
  14751. * (Highcharts, Gantt) Applies only when the axis `type` is `category`. When
  14752. * `uniqueNames` is true, points are placed on the X axis according to their
  14753. * names. If the same point name is repeated in the same or another series,
  14754. * the point is placed on the same X position as other points of the same
  14755. * name. When `uniqueNames` is false, the points are laid out in increasing
  14756. * X positions regardless of their names, and the X axis category will take
  14757. * the name of the last point in each position.
  14758. */
  14759. uniqueNames?: boolean;
  14760. /**
  14761. * (Highcharts, Highstock, Gantt) Whether axis, including axis title, line,
  14762. * ticks and labels, should be visible.
  14763. */
  14764. visible?: boolean;
  14765. /**
  14766. * (Highcharts, Highstock) The width as the horizontal axis. If it's a
  14767. * number, it is interpreted as pixels.
  14768. *
  14769. * Since Highcharts v5.0.13: If it's a percentage string, it is interpreted
  14770. * as percentages of the total plot width.
  14771. */
  14772. width?: (number|string);
  14773. /**
  14774. * (Highstock, Gantt) Whether to zoom axis. If `chart.zoomType` is set, the
  14775. * option allows to disable zooming on an individual axis.
  14776. */
  14777. zoomEnabled?: boolean;
  14778. }
  14779. /**
  14780. * (Highcharts, Highstock, Gantt) An object defining mouse events for the plot
  14781. * band. Supported properties are `click`, `mouseover`, `mouseout`, `mousemove`.
  14782. */
  14783. export interface NavigatorYAxisPlotBandsEventsOptions {
  14784. /**
  14785. * (Highcharts, Highstock, Gantt) Click event on a plot band.
  14786. */
  14787. click?: EventCallbackFunction<PlotLineOrBand>;
  14788. /**
  14789. * (Highcharts, Highstock, Gantt) Mouse move event on a plot band.
  14790. */
  14791. mousemove?: EventCallbackFunction<PlotLineOrBand>;
  14792. /**
  14793. * (Highcharts, Highstock, Gantt) Mouse out event on the corner of a plot
  14794. * band.
  14795. */
  14796. mouseout?: EventCallbackFunction<PlotLineOrBand>;
  14797. /**
  14798. * (Highcharts, Highstock, Gantt) Mouse over event on a plot band.
  14799. */
  14800. mouseover?: EventCallbackFunction<PlotLineOrBand>;
  14801. }
  14802. /**
  14803. * (Highcharts, Highstock, Gantt) Text labels for the plot bands
  14804. */
  14805. export interface NavigatorYAxisPlotBandsLabelOptions {
  14806. /**
  14807. * (Highcharts, Highstock, Gantt) Horizontal alignment of the label. Can be
  14808. * one of "left", "center" or "right".
  14809. */
  14810. align?: AlignValue;
  14811. /**
  14812. * (Highcharts, Highstock, Gantt) Rotation of the text label in degrees .
  14813. */
  14814. rotation?: number;
  14815. /**
  14816. * (Highcharts, Highstock, Gantt) CSS styles for the text label.
  14817. *
  14818. * In styled mode, the labels are styled by the
  14819. * `.highcharts-plot-band-label` class.
  14820. */
  14821. style?: CSSObject;
  14822. /**
  14823. * (Highcharts, Highstock, Gantt) The string text itself. A subset of HTML
  14824. * is supported.
  14825. */
  14826. text?: string;
  14827. /**
  14828. * (Highcharts, Highstock, Gantt) The text alignment for the label. While
  14829. * `align` determines where the texts anchor point is placed within the plot
  14830. * band, `textAlign` determines how the text is aligned against its anchor
  14831. * point. Possible values are "left", "center" and "right". Defaults to the
  14832. * same as the `align` option.
  14833. */
  14834. textAlign?: AlignValue;
  14835. /**
  14836. * (Highcharts, Highstock, Gantt) Whether to use HTML to render the labels.
  14837. */
  14838. useHTML?: boolean;
  14839. /**
  14840. * (Highcharts, Highstock, Gantt) Vertical alignment of the label relative
  14841. * to the plot band. Can be one of "top", "middle" or "bottom".
  14842. */
  14843. verticalAlign?: VerticalAlignValue;
  14844. /**
  14845. * (Highcharts, Highstock, Gantt) Horizontal position relative the
  14846. * alignment. Default varies by orientation.
  14847. */
  14848. x?: number;
  14849. /**
  14850. * (Highcharts, Highstock, Gantt) Vertical position of the text baseline
  14851. * relative to the alignment. Default varies by orientation.
  14852. */
  14853. y?: number;
  14854. }
  14855. /**
  14856. * (Highcharts, Highstock, Gantt) An array of colored bands stretching across
  14857. * the plot area marking an interval on the axis.
  14858. *
  14859. * In styled mode, the plot bands are styled by the `.highcharts-plot-band`
  14860. * class in addition to the `className` option.
  14861. */
  14862. export interface NavigatorYAxisPlotBandsOptions {
  14863. /**
  14864. * (Highstock) Flag to decide if plotBand should be rendered across all
  14865. * panes.
  14866. */
  14867. acrossPanes?: boolean;
  14868. /**
  14869. * (Highcharts, Highstock, Gantt) Border color for the plot band. Also
  14870. * requires `borderWidth` to be set.
  14871. */
  14872. borderColor?: ColorString;
  14873. /**
  14874. * (Highcharts, Highstock, Gantt) Border width for the plot band. Also
  14875. * requires `borderColor` to be set.
  14876. */
  14877. borderWidth?: number;
  14878. /**
  14879. * (Highcharts, Highstock, Gantt) A custom class name, in addition to the
  14880. * default `highcharts-plot-band`, to apply to each individual band.
  14881. */
  14882. className?: string;
  14883. /**
  14884. * (Highcharts, Highstock, Gantt) The color of the plot band.
  14885. */
  14886. color?: (ColorString|GradientColorObject|PatternObject);
  14887. /**
  14888. * (Highcharts, Highstock, Gantt) An object defining mouse events for the
  14889. * plot band. Supported properties are `click`, `mouseover`, `mouseout`,
  14890. * `mousemove`.
  14891. */
  14892. events?: NavigatorYAxisPlotBandsEventsOptions;
  14893. /**
  14894. * (Highcharts, Highstock, Gantt) The start position of the plot band in
  14895. * axis units.
  14896. */
  14897. from?: number;
  14898. /**
  14899. * (Highcharts, Highstock, Gantt) An id used for identifying the plot band
  14900. * in Axis.removePlotBand.
  14901. */
  14902. id?: string;
  14903. /**
  14904. * (Highcharts) In a gauge chart, this option determines the inner radius of
  14905. * the plot band that stretches along the perimeter. It can be given as a
  14906. * percentage string, like `"100%"`, or as a pixel number, like `100`. By
  14907. * default, the inner radius is controlled by the thickness option.
  14908. */
  14909. innerRadius?: (number|string);
  14910. /**
  14911. * (Highcharts, Highstock, Gantt) Text labels for the plot bands
  14912. */
  14913. label?: NavigatorYAxisPlotBandsLabelOptions;
  14914. /**
  14915. * (Highcharts) In a gauge chart, this option determines the outer radius of
  14916. * the plot band that stretches along the perimeter. It can be given as a
  14917. * percentage string, like `"100%"`, or as a pixel number, like `100`.
  14918. */
  14919. outerRadius?: (number|string);
  14920. /**
  14921. * (Highcharts) In a gauge chart, this option sets the width of the plot
  14922. * band stretching along the perimeter. It can be given as a percentage
  14923. * string, like `"10%"`, or as a pixel number, like `10`. The default value
  14924. * 10 is the same as the default tickLength, thus making the plot band act
  14925. * as a background for the tick markers.
  14926. */
  14927. thickness?: (number|string);
  14928. /**
  14929. * (Highcharts, Highstock, Gantt) The end position of the plot band in axis
  14930. * units.
  14931. */
  14932. to?: number;
  14933. /**
  14934. * (Highcharts, Highstock, Gantt) The z index of the plot band within the
  14935. * chart, relative to other elements. Using the same z index as another
  14936. * element may give unpredictable results, as the last rendered element will
  14937. * be on top. Values from 0 to 20 make sense.
  14938. */
  14939. zIndex?: number;
  14940. }
  14941. /**
  14942. * (Highcharts, Highstock, Gantt) An object defining mouse events for the plot
  14943. * line. Supported properties are `click`, `mouseover`, `mouseout`, `mousemove`.
  14944. */
  14945. export interface NavigatorYAxisPlotLinesEventsOptions {
  14946. /**
  14947. * (Highcharts, Highstock, Gantt) Click event on a plot band.
  14948. */
  14949. click?: EventCallbackFunction<PlotLineOrBand>;
  14950. /**
  14951. * (Highcharts, Highstock, Gantt) Mouse move event on a plot band.
  14952. */
  14953. mousemove?: EventCallbackFunction<PlotLineOrBand>;
  14954. /**
  14955. * (Highcharts, Highstock, Gantt) Mouse out event on the corner of a plot
  14956. * band.
  14957. */
  14958. mouseout?: EventCallbackFunction<PlotLineOrBand>;
  14959. /**
  14960. * (Highcharts, Highstock, Gantt) Mouse over event on a plot band.
  14961. */
  14962. mouseover?: EventCallbackFunction<PlotLineOrBand>;
  14963. }
  14964. /**
  14965. * (Highcharts, Highstock, Gantt) Text labels for the plot bands
  14966. */
  14967. export interface NavigatorYAxisPlotLinesLabelOptions {
  14968. /**
  14969. * (Highcharts, Highstock, Gantt) Horizontal alignment of the label. Can be
  14970. * one of "left", "center" or "right".
  14971. */
  14972. align?: AlignValue;
  14973. /**
  14974. * (Highcharts, Highstock, Gantt) Callback JavaScript function to format the
  14975. * label. Useful properties like the value of plot line or the range of plot
  14976. * band (`from` & `to` properties) can be found in `this.options` object.
  14977. */
  14978. formatter?: FormatterCallbackFunction<PlotLineOrBand>;
  14979. /**
  14980. * (Highcharts, Highstock, Gantt) Rotation of the text label in degrees.
  14981. * Defaults to 0 for horizontal plot lines and 90 for vertical lines.
  14982. */
  14983. rotation?: number;
  14984. /**
  14985. * (Highcharts, Highstock, Gantt) CSS styles for the text label.
  14986. *
  14987. * In styled mode, the labels are styled by the
  14988. * `.highcharts-plot-line-label` class.
  14989. */
  14990. style?: CSSObject;
  14991. /**
  14992. * (Highcharts, Highstock, Gantt) The text itself. A subset of HTML is
  14993. * supported.
  14994. */
  14995. text?: string;
  14996. /**
  14997. * (Highcharts, Highstock, Gantt) The text alignment for the label. While
  14998. * `align` determines where the texts anchor point is placed within the plot
  14999. * band, `textAlign` determines how the text is aligned against its anchor
  15000. * point. Possible values are "left", "center" and "right". Defaults to the
  15001. * same as the `align` option.
  15002. */
  15003. textAlign?: AlignValue;
  15004. /**
  15005. * (Highcharts, Highstock, Gantt) Whether to use HTML to render the labels.
  15006. */
  15007. useHTML?: boolean;
  15008. /**
  15009. * (Highcharts, Highstock, Gantt) Vertical alignment of the label relative
  15010. * to the plot line. Can be one of "top", "middle" or "bottom".
  15011. */
  15012. verticalAlign?: VerticalAlignValue;
  15013. /**
  15014. * (Highcharts, Highstock, Gantt) Horizontal position relative the
  15015. * alignment. Default varies by orientation.
  15016. */
  15017. x?: number;
  15018. /**
  15019. * (Highcharts, Highstock, Gantt) Vertical position of the text baseline
  15020. * relative to the alignment. Default varies by orientation.
  15021. */
  15022. y?: number;
  15023. }
  15024. /**
  15025. * (Highcharts, Highstock, Gantt) An array of lines stretching across the plot
  15026. * area, marking a specific value on one of the axes.
  15027. *
  15028. * In styled mode, the plot lines are styled by the `.highcharts-plot-line`
  15029. * class in addition to the `className` option.
  15030. */
  15031. export interface NavigatorYAxisPlotLinesOptions {
  15032. /**
  15033. * (Highstock) Flag to decide if plotLine should be rendered across all
  15034. * panes.
  15035. */
  15036. acrossPanes?: boolean;
  15037. /**
  15038. * (Highcharts, Highstock, Gantt) A custom class name, in addition to the
  15039. * default `highcharts-plot-line`, to apply to each individual line.
  15040. */
  15041. className?: string;
  15042. /**
  15043. * (Highcharts, Highstock, Gantt) The color of the line.
  15044. */
  15045. color?: ColorString;
  15046. /**
  15047. * (Highcharts, Highstock, Gantt) The dashing or dot style for the plot
  15048. * line. For possible values see this overview.
  15049. */
  15050. dashStyle?: DashStyleValue;
  15051. /**
  15052. * (Highcharts, Highstock, Gantt) An object defining mouse events for the
  15053. * plot line. Supported properties are `click`, `mouseover`, `mouseout`,
  15054. * `mousemove`.
  15055. */
  15056. events?: NavigatorYAxisPlotLinesEventsOptions;
  15057. /**
  15058. * (Highcharts, Highstock, Gantt) An id used for identifying the plot line
  15059. * in Axis.removePlotLine.
  15060. */
  15061. id?: string;
  15062. /**
  15063. * (Highcharts, Highstock, Gantt) Text labels for the plot bands
  15064. */
  15065. label?: NavigatorYAxisPlotLinesLabelOptions;
  15066. /**
  15067. * (Highcharts, Highstock, Gantt) The position of the line in axis units.
  15068. */
  15069. value?: number;
  15070. /**
  15071. * (Highcharts, Highstock, Gantt) The width or thickness of the plot line.
  15072. */
  15073. width?: number;
  15074. /**
  15075. * (Highcharts, Highstock, Gantt) The z index of the plot line within the
  15076. * chart.
  15077. */
  15078. zIndex?: number;
  15079. }
  15080. /**
  15081. * (Highcharts) Enable or disable the initial animation when a series is
  15082. * displayed for the `stackLabels`. The animation can also be set as a
  15083. * configuration object. Please note that this option only applies to the
  15084. * initial animation. For other animations, see chart.animation and the
  15085. * animation parameter under the API methods. The following properties are
  15086. * supported:
  15087. *
  15088. * - `defer`: The animation delay time in milliseconds.
  15089. */
  15090. export interface NavigatorYAxisStackLabelsAnimationOptions {
  15091. /**
  15092. * (Highcharts) The animation delay time in milliseconds. Set to `0` renders
  15093. * stackLabel immediately. As `undefined` inherits defer time from the
  15094. * series.animation.defer.
  15095. */
  15096. defer?: number;
  15097. }
  15098. /**
  15099. * (Highcharts) The stack labels show the total value for each bar in a stacked
  15100. * column or bar chart. The label will be placed on top of positive columns and
  15101. * below negative columns. In case of an inverted column chart or a bar chart
  15102. * the label is placed to the right of positive bars and to the left of negative
  15103. * bars.
  15104. */
  15105. export interface NavigatorYAxisStackLabelsOptions {
  15106. /**
  15107. * (Highcharts) Defines the horizontal alignment of the stack total label.
  15108. * Can be one of `"left"`, `"center"` or `"right"`. The default value is
  15109. * calculated at runtime and depends on orientation and whether the stack is
  15110. * positive or negative.
  15111. */
  15112. align?: AlignValue;
  15113. /**
  15114. * (Highcharts) Allow the stack labels to overlap.
  15115. */
  15116. allowOverlap?: boolean;
  15117. /**
  15118. * (Highcharts) Enable or disable the initial animation when a series is
  15119. * displayed for the `stackLabels`. The animation can also be set as a
  15120. * configuration object. Please note that this option only applies to the
  15121. * initial animation. For other animations, see chart.animation and the
  15122. * animation parameter under the API methods. The following properties are
  15123. * supported:
  15124. *
  15125. * - `defer`: The animation delay time in milliseconds.
  15126. */
  15127. animation?: (boolean|NavigatorYAxisStackLabelsAnimationOptions|Partial<AnimationOptionsObject>);
  15128. /**
  15129. * (Highcharts) The background color or gradient for the stack label.
  15130. */
  15131. backgroundColor?: ColorType;
  15132. /**
  15133. * (Highcharts) The border color for the stack label. Defaults to
  15134. * `undefined`.
  15135. */
  15136. borderColor?: ColorType;
  15137. /**
  15138. * (Highcharts) The border radius in pixels for the stack label.
  15139. */
  15140. borderRadius?: number;
  15141. /**
  15142. * (Highcharts) The border width in pixels for the stack label.
  15143. */
  15144. borderWidth?: number;
  15145. /**
  15146. * (Highcharts) Whether to hide stack labels that are outside the plot area.
  15147. * By default, the stack label is moved inside the plot area according to
  15148. * the overflow option.
  15149. */
  15150. crop?: boolean;
  15151. /**
  15152. * (Highcharts) Enable or disable the stack total labels.
  15153. */
  15154. enabled?: boolean;
  15155. /**
  15156. * (Highcharts, Highstock) A format string for the data label. Available
  15157. * variables are the same as for `formatter`.
  15158. */
  15159. format?: string;
  15160. /**
  15161. * (Highcharts) Callback JavaScript function to format the label. The value
  15162. * is given by `this.total`.
  15163. */
  15164. formatter?: FormatterCallbackFunction<StackItemObject>;
  15165. /**
  15166. * (Highcharts) How to handle stack total labels that flow outside the plot
  15167. * area. The default is set to `"justify"`, which aligns them inside the
  15168. * plot area. For columns and bars, this means it will be moved inside the
  15169. * bar. To display stack labels outside the plot area, set `crop` to `false`
  15170. * and `overflow` to `"allow"`.
  15171. */
  15172. overflow?: DataLabelsOverflowValue;
  15173. /**
  15174. * (Highcharts) Rotation of the labels in degrees.
  15175. */
  15176. rotation?: number;
  15177. /**
  15178. * (Highcharts) CSS styles for the label.
  15179. *
  15180. * In styled mode, the styles are set in the `.highcharts-stack-label`
  15181. * class.
  15182. */
  15183. style?: CSSObject;
  15184. /**
  15185. * (Highcharts) The text alignment for the label. While `align` determines
  15186. * where the texts anchor point is placed with regards to the stack,
  15187. * `textAlign` determines how the text is aligned against its anchor point.
  15188. * Possible values are `"left"`, `"center"` and `"right"`. The default value
  15189. * is calculated at runtime and depends on orientation and whether the stack
  15190. * is positive or negative.
  15191. */
  15192. textAlign?: AlignValue;
  15193. /**
  15194. * (Highcharts, Highstock) Whether to use HTML to render the labels.
  15195. */
  15196. useHTML?: boolean;
  15197. /**
  15198. * (Highcharts) Defines the vertical alignment of the stack total label. Can
  15199. * be one of `"top"`, `"middle"` or `"bottom"`. The default value is
  15200. * calculated at runtime and depends on orientation and whether the stack is
  15201. * positive or negative.
  15202. */
  15203. verticalAlign?: VerticalAlignValue;
  15204. /**
  15205. * (Highcharts) The x position offset of the label relative to the left of
  15206. * the stacked bar. The default value is calculated at runtime and depends
  15207. * on orientation and whether the stack is positive or negative.
  15208. */
  15209. x?: number;
  15210. /**
  15211. * (Highcharts) The y position offset of the label relative to the tick
  15212. * position on the axis. The default value is calculated at runtime and
  15213. * depends on orientation and whether the stack is positive or negative.
  15214. */
  15215. y?: number;
  15216. }
  15217. /**
  15218. * (Highstock, Gantt) The axis title, showing next to the axis line.
  15219. */
  15220. export interface NavigatorYAxisTitleOptions {
  15221. /**
  15222. * (Highstock, Gantt) Alignment of the title relative to the axis values.
  15223. * Possible values are "low", "middle" or "high".
  15224. */
  15225. align?: AxisTitleAlignValue;
  15226. /**
  15227. * (Highstock, Gantt) The pixel distance between the axis labels and the
  15228. * title. Positive values are outside the axis line, negative are inside.
  15229. */
  15230. margin?: number;
  15231. /**
  15232. * (Highstock, Gantt) The distance of the axis title from the axis line. By
  15233. * default, this distance is computed from the offset width of the labels,
  15234. * the labels' distance from the axis and the title's margin. However when
  15235. * the offset option is set, it overrides all this.
  15236. */
  15237. offset?: number;
  15238. /**
  15239. * (Highcharts) Defines how the title is repositioned according to the 3D
  15240. * chart orientation.
  15241. *
  15242. * - `'offset'`: Maintain a fixed horizontal/vertical distance from the tick
  15243. * marks, despite the chart orientation. This is the backwards compatible
  15244. * behavior, and causes skewing of X and Z axes.
  15245. *
  15246. * - `'chart'`: Preserve 3D position relative to the chart. This looks nice,
  15247. * but hard to read if the text isn't forward-facing.
  15248. *
  15249. * - `'flap'`: Rotated text along the axis to compensate for the chart
  15250. * orientation. This tries to maintain text as legible as possible on all
  15251. * orientations.
  15252. *
  15253. * - `'ortho'`: Rotated text along the axis direction so that the labels are
  15254. * orthogonal to the axis. This is very similar to `'flap'`, but prevents
  15255. * skewing the labels (X and Y scaling are still present).
  15256. *
  15257. * - `undefined`: Will use the config from `labels.position3d`
  15258. */
  15259. position3d?: ("chart"|"flap"|"offset"|"ortho"|null);
  15260. /**
  15261. * (Highcharts, Highstock, Gantt) Whether to reserve space for the title
  15262. * when laying out the axis.
  15263. */
  15264. reserveSpace?: boolean;
  15265. /**
  15266. * (Highstock, Gantt) The rotation of the text in degrees. 0 is horizontal,
  15267. * 270 is vertical reading from bottom to top.
  15268. */
  15269. rotation?: number;
  15270. /**
  15271. * (Highcharts) If enabled, the axis title will skewed to follow the
  15272. * perspective.
  15273. *
  15274. * This will fix overlapping labels and titles, but texts become less
  15275. * legible due to the distortion.
  15276. *
  15277. * The final appearance depends heavily on `title.position3d`.
  15278. *
  15279. * A `null` value will use the config from `labels.skew3d`.
  15280. */
  15281. skew3d?: (boolean|null);
  15282. /**
  15283. * (Highstock, Gantt) CSS styles for the title. If the title text is longer
  15284. * than the axis length, it will wrap to multiple lines by default. This can
  15285. * be customized by setting `textOverflow: 'ellipsis'`, by setting a
  15286. * specific `width` or by setting `whiteSpace: 'nowrap'`.
  15287. *
  15288. * In styled mode, the stroke width is given in the `.highcharts-axis-title`
  15289. * class.
  15290. */
  15291. style?: CSSObject;
  15292. /**
  15293. * (Highcharts, Highstock, Gantt) The actual text of the axis title.
  15294. * Horizontal texts can contain HTML, but rotated texts are painted using
  15295. * vector techniques and must be clean text. The Y axis title is disabled by
  15296. * setting the `text` option to `undefined`.
  15297. */
  15298. text?: (string|null);
  15299. /**
  15300. * (Highstock, Gantt) Alignment of the text, can be `"left"`, `"right"` or
  15301. * `"center"`. Default alignment depends on the title.align:
  15302. *
  15303. * Horizontal axes:
  15304. *
  15305. * - for `align` = `"low"`, `textAlign` is set to `left`
  15306. *
  15307. * - for `align` = `"middle"`, `textAlign` is set to `center`
  15308. *
  15309. * - for `align` = `"high"`, `textAlign` is set to `right`
  15310. *
  15311. * Vertical axes:
  15312. *
  15313. * - for `align` = `"low"` and `opposite` = `true`, `textAlign` is set to
  15314. * `right`
  15315. *
  15316. * - for `align` = `"low"` and `opposite` = `false`, `textAlign` is set to
  15317. * `left`
  15318. *
  15319. * - for `align` = `"middle"`, `textAlign` is set to `center`
  15320. *
  15321. * - for `align` = `"high"` and `opposite` = `true` `textAlign` is set to
  15322. * `left`
  15323. *
  15324. * - for `align` = `"high"` and `opposite` = `false` `textAlign` is set to
  15325. * `right`
  15326. */
  15327. textAlign?: AlignValue;
  15328. /**
  15329. * (Highcharts, Highstock, Gantt) Whether to use HTML to render the axis
  15330. * title.
  15331. */
  15332. useHTML?: boolean;
  15333. /**
  15334. * (Highcharts, Highstock, Gantt) Horizontal pixel offset of the title
  15335. * position.
  15336. */
  15337. x?: number;
  15338. /**
  15339. * (Highcharts, Highstock, Gantt) Vertical pixel offset of the title
  15340. * position.
  15341. */
  15342. y?: number;
  15343. }
  15344. /**
  15345. * (Highcharts, Highstock, Gantt) Options for displaying a message like "No data
  15346. * to display". This feature requires the file no-data-to-display.js to be
  15347. * loaded in the page. The actual text to display is set in the lang.noData
  15348. * option.
  15349. */
  15350. export interface NoDataOptions {
  15351. /**
  15352. * (Highcharts, Highstock, Gantt) An object of additional SVG attributes for
  15353. * the no-data label.
  15354. */
  15355. attr?: SVGAttributes;
  15356. /**
  15357. * (Highcharts, Highstock, Gantt) The position of the no-data label,
  15358. * relative to the plot area.
  15359. */
  15360. position?: (AlignObject|NoDataPositionOptions);
  15361. /**
  15362. * (Highcharts, Highstock, Gantt) CSS styles for the no-data label.
  15363. */
  15364. style?: CSSObject;
  15365. /**
  15366. * (Highcharts, Highstock, Gantt) Whether to insert the label as HTML, or as
  15367. * pseudo-HTML rendered with SVG.
  15368. */
  15369. useHTML?: boolean;
  15370. }
  15371. /**
  15372. * (Highcharts, Highstock, Gantt) The position of the no-data label, relative to
  15373. * the plot area.
  15374. */
  15375. export interface NoDataPositionOptions {
  15376. /**
  15377. * (Highcharts, Highstock, Gantt) Horizontal alignment of the label.
  15378. */
  15379. align?: AlignValue;
  15380. /**
  15381. * (Highcharts, Highstock, Gantt) Vertical alignment of the label.
  15382. */
  15383. verticalAlign?: VerticalAlignValue;
  15384. /**
  15385. * (Highcharts, Highstock, Gantt) Horizontal offset of the label, in pixels.
  15386. */
  15387. x?: number;
  15388. /**
  15389. * (Highcharts, Highstock, Gantt) Vertical offset of the label, in pixels.
  15390. */
  15391. y?: number;
  15392. }
  15393. /**
  15394. * An object containing `left` and `top` properties for the position in the
  15395. * page.
  15396. */
  15397. export interface OffsetObject {
  15398. /**
  15399. * Left distance to the page border.
  15400. */
  15401. left: number;
  15402. /**
  15403. * Top distance to the page border.
  15404. */
  15405. top: number;
  15406. }
  15407. export interface Options {
  15408. /**
  15409. * (Highcharts, Highstock, Highmaps, Gantt) Options for configuring
  15410. * accessibility for the chart. Requires the accessibility module to be
  15411. * loaded. For a description of the module and information on its features,
  15412. * see Highcharts Accessibility.
  15413. */
  15414. accessibility?: AccessibilityOptions;
  15415. /**
  15416. * (Highcharts, Highstock, Highmaps, Gantt) A basic type of an annotation.
  15417. * It allows to add custom labels or shapes. The items can be tied to
  15418. * points, axis coordinates or chart pixel coordinates.
  15419. */
  15420. annotations?: Array<AnnotationsOptions>;
  15421. /**
  15422. * (Highcharts, Highstock) Options for the Boost module. The Boost module
  15423. * allows certain series types to be rendered by WebGL instead of the
  15424. * default SVG. This allows hundreds of thousands of data points to be
  15425. * rendered in milliseconds. In addition to the WebGL rendering it saves
  15426. * time by skipping processing and inspection of the data wherever possible.
  15427. * This introduces some limitations to what features are available in boost
  15428. * mode. See the docs for details.
  15429. *
  15430. * In addition to the global `boost` option, each series has a
  15431. * boostThreshold that defines when the boost should kick in.
  15432. *
  15433. * Requires the `modules/boost.js` module.
  15434. */
  15435. boost?: BoostOptions;
  15436. /**
  15437. * (Highcharts, Highstock, Highmaps, Gantt) The chart's caption, which will
  15438. * render below the chart and will be part of exported charts. The caption
  15439. * can be updated after chart initialization through the `Chart.update` or
  15440. * `Chart.caption.update` methods.
  15441. */
  15442. caption?: CaptionOptions;
  15443. /**
  15444. * (Highcharts, Highstock, Highmaps, Gantt) General options for the chart.
  15445. */
  15446. chart?: ChartOptions;
  15447. /**
  15448. * (Highcharts, Highstock, Highmaps) A color axis for series. Visually, the
  15449. * color axis will appear as a gradient or as separate items inside the
  15450. * legend, depending on whether the axis is scalar or based on data classes.
  15451. *
  15452. * For supported color formats, see the docs article about colors.
  15453. *
  15454. * A scalar color axis is represented by a gradient. The colors either range
  15455. * between the minColor and the maxColor, or for more fine grained control
  15456. * the colors can be defined in stops. Often times, the color axis needs to
  15457. * be adjusted to get the right color spread for the data. In addition to
  15458. * stops, consider using a logarithmic axis type, or setting min and max to
  15459. * avoid the colors being determined by outliers.
  15460. *
  15461. * When dataClasses are used, the ranges are subdivided into separate
  15462. * classes like categories based on their values. This can be used for
  15463. * ranges between two values, but also for a true category. However, when
  15464. * your data is categorized, it may be as convenient to add each category to
  15465. * a separate series.
  15466. *
  15467. * Color axis does not work with: `sankey`, `sunburst`, `dependencywheel`,
  15468. * `networkgraph`, `wordcloud`, `venn`, `gauge` and `solidgauge` series
  15469. * types.
  15470. *
  15471. * Since v7.2.0 `colorAxis` can also be an array of options objects.
  15472. *
  15473. * See the Axis object for programmatic access to the axis.
  15474. */
  15475. colorAxis?: (ColorAxisOptions|Array<ColorAxisOptions>);
  15476. /**
  15477. * (Highcharts, Highstock, Highmaps, Gantt) An array containing the default
  15478. * colors for the chart's series. When all colors are used, new colors are
  15479. * pulled from the start again.
  15480. *
  15481. * Default colors can also be set on a series or series.type basis, see
  15482. * column.colors, pie.colors.
  15483. *
  15484. * In styled mode, the colors option doesn't exist. Instead, colors are
  15485. * defined in CSS and applied either through series or point class names, or
  15486. * through the chart.colorCount option.
  15487. *
  15488. * ### Legacy
  15489. *
  15490. * In Highcharts 3.x, the default colors were: (see online documentation for
  15491. * example)
  15492. *
  15493. * In Highcharts 2.x, the default colors were: (see online documentation for
  15494. * example)
  15495. */
  15496. colors?: Array<ColorString>;
  15497. /**
  15498. * (Gantt) The Pathfinder module allows you to define connections between
  15499. * any two points, represented as lines - optionally with markers for the
  15500. * start and/or end points. Multiple algorithms are available for
  15501. * calculating how the connecting lines are drawn.
  15502. *
  15503. * Connector functionality requires Highcharts Gantt to be loaded. In Gantt
  15504. * charts, the connectors are used to draw dependencies between tasks.
  15505. */
  15506. connectors?: ConnectorsOptions;
  15507. /**
  15508. * (Highcharts, Highstock, Highmaps, Gantt) Highchart by default puts a
  15509. * credits label in the lower right corner of the chart. This can be changed
  15510. * using these options.
  15511. */
  15512. credits?: CreditsOptions;
  15513. /**
  15514. * (Highcharts, Highstock, Highmaps, Gantt) The Data module provides a
  15515. * simplified interface for adding data to a chart from sources like CVS,
  15516. * HTML tables or grid views. See also the tutorial article on the Data
  15517. * module.
  15518. *
  15519. * It requires the `modules/data.js` file to be loaded.
  15520. *
  15521. * Please note that the default way of adding data in Highcharts, without
  15522. * the need of a module, is through the series._type_.data option.
  15523. */
  15524. data?: DataOptions;
  15525. /**
  15526. * (Highcharts, Highstock, Highmaps, Gantt) Options for configuring markers
  15527. * for annotations.
  15528. *
  15529. * An example of the arrow marker: (see online documentation for example)
  15530. */
  15531. defs?: (DefsOptions|Dictionary<ASTNode>);
  15532. /**
  15533. * (Highcharts, Highmaps) Options for drill down, the concept of inspecting
  15534. * increasingly high resolution data through clicking on chart items like
  15535. * columns or pie slices.
  15536. *
  15537. * The drilldown feature requires the drilldown.js file to be loaded, found
  15538. * in the modules directory of the download package, or online at
  15539. * code.highcharts.com/modules/drilldown.js.
  15540. */
  15541. drilldown?: DrilldownOptions;
  15542. /**
  15543. * (Highcharts, Highstock, Highmaps, Gantt) Options for the exporting
  15544. * module. For an overview on the matter, see the docs.
  15545. */
  15546. exporting?: ExportingOptions;
  15547. global?: GlobalOptions;
  15548. /**
  15549. * (Highcharts, Highstock, Highmaps, Gantt) Language object. The language
  15550. * object is global and it can't be set on each chart initialization.
  15551. * Instead, use `Highcharts.setOptions` to set it before any chart is
  15552. * initialized. (see online documentation for example)
  15553. */
  15554. lang?: LangOptions;
  15555. /**
  15556. * (Highcharts, Highstock, Highmaps, Gantt) The legend is a box containing a
  15557. * symbol and name for each series item or point item in the chart. Each
  15558. * series (or points in case of pie charts) is represented by a symbol and
  15559. * its name in the legend.
  15560. *
  15561. * It is possible to override the symbol creator function and create custom
  15562. * legend symbols.
  15563. */
  15564. legend?: LegendOptions;
  15565. /**
  15566. * (Highcharts, Highstock, Highmaps, Gantt) The loading options control the
  15567. * appearance of the loading screen that covers the plot area on chart
  15568. * operations. This screen only appears after an explicit call to
  15569. * `chart.showLoading()`. It is a utility for developers to communicate to
  15570. * the end user that something is going on, for example while retrieving new
  15571. * data via an XHR connection. The "Loading..." text itself is not part of
  15572. * this configuration object, but part of the `lang` object.
  15573. */
  15574. loading?: LoadingOptions;
  15575. mapNavigation?: MapNavigationOptions;
  15576. /**
  15577. * (Highcharts, Highstock, Highmaps, Gantt) A collection of options for
  15578. * buttons and menus appearing in the exporting module.
  15579. */
  15580. navigation?: NavigationOptions;
  15581. /**
  15582. * (Highstock, Gantt) The navigator is a small series below the main series,
  15583. * displaying a view of the entire data set. It provides tools to zoom in
  15584. * and out on parts of the data as well as panning across the dataset.
  15585. */
  15586. navigator?: NavigatorOptions;
  15587. /**
  15588. * (Highcharts, Highstock, Gantt) Options for displaying a message like "No
  15589. * data to display". This feature requires the file no-data-to-display.js to
  15590. * be loaded in the page. The actual text to display is set in the
  15591. * lang.noData option.
  15592. */
  15593. noData?: NoDataOptions;
  15594. /**
  15595. * (Highcharts) The pane serves as a container for axes and backgrounds for
  15596. * circular gauges and polar charts.
  15597. */
  15598. pane?: PaneOptions;
  15599. /**
  15600. * (Highcharts, Highstock, Highmaps, Gantt) The plotOptions is a wrapper
  15601. * object for config objects for each series type. The config objects for
  15602. * each series can also be overridden for each series item as given in the
  15603. * series array.
  15604. *
  15605. * Configuration options for the series are given in three levels. Options
  15606. * for all series in a chart are given in the plotOptions.series object.
  15607. * Then options for all series of a specific type are given in the
  15608. * plotOptions of that type, for example `plotOptions.line`. Next, options
  15609. * for one single series are given in the series array.
  15610. */
  15611. plotOptions?: PlotOptions;
  15612. /**
  15613. * (Highstock, Gantt) The range selector is a tool for selecting ranges to
  15614. * display within the chart. It provides buttons to select preconfigured
  15615. * ranges in the chart, like 1 day, 1 week, 1 month etc. It also provides
  15616. * input boxes where min and max dates can be manually input.
  15617. */
  15618. rangeSelector?: RangeSelectorOptions;
  15619. /**
  15620. * (Highcharts, Highstock, Highmaps, Gantt) Allows setting a set of rules to
  15621. * apply for different screen or chart sizes. Each rule specifies additional
  15622. * chart options.
  15623. */
  15624. responsive?: ResponsiveOptions;
  15625. /**
  15626. * (Highstock, Gantt) The scrollbar is a means of panning over the X axis of
  15627. * a stock chart. Scrollbars can also be applied to other types of axes.
  15628. *
  15629. * Another approach to scrollable charts is the chart.scrollablePlotArea
  15630. * option that is especially suitable for simpler cartesian charts on
  15631. * mobile.
  15632. *
  15633. * In styled mode, all the presentational options for the scrollbar are
  15634. * replaced by the classes `.highcharts-scrollbar-thumb`,
  15635. * `.highcharts-scrollbar-arrow`, `.highcharts-scrollbar-button`,
  15636. * `.highcharts-scrollbar-rifles` and `.highcharts-scrollbar-track`.
  15637. */
  15638. scrollbar?: ScrollbarOptions;
  15639. /**
  15640. * (Highcharts, Highstock, Highmaps, Gantt) Series options for specific data
  15641. * and the data itself. In TypeScript you have to cast the series options to
  15642. * specific series types, to get all possible options for a series.
  15643. */
  15644. series?: Array<SeriesOptionsType>;
  15645. /**
  15646. * (Highstock) Configure the stockTools gui strings in the chart. Requires
  15647. * the [stockTools module]() to be loaded. For a description of the module
  15648. * and information on its features, see [Highcharts StockTools]().
  15649. */
  15650. stockTools?: StockToolsOptions;
  15651. /**
  15652. * (Highcharts, Highstock, Highmaps, Gantt) The chart's subtitle. This can
  15653. * be used both to display a subtitle below the main title, and to display
  15654. * random text anywhere in the chart. The subtitle can be updated after
  15655. * chart initialization through the `Chart.setTitle` method.
  15656. */
  15657. subtitle?: SubtitleOptions;
  15658. /**
  15659. * (Highcharts, Highstock, Highmaps, Gantt) Time options that can apply
  15660. * globally or to individual charts. These settings affect how `datetime`
  15661. * axes are laid out, how tooltips are formatted, how series
  15662. * pointIntervalUnit works and how the Highstock range selector handles
  15663. * time.
  15664. *
  15665. * The common use case is that all charts in the same Highcharts object
  15666. * share the same time settings, in which case the global settings are set
  15667. * using `setOptions`. (see online documentation for example)
  15668. *
  15669. * Since v6.0.5, the time options were moved from the `global` obect to the
  15670. * `time` object, and time options can be set on each individual chart.
  15671. */
  15672. time?: TimeOptions;
  15673. /**
  15674. * (Highcharts, Highstock, Highmaps, Gantt) The chart's main title.
  15675. */
  15676. title?: TitleOptions;
  15677. /**
  15678. * (Highcharts, Highstock, Highmaps, Gantt) Options for the tooltip that
  15679. * appears when the user hovers over a series or point.
  15680. */
  15681. tooltip?: TooltipOptions;
  15682. /**
  15683. * (Highcharts, Highstock, Highmaps, Gantt) The X axis or category axis.
  15684. * Normally this is the horizontal axis, though if the chart is inverted
  15685. * this is the vertical axis. In case of multiple axes, the xAxis node is an
  15686. * array of configuration objects.
  15687. *
  15688. * See the Axis class for programmatic access to the axis.
  15689. */
  15690. xAxis?: (XAxisOptions|Array<XAxisOptions>);
  15691. /**
  15692. * (Highcharts, Highstock, Highmaps, Gantt) The Y axis or value axis.
  15693. * Normally this is the vertical axis, though if the chart is inverted this
  15694. * is the horizontal axis. In case of multiple axes, the yAxis node is an
  15695. * array of configuration objects.
  15696. *
  15697. * See the Axis object for programmatic access to the axis.
  15698. */
  15699. yAxis?: (YAxisOptions|Array<YAxisOptions>);
  15700. /**
  15701. * (Highcharts) The Z axis or depth axis for 3D plots.
  15702. *
  15703. * See the Axis class for programmatic access to the axis.
  15704. */
  15705. zAxis?: (ZAxisOptions|Array<ZAxisOptions>);
  15706. }
  15707. /**
  15708. * (Highcharts) An array of background items for the pane.
  15709. */
  15710. export interface PaneBackgroundOptions {
  15711. /**
  15712. * (Highcharts) The background color or gradient for the pane.
  15713. */
  15714. backgroundColor?: (ColorString|GradientColorObject|PatternObject);
  15715. /**
  15716. * (Highcharts) The pane background border color.
  15717. */
  15718. borderColor?: (ColorString|GradientColorObject|PatternObject);
  15719. /**
  15720. * (Highcharts) The pixel border width of the pane background.
  15721. */
  15722. borderWidth?: number;
  15723. /**
  15724. * (Highcharts) The class name for this background.
  15725. */
  15726. className?: string;
  15727. /**
  15728. * (Highcharts) The inner radius of the pane background. Can be either
  15729. * numeric (pixels) or a percentage string.
  15730. */
  15731. innerRadius?: (number|string);
  15732. /**
  15733. * (Highcharts) The outer radius of the circular pane background. Can be
  15734. * either numeric (pixels) or a percentage string.
  15735. */
  15736. outerRadius?: (number|string);
  15737. /**
  15738. * (Highcharts) The shape of the pane background. When `solid`, the
  15739. * background is circular. When `arc`, the background extends only from the
  15740. * min to the max of the value axis.
  15741. */
  15742. shape?: PaneBackgroundShapeValue;
  15743. }
  15744. /**
  15745. * (Highcharts) The pane serves as a container for axes and backgrounds for
  15746. * circular gauges and polar charts.
  15747. */
  15748. export interface PaneOptions {
  15749. /**
  15750. * (Highcharts) An array of background items for the pane.
  15751. */
  15752. background?: Array<PaneBackgroundOptions>;
  15753. /**
  15754. * (Highcharts) The center of a polar chart or angular gauge, given as an
  15755. * array of [x, y] positions. Positions can be given as integers that
  15756. * transform to pixels, or as percentages of the plot area size.
  15757. */
  15758. center?: Array<(string|number)>;
  15759. /**
  15760. * (Highcharts) The end angle of the polar X axis or gauge value axis, given
  15761. * in degrees where 0 is north. Defaults to startAngle
  15762. *
  15763. * + 360.
  15764. */
  15765. endAngle?: number;
  15766. /**
  15767. * (Highcharts) The inner size of the pane, either as a number defining
  15768. * pixels, or a percentage defining a percentage of the pane's size.
  15769. */
  15770. innerSize?: (number|string);
  15771. /**
  15772. * (Highcharts) The size of the pane, either as a number defining pixels, or
  15773. * a percentage defining a percentage of the available plot area (the
  15774. * smallest of the plot height or plot width).
  15775. */
  15776. size?: (number|string);
  15777. /**
  15778. * (Highcharts) The start angle of the polar X axis or gauge axis, given in
  15779. * degrees where 0 is north. Defaults to 0.
  15780. */
  15781. startAngle?: number;
  15782. }
  15783. /**
  15784. * Holds a pattern definition.
  15785. */
  15786. export interface PatternObject {
  15787. /**
  15788. * Animation options for the image pattern loading.
  15789. */
  15790. animation?: (boolean|Partial<AnimationOptionsObject>);
  15791. /**
  15792. * Pattern options
  15793. */
  15794. pattern: PatternOptionsObject;
  15795. /**
  15796. * Optionally an index referencing which pattern to use. Highcharts adds 10
  15797. * default patterns to the `Highcharts.patterns` array. Additional pattern
  15798. * definitions can be pushed to this array if desired. This option is an
  15799. * index into this array.
  15800. */
  15801. patternIndex?: number;
  15802. }
  15803. /**
  15804. * Pattern options
  15805. */
  15806. export interface PatternOptionsObject {
  15807. /**
  15808. * For automatically calculated width and height on images, it is possible
  15809. * to set an aspect ratio. The image will be zoomed to fill the bounding
  15810. * box, maintaining the aspect ratio defined.
  15811. */
  15812. aspectRatio: number;
  15813. /**
  15814. * Background color for the pattern if a `path` is set (not images).
  15815. */
  15816. backgroundColor: ColorString;
  15817. /**
  15818. * Pattern color, used as default path stroke.
  15819. */
  15820. color: ColorString;
  15821. /**
  15822. * Analogous to pattern.width.
  15823. */
  15824. height: number;
  15825. /**
  15826. * ID to assign to the pattern. This is automatically computed if not added,
  15827. * and identical patterns are reused. To refer to an existing pattern for a
  15828. * Highcharts color, use `color: "url(#pattern-id)"`.
  15829. */
  15830. id?: string;
  15831. /**
  15832. * URL to an image to use as the pattern.
  15833. */
  15834. image: string;
  15835. /**
  15836. * Opacity of the pattern as a float value from 0 to 1.
  15837. */
  15838. opacity: number;
  15839. /**
  15840. * Either an SVG path as string, or an object. As an object, supply the path
  15841. * string in the `path.d` property. Other supported properties are standard
  15842. * SVG attributes like `path.stroke` and `path.fill`. If a path is supplied
  15843. * for the pattern, the `image` property is ignored.
  15844. */
  15845. path: (string|SVGAttributes);
  15846. /**
  15847. * SVG `patternTransform` to apply to the entire pattern.
  15848. */
  15849. patternTransform: string;
  15850. /**
  15851. * Width of the pattern. For images this is automatically set to the width
  15852. * of the element bounding box if not supplied. For non-image patterns the
  15853. * default is 32px. Note that automatic resizing of image patterns to fill a
  15854. * bounding box dynamically is only supported for patterns with an
  15855. * automatically calculated ID.
  15856. */
  15857. width: number;
  15858. /**
  15859. * Horizontal offset of the pattern. Defaults to 0.
  15860. */
  15861. x?: number;
  15862. /**
  15863. * Vertical offset of the pattern. Defaults to 0.
  15864. */
  15865. y?: number;
  15866. }
  15867. /**
  15868. * (Highstock) Enable or disable the initial animation when a series is
  15869. * displayed. The animation can also be set as a configuration object. Please
  15870. * note that this option only applies to the initial animation of the series
  15871. * itself. For other animations, see chart.animation and the animation parameter
  15872. * under the API methods. The following properties are supported:
  15873. *
  15874. * - `defer`: The animation delay time in milliseconds.
  15875. *
  15876. * - `duration`: The duration of the animation in milliseconds.
  15877. *
  15878. * - `easing`: Can be a string reference to an easing function set on the `Math`
  15879. * object or a function. See the _Custom easing function_ demo below.
  15880. *
  15881. * Due to poor performance, animation is disabled in old IE browsers for several
  15882. * chart types.
  15883. */
  15884. export interface PlotAbandsAnimationOptions {
  15885. defer?: number;
  15886. }
  15887. export interface PlotAbandsBottomLineOptions {
  15888. styles?: PlotAbandsBottomLineStylesOptions;
  15889. }
  15890. export interface PlotAbandsBottomLineStylesOptions {
  15891. /**
  15892. * (Highstock) Pixel width of the line.
  15893. */
  15894. lineWidth?: number;
  15895. }
  15896. /**
  15897. * (Highcharts, Highstock, Highmaps, Gantt) Enable or disable the initial
  15898. * animation when a series is displayed for the `dataLabels`. The animation can
  15899. * also be set as a configuration object. Please note that this option only
  15900. * applies to the initial animation. For other animations, see chart.animation
  15901. * and the animation parameter under the API methods. The following properties
  15902. * are supported:
  15903. *
  15904. * - `defer`: The animation delay time in milliseconds.
  15905. */
  15906. export interface PlotAbandsDataLabelsAnimationOptions {
  15907. /**
  15908. * (Highcharts, Highstock, Highmaps, Gantt) The animation delay time in
  15909. * milliseconds. Set to `0` renders dataLabel immediately. As `undefined`
  15910. * inherits defer time from the series.animation.defer.
  15911. */
  15912. defer?: number;
  15913. }
  15914. /**
  15915. * (Highcharts, Highstock, Highmaps, Gantt) Options for the series data labels,
  15916. * appearing next to each data point.
  15917. *
  15918. * Since v6.2.0, multiple data labels can be applied to each single point by
  15919. * defining them as an array of configs.
  15920. *
  15921. * In styled mode, the data labels can be styled with the
  15922. * `.highcharts-data-label-box` and `.highcharts-data-label` class names (see
  15923. * example).
  15924. */
  15925. export interface PlotAbandsDataLabelsOptions {
  15926. /**
  15927. * (Highcharts, Highstock, Highmaps, Gantt) The alignment of the data label
  15928. * compared to the point. If `right`, the right side of the label should be
  15929. * touching the point. For points with an extent, like columns, the
  15930. * alignments also dictates how to align it inside the box, as given with
  15931. * the inside option. Can be one of `left`, `center` or `right`.
  15932. */
  15933. align?: (AlignValue|null);
  15934. /**
  15935. * (Highcharts, Highstock, Highmaps, Gantt) Whether to allow data labels to
  15936. * overlap. To make the labels less sensitive for overlapping, the
  15937. * dataLabels.padding can be set to 0.
  15938. */
  15939. allowOverlap?: boolean;
  15940. /**
  15941. * (Highcharts, Highstock, Highmaps, Gantt) Enable or disable the initial
  15942. * animation when a series is displayed for the `dataLabels`. The animation
  15943. * can also be set as a configuration object. Please note that this option
  15944. * only applies to the initial animation. For other animations, see
  15945. * chart.animation and the animation parameter under the API methods. The
  15946. * following properties are supported:
  15947. *
  15948. * - `defer`: The animation delay time in milliseconds.
  15949. */
  15950. animation?: (boolean|PlotAbandsDataLabelsAnimationOptions|Partial<AnimationOptionsObject>);
  15951. /**
  15952. * (Highcharts, Highstock, Highmaps, Gantt) The background color or gradient
  15953. * for the data label.
  15954. */
  15955. backgroundColor?: (ColorString|GradientColorObject|PatternObject);
  15956. /**
  15957. * (Highcharts, Highstock, Highmaps, Gantt) The border color for the data
  15958. * label. Defaults to `undefined`.
  15959. */
  15960. borderColor?: (ColorString|GradientColorObject|PatternObject);
  15961. /**
  15962. * (Highcharts, Highstock, Highmaps, Gantt) The border radius in pixels for
  15963. * the data label.
  15964. */
  15965. borderRadius?: number;
  15966. /**
  15967. * (Highcharts, Highstock, Highmaps, Gantt) The border width in pixels for
  15968. * the data label.
  15969. */
  15970. borderWidth?: number;
  15971. /**
  15972. * (Highcharts, Highstock, Highmaps, Gantt) A class name for the data label.
  15973. * Particularly in styled mode, this can be used to give each series' or
  15974. * point's data label unique styling. In addition to this option, a default
  15975. * color class name is added so that we can give the labels a contrast text
  15976. * shadow.
  15977. */
  15978. className?: string;
  15979. /**
  15980. * (Highcharts, Highstock, Highmaps, Gantt) The text color for the data
  15981. * labels. Defaults to `undefined`. For certain series types, like column or
  15982. * map, the data labels can be drawn inside the points. In this case the
  15983. * data label will be drawn with maximum contrast by default. Additionally,
  15984. * it will be given a `text-outline` style with the opposite color, to
  15985. * further increase the contrast. This can be overridden by setting the
  15986. * `text-outline` style to `none` in the `dataLabels.style` option.
  15987. */
  15988. color?: (ColorString|GradientColorObject|PatternObject);
  15989. /**
  15990. * (Highcharts, Highstock, Highmaps, Gantt) Whether to hide data labels that
  15991. * are outside the plot area. By default, the data label is moved inside the
  15992. * plot area according to the overflow option.
  15993. */
  15994. crop?: boolean;
  15995. /**
  15996. * (Highcharts, Highstock, Gantt) Whether to defer displaying the data
  15997. * labels until the initial series animation has finished. Setting to
  15998. * `false` renders the data label immediately. If set to `true` inherits the
  15999. * defer time set in plotOptions.series.animation.
  16000. */
  16001. defer?: boolean;
  16002. /**
  16003. * (Highcharts, Highstock, Highmaps, Gantt) Enable or disable the data
  16004. * labels.
  16005. */
  16006. enabled?: boolean;
  16007. /**
  16008. * (Highcharts, Highstock, Highmaps, Gantt) A declarative filter to control
  16009. * of which data labels to display. The declarative filter is designed for
  16010. * use when callback functions are not available, like when the chart
  16011. * options require a pure JSON structure or for use with graphical editors.
  16012. * For programmatic control, use the `formatter` instead, and return
  16013. * `undefined` to disable a single data label.
  16014. */
  16015. filter?: DataLabelsFilterOptionsObject;
  16016. /**
  16017. * (Highcharts, Highstock, Highmaps, Gantt) A format string for the data
  16018. * label. Available variables are the same as for `formatter`.
  16019. */
  16020. format?: string;
  16021. /**
  16022. * (Highcharts, Highstock, Highmaps, Gantt) Callback JavaScript function to
  16023. * format the data label. Note that if a `format` is defined, the format
  16024. * takes precedence and the formatter is ignored.
  16025. */
  16026. formatter?: DataLabelsFormatterCallbackFunction;
  16027. /**
  16028. * (Highcharts, Highstock, Highmaps, Gantt) For points with an extent, like
  16029. * columns or map areas, whether to align the data label inside the box or
  16030. * to the actual value point. Defaults to `false` in most cases, `true` in
  16031. * stacked columns.
  16032. */
  16033. inside?: boolean;
  16034. /**
  16035. * (Highcharts, Highstock, Highmaps, Gantt) Format for points with the value
  16036. * of null. Works analogously to format. `nullFormat` can be applied only to
  16037. * series which support displaying null points.
  16038. */
  16039. nullFormat?: (boolean|string);
  16040. /**
  16041. * (Highcharts, Highstock, Highmaps, Gantt) Callback JavaScript function
  16042. * that defines formatting for points with the value of null. Works
  16043. * analogously to formatter. `nullPointFormatter` can be applied only to
  16044. * series which support displaying null points.
  16045. */
  16046. nullFormatter?: DataLabelsFormatterCallbackFunction;
  16047. /**
  16048. * (Highcharts, Highstock, Highmaps, Gantt) How to handle data labels that
  16049. * flow outside the plot area. The default is `"justify"`, which aligns them
  16050. * inside the plot area. For columns and bars, this means it will be moved
  16051. * inside the bar. To display data labels outside the plot area, set `crop`
  16052. * to `false` and `overflow` to `"allow"`.
  16053. */
  16054. overflow?: DataLabelsOverflowValue;
  16055. /**
  16056. * (Highcharts, Highstock, Highmaps, Gantt) When either the `borderWidth` or
  16057. * the `backgroundColor` is set, this is the padding within the box.
  16058. */
  16059. padding?: number;
  16060. /**
  16061. * (Highcharts, Highstock, Highmaps, Gantt) Aligns data labels relative to
  16062. * points. If `center` alignment is not possible, it defaults to `right`.
  16063. */
  16064. position?: AlignValue;
  16065. /**
  16066. * (Highcharts, Highstock, Highmaps, Gantt) Text rotation in degrees. Note
  16067. * that due to a more complex structure, backgrounds, borders and padding
  16068. * will be lost on a rotated data label.
  16069. */
  16070. rotation?: number;
  16071. /**
  16072. * (Highcharts, Highstock, Highmaps, Gantt) The shadow of the box. Works
  16073. * best with `borderWidth` or `backgroundColor`. Since 2.3 the shadow can be
  16074. * an object configuration containing `color`, `offsetX`, `offsetY`,
  16075. * `opacity` and `width`.
  16076. */
  16077. shadow?: (boolean|ShadowOptionsObject);
  16078. /**
  16079. * (Highcharts, Highstock, Highmaps, Gantt) The name of a symbol to use for
  16080. * the border around the label. Symbols are predefined functions on the
  16081. * Renderer object.
  16082. */
  16083. shape?: string;
  16084. /**
  16085. * (Highcharts, Highstock, Highmaps, Gantt) Styles for the label. The
  16086. * default `color` setting is `"contrast"`, which is a pseudo color that
  16087. * Highcharts picks up and applies the maximum contrast to the underlying
  16088. * point item, for example the bar in a bar chart.
  16089. *
  16090. * The `textOutline` is a pseudo property that applies an outline of the
  16091. * given width with the given color, which by default is the maximum
  16092. * contrast to the text. So a bright text color will result in a black text
  16093. * outline for maximum readability on a mixed background. In some cases,
  16094. * especially with grayscale text, the text outline doesn't work well, in
  16095. * which cases it can be disabled by setting it to `"none"`. When `useHTML`
  16096. * is true, the `textOutline` will not be picked up. In this, case, the same
  16097. * effect can be acheived through the `text-shadow` CSS property.
  16098. *
  16099. * For some series types, where each point has an extent, like for example
  16100. * tree maps, the data label may overflow the point. There are two
  16101. * strategies for handling overflow. By default, the text will wrap to
  16102. * multiple lines. The other strategy is to set `style.textOverflow` to
  16103. * `ellipsis`, which will keep the text on one line plus it will break
  16104. * inside long words.
  16105. */
  16106. style?: CSSObject;
  16107. /**
  16108. * (Highcharts, Highstock, Highmaps, Gantt) Options for a label text which
  16109. * should follow marker's shape. Border and background are disabled for a
  16110. * label that follows a path.
  16111. *
  16112. * **Note:** Only SVG-based renderer supports this option. Setting `useHTML`
  16113. * to true will disable this option.
  16114. */
  16115. textPath?: DataLabelsTextPathOptionsObject;
  16116. /**
  16117. * (Highcharts, Highstock, Highmaps, Gantt) Whether to use HTML to render
  16118. * the labels.
  16119. */
  16120. useHTML?: boolean;
  16121. /**
  16122. * (Highcharts, Highstock, Highmaps, Gantt) The vertical alignment of a data
  16123. * label. Can be one of `top`, `middle` or `bottom`. The default value
  16124. * depends on the data, for instance in a column chart, the label is above
  16125. * positive values and below negative values.
  16126. */
  16127. verticalAlign?: (VerticalAlignValue|null);
  16128. /**
  16129. * (Highcharts, Highstock, Highmaps, Gantt) The x position offset of the
  16130. * label relative to the point in pixels.
  16131. */
  16132. x?: number;
  16133. /**
  16134. * (Highcharts, Highstock, Highmaps, Gantt) The y position offset of the
  16135. * label relative to the point in pixels.
  16136. */
  16137. y?: number;
  16138. /**
  16139. * (Highcharts, Highstock, Highmaps, Gantt) The Z index of the data labels.
  16140. * The default Z index puts it above the series. Use a Z index of 2 to
  16141. * display it behind the series.
  16142. */
  16143. z?: number;
  16144. }
  16145. /**
  16146. * (Highcharts, Highstock) Options for the series data sorting.
  16147. */
  16148. export interface PlotAbandsDataSortingOptions {
  16149. /**
  16150. * (Highcharts, Highstock) Enable or disable data sorting for the series.
  16151. * Use xAxis.reversed to change the sorting order.
  16152. */
  16153. enabled?: boolean;
  16154. /**
  16155. * (Highcharts, Highstock) Whether to allow matching points by name in an
  16156. * update. If this option is disabled, points will be matched by order.
  16157. */
  16158. matchByName?: boolean;
  16159. /**
  16160. * (Highcharts, Highstock) Determines what data value should be used to sort
  16161. * by.
  16162. */
  16163. sortKey?: string;
  16164. }
  16165. /**
  16166. * (Highstock) Acceleration bands (ABANDS). This series requires the `linkedTo`
  16167. * option to be set and should be loaded after the
  16168. * `stock/indicators/indicators.js`.
  16169. *
  16170. * In TypeScript the type option must always be set.
  16171. *
  16172. * Configuration options for the series are given in three levels:
  16173. *
  16174. * 1. Options for all series in a chart are defined in the plotOptions.series
  16175. * object.
  16176. *
  16177. * 2. Options for all `abands` series are defined in plotOptions.abands.
  16178. *
  16179. * 3. Options for one single series are given in the series instance array. (see
  16180. * online documentation for example)
  16181. */
  16182. export interface PlotAbandsOptions {
  16183. /**
  16184. * (Highstock) Accessibility options for a series.
  16185. */
  16186. accessibility?: SeriesAccessibilityOptionsObject;
  16187. /**
  16188. * (Highstock) Allow this series' points to be selected by clicking on the
  16189. * graphic (columns, point markers, pie slices, map areas etc).
  16190. *
  16191. * The selected points can be handled by point select and unselect events,
  16192. * or collectively by the getSelectedPoints function.
  16193. *
  16194. * And alternative way of selecting points is through dragging.
  16195. */
  16196. allowPointSelect?: boolean;
  16197. /**
  16198. * (Highstock) Enable or disable the initial animation when a series is
  16199. * displayed. The animation can also be set as a configuration object.
  16200. * Please note that this option only applies to the initial animation of the
  16201. * series itself. For other animations, see chart.animation and the
  16202. * animation parameter under the API methods. The following properties are
  16203. * supported:
  16204. *
  16205. * - `defer`: The animation delay time in milliseconds.
  16206. *
  16207. * - `duration`: The duration of the animation in milliseconds.
  16208. *
  16209. * - `easing`: Can be a string reference to an easing function set on the
  16210. * `Math` object or a function. See the _Custom easing function_ demo below.
  16211. *
  16212. * Due to poor performance, animation is disabled in old IE browsers for
  16213. * several chart types.
  16214. */
  16215. animation?: (boolean|PlotAbandsAnimationOptions|Partial<AnimationOptionsObject>);
  16216. /**
  16217. * (Highstock) For some series, there is a limit that shuts down initial
  16218. * animation by default when the total number of points in the chart is too
  16219. * high. For example, for a column chart and its derivatives, animation does
  16220. * not run if there is more than 250 points totally. To disable this cap,
  16221. * set `animationLimit` to `Infinity`.
  16222. */
  16223. animationLimit?: number;
  16224. /**
  16225. * (Highstock) Sets the color blending in the boost module.
  16226. */
  16227. boostBlending?: OptionsBoostBlendingValue;
  16228. /**
  16229. * (Highstock) Set the point threshold for when a series should enter boost
  16230. * mode.
  16231. *
  16232. * Setting it to e.g. 2000 will cause the series to enter boost mode when
  16233. * there are 2000 or more points in the series.
  16234. *
  16235. * To disable boosting on the series, set the `boostThreshold` to 0. Setting
  16236. * it to 1 will force boosting.
  16237. *
  16238. * Note that the cropThreshold also affects this setting. When zooming in on
  16239. * a series that has fewer points than the `cropThreshold`, all points are
  16240. * rendered although outside the visible plot area, and the `boostThreshold`
  16241. * won't take effect.
  16242. */
  16243. boostThreshold?: number;
  16244. /**
  16245. * (Highmaps) The border color of the map areas.
  16246. *
  16247. * In styled mode, the border stroke is given in the `.highcharts-point`
  16248. * class.
  16249. */
  16250. borderColor?: (ColorString|GradientColorObject|PatternObject);
  16251. /**
  16252. * (Highmaps) The border width of each map area.
  16253. *
  16254. * In styled mode, the border stroke width is given in the
  16255. * `.highcharts-point` class.
  16256. */
  16257. borderWidth?: number;
  16258. bottomLine?: PlotAbandsBottomLineOptions;
  16259. /**
  16260. * (Highstock) An additional class name to apply to the series' graphical
  16261. * elements. This option does not replace default class names of the
  16262. * graphical element.
  16263. */
  16264. className?: string;
  16265. /**
  16266. * (Highstock) Disable this option to allow series rendering in the whole
  16267. * plotting area.
  16268. *
  16269. * **Note:** Clipping should be always enabled when chart.zoomType is set
  16270. */
  16271. clip?: boolean;
  16272. /**
  16273. * (Highstock) The main color of the series. In line type series it applies
  16274. * to the line and the point markers unless otherwise specified. In bar type
  16275. * series it applies to the bars unless a color is specified per point. The
  16276. * default value is pulled from the `options.colors` array.
  16277. *
  16278. * In styled mode, the color can be defined by the colorIndex option. Also,
  16279. * the series color can be set with the `.highcharts-series`,
  16280. * `.highcharts-color-{n}`, `.highcharts-{type}-series` or
  16281. * `.highcharts-series-{n}` class, or individual classes given by the
  16282. * `className` option.
  16283. */
  16284. color?: (ColorString|GradientColorObject|PatternObject);
  16285. /**
  16286. * (Highstock) Styled mode only. A specific color index to use for the
  16287. * series, so its graphic representations are given the class name
  16288. * `highcharts-color-{n}`.
  16289. */
  16290. colorIndex?: number;
  16291. /**
  16292. * (Highcharts, Highstock, Highmaps) Determines what data value should be
  16293. * used to calculate point color if `colorAxis` is used. Requires to set
  16294. * `min` and `max` if some custom point property is used or if approximation
  16295. * for data grouping is set to `'sum'`.
  16296. */
  16297. colorKey?: string;
  16298. /**
  16299. * (Highstock) Defines if comparison should start from the first point
  16300. * within the visible range or should start from the first point **before**
  16301. * the range.
  16302. *
  16303. * In other words, this flag determines if first point within the visible
  16304. * range will have 0% (`compareStart=true`) or should have been already
  16305. * calculated according to the previous point (`compareStart=false`).
  16306. */
  16307. compareStart?: boolean;
  16308. /**
  16309. * (Highstock) Whether to compare indicator to the main series values or
  16310. * indicator values.
  16311. */
  16312. compareToMain?: boolean;
  16313. /**
  16314. * (Highcharts) Polar charts only. Whether to connect the ends of a line
  16315. * series plot across the extremes.
  16316. */
  16317. connectEnds?: boolean;
  16318. /**
  16319. * (Highcharts, Highstock) Whether to connect a graph line across null
  16320. * points, or render a gap between the two points on either side of the
  16321. * null.
  16322. */
  16323. connectNulls?: boolean;
  16324. /**
  16325. * (Gantt) Override Pathfinder connector options for a series. Requires
  16326. * Highcharts Gantt to be loaded.
  16327. */
  16328. connectors?: SeriesConnectorsOptionsObject;
  16329. /**
  16330. * (Highcharts, Highstock, Gantt) When true, each point or column edge is
  16331. * rounded to its nearest pixel in order to render sharp on screen. In some
  16332. * cases, when there are a lot of densely packed columns, this leads to
  16333. * visible difference in column widths or distance between columns. In these
  16334. * cases, setting `crisp` to `false` may look better, even though each
  16335. * column is rendered blurry.
  16336. */
  16337. crisp?: boolean;
  16338. /**
  16339. * (Highcharts, Highstock) When the series contains less points than the
  16340. * crop threshold, all points are drawn, even if the points fall outside the
  16341. * visible plot area at the current zoom. The advantage of drawing all
  16342. * points (including markers and columns), is that animation is performed on
  16343. * updates. On the other hand, when the series contains more points than the
  16344. * crop threshold, the series data is cropped to only contain points that
  16345. * fall within the plot area. The advantage of cropping away invisible
  16346. * points is to increase performance on large series.
  16347. */
  16348. cropThreshold?: number;
  16349. /**
  16350. * (Highstock) You can set the cursor to "pointer" if you have click events
  16351. * attached to the series, to signal to the user that the points and lines
  16352. * can be clicked.
  16353. *
  16354. * In styled mode, the series cursor can be set with the same classes as
  16355. * listed under series.color.
  16356. */
  16357. cursor?: (string|CursorValue);
  16358. /**
  16359. * (Highstock) A reserved subspace to store options and values for
  16360. * customized functionality. Here you can add additional data for your own
  16361. * event callbacks and formatter callbacks.
  16362. */
  16363. custom?: Dictionary<any>;
  16364. /**
  16365. * (Highstock) Name of the dash style to use for the graph, or for some
  16366. * series types the outline of each shape.
  16367. *
  16368. * In styled mode, the stroke dash-array can be set with the same classes as
  16369. * listed under series.color.
  16370. */
  16371. dashStyle?: DashStyleValue;
  16372. /**
  16373. * (Highstock) Data grouping is the concept of sampling the data values into
  16374. * larger blocks in order to ease readability and increase performance of
  16375. * the JavaScript charts. Highstock by default applies data grouping when
  16376. * the points become closer than a certain pixel value, determined by the
  16377. * `groupPixelWidth` option.
  16378. *
  16379. * If data grouping is applied, the grouping information of grouped points
  16380. * can be read from the Point.dataGroup. If point options other than the
  16381. * data itself are set, for example `name` or `color` or custom properties,
  16382. * the grouping logic doesn't know how to group it. In this case the options
  16383. * of the first point instance are copied over to the group point. This can
  16384. * be altered through a custom `approximation` callback function.
  16385. */
  16386. dataGrouping?: DataGroupingOptionsObject;
  16387. /**
  16388. * (Highcharts, Highstock, Highmaps, Gantt) Options for the series data
  16389. * labels, appearing next to each data point.
  16390. *
  16391. * Since v6.2.0, multiple data labels can be applied to each single point by
  16392. * defining them as an array of configs.
  16393. *
  16394. * In styled mode, the data labels can be styled with the
  16395. * `.highcharts-data-label-box` and `.highcharts-data-label` class names
  16396. * (see example).
  16397. */
  16398. dataLabels?: (PlotAbandsDataLabelsOptions|Array<PlotAbandsDataLabelsOptions>);
  16399. /**
  16400. * (Highcharts, Highstock) Options for the series data sorting.
  16401. */
  16402. dataSorting?: (DataSortingOptionsObject|PlotAbandsDataSortingOptions);
  16403. /**
  16404. * (Highstock) A description of the series to add to the screen reader
  16405. * information about the series.
  16406. */
  16407. description?: string;
  16408. /**
  16409. * (Highstock) Enable or disable the mouse tracking for a specific series.
  16410. * This includes point tooltips and click events on graphs and points. For
  16411. * large datasets it improves performance.
  16412. */
  16413. enableMouseTracking?: boolean;
  16414. /**
  16415. * (Highstock) General event handlers for the series items. These event
  16416. * hooks can also be attached to the series at run time using the
  16417. * `Highcharts.addEvent` function.
  16418. */
  16419. events?: SeriesEventsOptionsObject;
  16420. /**
  16421. * (Highstock) Determines whether the series should look for the nearest
  16422. * point in both dimensions or just the x-dimension when hovering the
  16423. * series. Defaults to `'xy'` for scatter series and `'x'` for most other
  16424. * series. If the data has duplicate x-values, it is recommended to set this
  16425. * to `'xy'` to allow hovering over all points.
  16426. *
  16427. * Applies only to series types using nearest neighbor search (not direct
  16428. * hover) for tooltip.
  16429. */
  16430. findNearestPointBy?: OptionsFindNearestPointByValue;
  16431. /**
  16432. * (Highstock) Defines when to display a gap in the graph, together with the
  16433. * gapUnit option.
  16434. *
  16435. * In case when `dataGrouping` is enabled, points can be grouped into a
  16436. * larger time span. This can make the grouped points to have a greater
  16437. * distance than the absolute value of `gapSize` property, which will result
  16438. * in disappearing graph completely. To prevent this situation the mentioned
  16439. * distance between grouped points is used instead of previously defined
  16440. * `gapSize`.
  16441. *
  16442. * In practice, this option is most often used to visualize gaps in time
  16443. * series. In a stock chart, intraday data is available for daytime hours,
  16444. * while gaps will appear in nights and weekends.
  16445. */
  16446. gapSize?: number;
  16447. /**
  16448. * (Highstock) Together with gapSize, this option defines where to draw gaps
  16449. * in the graph.
  16450. *
  16451. * When the `gapUnit` is `"relative"` (default), a gap size of 5 means that
  16452. * if the distance between two points is greater than 5 times that of the
  16453. * two closest points, the graph will be broken.
  16454. *
  16455. * When the `gapUnit` is `"value"`, the gap is based on absolute axis
  16456. * values, which on a datetime axis is milliseconds. This also applies to
  16457. * the navigator series that inherits gap options from the base series.
  16458. */
  16459. gapUnit?: OptionsGapUnitValue;
  16460. /**
  16461. * (Highcharts, Highstock, Gantt) Whether to use the Y extremes of the total
  16462. * chart width or only the zoomed area when zooming in on parts of the X
  16463. * axis. By default, the Y axis adjusts to the min and max of the visible
  16464. * data. Cartesian series only.
  16465. */
  16466. getExtremesFromAll?: boolean;
  16467. /**
  16468. * (Highstock) When set to `false` will prevent the series data from being
  16469. * included in any form of data export.
  16470. *
  16471. * Since version 6.0.0 until 7.1.0 the option was existing undocumented as
  16472. * `includeInCSVExport`.
  16473. */
  16474. includeInDataExport?: boolean;
  16475. /**
  16476. * (Highcharts, Highstock, Gantt) Series labels are placed as close to the
  16477. * series as possible in a natural way, seeking to avoid other series. The
  16478. * goal of this feature is to make the chart more easily readable, like if a
  16479. * human designer placed the labels in the optimal position.
  16480. *
  16481. * The series labels currently work with series types having a `graph` or an
  16482. * `area`.
  16483. */
  16484. label?: SeriesLabelOptionsObject;
  16485. /**
  16486. * (Highstock) The line marks the last price from all points.
  16487. */
  16488. lastPrice?: SeriesLastPriceOptionsObject;
  16489. /**
  16490. * (Highstock) The line marks the last price from visible range of points.
  16491. */
  16492. lastVisiblePrice?: SeriesLastVisiblePriceOptionsObject;
  16493. /**
  16494. * (Highcharts, Highstock) The SVG value used for the `stroke-linecap` and
  16495. * `stroke-linejoin` of a line graph. Round means that lines are rounded in
  16496. * the ends and bends.
  16497. */
  16498. linecap?: SeriesLinecapValue;
  16499. /**
  16500. * (Highcharts, Highstock) Pixel width of the graph line.
  16501. */
  16502. lineWidth?: number;
  16503. /**
  16504. * (Highcharts, Highstock, Gantt) The main series ID that indicator will be
  16505. * based on. Required for this indicator.
  16506. */
  16507. linkedTo?: string;
  16508. /**
  16509. * (Highstock) Options for the point markers of line-like series. Properties
  16510. * like `fillColor`, `lineColor` and `lineWidth` define the visual
  16511. * appearance of the markers. Other series types, like column series, don't
  16512. * have markers, but have visual options on the series level instead.
  16513. *
  16514. * In styled mode, the markers can be styled with the `.highcharts-point`,
  16515. * `.highcharts-point-hover` and `.highcharts-point-select` class names.
  16516. */
  16517. marker?: PointMarkerOptionsObject;
  16518. /**
  16519. * (Highstock) The name of the series as shown in the legend, tooltip etc.
  16520. * If not set, it will be based on a technical indicator type and default
  16521. * params.
  16522. */
  16523. name?: string;
  16524. /**
  16525. * (Highstock) The color for the parts of the graph or points that are below
  16526. * the threshold. Note that `zones` takes precedence over the negative
  16527. * color. Using `negativeColor` is equivalent to applying a zone with value
  16528. * of 0.
  16529. */
  16530. negativeColor?: (ColorString|GradientColorObject|PatternObject);
  16531. /**
  16532. * (Highstock) Opacity of a series parts: line, fill (e.g. area) and
  16533. * dataLabels.
  16534. */
  16535. opacity?: number;
  16536. /**
  16537. * (Highstock) Paramters used in calculation of regression series' points.
  16538. */
  16539. params?: PlotAbandsParamsOptions;
  16540. /**
  16541. * (Highstock) Properties for each single point.
  16542. */
  16543. point?: PlotSeriesPointOptions;
  16544. /**
  16545. * (Highstock) Same as accessibility.pointDescriptionFormatter, but for an
  16546. * individual series. Overrides the chart wide configuration.
  16547. */
  16548. pointDescriptionFormatter?: Function;
  16549. /**
  16550. * (Highstock) Whether to select the series initially. If `showCheckbox` is
  16551. * true, the checkbox next to the series name in the legend will be checked
  16552. * for a selected series.
  16553. */
  16554. selected?: boolean;
  16555. /**
  16556. * (Highstock) Whether to apply a drop shadow to the graph line. Since 2.3
  16557. * the shadow can be an object configuration containing `color`, `offsetX`,
  16558. * `offsetY`, `opacity` and `width`.
  16559. */
  16560. shadow?: (boolean|ShadowOptionsObject);
  16561. /**
  16562. * (Highstock) If true, a checkbox is displayed next to the legend item to
  16563. * allow selecting the series. The state of the checkbox is determined by
  16564. * the `selected` option.
  16565. */
  16566. showCheckbox?: boolean;
  16567. /**
  16568. * (Highstock) Whether to display this particular series or series type in
  16569. * the legend. Standalone series are shown in legend by default, and linked
  16570. * series are not. Since v7.2.0 it is possible to show series that use
  16571. * colorAxis by setting this option to `true`.
  16572. */
  16573. showInLegend?: boolean;
  16574. /**
  16575. * (Highstock) If set to `true`, the accessibility module will skip past the
  16576. * points in this series for keyboard navigation.
  16577. */
  16578. skipKeyboardNavigation?: boolean;
  16579. /**
  16580. * (Highcharts, Highstock) When this is true, the series will not cause the
  16581. * Y axis to cross the zero plane (or threshold option) unless the data
  16582. * actually crosses the plane.
  16583. *
  16584. * For example, if `softThreshold` is `false`, a series of 0, 1, 2, 3 will
  16585. * make the Y axis show negative values according to the `minPadding`
  16586. * option. If `softThreshold` is `true`, the Y axis starts at 0.
  16587. */
  16588. softThreshold?: boolean;
  16589. states?: SeriesStatesOptionsObject;
  16590. /**
  16591. * (Highcharts, Highstock) Whether to apply steps to the line. Possible
  16592. * values are `left`, `center` and `right`.
  16593. */
  16594. step?: OptionsStepValue;
  16595. /**
  16596. * (Highstock) Sticky tracking of mouse events. When true, the `mouseOut`
  16597. * event on a series isn't triggered until the mouse moves over another
  16598. * series, or out of the plot area. When false, the `mouseOut` event on a
  16599. * series is triggered when the mouse leaves the area around the series'
  16600. * graph or markers. This also implies the tooltip when not shared. When
  16601. * `stickyTracking` is false and `tooltip.shared` is false, the tooltip will
  16602. * be hidden when moving the mouse between series. Defaults to true for line
  16603. * and area type series, but to false for columns, pies etc.
  16604. *
  16605. * **Note:** The boost module will force this option because of technical
  16606. * limitations.
  16607. */
  16608. stickyTracking?: boolean;
  16609. /**
  16610. * (Highcharts, Highstock) The threshold, also called zero level or base
  16611. * level. For line type series this is only used in conjunction with
  16612. * negativeColor.
  16613. */
  16614. threshold?: (number|null);
  16615. /**
  16616. * (Highstock) A configuration object for the tooltip rendering of each
  16617. * single series. Properties are inherited from tooltip, but only the
  16618. * following properties can be defined on a series level.
  16619. */
  16620. tooltip?: SeriesTooltipOptionsObject;
  16621. topLine?: PlotAbandsTopLineOptions;
  16622. /**
  16623. * (Highcharts, Highstock, Gantt) When a series contains a data array that
  16624. * is longer than this, only one dimensional arrays of numbers, or two
  16625. * dimensional arrays with x and y values are allowed. Also, only the first
  16626. * point is tested, and the rest are assumed to be the same format. This
  16627. * saves expensive data checking and indexing in long series. Set it to `0`
  16628. * disable.
  16629. *
  16630. * Note: In boost mode turbo threshold is forced. Only array of numbers or
  16631. * two dimensional arrays are allowed.
  16632. */
  16633. turboThreshold?: number;
  16634. /**
  16635. * (Highstock) Set the initial visibility of the series.
  16636. */
  16637. visible?: boolean;
  16638. /**
  16639. * (Highmaps) Define the z index of the series.
  16640. */
  16641. zIndex?: number;
  16642. /**
  16643. * (Highcharts, Highstock) Defines the Axis on which the zones are applied.
  16644. */
  16645. zoneAxis?: string;
  16646. /**
  16647. * (Highcharts, Highstock) An array defining zones within a series. Zones
  16648. * can be applied to the X axis, Y axis or Z axis for bubbles, according to
  16649. * the `zoneAxis` option. The zone definitions have to be in ascending order
  16650. * regarding to the value.
  16651. *
  16652. * In styled mode, the color zones are styled with the
  16653. * `.highcharts-zone-{n}` class, or custom classed from the `className`
  16654. * option (view live demo).
  16655. */
  16656. zones?: Array<SeriesZonesOptionsObject>;
  16657. }
  16658. /**
  16659. * (Highstock) Paramters used in calculation of regression series' points.
  16660. */
  16661. export interface PlotAbandsParamsOptions {
  16662. /**
  16663. * (Highstock) The algorithms factor value used to calculate bands.
  16664. */
  16665. factor?: number;
  16666. /**
  16667. * (Highstock) The point index which indicator calculations will base. For
  16668. * example using OHLC data, index=2 means the indicator will be calculated
  16669. * using Low values.
  16670. */
  16671. index?: number;
  16672. /**
  16673. * (Highstock) The base period for indicator calculations. This is the
  16674. * number of data points which are taken into account for the indicator
  16675. * calculations.
  16676. */
  16677. period?: number;
  16678. }
  16679. export interface PlotAbandsTopLineOptions {
  16680. styles?: PlotAbandsTopLineStylesOptions;
  16681. }
  16682. export interface PlotAbandsTopLineStylesOptions {
  16683. /**
  16684. * (Highstock) Pixel width of the line.
  16685. */
  16686. lineWidth?: number;
  16687. }
  16688. /**
  16689. * (Highstock) Enable or disable the initial animation when a series is
  16690. * displayed. The animation can also be set as a configuration object. Please
  16691. * note that this option only applies to the initial animation of the series
  16692. * itself. For other animations, see chart.animation and the animation parameter
  16693. * under the API methods. The following properties are supported:
  16694. *
  16695. * - `defer`: The animation delay time in milliseconds.
  16696. *
  16697. * - `duration`: The duration of the animation in milliseconds.
  16698. *
  16699. * - `easing`: Can be a string reference to an easing function set on the `Math`
  16700. * object or a function. See the _Custom easing function_ demo below.
  16701. *
  16702. * Due to poor performance, animation is disabled in old IE browsers for several
  16703. * chart types.
  16704. */
  16705. export interface PlotAdAnimationOptions {
  16706. defer?: number;
  16707. }
  16708. /**
  16709. * (Highcharts, Highstock, Highmaps, Gantt) Enable or disable the initial
  16710. * animation when a series is displayed for the `dataLabels`. The animation can
  16711. * also be set as a configuration object. Please note that this option only
  16712. * applies to the initial animation. For other animations, see chart.animation
  16713. * and the animation parameter under the API methods. The following properties
  16714. * are supported:
  16715. *
  16716. * - `defer`: The animation delay time in milliseconds.
  16717. */
  16718. export interface PlotAdDataLabelsAnimationOptions {
  16719. /**
  16720. * (Highcharts, Highstock, Highmaps, Gantt) The animation delay time in
  16721. * milliseconds. Set to `0` renders dataLabel immediately. As `undefined`
  16722. * inherits defer time from the series.animation.defer.
  16723. */
  16724. defer?: number;
  16725. }
  16726. /**
  16727. * (Highcharts, Highstock, Highmaps, Gantt) Options for the series data labels,
  16728. * appearing next to each data point.
  16729. *
  16730. * Since v6.2.0, multiple data labels can be applied to each single point by
  16731. * defining them as an array of configs.
  16732. *
  16733. * In styled mode, the data labels can be styled with the
  16734. * `.highcharts-data-label-box` and `.highcharts-data-label` class names (see
  16735. * example).
  16736. */
  16737. export interface PlotAdDataLabelsOptions {
  16738. /**
  16739. * (Highcharts, Highstock, Highmaps, Gantt) The alignment of the data label
  16740. * compared to the point. If `right`, the right side of the label should be
  16741. * touching the point. For points with an extent, like columns, the
  16742. * alignments also dictates how to align it inside the box, as given with
  16743. * the inside option. Can be one of `left`, `center` or `right`.
  16744. */
  16745. align?: (AlignValue|null);
  16746. /**
  16747. * (Highcharts, Highstock, Highmaps, Gantt) Whether to allow data labels to
  16748. * overlap. To make the labels less sensitive for overlapping, the
  16749. * dataLabels.padding can be set to 0.
  16750. */
  16751. allowOverlap?: boolean;
  16752. /**
  16753. * (Highcharts, Highstock, Highmaps, Gantt) Enable or disable the initial
  16754. * animation when a series is displayed for the `dataLabels`. The animation
  16755. * can also be set as a configuration object. Please note that this option
  16756. * only applies to the initial animation. For other animations, see
  16757. * chart.animation and the animation parameter under the API methods. The
  16758. * following properties are supported:
  16759. *
  16760. * - `defer`: The animation delay time in milliseconds.
  16761. */
  16762. animation?: (boolean|PlotAdDataLabelsAnimationOptions|Partial<AnimationOptionsObject>);
  16763. /**
  16764. * (Highcharts, Highstock, Highmaps, Gantt) The background color or gradient
  16765. * for the data label.
  16766. */
  16767. backgroundColor?: (ColorString|GradientColorObject|PatternObject);
  16768. /**
  16769. * (Highcharts, Highstock, Highmaps, Gantt) The border color for the data
  16770. * label. Defaults to `undefined`.
  16771. */
  16772. borderColor?: (ColorString|GradientColorObject|PatternObject);
  16773. /**
  16774. * (Highcharts, Highstock, Highmaps, Gantt) The border radius in pixels for
  16775. * the data label.
  16776. */
  16777. borderRadius?: number;
  16778. /**
  16779. * (Highcharts, Highstock, Highmaps, Gantt) The border width in pixels for
  16780. * the data label.
  16781. */
  16782. borderWidth?: number;
  16783. /**
  16784. * (Highcharts, Highstock, Highmaps, Gantt) A class name for the data label.
  16785. * Particularly in styled mode, this can be used to give each series' or
  16786. * point's data label unique styling. In addition to this option, a default
  16787. * color class name is added so that we can give the labels a contrast text
  16788. * shadow.
  16789. */
  16790. className?: string;
  16791. /**
  16792. * (Highcharts, Highstock, Highmaps, Gantt) The text color for the data
  16793. * labels. Defaults to `undefined`. For certain series types, like column or
  16794. * map, the data labels can be drawn inside the points. In this case the
  16795. * data label will be drawn with maximum contrast by default. Additionally,
  16796. * it will be given a `text-outline` style with the opposite color, to
  16797. * further increase the contrast. This can be overridden by setting the
  16798. * `text-outline` style to `none` in the `dataLabels.style` option.
  16799. */
  16800. color?: (ColorString|GradientColorObject|PatternObject);
  16801. /**
  16802. * (Highcharts, Highstock, Highmaps, Gantt) Whether to hide data labels that
  16803. * are outside the plot area. By default, the data label is moved inside the
  16804. * plot area according to the overflow option.
  16805. */
  16806. crop?: boolean;
  16807. /**
  16808. * (Highcharts, Highstock, Gantt) Whether to defer displaying the data
  16809. * labels until the initial series animation has finished. Setting to
  16810. * `false` renders the data label immediately. If set to `true` inherits the
  16811. * defer time set in plotOptions.series.animation.
  16812. */
  16813. defer?: boolean;
  16814. /**
  16815. * (Highcharts, Highstock, Highmaps, Gantt) Enable or disable the data
  16816. * labels.
  16817. */
  16818. enabled?: boolean;
  16819. /**
  16820. * (Highcharts, Highstock, Highmaps, Gantt) A declarative filter to control
  16821. * of which data labels to display. The declarative filter is designed for
  16822. * use when callback functions are not available, like when the chart
  16823. * options require a pure JSON structure or for use with graphical editors.
  16824. * For programmatic control, use the `formatter` instead, and return
  16825. * `undefined` to disable a single data label.
  16826. */
  16827. filter?: DataLabelsFilterOptionsObject;
  16828. /**
  16829. * (Highcharts, Highstock, Highmaps, Gantt) A format string for the data
  16830. * label. Available variables are the same as for `formatter`.
  16831. */
  16832. format?: string;
  16833. /**
  16834. * (Highcharts, Highstock, Highmaps, Gantt) Callback JavaScript function to
  16835. * format the data label. Note that if a `format` is defined, the format
  16836. * takes precedence and the formatter is ignored.
  16837. */
  16838. formatter?: DataLabelsFormatterCallbackFunction;
  16839. /**
  16840. * (Highcharts, Highstock, Highmaps, Gantt) For points with an extent, like
  16841. * columns or map areas, whether to align the data label inside the box or
  16842. * to the actual value point. Defaults to `false` in most cases, `true` in
  16843. * stacked columns.
  16844. */
  16845. inside?: boolean;
  16846. /**
  16847. * (Highcharts, Highstock, Highmaps, Gantt) Format for points with the value
  16848. * of null. Works analogously to format. `nullFormat` can be applied only to
  16849. * series which support displaying null points.
  16850. */
  16851. nullFormat?: (boolean|string);
  16852. /**
  16853. * (Highcharts, Highstock, Highmaps, Gantt) Callback JavaScript function
  16854. * that defines formatting for points with the value of null. Works
  16855. * analogously to formatter. `nullPointFormatter` can be applied only to
  16856. * series which support displaying null points.
  16857. */
  16858. nullFormatter?: DataLabelsFormatterCallbackFunction;
  16859. /**
  16860. * (Highcharts, Highstock, Highmaps, Gantt) How to handle data labels that
  16861. * flow outside the plot area. The default is `"justify"`, which aligns them
  16862. * inside the plot area. For columns and bars, this means it will be moved
  16863. * inside the bar. To display data labels outside the plot area, set `crop`
  16864. * to `false` and `overflow` to `"allow"`.
  16865. */
  16866. overflow?: DataLabelsOverflowValue;
  16867. /**
  16868. * (Highcharts, Highstock, Highmaps, Gantt) When either the `borderWidth` or
  16869. * the `backgroundColor` is set, this is the padding within the box.
  16870. */
  16871. padding?: number;
  16872. /**
  16873. * (Highcharts, Highstock, Highmaps, Gantt) Aligns data labels relative to
  16874. * points. If `center` alignment is not possible, it defaults to `right`.
  16875. */
  16876. position?: AlignValue;
  16877. /**
  16878. * (Highcharts, Highstock, Highmaps, Gantt) Text rotation in degrees. Note
  16879. * that due to a more complex structure, backgrounds, borders and padding
  16880. * will be lost on a rotated data label.
  16881. */
  16882. rotation?: number;
  16883. /**
  16884. * (Highcharts, Highstock, Highmaps, Gantt) The shadow of the box. Works
  16885. * best with `borderWidth` or `backgroundColor`. Since 2.3 the shadow can be
  16886. * an object configuration containing `color`, `offsetX`, `offsetY`,
  16887. * `opacity` and `width`.
  16888. */
  16889. shadow?: (boolean|ShadowOptionsObject);
  16890. /**
  16891. * (Highcharts, Highstock, Highmaps, Gantt) The name of a symbol to use for
  16892. * the border around the label. Symbols are predefined functions on the
  16893. * Renderer object.
  16894. */
  16895. shape?: string;
  16896. /**
  16897. * (Highcharts, Highstock, Highmaps, Gantt) Styles for the label. The
  16898. * default `color` setting is `"contrast"`, which is a pseudo color that
  16899. * Highcharts picks up and applies the maximum contrast to the underlying
  16900. * point item, for example the bar in a bar chart.
  16901. *
  16902. * The `textOutline` is a pseudo property that applies an outline of the
  16903. * given width with the given color, which by default is the maximum
  16904. * contrast to the text. So a bright text color will result in a black text
  16905. * outline for maximum readability on a mixed background. In some cases,
  16906. * especially with grayscale text, the text outline doesn't work well, in
  16907. * which cases it can be disabled by setting it to `"none"`. When `useHTML`
  16908. * is true, the `textOutline` will not be picked up. In this, case, the same
  16909. * effect can be acheived through the `text-shadow` CSS property.
  16910. *
  16911. * For some series types, where each point has an extent, like for example
  16912. * tree maps, the data label may overflow the point. There are two
  16913. * strategies for handling overflow. By default, the text will wrap to
  16914. * multiple lines. The other strategy is to set `style.textOverflow` to
  16915. * `ellipsis`, which will keep the text on one line plus it will break
  16916. * inside long words.
  16917. */
  16918. style?: CSSObject;
  16919. /**
  16920. * (Highcharts, Highstock, Highmaps, Gantt) Options for a label text which
  16921. * should follow marker's shape. Border and background are disabled for a
  16922. * label that follows a path.
  16923. *
  16924. * **Note:** Only SVG-based renderer supports this option. Setting `useHTML`
  16925. * to true will disable this option.
  16926. */
  16927. textPath?: DataLabelsTextPathOptionsObject;
  16928. /**
  16929. * (Highcharts, Highstock, Highmaps, Gantt) Whether to use HTML to render
  16930. * the labels.
  16931. */
  16932. useHTML?: boolean;
  16933. /**
  16934. * (Highcharts, Highstock, Highmaps, Gantt) The vertical alignment of a data
  16935. * label. Can be one of `top`, `middle` or `bottom`. The default value
  16936. * depends on the data, for instance in a column chart, the label is above
  16937. * positive values and below negative values.
  16938. */
  16939. verticalAlign?: (VerticalAlignValue|null);
  16940. /**
  16941. * (Highcharts, Highstock, Highmaps, Gantt) The x position offset of the
  16942. * label relative to the point in pixels.
  16943. */
  16944. x?: number;
  16945. /**
  16946. * (Highcharts, Highstock, Highmaps, Gantt) The y position offset of the
  16947. * label relative to the point in pixels.
  16948. */
  16949. y?: number;
  16950. /**
  16951. * (Highcharts, Highstock, Highmaps, Gantt) The Z index of the data labels.
  16952. * The default Z index puts it above the series. Use a Z index of 2 to
  16953. * display it behind the series.
  16954. */
  16955. z?: number;
  16956. }
  16957. /**
  16958. * (Highcharts, Highstock) Options for the series data sorting.
  16959. */
  16960. export interface PlotAdDataSortingOptions {
  16961. /**
  16962. * (Highcharts, Highstock) Enable or disable data sorting for the series.
  16963. * Use xAxis.reversed to change the sorting order.
  16964. */
  16965. enabled?: boolean;
  16966. /**
  16967. * (Highcharts, Highstock) Whether to allow matching points by name in an
  16968. * update. If this option is disabled, points will be matched by order.
  16969. */
  16970. matchByName?: boolean;
  16971. /**
  16972. * (Highcharts, Highstock) Determines what data value should be used to sort
  16973. * by.
  16974. */
  16975. sortKey?: string;
  16976. }
  16977. /**
  16978. * (Highstock) Accumulation Distribution (AD). This series requires `linkedTo`
  16979. * option to be set.
  16980. *
  16981. * In TypeScript the type option must always be set.
  16982. *
  16983. * Configuration options for the series are given in three levels:
  16984. *
  16985. * 1. Options for all series in a chart are defined in the plotOptions.series
  16986. * object.
  16987. *
  16988. * 2. Options for all `ad` series are defined in plotOptions.ad.
  16989. *
  16990. * 3. Options for one single series are given in the series instance array. (see
  16991. * online documentation for example)
  16992. */
  16993. export interface PlotAdOptions {
  16994. /**
  16995. * (Highstock) Accessibility options for a series.
  16996. */
  16997. accessibility?: SeriesAccessibilityOptionsObject;
  16998. /**
  16999. * (Highstock) Allow this series' points to be selected by clicking on the
  17000. * graphic (columns, point markers, pie slices, map areas etc).
  17001. *
  17002. * The selected points can be handled by point select and unselect events,
  17003. * or collectively by the getSelectedPoints function.
  17004. *
  17005. * And alternative way of selecting points is through dragging.
  17006. */
  17007. allowPointSelect?: boolean;
  17008. /**
  17009. * (Highstock) Enable or disable the initial animation when a series is
  17010. * displayed. The animation can also be set as a configuration object.
  17011. * Please note that this option only applies to the initial animation of the
  17012. * series itself. For other animations, see chart.animation and the
  17013. * animation parameter under the API methods. The following properties are
  17014. * supported:
  17015. *
  17016. * - `defer`: The animation delay time in milliseconds.
  17017. *
  17018. * - `duration`: The duration of the animation in milliseconds.
  17019. *
  17020. * - `easing`: Can be a string reference to an easing function set on the
  17021. * `Math` object or a function. See the _Custom easing function_ demo below.
  17022. *
  17023. * Due to poor performance, animation is disabled in old IE browsers for
  17024. * several chart types.
  17025. */
  17026. animation?: (boolean|PlotAdAnimationOptions|Partial<AnimationOptionsObject>);
  17027. /**
  17028. * (Highstock) For some series, there is a limit that shuts down initial
  17029. * animation by default when the total number of points in the chart is too
  17030. * high. For example, for a column chart and its derivatives, animation does
  17031. * not run if there is more than 250 points totally. To disable this cap,
  17032. * set `animationLimit` to `Infinity`.
  17033. */
  17034. animationLimit?: number;
  17035. /**
  17036. * (Highstock) Sets the color blending in the boost module.
  17037. */
  17038. boostBlending?: OptionsBoostBlendingValue;
  17039. /**
  17040. * (Highstock) Set the point threshold for when a series should enter boost
  17041. * mode.
  17042. *
  17043. * Setting it to e.g. 2000 will cause the series to enter boost mode when
  17044. * there are 2000 or more points in the series.
  17045. *
  17046. * To disable boosting on the series, set the `boostThreshold` to 0. Setting
  17047. * it to 1 will force boosting.
  17048. *
  17049. * Note that the cropThreshold also affects this setting. When zooming in on
  17050. * a series that has fewer points than the `cropThreshold`, all points are
  17051. * rendered although outside the visible plot area, and the `boostThreshold`
  17052. * won't take effect.
  17053. */
  17054. boostThreshold?: number;
  17055. /**
  17056. * (Highmaps) The border color of the map areas.
  17057. *
  17058. * In styled mode, the border stroke is given in the `.highcharts-point`
  17059. * class.
  17060. */
  17061. borderColor?: (ColorString|GradientColorObject|PatternObject);
  17062. /**
  17063. * (Highmaps) The border width of each map area.
  17064. *
  17065. * In styled mode, the border stroke width is given in the
  17066. * `.highcharts-point` class.
  17067. */
  17068. borderWidth?: number;
  17069. /**
  17070. * (Highstock) An additional class name to apply to the series' graphical
  17071. * elements. This option does not replace default class names of the
  17072. * graphical element.
  17073. */
  17074. className?: string;
  17075. /**
  17076. * (Highstock) Disable this option to allow series rendering in the whole
  17077. * plotting area.
  17078. *
  17079. * **Note:** Clipping should be always enabled when chart.zoomType is set
  17080. */
  17081. clip?: boolean;
  17082. /**
  17083. * (Highstock) The main color of the series. In line type series it applies
  17084. * to the line and the point markers unless otherwise specified. In bar type
  17085. * series it applies to the bars unless a color is specified per point. The
  17086. * default value is pulled from the `options.colors` array.
  17087. *
  17088. * In styled mode, the color can be defined by the colorIndex option. Also,
  17089. * the series color can be set with the `.highcharts-series`,
  17090. * `.highcharts-color-{n}`, `.highcharts-{type}-series` or
  17091. * `.highcharts-series-{n}` class, or individual classes given by the
  17092. * `className` option.
  17093. */
  17094. color?: (ColorString|GradientColorObject|PatternObject);
  17095. /**
  17096. * (Highstock) Styled mode only. A specific color index to use for the
  17097. * series, so its graphic representations are given the class name
  17098. * `highcharts-color-{n}`.
  17099. */
  17100. colorIndex?: number;
  17101. /**
  17102. * (Highcharts, Highstock, Highmaps) Determines what data value should be
  17103. * used to calculate point color if `colorAxis` is used. Requires to set
  17104. * `min` and `max` if some custom point property is used or if approximation
  17105. * for data grouping is set to `'sum'`.
  17106. */
  17107. colorKey?: string;
  17108. /**
  17109. * (Highstock) Compare the values of the series against the first non-null,
  17110. * non- zero value in the visible range. The y axis will show percentage or
  17111. * absolute change depending on whether `compare` is set to `"percent"` or
  17112. * `"value"`. When this is applied to multiple series, it allows comparing
  17113. * the development of the series against each other. Adds a `change` field
  17114. * to every point object.
  17115. */
  17116. compare?: string;
  17117. /**
  17118. * (Highstock) When compare is `percent`, this option dictates whether to
  17119. * use 0 or 100 as the base of comparison.
  17120. */
  17121. compareBase?: (0|100);
  17122. /**
  17123. * (Highstock) Defines if comparison should start from the first point
  17124. * within the visible range or should start from the first point **before**
  17125. * the range.
  17126. *
  17127. * In other words, this flag determines if first point within the visible
  17128. * range will have 0% (`compareStart=true`) or should have been already
  17129. * calculated according to the previous point (`compareStart=false`).
  17130. */
  17131. compareStart?: boolean;
  17132. /**
  17133. * (Highstock) Whether to compare indicator to the main series values or
  17134. * indicator values.
  17135. */
  17136. compareToMain?: boolean;
  17137. /**
  17138. * (Highcharts) Polar charts only. Whether to connect the ends of a line
  17139. * series plot across the extremes.
  17140. */
  17141. connectEnds?: boolean;
  17142. /**
  17143. * (Highcharts, Highstock) Whether to connect a graph line across null
  17144. * points, or render a gap between the two points on either side of the
  17145. * null.
  17146. */
  17147. connectNulls?: boolean;
  17148. /**
  17149. * (Gantt) Override Pathfinder connector options for a series. Requires
  17150. * Highcharts Gantt to be loaded.
  17151. */
  17152. connectors?: SeriesConnectorsOptionsObject;
  17153. /**
  17154. * (Highcharts, Highstock, Gantt) When true, each point or column edge is
  17155. * rounded to its nearest pixel in order to render sharp on screen. In some
  17156. * cases, when there are a lot of densely packed columns, this leads to
  17157. * visible difference in column widths or distance between columns. In these
  17158. * cases, setting `crisp` to `false` may look better, even though each
  17159. * column is rendered blurry.
  17160. */
  17161. crisp?: boolean;
  17162. /**
  17163. * (Highcharts, Highstock) When the series contains less points than the
  17164. * crop threshold, all points are drawn, even if the points fall outside the
  17165. * visible plot area at the current zoom. The advantage of drawing all
  17166. * points (including markers and columns), is that animation is performed on
  17167. * updates. On the other hand, when the series contains more points than the
  17168. * crop threshold, the series data is cropped to only contain points that
  17169. * fall within the plot area. The advantage of cropping away invisible
  17170. * points is to increase performance on large series.
  17171. */
  17172. cropThreshold?: number;
  17173. /**
  17174. * (Highstock) You can set the cursor to "pointer" if you have click events
  17175. * attached to the series, to signal to the user that the points and lines
  17176. * can be clicked.
  17177. *
  17178. * In styled mode, the series cursor can be set with the same classes as
  17179. * listed under series.color.
  17180. */
  17181. cursor?: (string|CursorValue);
  17182. /**
  17183. * (Highstock) A reserved subspace to store options and values for
  17184. * customized functionality. Here you can add additional data for your own
  17185. * event callbacks and formatter callbacks.
  17186. */
  17187. custom?: Dictionary<any>;
  17188. /**
  17189. * (Highstock) Name of the dash style to use for the graph, or for some
  17190. * series types the outline of each shape.
  17191. *
  17192. * In styled mode, the stroke dash-array can be set with the same classes as
  17193. * listed under series.color.
  17194. */
  17195. dashStyle?: DashStyleValue;
  17196. /**
  17197. * (Highstock) Data grouping is the concept of sampling the data values into
  17198. * larger blocks in order to ease readability and increase performance of
  17199. * the JavaScript charts. Highstock by default applies data grouping when
  17200. * the points become closer than a certain pixel value, determined by the
  17201. * `groupPixelWidth` option.
  17202. *
  17203. * If data grouping is applied, the grouping information of grouped points
  17204. * can be read from the Point.dataGroup. If point options other than the
  17205. * data itself are set, for example `name` or `color` or custom properties,
  17206. * the grouping logic doesn't know how to group it. In this case the options
  17207. * of the first point instance are copied over to the group point. This can
  17208. * be altered through a custom `approximation` callback function.
  17209. */
  17210. dataGrouping?: DataGroupingOptionsObject;
  17211. /**
  17212. * (Highcharts, Highstock, Highmaps, Gantt) Options for the series data
  17213. * labels, appearing next to each data point.
  17214. *
  17215. * Since v6.2.0, multiple data labels can be applied to each single point by
  17216. * defining them as an array of configs.
  17217. *
  17218. * In styled mode, the data labels can be styled with the
  17219. * `.highcharts-data-label-box` and `.highcharts-data-label` class names
  17220. * (see example).
  17221. */
  17222. dataLabels?: (PlotAdDataLabelsOptions|Array<PlotAdDataLabelsOptions>);
  17223. /**
  17224. * (Highcharts, Highstock) Options for the series data sorting.
  17225. */
  17226. dataSorting?: (DataSortingOptionsObject|PlotAdDataSortingOptions);
  17227. /**
  17228. * (Highstock) A description of the series to add to the screen reader
  17229. * information about the series.
  17230. */
  17231. description?: string;
  17232. /**
  17233. * (Highstock) Enable or disable the mouse tracking for a specific series.
  17234. * This includes point tooltips and click events on graphs and points. For
  17235. * large datasets it improves performance.
  17236. */
  17237. enableMouseTracking?: boolean;
  17238. /**
  17239. * (Highstock) General event handlers for the series items. These event
  17240. * hooks can also be attached to the series at run time using the
  17241. * `Highcharts.addEvent` function.
  17242. */
  17243. events?: SeriesEventsOptionsObject;
  17244. /**
  17245. * (Highstock) Determines whether the series should look for the nearest
  17246. * point in both dimensions or just the x-dimension when hovering the
  17247. * series. Defaults to `'xy'` for scatter series and `'x'` for most other
  17248. * series. If the data has duplicate x-values, it is recommended to set this
  17249. * to `'xy'` to allow hovering over all points.
  17250. *
  17251. * Applies only to series types using nearest neighbor search (not direct
  17252. * hover) for tooltip.
  17253. */
  17254. findNearestPointBy?: OptionsFindNearestPointByValue;
  17255. /**
  17256. * (Highstock) Defines when to display a gap in the graph, together with the
  17257. * gapUnit option.
  17258. *
  17259. * In case when `dataGrouping` is enabled, points can be grouped into a
  17260. * larger time span. This can make the grouped points to have a greater
  17261. * distance than the absolute value of `gapSize` property, which will result
  17262. * in disappearing graph completely. To prevent this situation the mentioned
  17263. * distance between grouped points is used instead of previously defined
  17264. * `gapSize`.
  17265. *
  17266. * In practice, this option is most often used to visualize gaps in time
  17267. * series. In a stock chart, intraday data is available for daytime hours,
  17268. * while gaps will appear in nights and weekends.
  17269. */
  17270. gapSize?: number;
  17271. /**
  17272. * (Highstock) Together with gapSize, this option defines where to draw gaps
  17273. * in the graph.
  17274. *
  17275. * When the `gapUnit` is `"relative"` (default), a gap size of 5 means that
  17276. * if the distance between two points is greater than 5 times that of the
  17277. * two closest points, the graph will be broken.
  17278. *
  17279. * When the `gapUnit` is `"value"`, the gap is based on absolute axis
  17280. * values, which on a datetime axis is milliseconds. This also applies to
  17281. * the navigator series that inherits gap options from the base series.
  17282. */
  17283. gapUnit?: OptionsGapUnitValue;
  17284. /**
  17285. * (Highcharts, Highstock, Gantt) Whether to use the Y extremes of the total
  17286. * chart width or only the zoomed area when zooming in on parts of the X
  17287. * axis. By default, the Y axis adjusts to the min and max of the visible
  17288. * data. Cartesian series only.
  17289. */
  17290. getExtremesFromAll?: boolean;
  17291. /**
  17292. * (Highstock) When set to `false` will prevent the series data from being
  17293. * included in any form of data export.
  17294. *
  17295. * Since version 6.0.0 until 7.1.0 the option was existing undocumented as
  17296. * `includeInCSVExport`.
  17297. */
  17298. includeInDataExport?: boolean;
  17299. /**
  17300. * (Highcharts, Highstock, Gantt) Series labels are placed as close to the
  17301. * series as possible in a natural way, seeking to avoid other series. The
  17302. * goal of this feature is to make the chart more easily readable, like if a
  17303. * human designer placed the labels in the optimal position.
  17304. *
  17305. * The series labels currently work with series types having a `graph` or an
  17306. * `area`.
  17307. */
  17308. label?: SeriesLabelOptionsObject;
  17309. /**
  17310. * (Highstock) The line marks the last price from all points.
  17311. */
  17312. lastPrice?: SeriesLastPriceOptionsObject;
  17313. /**
  17314. * (Highstock) The line marks the last price from visible range of points.
  17315. */
  17316. lastVisiblePrice?: SeriesLastVisiblePriceOptionsObject;
  17317. /**
  17318. * (Highcharts, Highstock) The SVG value used for the `stroke-linecap` and
  17319. * `stroke-linejoin` of a line graph. Round means that lines are rounded in
  17320. * the ends and bends.
  17321. */
  17322. linecap?: SeriesLinecapValue;
  17323. /**
  17324. * (Highcharts, Highstock) Pixel width of the graph line.
  17325. */
  17326. lineWidth?: number;
  17327. /**
  17328. * (Highcharts, Highstock, Gantt) The main series ID that indicator will be
  17329. * based on. Required for this indicator.
  17330. */
  17331. linkedTo?: string;
  17332. /**
  17333. * (Highstock) Options for the point markers of line-like series. Properties
  17334. * like `fillColor`, `lineColor` and `lineWidth` define the visual
  17335. * appearance of the markers. Other series types, like column series, don't
  17336. * have markers, but have visual options on the series level instead.
  17337. *
  17338. * In styled mode, the markers can be styled with the `.highcharts-point`,
  17339. * `.highcharts-point-hover` and `.highcharts-point-select` class names.
  17340. */
  17341. marker?: PointMarkerOptionsObject;
  17342. /**
  17343. * (Highstock) The name of the series as shown in the legend, tooltip etc.
  17344. * If not set, it will be based on a technical indicator type and default
  17345. * params.
  17346. */
  17347. name?: string;
  17348. /**
  17349. * (Highstock) The color for the parts of the graph or points that are below
  17350. * the threshold. Note that `zones` takes precedence over the negative
  17351. * color. Using `negativeColor` is equivalent to applying a zone with value
  17352. * of 0.
  17353. */
  17354. negativeColor?: (ColorString|GradientColorObject|PatternObject);
  17355. /**
  17356. * (Highstock) Opacity of a series parts: line, fill (e.g. area) and
  17357. * dataLabels.
  17358. */
  17359. opacity?: number;
  17360. /**
  17361. * (Highstock) Paramters used in calculation of regression series' points.
  17362. */
  17363. params?: PlotAdParamsOptions;
  17364. /**
  17365. * (Highstock) Properties for each single point.
  17366. */
  17367. point?: PlotSeriesPointOptions;
  17368. /**
  17369. * (Highstock) Same as accessibility.pointDescriptionFormatter, but for an
  17370. * individual series. Overrides the chart wide configuration.
  17371. */
  17372. pointDescriptionFormatter?: Function;
  17373. /**
  17374. * (Highstock) Whether to select the series initially. If `showCheckbox` is
  17375. * true, the checkbox next to the series name in the legend will be checked
  17376. * for a selected series.
  17377. */
  17378. selected?: boolean;
  17379. /**
  17380. * (Highstock) Whether to apply a drop shadow to the graph line. Since 2.3
  17381. * the shadow can be an object configuration containing `color`, `offsetX`,
  17382. * `offsetY`, `opacity` and `width`.
  17383. */
  17384. shadow?: (boolean|ShadowOptionsObject);
  17385. /**
  17386. * (Highstock) If true, a checkbox is displayed next to the legend item to
  17387. * allow selecting the series. The state of the checkbox is determined by
  17388. * the `selected` option.
  17389. */
  17390. showCheckbox?: boolean;
  17391. /**
  17392. * (Highstock) Whether to display this particular series or series type in
  17393. * the legend. Standalone series are shown in legend by default, and linked
  17394. * series are not. Since v7.2.0 it is possible to show series that use
  17395. * colorAxis by setting this option to `true`.
  17396. */
  17397. showInLegend?: boolean;
  17398. /**
  17399. * (Highstock) If set to `true`, the accessibility module will skip past the
  17400. * points in this series for keyboard navigation.
  17401. */
  17402. skipKeyboardNavigation?: boolean;
  17403. /**
  17404. * (Highcharts, Highstock) When this is true, the series will not cause the
  17405. * Y axis to cross the zero plane (or threshold option) unless the data
  17406. * actually crosses the plane.
  17407. *
  17408. * For example, if `softThreshold` is `false`, a series of 0, 1, 2, 3 will
  17409. * make the Y axis show negative values according to the `minPadding`
  17410. * option. If `softThreshold` is `true`, the Y axis starts at 0.
  17411. */
  17412. softThreshold?: boolean;
  17413. states?: SeriesStatesOptionsObject;
  17414. /**
  17415. * (Highcharts, Highstock) Whether to apply steps to the line. Possible
  17416. * values are `left`, `center` and `right`.
  17417. */
  17418. step?: OptionsStepValue;
  17419. /**
  17420. * (Highstock) Sticky tracking of mouse events. When true, the `mouseOut`
  17421. * event on a series isn't triggered until the mouse moves over another
  17422. * series, or out of the plot area. When false, the `mouseOut` event on a
  17423. * series is triggered when the mouse leaves the area around the series'
  17424. * graph or markers. This also implies the tooltip when not shared. When
  17425. * `stickyTracking` is false and `tooltip.shared` is false, the tooltip will
  17426. * be hidden when moving the mouse between series. Defaults to true for line
  17427. * and area type series, but to false for columns, pies etc.
  17428. *
  17429. * **Note:** The boost module will force this option because of technical
  17430. * limitations.
  17431. */
  17432. stickyTracking?: boolean;
  17433. /**
  17434. * (Highcharts, Highstock) The threshold, also called zero level or base
  17435. * level. For line type series this is only used in conjunction with
  17436. * negativeColor.
  17437. */
  17438. threshold?: (number|null);
  17439. /**
  17440. * (Highstock) A configuration object for the tooltip rendering of each
  17441. * single series. Properties are inherited from tooltip, but only the
  17442. * following properties can be defined on a series level.
  17443. */
  17444. tooltip?: SeriesTooltipOptionsObject;
  17445. /**
  17446. * (Highcharts, Highstock, Gantt) When a series contains a data array that
  17447. * is longer than this, only one dimensional arrays of numbers, or two
  17448. * dimensional arrays with x and y values are allowed. Also, only the first
  17449. * point is tested, and the rest are assumed to be the same format. This
  17450. * saves expensive data checking and indexing in long series. Set it to `0`
  17451. * disable.
  17452. *
  17453. * Note: In boost mode turbo threshold is forced. Only array of numbers or
  17454. * two dimensional arrays are allowed.
  17455. */
  17456. turboThreshold?: number;
  17457. /**
  17458. * (Highstock) Set the initial visibility of the series.
  17459. */
  17460. visible?: boolean;
  17461. /**
  17462. * (Highmaps) Define the z index of the series.
  17463. */
  17464. zIndex?: number;
  17465. /**
  17466. * (Highcharts, Highstock) Defines the Axis on which the zones are applied.
  17467. */
  17468. zoneAxis?: string;
  17469. /**
  17470. * (Highcharts, Highstock) An array defining zones within a series. Zones
  17471. * can be applied to the X axis, Y axis or Z axis for bubbles, according to
  17472. * the `zoneAxis` option. The zone definitions have to be in ascending order
  17473. * regarding to the value.
  17474. *
  17475. * In styled mode, the color zones are styled with the
  17476. * `.highcharts-zone-{n}` class, or custom classed from the `className`
  17477. * option (view live demo).
  17478. */
  17479. zones?: Array<SeriesZonesOptionsObject>;
  17480. }
  17481. /**
  17482. * (Highstock) Paramters used in calculation of regression series' points.
  17483. */
  17484. export interface PlotAdParamsOptions {
  17485. /**
  17486. * (Highstock) The point index which indicator calculations will base. For
  17487. * example using OHLC data, index=2 means the indicator will be calculated
  17488. * using Low values.
  17489. */
  17490. index?: number;
  17491. /**
  17492. * (Highstock) The base period for indicator calculations. This is the
  17493. * number of data points which are taken into account for the indicator
  17494. * calculations.
  17495. */
  17496. period?: number;
  17497. /**
  17498. * (Highstock) The id of volume series which is mandatory. For example using
  17499. * OHLC data, volumeSeriesID='volume' means the indicator will be calculated
  17500. * using OHLC and volume values.
  17501. */
  17502. volumeSeriesID?: string;
  17503. }
  17504. /**
  17505. * (Highstock) Enable or disable the initial animation when a series is
  17506. * displayed. The animation can also be set as a configuration object. Please
  17507. * note that this option only applies to the initial animation of the series
  17508. * itself. For other animations, see chart.animation and the animation parameter
  17509. * under the API methods. The following properties are supported:
  17510. *
  17511. * - `defer`: The animation delay time in milliseconds.
  17512. *
  17513. * - `duration`: The duration of the animation in milliseconds.
  17514. *
  17515. * - `easing`: Can be a string reference to an easing function set on the `Math`
  17516. * object or a function. See the _Custom easing function_ demo below.
  17517. *
  17518. * Due to poor performance, animation is disabled in old IE browsers for several
  17519. * chart types.
  17520. */
  17521. export interface PlotAoAnimationOptions {
  17522. defer?: number;
  17523. }
  17524. /**
  17525. * (Highcharts, Highstock, Highmaps, Gantt) Enable or disable the initial
  17526. * animation when a series is displayed for the `dataLabels`. The animation can
  17527. * also be set as a configuration object. Please note that this option only
  17528. * applies to the initial animation. For other animations, see chart.animation
  17529. * and the animation parameter under the API methods. The following properties
  17530. * are supported:
  17531. *
  17532. * - `defer`: The animation delay time in milliseconds.
  17533. */
  17534. export interface PlotAoDataLabelsAnimationOptions {
  17535. /**
  17536. * (Highcharts, Highstock, Highmaps, Gantt) The animation delay time in
  17537. * milliseconds. Set to `0` renders dataLabel immediately. As `undefined`
  17538. * inherits defer time from the series.animation.defer.
  17539. */
  17540. defer?: number;
  17541. }
  17542. /**
  17543. * (Highcharts, Highstock, Highmaps, Gantt) Options for the series data labels,
  17544. * appearing next to each data point.
  17545. *
  17546. * Since v6.2.0, multiple data labels can be applied to each single point by
  17547. * defining them as an array of configs.
  17548. *
  17549. * In styled mode, the data labels can be styled with the
  17550. * `.highcharts-data-label-box` and `.highcharts-data-label` class names (see
  17551. * example).
  17552. */
  17553. export interface PlotAoDataLabelsOptions {
  17554. /**
  17555. * (Highcharts, Highstock, Highmaps, Gantt) The alignment of the data label
  17556. * compared to the point. If `right`, the right side of the label should be
  17557. * touching the point. For points with an extent, like columns, the
  17558. * alignments also dictates how to align it inside the box, as given with
  17559. * the inside option. Can be one of `left`, `center` or `right`.
  17560. */
  17561. align?: (AlignValue|null);
  17562. /**
  17563. * (Highcharts, Highstock, Highmaps, Gantt) Whether to allow data labels to
  17564. * overlap. To make the labels less sensitive for overlapping, the
  17565. * dataLabels.padding can be set to 0.
  17566. */
  17567. allowOverlap?: boolean;
  17568. /**
  17569. * (Highcharts, Highstock, Highmaps, Gantt) Enable or disable the initial
  17570. * animation when a series is displayed for the `dataLabels`. The animation
  17571. * can also be set as a configuration object. Please note that this option
  17572. * only applies to the initial animation. For other animations, see
  17573. * chart.animation and the animation parameter under the API methods. The
  17574. * following properties are supported:
  17575. *
  17576. * - `defer`: The animation delay time in milliseconds.
  17577. */
  17578. animation?: (boolean|PlotAoDataLabelsAnimationOptions|Partial<AnimationOptionsObject>);
  17579. /**
  17580. * (Highcharts, Highstock, Highmaps, Gantt) The background color or gradient
  17581. * for the data label.
  17582. */
  17583. backgroundColor?: (ColorString|GradientColorObject|PatternObject);
  17584. /**
  17585. * (Highcharts, Highstock, Highmaps, Gantt) The border color for the data
  17586. * label. Defaults to `undefined`.
  17587. */
  17588. borderColor?: (ColorString|GradientColorObject|PatternObject);
  17589. /**
  17590. * (Highcharts, Highstock, Highmaps, Gantt) The border radius in pixels for
  17591. * the data label.
  17592. */
  17593. borderRadius?: number;
  17594. /**
  17595. * (Highcharts, Highstock, Highmaps, Gantt) The border width in pixels for
  17596. * the data label.
  17597. */
  17598. borderWidth?: number;
  17599. /**
  17600. * (Highcharts, Highstock, Highmaps, Gantt) A class name for the data label.
  17601. * Particularly in styled mode, this can be used to give each series' or
  17602. * point's data label unique styling. In addition to this option, a default
  17603. * color class name is added so that we can give the labels a contrast text
  17604. * shadow.
  17605. */
  17606. className?: string;
  17607. /**
  17608. * (Highcharts, Highstock, Highmaps, Gantt) The text color for the data
  17609. * labels. Defaults to `undefined`. For certain series types, like column or
  17610. * map, the data labels can be drawn inside the points. In this case the
  17611. * data label will be drawn with maximum contrast by default. Additionally,
  17612. * it will be given a `text-outline` style with the opposite color, to
  17613. * further increase the contrast. This can be overridden by setting the
  17614. * `text-outline` style to `none` in the `dataLabels.style` option.
  17615. */
  17616. color?: (ColorString|GradientColorObject|PatternObject);
  17617. /**
  17618. * (Highcharts, Highstock, Highmaps, Gantt) Whether to hide data labels that
  17619. * are outside the plot area. By default, the data label is moved inside the
  17620. * plot area according to the overflow option.
  17621. */
  17622. crop?: boolean;
  17623. /**
  17624. * (Highcharts, Highstock, Gantt) Whether to defer displaying the data
  17625. * labels until the initial series animation has finished. Setting to
  17626. * `false` renders the data label immediately. If set to `true` inherits the
  17627. * defer time set in plotOptions.series.animation.
  17628. */
  17629. defer?: boolean;
  17630. /**
  17631. * (Highcharts, Highstock, Highmaps, Gantt) Enable or disable the data
  17632. * labels.
  17633. */
  17634. enabled?: boolean;
  17635. /**
  17636. * (Highcharts, Highstock, Highmaps, Gantt) A declarative filter to control
  17637. * of which data labels to display. The declarative filter is designed for
  17638. * use when callback functions are not available, like when the chart
  17639. * options require a pure JSON structure or for use with graphical editors.
  17640. * For programmatic control, use the `formatter` instead, and return
  17641. * `undefined` to disable a single data label.
  17642. */
  17643. filter?: DataLabelsFilterOptionsObject;
  17644. /**
  17645. * (Highcharts, Highstock, Highmaps, Gantt) A format string for the data
  17646. * label. Available variables are the same as for `formatter`.
  17647. */
  17648. format?: string;
  17649. /**
  17650. * (Highcharts, Highstock, Highmaps, Gantt) Callback JavaScript function to
  17651. * format the data label. Note that if a `format` is defined, the format
  17652. * takes precedence and the formatter is ignored.
  17653. */
  17654. formatter?: DataLabelsFormatterCallbackFunction;
  17655. /**
  17656. * (Highcharts, Highstock, Highmaps, Gantt) For points with an extent, like
  17657. * columns or map areas, whether to align the data label inside the box or
  17658. * to the actual value point. Defaults to `false` in most cases, `true` in
  17659. * stacked columns.
  17660. */
  17661. inside?: boolean;
  17662. /**
  17663. * (Highcharts, Highstock, Highmaps, Gantt) Format for points with the value
  17664. * of null. Works analogously to format. `nullFormat` can be applied only to
  17665. * series which support displaying null points.
  17666. */
  17667. nullFormat?: (boolean|string);
  17668. /**
  17669. * (Highcharts, Highstock, Highmaps, Gantt) Callback JavaScript function
  17670. * that defines formatting for points with the value of null. Works
  17671. * analogously to formatter. `nullPointFormatter` can be applied only to
  17672. * series which support displaying null points.
  17673. */
  17674. nullFormatter?: DataLabelsFormatterCallbackFunction;
  17675. /**
  17676. * (Highcharts, Highstock, Highmaps, Gantt) How to handle data labels that
  17677. * flow outside the plot area. The default is `"justify"`, which aligns them
  17678. * inside the plot area. For columns and bars, this means it will be moved
  17679. * inside the bar. To display data labels outside the plot area, set `crop`
  17680. * to `false` and `overflow` to `"allow"`.
  17681. */
  17682. overflow?: DataLabelsOverflowValue;
  17683. /**
  17684. * (Highcharts, Highstock, Highmaps, Gantt) When either the `borderWidth` or
  17685. * the `backgroundColor` is set, this is the padding within the box.
  17686. */
  17687. padding?: number;
  17688. /**
  17689. * (Highcharts, Highstock, Highmaps, Gantt) Aligns data labels relative to
  17690. * points. If `center` alignment is not possible, it defaults to `right`.
  17691. */
  17692. position?: AlignValue;
  17693. /**
  17694. * (Highcharts, Highstock, Highmaps, Gantt) Text rotation in degrees. Note
  17695. * that due to a more complex structure, backgrounds, borders and padding
  17696. * will be lost on a rotated data label.
  17697. */
  17698. rotation?: number;
  17699. /**
  17700. * (Highcharts, Highstock, Highmaps, Gantt) The shadow of the box. Works
  17701. * best with `borderWidth` or `backgroundColor`. Since 2.3 the shadow can be
  17702. * an object configuration containing `color`, `offsetX`, `offsetY`,
  17703. * `opacity` and `width`.
  17704. */
  17705. shadow?: (boolean|ShadowOptionsObject);
  17706. /**
  17707. * (Highcharts, Highstock, Highmaps, Gantt) The name of a symbol to use for
  17708. * the border around the label. Symbols are predefined functions on the
  17709. * Renderer object.
  17710. */
  17711. shape?: string;
  17712. /**
  17713. * (Highcharts, Highstock, Highmaps, Gantt) Styles for the label. The
  17714. * default `color` setting is `"contrast"`, which is a pseudo color that
  17715. * Highcharts picks up and applies the maximum contrast to the underlying
  17716. * point item, for example the bar in a bar chart.
  17717. *
  17718. * The `textOutline` is a pseudo property that applies an outline of the
  17719. * given width with the given color, which by default is the maximum
  17720. * contrast to the text. So a bright text color will result in a black text
  17721. * outline for maximum readability on a mixed background. In some cases,
  17722. * especially with grayscale text, the text outline doesn't work well, in
  17723. * which cases it can be disabled by setting it to `"none"`. When `useHTML`
  17724. * is true, the `textOutline` will not be picked up. In this, case, the same
  17725. * effect can be acheived through the `text-shadow` CSS property.
  17726. *
  17727. * For some series types, where each point has an extent, like for example
  17728. * tree maps, the data label may overflow the point. There are two
  17729. * strategies for handling overflow. By default, the text will wrap to
  17730. * multiple lines. The other strategy is to set `style.textOverflow` to
  17731. * `ellipsis`, which will keep the text on one line plus it will break
  17732. * inside long words.
  17733. */
  17734. style?: CSSObject;
  17735. /**
  17736. * (Highcharts, Highstock, Highmaps, Gantt) Options for a label text which
  17737. * should follow marker's shape. Border and background are disabled for a
  17738. * label that follows a path.
  17739. *
  17740. * **Note:** Only SVG-based renderer supports this option. Setting `useHTML`
  17741. * to true will disable this option.
  17742. */
  17743. textPath?: DataLabelsTextPathOptionsObject;
  17744. /**
  17745. * (Highcharts, Highstock, Highmaps, Gantt) Whether to use HTML to render
  17746. * the labels.
  17747. */
  17748. useHTML?: boolean;
  17749. /**
  17750. * (Highcharts, Highstock, Highmaps, Gantt) The vertical alignment of a data
  17751. * label. Can be one of `top`, `middle` or `bottom`. The default value
  17752. * depends on the data, for instance in a column chart, the label is above
  17753. * positive values and below negative values.
  17754. */
  17755. verticalAlign?: (VerticalAlignValue|null);
  17756. /**
  17757. * (Highcharts, Highstock, Highmaps, Gantt) The x position offset of the
  17758. * label relative to the point in pixels.
  17759. */
  17760. x?: number;
  17761. /**
  17762. * (Highcharts, Highstock, Highmaps, Gantt) The y position offset of the
  17763. * label relative to the point in pixels.
  17764. */
  17765. y?: number;
  17766. /**
  17767. * (Highcharts, Highstock, Highmaps, Gantt) The Z index of the data labels.
  17768. * The default Z index puts it above the series. Use a Z index of 2 to
  17769. * display it behind the series.
  17770. */
  17771. z?: number;
  17772. }
  17773. /**
  17774. * (Highcharts, Highstock) Options for the series data sorting.
  17775. */
  17776. export interface PlotAoDataSortingOptions {
  17777. /**
  17778. * (Highcharts, Highstock) Enable or disable data sorting for the series.
  17779. * Use xAxis.reversed to change the sorting order.
  17780. */
  17781. enabled?: boolean;
  17782. /**
  17783. * (Highcharts, Highstock) Whether to allow matching points by name in an
  17784. * update. If this option is disabled, points will be matched by order.
  17785. */
  17786. matchByName?: boolean;
  17787. /**
  17788. * (Highcharts, Highstock) Determines what data value should be used to sort
  17789. * by.
  17790. */
  17791. sortKey?: string;
  17792. }
  17793. /**
  17794. * (Highstock) Awesome Oscillator. This series requires the `linkedTo` option to
  17795. * be set and should be loaded after the `stock/indicators/indicators.js`
  17796. *
  17797. * In TypeScript the type option must always be set.
  17798. *
  17799. * Configuration options for the series are given in three levels:
  17800. *
  17801. * 1. Options for all series in a chart are defined in the plotOptions.series
  17802. * object.
  17803. *
  17804. * 2. Options for all `ao` series are defined in plotOptions.ao.
  17805. *
  17806. * 3. Options for one single series are given in the series instance array. (see
  17807. * online documentation for example)
  17808. */
  17809. export interface PlotAoOptions {
  17810. /**
  17811. * (Highstock) Accessibility options for a series.
  17812. */
  17813. accessibility?: SeriesAccessibilityOptionsObject;
  17814. /**
  17815. * (Highstock) Allow this series' points to be selected by clicking on the
  17816. * graphic (columns, point markers, pie slices, map areas etc).
  17817. *
  17818. * The selected points can be handled by point select and unselect events,
  17819. * or collectively by the getSelectedPoints function.
  17820. *
  17821. * And alternative way of selecting points is through dragging.
  17822. */
  17823. allowPointSelect?: boolean;
  17824. /**
  17825. * (Highstock) Enable or disable the initial animation when a series is
  17826. * displayed. The animation can also be set as a configuration object.
  17827. * Please note that this option only applies to the initial animation of the
  17828. * series itself. For other animations, see chart.animation and the
  17829. * animation parameter under the API methods. The following properties are
  17830. * supported:
  17831. *
  17832. * - `defer`: The animation delay time in milliseconds.
  17833. *
  17834. * - `duration`: The duration of the animation in milliseconds.
  17835. *
  17836. * - `easing`: Can be a string reference to an easing function set on the
  17837. * `Math` object or a function. See the _Custom easing function_ demo below.
  17838. *
  17839. * Due to poor performance, animation is disabled in old IE browsers for
  17840. * several chart types.
  17841. */
  17842. animation?: (boolean|PlotAoAnimationOptions|Partial<AnimationOptionsObject>);
  17843. /**
  17844. * (Highstock) For some series, there is a limit that shuts down initial
  17845. * animation by default when the total number of points in the chart is too
  17846. * high. For example, for a column chart and its derivatives, animation does
  17847. * not run if there is more than 250 points totally. To disable this cap,
  17848. * set `animationLimit` to `Infinity`.
  17849. */
  17850. animationLimit?: number;
  17851. /**
  17852. * (Highstock) Sets the color blending in the boost module.
  17853. */
  17854. boostBlending?: OptionsBoostBlendingValue;
  17855. /**
  17856. * (Highstock) Set the point threshold for when a series should enter boost
  17857. * mode.
  17858. *
  17859. * Setting it to e.g. 2000 will cause the series to enter boost mode when
  17860. * there are 2000 or more points in the series.
  17861. *
  17862. * To disable boosting on the series, set the `boostThreshold` to 0. Setting
  17863. * it to 1 will force boosting.
  17864. *
  17865. * Note that the cropThreshold also affects this setting. When zooming in on
  17866. * a series that has fewer points than the `cropThreshold`, all points are
  17867. * rendered although outside the visible plot area, and the `boostThreshold`
  17868. * won't take effect.
  17869. */
  17870. boostThreshold?: number;
  17871. /**
  17872. * (Highmaps) The border color of the map areas.
  17873. *
  17874. * In styled mode, the border stroke is given in the `.highcharts-point`
  17875. * class.
  17876. */
  17877. borderColor?: (ColorString|GradientColorObject|PatternObject);
  17878. /**
  17879. * (Highmaps) The border width of each map area.
  17880. *
  17881. * In styled mode, the border stroke width is given in the
  17882. * `.highcharts-point` class.
  17883. */
  17884. borderWidth?: number;
  17885. /**
  17886. * (Highstock) An additional class name to apply to the series' graphical
  17887. * elements. This option does not replace default class names of the
  17888. * graphical element.
  17889. */
  17890. className?: string;
  17891. /**
  17892. * (Highstock) Disable this option to allow series rendering in the whole
  17893. * plotting area.
  17894. *
  17895. * **Note:** Clipping should be always enabled when chart.zoomType is set
  17896. */
  17897. clip?: boolean;
  17898. /**
  17899. * (Highstock) The main color of the series. In line type series it applies
  17900. * to the line and the point markers unless otherwise specified. In bar type
  17901. * series it applies to the bars unless a color is specified per point. The
  17902. * default value is pulled from the `options.colors` array.
  17903. *
  17904. * In styled mode, the color can be defined by the colorIndex option. Also,
  17905. * the series color can be set with the `.highcharts-series`,
  17906. * `.highcharts-color-{n}`, `.highcharts-{type}-series` or
  17907. * `.highcharts-series-{n}` class, or individual classes given by the
  17908. * `className` option.
  17909. */
  17910. color?: (ColorString|GradientColorObject|PatternObject);
  17911. /**
  17912. * (Highstock) Styled mode only. A specific color index to use for the
  17913. * series, so its graphic representations are given the class name
  17914. * `highcharts-color-{n}`.
  17915. */
  17916. colorIndex?: number;
  17917. /**
  17918. * (Highcharts, Highstock, Highmaps) Determines what data value should be
  17919. * used to calculate point color if `colorAxis` is used. Requires to set
  17920. * `min` and `max` if some custom point property is used or if approximation
  17921. * for data grouping is set to `'sum'`.
  17922. */
  17923. colorKey?: string;
  17924. /**
  17925. * (Highstock) Compare the values of the series against the first non-null,
  17926. * non- zero value in the visible range. The y axis will show percentage or
  17927. * absolute change depending on whether `compare` is set to `"percent"` or
  17928. * `"value"`. When this is applied to multiple series, it allows comparing
  17929. * the development of the series against each other. Adds a `change` field
  17930. * to every point object.
  17931. */
  17932. compare?: string;
  17933. /**
  17934. * (Highstock) When compare is `percent`, this option dictates whether to
  17935. * use 0 or 100 as the base of comparison.
  17936. */
  17937. compareBase?: (0|100);
  17938. /**
  17939. * (Highstock) Defines if comparison should start from the first point
  17940. * within the visible range or should start from the first point **before**
  17941. * the range.
  17942. *
  17943. * In other words, this flag determines if first point within the visible
  17944. * range will have 0% (`compareStart=true`) or should have been already
  17945. * calculated according to the previous point (`compareStart=false`).
  17946. */
  17947. compareStart?: boolean;
  17948. /**
  17949. * (Highstock) Whether to compare indicator to the main series values or
  17950. * indicator values.
  17951. */
  17952. compareToMain?: boolean;
  17953. /**
  17954. * (Highcharts) Polar charts only. Whether to connect the ends of a line
  17955. * series plot across the extremes.
  17956. */
  17957. connectEnds?: boolean;
  17958. /**
  17959. * (Highcharts, Highstock) Whether to connect a graph line across null
  17960. * points, or render a gap between the two points on either side of the
  17961. * null.
  17962. */
  17963. connectNulls?: boolean;
  17964. /**
  17965. * (Gantt) Override Pathfinder connector options for a series. Requires
  17966. * Highcharts Gantt to be loaded.
  17967. */
  17968. connectors?: SeriesConnectorsOptionsObject;
  17969. /**
  17970. * (Highcharts, Highstock, Gantt) When true, each point or column edge is
  17971. * rounded to its nearest pixel in order to render sharp on screen. In some
  17972. * cases, when there are a lot of densely packed columns, this leads to
  17973. * visible difference in column widths or distance between columns. In these
  17974. * cases, setting `crisp` to `false` may look better, even though each
  17975. * column is rendered blurry.
  17976. */
  17977. crisp?: boolean;
  17978. /**
  17979. * (Highcharts, Highstock) When the series contains less points than the
  17980. * crop threshold, all points are drawn, even if the points fall outside the
  17981. * visible plot area at the current zoom. The advantage of drawing all
  17982. * points (including markers and columns), is that animation is performed on
  17983. * updates. On the other hand, when the series contains more points than the
  17984. * crop threshold, the series data is cropped to only contain points that
  17985. * fall within the plot area. The advantage of cropping away invisible
  17986. * points is to increase performance on large series.
  17987. */
  17988. cropThreshold?: number;
  17989. /**
  17990. * (Highstock) You can set the cursor to "pointer" if you have click events
  17991. * attached to the series, to signal to the user that the points and lines
  17992. * can be clicked.
  17993. *
  17994. * In styled mode, the series cursor can be set with the same classes as
  17995. * listed under series.color.
  17996. */
  17997. cursor?: (string|CursorValue);
  17998. /**
  17999. * (Highstock) A reserved subspace to store options and values for
  18000. * customized functionality. Here you can add additional data for your own
  18001. * event callbacks and formatter callbacks.
  18002. */
  18003. custom?: Dictionary<any>;
  18004. /**
  18005. * (Highstock) Name of the dash style to use for the graph, or for some
  18006. * series types the outline of each shape.
  18007. *
  18008. * In styled mode, the stroke dash-array can be set with the same classes as
  18009. * listed under series.color.
  18010. */
  18011. dashStyle?: DashStyleValue;
  18012. /**
  18013. * (Highstock) Data grouping is the concept of sampling the data values into
  18014. * larger blocks in order to ease readability and increase performance of
  18015. * the JavaScript charts. Highstock by default applies data grouping when
  18016. * the points become closer than a certain pixel value, determined by the
  18017. * `groupPixelWidth` option.
  18018. *
  18019. * If data grouping is applied, the grouping information of grouped points
  18020. * can be read from the Point.dataGroup. If point options other than the
  18021. * data itself are set, for example `name` or `color` or custom properties,
  18022. * the grouping logic doesn't know how to group it. In this case the options
  18023. * of the first point instance are copied over to the group point. This can
  18024. * be altered through a custom `approximation` callback function.
  18025. */
  18026. dataGrouping?: DataGroupingOptionsObject;
  18027. /**
  18028. * (Highcharts, Highstock, Highmaps, Gantt) Options for the series data
  18029. * labels, appearing next to each data point.
  18030. *
  18031. * Since v6.2.0, multiple data labels can be applied to each single point by
  18032. * defining them as an array of configs.
  18033. *
  18034. * In styled mode, the data labels can be styled with the
  18035. * `.highcharts-data-label-box` and `.highcharts-data-label` class names
  18036. * (see example).
  18037. */
  18038. dataLabels?: (PlotAoDataLabelsOptions|Array<PlotAoDataLabelsOptions>);
  18039. /**
  18040. * (Highcharts, Highstock) Options for the series data sorting.
  18041. */
  18042. dataSorting?: (DataSortingOptionsObject|PlotAoDataSortingOptions);
  18043. /**
  18044. * (Highstock) A description of the series to add to the screen reader
  18045. * information about the series.
  18046. */
  18047. description?: string;
  18048. /**
  18049. * (Highstock) Enable or disable the mouse tracking for a specific series.
  18050. * This includes point tooltips and click events on graphs and points. For
  18051. * large datasets it improves performance.
  18052. */
  18053. enableMouseTracking?: boolean;
  18054. /**
  18055. * (Highstock) General event handlers for the series items. These event
  18056. * hooks can also be attached to the series at run time using the
  18057. * `Highcharts.addEvent` function.
  18058. */
  18059. events?: SeriesEventsOptionsObject;
  18060. /**
  18061. * (Highstock) Determines whether the series should look for the nearest
  18062. * point in both dimensions or just the x-dimension when hovering the
  18063. * series. Defaults to `'xy'` for scatter series and `'x'` for most other
  18064. * series. If the data has duplicate x-values, it is recommended to set this
  18065. * to `'xy'` to allow hovering over all points.
  18066. *
  18067. * Applies only to series types using nearest neighbor search (not direct
  18068. * hover) for tooltip.
  18069. */
  18070. findNearestPointBy?: OptionsFindNearestPointByValue;
  18071. /**
  18072. * (Highstock) Defines when to display a gap in the graph, together with the
  18073. * gapUnit option.
  18074. *
  18075. * In case when `dataGrouping` is enabled, points can be grouped into a
  18076. * larger time span. This can make the grouped points to have a greater
  18077. * distance than the absolute value of `gapSize` property, which will result
  18078. * in disappearing graph completely. To prevent this situation the mentioned
  18079. * distance between grouped points is used instead of previously defined
  18080. * `gapSize`.
  18081. *
  18082. * In practice, this option is most often used to visualize gaps in time
  18083. * series. In a stock chart, intraday data is available for daytime hours,
  18084. * while gaps will appear in nights and weekends.
  18085. */
  18086. gapSize?: number;
  18087. /**
  18088. * (Highstock) Together with gapSize, this option defines where to draw gaps
  18089. * in the graph.
  18090. *
  18091. * When the `gapUnit` is `"relative"` (default), a gap size of 5 means that
  18092. * if the distance between two points is greater than 5 times that of the
  18093. * two closest points, the graph will be broken.
  18094. *
  18095. * When the `gapUnit` is `"value"`, the gap is based on absolute axis
  18096. * values, which on a datetime axis is milliseconds. This also applies to
  18097. * the navigator series that inherits gap options from the base series.
  18098. */
  18099. gapUnit?: OptionsGapUnitValue;
  18100. /**
  18101. * (Highcharts, Highstock, Gantt) Whether to use the Y extremes of the total
  18102. * chart width or only the zoomed area when zooming in on parts of the X
  18103. * axis. By default, the Y axis adjusts to the min and max of the visible
  18104. * data. Cartesian series only.
  18105. */
  18106. getExtremesFromAll?: boolean;
  18107. /**
  18108. * (Highstock) Color of the Awesome oscillator series bar that is greater
  18109. * than the previous one. Note that if a `color` is defined, the `color`
  18110. * takes precedence and the `greaterBarColor` is ignored.
  18111. */
  18112. greaterBarColor?: (ColorString|GradientColorObject|PatternObject);
  18113. groupPadding?: number;
  18114. /**
  18115. * (Highstock) When set to `false` will prevent the series data from being
  18116. * included in any form of data export.
  18117. *
  18118. * Since version 6.0.0 until 7.1.0 the option was existing undocumented as
  18119. * `includeInCSVExport`.
  18120. */
  18121. includeInDataExport?: boolean;
  18122. /**
  18123. * (Highcharts, Highstock, Gantt) Series labels are placed as close to the
  18124. * series as possible in a natural way, seeking to avoid other series. The
  18125. * goal of this feature is to make the chart more easily readable, like if a
  18126. * human designer placed the labels in the optimal position.
  18127. *
  18128. * The series labels currently work with series types having a `graph` or an
  18129. * `area`.
  18130. */
  18131. label?: SeriesLabelOptionsObject;
  18132. /**
  18133. * (Highstock) The line marks the last price from all points.
  18134. */
  18135. lastPrice?: SeriesLastPriceOptionsObject;
  18136. /**
  18137. * (Highstock) The line marks the last price from visible range of points.
  18138. */
  18139. lastVisiblePrice?: SeriesLastVisiblePriceOptionsObject;
  18140. /**
  18141. * (Highcharts, Highstock) The SVG value used for the `stroke-linecap` and
  18142. * `stroke-linejoin` of a line graph. Round means that lines are rounded in
  18143. * the ends and bends.
  18144. */
  18145. linecap?: SeriesLinecapValue;
  18146. /**
  18147. * (Highcharts, Highstock) Pixel width of the graph line.
  18148. */
  18149. lineWidth?: number;
  18150. /**
  18151. * (Highcharts, Highstock, Gantt) The main series ID that indicator will be
  18152. * based on. Required for this indicator.
  18153. */
  18154. linkedTo?: string;
  18155. /**
  18156. * (Highstock) Color of the Awesome oscillator series bar that is lower than
  18157. * the previous one. Note that if a `color` is defined, the `color` takes
  18158. * precedence and the `lowerBarColor` is ignored.
  18159. */
  18160. lowerBarColor?: (ColorString|GradientColorObject|PatternObject);
  18161. /**
  18162. * (Highstock) Options for the point markers of line-like series. Properties
  18163. * like `fillColor`, `lineColor` and `lineWidth` define the visual
  18164. * appearance of the markers. Other series types, like column series, don't
  18165. * have markers, but have visual options on the series level instead.
  18166. *
  18167. * In styled mode, the markers can be styled with the `.highcharts-point`,
  18168. * `.highcharts-point-hover` and `.highcharts-point-select` class names.
  18169. */
  18170. marker?: PointMarkerOptionsObject;
  18171. /**
  18172. * (Highstock) The name of the series as shown in the legend, tooltip etc.
  18173. * If not set, it will be based on a technical indicator type and default
  18174. * params.
  18175. */
  18176. name?: string;
  18177. /**
  18178. * (Highstock) The color for the parts of the graph or points that are below
  18179. * the threshold. Note that `zones` takes precedence over the negative
  18180. * color. Using `negativeColor` is equivalent to applying a zone with value
  18181. * of 0.
  18182. */
  18183. negativeColor?: (ColorString|GradientColorObject|PatternObject);
  18184. /**
  18185. * (Highstock) Opacity of a series parts: line, fill (e.g. area) and
  18186. * dataLabels.
  18187. */
  18188. opacity?: number;
  18189. /**
  18190. * (Highstock) Properties for each single point.
  18191. */
  18192. point?: PlotSeriesPointOptions;
  18193. /**
  18194. * (Highstock) Same as accessibility.pointDescriptionFormatter, but for an
  18195. * individual series. Overrides the chart wide configuration.
  18196. */
  18197. pointDescriptionFormatter?: Function;
  18198. pointPadding?: number;
  18199. /**
  18200. * (Highstock) Whether to select the series initially. If `showCheckbox` is
  18201. * true, the checkbox next to the series name in the legend will be checked
  18202. * for a selected series.
  18203. */
  18204. selected?: boolean;
  18205. /**
  18206. * (Highstock) Whether to apply a drop shadow to the graph line. Since 2.3
  18207. * the shadow can be an object configuration containing `color`, `offsetX`,
  18208. * `offsetY`, `opacity` and `width`.
  18209. */
  18210. shadow?: (boolean|ShadowOptionsObject);
  18211. /**
  18212. * (Highstock) If true, a checkbox is displayed next to the legend item to
  18213. * allow selecting the series. The state of the checkbox is determined by
  18214. * the `selected` option.
  18215. */
  18216. showCheckbox?: boolean;
  18217. /**
  18218. * (Highstock) Whether to display this particular series or series type in
  18219. * the legend. Standalone series are shown in legend by default, and linked
  18220. * series are not. Since v7.2.0 it is possible to show series that use
  18221. * colorAxis by setting this option to `true`.
  18222. */
  18223. showInLegend?: boolean;
  18224. /**
  18225. * (Highstock) If set to `true`, the accessibility module will skip past the
  18226. * points in this series for keyboard navigation.
  18227. */
  18228. skipKeyboardNavigation?: boolean;
  18229. /**
  18230. * (Highcharts, Highstock) When this is true, the series will not cause the
  18231. * Y axis to cross the zero plane (or threshold option) unless the data
  18232. * actually crosses the plane.
  18233. *
  18234. * For example, if `softThreshold` is `false`, a series of 0, 1, 2, 3 will
  18235. * make the Y axis show negative values according to the `minPadding`
  18236. * option. If `softThreshold` is `true`, the Y axis starts at 0.
  18237. */
  18238. softThreshold?: boolean;
  18239. states?: SeriesStatesOptionsObject;
  18240. /**
  18241. * (Highcharts, Highstock) Whether to apply steps to the line. Possible
  18242. * values are `left`, `center` and `right`.
  18243. */
  18244. step?: OptionsStepValue;
  18245. /**
  18246. * (Highstock) Sticky tracking of mouse events. When true, the `mouseOut`
  18247. * event on a series isn't triggered until the mouse moves over another
  18248. * series, or out of the plot area. When false, the `mouseOut` event on a
  18249. * series is triggered when the mouse leaves the area around the series'
  18250. * graph or markers. This also implies the tooltip when not shared. When
  18251. * `stickyTracking` is false and `tooltip.shared` is false, the tooltip will
  18252. * be hidden when moving the mouse between series. Defaults to true for line
  18253. * and area type series, but to false for columns, pies etc.
  18254. *
  18255. * **Note:** The boost module will force this option because of technical
  18256. * limitations.
  18257. */
  18258. stickyTracking?: boolean;
  18259. /**
  18260. * (Highcharts, Highstock) The threshold, also called zero level or base
  18261. * level. For line type series this is only used in conjunction with
  18262. * negativeColor.
  18263. */
  18264. threshold?: number;
  18265. /**
  18266. * (Highstock) A configuration object for the tooltip rendering of each
  18267. * single series. Properties are inherited from tooltip, but only the
  18268. * following properties can be defined on a series level.
  18269. */
  18270. tooltip?: SeriesTooltipOptionsObject;
  18271. /**
  18272. * (Highcharts, Highstock, Gantt) When a series contains a data array that
  18273. * is longer than this, only one dimensional arrays of numbers, or two
  18274. * dimensional arrays with x and y values are allowed. Also, only the first
  18275. * point is tested, and the rest are assumed to be the same format. This
  18276. * saves expensive data checking and indexing in long series. Set it to `0`
  18277. * disable.
  18278. *
  18279. * Note: In boost mode turbo threshold is forced. Only array of numbers or
  18280. * two dimensional arrays are allowed.
  18281. */
  18282. turboThreshold?: number;
  18283. /**
  18284. * (Highstock) Set the initial visibility of the series.
  18285. */
  18286. visible?: boolean;
  18287. /**
  18288. * (Highmaps) Define the z index of the series.
  18289. */
  18290. zIndex?: number;
  18291. /**
  18292. * (Highcharts, Highstock) Defines the Axis on which the zones are applied.
  18293. */
  18294. zoneAxis?: string;
  18295. /**
  18296. * (Highcharts, Highstock) An array defining zones within a series. Zones
  18297. * can be applied to the X axis, Y axis or Z axis for bubbles, according to
  18298. * the `zoneAxis` option. The zone definitions have to be in ascending order
  18299. * regarding to the value.
  18300. *
  18301. * In styled mode, the color zones are styled with the
  18302. * `.highcharts-zone-{n}` class, or custom classed from the `className`
  18303. * option (view live demo).
  18304. */
  18305. zones?: Array<SeriesZonesOptionsObject>;
  18306. }
  18307. /**
  18308. * (Highstock) Enable or disable the initial animation when a series is
  18309. * displayed. The animation can also be set as a configuration object. Please
  18310. * note that this option only applies to the initial animation of the series
  18311. * itself. For other animations, see chart.animation and the animation parameter
  18312. * under the API methods. The following properties are supported:
  18313. *
  18314. * - `defer`: The animation delay time in milliseconds.
  18315. *
  18316. * - `duration`: The duration of the animation in milliseconds.
  18317. *
  18318. * - `easing`: Can be a string reference to an easing function set on the `Math`
  18319. * object or a function. See the _Custom easing function_ demo below.
  18320. *
  18321. * Due to poor performance, animation is disabled in old IE browsers for several
  18322. * chart types.
  18323. */
  18324. export interface PlotApoAnimationOptions {
  18325. defer?: number;
  18326. }
  18327. /**
  18328. * (Highcharts, Highstock, Highmaps, Gantt) Enable or disable the initial
  18329. * animation when a series is displayed for the `dataLabels`. The animation can
  18330. * also be set as a configuration object. Please note that this option only
  18331. * applies to the initial animation. For other animations, see chart.animation
  18332. * and the animation parameter under the API methods. The following properties
  18333. * are supported:
  18334. *
  18335. * - `defer`: The animation delay time in milliseconds.
  18336. */
  18337. export interface PlotApoDataLabelsAnimationOptions {
  18338. /**
  18339. * (Highcharts, Highstock, Highmaps, Gantt) The animation delay time in
  18340. * milliseconds. Set to `0` renders dataLabel immediately. As `undefined`
  18341. * inherits defer time from the series.animation.defer.
  18342. */
  18343. defer?: number;
  18344. }
  18345. /**
  18346. * (Highcharts, Highstock, Highmaps, Gantt) Options for the series data labels,
  18347. * appearing next to each data point.
  18348. *
  18349. * Since v6.2.0, multiple data labels can be applied to each single point by
  18350. * defining them as an array of configs.
  18351. *
  18352. * In styled mode, the data labels can be styled with the
  18353. * `.highcharts-data-label-box` and `.highcharts-data-label` class names (see
  18354. * example).
  18355. */
  18356. export interface PlotApoDataLabelsOptions {
  18357. /**
  18358. * (Highcharts, Highstock, Highmaps, Gantt) The alignment of the data label
  18359. * compared to the point. If `right`, the right side of the label should be
  18360. * touching the point. For points with an extent, like columns, the
  18361. * alignments also dictates how to align it inside the box, as given with
  18362. * the inside option. Can be one of `left`, `center` or `right`.
  18363. */
  18364. align?: (AlignValue|null);
  18365. /**
  18366. * (Highcharts, Highstock, Highmaps, Gantt) Whether to allow data labels to
  18367. * overlap. To make the labels less sensitive for overlapping, the
  18368. * dataLabels.padding can be set to 0.
  18369. */
  18370. allowOverlap?: boolean;
  18371. /**
  18372. * (Highcharts, Highstock, Highmaps, Gantt) Enable or disable the initial
  18373. * animation when a series is displayed for the `dataLabels`. The animation
  18374. * can also be set as a configuration object. Please note that this option
  18375. * only applies to the initial animation. For other animations, see
  18376. * chart.animation and the animation parameter under the API methods. The
  18377. * following properties are supported:
  18378. *
  18379. * - `defer`: The animation delay time in milliseconds.
  18380. */
  18381. animation?: (boolean|PlotApoDataLabelsAnimationOptions|Partial<AnimationOptionsObject>);
  18382. /**
  18383. * (Highcharts, Highstock, Highmaps, Gantt) The background color or gradient
  18384. * for the data label.
  18385. */
  18386. backgroundColor?: (ColorString|GradientColorObject|PatternObject);
  18387. /**
  18388. * (Highcharts, Highstock, Highmaps, Gantt) The border color for the data
  18389. * label. Defaults to `undefined`.
  18390. */
  18391. borderColor?: (ColorString|GradientColorObject|PatternObject);
  18392. /**
  18393. * (Highcharts, Highstock, Highmaps, Gantt) The border radius in pixels for
  18394. * the data label.
  18395. */
  18396. borderRadius?: number;
  18397. /**
  18398. * (Highcharts, Highstock, Highmaps, Gantt) The border width in pixels for
  18399. * the data label.
  18400. */
  18401. borderWidth?: number;
  18402. /**
  18403. * (Highcharts, Highstock, Highmaps, Gantt) A class name for the data label.
  18404. * Particularly in styled mode, this can be used to give each series' or
  18405. * point's data label unique styling. In addition to this option, a default
  18406. * color class name is added so that we can give the labels a contrast text
  18407. * shadow.
  18408. */
  18409. className?: string;
  18410. /**
  18411. * (Highcharts, Highstock, Highmaps, Gantt) The text color for the data
  18412. * labels. Defaults to `undefined`. For certain series types, like column or
  18413. * map, the data labels can be drawn inside the points. In this case the
  18414. * data label will be drawn with maximum contrast by default. Additionally,
  18415. * it will be given a `text-outline` style with the opposite color, to
  18416. * further increase the contrast. This can be overridden by setting the
  18417. * `text-outline` style to `none` in the `dataLabels.style` option.
  18418. */
  18419. color?: (ColorString|GradientColorObject|PatternObject);
  18420. /**
  18421. * (Highcharts, Highstock, Highmaps, Gantt) Whether to hide data labels that
  18422. * are outside the plot area. By default, the data label is moved inside the
  18423. * plot area according to the overflow option.
  18424. */
  18425. crop?: boolean;
  18426. /**
  18427. * (Highcharts, Highstock, Gantt) Whether to defer displaying the data
  18428. * labels until the initial series animation has finished. Setting to
  18429. * `false` renders the data label immediately. If set to `true` inherits the
  18430. * defer time set in plotOptions.series.animation.
  18431. */
  18432. defer?: boolean;
  18433. /**
  18434. * (Highcharts, Highstock, Highmaps, Gantt) Enable or disable the data
  18435. * labels.
  18436. */
  18437. enabled?: boolean;
  18438. /**
  18439. * (Highcharts, Highstock, Highmaps, Gantt) A declarative filter to control
  18440. * of which data labels to display. The declarative filter is designed for
  18441. * use when callback functions are not available, like when the chart
  18442. * options require a pure JSON structure or for use with graphical editors.
  18443. * For programmatic control, use the `formatter` instead, and return
  18444. * `undefined` to disable a single data label.
  18445. */
  18446. filter?: DataLabelsFilterOptionsObject;
  18447. /**
  18448. * (Highcharts, Highstock, Highmaps, Gantt) A format string for the data
  18449. * label. Available variables are the same as for `formatter`.
  18450. */
  18451. format?: string;
  18452. /**
  18453. * (Highcharts, Highstock, Highmaps, Gantt) Callback JavaScript function to
  18454. * format the data label. Note that if a `format` is defined, the format
  18455. * takes precedence and the formatter is ignored.
  18456. */
  18457. formatter?: DataLabelsFormatterCallbackFunction;
  18458. /**
  18459. * (Highcharts, Highstock, Highmaps, Gantt) For points with an extent, like
  18460. * columns or map areas, whether to align the data label inside the box or
  18461. * to the actual value point. Defaults to `false` in most cases, `true` in
  18462. * stacked columns.
  18463. */
  18464. inside?: boolean;
  18465. /**
  18466. * (Highcharts, Highstock, Highmaps, Gantt) Format for points with the value
  18467. * of null. Works analogously to format. `nullFormat` can be applied only to
  18468. * series which support displaying null points.
  18469. */
  18470. nullFormat?: (boolean|string);
  18471. /**
  18472. * (Highcharts, Highstock, Highmaps, Gantt) Callback JavaScript function
  18473. * that defines formatting for points with the value of null. Works
  18474. * analogously to formatter. `nullPointFormatter` can be applied only to
  18475. * series which support displaying null points.
  18476. */
  18477. nullFormatter?: DataLabelsFormatterCallbackFunction;
  18478. /**
  18479. * (Highcharts, Highstock, Highmaps, Gantt) How to handle data labels that
  18480. * flow outside the plot area. The default is `"justify"`, which aligns them
  18481. * inside the plot area. For columns and bars, this means it will be moved
  18482. * inside the bar. To display data labels outside the plot area, set `crop`
  18483. * to `false` and `overflow` to `"allow"`.
  18484. */
  18485. overflow?: DataLabelsOverflowValue;
  18486. /**
  18487. * (Highcharts, Highstock, Highmaps, Gantt) When either the `borderWidth` or
  18488. * the `backgroundColor` is set, this is the padding within the box.
  18489. */
  18490. padding?: number;
  18491. /**
  18492. * (Highcharts, Highstock, Highmaps, Gantt) Aligns data labels relative to
  18493. * points. If `center` alignment is not possible, it defaults to `right`.
  18494. */
  18495. position?: AlignValue;
  18496. /**
  18497. * (Highcharts, Highstock, Highmaps, Gantt) Text rotation in degrees. Note
  18498. * that due to a more complex structure, backgrounds, borders and padding
  18499. * will be lost on a rotated data label.
  18500. */
  18501. rotation?: number;
  18502. /**
  18503. * (Highcharts, Highstock, Highmaps, Gantt) The shadow of the box. Works
  18504. * best with `borderWidth` or `backgroundColor`. Since 2.3 the shadow can be
  18505. * an object configuration containing `color`, `offsetX`, `offsetY`,
  18506. * `opacity` and `width`.
  18507. */
  18508. shadow?: (boolean|ShadowOptionsObject);
  18509. /**
  18510. * (Highcharts, Highstock, Highmaps, Gantt) The name of a symbol to use for
  18511. * the border around the label. Symbols are predefined functions on the
  18512. * Renderer object.
  18513. */
  18514. shape?: string;
  18515. /**
  18516. * (Highcharts, Highstock, Highmaps, Gantt) Styles for the label. The
  18517. * default `color` setting is `"contrast"`, which is a pseudo color that
  18518. * Highcharts picks up and applies the maximum contrast to the underlying
  18519. * point item, for example the bar in a bar chart.
  18520. *
  18521. * The `textOutline` is a pseudo property that applies an outline of the
  18522. * given width with the given color, which by default is the maximum
  18523. * contrast to the text. So a bright text color will result in a black text
  18524. * outline for maximum readability on a mixed background. In some cases,
  18525. * especially with grayscale text, the text outline doesn't work well, in
  18526. * which cases it can be disabled by setting it to `"none"`. When `useHTML`
  18527. * is true, the `textOutline` will not be picked up. In this, case, the same
  18528. * effect can be acheived through the `text-shadow` CSS property.
  18529. *
  18530. * For some series types, where each point has an extent, like for example
  18531. * tree maps, the data label may overflow the point. There are two
  18532. * strategies for handling overflow. By default, the text will wrap to
  18533. * multiple lines. The other strategy is to set `style.textOverflow` to
  18534. * `ellipsis`, which will keep the text on one line plus it will break
  18535. * inside long words.
  18536. */
  18537. style?: CSSObject;
  18538. /**
  18539. * (Highcharts, Highstock, Highmaps, Gantt) Options for a label text which
  18540. * should follow marker's shape. Border and background are disabled for a
  18541. * label that follows a path.
  18542. *
  18543. * **Note:** Only SVG-based renderer supports this option. Setting `useHTML`
  18544. * to true will disable this option.
  18545. */
  18546. textPath?: DataLabelsTextPathOptionsObject;
  18547. /**
  18548. * (Highcharts, Highstock, Highmaps, Gantt) Whether to use HTML to render
  18549. * the labels.
  18550. */
  18551. useHTML?: boolean;
  18552. /**
  18553. * (Highcharts, Highstock, Highmaps, Gantt) The vertical alignment of a data
  18554. * label. Can be one of `top`, `middle` or `bottom`. The default value
  18555. * depends on the data, for instance in a column chart, the label is above
  18556. * positive values and below negative values.
  18557. */
  18558. verticalAlign?: (VerticalAlignValue|null);
  18559. /**
  18560. * (Highcharts, Highstock, Highmaps, Gantt) The x position offset of the
  18561. * label relative to the point in pixels.
  18562. */
  18563. x?: number;
  18564. /**
  18565. * (Highcharts, Highstock, Highmaps, Gantt) The y position offset of the
  18566. * label relative to the point in pixels.
  18567. */
  18568. y?: number;
  18569. /**
  18570. * (Highcharts, Highstock, Highmaps, Gantt) The Z index of the data labels.
  18571. * The default Z index puts it above the series. Use a Z index of 2 to
  18572. * display it behind the series.
  18573. */
  18574. z?: number;
  18575. }
  18576. /**
  18577. * (Highcharts, Highstock) Options for the series data sorting.
  18578. */
  18579. export interface PlotApoDataSortingOptions {
  18580. /**
  18581. * (Highcharts, Highstock) Enable or disable data sorting for the series.
  18582. * Use xAxis.reversed to change the sorting order.
  18583. */
  18584. enabled?: boolean;
  18585. /**
  18586. * (Highcharts, Highstock) Whether to allow matching points by name in an
  18587. * update. If this option is disabled, points will be matched by order.
  18588. */
  18589. matchByName?: boolean;
  18590. /**
  18591. * (Highcharts, Highstock) Determines what data value should be used to sort
  18592. * by.
  18593. */
  18594. sortKey?: string;
  18595. }
  18596. /**
  18597. * (Highstock) Absolute Price Oscillator. This series requires the `linkedTo`
  18598. * option to be set and should be loaded after the
  18599. * `stock/indicators/indicators.js` and `stock/indicators/ema.js`.
  18600. *
  18601. * In TypeScript the type option must always be set.
  18602. *
  18603. * Configuration options for the series are given in three levels:
  18604. *
  18605. * 1. Options for all series in a chart are defined in the plotOptions.series
  18606. * object.
  18607. *
  18608. * 2. Options for all `apo` series are defined in plotOptions.apo.
  18609. *
  18610. * 3. Options for one single series are given in the series instance array. (see
  18611. * online documentation for example)
  18612. */
  18613. export interface PlotApoOptions {
  18614. /**
  18615. * (Highstock) Accessibility options for a series.
  18616. */
  18617. accessibility?: SeriesAccessibilityOptionsObject;
  18618. /**
  18619. * (Highstock) Allow this series' points to be selected by clicking on the
  18620. * graphic (columns, point markers, pie slices, map areas etc).
  18621. *
  18622. * The selected points can be handled by point select and unselect events,
  18623. * or collectively by the getSelectedPoints function.
  18624. *
  18625. * And alternative way of selecting points is through dragging.
  18626. */
  18627. allowPointSelect?: boolean;
  18628. /**
  18629. * (Highstock) Enable or disable the initial animation when a series is
  18630. * displayed. The animation can also be set as a configuration object.
  18631. * Please note that this option only applies to the initial animation of the
  18632. * series itself. For other animations, see chart.animation and the
  18633. * animation parameter under the API methods. The following properties are
  18634. * supported:
  18635. *
  18636. * - `defer`: The animation delay time in milliseconds.
  18637. *
  18638. * - `duration`: The duration of the animation in milliseconds.
  18639. *
  18640. * - `easing`: Can be a string reference to an easing function set on the
  18641. * `Math` object or a function. See the _Custom easing function_ demo below.
  18642. *
  18643. * Due to poor performance, animation is disabled in old IE browsers for
  18644. * several chart types.
  18645. */
  18646. animation?: (boolean|PlotApoAnimationOptions|Partial<AnimationOptionsObject>);
  18647. /**
  18648. * (Highstock) For some series, there is a limit that shuts down initial
  18649. * animation by default when the total number of points in the chart is too
  18650. * high. For example, for a column chart and its derivatives, animation does
  18651. * not run if there is more than 250 points totally. To disable this cap,
  18652. * set `animationLimit` to `Infinity`.
  18653. */
  18654. animationLimit?: number;
  18655. /**
  18656. * (Highstock) Sets the color blending in the boost module.
  18657. */
  18658. boostBlending?: OptionsBoostBlendingValue;
  18659. /**
  18660. * (Highstock) Set the point threshold for when a series should enter boost
  18661. * mode.
  18662. *
  18663. * Setting it to e.g. 2000 will cause the series to enter boost mode when
  18664. * there are 2000 or more points in the series.
  18665. *
  18666. * To disable boosting on the series, set the `boostThreshold` to 0. Setting
  18667. * it to 1 will force boosting.
  18668. *
  18669. * Note that the cropThreshold also affects this setting. When zooming in on
  18670. * a series that has fewer points than the `cropThreshold`, all points are
  18671. * rendered although outside the visible plot area, and the `boostThreshold`
  18672. * won't take effect.
  18673. */
  18674. boostThreshold?: number;
  18675. /**
  18676. * (Highmaps) The border color of the map areas.
  18677. *
  18678. * In styled mode, the border stroke is given in the `.highcharts-point`
  18679. * class.
  18680. */
  18681. borderColor?: (ColorString|GradientColorObject|PatternObject);
  18682. /**
  18683. * (Highmaps) The border width of each map area.
  18684. *
  18685. * In styled mode, the border stroke width is given in the
  18686. * `.highcharts-point` class.
  18687. */
  18688. borderWidth?: number;
  18689. /**
  18690. * (Highstock) An additional class name to apply to the series' graphical
  18691. * elements. This option does not replace default class names of the
  18692. * graphical element.
  18693. */
  18694. className?: string;
  18695. /**
  18696. * (Highstock) Disable this option to allow series rendering in the whole
  18697. * plotting area.
  18698. *
  18699. * **Note:** Clipping should be always enabled when chart.zoomType is set
  18700. */
  18701. clip?: boolean;
  18702. /**
  18703. * (Highstock) The main color of the series. In line type series it applies
  18704. * to the line and the point markers unless otherwise specified. In bar type
  18705. * series it applies to the bars unless a color is specified per point. The
  18706. * default value is pulled from the `options.colors` array.
  18707. *
  18708. * In styled mode, the color can be defined by the colorIndex option. Also,
  18709. * the series color can be set with the `.highcharts-series`,
  18710. * `.highcharts-color-{n}`, `.highcharts-{type}-series` or
  18711. * `.highcharts-series-{n}` class, or individual classes given by the
  18712. * `className` option.
  18713. */
  18714. color?: (ColorString|GradientColorObject|PatternObject);
  18715. /**
  18716. * (Highstock) Styled mode only. A specific color index to use for the
  18717. * series, so its graphic representations are given the class name
  18718. * `highcharts-color-{n}`.
  18719. */
  18720. colorIndex?: number;
  18721. /**
  18722. * (Highcharts, Highstock, Highmaps) Determines what data value should be
  18723. * used to calculate point color if `colorAxis` is used. Requires to set
  18724. * `min` and `max` if some custom point property is used or if approximation
  18725. * for data grouping is set to `'sum'`.
  18726. */
  18727. colorKey?: string;
  18728. /**
  18729. * (Highstock) Compare the values of the series against the first non-null,
  18730. * non- zero value in the visible range. The y axis will show percentage or
  18731. * absolute change depending on whether `compare` is set to `"percent"` or
  18732. * `"value"`. When this is applied to multiple series, it allows comparing
  18733. * the development of the series against each other. Adds a `change` field
  18734. * to every point object.
  18735. */
  18736. compare?: string;
  18737. /**
  18738. * (Highstock) When compare is `percent`, this option dictates whether to
  18739. * use 0 or 100 as the base of comparison.
  18740. */
  18741. compareBase?: (0|100);
  18742. /**
  18743. * (Highstock) Defines if comparison should start from the first point
  18744. * within the visible range or should start from the first point **before**
  18745. * the range.
  18746. *
  18747. * In other words, this flag determines if first point within the visible
  18748. * range will have 0% (`compareStart=true`) or should have been already
  18749. * calculated according to the previous point (`compareStart=false`).
  18750. */
  18751. compareStart?: boolean;
  18752. /**
  18753. * (Highstock) Whether to compare indicator to the main series values or
  18754. * indicator values.
  18755. */
  18756. compareToMain?: boolean;
  18757. /**
  18758. * (Highcharts) Polar charts only. Whether to connect the ends of a line
  18759. * series plot across the extremes.
  18760. */
  18761. connectEnds?: boolean;
  18762. /**
  18763. * (Highcharts, Highstock) Whether to connect a graph line across null
  18764. * points, or render a gap between the two points on either side of the
  18765. * null.
  18766. */
  18767. connectNulls?: boolean;
  18768. /**
  18769. * (Gantt) Override Pathfinder connector options for a series. Requires
  18770. * Highcharts Gantt to be loaded.
  18771. */
  18772. connectors?: SeriesConnectorsOptionsObject;
  18773. /**
  18774. * (Highcharts, Highstock, Gantt) When true, each point or column edge is
  18775. * rounded to its nearest pixel in order to render sharp on screen. In some
  18776. * cases, when there are a lot of densely packed columns, this leads to
  18777. * visible difference in column widths or distance between columns. In these
  18778. * cases, setting `crisp` to `false` may look better, even though each
  18779. * column is rendered blurry.
  18780. */
  18781. crisp?: boolean;
  18782. /**
  18783. * (Highcharts, Highstock) When the series contains less points than the
  18784. * crop threshold, all points are drawn, even if the points fall outside the
  18785. * visible plot area at the current zoom. The advantage of drawing all
  18786. * points (including markers and columns), is that animation is performed on
  18787. * updates. On the other hand, when the series contains more points than the
  18788. * crop threshold, the series data is cropped to only contain points that
  18789. * fall within the plot area. The advantage of cropping away invisible
  18790. * points is to increase performance on large series.
  18791. */
  18792. cropThreshold?: number;
  18793. /**
  18794. * (Highstock) You can set the cursor to "pointer" if you have click events
  18795. * attached to the series, to signal to the user that the points and lines
  18796. * can be clicked.
  18797. *
  18798. * In styled mode, the series cursor can be set with the same classes as
  18799. * listed under series.color.
  18800. */
  18801. cursor?: (string|CursorValue);
  18802. /**
  18803. * (Highstock) A reserved subspace to store options and values for
  18804. * customized functionality. Here you can add additional data for your own
  18805. * event callbacks and formatter callbacks.
  18806. */
  18807. custom?: Dictionary<any>;
  18808. /**
  18809. * (Highstock) Name of the dash style to use for the graph, or for some
  18810. * series types the outline of each shape.
  18811. *
  18812. * In styled mode, the stroke dash-array can be set with the same classes as
  18813. * listed under series.color.
  18814. */
  18815. dashStyle?: DashStyleValue;
  18816. /**
  18817. * (Highstock) Data grouping is the concept of sampling the data values into
  18818. * larger blocks in order to ease readability and increase performance of
  18819. * the JavaScript charts. Highstock by default applies data grouping when
  18820. * the points become closer than a certain pixel value, determined by the
  18821. * `groupPixelWidth` option.
  18822. *
  18823. * If data grouping is applied, the grouping information of grouped points
  18824. * can be read from the Point.dataGroup. If point options other than the
  18825. * data itself are set, for example `name` or `color` or custom properties,
  18826. * the grouping logic doesn't know how to group it. In this case the options
  18827. * of the first point instance are copied over to the group point. This can
  18828. * be altered through a custom `approximation` callback function.
  18829. */
  18830. dataGrouping?: DataGroupingOptionsObject;
  18831. /**
  18832. * (Highcharts, Highstock, Highmaps, Gantt) Options for the series data
  18833. * labels, appearing next to each data point.
  18834. *
  18835. * Since v6.2.0, multiple data labels can be applied to each single point by
  18836. * defining them as an array of configs.
  18837. *
  18838. * In styled mode, the data labels can be styled with the
  18839. * `.highcharts-data-label-box` and `.highcharts-data-label` class names
  18840. * (see example).
  18841. */
  18842. dataLabels?: (PlotApoDataLabelsOptions|Array<PlotApoDataLabelsOptions>);
  18843. /**
  18844. * (Highcharts, Highstock) Options for the series data sorting.
  18845. */
  18846. dataSorting?: (DataSortingOptionsObject|PlotApoDataSortingOptions);
  18847. /**
  18848. * (Highstock) A description of the series to add to the screen reader
  18849. * information about the series.
  18850. */
  18851. description?: string;
  18852. /**
  18853. * (Highstock) Enable or disable the mouse tracking for a specific series.
  18854. * This includes point tooltips and click events on graphs and points. For
  18855. * large datasets it improves performance.
  18856. */
  18857. enableMouseTracking?: boolean;
  18858. /**
  18859. * (Highstock) General event handlers for the series items. These event
  18860. * hooks can also be attached to the series at run time using the
  18861. * `Highcharts.addEvent` function.
  18862. */
  18863. events?: SeriesEventsOptionsObject;
  18864. /**
  18865. * (Highstock) Determines whether the series should look for the nearest
  18866. * point in both dimensions or just the x-dimension when hovering the
  18867. * series. Defaults to `'xy'` for scatter series and `'x'` for most other
  18868. * series. If the data has duplicate x-values, it is recommended to set this
  18869. * to `'xy'` to allow hovering over all points.
  18870. *
  18871. * Applies only to series types using nearest neighbor search (not direct
  18872. * hover) for tooltip.
  18873. */
  18874. findNearestPointBy?: OptionsFindNearestPointByValue;
  18875. /**
  18876. * (Highstock) Defines when to display a gap in the graph, together with the
  18877. * gapUnit option.
  18878. *
  18879. * In case when `dataGrouping` is enabled, points can be grouped into a
  18880. * larger time span. This can make the grouped points to have a greater
  18881. * distance than the absolute value of `gapSize` property, which will result
  18882. * in disappearing graph completely. To prevent this situation the mentioned
  18883. * distance between grouped points is used instead of previously defined
  18884. * `gapSize`.
  18885. *
  18886. * In practice, this option is most often used to visualize gaps in time
  18887. * series. In a stock chart, intraday data is available for daytime hours,
  18888. * while gaps will appear in nights and weekends.
  18889. */
  18890. gapSize?: number;
  18891. /**
  18892. * (Highstock) Together with gapSize, this option defines where to draw gaps
  18893. * in the graph.
  18894. *
  18895. * When the `gapUnit` is `"relative"` (default), a gap size of 5 means that
  18896. * if the distance between two points is greater than 5 times that of the
  18897. * two closest points, the graph will be broken.
  18898. *
  18899. * When the `gapUnit` is `"value"`, the gap is based on absolute axis
  18900. * values, which on a datetime axis is milliseconds. This also applies to
  18901. * the navigator series that inherits gap options from the base series.
  18902. */
  18903. gapUnit?: OptionsGapUnitValue;
  18904. /**
  18905. * (Highcharts, Highstock, Gantt) Whether to use the Y extremes of the total
  18906. * chart width or only the zoomed area when zooming in on parts of the X
  18907. * axis. By default, the Y axis adjusts to the min and max of the visible
  18908. * data. Cartesian series only.
  18909. */
  18910. getExtremesFromAll?: boolean;
  18911. /**
  18912. * (Highstock) When set to `false` will prevent the series data from being
  18913. * included in any form of data export.
  18914. *
  18915. * Since version 6.0.0 until 7.1.0 the option was existing undocumented as
  18916. * `includeInCSVExport`.
  18917. */
  18918. includeInDataExport?: boolean;
  18919. /**
  18920. * (Highcharts, Highstock, Gantt) Series labels are placed as close to the
  18921. * series as possible in a natural way, seeking to avoid other series. The
  18922. * goal of this feature is to make the chart more easily readable, like if a
  18923. * human designer placed the labels in the optimal position.
  18924. *
  18925. * The series labels currently work with series types having a `graph` or an
  18926. * `area`.
  18927. */
  18928. label?: SeriesLabelOptionsObject;
  18929. /**
  18930. * (Highstock) The line marks the last price from all points.
  18931. */
  18932. lastPrice?: SeriesLastPriceOptionsObject;
  18933. /**
  18934. * (Highstock) The line marks the last price from visible range of points.
  18935. */
  18936. lastVisiblePrice?: SeriesLastVisiblePriceOptionsObject;
  18937. /**
  18938. * (Highcharts, Highstock) The SVG value used for the `stroke-linecap` and
  18939. * `stroke-linejoin` of a line graph. Round means that lines are rounded in
  18940. * the ends and bends.
  18941. */
  18942. linecap?: SeriesLinecapValue;
  18943. /**
  18944. * (Highcharts, Highstock) Pixel width of the graph line.
  18945. */
  18946. lineWidth?: number;
  18947. /**
  18948. * (Highcharts, Highstock, Gantt) The main series ID that indicator will be
  18949. * based on. Required for this indicator.
  18950. */
  18951. linkedTo?: string;
  18952. /**
  18953. * (Highstock) Options for the point markers of line-like series. Properties
  18954. * like `fillColor`, `lineColor` and `lineWidth` define the visual
  18955. * appearance of the markers. Other series types, like column series, don't
  18956. * have markers, but have visual options on the series level instead.
  18957. *
  18958. * In styled mode, the markers can be styled with the `.highcharts-point`,
  18959. * `.highcharts-point-hover` and `.highcharts-point-select` class names.
  18960. */
  18961. marker?: PointMarkerOptionsObject;
  18962. /**
  18963. * (Highstock) The name of the series as shown in the legend, tooltip etc.
  18964. * If not set, it will be based on a technical indicator type and default
  18965. * params.
  18966. */
  18967. name?: string;
  18968. /**
  18969. * (Highstock) The color for the parts of the graph or points that are below
  18970. * the threshold. Note that `zones` takes precedence over the negative
  18971. * color. Using `negativeColor` is equivalent to applying a zone with value
  18972. * of 0.
  18973. */
  18974. negativeColor?: (ColorString|GradientColorObject|PatternObject);
  18975. /**
  18976. * (Highstock) Opacity of a series parts: line, fill (e.g. area) and
  18977. * dataLabels.
  18978. */
  18979. opacity?: number;
  18980. /**
  18981. * (Highstock) Paramters used in calculation of Absolute Price Oscillator
  18982. * series points.
  18983. */
  18984. params?: PlotApoParamsOptions;
  18985. /**
  18986. * (Highstock) Properties for each single point.
  18987. */
  18988. point?: PlotSeriesPointOptions;
  18989. /**
  18990. * (Highstock) Same as accessibility.pointDescriptionFormatter, but for an
  18991. * individual series. Overrides the chart wide configuration.
  18992. */
  18993. pointDescriptionFormatter?: Function;
  18994. /**
  18995. * (Highstock) Whether to select the series initially. If `showCheckbox` is
  18996. * true, the checkbox next to the series name in the legend will be checked
  18997. * for a selected series.
  18998. */
  18999. selected?: boolean;
  19000. /**
  19001. * (Highstock) Whether to apply a drop shadow to the graph line. Since 2.3
  19002. * the shadow can be an object configuration containing `color`, `offsetX`,
  19003. * `offsetY`, `opacity` and `width`.
  19004. */
  19005. shadow?: (boolean|ShadowOptionsObject);
  19006. /**
  19007. * (Highstock) If true, a checkbox is displayed next to the legend item to
  19008. * allow selecting the series. The state of the checkbox is determined by
  19009. * the `selected` option.
  19010. */
  19011. showCheckbox?: boolean;
  19012. /**
  19013. * (Highstock) Whether to display this particular series or series type in
  19014. * the legend. Standalone series are shown in legend by default, and linked
  19015. * series are not. Since v7.2.0 it is possible to show series that use
  19016. * colorAxis by setting this option to `true`.
  19017. */
  19018. showInLegend?: boolean;
  19019. /**
  19020. * (Highstock) If set to `true`, the accessibility module will skip past the
  19021. * points in this series for keyboard navigation.
  19022. */
  19023. skipKeyboardNavigation?: boolean;
  19024. /**
  19025. * (Highcharts, Highstock) When this is true, the series will not cause the
  19026. * Y axis to cross the zero plane (or threshold option) unless the data
  19027. * actually crosses the plane.
  19028. *
  19029. * For example, if `softThreshold` is `false`, a series of 0, 1, 2, 3 will
  19030. * make the Y axis show negative values according to the `minPadding`
  19031. * option. If `softThreshold` is `true`, the Y axis starts at 0.
  19032. */
  19033. softThreshold?: boolean;
  19034. states?: SeriesStatesOptionsObject;
  19035. /**
  19036. * (Highcharts, Highstock) Whether to apply steps to the line. Possible
  19037. * values are `left`, `center` and `right`.
  19038. */
  19039. step?: OptionsStepValue;
  19040. /**
  19041. * (Highstock) Sticky tracking of mouse events. When true, the `mouseOut`
  19042. * event on a series isn't triggered until the mouse moves over another
  19043. * series, or out of the plot area. When false, the `mouseOut` event on a
  19044. * series is triggered when the mouse leaves the area around the series'
  19045. * graph or markers. This also implies the tooltip when not shared. When
  19046. * `stickyTracking` is false and `tooltip.shared` is false, the tooltip will
  19047. * be hidden when moving the mouse between series. Defaults to true for line
  19048. * and area type series, but to false for columns, pies etc.
  19049. *
  19050. * **Note:** The boost module will force this option because of technical
  19051. * limitations.
  19052. */
  19053. stickyTracking?: boolean;
  19054. /**
  19055. * (Highcharts, Highstock) The threshold, also called zero level or base
  19056. * level. For line type series this is only used in conjunction with
  19057. * negativeColor.
  19058. */
  19059. threshold?: (number|null);
  19060. /**
  19061. * (Highstock) A configuration object for the tooltip rendering of each
  19062. * single series. Properties are inherited from tooltip, but only the
  19063. * following properties can be defined on a series level.
  19064. */
  19065. tooltip?: SeriesTooltipOptionsObject;
  19066. /**
  19067. * (Highcharts, Highstock, Gantt) When a series contains a data array that
  19068. * is longer than this, only one dimensional arrays of numbers, or two
  19069. * dimensional arrays with x and y values are allowed. Also, only the first
  19070. * point is tested, and the rest are assumed to be the same format. This
  19071. * saves expensive data checking and indexing in long series. Set it to `0`
  19072. * disable.
  19073. *
  19074. * Note: In boost mode turbo threshold is forced. Only array of numbers or
  19075. * two dimensional arrays are allowed.
  19076. */
  19077. turboThreshold?: number;
  19078. /**
  19079. * (Highstock) Set the initial visibility of the series.
  19080. */
  19081. visible?: boolean;
  19082. /**
  19083. * (Highmaps) Define the z index of the series.
  19084. */
  19085. zIndex?: number;
  19086. /**
  19087. * (Highcharts, Highstock) Defines the Axis on which the zones are applied.
  19088. */
  19089. zoneAxis?: string;
  19090. /**
  19091. * (Highcharts, Highstock) An array defining zones within a series. Zones
  19092. * can be applied to the X axis, Y axis or Z axis for bubbles, according to
  19093. * the `zoneAxis` option. The zone definitions have to be in ascending order
  19094. * regarding to the value.
  19095. *
  19096. * In styled mode, the color zones are styled with the
  19097. * `.highcharts-zone-{n}` class, or custom classed from the `className`
  19098. * option (view live demo).
  19099. */
  19100. zones?: Array<SeriesZonesOptionsObject>;
  19101. }
  19102. /**
  19103. * (Highstock) Paramters used in calculation of Absolute Price Oscillator series
  19104. * points.
  19105. */
  19106. export interface PlotApoParamsOptions {
  19107. /**
  19108. * (Highstock) The point index which indicator calculations will base. For
  19109. * example using OHLC data, index=2 means the indicator will be calculated
  19110. * using Low values.
  19111. *
  19112. * By default index value used to be set to 0. Since Highstock 7 by default
  19113. * index is set to 3 which means that the ema indicator will be calculated
  19114. * using Close values.
  19115. */
  19116. index?: number;
  19117. /**
  19118. * (Highstock) Periods for Absolute Price Oscillator calculations.
  19119. */
  19120. periods?: Array<number>;
  19121. }
  19122. /**
  19123. * (Highcharts, Highstock) Enable or disable the initial animation when a series
  19124. * is displayed. The animation can also be set as a configuration object. Please
  19125. * note that this option only applies to the initial animation of the series
  19126. * itself. For other animations, see chart.animation and the animation parameter
  19127. * under the API methods. The following properties are supported:
  19128. *
  19129. * - `defer`: The animation delay time in milliseconds.
  19130. *
  19131. * - `duration`: The duration of the animation in milliseconds.
  19132. *
  19133. * - `easing`: Can be a string reference to an easing function set on the `Math`
  19134. * object or a function. See the _Custom easing function_ demo below.
  19135. *
  19136. * Due to poor performance, animation is disabled in old IE browsers for several
  19137. * chart types.
  19138. */
  19139. export interface PlotAreaAnimationOptions {
  19140. defer?: number;
  19141. }
  19142. /**
  19143. * (Highcharts, Highstock, Highmaps, Gantt) Enable or disable the initial
  19144. * animation when a series is displayed for the `dataLabels`. The animation can
  19145. * also be set as a configuration object. Please note that this option only
  19146. * applies to the initial animation. For other animations, see chart.animation
  19147. * and the animation parameter under the API methods. The following properties
  19148. * are supported:
  19149. *
  19150. * - `defer`: The animation delay time in milliseconds.
  19151. */
  19152. export interface PlotAreaDataLabelsAnimationOptions {
  19153. /**
  19154. * (Highcharts, Highstock, Highmaps, Gantt) The animation delay time in
  19155. * milliseconds. Set to `0` renders dataLabel immediately. As `undefined`
  19156. * inherits defer time from the series.animation.defer.
  19157. */
  19158. defer?: number;
  19159. }
  19160. /**
  19161. * (Highcharts, Highstock, Highmaps, Gantt) Options for the series data labels,
  19162. * appearing next to each data point.
  19163. *
  19164. * Since v6.2.0, multiple data labels can be applied to each single point by
  19165. * defining them as an array of configs.
  19166. *
  19167. * In styled mode, the data labels can be styled with the
  19168. * `.highcharts-data-label-box` and `.highcharts-data-label` class names (see
  19169. * example).
  19170. */
  19171. export interface PlotAreaDataLabelsOptions {
  19172. /**
  19173. * (Highcharts, Highstock, Highmaps, Gantt) The alignment of the data label
  19174. * compared to the point. If `right`, the right side of the label should be
  19175. * touching the point. For points with an extent, like columns, the
  19176. * alignments also dictates how to align it inside the box, as given with
  19177. * the inside option. Can be one of `left`, `center` or `right`.
  19178. */
  19179. align?: (AlignValue|null);
  19180. /**
  19181. * (Highcharts, Highstock, Highmaps, Gantt) Whether to allow data labels to
  19182. * overlap. To make the labels less sensitive for overlapping, the
  19183. * dataLabels.padding can be set to 0.
  19184. */
  19185. allowOverlap?: boolean;
  19186. /**
  19187. * (Highcharts, Highstock, Highmaps, Gantt) Enable or disable the initial
  19188. * animation when a series is displayed for the `dataLabels`. The animation
  19189. * can also be set as a configuration object. Please note that this option
  19190. * only applies to the initial animation. For other animations, see
  19191. * chart.animation and the animation parameter under the API methods. The
  19192. * following properties are supported:
  19193. *
  19194. * - `defer`: The animation delay time in milliseconds.
  19195. */
  19196. animation?: (boolean|PlotAreaDataLabelsAnimationOptions|Partial<AnimationOptionsObject>);
  19197. /**
  19198. * (Highcharts, Highstock, Highmaps, Gantt) The background color or gradient
  19199. * for the data label.
  19200. */
  19201. backgroundColor?: (ColorString|GradientColorObject|PatternObject);
  19202. /**
  19203. * (Highcharts, Highstock, Highmaps, Gantt) The border color for the data
  19204. * label. Defaults to `undefined`.
  19205. */
  19206. borderColor?: (ColorString|GradientColorObject|PatternObject);
  19207. /**
  19208. * (Highcharts, Highstock, Highmaps, Gantt) The border radius in pixels for
  19209. * the data label.
  19210. */
  19211. borderRadius?: number;
  19212. /**
  19213. * (Highcharts, Highstock, Highmaps, Gantt) The border width in pixels for
  19214. * the data label.
  19215. */
  19216. borderWidth?: number;
  19217. /**
  19218. * (Highcharts, Highstock, Highmaps, Gantt) A class name for the data label.
  19219. * Particularly in styled mode, this can be used to give each series' or
  19220. * point's data label unique styling. In addition to this option, a default
  19221. * color class name is added so that we can give the labels a contrast text
  19222. * shadow.
  19223. */
  19224. className?: string;
  19225. /**
  19226. * (Highcharts, Highstock, Highmaps, Gantt) The text color for the data
  19227. * labels. Defaults to `undefined`. For certain series types, like column or
  19228. * map, the data labels can be drawn inside the points. In this case the
  19229. * data label will be drawn with maximum contrast by default. Additionally,
  19230. * it will be given a `text-outline` style with the opposite color, to
  19231. * further increase the contrast. This can be overridden by setting the
  19232. * `text-outline` style to `none` in the `dataLabels.style` option.
  19233. */
  19234. color?: (ColorString|GradientColorObject|PatternObject);
  19235. /**
  19236. * (Highcharts, Highstock, Highmaps, Gantt) Whether to hide data labels that
  19237. * are outside the plot area. By default, the data label is moved inside the
  19238. * plot area according to the overflow option.
  19239. */
  19240. crop?: boolean;
  19241. /**
  19242. * (Highcharts, Highstock, Gantt) Whether to defer displaying the data
  19243. * labels until the initial series animation has finished. Setting to
  19244. * `false` renders the data label immediately. If set to `true` inherits the
  19245. * defer time set in plotOptions.series.animation.
  19246. */
  19247. defer?: boolean;
  19248. /**
  19249. * (Highcharts, Highstock, Highmaps, Gantt) Enable or disable the data
  19250. * labels.
  19251. */
  19252. enabled?: boolean;
  19253. /**
  19254. * (Highcharts, Highstock, Highmaps, Gantt) A declarative filter to control
  19255. * of which data labels to display. The declarative filter is designed for
  19256. * use when callback functions are not available, like when the chart
  19257. * options require a pure JSON structure or for use with graphical editors.
  19258. * For programmatic control, use the `formatter` instead, and return
  19259. * `undefined` to disable a single data label.
  19260. */
  19261. filter?: DataLabelsFilterOptionsObject;
  19262. /**
  19263. * (Highcharts, Highstock, Highmaps, Gantt) A format string for the data
  19264. * label. Available variables are the same as for `formatter`.
  19265. */
  19266. format?: string;
  19267. /**
  19268. * (Highcharts, Highstock, Highmaps, Gantt) Callback JavaScript function to
  19269. * format the data label. Note that if a `format` is defined, the format
  19270. * takes precedence and the formatter is ignored.
  19271. */
  19272. formatter?: DataLabelsFormatterCallbackFunction;
  19273. /**
  19274. * (Highcharts, Highstock, Highmaps, Gantt) For points with an extent, like
  19275. * columns or map areas, whether to align the data label inside the box or
  19276. * to the actual value point. Defaults to `false` in most cases, `true` in
  19277. * stacked columns.
  19278. */
  19279. inside?: boolean;
  19280. /**
  19281. * (Highcharts, Highstock, Highmaps, Gantt) Format for points with the value
  19282. * of null. Works analogously to format. `nullFormat` can be applied only to
  19283. * series which support displaying null points.
  19284. */
  19285. nullFormat?: (boolean|string);
  19286. /**
  19287. * (Highcharts, Highstock, Highmaps, Gantt) Callback JavaScript function
  19288. * that defines formatting for points with the value of null. Works
  19289. * analogously to formatter. `nullPointFormatter` can be applied only to
  19290. * series which support displaying null points.
  19291. */
  19292. nullFormatter?: DataLabelsFormatterCallbackFunction;
  19293. /**
  19294. * (Highcharts, Highstock, Highmaps, Gantt) How to handle data labels that
  19295. * flow outside the plot area. The default is `"justify"`, which aligns them
  19296. * inside the plot area. For columns and bars, this means it will be moved
  19297. * inside the bar. To display data labels outside the plot area, set `crop`
  19298. * to `false` and `overflow` to `"allow"`.
  19299. */
  19300. overflow?: DataLabelsOverflowValue;
  19301. /**
  19302. * (Highcharts, Highstock, Highmaps, Gantt) When either the `borderWidth` or
  19303. * the `backgroundColor` is set, this is the padding within the box.
  19304. */
  19305. padding?: number;
  19306. /**
  19307. * (Highcharts, Highstock, Highmaps, Gantt) Aligns data labels relative to
  19308. * points. If `center` alignment is not possible, it defaults to `right`.
  19309. */
  19310. position?: AlignValue;
  19311. /**
  19312. * (Highcharts, Highstock, Highmaps, Gantt) Text rotation in degrees. Note
  19313. * that due to a more complex structure, backgrounds, borders and padding
  19314. * will be lost on a rotated data label.
  19315. */
  19316. rotation?: number;
  19317. /**
  19318. * (Highcharts, Highstock, Highmaps, Gantt) The shadow of the box. Works
  19319. * best with `borderWidth` or `backgroundColor`. Since 2.3 the shadow can be
  19320. * an object configuration containing `color`, `offsetX`, `offsetY`,
  19321. * `opacity` and `width`.
  19322. */
  19323. shadow?: (boolean|ShadowOptionsObject);
  19324. /**
  19325. * (Highcharts, Highstock, Highmaps, Gantt) The name of a symbol to use for
  19326. * the border around the label. Symbols are predefined functions on the
  19327. * Renderer object.
  19328. */
  19329. shape?: string;
  19330. /**
  19331. * (Highcharts, Highstock, Highmaps, Gantt) Styles for the label. The
  19332. * default `color` setting is `"contrast"`, which is a pseudo color that
  19333. * Highcharts picks up and applies the maximum contrast to the underlying
  19334. * point item, for example the bar in a bar chart.
  19335. *
  19336. * The `textOutline` is a pseudo property that applies an outline of the
  19337. * given width with the given color, which by default is the maximum
  19338. * contrast to the text. So a bright text color will result in a black text
  19339. * outline for maximum readability on a mixed background. In some cases,
  19340. * especially with grayscale text, the text outline doesn't work well, in
  19341. * which cases it can be disabled by setting it to `"none"`. When `useHTML`
  19342. * is true, the `textOutline` will not be picked up. In this, case, the same
  19343. * effect can be acheived through the `text-shadow` CSS property.
  19344. *
  19345. * For some series types, where each point has an extent, like for example
  19346. * tree maps, the data label may overflow the point. There are two
  19347. * strategies for handling overflow. By default, the text will wrap to
  19348. * multiple lines. The other strategy is to set `style.textOverflow` to
  19349. * `ellipsis`, which will keep the text on one line plus it will break
  19350. * inside long words.
  19351. */
  19352. style?: CSSObject;
  19353. /**
  19354. * (Highcharts, Highstock, Highmaps, Gantt) Options for a label text which
  19355. * should follow marker's shape. Border and background are disabled for a
  19356. * label that follows a path.
  19357. *
  19358. * **Note:** Only SVG-based renderer supports this option. Setting `useHTML`
  19359. * to true will disable this option.
  19360. */
  19361. textPath?: DataLabelsTextPathOptionsObject;
  19362. /**
  19363. * (Highcharts, Highstock, Highmaps, Gantt) Whether to use HTML to render
  19364. * the labels.
  19365. */
  19366. useHTML?: boolean;
  19367. /**
  19368. * (Highcharts, Highstock, Highmaps, Gantt) The vertical alignment of a data
  19369. * label. Can be one of `top`, `middle` or `bottom`. The default value
  19370. * depends on the data, for instance in a column chart, the label is above
  19371. * positive values and below negative values.
  19372. */
  19373. verticalAlign?: (VerticalAlignValue|null);
  19374. /**
  19375. * (Highcharts, Highstock, Highmaps, Gantt) The x position offset of the
  19376. * label relative to the point in pixels.
  19377. */
  19378. x?: number;
  19379. /**
  19380. * (Highcharts, Highstock, Highmaps, Gantt) The y position offset of the
  19381. * label relative to the point in pixels.
  19382. */
  19383. y?: number;
  19384. /**
  19385. * (Highcharts, Highstock, Highmaps, Gantt) The Z index of the data labels.
  19386. * The default Z index puts it above the series. Use a Z index of 2 to
  19387. * display it behind the series.
  19388. */
  19389. z?: number;
  19390. }
  19391. /**
  19392. * (Highcharts, Highstock) Options for the series data sorting.
  19393. */
  19394. export interface PlotAreaDataSortingOptions {
  19395. /**
  19396. * (Highcharts, Highstock) Enable or disable data sorting for the series.
  19397. * Use xAxis.reversed to change the sorting order.
  19398. */
  19399. enabled?: boolean;
  19400. /**
  19401. * (Highcharts, Highstock) Whether to allow matching points by name in an
  19402. * update. If this option is disabled, points will be matched by order.
  19403. */
  19404. matchByName?: boolean;
  19405. /**
  19406. * (Highcharts, Highstock) Determines what data value should be used to sort
  19407. * by.
  19408. */
  19409. sortKey?: string;
  19410. }
  19411. /**
  19412. * (Highcharts, Highstock) Style options for the guide box. The guide box has
  19413. * one state by default, the `default` state.
  19414. */
  19415. export interface PlotAreaDragDropGuideBoxOptions {
  19416. /**
  19417. * (Highcharts, Highstock) Style options for the guide box default state.
  19418. */
  19419. default?: DragDropGuideBoxOptionsObject;
  19420. }
  19421. /**
  19422. * (Highcharts, Highstock) The area series type.
  19423. *
  19424. * In TypeScript the type option must always be set.
  19425. *
  19426. * Configuration options for the series are given in three levels:
  19427. *
  19428. * 1. Options for all series in a chart are defined in the plotOptions.series
  19429. * object.
  19430. *
  19431. * 2. Options for all `area` series are defined in plotOptions.area.
  19432. *
  19433. * 3. Options for one single series are given in the series instance array. (see
  19434. * online documentation for example)
  19435. */
  19436. export interface PlotAreaOptions {
  19437. /**
  19438. * (Highcharts, Highstock) Accessibility options for a series.
  19439. */
  19440. accessibility?: SeriesAccessibilityOptionsObject;
  19441. /**
  19442. * (Highmaps) Whether all areas of the map defined in `mapData` should be
  19443. * rendered. If `true`, areas which don't correspond to a data point, are
  19444. * rendered as `null` points. If `false`, those areas are skipped.
  19445. */
  19446. allAreas?: boolean;
  19447. /**
  19448. * (Highcharts, Highstock) Allow this series' points to be selected by
  19449. * clicking on the graphic (columns, point markers, pie slices, map areas
  19450. * etc).
  19451. *
  19452. * The selected points can be handled by point select and unselect events,
  19453. * or collectively by the getSelectedPoints function.
  19454. *
  19455. * And alternative way of selecting points is through dragging.
  19456. */
  19457. allowPointSelect?: boolean;
  19458. /**
  19459. * (Highcharts, Highstock) Enable or disable the initial animation when a
  19460. * series is displayed. The animation can also be set as a configuration
  19461. * object. Please note that this option only applies to the initial
  19462. * animation of the series itself. For other animations, see chart.animation
  19463. * and the animation parameter under the API methods. The following
  19464. * properties are supported:
  19465. *
  19466. * - `defer`: The animation delay time in milliseconds.
  19467. *
  19468. * - `duration`: The duration of the animation in milliseconds.
  19469. *
  19470. * - `easing`: Can be a string reference to an easing function set on the
  19471. * `Math` object or a function. See the _Custom easing function_ demo below.
  19472. *
  19473. * Due to poor performance, animation is disabled in old IE browsers for
  19474. * several chart types.
  19475. */
  19476. animation?: (boolean|PlotAreaAnimationOptions|Partial<AnimationOptionsObject>);
  19477. /**
  19478. * (Highcharts, Highstock) For some series, there is a limit that shuts down
  19479. * initial animation by default when the total number of points in the chart
  19480. * is too high. For example, for a column chart and its derivatives,
  19481. * animation does not run if there is more than 250 points totally. To
  19482. * disable this cap, set `animationLimit` to `Infinity`.
  19483. */
  19484. animationLimit?: number;
  19485. /**
  19486. * (Highcharts, Highstock) Sets the color blending in the boost module.
  19487. */
  19488. boostBlending?: OptionsBoostBlendingValue;
  19489. /**
  19490. * (Highcharts, Highstock) Set the point threshold for when a series should
  19491. * enter boost mode.
  19492. *
  19493. * Setting it to e.g. 2000 will cause the series to enter boost mode when
  19494. * there are 2000 or more points in the series.
  19495. *
  19496. * To disable boosting on the series, set the `boostThreshold` to 0. Setting
  19497. * it to 1 will force boosting.
  19498. *
  19499. * Note that the cropThreshold also affects this setting. When zooming in on
  19500. * a series that has fewer points than the `cropThreshold`, all points are
  19501. * rendered although outside the visible plot area, and the `boostThreshold`
  19502. * won't take effect.
  19503. */
  19504. boostThreshold?: number;
  19505. /**
  19506. * (Highmaps) The border color of the map areas.
  19507. *
  19508. * In styled mode, the border stroke is given in the `.highcharts-point`
  19509. * class.
  19510. */
  19511. borderColor?: (ColorString|GradientColorObject|PatternObject);
  19512. /**
  19513. * (Highmaps) The border width of each map area.
  19514. *
  19515. * In styled mode, the border stroke width is given in the
  19516. * `.highcharts-point` class.
  19517. */
  19518. borderWidth?: number;
  19519. /**
  19520. * (Highcharts, Highstock) An additional class name to apply to the series'
  19521. * graphical elements. This option does not replace default class names of
  19522. * the graphical element.
  19523. */
  19524. className?: string;
  19525. /**
  19526. * (Highcharts, Highstock) Disable this option to allow series rendering in
  19527. * the whole plotting area.
  19528. *
  19529. * **Note:** Clipping should be always enabled when chart.zoomType is set
  19530. */
  19531. clip?: boolean;
  19532. /**
  19533. * (Highcharts, Highstock) The main color of the series. In line type series
  19534. * it applies to the line and the point markers unless otherwise specified.
  19535. * In bar type series it applies to the bars unless a color is specified per
  19536. * point. The default value is pulled from the `options.colors` array.
  19537. *
  19538. * In styled mode, the color can be defined by the colorIndex option. Also,
  19539. * the series color can be set with the `.highcharts-series`,
  19540. * `.highcharts-color-{n}`, `.highcharts-{type}-series` or
  19541. * `.highcharts-series-{n}` class, or individual classes given by the
  19542. * `className` option.
  19543. */
  19544. color?: (ColorString|GradientColorObject|PatternObject);
  19545. /**
  19546. * (Highcharts, Highstock, Highmaps) When using dual or multiple color axes,
  19547. * this number defines which colorAxis the particular series is connected
  19548. * to. It refers to either the axis id or the index of the axis in the
  19549. * colorAxis array, with 0 being the first. Set this option to false to
  19550. * prevent a series from connecting to the default color axis.
  19551. *
  19552. * Since v7.2.0 the option can also be an axis id or an axis index instead
  19553. * of a boolean flag.
  19554. */
  19555. colorAxis?: (boolean|number|string);
  19556. /**
  19557. * (Highcharts, Highstock) Styled mode only. A specific color index to use
  19558. * for the series, so its graphic representations are given the class name
  19559. * `highcharts-color-{n}`.
  19560. */
  19561. colorIndex?: number;
  19562. /**
  19563. * (Highcharts, Highstock, Highmaps) Determines what data value should be
  19564. * used to calculate point color if `colorAxis` is used. Requires to set
  19565. * `min` and `max` if some custom point property is used or if approximation
  19566. * for data grouping is set to `'sum'`.
  19567. */
  19568. colorKey?: string;
  19569. /**
  19570. * (Highstock) Compare the values of the series against the first non-null,
  19571. * non- zero value in the visible range. The y axis will show percentage or
  19572. * absolute change depending on whether `compare` is set to `"percent"` or
  19573. * `"value"`. When this is applied to multiple series, it allows comparing
  19574. * the development of the series against each other. Adds a `change` field
  19575. * to every point object.
  19576. */
  19577. compare?: string;
  19578. /**
  19579. * (Highstock) When compare is `percent`, this option dictates whether to
  19580. * use 0 or 100 as the base of comparison.
  19581. */
  19582. compareBase?: (0|100);
  19583. /**
  19584. * (Highstock) Defines if comparison should start from the first point
  19585. * within the visible range or should start from the first point **before**
  19586. * the range.
  19587. *
  19588. * In other words, this flag determines if first point within the visible
  19589. * range will have 0% (`compareStart=true`) or should have been already
  19590. * calculated according to the previous point (`compareStart=false`).
  19591. */
  19592. compareStart?: boolean;
  19593. /**
  19594. * (Highcharts) Polar charts only. Whether to connect the ends of a line
  19595. * series plot across the extremes.
  19596. */
  19597. connectEnds?: boolean;
  19598. /**
  19599. * (Highcharts, Highstock) Whether to connect a graph line across null
  19600. * points, or render a gap between the two points on either side of the
  19601. * null.
  19602. */
  19603. connectNulls?: boolean;
  19604. /**
  19605. * (Gantt) Override Pathfinder connector options for a series. Requires
  19606. * Highcharts Gantt to be loaded.
  19607. */
  19608. connectors?: SeriesConnectorsOptionsObject;
  19609. /**
  19610. * (Highcharts, Highstock, Gantt) When true, each point or column edge is
  19611. * rounded to its nearest pixel in order to render sharp on screen. In some
  19612. * cases, when there are a lot of densely packed columns, this leads to
  19613. * visible difference in column widths or distance between columns. In these
  19614. * cases, setting `crisp` to `false` may look better, even though each
  19615. * column is rendered blurry.
  19616. */
  19617. crisp?: boolean;
  19618. /**
  19619. * (Highcharts, Highstock) When the series contains less points than the
  19620. * crop threshold, all points are drawn, even if the points fall outside the
  19621. * visible plot area at the current zoom. The advantage of drawing all
  19622. * points (including markers and columns), is that animation is performed on
  19623. * updates. On the other hand, when the series contains more points than the
  19624. * crop threshold, the series data is cropped to only contain points that
  19625. * fall within the plot area. The advantage of cropping away invisible
  19626. * points is to increase performance on large series.
  19627. */
  19628. cropThreshold?: number;
  19629. /**
  19630. * (Highcharts, Highstock) You can set the cursor to "pointer" if you have
  19631. * click events attached to the series, to signal to the user that the
  19632. * points and lines can be clicked.
  19633. *
  19634. * In styled mode, the series cursor can be set with the same classes as
  19635. * listed under series.color.
  19636. */
  19637. cursor?: (string|CursorValue);
  19638. /**
  19639. * (Highcharts, Highstock) A reserved subspace to store options and values
  19640. * for customized functionality. Here you can add additional data for your
  19641. * own event callbacks and formatter callbacks.
  19642. */
  19643. custom?: Dictionary<any>;
  19644. /**
  19645. * (Highcharts, Highstock) Name of the dash style to use for the graph, or
  19646. * for some series types the outline of each shape.
  19647. *
  19648. * In styled mode, the stroke dash-array can be set with the same classes as
  19649. * listed under series.color.
  19650. */
  19651. dashStyle?: DashStyleValue;
  19652. /**
  19653. * (Highstock) Data grouping is the concept of sampling the data values into
  19654. * larger blocks in order to ease readability and increase performance of
  19655. * the JavaScript charts. Highstock by default applies data grouping when
  19656. * the points become closer than a certain pixel value, determined by the
  19657. * `groupPixelWidth` option.
  19658. *
  19659. * If data grouping is applied, the grouping information of grouped points
  19660. * can be read from the Point.dataGroup. If point options other than the
  19661. * data itself are set, for example `name` or `color` or custom properties,
  19662. * the grouping logic doesn't know how to group it. In this case the options
  19663. * of the first point instance are copied over to the group point. This can
  19664. * be altered through a custom `approximation` callback function.
  19665. */
  19666. dataGrouping?: DataGroupingOptionsObject;
  19667. /**
  19668. * (Highcharts, Highstock, Highmaps, Gantt) Options for the series data
  19669. * labels, appearing next to each data point.
  19670. *
  19671. * Since v6.2.0, multiple data labels can be applied to each single point by
  19672. * defining them as an array of configs.
  19673. *
  19674. * In styled mode, the data labels can be styled with the
  19675. * `.highcharts-data-label-box` and `.highcharts-data-label` class names
  19676. * (see example).
  19677. */
  19678. dataLabels?: (PlotAreaDataLabelsOptions|Array<PlotAreaDataLabelsOptions>);
  19679. /**
  19680. * (Highcharts, Highstock) Options for the series data sorting.
  19681. */
  19682. dataSorting?: (DataSortingOptionsObject|PlotAreaDataSortingOptions);
  19683. /**
  19684. * (Highcharts, Highstock) A description of the series to add to the screen
  19685. * reader information about the series.
  19686. */
  19687. description?: string;
  19688. /**
  19689. * (Highcharts, Highstock) The draggable-points module allows points to be
  19690. * moved around or modified in the chart. In addition to the options
  19691. * mentioned under the `dragDrop` API structure, the module fires three
  19692. * events, point.dragStart, point.drag and point.drop.
  19693. */
  19694. dragDrop?: SeriesDragDropOptionsObject;
  19695. /**
  19696. * (Highcharts, Highstock) Enable or disable the mouse tracking for a
  19697. * specific series. This includes point tooltips and click events on graphs
  19698. * and points. For large datasets it improves performance.
  19699. */
  19700. enableMouseTracking?: boolean;
  19701. /**
  19702. * (Highcharts, Highstock) General event handlers for the series items.
  19703. * These event hooks can also be attached to the series at run time using
  19704. * the `Highcharts.addEvent` function.
  19705. */
  19706. events?: SeriesEventsOptionsObject;
  19707. /**
  19708. * (Highcharts, Highstock) Fill color or gradient for the area. When `null`,
  19709. * the series' `color` is used with the series' `fillOpacity`.
  19710. *
  19711. * In styled mode, the fill color can be set with the `.highcharts-area`
  19712. * class name.
  19713. */
  19714. fillColor?: (ColorString|GradientColorObject|PatternObject);
  19715. /**
  19716. * (Highcharts, Highstock) Fill opacity for the area. When you set an
  19717. * explicit `fillColor`, the `fillOpacity` is not applied. Instead, you
  19718. * should define the opacity in the `fillColor` with an rgba color
  19719. * definition. The `fillOpacity` setting, also the default setting,
  19720. * overrides the alpha component of the `color` setting.
  19721. *
  19722. * In styled mode, the fill opacity can be set with the `.highcharts-area`
  19723. * class name.
  19724. */
  19725. fillOpacity?: number;
  19726. /**
  19727. * (Highcharts, Highstock) Determines whether the series should look for the
  19728. * nearest point in both dimensions or just the x-dimension when hovering
  19729. * the series. Defaults to `'xy'` for scatter series and `'x'` for most
  19730. * other series. If the data has duplicate x-values, it is recommended to
  19731. * set this to `'xy'` to allow hovering over all points.
  19732. *
  19733. * Applies only to series types using nearest neighbor search (not direct
  19734. * hover) for tooltip.
  19735. */
  19736. findNearestPointBy?: OptionsFindNearestPointByValue;
  19737. /**
  19738. * (Highstock) Defines when to display a gap in the graph, together with the
  19739. * gapUnit option.
  19740. *
  19741. * In case when `dataGrouping` is enabled, points can be grouped into a
  19742. * larger time span. This can make the grouped points to have a greater
  19743. * distance than the absolute value of `gapSize` property, which will result
  19744. * in disappearing graph completely. To prevent this situation the mentioned
  19745. * distance between grouped points is used instead of previously defined
  19746. * `gapSize`.
  19747. *
  19748. * In practice, this option is most often used to visualize gaps in time
  19749. * series. In a stock chart, intraday data is available for daytime hours,
  19750. * while gaps will appear in nights and weekends.
  19751. */
  19752. gapSize?: number;
  19753. /**
  19754. * (Highstock) Together with gapSize, this option defines where to draw gaps
  19755. * in the graph.
  19756. *
  19757. * When the `gapUnit` is `"relative"` (default), a gap size of 5 means that
  19758. * if the distance between two points is greater than 5 times that of the
  19759. * two closest points, the graph will be broken.
  19760. *
  19761. * When the `gapUnit` is `"value"`, the gap is based on absolute axis
  19762. * values, which on a datetime axis is milliseconds. This also applies to
  19763. * the navigator series that inherits gap options from the base series.
  19764. */
  19765. gapUnit?: OptionsGapUnitValue;
  19766. /**
  19767. * (Highcharts, Highstock, Gantt) Whether to use the Y extremes of the total
  19768. * chart width or only the zoomed area when zooming in on parts of the X
  19769. * axis. By default, the Y axis adjusts to the min and max of the visible
  19770. * data. Cartesian series only.
  19771. */
  19772. getExtremesFromAll?: boolean;
  19773. /**
  19774. * (Highcharts, Highstock) When set to `false` will prevent the series data
  19775. * from being included in any form of data export.
  19776. *
  19777. * Since version 6.0.0 until 7.1.0 the option was existing undocumented as
  19778. * `includeInCSVExport`.
  19779. */
  19780. includeInDataExport?: boolean;
  19781. /**
  19782. * (Highmaps) What property to join the `mapData` to the value data. For
  19783. * example, if joinBy is "code", the mapData items with a specific code is
  19784. * merged into the data with the same code. For maps loaded from GeoJSON,
  19785. * the keys may be held in each point's `properties` object.
  19786. *
  19787. * The joinBy option can also be an array of two values, where the first
  19788. * points to a key in the `mapData`, and the second points to another key in
  19789. * the `data`.
  19790. *
  19791. * When joinBy is `null`, the map items are joined by their position in the
  19792. * array, which performs much better in maps with many data points. This is
  19793. * the recommended option if you are printing more than a thousand data
  19794. * points and have a backend that can preprocess the data into a parallel
  19795. * array of the mapData.
  19796. */
  19797. joinBy?: (string|Array<string>);
  19798. /**
  19799. * (Highcharts, Highstock) An array specifying which option maps to which
  19800. * key in the data point array. This makes it convenient to work with
  19801. * unstructured data arrays from different sources.
  19802. */
  19803. keys?: Array<string>;
  19804. /**
  19805. * (Highcharts, Highstock, Gantt) Series labels are placed as close to the
  19806. * series as possible in a natural way, seeking to avoid other series. The
  19807. * goal of this feature is to make the chart more easily readable, like if a
  19808. * human designer placed the labels in the optimal position.
  19809. *
  19810. * The series labels currently work with series types having a `graph` or an
  19811. * `area`.
  19812. */
  19813. label?: SeriesLabelOptionsObject;
  19814. /**
  19815. * (Highstock) The line marks the last price from all points.
  19816. */
  19817. lastPrice?: SeriesLastPriceOptionsObject;
  19818. /**
  19819. * (Highstock) The line marks the last price from visible range of points.
  19820. */
  19821. lastVisiblePrice?: SeriesLastVisiblePriceOptionsObject;
  19822. /**
  19823. * (Highcharts, Highstock) The SVG value used for the `stroke-linecap` and
  19824. * `stroke-linejoin` of a line graph. Round means that lines are rounded in
  19825. * the ends and bends.
  19826. */
  19827. linecap?: SeriesLinecapValue;
  19828. /**
  19829. * (Highcharts, Highstock) A separate color for the graph line. By default
  19830. * the line takes the `color` of the series, but the lineColor setting
  19831. * allows setting a separate color for the line without altering the
  19832. * `fillColor`.
  19833. *
  19834. * In styled mode, the line stroke can be set with the `.highcharts-graph`
  19835. * class name.
  19836. */
  19837. lineColor?: (ColorString|GradientColorObject|PatternObject);
  19838. /**
  19839. * (Highcharts, Highstock) Pixel width of the graph line.
  19840. */
  19841. lineWidth?: number;
  19842. /**
  19843. * (Highcharts, Highstock, Gantt) The id of another series to link to.
  19844. * Additionally, the value can be ":previous" to link to the previous
  19845. * series. When two series are linked, only the first one appears in the
  19846. * legend. Toggling the visibility of this also toggles the linked series.
  19847. *
  19848. * If master series uses data sorting and linked series does not have its
  19849. * own sorting definition, the linked series will be sorted in the same
  19850. * order as the master one.
  19851. */
  19852. linkedTo?: string;
  19853. /**
  19854. * (Highcharts, Highstock) Options for the point markers of line-like
  19855. * series. Properties like `fillColor`, `lineColor` and `lineWidth` define
  19856. * the visual appearance of the markers. Other series types, like column
  19857. * series, don't have markers, but have visual options on the series level
  19858. * instead.
  19859. *
  19860. * In styled mode, the markers can be styled with the `.highcharts-point`,
  19861. * `.highcharts-point-hover` and `.highcharts-point-select` class names.
  19862. */
  19863. marker?: PointMarkerOptionsObject;
  19864. /**
  19865. * (Highstock) Options for the corresponding navigator series if
  19866. * `showInNavigator` is `true` for this series. Available options are the
  19867. * same as any series, documented at plotOptions and series.
  19868. *
  19869. * These options are merged with options in navigator.series, and will take
  19870. * precedence if the same option is defined both places.
  19871. */
  19872. navigatorOptions?: PlotSeriesOptions;
  19873. /**
  19874. * (Highcharts, Highstock) The color for the parts of the graph or points
  19875. * that are below the threshold. Note that `zones` takes precedence over the
  19876. * negative color. Using `negativeColor` is equivalent to applying a zone
  19877. * with value of 0.
  19878. */
  19879. negativeColor?: (ColorString|GradientColorObject|PatternObject);
  19880. /**
  19881. * (Highcharts) A separate color for the negative part of the area.
  19882. *
  19883. * In styled mode, a negative color is set with the `.highcharts-negative`
  19884. * class name.
  19885. */
  19886. negativeFillColor?: (ColorString|GradientColorObject|PatternObject);
  19887. /**
  19888. * (Highcharts, Highstock) Opacity of a series parts: line, fill (e.g. area)
  19889. * and dataLabels.
  19890. */
  19891. opacity?: number;
  19892. /**
  19893. * (Highcharts, Highstock) Properties for each single point.
  19894. */
  19895. point?: PlotSeriesPointOptions;
  19896. /**
  19897. * (Highcharts, Highstock) Same as accessibility.pointDescriptionFormatter,
  19898. * but for an individual series. Overrides the chart wide configuration.
  19899. */
  19900. pointDescriptionFormatter?: Function;
  19901. /**
  19902. * (Highcharts, Highstock, Gantt) If no x values are given for the points in
  19903. * a series, `pointInterval` defines the interval of the x values. For
  19904. * example, if a series contains one value every decade starting from year
  19905. * 0, set `pointInterval` to `10`. In true `datetime` axes, the
  19906. * `pointInterval` is set in milliseconds.
  19907. *
  19908. * It can be also be combined with `pointIntervalUnit` to draw irregular
  19909. * time intervals.
  19910. *
  19911. * Please note that this options applies to the _series data_, not the
  19912. * interval of the axis ticks, which is independent.
  19913. */
  19914. pointInterval?: number;
  19915. /**
  19916. * (Highcharts, Highstock, Gantt) On datetime series, this allows for
  19917. * setting the pointInterval to irregular time units, `day`, `month` and
  19918. * `year`. A day is usually the same as 24 hours, but `pointIntervalUnit`
  19919. * also takes the DST crossover into consideration when dealing with local
  19920. * time. Combine this option with `pointInterval` to draw weeks, quarters, 6
  19921. * months, 10 years etc.
  19922. *
  19923. * Please note that this options applies to the _series data_, not the
  19924. * interval of the axis ticks, which is independent.
  19925. */
  19926. pointIntervalUnit?: OptionsPointIntervalUnitValue;
  19927. /**
  19928. * (Highcharts, Highstock, Gantt) Possible values: `"on"`, `"between"`,
  19929. * `number`.
  19930. *
  19931. * In a column chart, when pointPlacement is `"on"`, the point will not
  19932. * create any padding of the X axis. In a polar column chart this means that
  19933. * the first column points directly north. If the pointPlacement is
  19934. * `"between"`, the columns will be laid out between ticks. This is useful
  19935. * for example for visualising an amount between two points in time or in a
  19936. * certain sector of a polar chart.
  19937. *
  19938. * Since Highcharts 3.0.2, the point placement can also be numeric, where 0
  19939. * is on the axis value, -0.5 is between this value and the previous, and
  19940. * 0.5 is between this value and the next. Unlike the textual options,
  19941. * numeric point placement options won't affect axis padding.
  19942. *
  19943. * Note that pointPlacement needs a pointRange to work. For column series
  19944. * this is computed, but for line-type series it needs to be set.
  19945. *
  19946. * For the `xrange` series type and gantt charts, if the Y axis is a
  19947. * category axis, the `pointPlacement` applies to the Y axis rather than the
  19948. * (typically datetime) X axis.
  19949. *
  19950. * Defaults to `undefined` in cartesian charts, `"between"` in polar charts.
  19951. */
  19952. pointPlacement?: (number|string);
  19953. /**
  19954. * (Highstock) The width of each point on the x axis. For example in a
  19955. * column chart with one value each day, the pointRange would be 1 day (= 24
  19956. * * 3600
  19957. *
  19958. * * 1000 milliseconds). This is normally computed automatically, but this
  19959. * option can be used to override the automatic value.
  19960. */
  19961. pointRange?: number;
  19962. /**
  19963. * (Highcharts, Highstock, Gantt) If no x values are given for the points in
  19964. * a series, pointStart defines on what value to start. For example, if a
  19965. * series contains one yearly value starting from 1945, set pointStart to
  19966. * 1945.
  19967. */
  19968. pointStart?: number;
  19969. /**
  19970. * (Highcharts, Highstock) Whether to select the series initially. If
  19971. * `showCheckbox` is true, the checkbox next to the series name in the
  19972. * legend will be checked for a selected series.
  19973. */
  19974. selected?: boolean;
  19975. /**
  19976. * (Highcharts, Highstock) Whether to apply a drop shadow to the graph line.
  19977. * Since 2.3 the shadow can be an object configuration containing `color`,
  19978. * `offsetX`, `offsetY`, `opacity` and `width`.
  19979. */
  19980. shadow?: (boolean|ShadowOptionsObject);
  19981. /**
  19982. * (Highcharts, Highstock) If true, a checkbox is displayed next to the
  19983. * legend item to allow selecting the series. The state of the checkbox is
  19984. * determined by the `selected` option.
  19985. */
  19986. showCheckbox?: boolean;
  19987. /**
  19988. * (Highcharts, Highstock) Whether to display this particular series or
  19989. * series type in the legend. Standalone series are shown in legend by
  19990. * default, and linked series are not. Since v7.2.0 it is possible to show
  19991. * series that use colorAxis by setting this option to `true`.
  19992. */
  19993. showInLegend?: boolean;
  19994. /**
  19995. * (Highstock) Whether or not to show the series in the navigator. Takes
  19996. * precedence over navigator.baseSeries if defined.
  19997. */
  19998. showInNavigator?: boolean;
  19999. /**
  20000. * (Highcharts, Highstock) If set to `true`, the accessibility module will
  20001. * skip past the points in this series for keyboard navigation.
  20002. */
  20003. skipKeyboardNavigation?: boolean;
  20004. /**
  20005. * (Highcharts, Highstock) When this is true, the series will not cause the
  20006. * Y axis to cross the zero plane (or threshold option) unless the data
  20007. * actually crosses the plane.
  20008. *
  20009. * For example, if `softThreshold` is `false`, a series of 0, 1, 2, 3 will
  20010. * make the Y axis show negative values according to the `minPadding`
  20011. * option. If `softThreshold` is `true`, the Y axis starts at 0.
  20012. */
  20013. softThreshold?: boolean;
  20014. /**
  20015. * (Highcharts, Highstock) Whether to stack the values of each series on top
  20016. * of each other. Possible values are `undefined` to disable, `"normal"` to
  20017. * stack by value or `"percent"`.
  20018. *
  20019. * When stacking is enabled, data must be sorted in ascending X order.
  20020. *
  20021. * Some stacking options are related to specific series types. In the
  20022. * streamgraph series type, the stacking option is set to `"stream"`. The
  20023. * second one is `"overlap"`, which only applies to waterfall series.
  20024. */
  20025. stacking?: OptionsStackingValue;
  20026. states?: SeriesStatesOptionsObject;
  20027. /**
  20028. * (Highcharts, Highstock) Whether to apply steps to the line. Possible
  20029. * values are `left`, `center` and `right`.
  20030. */
  20031. step?: OptionsStepValue;
  20032. /**
  20033. * (Highcharts, Highstock) Sticky tracking of mouse events. When true, the
  20034. * `mouseOut` event on a series isn't triggered until the mouse moves over
  20035. * another series, or out of the plot area. When false, the `mouseOut` event
  20036. * on a series is triggered when the mouse leaves the area around the
  20037. * series' graph or markers. This also implies the tooltip when not shared.
  20038. * When `stickyTracking` is false and `tooltip.shared` is false, the tooltip
  20039. * will be hidden when moving the mouse between series. Defaults to true for
  20040. * line and area type series, but to false for columns, pies etc.
  20041. *
  20042. * **Note:** The boost module will force this option because of technical
  20043. * limitations.
  20044. */
  20045. stickyTracking?: boolean;
  20046. /**
  20047. * (Highcharts, Highstock) The Y axis value to serve as the base for the
  20048. * area, for distinguishing between values above and below a threshold. The
  20049. * area between the graph and the threshold is filled.
  20050. *
  20051. * * If a number is given, the Y axis will scale to the threshold.
  20052. *
  20053. * * If `null`, the scaling behaves like a line series with fill between the
  20054. * graph and the Y axis minimum.
  20055. *
  20056. * * If `Infinity` or `-Infinity`, the area between the graph and the
  20057. * corresponding Y axis extreme is filled (since v6.1.0).
  20058. */
  20059. threshold?: (number|null);
  20060. /**
  20061. * (Highcharts, Highstock) A configuration object for the tooltip rendering
  20062. * of each single series. Properties are inherited from tooltip, but only
  20063. * the following properties can be defined on a series level.
  20064. */
  20065. tooltip?: SeriesTooltipOptionsObject;
  20066. /**
  20067. * (Highcharts, Highstock) Whether the whole area or just the line should
  20068. * respond to mouseover tooltips and other mouse or touch events.
  20069. */
  20070. trackByArea?: boolean;
  20071. /**
  20072. * (Highcharts, Highstock, Gantt) When a series contains a data array that
  20073. * is longer than this, only one dimensional arrays of numbers, or two
  20074. * dimensional arrays with x and y values are allowed. Also, only the first
  20075. * point is tested, and the rest are assumed to be the same format. This
  20076. * saves expensive data checking and indexing in long series. Set it to `0`
  20077. * disable.
  20078. *
  20079. * Note: In boost mode turbo threshold is forced. Only array of numbers or
  20080. * two dimensional arrays are allowed.
  20081. */
  20082. turboThreshold?: number;
  20083. /**
  20084. * (Highcharts, Highstock) Set the initial visibility of the series.
  20085. */
  20086. visible?: boolean;
  20087. /**
  20088. * (Highmaps) Define the z index of the series.
  20089. */
  20090. zIndex?: number;
  20091. /**
  20092. * (Highcharts, Highstock) Defines the Axis on which the zones are applied.
  20093. */
  20094. zoneAxis?: string;
  20095. /**
  20096. * (Highcharts, Highstock) An array defining zones within a series. Zones
  20097. * can be applied to the X axis, Y axis or Z axis for bubbles, according to
  20098. * the `zoneAxis` option. The zone definitions have to be in ascending order
  20099. * regarding to the value.
  20100. *
  20101. * In styled mode, the color zones are styled with the
  20102. * `.highcharts-zone-{n}` class, or custom classed from the `className`
  20103. * option (view live demo).
  20104. */
  20105. zones?: Array<SeriesZonesOptionsObject>;
  20106. }
  20107. /**
  20108. * (Highcharts, Highstock) Enable or disable the initial animation when a series
  20109. * is displayed. The animation can also be set as a configuration object. Please
  20110. * note that this option only applies to the initial animation of the series
  20111. * itself. For other animations, see chart.animation and the animation parameter
  20112. * under the API methods. The following properties are supported:
  20113. *
  20114. * - `defer`: The animation delay time in milliseconds.
  20115. *
  20116. * - `duration`: The duration of the animation in milliseconds.
  20117. *
  20118. * - `easing`: Can be a string reference to an easing function set on the `Math`
  20119. * object or a function. See the _Custom easing function_ demo below.
  20120. *
  20121. * Due to poor performance, animation is disabled in old IE browsers for several
  20122. * chart types.
  20123. */
  20124. export interface PlotArearangeAnimationOptions {
  20125. defer?: number;
  20126. }
  20127. /**
  20128. * (Highcharts, Highstock) Enable or disable the initial animation when a series
  20129. * is displayed for the `dataLabels`. The animation can also be set as a
  20130. * configuration object. Please note that this option only applies to the
  20131. * initial animation. For other animations, see chart.animation and the
  20132. * animation parameter under the API methods. The following properties are
  20133. * supported:
  20134. *
  20135. * - `defer`: The animation delay time in milliseconds.
  20136. */
  20137. export interface PlotArearangeDataLabelsAnimationOptions {
  20138. /**
  20139. * (Highcharts, Highstock) The animation delay time in milliseconds. Set to
  20140. * `0` renders dataLabel immediately. As `undefined` inherits defer time
  20141. * from the series.animation.defer.
  20142. */
  20143. defer?: number;
  20144. }
  20145. /**
  20146. * (Highcharts, Highstock) Options for the series data sorting.
  20147. */
  20148. export interface PlotArearangeDataSortingOptions {
  20149. /**
  20150. * (Highcharts, Highstock) Enable or disable data sorting for the series.
  20151. * Use xAxis.reversed to change the sorting order.
  20152. */
  20153. enabled?: boolean;
  20154. /**
  20155. * (Highcharts, Highstock) Whether to allow matching points by name in an
  20156. * update. If this option is disabled, points will be matched by order.
  20157. */
  20158. matchByName?: boolean;
  20159. /**
  20160. * (Highcharts, Highstock) Determines what data value should be used to sort
  20161. * by.
  20162. */
  20163. sortKey?: string;
  20164. }
  20165. /**
  20166. * (Highcharts, Highstock) Style options for the guide box. The guide box has
  20167. * one state by default, the `default` state.
  20168. */
  20169. export interface PlotArearangeDragDropGuideBoxOptions {
  20170. /**
  20171. * (Highcharts, Highstock) Style options for the guide box default state.
  20172. */
  20173. default?: DragDropGuideBoxOptionsObject;
  20174. }
  20175. /**
  20176. * (Highcharts, Highstock) The area range series is a carteseian series with
  20177. * higher and lower values for each point along an X axis, where the area
  20178. * between the values is shaded.
  20179. *
  20180. * In TypeScript the type option must always be set.
  20181. *
  20182. * Configuration options for the series are given in three levels:
  20183. *
  20184. * 1. Options for all series in a chart are defined in the plotOptions.series
  20185. * object.
  20186. *
  20187. * 2. Options for all `arearange` series are defined in plotOptions.arearange.
  20188. *
  20189. * 3. Options for one single series are given in the series instance array. (see
  20190. * online documentation for example)
  20191. */
  20192. export interface PlotArearangeOptions {
  20193. /**
  20194. * (Highcharts, Highstock) Accessibility options for a series.
  20195. */
  20196. accessibility?: SeriesAccessibilityOptionsObject;
  20197. /**
  20198. * (Highmaps) Whether all areas of the map defined in `mapData` should be
  20199. * rendered. If `true`, areas which don't correspond to a data point, are
  20200. * rendered as `null` points. If `false`, those areas are skipped.
  20201. */
  20202. allAreas?: boolean;
  20203. /**
  20204. * (Highcharts, Highstock) Allow this series' points to be selected by
  20205. * clicking on the graphic (columns, point markers, pie slices, map areas
  20206. * etc).
  20207. *
  20208. * The selected points can be handled by point select and unselect events,
  20209. * or collectively by the getSelectedPoints function.
  20210. *
  20211. * And alternative way of selecting points is through dragging.
  20212. */
  20213. allowPointSelect?: boolean;
  20214. /**
  20215. * (Highcharts, Highstock) Enable or disable the initial animation when a
  20216. * series is displayed. The animation can also be set as a configuration
  20217. * object. Please note that this option only applies to the initial
  20218. * animation of the series itself. For other animations, see chart.animation
  20219. * and the animation parameter under the API methods. The following
  20220. * properties are supported:
  20221. *
  20222. * - `defer`: The animation delay time in milliseconds.
  20223. *
  20224. * - `duration`: The duration of the animation in milliseconds.
  20225. *
  20226. * - `easing`: Can be a string reference to an easing function set on the
  20227. * `Math` object or a function. See the _Custom easing function_ demo below.
  20228. *
  20229. * Due to poor performance, animation is disabled in old IE browsers for
  20230. * several chart types.
  20231. */
  20232. animation?: (boolean|PlotArearangeAnimationOptions|Partial<AnimationOptionsObject>);
  20233. /**
  20234. * (Highcharts, Highstock) For some series, there is a limit that shuts down
  20235. * initial animation by default when the total number of points in the chart
  20236. * is too high. For example, for a column chart and its derivatives,
  20237. * animation does not run if there is more than 250 points totally. To
  20238. * disable this cap, set `animationLimit` to `Infinity`.
  20239. */
  20240. animationLimit?: number;
  20241. /**
  20242. * (Highcharts, Highstock) Sets the color blending in the boost module.
  20243. */
  20244. boostBlending?: OptionsBoostBlendingValue;
  20245. /**
  20246. * (Highcharts, Highstock) Set the point threshold for when a series should
  20247. * enter boost mode.
  20248. *
  20249. * Setting it to e.g. 2000 will cause the series to enter boost mode when
  20250. * there are 2000 or more points in the series.
  20251. *
  20252. * To disable boosting on the series, set the `boostThreshold` to 0. Setting
  20253. * it to 1 will force boosting.
  20254. *
  20255. * Note that the cropThreshold also affects this setting. When zooming in on
  20256. * a series that has fewer points than the `cropThreshold`, all points are
  20257. * rendered although outside the visible plot area, and the `boostThreshold`
  20258. * won't take effect.
  20259. */
  20260. boostThreshold?: number;
  20261. /**
  20262. * (Highmaps) The border color of the map areas.
  20263. *
  20264. * In styled mode, the border stroke is given in the `.highcharts-point`
  20265. * class.
  20266. */
  20267. borderColor?: (ColorString|GradientColorObject|PatternObject);
  20268. /**
  20269. * (Highmaps) The border width of each map area.
  20270. *
  20271. * In styled mode, the border stroke width is given in the
  20272. * `.highcharts-point` class.
  20273. */
  20274. borderWidth?: number;
  20275. /**
  20276. * (Highcharts, Highstock) An additional class name to apply to the series'
  20277. * graphical elements. This option does not replace default class names of
  20278. * the graphical element.
  20279. */
  20280. className?: string;
  20281. /**
  20282. * (Highcharts, Highstock) Disable this option to allow series rendering in
  20283. * the whole plotting area.
  20284. *
  20285. * **Note:** Clipping should be always enabled when chart.zoomType is set
  20286. */
  20287. clip?: boolean;
  20288. /**
  20289. * (Highcharts, Highstock) The main color of the series. In line type series
  20290. * it applies to the line and the point markers unless otherwise specified.
  20291. * In bar type series it applies to the bars unless a color is specified per
  20292. * point. The default value is pulled from the `options.colors` array.
  20293. *
  20294. * In styled mode, the color can be defined by the colorIndex option. Also,
  20295. * the series color can be set with the `.highcharts-series`,
  20296. * `.highcharts-color-{n}`, `.highcharts-{type}-series` or
  20297. * `.highcharts-series-{n}` class, or individual classes given by the
  20298. * `className` option.
  20299. */
  20300. color?: (ColorString|GradientColorObject|PatternObject);
  20301. /**
  20302. * (Highcharts, Highstock, Highmaps) When using dual or multiple color axes,
  20303. * this number defines which colorAxis the particular series is connected
  20304. * to. It refers to either the axis id or the index of the axis in the
  20305. * colorAxis array, with 0 being the first. Set this option to false to
  20306. * prevent a series from connecting to the default color axis.
  20307. *
  20308. * Since v7.2.0 the option can also be an axis id or an axis index instead
  20309. * of a boolean flag.
  20310. */
  20311. colorAxis?: (boolean|number|string);
  20312. /**
  20313. * (Highcharts, Highstock) Styled mode only. A specific color index to use
  20314. * for the series, so its graphic representations are given the class name
  20315. * `highcharts-color-{n}`.
  20316. */
  20317. colorIndex?: number;
  20318. /**
  20319. * (Highcharts, Highstock, Highmaps) Determines what data value should be
  20320. * used to calculate point color if `colorAxis` is used. Requires to set
  20321. * `min` and `max` if some custom point property is used or if approximation
  20322. * for data grouping is set to `'sum'`.
  20323. */
  20324. colorKey?: string;
  20325. /**
  20326. * (Highstock) Compare the values of the series against the first non-null,
  20327. * non- zero value in the visible range. The y axis will show percentage or
  20328. * absolute change depending on whether `compare` is set to `"percent"` or
  20329. * `"value"`. When this is applied to multiple series, it allows comparing
  20330. * the development of the series against each other. Adds a `change` field
  20331. * to every point object.
  20332. */
  20333. compare?: string;
  20334. /**
  20335. * (Highstock) When compare is `percent`, this option dictates whether to
  20336. * use 0 or 100 as the base of comparison.
  20337. */
  20338. compareBase?: (0|100);
  20339. /**
  20340. * (Highstock) Defines if comparison should start from the first point
  20341. * within the visible range or should start from the first point **before**
  20342. * the range.
  20343. *
  20344. * In other words, this flag determines if first point within the visible
  20345. * range will have 0% (`compareStart=true`) or should have been already
  20346. * calculated according to the previous point (`compareStart=false`).
  20347. */
  20348. compareStart?: boolean;
  20349. /**
  20350. * (Highcharts) Polar charts only. Whether to connect the ends of a line
  20351. * series plot across the extremes.
  20352. */
  20353. connectEnds?: boolean;
  20354. /**
  20355. * (Highcharts, Highstock) Whether to connect a graph line across null
  20356. * points, or render a gap between the two points on either side of the
  20357. * null.
  20358. */
  20359. connectNulls?: boolean;
  20360. /**
  20361. * (Gantt) Override Pathfinder connector options for a series. Requires
  20362. * Highcharts Gantt to be loaded.
  20363. */
  20364. connectors?: SeriesConnectorsOptionsObject;
  20365. /**
  20366. * (Highcharts, Highstock, Gantt) When true, each point or column edge is
  20367. * rounded to its nearest pixel in order to render sharp on screen. In some
  20368. * cases, when there are a lot of densely packed columns, this leads to
  20369. * visible difference in column widths or distance between columns. In these
  20370. * cases, setting `crisp` to `false` may look better, even though each
  20371. * column is rendered blurry.
  20372. */
  20373. crisp?: boolean;
  20374. /**
  20375. * (Highcharts, Highstock) When the series contains less points than the
  20376. * crop threshold, all points are drawn, even if the points fall outside the
  20377. * visible plot area at the current zoom. The advantage of drawing all
  20378. * points (including markers and columns), is that animation is performed on
  20379. * updates. On the other hand, when the series contains more points than the
  20380. * crop threshold, the series data is cropped to only contain points that
  20381. * fall within the plot area. The advantage of cropping away invisible
  20382. * points is to increase performance on large series.
  20383. */
  20384. cropThreshold?: number;
  20385. /**
  20386. * (Highcharts, Highstock) You can set the cursor to "pointer" if you have
  20387. * click events attached to the series, to signal to the user that the
  20388. * points and lines can be clicked.
  20389. *
  20390. * In styled mode, the series cursor can be set with the same classes as
  20391. * listed under series.color.
  20392. */
  20393. cursor?: (string|CursorValue);
  20394. /**
  20395. * (Highcharts, Highstock) A reserved subspace to store options and values
  20396. * for customized functionality. Here you can add additional data for your
  20397. * own event callbacks and formatter callbacks.
  20398. */
  20399. custom?: Dictionary<any>;
  20400. /**
  20401. * (Highcharts, Highstock) Name of the dash style to use for the graph, or
  20402. * for some series types the outline of each shape.
  20403. *
  20404. * In styled mode, the stroke dash-array can be set with the same classes as
  20405. * listed under series.color.
  20406. */
  20407. dashStyle?: DashStyleValue;
  20408. /**
  20409. * (Highstock) Data grouping is the concept of sampling the data values into
  20410. * larger blocks in order to ease readability and increase performance of
  20411. * the JavaScript charts. Highstock by default applies data grouping when
  20412. * the points become closer than a certain pixel value, determined by the
  20413. * `groupPixelWidth` option.
  20414. *
  20415. * If data grouping is applied, the grouping information of grouped points
  20416. * can be read from the Point.dataGroup. If point options other than the
  20417. * data itself are set, for example `name` or `color` or custom properties,
  20418. * the grouping logic doesn't know how to group it. In this case the options
  20419. * of the first point instance are copied over to the group point. This can
  20420. * be altered through a custom `approximation` callback function.
  20421. */
  20422. dataGrouping?: DataGroupingOptionsObject;
  20423. /**
  20424. * (Highcharts, Highstock) Extended data labels for range series types.
  20425. * Range series data labels use no `x` and `y` options. Instead, they have
  20426. * `xLow`, `xHigh`, `yLow` and `yHigh` options to allow the higher and lower
  20427. * data label sets individually.
  20428. */
  20429. dataLabels?: (SeriesAreaRangeDataLabelsOptionsObject|Array<SeriesAreaRangeDataLabelsOptionsObject>);
  20430. /**
  20431. * (Highcharts, Highstock) Options for the series data sorting.
  20432. */
  20433. dataSorting?: (DataSortingOptionsObject|PlotArearangeDataSortingOptions);
  20434. /**
  20435. * (Highcharts, Highstock) A description of the series to add to the screen
  20436. * reader information about the series.
  20437. */
  20438. description?: string;
  20439. /**
  20440. * (Highcharts, Highstock) The draggable-points module allows points to be
  20441. * moved around or modified in the chart. In addition to the options
  20442. * mentioned under the `dragDrop` API structure, the module fires three
  20443. * events, point.dragStart, point.drag and point.drop.
  20444. */
  20445. dragDrop?: SeriesDragDropOptionsObject;
  20446. /**
  20447. * (Highcharts, Highstock) Enable or disable the mouse tracking for a
  20448. * specific series. This includes point tooltips and click events on graphs
  20449. * and points. For large datasets it improves performance.
  20450. */
  20451. enableMouseTracking?: boolean;
  20452. /**
  20453. * (Highcharts, Highstock) General event handlers for the series items.
  20454. * These event hooks can also be attached to the series at run time using
  20455. * the `Highcharts.addEvent` function.
  20456. */
  20457. events?: SeriesEventsOptionsObject;
  20458. /**
  20459. * (Highcharts, Highstock) Fill color or gradient for the area. When `null`,
  20460. * the series' `color` is used with the series' `fillOpacity`.
  20461. *
  20462. * In styled mode, the fill color can be set with the `.highcharts-area`
  20463. * class name.
  20464. */
  20465. fillColor?: (ColorString|GradientColorObject|PatternObject);
  20466. /**
  20467. * (Highcharts, Highstock) Fill opacity for the area. When you set an
  20468. * explicit `fillColor`, the `fillOpacity` is not applied. Instead, you
  20469. * should define the opacity in the `fillColor` with an rgba color
  20470. * definition. The `fillOpacity` setting, also the default setting,
  20471. * overrides the alpha component of the `color` setting.
  20472. *
  20473. * In styled mode, the fill opacity can be set with the `.highcharts-area`
  20474. * class name.
  20475. */
  20476. fillOpacity?: number;
  20477. /**
  20478. * (Highcharts, Highstock) Determines whether the series should look for the
  20479. * nearest point in both dimensions or just the x-dimension when hovering
  20480. * the series. Defaults to `'xy'` for scatter series and `'x'` for most
  20481. * other series. If the data has duplicate x-values, it is recommended to
  20482. * set this to `'xy'` to allow hovering over all points.
  20483. *
  20484. * Applies only to series types using nearest neighbor search (not direct
  20485. * hover) for tooltip.
  20486. */
  20487. findNearestPointBy?: OptionsFindNearestPointByValue;
  20488. /**
  20489. * (Highstock) Defines when to display a gap in the graph, together with the
  20490. * gapUnit option.
  20491. *
  20492. * In case when `dataGrouping` is enabled, points can be grouped into a
  20493. * larger time span. This can make the grouped points to have a greater
  20494. * distance than the absolute value of `gapSize` property, which will result
  20495. * in disappearing graph completely. To prevent this situation the mentioned
  20496. * distance between grouped points is used instead of previously defined
  20497. * `gapSize`.
  20498. *
  20499. * In practice, this option is most often used to visualize gaps in time
  20500. * series. In a stock chart, intraday data is available for daytime hours,
  20501. * while gaps will appear in nights and weekends.
  20502. */
  20503. gapSize?: number;
  20504. /**
  20505. * (Highstock) Together with gapSize, this option defines where to draw gaps
  20506. * in the graph.
  20507. *
  20508. * When the `gapUnit` is `"relative"` (default), a gap size of 5 means that
  20509. * if the distance between two points is greater than 5 times that of the
  20510. * two closest points, the graph will be broken.
  20511. *
  20512. * When the `gapUnit` is `"value"`, the gap is based on absolute axis
  20513. * values, which on a datetime axis is milliseconds. This also applies to
  20514. * the navigator series that inherits gap options from the base series.
  20515. */
  20516. gapUnit?: OptionsGapUnitValue;
  20517. /**
  20518. * (Highcharts, Highstock, Gantt) Whether to use the Y extremes of the total
  20519. * chart width or only the zoomed area when zooming in on parts of the X
  20520. * axis. By default, the Y axis adjusts to the min and max of the visible
  20521. * data. Cartesian series only.
  20522. */
  20523. getExtremesFromAll?: boolean;
  20524. /**
  20525. * (Highcharts, Highstock) When set to `false` will prevent the series data
  20526. * from being included in any form of data export.
  20527. *
  20528. * Since version 6.0.0 until 7.1.0 the option was existing undocumented as
  20529. * `includeInCSVExport`.
  20530. */
  20531. includeInDataExport?: boolean;
  20532. /**
  20533. * (Highmaps) What property to join the `mapData` to the value data. For
  20534. * example, if joinBy is "code", the mapData items with a specific code is
  20535. * merged into the data with the same code. For maps loaded from GeoJSON,
  20536. * the keys may be held in each point's `properties` object.
  20537. *
  20538. * The joinBy option can also be an array of two values, where the first
  20539. * points to a key in the `mapData`, and the second points to another key in
  20540. * the `data`.
  20541. *
  20542. * When joinBy is `null`, the map items are joined by their position in the
  20543. * array, which performs much better in maps with many data points. This is
  20544. * the recommended option if you are printing more than a thousand data
  20545. * points and have a backend that can preprocess the data into a parallel
  20546. * array of the mapData.
  20547. */
  20548. joinBy?: (string|Array<string>);
  20549. /**
  20550. * (Highcharts, Highstock) An array specifying which option maps to which
  20551. * key in the data point array. This makes it convenient to work with
  20552. * unstructured data arrays from different sources.
  20553. */
  20554. keys?: Array<string>;
  20555. /**
  20556. * (Highcharts, Highstock, Gantt) Series labels are placed as close to the
  20557. * series as possible in a natural way, seeking to avoid other series. The
  20558. * goal of this feature is to make the chart more easily readable, like if a
  20559. * human designer placed the labels in the optimal position.
  20560. *
  20561. * The series labels currently work with series types having a `graph` or an
  20562. * `area`.
  20563. */
  20564. label?: SeriesLabelOptionsObject;
  20565. /**
  20566. * (Highstock) The line marks the last price from all points.
  20567. */
  20568. lastPrice?: SeriesLastPriceOptionsObject;
  20569. /**
  20570. * (Highstock) The line marks the last price from visible range of points.
  20571. */
  20572. lastVisiblePrice?: SeriesLastVisiblePriceOptionsObject;
  20573. /**
  20574. * (Highcharts, Highstock) The SVG value used for the `stroke-linecap` and
  20575. * `stroke-linejoin` of a line graph. Round means that lines are rounded in
  20576. * the ends and bends.
  20577. */
  20578. linecap?: SeriesLinecapValue;
  20579. /**
  20580. * (Highcharts, Highstock) A separate color for the graph line. By default
  20581. * the line takes the `color` of the series, but the lineColor setting
  20582. * allows setting a separate color for the line without altering the
  20583. * `fillColor`.
  20584. *
  20585. * In styled mode, the line stroke can be set with the `.highcharts-graph`
  20586. * class name.
  20587. */
  20588. lineColor?: (ColorString|GradientColorObject|PatternObject);
  20589. /**
  20590. * (Highcharts, Highstock) Pixel width of the arearange graph line.
  20591. */
  20592. lineWidth?: number;
  20593. /**
  20594. * (Highcharts, Highstock, Gantt) The id of another series to link to.
  20595. * Additionally, the value can be ":previous" to link to the previous
  20596. * series. When two series are linked, only the first one appears in the
  20597. * legend. Toggling the visibility of this also toggles the linked series.
  20598. *
  20599. * If master series uses data sorting and linked series does not have its
  20600. * own sorting definition, the linked series will be sorted in the same
  20601. * order as the master one.
  20602. */
  20603. linkedTo?: string;
  20604. /**
  20605. * (Highcharts, Highstock) Options for the point markers of line-like
  20606. * series. Properties like `fillColor`, `lineColor` and `lineWidth` define
  20607. * the visual appearance of the markers. Other series types, like column
  20608. * series, don't have markers, but have visual options on the series level
  20609. * instead.
  20610. *
  20611. * In styled mode, the markers can be styled with the `.highcharts-point`,
  20612. * `.highcharts-point-hover` and `.highcharts-point-select` class names.
  20613. */
  20614. marker?: PointMarkerOptionsObject;
  20615. /**
  20616. * (Highstock) Options for the corresponding navigator series if
  20617. * `showInNavigator` is `true` for this series. Available options are the
  20618. * same as any series, documented at plotOptions and series.
  20619. *
  20620. * These options are merged with options in navigator.series, and will take
  20621. * precedence if the same option is defined both places.
  20622. */
  20623. navigatorOptions?: PlotSeriesOptions;
  20624. /**
  20625. * (Highcharts, Highstock) The color for the parts of the graph or points
  20626. * that are below the threshold. Note that `zones` takes precedence over the
  20627. * negative color. Using `negativeColor` is equivalent to applying a zone
  20628. * with value of 0.
  20629. */
  20630. negativeColor?: (ColorString|GradientColorObject|PatternObject);
  20631. /**
  20632. * (Highcharts) A separate color for the negative part of the area.
  20633. *
  20634. * In styled mode, a negative color is set with the `.highcharts-negative`
  20635. * class name.
  20636. */
  20637. negativeFillColor?: (ColorString|GradientColorObject|PatternObject);
  20638. /**
  20639. * (Highcharts, Highstock) Opacity of a series parts: line, fill (e.g. area)
  20640. * and dataLabels.
  20641. */
  20642. opacity?: number;
  20643. /**
  20644. * (Highcharts, Highstock) Properties for each single point.
  20645. */
  20646. point?: PlotSeriesPointOptions;
  20647. /**
  20648. * (Highcharts, Highstock) Same as accessibility.pointDescriptionFormatter,
  20649. * but for an individual series. Overrides the chart wide configuration.
  20650. */
  20651. pointDescriptionFormatter?: Function;
  20652. /**
  20653. * (Highcharts, Highstock, Gantt) If no x values are given for the points in
  20654. * a series, `pointInterval` defines the interval of the x values. For
  20655. * example, if a series contains one value every decade starting from year
  20656. * 0, set `pointInterval` to `10`. In true `datetime` axes, the
  20657. * `pointInterval` is set in milliseconds.
  20658. *
  20659. * It can be also be combined with `pointIntervalUnit` to draw irregular
  20660. * time intervals.
  20661. *
  20662. * Please note that this options applies to the _series data_, not the
  20663. * interval of the axis ticks, which is independent.
  20664. */
  20665. pointInterval?: number;
  20666. /**
  20667. * (Highcharts, Highstock, Gantt) On datetime series, this allows for
  20668. * setting the pointInterval to irregular time units, `day`, `month` and
  20669. * `year`. A day is usually the same as 24 hours, but `pointIntervalUnit`
  20670. * also takes the DST crossover into consideration when dealing with local
  20671. * time. Combine this option with `pointInterval` to draw weeks, quarters, 6
  20672. * months, 10 years etc.
  20673. *
  20674. * Please note that this options applies to the _series data_, not the
  20675. * interval of the axis ticks, which is independent.
  20676. */
  20677. pointIntervalUnit?: OptionsPointIntervalUnitValue;
  20678. /**
  20679. * (Highcharts, Highstock, Gantt) Possible values: `"on"`, `"between"`,
  20680. * `number`.
  20681. *
  20682. * In a column chart, when pointPlacement is `"on"`, the point will not
  20683. * create any padding of the X axis. In a polar column chart this means that
  20684. * the first column points directly north. If the pointPlacement is
  20685. * `"between"`, the columns will be laid out between ticks. This is useful
  20686. * for example for visualising an amount between two points in time or in a
  20687. * certain sector of a polar chart.
  20688. *
  20689. * Since Highcharts 3.0.2, the point placement can also be numeric, where 0
  20690. * is on the axis value, -0.5 is between this value and the previous, and
  20691. * 0.5 is between this value and the next. Unlike the textual options,
  20692. * numeric point placement options won't affect axis padding.
  20693. *
  20694. * Note that pointPlacement needs a pointRange to work. For column series
  20695. * this is computed, but for line-type series it needs to be set.
  20696. *
  20697. * For the `xrange` series type and gantt charts, if the Y axis is a
  20698. * category axis, the `pointPlacement` applies to the Y axis rather than the
  20699. * (typically datetime) X axis.
  20700. *
  20701. * Defaults to `undefined` in cartesian charts, `"between"` in polar charts.
  20702. */
  20703. pointPlacement?: (number|string);
  20704. /**
  20705. * (Highstock) The width of each point on the x axis. For example in a
  20706. * column chart with one value each day, the pointRange would be 1 day (= 24
  20707. * * 3600
  20708. *
  20709. * * 1000 milliseconds). This is normally computed automatically, but this
  20710. * option can be used to override the automatic value.
  20711. */
  20712. pointRange?: number;
  20713. /**
  20714. * (Highcharts, Highstock, Gantt) If no x values are given for the points in
  20715. * a series, pointStart defines on what value to start. For example, if a
  20716. * series contains one yearly value starting from 1945, set pointStart to
  20717. * 1945.
  20718. */
  20719. pointStart?: number;
  20720. /**
  20721. * (Highcharts, Highstock) Whether to select the series initially. If
  20722. * `showCheckbox` is true, the checkbox next to the series name in the
  20723. * legend will be checked for a selected series.
  20724. */
  20725. selected?: boolean;
  20726. /**
  20727. * (Highcharts) Whether to apply a drop shadow to the graph line. Since 2.3
  20728. * the shadow can be an object configuration containing `color`, `offsetX`,
  20729. * `offsetY`, `opacity` and `width`.
  20730. */
  20731. shadow?: (boolean|ShadowOptionsObject);
  20732. /**
  20733. * (Highcharts, Highstock) If true, a checkbox is displayed next to the
  20734. * legend item to allow selecting the series. The state of the checkbox is
  20735. * determined by the `selected` option.
  20736. */
  20737. showCheckbox?: boolean;
  20738. /**
  20739. * (Highcharts, Highstock) Whether to display this particular series or
  20740. * series type in the legend. Standalone series are shown in legend by
  20741. * default, and linked series are not. Since v7.2.0 it is possible to show
  20742. * series that use colorAxis by setting this option to `true`.
  20743. */
  20744. showInLegend?: boolean;
  20745. /**
  20746. * (Highstock) Whether or not to show the series in the navigator. Takes
  20747. * precedence over navigator.baseSeries if defined.
  20748. */
  20749. showInNavigator?: boolean;
  20750. /**
  20751. * (Highcharts, Highstock) If set to `true`, the accessibility module will
  20752. * skip past the points in this series for keyboard navigation.
  20753. */
  20754. skipKeyboardNavigation?: boolean;
  20755. /**
  20756. * (Highcharts, Highstock) When this is true, the series will not cause the
  20757. * Y axis to cross the zero plane (or threshold option) unless the data
  20758. * actually crosses the plane.
  20759. *
  20760. * For example, if `softThreshold` is `false`, a series of 0, 1, 2, 3 will
  20761. * make the Y axis show negative values according to the `minPadding`
  20762. * option. If `softThreshold` is `true`, the Y axis starts at 0.
  20763. */
  20764. softThreshold?: boolean;
  20765. states?: SeriesStatesOptionsObject;
  20766. /**
  20767. * (Highcharts, Highstock) Whether to apply steps to the line. Possible
  20768. * values are `left`, `center` and `right`.
  20769. */
  20770. step?: OptionsStepValue;
  20771. /**
  20772. * (Highcharts, Highstock) Sticky tracking of mouse events. When true, the
  20773. * `mouseOut` event on a series isn't triggered until the mouse moves over
  20774. * another series, or out of the plot area. When false, the `mouseOut` event
  20775. * on a series is triggered when the mouse leaves the area around the
  20776. * series' graph or markers. This also implies the tooltip when not shared.
  20777. * When `stickyTracking` is false and `tooltip.shared` is false, the tooltip
  20778. * will be hidden when moving the mouse between series. Defaults to true for
  20779. * line and area type series, but to false for columns, pies etc.
  20780. *
  20781. * **Note:** The boost module will force this option because of technical
  20782. * limitations.
  20783. */
  20784. stickyTracking?: boolean;
  20785. /**
  20786. * (Highcharts, Highstock) The Y axis value to serve as the base for the
  20787. * area, for distinguishing between values above and below a threshold. The
  20788. * area between the graph and the threshold is filled.
  20789. *
  20790. * * If a number is given, the Y axis will scale to the threshold.
  20791. *
  20792. * * If `null`, the scaling behaves like a line series with fill between the
  20793. * graph and the Y axis minimum.
  20794. *
  20795. * * If `Infinity` or `-Infinity`, the area between the graph and the
  20796. * corresponding Y axis extreme is filled (since v6.1.0).
  20797. */
  20798. threshold?: (number|null);
  20799. /**
  20800. * (Highcharts, Highstock) A configuration object for the tooltip rendering
  20801. * of each single series. Properties are inherited from tooltip, but only
  20802. * the following properties can be defined on a series level.
  20803. */
  20804. tooltip?: SeriesTooltipOptionsObject;
  20805. /**
  20806. * (Highcharts, Highstock) Whether the whole area or just the line should
  20807. * respond to mouseover tooltips and other mouse or touch events.
  20808. */
  20809. trackByArea?: boolean;
  20810. /**
  20811. * (Highcharts, Highstock, Gantt) When a series contains a data array that
  20812. * is longer than this, only one dimensional arrays of numbers, or two
  20813. * dimensional arrays with x and y values are allowed. Also, only the first
  20814. * point is tested, and the rest are assumed to be the same format. This
  20815. * saves expensive data checking and indexing in long series. Set it to `0`
  20816. * disable.
  20817. *
  20818. * Note: In boost mode turbo threshold is forced. Only array of numbers or
  20819. * two dimensional arrays are allowed.
  20820. */
  20821. turboThreshold?: number;
  20822. /**
  20823. * (Highcharts, Highstock) Set the initial visibility of the series.
  20824. */
  20825. visible?: boolean;
  20826. /**
  20827. * (Highmaps) Define the z index of the series.
  20828. */
  20829. zIndex?: number;
  20830. /**
  20831. * (Highcharts, Highstock) Defines the Axis on which the zones are applied.
  20832. */
  20833. zoneAxis?: string;
  20834. /**
  20835. * (Highcharts, Highstock) An array defining zones within a series. Zones
  20836. * can be applied to the X axis, Y axis or Z axis for bubbles, according to
  20837. * the `zoneAxis` option. The zone definitions have to be in ascending order
  20838. * regarding to the value.
  20839. *
  20840. * In styled mode, the color zones are styled with the
  20841. * `.highcharts-zone-{n}` class, or custom classed from the `className`
  20842. * option (view live demo).
  20843. */
  20844. zones?: Array<SeriesZonesOptionsObject>;
  20845. }
  20846. /**
  20847. * (Highcharts, Highstock) Enable or disable the initial animation when a series
  20848. * is displayed. The animation can also be set as a configuration object. Please
  20849. * note that this option only applies to the initial animation of the series
  20850. * itself. For other animations, see chart.animation and the animation parameter
  20851. * under the API methods. The following properties are supported:
  20852. *
  20853. * - `defer`: The animation delay time in milliseconds.
  20854. *
  20855. * - `duration`: The duration of the animation in milliseconds.
  20856. *
  20857. * - `easing`: Can be a string reference to an easing function set on the `Math`
  20858. * object or a function. See the _Custom easing function_ demo below.
  20859. *
  20860. * Due to poor performance, animation is disabled in old IE browsers for several
  20861. * chart types.
  20862. */
  20863. export interface PlotAreasplineAnimationOptions {
  20864. defer?: number;
  20865. }
  20866. /**
  20867. * (Highcharts, Highstock, Highmaps, Gantt) Enable or disable the initial
  20868. * animation when a series is displayed for the `dataLabels`. The animation can
  20869. * also be set as a configuration object. Please note that this option only
  20870. * applies to the initial animation. For other animations, see chart.animation
  20871. * and the animation parameter under the API methods. The following properties
  20872. * are supported:
  20873. *
  20874. * - `defer`: The animation delay time in milliseconds.
  20875. */
  20876. export interface PlotAreasplineDataLabelsAnimationOptions {
  20877. /**
  20878. * (Highcharts, Highstock, Highmaps, Gantt) The animation delay time in
  20879. * milliseconds. Set to `0` renders dataLabel immediately. As `undefined`
  20880. * inherits defer time from the series.animation.defer.
  20881. */
  20882. defer?: number;
  20883. }
  20884. /**
  20885. * (Highcharts, Highstock, Highmaps, Gantt) Options for the series data labels,
  20886. * appearing next to each data point.
  20887. *
  20888. * Since v6.2.0, multiple data labels can be applied to each single point by
  20889. * defining them as an array of configs.
  20890. *
  20891. * In styled mode, the data labels can be styled with the
  20892. * `.highcharts-data-label-box` and `.highcharts-data-label` class names (see
  20893. * example).
  20894. */
  20895. export interface PlotAreasplineDataLabelsOptions {
  20896. /**
  20897. * (Highcharts, Highstock, Highmaps, Gantt) The alignment of the data label
  20898. * compared to the point. If `right`, the right side of the label should be
  20899. * touching the point. For points with an extent, like columns, the
  20900. * alignments also dictates how to align it inside the box, as given with
  20901. * the inside option. Can be one of `left`, `center` or `right`.
  20902. */
  20903. align?: (AlignValue|null);
  20904. /**
  20905. * (Highcharts, Highstock, Highmaps, Gantt) Whether to allow data labels to
  20906. * overlap. To make the labels less sensitive for overlapping, the
  20907. * dataLabels.padding can be set to 0.
  20908. */
  20909. allowOverlap?: boolean;
  20910. /**
  20911. * (Highcharts, Highstock, Highmaps, Gantt) Enable or disable the initial
  20912. * animation when a series is displayed for the `dataLabels`. The animation
  20913. * can also be set as a configuration object. Please note that this option
  20914. * only applies to the initial animation. For other animations, see
  20915. * chart.animation and the animation parameter under the API methods. The
  20916. * following properties are supported:
  20917. *
  20918. * - `defer`: The animation delay time in milliseconds.
  20919. */
  20920. animation?: (boolean|PlotAreasplineDataLabelsAnimationOptions|Partial<AnimationOptionsObject>);
  20921. /**
  20922. * (Highcharts, Highstock, Highmaps, Gantt) The background color or gradient
  20923. * for the data label.
  20924. */
  20925. backgroundColor?: (ColorString|GradientColorObject|PatternObject);
  20926. /**
  20927. * (Highcharts, Highstock, Highmaps, Gantt) The border color for the data
  20928. * label. Defaults to `undefined`.
  20929. */
  20930. borderColor?: (ColorString|GradientColorObject|PatternObject);
  20931. /**
  20932. * (Highcharts, Highstock, Highmaps, Gantt) The border radius in pixels for
  20933. * the data label.
  20934. */
  20935. borderRadius?: number;
  20936. /**
  20937. * (Highcharts, Highstock, Highmaps, Gantt) The border width in pixels for
  20938. * the data label.
  20939. */
  20940. borderWidth?: number;
  20941. /**
  20942. * (Highcharts, Highstock, Highmaps, Gantt) A class name for the data label.
  20943. * Particularly in styled mode, this can be used to give each series' or
  20944. * point's data label unique styling. In addition to this option, a default
  20945. * color class name is added so that we can give the labels a contrast text
  20946. * shadow.
  20947. */
  20948. className?: string;
  20949. /**
  20950. * (Highcharts, Highstock, Highmaps, Gantt) The text color for the data
  20951. * labels. Defaults to `undefined`. For certain series types, like column or
  20952. * map, the data labels can be drawn inside the points. In this case the
  20953. * data label will be drawn with maximum contrast by default. Additionally,
  20954. * it will be given a `text-outline` style with the opposite color, to
  20955. * further increase the contrast. This can be overridden by setting the
  20956. * `text-outline` style to `none` in the `dataLabels.style` option.
  20957. */
  20958. color?: (ColorString|GradientColorObject|PatternObject);
  20959. /**
  20960. * (Highcharts, Highstock, Highmaps, Gantt) Whether to hide data labels that
  20961. * are outside the plot area. By default, the data label is moved inside the
  20962. * plot area according to the overflow option.
  20963. */
  20964. crop?: boolean;
  20965. /**
  20966. * (Highcharts, Highstock, Gantt) Whether to defer displaying the data
  20967. * labels until the initial series animation has finished. Setting to
  20968. * `false` renders the data label immediately. If set to `true` inherits the
  20969. * defer time set in plotOptions.series.animation.
  20970. */
  20971. defer?: boolean;
  20972. /**
  20973. * (Highcharts, Highstock, Highmaps, Gantt) Enable or disable the data
  20974. * labels.
  20975. */
  20976. enabled?: boolean;
  20977. /**
  20978. * (Highcharts, Highstock, Highmaps, Gantt) A declarative filter to control
  20979. * of which data labels to display. The declarative filter is designed for
  20980. * use when callback functions are not available, like when the chart
  20981. * options require a pure JSON structure or for use with graphical editors.
  20982. * For programmatic control, use the `formatter` instead, and return
  20983. * `undefined` to disable a single data label.
  20984. */
  20985. filter?: DataLabelsFilterOptionsObject;
  20986. /**
  20987. * (Highcharts, Highstock, Highmaps, Gantt) A format string for the data
  20988. * label. Available variables are the same as for `formatter`.
  20989. */
  20990. format?: string;
  20991. /**
  20992. * (Highcharts, Highstock, Highmaps, Gantt) Callback JavaScript function to
  20993. * format the data label. Note that if a `format` is defined, the format
  20994. * takes precedence and the formatter is ignored.
  20995. */
  20996. formatter?: DataLabelsFormatterCallbackFunction;
  20997. /**
  20998. * (Highcharts, Highstock, Highmaps, Gantt) For points with an extent, like
  20999. * columns or map areas, whether to align the data label inside the box or
  21000. * to the actual value point. Defaults to `false` in most cases, `true` in
  21001. * stacked columns.
  21002. */
  21003. inside?: boolean;
  21004. /**
  21005. * (Highcharts, Highstock, Highmaps, Gantt) Format for points with the value
  21006. * of null. Works analogously to format. `nullFormat` can be applied only to
  21007. * series which support displaying null points.
  21008. */
  21009. nullFormat?: (boolean|string);
  21010. /**
  21011. * (Highcharts, Highstock, Highmaps, Gantt) Callback JavaScript function
  21012. * that defines formatting for points with the value of null. Works
  21013. * analogously to formatter. `nullPointFormatter` can be applied only to
  21014. * series which support displaying null points.
  21015. */
  21016. nullFormatter?: DataLabelsFormatterCallbackFunction;
  21017. /**
  21018. * (Highcharts, Highstock, Highmaps, Gantt) How to handle data labels that
  21019. * flow outside the plot area. The default is `"justify"`, which aligns them
  21020. * inside the plot area. For columns and bars, this means it will be moved
  21021. * inside the bar. To display data labels outside the plot area, set `crop`
  21022. * to `false` and `overflow` to `"allow"`.
  21023. */
  21024. overflow?: DataLabelsOverflowValue;
  21025. /**
  21026. * (Highcharts, Highstock, Highmaps, Gantt) When either the `borderWidth` or
  21027. * the `backgroundColor` is set, this is the padding within the box.
  21028. */
  21029. padding?: number;
  21030. /**
  21031. * (Highcharts, Highstock, Highmaps, Gantt) Aligns data labels relative to
  21032. * points. If `center` alignment is not possible, it defaults to `right`.
  21033. */
  21034. position?: AlignValue;
  21035. /**
  21036. * (Highcharts, Highstock, Highmaps, Gantt) Text rotation in degrees. Note
  21037. * that due to a more complex structure, backgrounds, borders and padding
  21038. * will be lost on a rotated data label.
  21039. */
  21040. rotation?: number;
  21041. /**
  21042. * (Highcharts, Highstock, Highmaps, Gantt) The shadow of the box. Works
  21043. * best with `borderWidth` or `backgroundColor`. Since 2.3 the shadow can be
  21044. * an object configuration containing `color`, `offsetX`, `offsetY`,
  21045. * `opacity` and `width`.
  21046. */
  21047. shadow?: (boolean|ShadowOptionsObject);
  21048. /**
  21049. * (Highcharts, Highstock, Highmaps, Gantt) The name of a symbol to use for
  21050. * the border around the label. Symbols are predefined functions on the
  21051. * Renderer object.
  21052. */
  21053. shape?: string;
  21054. /**
  21055. * (Highcharts, Highstock, Highmaps, Gantt) Styles for the label. The
  21056. * default `color` setting is `"contrast"`, which is a pseudo color that
  21057. * Highcharts picks up and applies the maximum contrast to the underlying
  21058. * point item, for example the bar in a bar chart.
  21059. *
  21060. * The `textOutline` is a pseudo property that applies an outline of the
  21061. * given width with the given color, which by default is the maximum
  21062. * contrast to the text. So a bright text color will result in a black text
  21063. * outline for maximum readability on a mixed background. In some cases,
  21064. * especially with grayscale text, the text outline doesn't work well, in
  21065. * which cases it can be disabled by setting it to `"none"`. When `useHTML`
  21066. * is true, the `textOutline` will not be picked up. In this, case, the same
  21067. * effect can be acheived through the `text-shadow` CSS property.
  21068. *
  21069. * For some series types, where each point has an extent, like for example
  21070. * tree maps, the data label may overflow the point. There are two
  21071. * strategies for handling overflow. By default, the text will wrap to
  21072. * multiple lines. The other strategy is to set `style.textOverflow` to
  21073. * `ellipsis`, which will keep the text on one line plus it will break
  21074. * inside long words.
  21075. */
  21076. style?: CSSObject;
  21077. /**
  21078. * (Highcharts, Highstock, Highmaps, Gantt) Options for a label text which
  21079. * should follow marker's shape. Border and background are disabled for a
  21080. * label that follows a path.
  21081. *
  21082. * **Note:** Only SVG-based renderer supports this option. Setting `useHTML`
  21083. * to true will disable this option.
  21084. */
  21085. textPath?: DataLabelsTextPathOptionsObject;
  21086. /**
  21087. * (Highcharts, Highstock, Highmaps, Gantt) Whether to use HTML to render
  21088. * the labels.
  21089. */
  21090. useHTML?: boolean;
  21091. /**
  21092. * (Highcharts, Highstock, Highmaps, Gantt) The vertical alignment of a data
  21093. * label. Can be one of `top`, `middle` or `bottom`. The default value
  21094. * depends on the data, for instance in a column chart, the label is above
  21095. * positive values and below negative values.
  21096. */
  21097. verticalAlign?: (VerticalAlignValue|null);
  21098. /**
  21099. * (Highcharts, Highstock, Highmaps, Gantt) The x position offset of the
  21100. * label relative to the point in pixels.
  21101. */
  21102. x?: number;
  21103. /**
  21104. * (Highcharts, Highstock, Highmaps, Gantt) The y position offset of the
  21105. * label relative to the point in pixels.
  21106. */
  21107. y?: number;
  21108. /**
  21109. * (Highcharts, Highstock, Highmaps, Gantt) The Z index of the data labels.
  21110. * The default Z index puts it above the series. Use a Z index of 2 to
  21111. * display it behind the series.
  21112. */
  21113. z?: number;
  21114. }
  21115. /**
  21116. * (Highcharts, Highstock) Options for the series data sorting.
  21117. */
  21118. export interface PlotAreasplineDataSortingOptions {
  21119. /**
  21120. * (Highcharts, Highstock) Enable or disable data sorting for the series.
  21121. * Use xAxis.reversed to change the sorting order.
  21122. */
  21123. enabled?: boolean;
  21124. /**
  21125. * (Highcharts, Highstock) Whether to allow matching points by name in an
  21126. * update. If this option is disabled, points will be matched by order.
  21127. */
  21128. matchByName?: boolean;
  21129. /**
  21130. * (Highcharts, Highstock) Determines what data value should be used to sort
  21131. * by.
  21132. */
  21133. sortKey?: string;
  21134. }
  21135. /**
  21136. * (Highcharts, Highstock) Style options for the guide box. The guide box has
  21137. * one state by default, the `default` state.
  21138. */
  21139. export interface PlotAreasplineDragDropGuideBoxOptions {
  21140. /**
  21141. * (Highcharts, Highstock) Style options for the guide box default state.
  21142. */
  21143. default?: DragDropGuideBoxOptionsObject;
  21144. }
  21145. /**
  21146. * (Highcharts, Highstock) The area spline series is an area series where the
  21147. * graph between the points is smoothed into a spline.
  21148. *
  21149. * In TypeScript the type option must always be set.
  21150. *
  21151. * Configuration options for the series are given in three levels:
  21152. *
  21153. * 1. Options for all series in a chart are defined in the plotOptions.series
  21154. * object.
  21155. *
  21156. * 2. Options for all `areaspline` series are defined in plotOptions.areaspline.
  21157. *
  21158. * 3. Options for one single series are given in the series instance array. (see
  21159. * online documentation for example)
  21160. */
  21161. export interface PlotAreasplineOptions {
  21162. /**
  21163. * (Highcharts, Highstock) Accessibility options for a series.
  21164. */
  21165. accessibility?: SeriesAccessibilityOptionsObject;
  21166. /**
  21167. * (Highmaps) Whether all areas of the map defined in `mapData` should be
  21168. * rendered. If `true`, areas which don't correspond to a data point, are
  21169. * rendered as `null` points. If `false`, those areas are skipped.
  21170. */
  21171. allAreas?: boolean;
  21172. /**
  21173. * (Highcharts, Highstock) Allow this series' points to be selected by
  21174. * clicking on the graphic (columns, point markers, pie slices, map areas
  21175. * etc).
  21176. *
  21177. * The selected points can be handled by point select and unselect events,
  21178. * or collectively by the getSelectedPoints function.
  21179. *
  21180. * And alternative way of selecting points is through dragging.
  21181. */
  21182. allowPointSelect?: boolean;
  21183. /**
  21184. * (Highcharts, Highstock) Enable or disable the initial animation when a
  21185. * series is displayed. The animation can also be set as a configuration
  21186. * object. Please note that this option only applies to the initial
  21187. * animation of the series itself. For other animations, see chart.animation
  21188. * and the animation parameter under the API methods. The following
  21189. * properties are supported:
  21190. *
  21191. * - `defer`: The animation delay time in milliseconds.
  21192. *
  21193. * - `duration`: The duration of the animation in milliseconds.
  21194. *
  21195. * - `easing`: Can be a string reference to an easing function set on the
  21196. * `Math` object or a function. See the _Custom easing function_ demo below.
  21197. *
  21198. * Due to poor performance, animation is disabled in old IE browsers for
  21199. * several chart types.
  21200. */
  21201. animation?: (boolean|PlotAreasplineAnimationOptions|Partial<AnimationOptionsObject>);
  21202. /**
  21203. * (Highcharts, Highstock) For some series, there is a limit that shuts down
  21204. * initial animation by default when the total number of points in the chart
  21205. * is too high. For example, for a column chart and its derivatives,
  21206. * animation does not run if there is more than 250 points totally. To
  21207. * disable this cap, set `animationLimit` to `Infinity`.
  21208. */
  21209. animationLimit?: number;
  21210. /**
  21211. * (Highmaps) The border color of the map areas.
  21212. *
  21213. * In styled mode, the border stroke is given in the `.highcharts-point`
  21214. * class.
  21215. */
  21216. borderColor?: (ColorString|GradientColorObject|PatternObject);
  21217. /**
  21218. * (Highmaps) The border width of each map area.
  21219. *
  21220. * In styled mode, the border stroke width is given in the
  21221. * `.highcharts-point` class.
  21222. */
  21223. borderWidth?: number;
  21224. /**
  21225. * (Highcharts, Highstock) An additional class name to apply to the series'
  21226. * graphical elements. This option does not replace default class names of
  21227. * the graphical element.
  21228. */
  21229. className?: string;
  21230. /**
  21231. * (Highcharts, Highstock) Disable this option to allow series rendering in
  21232. * the whole plotting area.
  21233. *
  21234. * **Note:** Clipping should be always enabled when chart.zoomType is set
  21235. */
  21236. clip?: boolean;
  21237. /**
  21238. * (Highcharts, Highstock) The main color of the series. In line type series
  21239. * it applies to the line and the point markers unless otherwise specified.
  21240. * In bar type series it applies to the bars unless a color is specified per
  21241. * point. The default value is pulled from the `options.colors` array.
  21242. *
  21243. * In styled mode, the color can be defined by the colorIndex option. Also,
  21244. * the series color can be set with the `.highcharts-series`,
  21245. * `.highcharts-color-{n}`, `.highcharts-{type}-series` or
  21246. * `.highcharts-series-{n}` class, or individual classes given by the
  21247. * `className` option.
  21248. */
  21249. color?: (ColorString|GradientColorObject|PatternObject);
  21250. /**
  21251. * (Highcharts, Highstock, Highmaps) When using dual or multiple color axes,
  21252. * this number defines which colorAxis the particular series is connected
  21253. * to. It refers to either the axis id or the index of the axis in the
  21254. * colorAxis array, with 0 being the first. Set this option to false to
  21255. * prevent a series from connecting to the default color axis.
  21256. *
  21257. * Since v7.2.0 the option can also be an axis id or an axis index instead
  21258. * of a boolean flag.
  21259. */
  21260. colorAxis?: (boolean|number|string);
  21261. /**
  21262. * (Highcharts, Highstock) Styled mode only. A specific color index to use
  21263. * for the series, so its graphic representations are given the class name
  21264. * `highcharts-color-{n}`.
  21265. */
  21266. colorIndex?: number;
  21267. /**
  21268. * (Highcharts, Highstock, Highmaps) Determines what data value should be
  21269. * used to calculate point color if `colorAxis` is used. Requires to set
  21270. * `min` and `max` if some custom point property is used or if approximation
  21271. * for data grouping is set to `'sum'`.
  21272. */
  21273. colorKey?: string;
  21274. /**
  21275. * (Highstock) Compare the values of the series against the first non-null,
  21276. * non- zero value in the visible range. The y axis will show percentage or
  21277. * absolute change depending on whether `compare` is set to `"percent"` or
  21278. * `"value"`. When this is applied to multiple series, it allows comparing
  21279. * the development of the series against each other. Adds a `change` field
  21280. * to every point object.
  21281. */
  21282. compare?: string;
  21283. /**
  21284. * (Highstock) When compare is `percent`, this option dictates whether to
  21285. * use 0 or 100 as the base of comparison.
  21286. */
  21287. compareBase?: (0|100);
  21288. /**
  21289. * (Highstock) Defines if comparison should start from the first point
  21290. * within the visible range or should start from the first point **before**
  21291. * the range.
  21292. *
  21293. * In other words, this flag determines if first point within the visible
  21294. * range will have 0% (`compareStart=true`) or should have been already
  21295. * calculated according to the previous point (`compareStart=false`).
  21296. */
  21297. compareStart?: boolean;
  21298. /**
  21299. * (Highcharts) Polar charts only. Whether to connect the ends of a line
  21300. * series plot across the extremes.
  21301. */
  21302. connectEnds?: boolean;
  21303. /**
  21304. * (Highcharts, Highstock) Whether to connect a graph line across null
  21305. * points, or render a gap between the two points on either side of the
  21306. * null.
  21307. */
  21308. connectNulls?: boolean;
  21309. /**
  21310. * (Gantt) Override Pathfinder connector options for a series. Requires
  21311. * Highcharts Gantt to be loaded.
  21312. */
  21313. connectors?: SeriesConnectorsOptionsObject;
  21314. /**
  21315. * (Highcharts, Highstock, Gantt) When true, each point or column edge is
  21316. * rounded to its nearest pixel in order to render sharp on screen. In some
  21317. * cases, when there are a lot of densely packed columns, this leads to
  21318. * visible difference in column widths or distance between columns. In these
  21319. * cases, setting `crisp` to `false` may look better, even though each
  21320. * column is rendered blurry.
  21321. */
  21322. crisp?: boolean;
  21323. /**
  21324. * (Highcharts, Highstock) When the series contains less points than the
  21325. * crop threshold, all points are drawn, even if the points fall outside the
  21326. * visible plot area at the current zoom. The advantage of drawing all
  21327. * points (including markers and columns), is that animation is performed on
  21328. * updates. On the other hand, when the series contains more points than the
  21329. * crop threshold, the series data is cropped to only contain points that
  21330. * fall within the plot area. The advantage of cropping away invisible
  21331. * points is to increase performance on large series.
  21332. */
  21333. cropThreshold?: number;
  21334. /**
  21335. * (Highcharts, Highstock) You can set the cursor to "pointer" if you have
  21336. * click events attached to the series, to signal to the user that the
  21337. * points and lines can be clicked.
  21338. *
  21339. * In styled mode, the series cursor can be set with the same classes as
  21340. * listed under series.color.
  21341. */
  21342. cursor?: (string|CursorValue);
  21343. /**
  21344. * (Highcharts, Highstock) A reserved subspace to store options and values
  21345. * for customized functionality. Here you can add additional data for your
  21346. * own event callbacks and formatter callbacks.
  21347. */
  21348. custom?: Dictionary<any>;
  21349. /**
  21350. * (Highcharts, Highstock) Name of the dash style to use for the graph, or
  21351. * for some series types the outline of each shape.
  21352. *
  21353. * In styled mode, the stroke dash-array can be set with the same classes as
  21354. * listed under series.color.
  21355. */
  21356. dashStyle?: DashStyleValue;
  21357. /**
  21358. * (Highstock) Data grouping is the concept of sampling the data values into
  21359. * larger blocks in order to ease readability and increase performance of
  21360. * the JavaScript charts. Highstock by default applies data grouping when
  21361. * the points become closer than a certain pixel value, determined by the
  21362. * `groupPixelWidth` option.
  21363. *
  21364. * If data grouping is applied, the grouping information of grouped points
  21365. * can be read from the Point.dataGroup. If point options other than the
  21366. * data itself are set, for example `name` or `color` or custom properties,
  21367. * the grouping logic doesn't know how to group it. In this case the options
  21368. * of the first point instance are copied over to the group point. This can
  21369. * be altered through a custom `approximation` callback function.
  21370. */
  21371. dataGrouping?: DataGroupingOptionsObject;
  21372. /**
  21373. * (Highcharts, Highstock, Highmaps, Gantt) Options for the series data
  21374. * labels, appearing next to each data point.
  21375. *
  21376. * Since v6.2.0, multiple data labels can be applied to each single point by
  21377. * defining them as an array of configs.
  21378. *
  21379. * In styled mode, the data labels can be styled with the
  21380. * `.highcharts-data-label-box` and `.highcharts-data-label` class names
  21381. * (see example).
  21382. */
  21383. dataLabels?: (PlotAreasplineDataLabelsOptions|Array<PlotAreasplineDataLabelsOptions>);
  21384. /**
  21385. * (Highcharts, Highstock) Options for the series data sorting.
  21386. */
  21387. dataSorting?: (DataSortingOptionsObject|PlotAreasplineDataSortingOptions);
  21388. /**
  21389. * (Highcharts, Highstock) A description of the series to add to the screen
  21390. * reader information about the series.
  21391. */
  21392. description?: string;
  21393. /**
  21394. * (Highcharts, Highstock) The draggable-points module allows points to be
  21395. * moved around or modified in the chart. In addition to the options
  21396. * mentioned under the `dragDrop` API structure, the module fires three
  21397. * events, point.dragStart, point.drag and point.drop.
  21398. */
  21399. dragDrop?: SeriesDragDropOptionsObject;
  21400. /**
  21401. * (Highcharts, Highstock) Enable or disable the mouse tracking for a
  21402. * specific series. This includes point tooltips and click events on graphs
  21403. * and points. For large datasets it improves performance.
  21404. */
  21405. enableMouseTracking?: boolean;
  21406. /**
  21407. * (Highcharts, Highstock) General event handlers for the series items.
  21408. * These event hooks can also be attached to the series at run time using
  21409. * the `Highcharts.addEvent` function.
  21410. */
  21411. events?: SeriesEventsOptionsObject;
  21412. /**
  21413. * (Highcharts, Highstock) Fill color or gradient for the area. When `null`,
  21414. * the series' `color` is used with the series' `fillOpacity`.
  21415. *
  21416. * In styled mode, the fill color can be set with the `.highcharts-area`
  21417. * class name.
  21418. */
  21419. fillColor?: (ColorString|GradientColorObject|PatternObject);
  21420. /**
  21421. * (Highcharts, Highstock) Fill opacity for the area. When you set an
  21422. * explicit `fillColor`, the `fillOpacity` is not applied. Instead, you
  21423. * should define the opacity in the `fillColor` with an rgba color
  21424. * definition. The `fillOpacity` setting, also the default setting,
  21425. * overrides the alpha component of the `color` setting.
  21426. *
  21427. * In styled mode, the fill opacity can be set with the `.highcharts-area`
  21428. * class name.
  21429. */
  21430. fillOpacity?: number;
  21431. /**
  21432. * (Highcharts, Highstock) Determines whether the series should look for the
  21433. * nearest point in both dimensions or just the x-dimension when hovering
  21434. * the series. Defaults to `'xy'` for scatter series and `'x'` for most
  21435. * other series. If the data has duplicate x-values, it is recommended to
  21436. * set this to `'xy'` to allow hovering over all points.
  21437. *
  21438. * Applies only to series types using nearest neighbor search (not direct
  21439. * hover) for tooltip.
  21440. */
  21441. findNearestPointBy?: OptionsFindNearestPointByValue;
  21442. /**
  21443. * (Highstock) Defines when to display a gap in the graph, together with the
  21444. * gapUnit option.
  21445. *
  21446. * In case when `dataGrouping` is enabled, points can be grouped into a
  21447. * larger time span. This can make the grouped points to have a greater
  21448. * distance than the absolute value of `gapSize` property, which will result
  21449. * in disappearing graph completely. To prevent this situation the mentioned
  21450. * distance between grouped points is used instead of previously defined
  21451. * `gapSize`.
  21452. *
  21453. * In practice, this option is most often used to visualize gaps in time
  21454. * series. In a stock chart, intraday data is available for daytime hours,
  21455. * while gaps will appear in nights and weekends.
  21456. */
  21457. gapSize?: number;
  21458. /**
  21459. * (Highstock) Together with gapSize, this option defines where to draw gaps
  21460. * in the graph.
  21461. *
  21462. * When the `gapUnit` is `"relative"` (default), a gap size of 5 means that
  21463. * if the distance between two points is greater than 5 times that of the
  21464. * two closest points, the graph will be broken.
  21465. *
  21466. * When the `gapUnit` is `"value"`, the gap is based on absolute axis
  21467. * values, which on a datetime axis is milliseconds. This also applies to
  21468. * the navigator series that inherits gap options from the base series.
  21469. */
  21470. gapUnit?: OptionsGapUnitValue;
  21471. /**
  21472. * (Highcharts, Highstock, Gantt) Whether to use the Y extremes of the total
  21473. * chart width or only the zoomed area when zooming in on parts of the X
  21474. * axis. By default, the Y axis adjusts to the min and max of the visible
  21475. * data. Cartesian series only.
  21476. */
  21477. getExtremesFromAll?: boolean;
  21478. /**
  21479. * (Highcharts, Highstock) When set to `false` will prevent the series data
  21480. * from being included in any form of data export.
  21481. *
  21482. * Since version 6.0.0 until 7.1.0 the option was existing undocumented as
  21483. * `includeInCSVExport`.
  21484. */
  21485. includeInDataExport?: boolean;
  21486. /**
  21487. * (Highmaps) What property to join the `mapData` to the value data. For
  21488. * example, if joinBy is "code", the mapData items with a specific code is
  21489. * merged into the data with the same code. For maps loaded from GeoJSON,
  21490. * the keys may be held in each point's `properties` object.
  21491. *
  21492. * The joinBy option can also be an array of two values, where the first
  21493. * points to a key in the `mapData`, and the second points to another key in
  21494. * the `data`.
  21495. *
  21496. * When joinBy is `null`, the map items are joined by their position in the
  21497. * array, which performs much better in maps with many data points. This is
  21498. * the recommended option if you are printing more than a thousand data
  21499. * points and have a backend that can preprocess the data into a parallel
  21500. * array of the mapData.
  21501. */
  21502. joinBy?: (string|Array<string>);
  21503. /**
  21504. * (Highcharts, Highstock) An array specifying which option maps to which
  21505. * key in the data point array. This makes it convenient to work with
  21506. * unstructured data arrays from different sources.
  21507. */
  21508. keys?: Array<string>;
  21509. /**
  21510. * (Highcharts, Highstock, Gantt) Series labels are placed as close to the
  21511. * series as possible in a natural way, seeking to avoid other series. The
  21512. * goal of this feature is to make the chart more easily readable, like if a
  21513. * human designer placed the labels in the optimal position.
  21514. *
  21515. * The series labels currently work with series types having a `graph` or an
  21516. * `area`.
  21517. */
  21518. label?: SeriesLabelOptionsObject;
  21519. /**
  21520. * (Highstock) The line marks the last price from all points.
  21521. */
  21522. lastPrice?: SeriesLastPriceOptionsObject;
  21523. /**
  21524. * (Highstock) The line marks the last price from visible range of points.
  21525. */
  21526. lastVisiblePrice?: SeriesLastVisiblePriceOptionsObject;
  21527. /**
  21528. * (Highcharts, Highstock) The SVG value used for the `stroke-linecap` and
  21529. * `stroke-linejoin` of a line graph. Round means that lines are rounded in
  21530. * the ends and bends.
  21531. */
  21532. linecap?: SeriesLinecapValue;
  21533. /**
  21534. * (Highcharts, Highstock) A separate color for the graph line. By default
  21535. * the line takes the `color` of the series, but the lineColor setting
  21536. * allows setting a separate color for the line without altering the
  21537. * `fillColor`.
  21538. *
  21539. * In styled mode, the line stroke can be set with the `.highcharts-graph`
  21540. * class name.
  21541. */
  21542. lineColor?: (ColorString|GradientColorObject|PatternObject);
  21543. /**
  21544. * (Highcharts, Highstock) Pixel width of the graph line.
  21545. */
  21546. lineWidth?: number;
  21547. /**
  21548. * (Highcharts, Highstock, Gantt) The id of another series to link to.
  21549. * Additionally, the value can be ":previous" to link to the previous
  21550. * series. When two series are linked, only the first one appears in the
  21551. * legend. Toggling the visibility of this also toggles the linked series.
  21552. *
  21553. * If master series uses data sorting and linked series does not have its
  21554. * own sorting definition, the linked series will be sorted in the same
  21555. * order as the master one.
  21556. */
  21557. linkedTo?: string;
  21558. /**
  21559. * (Highcharts, Highstock) Options for the point markers of line-like
  21560. * series. Properties like `fillColor`, `lineColor` and `lineWidth` define
  21561. * the visual appearance of the markers. Other series types, like column
  21562. * series, don't have markers, but have visual options on the series level
  21563. * instead.
  21564. *
  21565. * In styled mode, the markers can be styled with the `.highcharts-point`,
  21566. * `.highcharts-point-hover` and `.highcharts-point-select` class names.
  21567. */
  21568. marker?: PointMarkerOptionsObject;
  21569. /**
  21570. * (Highstock) Options for the corresponding navigator series if
  21571. * `showInNavigator` is `true` for this series. Available options are the
  21572. * same as any series, documented at plotOptions and series.
  21573. *
  21574. * These options are merged with options in navigator.series, and will take
  21575. * precedence if the same option is defined both places.
  21576. */
  21577. navigatorOptions?: PlotSeriesOptions;
  21578. /**
  21579. * (Highcharts, Highstock) The color for the parts of the graph or points
  21580. * that are below the threshold. Note that `zones` takes precedence over the
  21581. * negative color. Using `negativeColor` is equivalent to applying a zone
  21582. * with value of 0.
  21583. */
  21584. negativeColor?: (ColorString|GradientColorObject|PatternObject);
  21585. /**
  21586. * (Highcharts) A separate color for the negative part of the area.
  21587. *
  21588. * In styled mode, a negative color is set with the `.highcharts-negative`
  21589. * class name.
  21590. */
  21591. negativeFillColor?: (ColorString|GradientColorObject|PatternObject);
  21592. /**
  21593. * (Highcharts, Highstock) Opacity of a series parts: line, fill (e.g. area)
  21594. * and dataLabels.
  21595. */
  21596. opacity?: number;
  21597. /**
  21598. * (Highcharts, Highstock) Properties for each single point.
  21599. */
  21600. point?: PlotSeriesPointOptions;
  21601. /**
  21602. * (Highcharts, Highstock) Same as accessibility.pointDescriptionFormatter,
  21603. * but for an individual series. Overrides the chart wide configuration.
  21604. */
  21605. pointDescriptionFormatter?: Function;
  21606. /**
  21607. * (Highcharts, Highstock, Gantt) If no x values are given for the points in
  21608. * a series, `pointInterval` defines the interval of the x values. For
  21609. * example, if a series contains one value every decade starting from year
  21610. * 0, set `pointInterval` to `10`. In true `datetime` axes, the
  21611. * `pointInterval` is set in milliseconds.
  21612. *
  21613. * It can be also be combined with `pointIntervalUnit` to draw irregular
  21614. * time intervals.
  21615. *
  21616. * Please note that this options applies to the _series data_, not the
  21617. * interval of the axis ticks, which is independent.
  21618. */
  21619. pointInterval?: number;
  21620. /**
  21621. * (Highcharts, Highstock, Gantt) On datetime series, this allows for
  21622. * setting the pointInterval to irregular time units, `day`, `month` and
  21623. * `year`. A day is usually the same as 24 hours, but `pointIntervalUnit`
  21624. * also takes the DST crossover into consideration when dealing with local
  21625. * time. Combine this option with `pointInterval` to draw weeks, quarters, 6
  21626. * months, 10 years etc.
  21627. *
  21628. * Please note that this options applies to the _series data_, not the
  21629. * interval of the axis ticks, which is independent.
  21630. */
  21631. pointIntervalUnit?: OptionsPointIntervalUnitValue;
  21632. /**
  21633. * (Highcharts, Highstock, Gantt) Possible values: `"on"`, `"between"`,
  21634. * `number`.
  21635. *
  21636. * In a column chart, when pointPlacement is `"on"`, the point will not
  21637. * create any padding of the X axis. In a polar column chart this means that
  21638. * the first column points directly north. If the pointPlacement is
  21639. * `"between"`, the columns will be laid out between ticks. This is useful
  21640. * for example for visualising an amount between two points in time or in a
  21641. * certain sector of a polar chart.
  21642. *
  21643. * Since Highcharts 3.0.2, the point placement can also be numeric, where 0
  21644. * is on the axis value, -0.5 is between this value and the previous, and
  21645. * 0.5 is between this value and the next. Unlike the textual options,
  21646. * numeric point placement options won't affect axis padding.
  21647. *
  21648. * Note that pointPlacement needs a pointRange to work. For column series
  21649. * this is computed, but for line-type series it needs to be set.
  21650. *
  21651. * For the `xrange` series type and gantt charts, if the Y axis is a
  21652. * category axis, the `pointPlacement` applies to the Y axis rather than the
  21653. * (typically datetime) X axis.
  21654. *
  21655. * Defaults to `undefined` in cartesian charts, `"between"` in polar charts.
  21656. */
  21657. pointPlacement?: (number|string);
  21658. /**
  21659. * (Highstock) The width of each point on the x axis. For example in a
  21660. * column chart with one value each day, the pointRange would be 1 day (= 24
  21661. * * 3600
  21662. *
  21663. * * 1000 milliseconds). This is normally computed automatically, but this
  21664. * option can be used to override the automatic value.
  21665. */
  21666. pointRange?: number;
  21667. /**
  21668. * (Highcharts, Highstock, Gantt) If no x values are given for the points in
  21669. * a series, pointStart defines on what value to start. For example, if a
  21670. * series contains one yearly value starting from 1945, set pointStart to
  21671. * 1945.
  21672. */
  21673. pointStart?: number;
  21674. /**
  21675. * (Highcharts, Highstock) Whether to select the series initially. If
  21676. * `showCheckbox` is true, the checkbox next to the series name in the
  21677. * legend will be checked for a selected series.
  21678. */
  21679. selected?: boolean;
  21680. /**
  21681. * (Highcharts, Highstock) Whether to apply a drop shadow to the graph line.
  21682. * Since 2.3 the shadow can be an object configuration containing `color`,
  21683. * `offsetX`, `offsetY`, `opacity` and `width`.
  21684. */
  21685. shadow?: (boolean|ShadowOptionsObject);
  21686. /**
  21687. * (Highcharts, Highstock) If true, a checkbox is displayed next to the
  21688. * legend item to allow selecting the series. The state of the checkbox is
  21689. * determined by the `selected` option.
  21690. */
  21691. showCheckbox?: boolean;
  21692. /**
  21693. * (Highcharts, Highstock) Whether to display this particular series or
  21694. * series type in the legend. Standalone series are shown in legend by
  21695. * default, and linked series are not. Since v7.2.0 it is possible to show
  21696. * series that use colorAxis by setting this option to `true`.
  21697. */
  21698. showInLegend?: boolean;
  21699. /**
  21700. * (Highstock) Whether or not to show the series in the navigator. Takes
  21701. * precedence over navigator.baseSeries if defined.
  21702. */
  21703. showInNavigator?: boolean;
  21704. /**
  21705. * (Highcharts, Highstock) If set to `true`, the accessibility module will
  21706. * skip past the points in this series for keyboard navigation.
  21707. */
  21708. skipKeyboardNavigation?: boolean;
  21709. /**
  21710. * (Highcharts, Highstock) When this is true, the series will not cause the
  21711. * Y axis to cross the zero plane (or threshold option) unless the data
  21712. * actually crosses the plane.
  21713. *
  21714. * For example, if `softThreshold` is `false`, a series of 0, 1, 2, 3 will
  21715. * make the Y axis show negative values according to the `minPadding`
  21716. * option. If `softThreshold` is `true`, the Y axis starts at 0.
  21717. */
  21718. softThreshold?: boolean;
  21719. /**
  21720. * (Highcharts, Highstock) Whether to stack the values of each series on top
  21721. * of each other. Possible values are `undefined` to disable, `"normal"` to
  21722. * stack by value or `"percent"`.
  21723. *
  21724. * When stacking is enabled, data must be sorted in ascending X order.
  21725. *
  21726. * Some stacking options are related to specific series types. In the
  21727. * streamgraph series type, the stacking option is set to `"stream"`. The
  21728. * second one is `"overlap"`, which only applies to waterfall series.
  21729. */
  21730. stacking?: OptionsStackingValue;
  21731. states?: SeriesStatesOptionsObject;
  21732. /**
  21733. * (Highcharts, Highstock) Sticky tracking of mouse events. When true, the
  21734. * `mouseOut` event on a series isn't triggered until the mouse moves over
  21735. * another series, or out of the plot area. When false, the `mouseOut` event
  21736. * on a series is triggered when the mouse leaves the area around the
  21737. * series' graph or markers. This also implies the tooltip when not shared.
  21738. * When `stickyTracking` is false and `tooltip.shared` is false, the tooltip
  21739. * will be hidden when moving the mouse between series. Defaults to true for
  21740. * line and area type series, but to false for columns, pies etc.
  21741. *
  21742. * **Note:** The boost module will force this option because of technical
  21743. * limitations.
  21744. */
  21745. stickyTracking?: boolean;
  21746. /**
  21747. * (Highcharts, Highstock) The Y axis value to serve as the base for the
  21748. * area, for distinguishing between values above and below a threshold. The
  21749. * area between the graph and the threshold is filled.
  21750. *
  21751. * * If a number is given, the Y axis will scale to the threshold.
  21752. *
  21753. * * If `null`, the scaling behaves like a line series with fill between the
  21754. * graph and the Y axis minimum.
  21755. *
  21756. * * If `Infinity` or `-Infinity`, the area between the graph and the
  21757. * corresponding Y axis extreme is filled (since v6.1.0).
  21758. */
  21759. threshold?: (number|null);
  21760. /**
  21761. * (Highcharts, Highstock) A configuration object for the tooltip rendering
  21762. * of each single series. Properties are inherited from tooltip, but only
  21763. * the following properties can be defined on a series level.
  21764. */
  21765. tooltip?: SeriesTooltipOptionsObject;
  21766. /**
  21767. * (Highcharts, Highstock) Whether the whole area or just the line should
  21768. * respond to mouseover tooltips and other mouse or touch events.
  21769. */
  21770. trackByArea?: boolean;
  21771. /**
  21772. * (Highcharts, Highstock, Gantt) When a series contains a data array that
  21773. * is longer than this, only one dimensional arrays of numbers, or two
  21774. * dimensional arrays with x and y values are allowed. Also, only the first
  21775. * point is tested, and the rest are assumed to be the same format. This
  21776. * saves expensive data checking and indexing in long series. Set it to `0`
  21777. * disable.
  21778. *
  21779. * Note: In boost mode turbo threshold is forced. Only array of numbers or
  21780. * two dimensional arrays are allowed.
  21781. */
  21782. turboThreshold?: number;
  21783. /**
  21784. * (Highcharts, Highstock) Set the initial visibility of the series.
  21785. */
  21786. visible?: boolean;
  21787. /**
  21788. * (Highmaps) Define the z index of the series.
  21789. */
  21790. zIndex?: number;
  21791. /**
  21792. * (Highcharts, Highstock) Defines the Axis on which the zones are applied.
  21793. */
  21794. zoneAxis?: string;
  21795. /**
  21796. * (Highcharts, Highstock) An array defining zones within a series. Zones
  21797. * can be applied to the X axis, Y axis or Z axis for bubbles, according to
  21798. * the `zoneAxis` option. The zone definitions have to be in ascending order
  21799. * regarding to the value.
  21800. *
  21801. * In styled mode, the color zones are styled with the
  21802. * `.highcharts-zone-{n}` class, or custom classed from the `className`
  21803. * option (view live demo).
  21804. */
  21805. zones?: Array<SeriesZonesOptionsObject>;
  21806. }
  21807. /**
  21808. * (Highcharts, Highstock) Enable or disable the initial animation when a series
  21809. * is displayed. The animation can also be set as a configuration object. Please
  21810. * note that this option only applies to the initial animation of the series
  21811. * itself. For other animations, see chart.animation and the animation parameter
  21812. * under the API methods. The following properties are supported:
  21813. *
  21814. * - `defer`: The animation delay time in milliseconds.
  21815. *
  21816. * - `duration`: The duration of the animation in milliseconds.
  21817. *
  21818. * - `easing`: Can be a string reference to an easing function set on the `Math`
  21819. * object or a function. See the _Custom easing function_ demo below.
  21820. *
  21821. * Due to poor performance, animation is disabled in old IE browsers for several
  21822. * chart types.
  21823. */
  21824. export interface PlotAreasplinerangeAnimationOptions {
  21825. defer?: number;
  21826. }
  21827. /**
  21828. * (Highcharts, Highstock) Enable or disable the initial animation when a series
  21829. * is displayed for the `dataLabels`. The animation can also be set as a
  21830. * configuration object. Please note that this option only applies to the
  21831. * initial animation. For other animations, see chart.animation and the
  21832. * animation parameter under the API methods. The following properties are
  21833. * supported:
  21834. *
  21835. * - `defer`: The animation delay time in milliseconds.
  21836. */
  21837. export interface PlotAreasplinerangeDataLabelsAnimationOptions {
  21838. /**
  21839. * (Highcharts, Highstock) The animation delay time in milliseconds. Set to
  21840. * `0` renders dataLabel immediately. As `undefined` inherits defer time
  21841. * from the series.animation.defer.
  21842. */
  21843. defer?: number;
  21844. }
  21845. /**
  21846. * (Highcharts, Highstock) Options for the series data sorting.
  21847. */
  21848. export interface PlotAreasplinerangeDataSortingOptions {
  21849. /**
  21850. * (Highcharts, Highstock) Enable or disable data sorting for the series.
  21851. * Use xAxis.reversed to change the sorting order.
  21852. */
  21853. enabled?: boolean;
  21854. /**
  21855. * (Highcharts, Highstock) Whether to allow matching points by name in an
  21856. * update. If this option is disabled, points will be matched by order.
  21857. */
  21858. matchByName?: boolean;
  21859. /**
  21860. * (Highcharts, Highstock) Determines what data value should be used to sort
  21861. * by.
  21862. */
  21863. sortKey?: string;
  21864. }
  21865. /**
  21866. * (Highcharts, Highstock) Style options for the guide box. The guide box has
  21867. * one state by default, the `default` state.
  21868. */
  21869. export interface PlotAreasplinerangeDragDropGuideBoxOptions {
  21870. /**
  21871. * (Highcharts, Highstock) Style options for the guide box default state.
  21872. */
  21873. default?: DragDropGuideBoxOptionsObject;
  21874. }
  21875. /**
  21876. * (Highcharts, Highstock) The area spline range is a cartesian series type with
  21877. * higher and lower Y values along an X axis. The area inside the range is
  21878. * colored, and the graph outlining the area is a smoothed spline.
  21879. *
  21880. * In TypeScript the type option must always be set.
  21881. *
  21882. * Configuration options for the series are given in three levels:
  21883. *
  21884. * 1. Options for all series in a chart are defined in the plotOptions.series
  21885. * object.
  21886. *
  21887. * 2. Options for all `areasplinerange` series are defined in
  21888. * plotOptions.areasplinerange.
  21889. *
  21890. * 3. Options for one single series are given in the series instance array. (see
  21891. * online documentation for example)
  21892. */
  21893. export interface PlotAreasplinerangeOptions {
  21894. /**
  21895. * (Highcharts, Highstock) Accessibility options for a series.
  21896. */
  21897. accessibility?: SeriesAccessibilityOptionsObject;
  21898. /**
  21899. * (Highmaps) Whether all areas of the map defined in `mapData` should be
  21900. * rendered. If `true`, areas which don't correspond to a data point, are
  21901. * rendered as `null` points. If `false`, those areas are skipped.
  21902. */
  21903. allAreas?: boolean;
  21904. /**
  21905. * (Highcharts, Highstock) Allow this series' points to be selected by
  21906. * clicking on the graphic (columns, point markers, pie slices, map areas
  21907. * etc).
  21908. *
  21909. * The selected points can be handled by point select and unselect events,
  21910. * or collectively by the getSelectedPoints function.
  21911. *
  21912. * And alternative way of selecting points is through dragging.
  21913. */
  21914. allowPointSelect?: boolean;
  21915. /**
  21916. * (Highcharts, Highstock) Enable or disable the initial animation when a
  21917. * series is displayed. The animation can also be set as a configuration
  21918. * object. Please note that this option only applies to the initial
  21919. * animation of the series itself. For other animations, see chart.animation
  21920. * and the animation parameter under the API methods. The following
  21921. * properties are supported:
  21922. *
  21923. * - `defer`: The animation delay time in milliseconds.
  21924. *
  21925. * - `duration`: The duration of the animation in milliseconds.
  21926. *
  21927. * - `easing`: Can be a string reference to an easing function set on the
  21928. * `Math` object or a function. See the _Custom easing function_ demo below.
  21929. *
  21930. * Due to poor performance, animation is disabled in old IE browsers for
  21931. * several chart types.
  21932. */
  21933. animation?: (boolean|PlotAreasplinerangeAnimationOptions|Partial<AnimationOptionsObject>);
  21934. /**
  21935. * (Highcharts, Highstock) For some series, there is a limit that shuts down
  21936. * initial animation by default when the total number of points in the chart
  21937. * is too high. For example, for a column chart and its derivatives,
  21938. * animation does not run if there is more than 250 points totally. To
  21939. * disable this cap, set `animationLimit` to `Infinity`.
  21940. */
  21941. animationLimit?: number;
  21942. /**
  21943. * (Highmaps) The border color of the map areas.
  21944. *
  21945. * In styled mode, the border stroke is given in the `.highcharts-point`
  21946. * class.
  21947. */
  21948. borderColor?: (ColorString|GradientColorObject|PatternObject);
  21949. /**
  21950. * (Highmaps) The border width of each map area.
  21951. *
  21952. * In styled mode, the border stroke width is given in the
  21953. * `.highcharts-point` class.
  21954. */
  21955. borderWidth?: number;
  21956. /**
  21957. * (Highcharts, Highstock) An additional class name to apply to the series'
  21958. * graphical elements. This option does not replace default class names of
  21959. * the graphical element.
  21960. */
  21961. className?: string;
  21962. /**
  21963. * (Highcharts, Highstock) Disable this option to allow series rendering in
  21964. * the whole plotting area.
  21965. *
  21966. * **Note:** Clipping should be always enabled when chart.zoomType is set
  21967. */
  21968. clip?: boolean;
  21969. /**
  21970. * (Highcharts, Highstock) The main color of the series. In line type series
  21971. * it applies to the line and the point markers unless otherwise specified.
  21972. * In bar type series it applies to the bars unless a color is specified per
  21973. * point. The default value is pulled from the `options.colors` array.
  21974. *
  21975. * In styled mode, the color can be defined by the colorIndex option. Also,
  21976. * the series color can be set with the `.highcharts-series`,
  21977. * `.highcharts-color-{n}`, `.highcharts-{type}-series` or
  21978. * `.highcharts-series-{n}` class, or individual classes given by the
  21979. * `className` option.
  21980. */
  21981. color?: (ColorString|GradientColorObject|PatternObject);
  21982. /**
  21983. * (Highcharts, Highstock, Highmaps) When using dual or multiple color axes,
  21984. * this number defines which colorAxis the particular series is connected
  21985. * to. It refers to either the axis id or the index of the axis in the
  21986. * colorAxis array, with 0 being the first. Set this option to false to
  21987. * prevent a series from connecting to the default color axis.
  21988. *
  21989. * Since v7.2.0 the option can also be an axis id or an axis index instead
  21990. * of a boolean flag.
  21991. */
  21992. colorAxis?: (boolean|number|string);
  21993. /**
  21994. * (Highcharts, Highstock) Styled mode only. A specific color index to use
  21995. * for the series, so its graphic representations are given the class name
  21996. * `highcharts-color-{n}`.
  21997. */
  21998. colorIndex?: number;
  21999. /**
  22000. * (Highcharts, Highstock, Highmaps) Determines what data value should be
  22001. * used to calculate point color if `colorAxis` is used. Requires to set
  22002. * `min` and `max` if some custom point property is used or if approximation
  22003. * for data grouping is set to `'sum'`.
  22004. */
  22005. colorKey?: string;
  22006. /**
  22007. * (Highstock) Compare the values of the series against the first non-null,
  22008. * non- zero value in the visible range. The y axis will show percentage or
  22009. * absolute change depending on whether `compare` is set to `"percent"` or
  22010. * `"value"`. When this is applied to multiple series, it allows comparing
  22011. * the development of the series against each other. Adds a `change` field
  22012. * to every point object.
  22013. */
  22014. compare?: string;
  22015. /**
  22016. * (Highstock) When compare is `percent`, this option dictates whether to
  22017. * use 0 or 100 as the base of comparison.
  22018. */
  22019. compareBase?: (0|100);
  22020. /**
  22021. * (Highstock) Defines if comparison should start from the first point
  22022. * within the visible range or should start from the first point **before**
  22023. * the range.
  22024. *
  22025. * In other words, this flag determines if first point within the visible
  22026. * range will have 0% (`compareStart=true`) or should have been already
  22027. * calculated according to the previous point (`compareStart=false`).
  22028. */
  22029. compareStart?: boolean;
  22030. /**
  22031. * (Highcharts) Polar charts only. Whether to connect the ends of a line
  22032. * series plot across the extremes.
  22033. */
  22034. connectEnds?: boolean;
  22035. /**
  22036. * (Highcharts, Highstock) Whether to connect a graph line across null
  22037. * points, or render a gap between the two points on either side of the
  22038. * null.
  22039. */
  22040. connectNulls?: boolean;
  22041. /**
  22042. * (Gantt) Override Pathfinder connector options for a series. Requires
  22043. * Highcharts Gantt to be loaded.
  22044. */
  22045. connectors?: SeriesConnectorsOptionsObject;
  22046. /**
  22047. * (Highcharts, Highstock, Gantt) When true, each point or column edge is
  22048. * rounded to its nearest pixel in order to render sharp on screen. In some
  22049. * cases, when there are a lot of densely packed columns, this leads to
  22050. * visible difference in column widths or distance between columns. In these
  22051. * cases, setting `crisp` to `false` may look better, even though each
  22052. * column is rendered blurry.
  22053. */
  22054. crisp?: boolean;
  22055. /**
  22056. * (Highcharts, Highstock) When the series contains less points than the
  22057. * crop threshold, all points are drawn, even if the points fall outside the
  22058. * visible plot area at the current zoom. The advantage of drawing all
  22059. * points (including markers and columns), is that animation is performed on
  22060. * updates. On the other hand, when the series contains more points than the
  22061. * crop threshold, the series data is cropped to only contain points that
  22062. * fall within the plot area. The advantage of cropping away invisible
  22063. * points is to increase performance on large series.
  22064. */
  22065. cropThreshold?: number;
  22066. /**
  22067. * (Highcharts, Highstock) You can set the cursor to "pointer" if you have
  22068. * click events attached to the series, to signal to the user that the
  22069. * points and lines can be clicked.
  22070. *
  22071. * In styled mode, the series cursor can be set with the same classes as
  22072. * listed under series.color.
  22073. */
  22074. cursor?: (string|CursorValue);
  22075. /**
  22076. * (Highcharts, Highstock) A reserved subspace to store options and values
  22077. * for customized functionality. Here you can add additional data for your
  22078. * own event callbacks and formatter callbacks.
  22079. */
  22080. custom?: Dictionary<any>;
  22081. /**
  22082. * (Highcharts, Highstock) Name of the dash style to use for the graph, or
  22083. * for some series types the outline of each shape.
  22084. *
  22085. * In styled mode, the stroke dash-array can be set with the same classes as
  22086. * listed under series.color.
  22087. */
  22088. dashStyle?: DashStyleValue;
  22089. /**
  22090. * (Highstock) Data grouping is the concept of sampling the data values into
  22091. * larger blocks in order to ease readability and increase performance of
  22092. * the JavaScript charts. Highstock by default applies data grouping when
  22093. * the points become closer than a certain pixel value, determined by the
  22094. * `groupPixelWidth` option.
  22095. *
  22096. * If data grouping is applied, the grouping information of grouped points
  22097. * can be read from the Point.dataGroup. If point options other than the
  22098. * data itself are set, for example `name` or `color` or custom properties,
  22099. * the grouping logic doesn't know how to group it. In this case the options
  22100. * of the first point instance are copied over to the group point. This can
  22101. * be altered through a custom `approximation` callback function.
  22102. */
  22103. dataGrouping?: DataGroupingOptionsObject;
  22104. /**
  22105. * (Highcharts, Highstock) Extended data labels for range series types.
  22106. * Range series data labels use no `x` and `y` options. Instead, they have
  22107. * `xLow`, `xHigh`, `yLow` and `yHigh` options to allow the higher and lower
  22108. * data label sets individually.
  22109. */
  22110. dataLabels?: (SeriesAreaRangeDataLabelsOptionsObject|Array<SeriesAreaRangeDataLabelsOptionsObject>);
  22111. /**
  22112. * (Highcharts, Highstock) Options for the series data sorting.
  22113. */
  22114. dataSorting?: (DataSortingOptionsObject|PlotAreasplinerangeDataSortingOptions);
  22115. /**
  22116. * (Highcharts, Highstock) A description of the series to add to the screen
  22117. * reader information about the series.
  22118. */
  22119. description?: string;
  22120. /**
  22121. * (Highcharts, Highstock) The draggable-points module allows points to be
  22122. * moved around or modified in the chart. In addition to the options
  22123. * mentioned under the `dragDrop` API structure, the module fires three
  22124. * events, point.dragStart, point.drag and point.drop.
  22125. */
  22126. dragDrop?: SeriesDragDropOptionsObject;
  22127. /**
  22128. * (Highcharts, Highstock) Enable or disable the mouse tracking for a
  22129. * specific series. This includes point tooltips and click events on graphs
  22130. * and points. For large datasets it improves performance.
  22131. */
  22132. enableMouseTracking?: boolean;
  22133. /**
  22134. * (Highcharts, Highstock) General event handlers for the series items.
  22135. * These event hooks can also be attached to the series at run time using
  22136. * the `Highcharts.addEvent` function.
  22137. */
  22138. events?: SeriesEventsOptionsObject;
  22139. /**
  22140. * (Highcharts, Highstock) Fill color or gradient for the area. When `null`,
  22141. * the series' `color` is used with the series' `fillOpacity`.
  22142. *
  22143. * In styled mode, the fill color can be set with the `.highcharts-area`
  22144. * class name.
  22145. */
  22146. fillColor?: (ColorString|GradientColorObject|PatternObject);
  22147. /**
  22148. * (Highcharts, Highstock) Fill opacity for the area. When you set an
  22149. * explicit `fillColor`, the `fillOpacity` is not applied. Instead, you
  22150. * should define the opacity in the `fillColor` with an rgba color
  22151. * definition. The `fillOpacity` setting, also the default setting,
  22152. * overrides the alpha component of the `color` setting.
  22153. *
  22154. * In styled mode, the fill opacity can be set with the `.highcharts-area`
  22155. * class name.
  22156. */
  22157. fillOpacity?: number;
  22158. /**
  22159. * (Highcharts, Highstock) Determines whether the series should look for the
  22160. * nearest point in both dimensions or just the x-dimension when hovering
  22161. * the series. Defaults to `'xy'` for scatter series and `'x'` for most
  22162. * other series. If the data has duplicate x-values, it is recommended to
  22163. * set this to `'xy'` to allow hovering over all points.
  22164. *
  22165. * Applies only to series types using nearest neighbor search (not direct
  22166. * hover) for tooltip.
  22167. */
  22168. findNearestPointBy?: OptionsFindNearestPointByValue;
  22169. /**
  22170. * (Highstock) Defines when to display a gap in the graph, together with the
  22171. * gapUnit option.
  22172. *
  22173. * In case when `dataGrouping` is enabled, points can be grouped into a
  22174. * larger time span. This can make the grouped points to have a greater
  22175. * distance than the absolute value of `gapSize` property, which will result
  22176. * in disappearing graph completely. To prevent this situation the mentioned
  22177. * distance between grouped points is used instead of previously defined
  22178. * `gapSize`.
  22179. *
  22180. * In practice, this option is most often used to visualize gaps in time
  22181. * series. In a stock chart, intraday data is available for daytime hours,
  22182. * while gaps will appear in nights and weekends.
  22183. */
  22184. gapSize?: number;
  22185. /**
  22186. * (Highstock) Together with gapSize, this option defines where to draw gaps
  22187. * in the graph.
  22188. *
  22189. * When the `gapUnit` is `"relative"` (default), a gap size of 5 means that
  22190. * if the distance between two points is greater than 5 times that of the
  22191. * two closest points, the graph will be broken.
  22192. *
  22193. * When the `gapUnit` is `"value"`, the gap is based on absolute axis
  22194. * values, which on a datetime axis is milliseconds. This also applies to
  22195. * the navigator series that inherits gap options from the base series.
  22196. */
  22197. gapUnit?: OptionsGapUnitValue;
  22198. /**
  22199. * (Highcharts, Highstock, Gantt) Whether to use the Y extremes of the total
  22200. * chart width or only the zoomed area when zooming in on parts of the X
  22201. * axis. By default, the Y axis adjusts to the min and max of the visible
  22202. * data. Cartesian series only.
  22203. */
  22204. getExtremesFromAll?: boolean;
  22205. /**
  22206. * (Highcharts, Highstock) When set to `false` will prevent the series data
  22207. * from being included in any form of data export.
  22208. *
  22209. * Since version 6.0.0 until 7.1.0 the option was existing undocumented as
  22210. * `includeInCSVExport`.
  22211. */
  22212. includeInDataExport?: boolean;
  22213. /**
  22214. * (Highmaps) What property to join the `mapData` to the value data. For
  22215. * example, if joinBy is "code", the mapData items with a specific code is
  22216. * merged into the data with the same code. For maps loaded from GeoJSON,
  22217. * the keys may be held in each point's `properties` object.
  22218. *
  22219. * The joinBy option can also be an array of two values, where the first
  22220. * points to a key in the `mapData`, and the second points to another key in
  22221. * the `data`.
  22222. *
  22223. * When joinBy is `null`, the map items are joined by their position in the
  22224. * array, which performs much better in maps with many data points. This is
  22225. * the recommended option if you are printing more than a thousand data
  22226. * points and have a backend that can preprocess the data into a parallel
  22227. * array of the mapData.
  22228. */
  22229. joinBy?: (string|Array<string>);
  22230. /**
  22231. * (Highcharts, Highstock) An array specifying which option maps to which
  22232. * key in the data point array. This makes it convenient to work with
  22233. * unstructured data arrays from different sources.
  22234. */
  22235. keys?: Array<string>;
  22236. /**
  22237. * (Highcharts, Highstock, Gantt) Series labels are placed as close to the
  22238. * series as possible in a natural way, seeking to avoid other series. The
  22239. * goal of this feature is to make the chart more easily readable, like if a
  22240. * human designer placed the labels in the optimal position.
  22241. *
  22242. * The series labels currently work with series types having a `graph` or an
  22243. * `area`.
  22244. */
  22245. label?: SeriesLabelOptionsObject;
  22246. /**
  22247. * (Highstock) The line marks the last price from all points.
  22248. */
  22249. lastPrice?: SeriesLastPriceOptionsObject;
  22250. /**
  22251. * (Highstock) The line marks the last price from visible range of points.
  22252. */
  22253. lastVisiblePrice?: SeriesLastVisiblePriceOptionsObject;
  22254. /**
  22255. * (Highcharts, Highstock) The SVG value used for the `stroke-linecap` and
  22256. * `stroke-linejoin` of a line graph. Round means that lines are rounded in
  22257. * the ends and bends.
  22258. */
  22259. linecap?: SeriesLinecapValue;
  22260. /**
  22261. * (Highcharts, Highstock) A separate color for the graph line. By default
  22262. * the line takes the `color` of the series, but the lineColor setting
  22263. * allows setting a separate color for the line without altering the
  22264. * `fillColor`.
  22265. *
  22266. * In styled mode, the line stroke can be set with the `.highcharts-graph`
  22267. * class name.
  22268. */
  22269. lineColor?: (ColorString|GradientColorObject|PatternObject);
  22270. /**
  22271. * (Highcharts, Highstock) Pixel width of the arearange graph line.
  22272. */
  22273. lineWidth?: number;
  22274. /**
  22275. * (Highcharts, Highstock, Gantt) The id of another series to link to.
  22276. * Additionally, the value can be ":previous" to link to the previous
  22277. * series. When two series are linked, only the first one appears in the
  22278. * legend. Toggling the visibility of this also toggles the linked series.
  22279. *
  22280. * If master series uses data sorting and linked series does not have its
  22281. * own sorting definition, the linked series will be sorted in the same
  22282. * order as the master one.
  22283. */
  22284. linkedTo?: string;
  22285. /**
  22286. * (Highcharts, Highstock) Options for the point markers of line-like
  22287. * series. Properties like `fillColor`, `lineColor` and `lineWidth` define
  22288. * the visual appearance of the markers. Other series types, like column
  22289. * series, don't have markers, but have visual options on the series level
  22290. * instead.
  22291. *
  22292. * In styled mode, the markers can be styled with the `.highcharts-point`,
  22293. * `.highcharts-point-hover` and `.highcharts-point-select` class names.
  22294. */
  22295. marker?: PointMarkerOptionsObject;
  22296. /**
  22297. * (Highstock) Options for the corresponding navigator series if
  22298. * `showInNavigator` is `true` for this series. Available options are the
  22299. * same as any series, documented at plotOptions and series.
  22300. *
  22301. * These options are merged with options in navigator.series, and will take
  22302. * precedence if the same option is defined both places.
  22303. */
  22304. navigatorOptions?: PlotSeriesOptions;
  22305. /**
  22306. * (Highcharts, Highstock) The color for the parts of the graph or points
  22307. * that are below the threshold. Note that `zones` takes precedence over the
  22308. * negative color. Using `negativeColor` is equivalent to applying a zone
  22309. * with value of 0.
  22310. */
  22311. negativeColor?: (ColorString|GradientColorObject|PatternObject);
  22312. /**
  22313. * (Highcharts) A separate color for the negative part of the area.
  22314. *
  22315. * In styled mode, a negative color is set with the `.highcharts-negative`
  22316. * class name.
  22317. */
  22318. negativeFillColor?: (ColorString|GradientColorObject|PatternObject);
  22319. /**
  22320. * (Highcharts, Highstock) Opacity of a series parts: line, fill (e.g. area)
  22321. * and dataLabels.
  22322. */
  22323. opacity?: number;
  22324. /**
  22325. * (Highcharts, Highstock) Properties for each single point.
  22326. */
  22327. point?: PlotSeriesPointOptions;
  22328. /**
  22329. * (Highcharts, Highstock) Same as accessibility.pointDescriptionFormatter,
  22330. * but for an individual series. Overrides the chart wide configuration.
  22331. */
  22332. pointDescriptionFormatter?: Function;
  22333. /**
  22334. * (Highcharts, Highstock, Gantt) If no x values are given for the points in
  22335. * a series, `pointInterval` defines the interval of the x values. For
  22336. * example, if a series contains one value every decade starting from year
  22337. * 0, set `pointInterval` to `10`. In true `datetime` axes, the
  22338. * `pointInterval` is set in milliseconds.
  22339. *
  22340. * It can be also be combined with `pointIntervalUnit` to draw irregular
  22341. * time intervals.
  22342. *
  22343. * Please note that this options applies to the _series data_, not the
  22344. * interval of the axis ticks, which is independent.
  22345. */
  22346. pointInterval?: number;
  22347. /**
  22348. * (Highcharts, Highstock, Gantt) On datetime series, this allows for
  22349. * setting the pointInterval to irregular time units, `day`, `month` and
  22350. * `year`. A day is usually the same as 24 hours, but `pointIntervalUnit`
  22351. * also takes the DST crossover into consideration when dealing with local
  22352. * time. Combine this option with `pointInterval` to draw weeks, quarters, 6
  22353. * months, 10 years etc.
  22354. *
  22355. * Please note that this options applies to the _series data_, not the
  22356. * interval of the axis ticks, which is independent.
  22357. */
  22358. pointIntervalUnit?: OptionsPointIntervalUnitValue;
  22359. /**
  22360. * (Highcharts, Highstock, Gantt) Possible values: `"on"`, `"between"`,
  22361. * `number`.
  22362. *
  22363. * In a column chart, when pointPlacement is `"on"`, the point will not
  22364. * create any padding of the X axis. In a polar column chart this means that
  22365. * the first column points directly north. If the pointPlacement is
  22366. * `"between"`, the columns will be laid out between ticks. This is useful
  22367. * for example for visualising an amount between two points in time or in a
  22368. * certain sector of a polar chart.
  22369. *
  22370. * Since Highcharts 3.0.2, the point placement can also be numeric, where 0
  22371. * is on the axis value, -0.5 is between this value and the previous, and
  22372. * 0.5 is between this value and the next. Unlike the textual options,
  22373. * numeric point placement options won't affect axis padding.
  22374. *
  22375. * Note that pointPlacement needs a pointRange to work. For column series
  22376. * this is computed, but for line-type series it needs to be set.
  22377. *
  22378. * For the `xrange` series type and gantt charts, if the Y axis is a
  22379. * category axis, the `pointPlacement` applies to the Y axis rather than the
  22380. * (typically datetime) X axis.
  22381. *
  22382. * Defaults to `undefined` in cartesian charts, `"between"` in polar charts.
  22383. */
  22384. pointPlacement?: (number|string);
  22385. /**
  22386. * (Highstock) The width of each point on the x axis. For example in a
  22387. * column chart with one value each day, the pointRange would be 1 day (= 24
  22388. * * 3600
  22389. *
  22390. * * 1000 milliseconds). This is normally computed automatically, but this
  22391. * option can be used to override the automatic value.
  22392. */
  22393. pointRange?: number;
  22394. /**
  22395. * (Highcharts, Highstock, Gantt) If no x values are given for the points in
  22396. * a series, pointStart defines on what value to start. For example, if a
  22397. * series contains one yearly value starting from 1945, set pointStart to
  22398. * 1945.
  22399. */
  22400. pointStart?: number;
  22401. /**
  22402. * (Highcharts, Highstock) Whether to select the series initially. If
  22403. * `showCheckbox` is true, the checkbox next to the series name in the
  22404. * legend will be checked for a selected series.
  22405. */
  22406. selected?: boolean;
  22407. /**
  22408. * (Highcharts) Whether to apply a drop shadow to the graph line. Since 2.3
  22409. * the shadow can be an object configuration containing `color`, `offsetX`,
  22410. * `offsetY`, `opacity` and `width`.
  22411. */
  22412. shadow?: (boolean|ShadowOptionsObject);
  22413. /**
  22414. * (Highcharts, Highstock) If true, a checkbox is displayed next to the
  22415. * legend item to allow selecting the series. The state of the checkbox is
  22416. * determined by the `selected` option.
  22417. */
  22418. showCheckbox?: boolean;
  22419. /**
  22420. * (Highcharts, Highstock) Whether to display this particular series or
  22421. * series type in the legend. Standalone series are shown in legend by
  22422. * default, and linked series are not. Since v7.2.0 it is possible to show
  22423. * series that use colorAxis by setting this option to `true`.
  22424. */
  22425. showInLegend?: boolean;
  22426. /**
  22427. * (Highstock) Whether or not to show the series in the navigator. Takes
  22428. * precedence over navigator.baseSeries if defined.
  22429. */
  22430. showInNavigator?: boolean;
  22431. /**
  22432. * (Highcharts, Highstock) If set to `true`, the accessibility module will
  22433. * skip past the points in this series for keyboard navigation.
  22434. */
  22435. skipKeyboardNavigation?: boolean;
  22436. /**
  22437. * (Highcharts, Highstock) When this is true, the series will not cause the
  22438. * Y axis to cross the zero plane (or threshold option) unless the data
  22439. * actually crosses the plane.
  22440. *
  22441. * For example, if `softThreshold` is `false`, a series of 0, 1, 2, 3 will
  22442. * make the Y axis show negative values according to the `minPadding`
  22443. * option. If `softThreshold` is `true`, the Y axis starts at 0.
  22444. */
  22445. softThreshold?: boolean;
  22446. states?: SeriesStatesOptionsObject;
  22447. /**
  22448. * (Highcharts, Highstock) Sticky tracking of mouse events. When true, the
  22449. * `mouseOut` event on a series isn't triggered until the mouse moves over
  22450. * another series, or out of the plot area. When false, the `mouseOut` event
  22451. * on a series is triggered when the mouse leaves the area around the
  22452. * series' graph or markers. This also implies the tooltip when not shared.
  22453. * When `stickyTracking` is false and `tooltip.shared` is false, the tooltip
  22454. * will be hidden when moving the mouse between series. Defaults to true for
  22455. * line and area type series, but to false for columns, pies etc.
  22456. *
  22457. * **Note:** The boost module will force this option because of technical
  22458. * limitations.
  22459. */
  22460. stickyTracking?: boolean;
  22461. /**
  22462. * (Highcharts, Highstock) The Y axis value to serve as the base for the
  22463. * area, for distinguishing between values above and below a threshold. The
  22464. * area between the graph and the threshold is filled.
  22465. *
  22466. * * If a number is given, the Y axis will scale to the threshold.
  22467. *
  22468. * * If `null`, the scaling behaves like a line series with fill between the
  22469. * graph and the Y axis minimum.
  22470. *
  22471. * * If `Infinity` or `-Infinity`, the area between the graph and the
  22472. * corresponding Y axis extreme is filled (since v6.1.0).
  22473. */
  22474. threshold?: (number|null);
  22475. /**
  22476. * (Highcharts, Highstock) A configuration object for the tooltip rendering
  22477. * of each single series. Properties are inherited from tooltip, but only
  22478. * the following properties can be defined on a series level.
  22479. */
  22480. tooltip?: SeriesTooltipOptionsObject;
  22481. /**
  22482. * (Highcharts, Highstock) Whether the whole area or just the line should
  22483. * respond to mouseover tooltips and other mouse or touch events.
  22484. */
  22485. trackByArea?: boolean;
  22486. /**
  22487. * (Highcharts, Highstock, Gantt) When a series contains a data array that
  22488. * is longer than this, only one dimensional arrays of numbers, or two
  22489. * dimensional arrays with x and y values are allowed. Also, only the first
  22490. * point is tested, and the rest are assumed to be the same format. This
  22491. * saves expensive data checking and indexing in long series. Set it to `0`
  22492. * disable.
  22493. *
  22494. * Note: In boost mode turbo threshold is forced. Only array of numbers or
  22495. * two dimensional arrays are allowed.
  22496. */
  22497. turboThreshold?: number;
  22498. /**
  22499. * (Highcharts, Highstock) Set the initial visibility of the series.
  22500. */
  22501. visible?: boolean;
  22502. /**
  22503. * (Highmaps) Define the z index of the series.
  22504. */
  22505. zIndex?: number;
  22506. /**
  22507. * (Highcharts, Highstock) Defines the Axis on which the zones are applied.
  22508. */
  22509. zoneAxis?: string;
  22510. /**
  22511. * (Highcharts, Highstock) An array defining zones within a series. Zones
  22512. * can be applied to the X axis, Y axis or Z axis for bubbles, according to
  22513. * the `zoneAxis` option. The zone definitions have to be in ascending order
  22514. * regarding to the value.
  22515. *
  22516. * In styled mode, the color zones are styled with the
  22517. * `.highcharts-zone-{n}` class, or custom classed from the `className`
  22518. * option (view live demo).
  22519. */
  22520. zones?: Array<SeriesZonesOptionsObject>;
  22521. }
  22522. /**
  22523. * (Highstock) Enable or disable the initial animation when a series is
  22524. * displayed. The animation can also be set as a configuration object. Please
  22525. * note that this option only applies to the initial animation of the series
  22526. * itself. For other animations, see chart.animation and the animation parameter
  22527. * under the API methods. The following properties are supported:
  22528. *
  22529. * - `defer`: The animation delay time in milliseconds.
  22530. *
  22531. * - `duration`: The duration of the animation in milliseconds.
  22532. *
  22533. * - `easing`: Can be a string reference to an easing function set on the `Math`
  22534. * object or a function. See the _Custom easing function_ demo below.
  22535. *
  22536. * Due to poor performance, animation is disabled in old IE browsers for several
  22537. * chart types.
  22538. */
  22539. export interface PlotAroonAnimationOptions {
  22540. defer?: number;
  22541. }
  22542. /**
  22543. * (Highstock) aroonDown line options.
  22544. */
  22545. export interface PlotAroonAroonDownOptions {
  22546. /**
  22547. * (Highstock) Styles for an aroonDown line.
  22548. */
  22549. styles?: PlotAroonAroonDownStylesOptions;
  22550. }
  22551. /**
  22552. * (Highstock) Styles for an aroonDown line.
  22553. */
  22554. export interface PlotAroonAroonDownStylesOptions {
  22555. /**
  22556. * (Highstock) Color of the line. If not set, it's inherited from
  22557. * plotOptions.aroon.color.
  22558. */
  22559. lineColor?: ColorString;
  22560. /**
  22561. * (Highstock) Pixel width of the line.
  22562. */
  22563. lineWidth?: number;
  22564. }
  22565. /**
  22566. * (Highcharts, Highstock, Highmaps, Gantt) Enable or disable the initial
  22567. * animation when a series is displayed for the `dataLabels`. The animation can
  22568. * also be set as a configuration object. Please note that this option only
  22569. * applies to the initial animation. For other animations, see chart.animation
  22570. * and the animation parameter under the API methods. The following properties
  22571. * are supported:
  22572. *
  22573. * - `defer`: The animation delay time in milliseconds.
  22574. */
  22575. export interface PlotAroonDataLabelsAnimationOptions {
  22576. /**
  22577. * (Highcharts, Highstock, Highmaps, Gantt) The animation delay time in
  22578. * milliseconds. Set to `0` renders dataLabel immediately. As `undefined`
  22579. * inherits defer time from the series.animation.defer.
  22580. */
  22581. defer?: number;
  22582. }
  22583. /**
  22584. * (Highcharts, Highstock, Highmaps, Gantt) Options for the series data labels,
  22585. * appearing next to each data point.
  22586. *
  22587. * Since v6.2.0, multiple data labels can be applied to each single point by
  22588. * defining them as an array of configs.
  22589. *
  22590. * In styled mode, the data labels can be styled with the
  22591. * `.highcharts-data-label-box` and `.highcharts-data-label` class names (see
  22592. * example).
  22593. */
  22594. export interface PlotAroonDataLabelsOptions {
  22595. /**
  22596. * (Highcharts, Highstock, Highmaps, Gantt) The alignment of the data label
  22597. * compared to the point. If `right`, the right side of the label should be
  22598. * touching the point. For points with an extent, like columns, the
  22599. * alignments also dictates how to align it inside the box, as given with
  22600. * the inside option. Can be one of `left`, `center` or `right`.
  22601. */
  22602. align?: (AlignValue|null);
  22603. /**
  22604. * (Highcharts, Highstock, Highmaps, Gantt) Whether to allow data labels to
  22605. * overlap. To make the labels less sensitive for overlapping, the
  22606. * dataLabels.padding can be set to 0.
  22607. */
  22608. allowOverlap?: boolean;
  22609. /**
  22610. * (Highcharts, Highstock, Highmaps, Gantt) Enable or disable the initial
  22611. * animation when a series is displayed for the `dataLabels`. The animation
  22612. * can also be set as a configuration object. Please note that this option
  22613. * only applies to the initial animation. For other animations, see
  22614. * chart.animation and the animation parameter under the API methods. The
  22615. * following properties are supported:
  22616. *
  22617. * - `defer`: The animation delay time in milliseconds.
  22618. */
  22619. animation?: (boolean|PlotAroonDataLabelsAnimationOptions|Partial<AnimationOptionsObject>);
  22620. /**
  22621. * (Highcharts, Highstock, Highmaps, Gantt) The background color or gradient
  22622. * for the data label.
  22623. */
  22624. backgroundColor?: (ColorString|GradientColorObject|PatternObject);
  22625. /**
  22626. * (Highcharts, Highstock, Highmaps, Gantt) The border color for the data
  22627. * label. Defaults to `undefined`.
  22628. */
  22629. borderColor?: (ColorString|GradientColorObject|PatternObject);
  22630. /**
  22631. * (Highcharts, Highstock, Highmaps, Gantt) The border radius in pixels for
  22632. * the data label.
  22633. */
  22634. borderRadius?: number;
  22635. /**
  22636. * (Highcharts, Highstock, Highmaps, Gantt) The border width in pixels for
  22637. * the data label.
  22638. */
  22639. borderWidth?: number;
  22640. /**
  22641. * (Highcharts, Highstock, Highmaps, Gantt) A class name for the data label.
  22642. * Particularly in styled mode, this can be used to give each series' or
  22643. * point's data label unique styling. In addition to this option, a default
  22644. * color class name is added so that we can give the labels a contrast text
  22645. * shadow.
  22646. */
  22647. className?: string;
  22648. /**
  22649. * (Highcharts, Highstock, Highmaps, Gantt) The text color for the data
  22650. * labels. Defaults to `undefined`. For certain series types, like column or
  22651. * map, the data labels can be drawn inside the points. In this case the
  22652. * data label will be drawn with maximum contrast by default. Additionally,
  22653. * it will be given a `text-outline` style with the opposite color, to
  22654. * further increase the contrast. This can be overridden by setting the
  22655. * `text-outline` style to `none` in the `dataLabels.style` option.
  22656. */
  22657. color?: (ColorString|GradientColorObject|PatternObject);
  22658. /**
  22659. * (Highcharts, Highstock, Highmaps, Gantt) Whether to hide data labels that
  22660. * are outside the plot area. By default, the data label is moved inside the
  22661. * plot area according to the overflow option.
  22662. */
  22663. crop?: boolean;
  22664. /**
  22665. * (Highcharts, Highstock, Gantt) Whether to defer displaying the data
  22666. * labels until the initial series animation has finished. Setting to
  22667. * `false` renders the data label immediately. If set to `true` inherits the
  22668. * defer time set in plotOptions.series.animation.
  22669. */
  22670. defer?: boolean;
  22671. /**
  22672. * (Highcharts, Highstock, Highmaps, Gantt) Enable or disable the data
  22673. * labels.
  22674. */
  22675. enabled?: boolean;
  22676. /**
  22677. * (Highcharts, Highstock, Highmaps, Gantt) A declarative filter to control
  22678. * of which data labels to display. The declarative filter is designed for
  22679. * use when callback functions are not available, like when the chart
  22680. * options require a pure JSON structure or for use with graphical editors.
  22681. * For programmatic control, use the `formatter` instead, and return
  22682. * `undefined` to disable a single data label.
  22683. */
  22684. filter?: DataLabelsFilterOptionsObject;
  22685. /**
  22686. * (Highcharts, Highstock, Highmaps, Gantt) A format string for the data
  22687. * label. Available variables are the same as for `formatter`.
  22688. */
  22689. format?: string;
  22690. /**
  22691. * (Highcharts, Highstock, Highmaps, Gantt) Callback JavaScript function to
  22692. * format the data label. Note that if a `format` is defined, the format
  22693. * takes precedence and the formatter is ignored.
  22694. */
  22695. formatter?: DataLabelsFormatterCallbackFunction;
  22696. /**
  22697. * (Highcharts, Highstock, Highmaps, Gantt) For points with an extent, like
  22698. * columns or map areas, whether to align the data label inside the box or
  22699. * to the actual value point. Defaults to `false` in most cases, `true` in
  22700. * stacked columns.
  22701. */
  22702. inside?: boolean;
  22703. /**
  22704. * (Highcharts, Highstock, Highmaps, Gantt) Format for points with the value
  22705. * of null. Works analogously to format. `nullFormat` can be applied only to
  22706. * series which support displaying null points.
  22707. */
  22708. nullFormat?: (boolean|string);
  22709. /**
  22710. * (Highcharts, Highstock, Highmaps, Gantt) Callback JavaScript function
  22711. * that defines formatting for points with the value of null. Works
  22712. * analogously to formatter. `nullPointFormatter` can be applied only to
  22713. * series which support displaying null points.
  22714. */
  22715. nullFormatter?: DataLabelsFormatterCallbackFunction;
  22716. /**
  22717. * (Highcharts, Highstock, Highmaps, Gantt) How to handle data labels that
  22718. * flow outside the plot area. The default is `"justify"`, which aligns them
  22719. * inside the plot area. For columns and bars, this means it will be moved
  22720. * inside the bar. To display data labels outside the plot area, set `crop`
  22721. * to `false` and `overflow` to `"allow"`.
  22722. */
  22723. overflow?: DataLabelsOverflowValue;
  22724. /**
  22725. * (Highcharts, Highstock, Highmaps, Gantt) When either the `borderWidth` or
  22726. * the `backgroundColor` is set, this is the padding within the box.
  22727. */
  22728. padding?: number;
  22729. /**
  22730. * (Highcharts, Highstock, Highmaps, Gantt) Aligns data labels relative to
  22731. * points. If `center` alignment is not possible, it defaults to `right`.
  22732. */
  22733. position?: AlignValue;
  22734. /**
  22735. * (Highcharts, Highstock, Highmaps, Gantt) Text rotation in degrees. Note
  22736. * that due to a more complex structure, backgrounds, borders and padding
  22737. * will be lost on a rotated data label.
  22738. */
  22739. rotation?: number;
  22740. /**
  22741. * (Highcharts, Highstock, Highmaps, Gantt) The shadow of the box. Works
  22742. * best with `borderWidth` or `backgroundColor`. Since 2.3 the shadow can be
  22743. * an object configuration containing `color`, `offsetX`, `offsetY`,
  22744. * `opacity` and `width`.
  22745. */
  22746. shadow?: (boolean|ShadowOptionsObject);
  22747. /**
  22748. * (Highcharts, Highstock, Highmaps, Gantt) The name of a symbol to use for
  22749. * the border around the label. Symbols are predefined functions on the
  22750. * Renderer object.
  22751. */
  22752. shape?: string;
  22753. /**
  22754. * (Highcharts, Highstock, Highmaps, Gantt) Styles for the label. The
  22755. * default `color` setting is `"contrast"`, which is a pseudo color that
  22756. * Highcharts picks up and applies the maximum contrast to the underlying
  22757. * point item, for example the bar in a bar chart.
  22758. *
  22759. * The `textOutline` is a pseudo property that applies an outline of the
  22760. * given width with the given color, which by default is the maximum
  22761. * contrast to the text. So a bright text color will result in a black text
  22762. * outline for maximum readability on a mixed background. In some cases,
  22763. * especially with grayscale text, the text outline doesn't work well, in
  22764. * which cases it can be disabled by setting it to `"none"`. When `useHTML`
  22765. * is true, the `textOutline` will not be picked up. In this, case, the same
  22766. * effect can be acheived through the `text-shadow` CSS property.
  22767. *
  22768. * For some series types, where each point has an extent, like for example
  22769. * tree maps, the data label may overflow the point. There are two
  22770. * strategies for handling overflow. By default, the text will wrap to
  22771. * multiple lines. The other strategy is to set `style.textOverflow` to
  22772. * `ellipsis`, which will keep the text on one line plus it will break
  22773. * inside long words.
  22774. */
  22775. style?: CSSObject;
  22776. /**
  22777. * (Highcharts, Highstock, Highmaps, Gantt) Options for a label text which
  22778. * should follow marker's shape. Border and background are disabled for a
  22779. * label that follows a path.
  22780. *
  22781. * **Note:** Only SVG-based renderer supports this option. Setting `useHTML`
  22782. * to true will disable this option.
  22783. */
  22784. textPath?: DataLabelsTextPathOptionsObject;
  22785. /**
  22786. * (Highcharts, Highstock, Highmaps, Gantt) Whether to use HTML to render
  22787. * the labels.
  22788. */
  22789. useHTML?: boolean;
  22790. /**
  22791. * (Highcharts, Highstock, Highmaps, Gantt) The vertical alignment of a data
  22792. * label. Can be one of `top`, `middle` or `bottom`. The default value
  22793. * depends on the data, for instance in a column chart, the label is above
  22794. * positive values and below negative values.
  22795. */
  22796. verticalAlign?: (VerticalAlignValue|null);
  22797. /**
  22798. * (Highcharts, Highstock, Highmaps, Gantt) The x position offset of the
  22799. * label relative to the point in pixels.
  22800. */
  22801. x?: number;
  22802. /**
  22803. * (Highcharts, Highstock, Highmaps, Gantt) The y position offset of the
  22804. * label relative to the point in pixels.
  22805. */
  22806. y?: number;
  22807. /**
  22808. * (Highcharts, Highstock, Highmaps, Gantt) The Z index of the data labels.
  22809. * The default Z index puts it above the series. Use a Z index of 2 to
  22810. * display it behind the series.
  22811. */
  22812. z?: number;
  22813. }
  22814. /**
  22815. * (Highcharts, Highstock) Options for the series data sorting.
  22816. */
  22817. export interface PlotAroonDataSortingOptions {
  22818. /**
  22819. * (Highcharts, Highstock) Enable or disable data sorting for the series.
  22820. * Use xAxis.reversed to change the sorting order.
  22821. */
  22822. enabled?: boolean;
  22823. /**
  22824. * (Highcharts, Highstock) Whether to allow matching points by name in an
  22825. * update. If this option is disabled, points will be matched by order.
  22826. */
  22827. matchByName?: boolean;
  22828. /**
  22829. * (Highcharts, Highstock) Determines what data value should be used to sort
  22830. * by.
  22831. */
  22832. sortKey?: string;
  22833. }
  22834. /**
  22835. * (Highstock) Aroon. This series requires the `linkedTo` option to be set and
  22836. * should be loaded after the `stock/indicators/indicators.js`.
  22837. *
  22838. * In TypeScript the type option must always be set.
  22839. *
  22840. * Configuration options for the series are given in three levels:
  22841. *
  22842. * 1. Options for all series in a chart are defined in the plotOptions.series
  22843. * object.
  22844. *
  22845. * 2. Options for all `aroon` series are defined in plotOptions.aroon.
  22846. *
  22847. * 3. Options for one single series are given in the series instance array. (see
  22848. * online documentation for example)
  22849. */
  22850. export interface PlotAroonOptions {
  22851. /**
  22852. * (Highstock) Accessibility options for a series.
  22853. */
  22854. accessibility?: SeriesAccessibilityOptionsObject;
  22855. /**
  22856. * (Highstock) Allow this series' points to be selected by clicking on the
  22857. * graphic (columns, point markers, pie slices, map areas etc).
  22858. *
  22859. * The selected points can be handled by point select and unselect events,
  22860. * or collectively by the getSelectedPoints function.
  22861. *
  22862. * And alternative way of selecting points is through dragging.
  22863. */
  22864. allowPointSelect?: boolean;
  22865. /**
  22866. * (Highstock) Enable or disable the initial animation when a series is
  22867. * displayed. The animation can also be set as a configuration object.
  22868. * Please note that this option only applies to the initial animation of the
  22869. * series itself. For other animations, see chart.animation and the
  22870. * animation parameter under the API methods. The following properties are
  22871. * supported:
  22872. *
  22873. * - `defer`: The animation delay time in milliseconds.
  22874. *
  22875. * - `duration`: The duration of the animation in milliseconds.
  22876. *
  22877. * - `easing`: Can be a string reference to an easing function set on the
  22878. * `Math` object or a function. See the _Custom easing function_ demo below.
  22879. *
  22880. * Due to poor performance, animation is disabled in old IE browsers for
  22881. * several chart types.
  22882. */
  22883. animation?: (boolean|PlotAroonAnimationOptions|Partial<AnimationOptionsObject>);
  22884. /**
  22885. * (Highstock) For some series, there is a limit that shuts down initial
  22886. * animation by default when the total number of points in the chart is too
  22887. * high. For example, for a column chart and its derivatives, animation does
  22888. * not run if there is more than 250 points totally. To disable this cap,
  22889. * set `animationLimit` to `Infinity`.
  22890. */
  22891. animationLimit?: number;
  22892. /**
  22893. * (Highstock) aroonDown line options.
  22894. */
  22895. aroonDown?: PlotAroonAroonDownOptions;
  22896. /**
  22897. * (Highstock) Sets the color blending in the boost module.
  22898. */
  22899. boostBlending?: OptionsBoostBlendingValue;
  22900. /**
  22901. * (Highstock) Set the point threshold for when a series should enter boost
  22902. * mode.
  22903. *
  22904. * Setting it to e.g. 2000 will cause the series to enter boost mode when
  22905. * there are 2000 or more points in the series.
  22906. *
  22907. * To disable boosting on the series, set the `boostThreshold` to 0. Setting
  22908. * it to 1 will force boosting.
  22909. *
  22910. * Note that the cropThreshold also affects this setting. When zooming in on
  22911. * a series that has fewer points than the `cropThreshold`, all points are
  22912. * rendered although outside the visible plot area, and the `boostThreshold`
  22913. * won't take effect.
  22914. */
  22915. boostThreshold?: number;
  22916. /**
  22917. * (Highmaps) The border color of the map areas.
  22918. *
  22919. * In styled mode, the border stroke is given in the `.highcharts-point`
  22920. * class.
  22921. */
  22922. borderColor?: (ColorString|GradientColorObject|PatternObject);
  22923. /**
  22924. * (Highmaps) The border width of each map area.
  22925. *
  22926. * In styled mode, the border stroke width is given in the
  22927. * `.highcharts-point` class.
  22928. */
  22929. borderWidth?: number;
  22930. /**
  22931. * (Highstock) An additional class name to apply to the series' graphical
  22932. * elements. This option does not replace default class names of the
  22933. * graphical element.
  22934. */
  22935. className?: string;
  22936. /**
  22937. * (Highstock) Disable this option to allow series rendering in the whole
  22938. * plotting area.
  22939. *
  22940. * **Note:** Clipping should be always enabled when chart.zoomType is set
  22941. */
  22942. clip?: boolean;
  22943. /**
  22944. * (Highstock) The main color of the series. In line type series it applies
  22945. * to the line and the point markers unless otherwise specified. In bar type
  22946. * series it applies to the bars unless a color is specified per point. The
  22947. * default value is pulled from the `options.colors` array.
  22948. *
  22949. * In styled mode, the color can be defined by the colorIndex option. Also,
  22950. * the series color can be set with the `.highcharts-series`,
  22951. * `.highcharts-color-{n}`, `.highcharts-{type}-series` or
  22952. * `.highcharts-series-{n}` class, or individual classes given by the
  22953. * `className` option.
  22954. */
  22955. color?: (ColorString|GradientColorObject|PatternObject);
  22956. /**
  22957. * (Highstock) Styled mode only. A specific color index to use for the
  22958. * series, so its graphic representations are given the class name
  22959. * `highcharts-color-{n}`.
  22960. */
  22961. colorIndex?: number;
  22962. /**
  22963. * (Highcharts, Highstock, Highmaps) Determines what data value should be
  22964. * used to calculate point color if `colorAxis` is used. Requires to set
  22965. * `min` and `max` if some custom point property is used or if approximation
  22966. * for data grouping is set to `'sum'`.
  22967. */
  22968. colorKey?: string;
  22969. /**
  22970. * (Highstock) Defines if comparison should start from the first point
  22971. * within the visible range or should start from the first point **before**
  22972. * the range.
  22973. *
  22974. * In other words, this flag determines if first point within the visible
  22975. * range will have 0% (`compareStart=true`) or should have been already
  22976. * calculated according to the previous point (`compareStart=false`).
  22977. */
  22978. compareStart?: boolean;
  22979. /**
  22980. * (Highstock) Whether to compare indicator to the main series values or
  22981. * indicator values.
  22982. */
  22983. compareToMain?: boolean;
  22984. /**
  22985. * (Highcharts) Polar charts only. Whether to connect the ends of a line
  22986. * series plot across the extremes.
  22987. */
  22988. connectEnds?: boolean;
  22989. /**
  22990. * (Highcharts, Highstock) Whether to connect a graph line across null
  22991. * points, or render a gap between the two points on either side of the
  22992. * null.
  22993. */
  22994. connectNulls?: boolean;
  22995. /**
  22996. * (Gantt) Override Pathfinder connector options for a series. Requires
  22997. * Highcharts Gantt to be loaded.
  22998. */
  22999. connectors?: SeriesConnectorsOptionsObject;
  23000. /**
  23001. * (Highcharts, Highstock, Gantt) When true, each point or column edge is
  23002. * rounded to its nearest pixel in order to render sharp on screen. In some
  23003. * cases, when there are a lot of densely packed columns, this leads to
  23004. * visible difference in column widths or distance between columns. In these
  23005. * cases, setting `crisp` to `false` may look better, even though each
  23006. * column is rendered blurry.
  23007. */
  23008. crisp?: boolean;
  23009. /**
  23010. * (Highcharts, Highstock) When the series contains less points than the
  23011. * crop threshold, all points are drawn, even if the points fall outside the
  23012. * visible plot area at the current zoom. The advantage of drawing all
  23013. * points (including markers and columns), is that animation is performed on
  23014. * updates. On the other hand, when the series contains more points than the
  23015. * crop threshold, the series data is cropped to only contain points that
  23016. * fall within the plot area. The advantage of cropping away invisible
  23017. * points is to increase performance on large series.
  23018. */
  23019. cropThreshold?: number;
  23020. /**
  23021. * (Highstock) You can set the cursor to "pointer" if you have click events
  23022. * attached to the series, to signal to the user that the points and lines
  23023. * can be clicked.
  23024. *
  23025. * In styled mode, the series cursor can be set with the same classes as
  23026. * listed under series.color.
  23027. */
  23028. cursor?: (string|CursorValue);
  23029. /**
  23030. * (Highstock) A reserved subspace to store options and values for
  23031. * customized functionality. Here you can add additional data for your own
  23032. * event callbacks and formatter callbacks.
  23033. */
  23034. custom?: Dictionary<any>;
  23035. /**
  23036. * (Highstock) Name of the dash style to use for the graph, or for some
  23037. * series types the outline of each shape.
  23038. *
  23039. * In styled mode, the stroke dash-array can be set with the same classes as
  23040. * listed under series.color.
  23041. */
  23042. dashStyle?: DashStyleValue;
  23043. /**
  23044. * (Highstock) Data grouping is the concept of sampling the data values into
  23045. * larger blocks in order to ease readability and increase performance of
  23046. * the JavaScript charts. Highstock by default applies data grouping when
  23047. * the points become closer than a certain pixel value, determined by the
  23048. * `groupPixelWidth` option.
  23049. *
  23050. * If data grouping is applied, the grouping information of grouped points
  23051. * can be read from the Point.dataGroup. If point options other than the
  23052. * data itself are set, for example `name` or `color` or custom properties,
  23053. * the grouping logic doesn't know how to group it. In this case the options
  23054. * of the first point instance are copied over to the group point. This can
  23055. * be altered through a custom `approximation` callback function.
  23056. */
  23057. dataGrouping?: DataGroupingOptionsObject;
  23058. /**
  23059. * (Highcharts, Highstock, Highmaps, Gantt) Options for the series data
  23060. * labels, appearing next to each data point.
  23061. *
  23062. * Since v6.2.0, multiple data labels can be applied to each single point by
  23063. * defining them as an array of configs.
  23064. *
  23065. * In styled mode, the data labels can be styled with the
  23066. * `.highcharts-data-label-box` and `.highcharts-data-label` class names
  23067. * (see example).
  23068. */
  23069. dataLabels?: (PlotAroonDataLabelsOptions|Array<PlotAroonDataLabelsOptions>);
  23070. /**
  23071. * (Highcharts, Highstock) Options for the series data sorting.
  23072. */
  23073. dataSorting?: (DataSortingOptionsObject|PlotAroonDataSortingOptions);
  23074. /**
  23075. * (Highstock) A description of the series to add to the screen reader
  23076. * information about the series.
  23077. */
  23078. description?: string;
  23079. /**
  23080. * (Highstock) Enable or disable the mouse tracking for a specific series.
  23081. * This includes point tooltips and click events on graphs and points. For
  23082. * large datasets it improves performance.
  23083. */
  23084. enableMouseTracking?: boolean;
  23085. /**
  23086. * (Highstock) General event handlers for the series items. These event
  23087. * hooks can also be attached to the series at run time using the
  23088. * `Highcharts.addEvent` function.
  23089. */
  23090. events?: SeriesEventsOptionsObject;
  23091. /**
  23092. * (Highstock) Determines whether the series should look for the nearest
  23093. * point in both dimensions or just the x-dimension when hovering the
  23094. * series. Defaults to `'xy'` for scatter series and `'x'` for most other
  23095. * series. If the data has duplicate x-values, it is recommended to set this
  23096. * to `'xy'` to allow hovering over all points.
  23097. *
  23098. * Applies only to series types using nearest neighbor search (not direct
  23099. * hover) for tooltip.
  23100. */
  23101. findNearestPointBy?: OptionsFindNearestPointByValue;
  23102. /**
  23103. * (Highstock) Defines when to display a gap in the graph, together with the
  23104. * gapUnit option.
  23105. *
  23106. * In case when `dataGrouping` is enabled, points can be grouped into a
  23107. * larger time span. This can make the grouped points to have a greater
  23108. * distance than the absolute value of `gapSize` property, which will result
  23109. * in disappearing graph completely. To prevent this situation the mentioned
  23110. * distance between grouped points is used instead of previously defined
  23111. * `gapSize`.
  23112. *
  23113. * In practice, this option is most often used to visualize gaps in time
  23114. * series. In a stock chart, intraday data is available for daytime hours,
  23115. * while gaps will appear in nights and weekends.
  23116. */
  23117. gapSize?: number;
  23118. /**
  23119. * (Highstock) Together with gapSize, this option defines where to draw gaps
  23120. * in the graph.
  23121. *
  23122. * When the `gapUnit` is `"relative"` (default), a gap size of 5 means that
  23123. * if the distance between two points is greater than 5 times that of the
  23124. * two closest points, the graph will be broken.
  23125. *
  23126. * When the `gapUnit` is `"value"`, the gap is based on absolute axis
  23127. * values, which on a datetime axis is milliseconds. This also applies to
  23128. * the navigator series that inherits gap options from the base series.
  23129. */
  23130. gapUnit?: OptionsGapUnitValue;
  23131. /**
  23132. * (Highcharts, Highstock, Gantt) Whether to use the Y extremes of the total
  23133. * chart width or only the zoomed area when zooming in on parts of the X
  23134. * axis. By default, the Y axis adjusts to the min and max of the visible
  23135. * data. Cartesian series only.
  23136. */
  23137. getExtremesFromAll?: boolean;
  23138. /**
  23139. * (Highstock) When set to `false` will prevent the series data from being
  23140. * included in any form of data export.
  23141. *
  23142. * Since version 6.0.0 until 7.1.0 the option was existing undocumented as
  23143. * `includeInCSVExport`.
  23144. */
  23145. includeInDataExport?: boolean;
  23146. /**
  23147. * (Highcharts, Highstock, Gantt) Series labels are placed as close to the
  23148. * series as possible in a natural way, seeking to avoid other series. The
  23149. * goal of this feature is to make the chart more easily readable, like if a
  23150. * human designer placed the labels in the optimal position.
  23151. *
  23152. * The series labels currently work with series types having a `graph` or an
  23153. * `area`.
  23154. */
  23155. label?: SeriesLabelOptionsObject;
  23156. /**
  23157. * (Highstock) The line marks the last price from all points.
  23158. */
  23159. lastPrice?: SeriesLastPriceOptionsObject;
  23160. /**
  23161. * (Highstock) The line marks the last price from visible range of points.
  23162. */
  23163. lastVisiblePrice?: SeriesLastVisiblePriceOptionsObject;
  23164. /**
  23165. * (Highcharts, Highstock) The SVG value used for the `stroke-linecap` and
  23166. * `stroke-linejoin` of a line graph. Round means that lines are rounded in
  23167. * the ends and bends.
  23168. */
  23169. linecap?: SeriesLinecapValue;
  23170. /**
  23171. * (Highcharts, Highstock) Pixel width of the graph line.
  23172. */
  23173. lineWidth?: number;
  23174. /**
  23175. * (Highcharts, Highstock, Gantt) The main series ID that indicator will be
  23176. * based on. Required for this indicator.
  23177. */
  23178. linkedTo?: string;
  23179. /**
  23180. * (Highstock) Options for the point markers of line-like series. Properties
  23181. * like `fillColor`, `lineColor` and `lineWidth` define the visual
  23182. * appearance of the markers. Other series types, like column series, don't
  23183. * have markers, but have visual options on the series level instead.
  23184. *
  23185. * In styled mode, the markers can be styled with the `.highcharts-point`,
  23186. * `.highcharts-point-hover` and `.highcharts-point-select` class names.
  23187. */
  23188. marker?: PointMarkerOptionsObject;
  23189. /**
  23190. * (Highstock) The name of the series as shown in the legend, tooltip etc.
  23191. * If not set, it will be based on a technical indicator type and default
  23192. * params.
  23193. */
  23194. name?: string;
  23195. /**
  23196. * (Highstock) The color for the parts of the graph or points that are below
  23197. * the threshold. Note that `zones` takes precedence over the negative
  23198. * color. Using `negativeColor` is equivalent to applying a zone with value
  23199. * of 0.
  23200. */
  23201. negativeColor?: (ColorString|GradientColorObject|PatternObject);
  23202. /**
  23203. * (Highstock) Opacity of a series parts: line, fill (e.g. area) and
  23204. * dataLabels.
  23205. */
  23206. opacity?: number;
  23207. /**
  23208. * (Highstock) Paramters used in calculation of aroon series points.
  23209. */
  23210. params?: PlotAroonParamsOptions;
  23211. /**
  23212. * (Highstock) Properties for each single point.
  23213. */
  23214. point?: PlotSeriesPointOptions;
  23215. /**
  23216. * (Highstock) Same as accessibility.pointDescriptionFormatter, but for an
  23217. * individual series. Overrides the chart wide configuration.
  23218. */
  23219. pointDescriptionFormatter?: Function;
  23220. /**
  23221. * (Highstock) Whether to select the series initially. If `showCheckbox` is
  23222. * true, the checkbox next to the series name in the legend will be checked
  23223. * for a selected series.
  23224. */
  23225. selected?: boolean;
  23226. /**
  23227. * (Highstock) Whether to apply a drop shadow to the graph line. Since 2.3
  23228. * the shadow can be an object configuration containing `color`, `offsetX`,
  23229. * `offsetY`, `opacity` and `width`.
  23230. */
  23231. shadow?: (boolean|ShadowOptionsObject);
  23232. /**
  23233. * (Highstock) If true, a checkbox is displayed next to the legend item to
  23234. * allow selecting the series. The state of the checkbox is determined by
  23235. * the `selected` option.
  23236. */
  23237. showCheckbox?: boolean;
  23238. /**
  23239. * (Highstock) Whether to display this particular series or series type in
  23240. * the legend. Standalone series are shown in legend by default, and linked
  23241. * series are not. Since v7.2.0 it is possible to show series that use
  23242. * colorAxis by setting this option to `true`.
  23243. */
  23244. showInLegend?: boolean;
  23245. /**
  23246. * (Highstock) If set to `true`, the accessibility module will skip past the
  23247. * points in this series for keyboard navigation.
  23248. */
  23249. skipKeyboardNavigation?: boolean;
  23250. /**
  23251. * (Highcharts, Highstock) When this is true, the series will not cause the
  23252. * Y axis to cross the zero plane (or threshold option) unless the data
  23253. * actually crosses the plane.
  23254. *
  23255. * For example, if `softThreshold` is `false`, a series of 0, 1, 2, 3 will
  23256. * make the Y axis show negative values according to the `minPadding`
  23257. * option. If `softThreshold` is `true`, the Y axis starts at 0.
  23258. */
  23259. softThreshold?: boolean;
  23260. states?: SeriesStatesOptionsObject;
  23261. /**
  23262. * (Highcharts, Highstock) Whether to apply steps to the line. Possible
  23263. * values are `left`, `center` and `right`.
  23264. */
  23265. step?: OptionsStepValue;
  23266. /**
  23267. * (Highstock) Sticky tracking of mouse events. When true, the `mouseOut`
  23268. * event on a series isn't triggered until the mouse moves over another
  23269. * series, or out of the plot area. When false, the `mouseOut` event on a
  23270. * series is triggered when the mouse leaves the area around the series'
  23271. * graph or markers. This also implies the tooltip when not shared. When
  23272. * `stickyTracking` is false and `tooltip.shared` is false, the tooltip will
  23273. * be hidden when moving the mouse between series. Defaults to true for line
  23274. * and area type series, but to false for columns, pies etc.
  23275. *
  23276. * **Note:** The boost module will force this option because of technical
  23277. * limitations.
  23278. */
  23279. stickyTracking?: boolean;
  23280. /**
  23281. * (Highcharts, Highstock) The threshold, also called zero level or base
  23282. * level. For line type series this is only used in conjunction with
  23283. * negativeColor.
  23284. */
  23285. threshold?: (number|null);
  23286. /**
  23287. * (Highstock) A configuration object for the tooltip rendering of each
  23288. * single series. Properties are inherited from tooltip, but only the
  23289. * following properties can be defined on a series level.
  23290. */
  23291. tooltip?: SeriesTooltipOptionsObject;
  23292. /**
  23293. * (Highcharts, Highstock, Gantt) When a series contains a data array that
  23294. * is longer than this, only one dimensional arrays of numbers, or two
  23295. * dimensional arrays with x and y values are allowed. Also, only the first
  23296. * point is tested, and the rest are assumed to be the same format. This
  23297. * saves expensive data checking and indexing in long series. Set it to `0`
  23298. * disable.
  23299. *
  23300. * Note: In boost mode turbo threshold is forced. Only array of numbers or
  23301. * two dimensional arrays are allowed.
  23302. */
  23303. turboThreshold?: number;
  23304. /**
  23305. * (Highstock) Set the initial visibility of the series.
  23306. */
  23307. visible?: boolean;
  23308. /**
  23309. * (Highmaps) Define the z index of the series.
  23310. */
  23311. zIndex?: number;
  23312. /**
  23313. * (Highcharts, Highstock) Defines the Axis on which the zones are applied.
  23314. */
  23315. zoneAxis?: string;
  23316. /**
  23317. * (Highcharts, Highstock) An array defining zones within a series. Zones
  23318. * can be applied to the X axis, Y axis or Z axis for bubbles, according to
  23319. * the `zoneAxis` option. The zone definitions have to be in ascending order
  23320. * regarding to the value.
  23321. *
  23322. * In styled mode, the color zones are styled with the
  23323. * `.highcharts-zone-{n}` class, or custom classed from the `className`
  23324. * option (view live demo).
  23325. */
  23326. zones?: Array<SeriesZonesOptionsObject>;
  23327. }
  23328. /**
  23329. * (Highstock) Enable or disable the initial animation when a series is
  23330. * displayed. The animation can also be set as a configuration object. Please
  23331. * note that this option only applies to the initial animation of the series
  23332. * itself. For other animations, see chart.animation and the animation parameter
  23333. * under the API methods. The following properties are supported:
  23334. *
  23335. * - `defer`: The animation delay time in milliseconds.
  23336. *
  23337. * - `duration`: The duration of the animation in milliseconds.
  23338. *
  23339. * - `easing`: Can be a string reference to an easing function set on the `Math`
  23340. * object or a function. See the _Custom easing function_ demo below.
  23341. *
  23342. * Due to poor performance, animation is disabled in old IE browsers for several
  23343. * chart types.
  23344. */
  23345. export interface PlotAroonoscillatorAnimationOptions {
  23346. defer?: number;
  23347. }
  23348. /**
  23349. * (Highcharts, Highstock, Highmaps, Gantt) Enable or disable the initial
  23350. * animation when a series is displayed for the `dataLabels`. The animation can
  23351. * also be set as a configuration object. Please note that this option only
  23352. * applies to the initial animation. For other animations, see chart.animation
  23353. * and the animation parameter under the API methods. The following properties
  23354. * are supported:
  23355. *
  23356. * - `defer`: The animation delay time in milliseconds.
  23357. */
  23358. export interface PlotAroonoscillatorDataLabelsAnimationOptions {
  23359. /**
  23360. * (Highcharts, Highstock, Highmaps, Gantt) The animation delay time in
  23361. * milliseconds. Set to `0` renders dataLabel immediately. As `undefined`
  23362. * inherits defer time from the series.animation.defer.
  23363. */
  23364. defer?: number;
  23365. }
  23366. /**
  23367. * (Highcharts, Highstock, Highmaps, Gantt) Options for the series data labels,
  23368. * appearing next to each data point.
  23369. *
  23370. * Since v6.2.0, multiple data labels can be applied to each single point by
  23371. * defining them as an array of configs.
  23372. *
  23373. * In styled mode, the data labels can be styled with the
  23374. * `.highcharts-data-label-box` and `.highcharts-data-label` class names (see
  23375. * example).
  23376. */
  23377. export interface PlotAroonoscillatorDataLabelsOptions {
  23378. /**
  23379. * (Highcharts, Highstock, Highmaps, Gantt) The alignment of the data label
  23380. * compared to the point. If `right`, the right side of the label should be
  23381. * touching the point. For points with an extent, like columns, the
  23382. * alignments also dictates how to align it inside the box, as given with
  23383. * the inside option. Can be one of `left`, `center` or `right`.
  23384. */
  23385. align?: (AlignValue|null);
  23386. /**
  23387. * (Highcharts, Highstock, Highmaps, Gantt) Whether to allow data labels to
  23388. * overlap. To make the labels less sensitive for overlapping, the
  23389. * dataLabels.padding can be set to 0.
  23390. */
  23391. allowOverlap?: boolean;
  23392. /**
  23393. * (Highcharts, Highstock, Highmaps, Gantt) Enable or disable the initial
  23394. * animation when a series is displayed for the `dataLabels`. The animation
  23395. * can also be set as a configuration object. Please note that this option
  23396. * only applies to the initial animation. For other animations, see
  23397. * chart.animation and the animation parameter under the API methods. The
  23398. * following properties are supported:
  23399. *
  23400. * - `defer`: The animation delay time in milliseconds.
  23401. */
  23402. animation?: (boolean|PlotAroonoscillatorDataLabelsAnimationOptions|Partial<AnimationOptionsObject>);
  23403. /**
  23404. * (Highcharts, Highstock, Highmaps, Gantt) The background color or gradient
  23405. * for the data label.
  23406. */
  23407. backgroundColor?: (ColorString|GradientColorObject|PatternObject);
  23408. /**
  23409. * (Highcharts, Highstock, Highmaps, Gantt) The border color for the data
  23410. * label. Defaults to `undefined`.
  23411. */
  23412. borderColor?: (ColorString|GradientColorObject|PatternObject);
  23413. /**
  23414. * (Highcharts, Highstock, Highmaps, Gantt) The border radius in pixels for
  23415. * the data label.
  23416. */
  23417. borderRadius?: number;
  23418. /**
  23419. * (Highcharts, Highstock, Highmaps, Gantt) The border width in pixels for
  23420. * the data label.
  23421. */
  23422. borderWidth?: number;
  23423. /**
  23424. * (Highcharts, Highstock, Highmaps, Gantt) A class name for the data label.
  23425. * Particularly in styled mode, this can be used to give each series' or
  23426. * point's data label unique styling. In addition to this option, a default
  23427. * color class name is added so that we can give the labels a contrast text
  23428. * shadow.
  23429. */
  23430. className?: string;
  23431. /**
  23432. * (Highcharts, Highstock, Highmaps, Gantt) The text color for the data
  23433. * labels. Defaults to `undefined`. For certain series types, like column or
  23434. * map, the data labels can be drawn inside the points. In this case the
  23435. * data label will be drawn with maximum contrast by default. Additionally,
  23436. * it will be given a `text-outline` style with the opposite color, to
  23437. * further increase the contrast. This can be overridden by setting the
  23438. * `text-outline` style to `none` in the `dataLabels.style` option.
  23439. */
  23440. color?: (ColorString|GradientColorObject|PatternObject);
  23441. /**
  23442. * (Highcharts, Highstock, Highmaps, Gantt) Whether to hide data labels that
  23443. * are outside the plot area. By default, the data label is moved inside the
  23444. * plot area according to the overflow option.
  23445. */
  23446. crop?: boolean;
  23447. /**
  23448. * (Highcharts, Highstock, Gantt) Whether to defer displaying the data
  23449. * labels until the initial series animation has finished. Setting to
  23450. * `false` renders the data label immediately. If set to `true` inherits the
  23451. * defer time set in plotOptions.series.animation.
  23452. */
  23453. defer?: boolean;
  23454. /**
  23455. * (Highcharts, Highstock, Highmaps, Gantt) Enable or disable the data
  23456. * labels.
  23457. */
  23458. enabled?: boolean;
  23459. /**
  23460. * (Highcharts, Highstock, Highmaps, Gantt) A declarative filter to control
  23461. * of which data labels to display. The declarative filter is designed for
  23462. * use when callback functions are not available, like when the chart
  23463. * options require a pure JSON structure or for use with graphical editors.
  23464. * For programmatic control, use the `formatter` instead, and return
  23465. * `undefined` to disable a single data label.
  23466. */
  23467. filter?: DataLabelsFilterOptionsObject;
  23468. /**
  23469. * (Highcharts, Highstock, Highmaps, Gantt) A format string for the data
  23470. * label. Available variables are the same as for `formatter`.
  23471. */
  23472. format?: string;
  23473. /**
  23474. * (Highcharts, Highstock, Highmaps, Gantt) Callback JavaScript function to
  23475. * format the data label. Note that if a `format` is defined, the format
  23476. * takes precedence and the formatter is ignored.
  23477. */
  23478. formatter?: DataLabelsFormatterCallbackFunction;
  23479. /**
  23480. * (Highcharts, Highstock, Highmaps, Gantt) For points with an extent, like
  23481. * columns or map areas, whether to align the data label inside the box or
  23482. * to the actual value point. Defaults to `false` in most cases, `true` in
  23483. * stacked columns.
  23484. */
  23485. inside?: boolean;
  23486. /**
  23487. * (Highcharts, Highstock, Highmaps, Gantt) Format for points with the value
  23488. * of null. Works analogously to format. `nullFormat` can be applied only to
  23489. * series which support displaying null points.
  23490. */
  23491. nullFormat?: (boolean|string);
  23492. /**
  23493. * (Highcharts, Highstock, Highmaps, Gantt) Callback JavaScript function
  23494. * that defines formatting for points with the value of null. Works
  23495. * analogously to formatter. `nullPointFormatter` can be applied only to
  23496. * series which support displaying null points.
  23497. */
  23498. nullFormatter?: DataLabelsFormatterCallbackFunction;
  23499. /**
  23500. * (Highcharts, Highstock, Highmaps, Gantt) How to handle data labels that
  23501. * flow outside the plot area. The default is `"justify"`, which aligns them
  23502. * inside the plot area. For columns and bars, this means it will be moved
  23503. * inside the bar. To display data labels outside the plot area, set `crop`
  23504. * to `false` and `overflow` to `"allow"`.
  23505. */
  23506. overflow?: DataLabelsOverflowValue;
  23507. /**
  23508. * (Highcharts, Highstock, Highmaps, Gantt) When either the `borderWidth` or
  23509. * the `backgroundColor` is set, this is the padding within the box.
  23510. */
  23511. padding?: number;
  23512. /**
  23513. * (Highcharts, Highstock, Highmaps, Gantt) Aligns data labels relative to
  23514. * points. If `center` alignment is not possible, it defaults to `right`.
  23515. */
  23516. position?: AlignValue;
  23517. /**
  23518. * (Highcharts, Highstock, Highmaps, Gantt) Text rotation in degrees. Note
  23519. * that due to a more complex structure, backgrounds, borders and padding
  23520. * will be lost on a rotated data label.
  23521. */
  23522. rotation?: number;
  23523. /**
  23524. * (Highcharts, Highstock, Highmaps, Gantt) The shadow of the box. Works
  23525. * best with `borderWidth` or `backgroundColor`. Since 2.3 the shadow can be
  23526. * an object configuration containing `color`, `offsetX`, `offsetY`,
  23527. * `opacity` and `width`.
  23528. */
  23529. shadow?: (boolean|ShadowOptionsObject);
  23530. /**
  23531. * (Highcharts, Highstock, Highmaps, Gantt) The name of a symbol to use for
  23532. * the border around the label. Symbols are predefined functions on the
  23533. * Renderer object.
  23534. */
  23535. shape?: string;
  23536. /**
  23537. * (Highcharts, Highstock, Highmaps, Gantt) Styles for the label. The
  23538. * default `color` setting is `"contrast"`, which is a pseudo color that
  23539. * Highcharts picks up and applies the maximum contrast to the underlying
  23540. * point item, for example the bar in a bar chart.
  23541. *
  23542. * The `textOutline` is a pseudo property that applies an outline of the
  23543. * given width with the given color, which by default is the maximum
  23544. * contrast to the text. So a bright text color will result in a black text
  23545. * outline for maximum readability on a mixed background. In some cases,
  23546. * especially with grayscale text, the text outline doesn't work well, in
  23547. * which cases it can be disabled by setting it to `"none"`. When `useHTML`
  23548. * is true, the `textOutline` will not be picked up. In this, case, the same
  23549. * effect can be acheived through the `text-shadow` CSS property.
  23550. *
  23551. * For some series types, where each point has an extent, like for example
  23552. * tree maps, the data label may overflow the point. There are two
  23553. * strategies for handling overflow. By default, the text will wrap to
  23554. * multiple lines. The other strategy is to set `style.textOverflow` to
  23555. * `ellipsis`, which will keep the text on one line plus it will break
  23556. * inside long words.
  23557. */
  23558. style?: CSSObject;
  23559. /**
  23560. * (Highcharts, Highstock, Highmaps, Gantt) Options for a label text which
  23561. * should follow marker's shape. Border and background are disabled for a
  23562. * label that follows a path.
  23563. *
  23564. * **Note:** Only SVG-based renderer supports this option. Setting `useHTML`
  23565. * to true will disable this option.
  23566. */
  23567. textPath?: DataLabelsTextPathOptionsObject;
  23568. /**
  23569. * (Highcharts, Highstock, Highmaps, Gantt) Whether to use HTML to render
  23570. * the labels.
  23571. */
  23572. useHTML?: boolean;
  23573. /**
  23574. * (Highcharts, Highstock, Highmaps, Gantt) The vertical alignment of a data
  23575. * label. Can be one of `top`, `middle` or `bottom`. The default value
  23576. * depends on the data, for instance in a column chart, the label is above
  23577. * positive values and below negative values.
  23578. */
  23579. verticalAlign?: (VerticalAlignValue|null);
  23580. /**
  23581. * (Highcharts, Highstock, Highmaps, Gantt) The x position offset of the
  23582. * label relative to the point in pixels.
  23583. */
  23584. x?: number;
  23585. /**
  23586. * (Highcharts, Highstock, Highmaps, Gantt) The y position offset of the
  23587. * label relative to the point in pixels.
  23588. */
  23589. y?: number;
  23590. /**
  23591. * (Highcharts, Highstock, Highmaps, Gantt) The Z index of the data labels.
  23592. * The default Z index puts it above the series. Use a Z index of 2 to
  23593. * display it behind the series.
  23594. */
  23595. z?: number;
  23596. }
  23597. /**
  23598. * (Highcharts, Highstock) Options for the series data sorting.
  23599. */
  23600. export interface PlotAroonoscillatorDataSortingOptions {
  23601. /**
  23602. * (Highcharts, Highstock) Enable or disable data sorting for the series.
  23603. * Use xAxis.reversed to change the sorting order.
  23604. */
  23605. enabled?: boolean;
  23606. /**
  23607. * (Highcharts, Highstock) Whether to allow matching points by name in an
  23608. * update. If this option is disabled, points will be matched by order.
  23609. */
  23610. matchByName?: boolean;
  23611. /**
  23612. * (Highcharts, Highstock) Determines what data value should be used to sort
  23613. * by.
  23614. */
  23615. sortKey?: string;
  23616. }
  23617. /**
  23618. * (Highstock) Aroon Oscillator. This series requires the `linkedTo` option to
  23619. * be set and should be loaded after the `stock/indicators/indicators.js` and
  23620. * `stock/indicators/aroon.js`.
  23621. *
  23622. * In TypeScript the type option must always be set.
  23623. *
  23624. * Configuration options for the series are given in three levels:
  23625. *
  23626. * 1. Options for all series in a chart are defined in the plotOptions.series
  23627. * object.
  23628. *
  23629. * 2. Options for all `aroonoscillator` series are defined in
  23630. * plotOptions.aroonoscillator.
  23631. *
  23632. * 3. Options for one single series are given in the series instance array. (see
  23633. * online documentation for example)
  23634. */
  23635. export interface PlotAroonoscillatorOptions {
  23636. /**
  23637. * (Highstock) Accessibility options for a series.
  23638. */
  23639. accessibility?: SeriesAccessibilityOptionsObject;
  23640. /**
  23641. * (Highstock) Allow this series' points to be selected by clicking on the
  23642. * graphic (columns, point markers, pie slices, map areas etc).
  23643. *
  23644. * The selected points can be handled by point select and unselect events,
  23645. * or collectively by the getSelectedPoints function.
  23646. *
  23647. * And alternative way of selecting points is through dragging.
  23648. */
  23649. allowPointSelect?: boolean;
  23650. /**
  23651. * (Highstock) Enable or disable the initial animation when a series is
  23652. * displayed. The animation can also be set as a configuration object.
  23653. * Please note that this option only applies to the initial animation of the
  23654. * series itself. For other animations, see chart.animation and the
  23655. * animation parameter under the API methods. The following properties are
  23656. * supported:
  23657. *
  23658. * - `defer`: The animation delay time in milliseconds.
  23659. *
  23660. * - `duration`: The duration of the animation in milliseconds.
  23661. *
  23662. * - `easing`: Can be a string reference to an easing function set on the
  23663. * `Math` object or a function. See the _Custom easing function_ demo below.
  23664. *
  23665. * Due to poor performance, animation is disabled in old IE browsers for
  23666. * several chart types.
  23667. */
  23668. animation?: (boolean|PlotAroonoscillatorAnimationOptions|Partial<AnimationOptionsObject>);
  23669. /**
  23670. * (Highstock) For some series, there is a limit that shuts down initial
  23671. * animation by default when the total number of points in the chart is too
  23672. * high. For example, for a column chart and its derivatives, animation does
  23673. * not run if there is more than 250 points totally. To disable this cap,
  23674. * set `animationLimit` to `Infinity`.
  23675. */
  23676. animationLimit?: number;
  23677. /**
  23678. * (Highstock) Sets the color blending in the boost module.
  23679. */
  23680. boostBlending?: OptionsBoostBlendingValue;
  23681. /**
  23682. * (Highstock) Set the point threshold for when a series should enter boost
  23683. * mode.
  23684. *
  23685. * Setting it to e.g. 2000 will cause the series to enter boost mode when
  23686. * there are 2000 or more points in the series.
  23687. *
  23688. * To disable boosting on the series, set the `boostThreshold` to 0. Setting
  23689. * it to 1 will force boosting.
  23690. *
  23691. * Note that the cropThreshold also affects this setting. When zooming in on
  23692. * a series that has fewer points than the `cropThreshold`, all points are
  23693. * rendered although outside the visible plot area, and the `boostThreshold`
  23694. * won't take effect.
  23695. */
  23696. boostThreshold?: number;
  23697. /**
  23698. * (Highmaps) The border color of the map areas.
  23699. *
  23700. * In styled mode, the border stroke is given in the `.highcharts-point`
  23701. * class.
  23702. */
  23703. borderColor?: (ColorString|GradientColorObject|PatternObject);
  23704. /**
  23705. * (Highmaps) The border width of each map area.
  23706. *
  23707. * In styled mode, the border stroke width is given in the
  23708. * `.highcharts-point` class.
  23709. */
  23710. borderWidth?: number;
  23711. /**
  23712. * (Highstock) An additional class name to apply to the series' graphical
  23713. * elements. This option does not replace default class names of the
  23714. * graphical element.
  23715. */
  23716. className?: string;
  23717. /**
  23718. * (Highstock) Disable this option to allow series rendering in the whole
  23719. * plotting area.
  23720. *
  23721. * **Note:** Clipping should be always enabled when chart.zoomType is set
  23722. */
  23723. clip?: boolean;
  23724. /**
  23725. * (Highstock) The main color of the series. In line type series it applies
  23726. * to the line and the point markers unless otherwise specified. In bar type
  23727. * series it applies to the bars unless a color is specified per point. The
  23728. * default value is pulled from the `options.colors` array.
  23729. *
  23730. * In styled mode, the color can be defined by the colorIndex option. Also,
  23731. * the series color can be set with the `.highcharts-series`,
  23732. * `.highcharts-color-{n}`, `.highcharts-{type}-series` or
  23733. * `.highcharts-series-{n}` class, or individual classes given by the
  23734. * `className` option.
  23735. */
  23736. color?: (ColorString|GradientColorObject|PatternObject);
  23737. /**
  23738. * (Highstock) Styled mode only. A specific color index to use for the
  23739. * series, so its graphic representations are given the class name
  23740. * `highcharts-color-{n}`.
  23741. */
  23742. colorIndex?: number;
  23743. /**
  23744. * (Highcharts, Highstock, Highmaps) Determines what data value should be
  23745. * used to calculate point color if `colorAxis` is used. Requires to set
  23746. * `min` and `max` if some custom point property is used or if approximation
  23747. * for data grouping is set to `'sum'`.
  23748. */
  23749. colorKey?: string;
  23750. /**
  23751. * (Highstock) Defines if comparison should start from the first point
  23752. * within the visible range or should start from the first point **before**
  23753. * the range.
  23754. *
  23755. * In other words, this flag determines if first point within the visible
  23756. * range will have 0% (`compareStart=true`) or should have been already
  23757. * calculated according to the previous point (`compareStart=false`).
  23758. */
  23759. compareStart?: boolean;
  23760. /**
  23761. * (Highstock) Whether to compare indicator to the main series values or
  23762. * indicator values.
  23763. */
  23764. compareToMain?: boolean;
  23765. /**
  23766. * (Highcharts) Polar charts only. Whether to connect the ends of a line
  23767. * series plot across the extremes.
  23768. */
  23769. connectEnds?: boolean;
  23770. /**
  23771. * (Highcharts, Highstock) Whether to connect a graph line across null
  23772. * points, or render a gap between the two points on either side of the
  23773. * null.
  23774. */
  23775. connectNulls?: boolean;
  23776. /**
  23777. * (Gantt) Override Pathfinder connector options for a series. Requires
  23778. * Highcharts Gantt to be loaded.
  23779. */
  23780. connectors?: SeriesConnectorsOptionsObject;
  23781. /**
  23782. * (Highcharts, Highstock, Gantt) When true, each point or column edge is
  23783. * rounded to its nearest pixel in order to render sharp on screen. In some
  23784. * cases, when there are a lot of densely packed columns, this leads to
  23785. * visible difference in column widths or distance between columns. In these
  23786. * cases, setting `crisp` to `false` may look better, even though each
  23787. * column is rendered blurry.
  23788. */
  23789. crisp?: boolean;
  23790. /**
  23791. * (Highcharts, Highstock) When the series contains less points than the
  23792. * crop threshold, all points are drawn, even if the points fall outside the
  23793. * visible plot area at the current zoom. The advantage of drawing all
  23794. * points (including markers and columns), is that animation is performed on
  23795. * updates. On the other hand, when the series contains more points than the
  23796. * crop threshold, the series data is cropped to only contain points that
  23797. * fall within the plot area. The advantage of cropping away invisible
  23798. * points is to increase performance on large series.
  23799. */
  23800. cropThreshold?: number;
  23801. /**
  23802. * (Highstock) You can set the cursor to "pointer" if you have click events
  23803. * attached to the series, to signal to the user that the points and lines
  23804. * can be clicked.
  23805. *
  23806. * In styled mode, the series cursor can be set with the same classes as
  23807. * listed under series.color.
  23808. */
  23809. cursor?: (string|CursorValue);
  23810. /**
  23811. * (Highstock) A reserved subspace to store options and values for
  23812. * customized functionality. Here you can add additional data for your own
  23813. * event callbacks and formatter callbacks.
  23814. */
  23815. custom?: Dictionary<any>;
  23816. /**
  23817. * (Highstock) Name of the dash style to use for the graph, or for some
  23818. * series types the outline of each shape.
  23819. *
  23820. * In styled mode, the stroke dash-array can be set with the same classes as
  23821. * listed under series.color.
  23822. */
  23823. dashStyle?: DashStyleValue;
  23824. /**
  23825. * (Highstock) Data grouping is the concept of sampling the data values into
  23826. * larger blocks in order to ease readability and increase performance of
  23827. * the JavaScript charts. Highstock by default applies data grouping when
  23828. * the points become closer than a certain pixel value, determined by the
  23829. * `groupPixelWidth` option.
  23830. *
  23831. * If data grouping is applied, the grouping information of grouped points
  23832. * can be read from the Point.dataGroup. If point options other than the
  23833. * data itself are set, for example `name` or `color` or custom properties,
  23834. * the grouping logic doesn't know how to group it. In this case the options
  23835. * of the first point instance are copied over to the group point. This can
  23836. * be altered through a custom `approximation` callback function.
  23837. */
  23838. dataGrouping?: DataGroupingOptionsObject;
  23839. /**
  23840. * (Highcharts, Highstock, Highmaps, Gantt) Options for the series data
  23841. * labels, appearing next to each data point.
  23842. *
  23843. * Since v6.2.0, multiple data labels can be applied to each single point by
  23844. * defining them as an array of configs.
  23845. *
  23846. * In styled mode, the data labels can be styled with the
  23847. * `.highcharts-data-label-box` and `.highcharts-data-label` class names
  23848. * (see example).
  23849. */
  23850. dataLabels?: (PlotAroonoscillatorDataLabelsOptions|Array<PlotAroonoscillatorDataLabelsOptions>);
  23851. /**
  23852. * (Highcharts, Highstock) Options for the series data sorting.
  23853. */
  23854. dataSorting?: (DataSortingOptionsObject|PlotAroonoscillatorDataSortingOptions);
  23855. /**
  23856. * (Highstock) A description of the series to add to the screen reader
  23857. * information about the series.
  23858. */
  23859. description?: string;
  23860. /**
  23861. * (Highstock) Enable or disable the mouse tracking for a specific series.
  23862. * This includes point tooltips and click events on graphs and points. For
  23863. * large datasets it improves performance.
  23864. */
  23865. enableMouseTracking?: boolean;
  23866. /**
  23867. * (Highstock) General event handlers for the series items. These event
  23868. * hooks can also be attached to the series at run time using the
  23869. * `Highcharts.addEvent` function.
  23870. */
  23871. events?: SeriesEventsOptionsObject;
  23872. /**
  23873. * (Highstock) Determines whether the series should look for the nearest
  23874. * point in both dimensions or just the x-dimension when hovering the
  23875. * series. Defaults to `'xy'` for scatter series and `'x'` for most other
  23876. * series. If the data has duplicate x-values, it is recommended to set this
  23877. * to `'xy'` to allow hovering over all points.
  23878. *
  23879. * Applies only to series types using nearest neighbor search (not direct
  23880. * hover) for tooltip.
  23881. */
  23882. findNearestPointBy?: OptionsFindNearestPointByValue;
  23883. /**
  23884. * (Highstock) Defines when to display a gap in the graph, together with the
  23885. * gapUnit option.
  23886. *
  23887. * In case when `dataGrouping` is enabled, points can be grouped into a
  23888. * larger time span. This can make the grouped points to have a greater
  23889. * distance than the absolute value of `gapSize` property, which will result
  23890. * in disappearing graph completely. To prevent this situation the mentioned
  23891. * distance between grouped points is used instead of previously defined
  23892. * `gapSize`.
  23893. *
  23894. * In practice, this option is most often used to visualize gaps in time
  23895. * series. In a stock chart, intraday data is available for daytime hours,
  23896. * while gaps will appear in nights and weekends.
  23897. */
  23898. gapSize?: number;
  23899. /**
  23900. * (Highstock) Together with gapSize, this option defines where to draw gaps
  23901. * in the graph.
  23902. *
  23903. * When the `gapUnit` is `"relative"` (default), a gap size of 5 means that
  23904. * if the distance between two points is greater than 5 times that of the
  23905. * two closest points, the graph will be broken.
  23906. *
  23907. * When the `gapUnit` is `"value"`, the gap is based on absolute axis
  23908. * values, which on a datetime axis is milliseconds. This also applies to
  23909. * the navigator series that inherits gap options from the base series.
  23910. */
  23911. gapUnit?: OptionsGapUnitValue;
  23912. /**
  23913. * (Highcharts, Highstock, Gantt) Whether to use the Y extremes of the total
  23914. * chart width or only the zoomed area when zooming in on parts of the X
  23915. * axis. By default, the Y axis adjusts to the min and max of the visible
  23916. * data. Cartesian series only.
  23917. */
  23918. getExtremesFromAll?: boolean;
  23919. /**
  23920. * (Highstock) When set to `false` will prevent the series data from being
  23921. * included in any form of data export.
  23922. *
  23923. * Since version 6.0.0 until 7.1.0 the option was existing undocumented as
  23924. * `includeInCSVExport`.
  23925. */
  23926. includeInDataExport?: boolean;
  23927. /**
  23928. * (Highcharts, Highstock, Gantt) Series labels are placed as close to the
  23929. * series as possible in a natural way, seeking to avoid other series. The
  23930. * goal of this feature is to make the chart more easily readable, like if a
  23931. * human designer placed the labels in the optimal position.
  23932. *
  23933. * The series labels currently work with series types having a `graph` or an
  23934. * `area`.
  23935. */
  23936. label?: SeriesLabelOptionsObject;
  23937. /**
  23938. * (Highstock) The line marks the last price from all points.
  23939. */
  23940. lastPrice?: SeriesLastPriceOptionsObject;
  23941. /**
  23942. * (Highstock) The line marks the last price from visible range of points.
  23943. */
  23944. lastVisiblePrice?: SeriesLastVisiblePriceOptionsObject;
  23945. /**
  23946. * (Highcharts, Highstock) The SVG value used for the `stroke-linecap` and
  23947. * `stroke-linejoin` of a line graph. Round means that lines are rounded in
  23948. * the ends and bends.
  23949. */
  23950. linecap?: SeriesLinecapValue;
  23951. /**
  23952. * (Highcharts, Highstock) Pixel width of the graph line.
  23953. */
  23954. lineWidth?: number;
  23955. /**
  23956. * (Highcharts, Highstock, Gantt) The main series ID that indicator will be
  23957. * based on. Required for this indicator.
  23958. */
  23959. linkedTo?: string;
  23960. /**
  23961. * (Highstock) Options for the point markers of line-like series. Properties
  23962. * like `fillColor`, `lineColor` and `lineWidth` define the visual
  23963. * appearance of the markers. Other series types, like column series, don't
  23964. * have markers, but have visual options on the series level instead.
  23965. *
  23966. * In styled mode, the markers can be styled with the `.highcharts-point`,
  23967. * `.highcharts-point-hover` and `.highcharts-point-select` class names.
  23968. */
  23969. marker?: PointMarkerOptionsObject;
  23970. /**
  23971. * (Highstock) The name of the series as shown in the legend, tooltip etc.
  23972. * If not set, it will be based on a technical indicator type and default
  23973. * params.
  23974. */
  23975. name?: string;
  23976. /**
  23977. * (Highstock) The color for the parts of the graph or points that are below
  23978. * the threshold. Note that `zones` takes precedence over the negative
  23979. * color. Using `negativeColor` is equivalent to applying a zone with value
  23980. * of 0.
  23981. */
  23982. negativeColor?: (ColorString|GradientColorObject|PatternObject);
  23983. /**
  23984. * (Highstock) Opacity of a series parts: line, fill (e.g. area) and
  23985. * dataLabels.
  23986. */
  23987. opacity?: number;
  23988. /**
  23989. * (Highstock) Paramters used in calculation of aroon oscillator series
  23990. * points.
  23991. */
  23992. params?: PlotAroonoscillatorParamsOptions;
  23993. /**
  23994. * (Highstock) Properties for each single point.
  23995. */
  23996. point?: PlotSeriesPointOptions;
  23997. /**
  23998. * (Highstock) Same as accessibility.pointDescriptionFormatter, but for an
  23999. * individual series. Overrides the chart wide configuration.
  24000. */
  24001. pointDescriptionFormatter?: Function;
  24002. /**
  24003. * (Highstock) Whether to select the series initially. If `showCheckbox` is
  24004. * true, the checkbox next to the series name in the legend will be checked
  24005. * for a selected series.
  24006. */
  24007. selected?: boolean;
  24008. /**
  24009. * (Highstock) Whether to apply a drop shadow to the graph line. Since 2.3
  24010. * the shadow can be an object configuration containing `color`, `offsetX`,
  24011. * `offsetY`, `opacity` and `width`.
  24012. */
  24013. shadow?: (boolean|ShadowOptionsObject);
  24014. /**
  24015. * (Highstock) If true, a checkbox is displayed next to the legend item to
  24016. * allow selecting the series. The state of the checkbox is determined by
  24017. * the `selected` option.
  24018. */
  24019. showCheckbox?: boolean;
  24020. /**
  24021. * (Highstock) Whether to display this particular series or series type in
  24022. * the legend. Standalone series are shown in legend by default, and linked
  24023. * series are not. Since v7.2.0 it is possible to show series that use
  24024. * colorAxis by setting this option to `true`.
  24025. */
  24026. showInLegend?: boolean;
  24027. /**
  24028. * (Highstock) If set to `true`, the accessibility module will skip past the
  24029. * points in this series for keyboard navigation.
  24030. */
  24031. skipKeyboardNavigation?: boolean;
  24032. /**
  24033. * (Highcharts, Highstock) When this is true, the series will not cause the
  24034. * Y axis to cross the zero plane (or threshold option) unless the data
  24035. * actually crosses the plane.
  24036. *
  24037. * For example, if `softThreshold` is `false`, a series of 0, 1, 2, 3 will
  24038. * make the Y axis show negative values according to the `minPadding`
  24039. * option. If `softThreshold` is `true`, the Y axis starts at 0.
  24040. */
  24041. softThreshold?: boolean;
  24042. states?: SeriesStatesOptionsObject;
  24043. /**
  24044. * (Highcharts, Highstock) Whether to apply steps to the line. Possible
  24045. * values are `left`, `center` and `right`.
  24046. */
  24047. step?: OptionsStepValue;
  24048. /**
  24049. * (Highstock) Sticky tracking of mouse events. When true, the `mouseOut`
  24050. * event on a series isn't triggered until the mouse moves over another
  24051. * series, or out of the plot area. When false, the `mouseOut` event on a
  24052. * series is triggered when the mouse leaves the area around the series'
  24053. * graph or markers. This also implies the tooltip when not shared. When
  24054. * `stickyTracking` is false and `tooltip.shared` is false, the tooltip will
  24055. * be hidden when moving the mouse between series. Defaults to true for line
  24056. * and area type series, but to false for columns, pies etc.
  24057. *
  24058. * **Note:** The boost module will force this option because of technical
  24059. * limitations.
  24060. */
  24061. stickyTracking?: boolean;
  24062. /**
  24063. * (Highcharts, Highstock) The threshold, also called zero level or base
  24064. * level. For line type series this is only used in conjunction with
  24065. * negativeColor.
  24066. */
  24067. threshold?: (number|null);
  24068. /**
  24069. * (Highstock) A configuration object for the tooltip rendering of each
  24070. * single series. Properties are inherited from tooltip, but only the
  24071. * following properties can be defined on a series level.
  24072. */
  24073. tooltip?: SeriesTooltipOptionsObject;
  24074. /**
  24075. * (Highcharts, Highstock, Gantt) When a series contains a data array that
  24076. * is longer than this, only one dimensional arrays of numbers, or two
  24077. * dimensional arrays with x and y values are allowed. Also, only the first
  24078. * point is tested, and the rest are assumed to be the same format. This
  24079. * saves expensive data checking and indexing in long series. Set it to `0`
  24080. * disable.
  24081. *
  24082. * Note: In boost mode turbo threshold is forced. Only array of numbers or
  24083. * two dimensional arrays are allowed.
  24084. */
  24085. turboThreshold?: number;
  24086. /**
  24087. * (Highstock) Set the initial visibility of the series.
  24088. */
  24089. visible?: boolean;
  24090. /**
  24091. * (Highmaps) Define the z index of the series.
  24092. */
  24093. zIndex?: number;
  24094. /**
  24095. * (Highcharts, Highstock) Defines the Axis on which the zones are applied.
  24096. */
  24097. zoneAxis?: string;
  24098. /**
  24099. * (Highcharts, Highstock) An array defining zones within a series. Zones
  24100. * can be applied to the X axis, Y axis or Z axis for bubbles, according to
  24101. * the `zoneAxis` option. The zone definitions have to be in ascending order
  24102. * regarding to the value.
  24103. *
  24104. * In styled mode, the color zones are styled with the
  24105. * `.highcharts-zone-{n}` class, or custom classed from the `className`
  24106. * option (view live demo).
  24107. */
  24108. zones?: Array<SeriesZonesOptionsObject>;
  24109. }
  24110. /**
  24111. * (Highstock) Paramters used in calculation of aroon oscillator series points.
  24112. */
  24113. export interface PlotAroonoscillatorParamsOptions {
  24114. /**
  24115. * (Highstock) Period for Aroon Oscillator
  24116. */
  24117. period?: number;
  24118. }
  24119. /**
  24120. * (Highstock) Paramters used in calculation of aroon series points.
  24121. */
  24122. export interface PlotAroonParamsOptions {
  24123. /**
  24124. * (Highstock) Period for Aroon indicator
  24125. */
  24126. period?: number;
  24127. }
  24128. /**
  24129. * (Highstock) Enable or disable the initial animation when a series is
  24130. * displayed. The animation can also be set as a configuration object. Please
  24131. * note that this option only applies to the initial animation of the series
  24132. * itself. For other animations, see chart.animation and the animation parameter
  24133. * under the API methods. The following properties are supported:
  24134. *
  24135. * - `defer`: The animation delay time in milliseconds.
  24136. *
  24137. * - `duration`: The duration of the animation in milliseconds.
  24138. *
  24139. * - `easing`: Can be a string reference to an easing function set on the `Math`
  24140. * object or a function. See the _Custom easing function_ demo below.
  24141. *
  24142. * Due to poor performance, animation is disabled in old IE browsers for several
  24143. * chart types.
  24144. */
  24145. export interface PlotAtrAnimationOptions {
  24146. defer?: number;
  24147. }
  24148. /**
  24149. * (Highcharts, Highstock, Highmaps, Gantt) Enable or disable the initial
  24150. * animation when a series is displayed for the `dataLabels`. The animation can
  24151. * also be set as a configuration object. Please note that this option only
  24152. * applies to the initial animation. For other animations, see chart.animation
  24153. * and the animation parameter under the API methods. The following properties
  24154. * are supported:
  24155. *
  24156. * - `defer`: The animation delay time in milliseconds.
  24157. */
  24158. export interface PlotAtrDataLabelsAnimationOptions {
  24159. /**
  24160. * (Highcharts, Highstock, Highmaps, Gantt) The animation delay time in
  24161. * milliseconds. Set to `0` renders dataLabel immediately. As `undefined`
  24162. * inherits defer time from the series.animation.defer.
  24163. */
  24164. defer?: number;
  24165. }
  24166. /**
  24167. * (Highcharts, Highstock, Highmaps, Gantt) Options for the series data labels,
  24168. * appearing next to each data point.
  24169. *
  24170. * Since v6.2.0, multiple data labels can be applied to each single point by
  24171. * defining them as an array of configs.
  24172. *
  24173. * In styled mode, the data labels can be styled with the
  24174. * `.highcharts-data-label-box` and `.highcharts-data-label` class names (see
  24175. * example).
  24176. */
  24177. export interface PlotAtrDataLabelsOptions {
  24178. /**
  24179. * (Highcharts, Highstock, Highmaps, Gantt) The alignment of the data label
  24180. * compared to the point. If `right`, the right side of the label should be
  24181. * touching the point. For points with an extent, like columns, the
  24182. * alignments also dictates how to align it inside the box, as given with
  24183. * the inside option. Can be one of `left`, `center` or `right`.
  24184. */
  24185. align?: (AlignValue|null);
  24186. /**
  24187. * (Highcharts, Highstock, Highmaps, Gantt) Whether to allow data labels to
  24188. * overlap. To make the labels less sensitive for overlapping, the
  24189. * dataLabels.padding can be set to 0.
  24190. */
  24191. allowOverlap?: boolean;
  24192. /**
  24193. * (Highcharts, Highstock, Highmaps, Gantt) Enable or disable the initial
  24194. * animation when a series is displayed for the `dataLabels`. The animation
  24195. * can also be set as a configuration object. Please note that this option
  24196. * only applies to the initial animation. For other animations, see
  24197. * chart.animation and the animation parameter under the API methods. The
  24198. * following properties are supported:
  24199. *
  24200. * - `defer`: The animation delay time in milliseconds.
  24201. */
  24202. animation?: (boolean|PlotAtrDataLabelsAnimationOptions|Partial<AnimationOptionsObject>);
  24203. /**
  24204. * (Highcharts, Highstock, Highmaps, Gantt) The background color or gradient
  24205. * for the data label.
  24206. */
  24207. backgroundColor?: (ColorString|GradientColorObject|PatternObject);
  24208. /**
  24209. * (Highcharts, Highstock, Highmaps, Gantt) The border color for the data
  24210. * label. Defaults to `undefined`.
  24211. */
  24212. borderColor?: (ColorString|GradientColorObject|PatternObject);
  24213. /**
  24214. * (Highcharts, Highstock, Highmaps, Gantt) The border radius in pixels for
  24215. * the data label.
  24216. */
  24217. borderRadius?: number;
  24218. /**
  24219. * (Highcharts, Highstock, Highmaps, Gantt) The border width in pixels for
  24220. * the data label.
  24221. */
  24222. borderWidth?: number;
  24223. /**
  24224. * (Highcharts, Highstock, Highmaps, Gantt) A class name for the data label.
  24225. * Particularly in styled mode, this can be used to give each series' or
  24226. * point's data label unique styling. In addition to this option, a default
  24227. * color class name is added so that we can give the labels a contrast text
  24228. * shadow.
  24229. */
  24230. className?: string;
  24231. /**
  24232. * (Highcharts, Highstock, Highmaps, Gantt) The text color for the data
  24233. * labels. Defaults to `undefined`. For certain series types, like column or
  24234. * map, the data labels can be drawn inside the points. In this case the
  24235. * data label will be drawn with maximum contrast by default. Additionally,
  24236. * it will be given a `text-outline` style with the opposite color, to
  24237. * further increase the contrast. This can be overridden by setting the
  24238. * `text-outline` style to `none` in the `dataLabels.style` option.
  24239. */
  24240. color?: (ColorString|GradientColorObject|PatternObject);
  24241. /**
  24242. * (Highcharts, Highstock, Highmaps, Gantt) Whether to hide data labels that
  24243. * are outside the plot area. By default, the data label is moved inside the
  24244. * plot area according to the overflow option.
  24245. */
  24246. crop?: boolean;
  24247. /**
  24248. * (Highcharts, Highstock, Gantt) Whether to defer displaying the data
  24249. * labels until the initial series animation has finished. Setting to
  24250. * `false` renders the data label immediately. If set to `true` inherits the
  24251. * defer time set in plotOptions.series.animation.
  24252. */
  24253. defer?: boolean;
  24254. /**
  24255. * (Highcharts, Highstock, Highmaps, Gantt) Enable or disable the data
  24256. * labels.
  24257. */
  24258. enabled?: boolean;
  24259. /**
  24260. * (Highcharts, Highstock, Highmaps, Gantt) A declarative filter to control
  24261. * of which data labels to display. The declarative filter is designed for
  24262. * use when callback functions are not available, like when the chart
  24263. * options require a pure JSON structure or for use with graphical editors.
  24264. * For programmatic control, use the `formatter` instead, and return
  24265. * `undefined` to disable a single data label.
  24266. */
  24267. filter?: DataLabelsFilterOptionsObject;
  24268. /**
  24269. * (Highcharts, Highstock, Highmaps, Gantt) A format string for the data
  24270. * label. Available variables are the same as for `formatter`.
  24271. */
  24272. format?: string;
  24273. /**
  24274. * (Highcharts, Highstock, Highmaps, Gantt) Callback JavaScript function to
  24275. * format the data label. Note that if a `format` is defined, the format
  24276. * takes precedence and the formatter is ignored.
  24277. */
  24278. formatter?: DataLabelsFormatterCallbackFunction;
  24279. /**
  24280. * (Highcharts, Highstock, Highmaps, Gantt) For points with an extent, like
  24281. * columns or map areas, whether to align the data label inside the box or
  24282. * to the actual value point. Defaults to `false` in most cases, `true` in
  24283. * stacked columns.
  24284. */
  24285. inside?: boolean;
  24286. /**
  24287. * (Highcharts, Highstock, Highmaps, Gantt) Format for points with the value
  24288. * of null. Works analogously to format. `nullFormat` can be applied only to
  24289. * series which support displaying null points.
  24290. */
  24291. nullFormat?: (boolean|string);
  24292. /**
  24293. * (Highcharts, Highstock, Highmaps, Gantt) Callback JavaScript function
  24294. * that defines formatting for points with the value of null. Works
  24295. * analogously to formatter. `nullPointFormatter` can be applied only to
  24296. * series which support displaying null points.
  24297. */
  24298. nullFormatter?: DataLabelsFormatterCallbackFunction;
  24299. /**
  24300. * (Highcharts, Highstock, Highmaps, Gantt) How to handle data labels that
  24301. * flow outside the plot area. The default is `"justify"`, which aligns them
  24302. * inside the plot area. For columns and bars, this means it will be moved
  24303. * inside the bar. To display data labels outside the plot area, set `crop`
  24304. * to `false` and `overflow` to `"allow"`.
  24305. */
  24306. overflow?: DataLabelsOverflowValue;
  24307. /**
  24308. * (Highcharts, Highstock, Highmaps, Gantt) When either the `borderWidth` or
  24309. * the `backgroundColor` is set, this is the padding within the box.
  24310. */
  24311. padding?: number;
  24312. /**
  24313. * (Highcharts, Highstock, Highmaps, Gantt) Aligns data labels relative to
  24314. * points. If `center` alignment is not possible, it defaults to `right`.
  24315. */
  24316. position?: AlignValue;
  24317. /**
  24318. * (Highcharts, Highstock, Highmaps, Gantt) Text rotation in degrees. Note
  24319. * that due to a more complex structure, backgrounds, borders and padding
  24320. * will be lost on a rotated data label.
  24321. */
  24322. rotation?: number;
  24323. /**
  24324. * (Highcharts, Highstock, Highmaps, Gantt) The shadow of the box. Works
  24325. * best with `borderWidth` or `backgroundColor`. Since 2.3 the shadow can be
  24326. * an object configuration containing `color`, `offsetX`, `offsetY`,
  24327. * `opacity` and `width`.
  24328. */
  24329. shadow?: (boolean|ShadowOptionsObject);
  24330. /**
  24331. * (Highcharts, Highstock, Highmaps, Gantt) The name of a symbol to use for
  24332. * the border around the label. Symbols are predefined functions on the
  24333. * Renderer object.
  24334. */
  24335. shape?: string;
  24336. /**
  24337. * (Highcharts, Highstock, Highmaps, Gantt) Styles for the label. The
  24338. * default `color` setting is `"contrast"`, which is a pseudo color that
  24339. * Highcharts picks up and applies the maximum contrast to the underlying
  24340. * point item, for example the bar in a bar chart.
  24341. *
  24342. * The `textOutline` is a pseudo property that applies an outline of the
  24343. * given width with the given color, which by default is the maximum
  24344. * contrast to the text. So a bright text color will result in a black text
  24345. * outline for maximum readability on a mixed background. In some cases,
  24346. * especially with grayscale text, the text outline doesn't work well, in
  24347. * which cases it can be disabled by setting it to `"none"`. When `useHTML`
  24348. * is true, the `textOutline` will not be picked up. In this, case, the same
  24349. * effect can be acheived through the `text-shadow` CSS property.
  24350. *
  24351. * For some series types, where each point has an extent, like for example
  24352. * tree maps, the data label may overflow the point. There are two
  24353. * strategies for handling overflow. By default, the text will wrap to
  24354. * multiple lines. The other strategy is to set `style.textOverflow` to
  24355. * `ellipsis`, which will keep the text on one line plus it will break
  24356. * inside long words.
  24357. */
  24358. style?: CSSObject;
  24359. /**
  24360. * (Highcharts, Highstock, Highmaps, Gantt) Options for a label text which
  24361. * should follow marker's shape. Border and background are disabled for a
  24362. * label that follows a path.
  24363. *
  24364. * **Note:** Only SVG-based renderer supports this option. Setting `useHTML`
  24365. * to true will disable this option.
  24366. */
  24367. textPath?: DataLabelsTextPathOptionsObject;
  24368. /**
  24369. * (Highcharts, Highstock, Highmaps, Gantt) Whether to use HTML to render
  24370. * the labels.
  24371. */
  24372. useHTML?: boolean;
  24373. /**
  24374. * (Highcharts, Highstock, Highmaps, Gantt) The vertical alignment of a data
  24375. * label. Can be one of `top`, `middle` or `bottom`. The default value
  24376. * depends on the data, for instance in a column chart, the label is above
  24377. * positive values and below negative values.
  24378. */
  24379. verticalAlign?: (VerticalAlignValue|null);
  24380. /**
  24381. * (Highcharts, Highstock, Highmaps, Gantt) The x position offset of the
  24382. * label relative to the point in pixels.
  24383. */
  24384. x?: number;
  24385. /**
  24386. * (Highcharts, Highstock, Highmaps, Gantt) The y position offset of the
  24387. * label relative to the point in pixels.
  24388. */
  24389. y?: number;
  24390. /**
  24391. * (Highcharts, Highstock, Highmaps, Gantt) The Z index of the data labels.
  24392. * The default Z index puts it above the series. Use a Z index of 2 to
  24393. * display it behind the series.
  24394. */
  24395. z?: number;
  24396. }
  24397. /**
  24398. * (Highcharts, Highstock) Options for the series data sorting.
  24399. */
  24400. export interface PlotAtrDataSortingOptions {
  24401. /**
  24402. * (Highcharts, Highstock) Enable or disable data sorting for the series.
  24403. * Use xAxis.reversed to change the sorting order.
  24404. */
  24405. enabled?: boolean;
  24406. /**
  24407. * (Highcharts, Highstock) Whether to allow matching points by name in an
  24408. * update. If this option is disabled, points will be matched by order.
  24409. */
  24410. matchByName?: boolean;
  24411. /**
  24412. * (Highcharts, Highstock) Determines what data value should be used to sort
  24413. * by.
  24414. */
  24415. sortKey?: string;
  24416. }
  24417. /**
  24418. * (Highstock) Average true range indicator (ATR). This series requires
  24419. * `linkedTo` option to be set.
  24420. *
  24421. * In TypeScript the type option must always be set.
  24422. *
  24423. * Configuration options for the series are given in three levels:
  24424. *
  24425. * 1. Options for all series in a chart are defined in the plotOptions.series
  24426. * object.
  24427. *
  24428. * 2. Options for all `atr` series are defined in plotOptions.atr.
  24429. *
  24430. * 3. Options for one single series are given in the series instance array. (see
  24431. * online documentation for example)
  24432. */
  24433. export interface PlotAtrOptions {
  24434. /**
  24435. * (Highstock) Accessibility options for a series.
  24436. */
  24437. accessibility?: SeriesAccessibilityOptionsObject;
  24438. /**
  24439. * (Highstock) Allow this series' points to be selected by clicking on the
  24440. * graphic (columns, point markers, pie slices, map areas etc).
  24441. *
  24442. * The selected points can be handled by point select and unselect events,
  24443. * or collectively by the getSelectedPoints function.
  24444. *
  24445. * And alternative way of selecting points is through dragging.
  24446. */
  24447. allowPointSelect?: boolean;
  24448. /**
  24449. * (Highstock) Enable or disable the initial animation when a series is
  24450. * displayed. The animation can also be set as a configuration object.
  24451. * Please note that this option only applies to the initial animation of the
  24452. * series itself. For other animations, see chart.animation and the
  24453. * animation parameter under the API methods. The following properties are
  24454. * supported:
  24455. *
  24456. * - `defer`: The animation delay time in milliseconds.
  24457. *
  24458. * - `duration`: The duration of the animation in milliseconds.
  24459. *
  24460. * - `easing`: Can be a string reference to an easing function set on the
  24461. * `Math` object or a function. See the _Custom easing function_ demo below.
  24462. *
  24463. * Due to poor performance, animation is disabled in old IE browsers for
  24464. * several chart types.
  24465. */
  24466. animation?: (boolean|PlotAtrAnimationOptions|Partial<AnimationOptionsObject>);
  24467. /**
  24468. * (Highstock) For some series, there is a limit that shuts down initial
  24469. * animation by default when the total number of points in the chart is too
  24470. * high. For example, for a column chart and its derivatives, animation does
  24471. * not run if there is more than 250 points totally. To disable this cap,
  24472. * set `animationLimit` to `Infinity`.
  24473. */
  24474. animationLimit?: number;
  24475. /**
  24476. * (Highstock) Sets the color blending in the boost module.
  24477. */
  24478. boostBlending?: OptionsBoostBlendingValue;
  24479. /**
  24480. * (Highstock) Set the point threshold for when a series should enter boost
  24481. * mode.
  24482. *
  24483. * Setting it to e.g. 2000 will cause the series to enter boost mode when
  24484. * there are 2000 or more points in the series.
  24485. *
  24486. * To disable boosting on the series, set the `boostThreshold` to 0. Setting
  24487. * it to 1 will force boosting.
  24488. *
  24489. * Note that the cropThreshold also affects this setting. When zooming in on
  24490. * a series that has fewer points than the `cropThreshold`, all points are
  24491. * rendered although outside the visible plot area, and the `boostThreshold`
  24492. * won't take effect.
  24493. */
  24494. boostThreshold?: number;
  24495. /**
  24496. * (Highmaps) The border color of the map areas.
  24497. *
  24498. * In styled mode, the border stroke is given in the `.highcharts-point`
  24499. * class.
  24500. */
  24501. borderColor?: (ColorString|GradientColorObject|PatternObject);
  24502. /**
  24503. * (Highmaps) The border width of each map area.
  24504. *
  24505. * In styled mode, the border stroke width is given in the
  24506. * `.highcharts-point` class.
  24507. */
  24508. borderWidth?: number;
  24509. /**
  24510. * (Highstock) An additional class name to apply to the series' graphical
  24511. * elements. This option does not replace default class names of the
  24512. * graphical element.
  24513. */
  24514. className?: string;
  24515. /**
  24516. * (Highstock) Disable this option to allow series rendering in the whole
  24517. * plotting area.
  24518. *
  24519. * **Note:** Clipping should be always enabled when chart.zoomType is set
  24520. */
  24521. clip?: boolean;
  24522. /**
  24523. * (Highstock) The main color of the series. In line type series it applies
  24524. * to the line and the point markers unless otherwise specified. In bar type
  24525. * series it applies to the bars unless a color is specified per point. The
  24526. * default value is pulled from the `options.colors` array.
  24527. *
  24528. * In styled mode, the color can be defined by the colorIndex option. Also,
  24529. * the series color can be set with the `.highcharts-series`,
  24530. * `.highcharts-color-{n}`, `.highcharts-{type}-series` or
  24531. * `.highcharts-series-{n}` class, or individual classes given by the
  24532. * `className` option.
  24533. */
  24534. color?: (ColorString|GradientColorObject|PatternObject);
  24535. /**
  24536. * (Highstock) Styled mode only. A specific color index to use for the
  24537. * series, so its graphic representations are given the class name
  24538. * `highcharts-color-{n}`.
  24539. */
  24540. colorIndex?: number;
  24541. /**
  24542. * (Highcharts, Highstock, Highmaps) Determines what data value should be
  24543. * used to calculate point color if `colorAxis` is used. Requires to set
  24544. * `min` and `max` if some custom point property is used or if approximation
  24545. * for data grouping is set to `'sum'`.
  24546. */
  24547. colorKey?: string;
  24548. /**
  24549. * (Highstock) Compare the values of the series against the first non-null,
  24550. * non- zero value in the visible range. The y axis will show percentage or
  24551. * absolute change depending on whether `compare` is set to `"percent"` or
  24552. * `"value"`. When this is applied to multiple series, it allows comparing
  24553. * the development of the series against each other. Adds a `change` field
  24554. * to every point object.
  24555. */
  24556. compare?: string;
  24557. /**
  24558. * (Highstock) When compare is `percent`, this option dictates whether to
  24559. * use 0 or 100 as the base of comparison.
  24560. */
  24561. compareBase?: (0|100);
  24562. /**
  24563. * (Highstock) Defines if comparison should start from the first point
  24564. * within the visible range or should start from the first point **before**
  24565. * the range.
  24566. *
  24567. * In other words, this flag determines if first point within the visible
  24568. * range will have 0% (`compareStart=true`) or should have been already
  24569. * calculated according to the previous point (`compareStart=false`).
  24570. */
  24571. compareStart?: boolean;
  24572. /**
  24573. * (Highstock) Whether to compare indicator to the main series values or
  24574. * indicator values.
  24575. */
  24576. compareToMain?: boolean;
  24577. /**
  24578. * (Highcharts) Polar charts only. Whether to connect the ends of a line
  24579. * series plot across the extremes.
  24580. */
  24581. connectEnds?: boolean;
  24582. /**
  24583. * (Highcharts, Highstock) Whether to connect a graph line across null
  24584. * points, or render a gap between the two points on either side of the
  24585. * null.
  24586. */
  24587. connectNulls?: boolean;
  24588. /**
  24589. * (Gantt) Override Pathfinder connector options for a series. Requires
  24590. * Highcharts Gantt to be loaded.
  24591. */
  24592. connectors?: SeriesConnectorsOptionsObject;
  24593. /**
  24594. * (Highcharts, Highstock, Gantt) When true, each point or column edge is
  24595. * rounded to its nearest pixel in order to render sharp on screen. In some
  24596. * cases, when there are a lot of densely packed columns, this leads to
  24597. * visible difference in column widths or distance between columns. In these
  24598. * cases, setting `crisp` to `false` may look better, even though each
  24599. * column is rendered blurry.
  24600. */
  24601. crisp?: boolean;
  24602. /**
  24603. * (Highcharts, Highstock) When the series contains less points than the
  24604. * crop threshold, all points are drawn, even if the points fall outside the
  24605. * visible plot area at the current zoom. The advantage of drawing all
  24606. * points (including markers and columns), is that animation is performed on
  24607. * updates. On the other hand, when the series contains more points than the
  24608. * crop threshold, the series data is cropped to only contain points that
  24609. * fall within the plot area. The advantage of cropping away invisible
  24610. * points is to increase performance on large series.
  24611. */
  24612. cropThreshold?: number;
  24613. /**
  24614. * (Highstock) You can set the cursor to "pointer" if you have click events
  24615. * attached to the series, to signal to the user that the points and lines
  24616. * can be clicked.
  24617. *
  24618. * In styled mode, the series cursor can be set with the same classes as
  24619. * listed under series.color.
  24620. */
  24621. cursor?: (string|CursorValue);
  24622. /**
  24623. * (Highstock) A reserved subspace to store options and values for
  24624. * customized functionality. Here you can add additional data for your own
  24625. * event callbacks and formatter callbacks.
  24626. */
  24627. custom?: Dictionary<any>;
  24628. /**
  24629. * (Highstock) Name of the dash style to use for the graph, or for some
  24630. * series types the outline of each shape.
  24631. *
  24632. * In styled mode, the stroke dash-array can be set with the same classes as
  24633. * listed under series.color.
  24634. */
  24635. dashStyle?: DashStyleValue;
  24636. /**
  24637. * (Highstock) Data grouping is the concept of sampling the data values into
  24638. * larger blocks in order to ease readability and increase performance of
  24639. * the JavaScript charts. Highstock by default applies data grouping when
  24640. * the points become closer than a certain pixel value, determined by the
  24641. * `groupPixelWidth` option.
  24642. *
  24643. * If data grouping is applied, the grouping information of grouped points
  24644. * can be read from the Point.dataGroup. If point options other than the
  24645. * data itself are set, for example `name` or `color` or custom properties,
  24646. * the grouping logic doesn't know how to group it. In this case the options
  24647. * of the first point instance are copied over to the group point. This can
  24648. * be altered through a custom `approximation` callback function.
  24649. */
  24650. dataGrouping?: DataGroupingOptionsObject;
  24651. /**
  24652. * (Highcharts, Highstock, Highmaps, Gantt) Options for the series data
  24653. * labels, appearing next to each data point.
  24654. *
  24655. * Since v6.2.0, multiple data labels can be applied to each single point by
  24656. * defining them as an array of configs.
  24657. *
  24658. * In styled mode, the data labels can be styled with the
  24659. * `.highcharts-data-label-box` and `.highcharts-data-label` class names
  24660. * (see example).
  24661. */
  24662. dataLabels?: (PlotAtrDataLabelsOptions|Array<PlotAtrDataLabelsOptions>);
  24663. /**
  24664. * (Highcharts, Highstock) Options for the series data sorting.
  24665. */
  24666. dataSorting?: (DataSortingOptionsObject|PlotAtrDataSortingOptions);
  24667. /**
  24668. * (Highstock) A description of the series to add to the screen reader
  24669. * information about the series.
  24670. */
  24671. description?: string;
  24672. /**
  24673. * (Highstock) Enable or disable the mouse tracking for a specific series.
  24674. * This includes point tooltips and click events on graphs and points. For
  24675. * large datasets it improves performance.
  24676. */
  24677. enableMouseTracking?: boolean;
  24678. /**
  24679. * (Highstock) General event handlers for the series items. These event
  24680. * hooks can also be attached to the series at run time using the
  24681. * `Highcharts.addEvent` function.
  24682. */
  24683. events?: SeriesEventsOptionsObject;
  24684. /**
  24685. * (Highstock) Determines whether the series should look for the nearest
  24686. * point in both dimensions or just the x-dimension when hovering the
  24687. * series. Defaults to `'xy'` for scatter series and `'x'` for most other
  24688. * series. If the data has duplicate x-values, it is recommended to set this
  24689. * to `'xy'` to allow hovering over all points.
  24690. *
  24691. * Applies only to series types using nearest neighbor search (not direct
  24692. * hover) for tooltip.
  24693. */
  24694. findNearestPointBy?: OptionsFindNearestPointByValue;
  24695. /**
  24696. * (Highstock) Defines when to display a gap in the graph, together with the
  24697. * gapUnit option.
  24698. *
  24699. * In case when `dataGrouping` is enabled, points can be grouped into a
  24700. * larger time span. This can make the grouped points to have a greater
  24701. * distance than the absolute value of `gapSize` property, which will result
  24702. * in disappearing graph completely. To prevent this situation the mentioned
  24703. * distance between grouped points is used instead of previously defined
  24704. * `gapSize`.
  24705. *
  24706. * In practice, this option is most often used to visualize gaps in time
  24707. * series. In a stock chart, intraday data is available for daytime hours,
  24708. * while gaps will appear in nights and weekends.
  24709. */
  24710. gapSize?: number;
  24711. /**
  24712. * (Highstock) Together with gapSize, this option defines where to draw gaps
  24713. * in the graph.
  24714. *
  24715. * When the `gapUnit` is `"relative"` (default), a gap size of 5 means that
  24716. * if the distance between two points is greater than 5 times that of the
  24717. * two closest points, the graph will be broken.
  24718. *
  24719. * When the `gapUnit` is `"value"`, the gap is based on absolute axis
  24720. * values, which on a datetime axis is milliseconds. This also applies to
  24721. * the navigator series that inherits gap options from the base series.
  24722. */
  24723. gapUnit?: OptionsGapUnitValue;
  24724. /**
  24725. * (Highcharts, Highstock, Gantt) Whether to use the Y extremes of the total
  24726. * chart width or only the zoomed area when zooming in on parts of the X
  24727. * axis. By default, the Y axis adjusts to the min and max of the visible
  24728. * data. Cartesian series only.
  24729. */
  24730. getExtremesFromAll?: boolean;
  24731. /**
  24732. * (Highstock) When set to `false` will prevent the series data from being
  24733. * included in any form of data export.
  24734. *
  24735. * Since version 6.0.0 until 7.1.0 the option was existing undocumented as
  24736. * `includeInCSVExport`.
  24737. */
  24738. includeInDataExport?: boolean;
  24739. /**
  24740. * (Highcharts, Highstock, Gantt) Series labels are placed as close to the
  24741. * series as possible in a natural way, seeking to avoid other series. The
  24742. * goal of this feature is to make the chart more easily readable, like if a
  24743. * human designer placed the labels in the optimal position.
  24744. *
  24745. * The series labels currently work with series types having a `graph` or an
  24746. * `area`.
  24747. */
  24748. label?: SeriesLabelOptionsObject;
  24749. /**
  24750. * (Highstock) The line marks the last price from all points.
  24751. */
  24752. lastPrice?: SeriesLastPriceOptionsObject;
  24753. /**
  24754. * (Highstock) The line marks the last price from visible range of points.
  24755. */
  24756. lastVisiblePrice?: SeriesLastVisiblePriceOptionsObject;
  24757. /**
  24758. * (Highcharts, Highstock) The SVG value used for the `stroke-linecap` and
  24759. * `stroke-linejoin` of a line graph. Round means that lines are rounded in
  24760. * the ends and bends.
  24761. */
  24762. linecap?: SeriesLinecapValue;
  24763. /**
  24764. * (Highcharts, Highstock) Pixel width of the graph line.
  24765. */
  24766. lineWidth?: number;
  24767. /**
  24768. * (Highcharts, Highstock, Gantt) The main series ID that indicator will be
  24769. * based on. Required for this indicator.
  24770. */
  24771. linkedTo?: string;
  24772. /**
  24773. * (Highstock) Options for the point markers of line-like series. Properties
  24774. * like `fillColor`, `lineColor` and `lineWidth` define the visual
  24775. * appearance of the markers. Other series types, like column series, don't
  24776. * have markers, but have visual options on the series level instead.
  24777. *
  24778. * In styled mode, the markers can be styled with the `.highcharts-point`,
  24779. * `.highcharts-point-hover` and `.highcharts-point-select` class names.
  24780. */
  24781. marker?: PointMarkerOptionsObject;
  24782. /**
  24783. * (Highstock) The name of the series as shown in the legend, tooltip etc.
  24784. * If not set, it will be based on a technical indicator type and default
  24785. * params.
  24786. */
  24787. name?: string;
  24788. /**
  24789. * (Highstock) The color for the parts of the graph or points that are below
  24790. * the threshold. Note that `zones` takes precedence over the negative
  24791. * color. Using `negativeColor` is equivalent to applying a zone with value
  24792. * of 0.
  24793. */
  24794. negativeColor?: (ColorString|GradientColorObject|PatternObject);
  24795. /**
  24796. * (Highstock) Opacity of a series parts: line, fill (e.g. area) and
  24797. * dataLabels.
  24798. */
  24799. opacity?: number;
  24800. /**
  24801. * (Highstock) Paramters used in calculation of regression series' points.
  24802. */
  24803. params?: PlotAtrParamsOptions;
  24804. /**
  24805. * (Highstock) Properties for each single point.
  24806. */
  24807. point?: PlotSeriesPointOptions;
  24808. /**
  24809. * (Highstock) Same as accessibility.pointDescriptionFormatter, but for an
  24810. * individual series. Overrides the chart wide configuration.
  24811. */
  24812. pointDescriptionFormatter?: Function;
  24813. /**
  24814. * (Highstock) Whether to select the series initially. If `showCheckbox` is
  24815. * true, the checkbox next to the series name in the legend will be checked
  24816. * for a selected series.
  24817. */
  24818. selected?: boolean;
  24819. /**
  24820. * (Highstock) Whether to apply a drop shadow to the graph line. Since 2.3
  24821. * the shadow can be an object configuration containing `color`, `offsetX`,
  24822. * `offsetY`, `opacity` and `width`.
  24823. */
  24824. shadow?: (boolean|ShadowOptionsObject);
  24825. /**
  24826. * (Highstock) If true, a checkbox is displayed next to the legend item to
  24827. * allow selecting the series. The state of the checkbox is determined by
  24828. * the `selected` option.
  24829. */
  24830. showCheckbox?: boolean;
  24831. /**
  24832. * (Highstock) Whether to display this particular series or series type in
  24833. * the legend. Standalone series are shown in legend by default, and linked
  24834. * series are not. Since v7.2.0 it is possible to show series that use
  24835. * colorAxis by setting this option to `true`.
  24836. */
  24837. showInLegend?: boolean;
  24838. /**
  24839. * (Highstock) If set to `true`, the accessibility module will skip past the
  24840. * points in this series for keyboard navigation.
  24841. */
  24842. skipKeyboardNavigation?: boolean;
  24843. /**
  24844. * (Highcharts, Highstock) When this is true, the series will not cause the
  24845. * Y axis to cross the zero plane (or threshold option) unless the data
  24846. * actually crosses the plane.
  24847. *
  24848. * For example, if `softThreshold` is `false`, a series of 0, 1, 2, 3 will
  24849. * make the Y axis show negative values according to the `minPadding`
  24850. * option. If `softThreshold` is `true`, the Y axis starts at 0.
  24851. */
  24852. softThreshold?: boolean;
  24853. states?: SeriesStatesOptionsObject;
  24854. /**
  24855. * (Highcharts, Highstock) Whether to apply steps to the line. Possible
  24856. * values are `left`, `center` and `right`.
  24857. */
  24858. step?: OptionsStepValue;
  24859. /**
  24860. * (Highstock) Sticky tracking of mouse events. When true, the `mouseOut`
  24861. * event on a series isn't triggered until the mouse moves over another
  24862. * series, or out of the plot area. When false, the `mouseOut` event on a
  24863. * series is triggered when the mouse leaves the area around the series'
  24864. * graph or markers. This also implies the tooltip when not shared. When
  24865. * `stickyTracking` is false and `tooltip.shared` is false, the tooltip will
  24866. * be hidden when moving the mouse between series. Defaults to true for line
  24867. * and area type series, but to false for columns, pies etc.
  24868. *
  24869. * **Note:** The boost module will force this option because of technical
  24870. * limitations.
  24871. */
  24872. stickyTracking?: boolean;
  24873. /**
  24874. * (Highcharts, Highstock) The threshold, also called zero level or base
  24875. * level. For line type series this is only used in conjunction with
  24876. * negativeColor.
  24877. */
  24878. threshold?: (number|null);
  24879. /**
  24880. * (Highstock) A configuration object for the tooltip rendering of each
  24881. * single series. Properties are inherited from tooltip, but only the
  24882. * following properties can be defined on a series level.
  24883. */
  24884. tooltip?: SeriesTooltipOptionsObject;
  24885. /**
  24886. * (Highcharts, Highstock, Gantt) When a series contains a data array that
  24887. * is longer than this, only one dimensional arrays of numbers, or two
  24888. * dimensional arrays with x and y values are allowed. Also, only the first
  24889. * point is tested, and the rest are assumed to be the same format. This
  24890. * saves expensive data checking and indexing in long series. Set it to `0`
  24891. * disable.
  24892. *
  24893. * Note: In boost mode turbo threshold is forced. Only array of numbers or
  24894. * two dimensional arrays are allowed.
  24895. */
  24896. turboThreshold?: number;
  24897. /**
  24898. * (Highstock) Set the initial visibility of the series.
  24899. */
  24900. visible?: boolean;
  24901. /**
  24902. * (Highmaps) Define the z index of the series.
  24903. */
  24904. zIndex?: number;
  24905. /**
  24906. * (Highcharts, Highstock) Defines the Axis on which the zones are applied.
  24907. */
  24908. zoneAxis?: string;
  24909. /**
  24910. * (Highcharts, Highstock) An array defining zones within a series. Zones
  24911. * can be applied to the X axis, Y axis or Z axis for bubbles, according to
  24912. * the `zoneAxis` option. The zone definitions have to be in ascending order
  24913. * regarding to the value.
  24914. *
  24915. * In styled mode, the color zones are styled with the
  24916. * `.highcharts-zone-{n}` class, or custom classed from the `className`
  24917. * option (view live demo).
  24918. */
  24919. zones?: Array<SeriesZonesOptionsObject>;
  24920. }
  24921. /**
  24922. * (Highstock) Paramters used in calculation of regression series' points.
  24923. */
  24924. export interface PlotAtrParamsOptions {
  24925. /**
  24926. * (Highstock) The point index which indicator calculations will base. For
  24927. * example using OHLC data, index=2 means the indicator will be calculated
  24928. * using Low values.
  24929. */
  24930. index?: number;
  24931. /**
  24932. * (Highstock) The base period for indicator calculations. This is the
  24933. * number of data points which are taken into account for the indicator
  24934. * calculations.
  24935. */
  24936. period?: number;
  24937. }
  24938. /**
  24939. * (Highcharts) Enable or disable the initial animation when a series is
  24940. * displayed. The animation can also be set as a configuration object. Please
  24941. * note that this option only applies to the initial animation of the series
  24942. * itself. For other animations, see chart.animation and the animation parameter
  24943. * under the API methods. The following properties are supported:
  24944. *
  24945. * - `defer`: The animation delay time in milliseconds.
  24946. *
  24947. * - `duration`: The duration of the animation in milliseconds.
  24948. *
  24949. * - `easing`: Can be a string reference to an easing function set on the `Math`
  24950. * object or a function. See the _Custom easing function_ demo below.
  24951. *
  24952. * Due to poor performance, animation is disabled in old IE browsers for several
  24953. * chart types.
  24954. */
  24955. export interface PlotBarAnimationOptions {
  24956. defer?: number;
  24957. }
  24958. /**
  24959. * (Highcharts, Highstock, Highmaps, Gantt) Enable or disable the initial
  24960. * animation when a series is displayed for the `dataLabels`. The animation can
  24961. * also be set as a configuration object. Please note that this option only
  24962. * applies to the initial animation. For other animations, see chart.animation
  24963. * and the animation parameter under the API methods. The following properties
  24964. * are supported:
  24965. *
  24966. * - `defer`: The animation delay time in milliseconds.
  24967. */
  24968. export interface PlotBarDataLabelsAnimationOptions {
  24969. /**
  24970. * (Highcharts, Highstock, Highmaps, Gantt) The animation delay time in
  24971. * milliseconds. Set to `0` renders dataLabel immediately. As `undefined`
  24972. * inherits defer time from the series.animation.defer.
  24973. */
  24974. defer?: number;
  24975. }
  24976. /**
  24977. * (Highcharts, Highstock, Highmaps, Gantt) Options for the series data labels,
  24978. * appearing next to each data point.
  24979. *
  24980. * Since v6.2.0, multiple data labels can be applied to each single point by
  24981. * defining them as an array of configs.
  24982. *
  24983. * In styled mode, the data labels can be styled with the
  24984. * `.highcharts-data-label-box` and `.highcharts-data-label` class names (see
  24985. * example).
  24986. */
  24987. export interface PlotBarDataLabelsOptions {
  24988. /**
  24989. * (Highcharts, Highstock, Highmaps, Gantt) The alignment of the data label
  24990. * compared to the point. If `right`, the right side of the label should be
  24991. * touching the point. For points with an extent, like columns, the
  24992. * alignments also dictates how to align it inside the box, as given with
  24993. * the inside option. Can be one of `left`, `center` or `right`.
  24994. */
  24995. align?: string;
  24996. /**
  24997. * (Highcharts, Highstock, Highmaps, Gantt) Whether to allow data labels to
  24998. * overlap. To make the labels less sensitive for overlapping, the
  24999. * dataLabels.padding can be set to 0.
  25000. */
  25001. allowOverlap?: boolean;
  25002. /**
  25003. * (Highcharts, Highstock, Highmaps, Gantt) Enable or disable the initial
  25004. * animation when a series is displayed for the `dataLabels`. The animation
  25005. * can also be set as a configuration object. Please note that this option
  25006. * only applies to the initial animation. For other animations, see
  25007. * chart.animation and the animation parameter under the API methods. The
  25008. * following properties are supported:
  25009. *
  25010. * - `defer`: The animation delay time in milliseconds.
  25011. */
  25012. animation?: (boolean|PlotBarDataLabelsAnimationOptions|Partial<AnimationOptionsObject>);
  25013. /**
  25014. * (Highcharts, Highstock, Highmaps, Gantt) The background color or gradient
  25015. * for the data label.
  25016. */
  25017. backgroundColor?: (ColorString|GradientColorObject|PatternObject);
  25018. /**
  25019. * (Highcharts, Highstock, Highmaps, Gantt) The border color for the data
  25020. * label. Defaults to `undefined`.
  25021. */
  25022. borderColor?: (ColorString|GradientColorObject|PatternObject);
  25023. /**
  25024. * (Highcharts, Highstock, Highmaps, Gantt) The border radius in pixels for
  25025. * the data label.
  25026. */
  25027. borderRadius?: number;
  25028. /**
  25029. * (Highcharts, Highstock, Highmaps, Gantt) The border width in pixels for
  25030. * the data label.
  25031. */
  25032. borderWidth?: number;
  25033. /**
  25034. * (Highcharts, Highstock, Highmaps, Gantt) A class name for the data label.
  25035. * Particularly in styled mode, this can be used to give each series' or
  25036. * point's data label unique styling. In addition to this option, a default
  25037. * color class name is added so that we can give the labels a contrast text
  25038. * shadow.
  25039. */
  25040. className?: string;
  25041. /**
  25042. * (Highcharts, Highstock, Highmaps, Gantt) The text color for the data
  25043. * labels. Defaults to `undefined`. For certain series types, like column or
  25044. * map, the data labels can be drawn inside the points. In this case the
  25045. * data label will be drawn with maximum contrast by default. Additionally,
  25046. * it will be given a `text-outline` style with the opposite color, to
  25047. * further increase the contrast. This can be overridden by setting the
  25048. * `text-outline` style to `none` in the `dataLabels.style` option.
  25049. */
  25050. color?: (ColorString|GradientColorObject|PatternObject);
  25051. /**
  25052. * (Highcharts, Highstock, Highmaps, Gantt) Whether to hide data labels that
  25053. * are outside the plot area. By default, the data label is moved inside the
  25054. * plot area according to the overflow option.
  25055. */
  25056. crop?: boolean;
  25057. /**
  25058. * (Highcharts, Highstock, Gantt) Whether to defer displaying the data
  25059. * labels until the initial series animation has finished. Setting to
  25060. * `false` renders the data label immediately. If set to `true` inherits the
  25061. * defer time set in plotOptions.series.animation.
  25062. */
  25063. defer?: boolean;
  25064. /**
  25065. * (Highcharts, Highstock, Highmaps, Gantt) Enable or disable the data
  25066. * labels.
  25067. */
  25068. enabled?: boolean;
  25069. /**
  25070. * (Highcharts, Highstock, Highmaps, Gantt) A declarative filter to control
  25071. * of which data labels to display. The declarative filter is designed for
  25072. * use when callback functions are not available, like when the chart
  25073. * options require a pure JSON structure or for use with graphical editors.
  25074. * For programmatic control, use the `formatter` instead, and return
  25075. * `undefined` to disable a single data label.
  25076. */
  25077. filter?: DataLabelsFilterOptionsObject;
  25078. /**
  25079. * (Highcharts, Highstock, Highmaps, Gantt) A format string for the data
  25080. * label. Available variables are the same as for `formatter`.
  25081. */
  25082. format?: string;
  25083. /**
  25084. * (Highcharts, Highstock, Highmaps, Gantt) Callback JavaScript function to
  25085. * format the data label. Note that if a `format` is defined, the format
  25086. * takes precedence and the formatter is ignored.
  25087. */
  25088. formatter?: DataLabelsFormatterCallbackFunction;
  25089. /**
  25090. * (Highcharts, Highstock, Highmaps, Gantt) For points with an extent, like
  25091. * columns or map areas, whether to align the data label inside the box or
  25092. * to the actual value point. Defaults to `false` in most cases, `true` in
  25093. * stacked columns.
  25094. */
  25095. inside?: boolean;
  25096. /**
  25097. * (Highcharts, Highstock, Highmaps, Gantt) Format for points with the value
  25098. * of null. Works analogously to format. `nullFormat` can be applied only to
  25099. * series which support displaying null points.
  25100. */
  25101. nullFormat?: (boolean|string);
  25102. /**
  25103. * (Highcharts, Highstock, Highmaps, Gantt) Callback JavaScript function
  25104. * that defines formatting for points with the value of null. Works
  25105. * analogously to formatter. `nullPointFormatter` can be applied only to
  25106. * series which support displaying null points.
  25107. */
  25108. nullFormatter?: DataLabelsFormatterCallbackFunction;
  25109. /**
  25110. * (Highcharts, Highstock, Highmaps, Gantt) How to handle data labels that
  25111. * flow outside the plot area. The default is `"justify"`, which aligns them
  25112. * inside the plot area. For columns and bars, this means it will be moved
  25113. * inside the bar. To display data labels outside the plot area, set `crop`
  25114. * to `false` and `overflow` to `"allow"`.
  25115. */
  25116. overflow?: DataLabelsOverflowValue;
  25117. /**
  25118. * (Highcharts, Highstock, Highmaps, Gantt) When either the `borderWidth` or
  25119. * the `backgroundColor` is set, this is the padding within the box.
  25120. */
  25121. padding?: number;
  25122. /**
  25123. * (Highcharts, Highstock, Highmaps, Gantt) Aligns data labels relative to
  25124. * points. If `center` alignment is not possible, it defaults to `right`.
  25125. */
  25126. position?: AlignValue;
  25127. /**
  25128. * (Highcharts, Highstock, Highmaps, Gantt) Text rotation in degrees. Note
  25129. * that due to a more complex structure, backgrounds, borders and padding
  25130. * will be lost on a rotated data label.
  25131. */
  25132. rotation?: number;
  25133. /**
  25134. * (Highcharts, Highstock, Highmaps, Gantt) The shadow of the box. Works
  25135. * best with `borderWidth` or `backgroundColor`. Since 2.3 the shadow can be
  25136. * an object configuration containing `color`, `offsetX`, `offsetY`,
  25137. * `opacity` and `width`.
  25138. */
  25139. shadow?: (boolean|ShadowOptionsObject);
  25140. /**
  25141. * (Highcharts, Highstock, Highmaps, Gantt) The name of a symbol to use for
  25142. * the border around the label. Symbols are predefined functions on the
  25143. * Renderer object.
  25144. */
  25145. shape?: string;
  25146. /**
  25147. * (Highcharts, Highstock, Highmaps, Gantt) Styles for the label. The
  25148. * default `color` setting is `"contrast"`, which is a pseudo color that
  25149. * Highcharts picks up and applies the maximum contrast to the underlying
  25150. * point item, for example the bar in a bar chart.
  25151. *
  25152. * The `textOutline` is a pseudo property that applies an outline of the
  25153. * given width with the given color, which by default is the maximum
  25154. * contrast to the text. So a bright text color will result in a black text
  25155. * outline for maximum readability on a mixed background. In some cases,
  25156. * especially with grayscale text, the text outline doesn't work well, in
  25157. * which cases it can be disabled by setting it to `"none"`. When `useHTML`
  25158. * is true, the `textOutline` will not be picked up. In this, case, the same
  25159. * effect can be acheived through the `text-shadow` CSS property.
  25160. *
  25161. * For some series types, where each point has an extent, like for example
  25162. * tree maps, the data label may overflow the point. There are two
  25163. * strategies for handling overflow. By default, the text will wrap to
  25164. * multiple lines. The other strategy is to set `style.textOverflow` to
  25165. * `ellipsis`, which will keep the text on one line plus it will break
  25166. * inside long words.
  25167. */
  25168. style?: CSSObject;
  25169. /**
  25170. * (Highcharts, Highstock, Highmaps, Gantt) Options for a label text which
  25171. * should follow marker's shape. Border and background are disabled for a
  25172. * label that follows a path.
  25173. *
  25174. * **Note:** Only SVG-based renderer supports this option. Setting `useHTML`
  25175. * to true will disable this option.
  25176. */
  25177. textPath?: DataLabelsTextPathOptionsObject;
  25178. /**
  25179. * (Highcharts, Highstock, Highmaps, Gantt) Whether to use HTML to render
  25180. * the labels.
  25181. */
  25182. useHTML?: boolean;
  25183. /**
  25184. * (Highcharts, Highstock, Highmaps, Gantt) The vertical alignment of a data
  25185. * label. Can be one of `top`, `middle` or `bottom`. The default value
  25186. * depends on the data, for instance in a column chart, the label is above
  25187. * positive values and below negative values.
  25188. */
  25189. verticalAlign?: string;
  25190. /**
  25191. * (Highcharts, Highstock, Highmaps, Gantt) The x position offset of the
  25192. * label relative to the point in pixels.
  25193. */
  25194. x?: number;
  25195. /**
  25196. * (Highcharts, Highstock, Highmaps, Gantt) The y position offset of the
  25197. * label relative to the point in pixels.
  25198. */
  25199. y?: number;
  25200. /**
  25201. * (Highcharts, Highstock, Highmaps, Gantt) The Z index of the data labels.
  25202. * The default Z index puts it above the series. Use a Z index of 2 to
  25203. * display it behind the series.
  25204. */
  25205. z?: number;
  25206. }
  25207. /**
  25208. * (Highcharts, Highstock) Options for the series data sorting.
  25209. */
  25210. export interface PlotBarDataSortingOptions {
  25211. /**
  25212. * (Highcharts, Highstock) Enable or disable data sorting for the series.
  25213. * Use xAxis.reversed to change the sorting order.
  25214. */
  25215. enabled?: boolean;
  25216. /**
  25217. * (Highcharts, Highstock) Whether to allow matching points by name in an
  25218. * update. If this option is disabled, points will be matched by order.
  25219. */
  25220. matchByName?: boolean;
  25221. /**
  25222. * (Highcharts, Highstock) Determines what data value should be used to sort
  25223. * by.
  25224. */
  25225. sortKey?: string;
  25226. }
  25227. /**
  25228. * (Highcharts) Style options for the guide box. The guide box has one state by
  25229. * default, the `default` state.
  25230. */
  25231. export interface PlotBarDragDropGuideBoxOptions {
  25232. /**
  25233. * (Highcharts) Style options for the guide box default state.
  25234. */
  25235. default?: DragDropGuideBoxOptionsObject;
  25236. }
  25237. /**
  25238. * (Highcharts) A bar series is a special type of column series where the
  25239. * columns are horizontal.
  25240. *
  25241. * In TypeScript the type option must always be set.
  25242. *
  25243. * Configuration options for the series are given in three levels:
  25244. *
  25245. * 1. Options for all series in a chart are defined in the plotOptions.series
  25246. * object.
  25247. *
  25248. * 2. Options for all `bar` series are defined in plotOptions.bar.
  25249. *
  25250. * 3. Options for one single series are given in the series instance array. (see
  25251. * online documentation for example)
  25252. */
  25253. export interface PlotBarOptions {
  25254. /**
  25255. * (Highcharts) Accessibility options for a series.
  25256. */
  25257. accessibility?: SeriesAccessibilityOptionsObject;
  25258. /**
  25259. * (Highmaps) Whether all areas of the map defined in `mapData` should be
  25260. * rendered. If `true`, areas which don't correspond to a data point, are
  25261. * rendered as `null` points. If `false`, those areas are skipped.
  25262. */
  25263. allAreas?: boolean;
  25264. /**
  25265. * (Highcharts) Allow this series' points to be selected by clicking on the
  25266. * graphic (columns, point markers, pie slices, map areas etc).
  25267. *
  25268. * The selected points can be handled by point select and unselect events,
  25269. * or collectively by the getSelectedPoints function.
  25270. *
  25271. * And alternative way of selecting points is through dragging.
  25272. */
  25273. allowPointSelect?: boolean;
  25274. /**
  25275. * (Highcharts) Enable or disable the initial animation when a series is
  25276. * displayed. The animation can also be set as a configuration object.
  25277. * Please note that this option only applies to the initial animation of the
  25278. * series itself. For other animations, see chart.animation and the
  25279. * animation parameter under the API methods. The following properties are
  25280. * supported:
  25281. *
  25282. * - `defer`: The animation delay time in milliseconds.
  25283. *
  25284. * - `duration`: The duration of the animation in milliseconds.
  25285. *
  25286. * - `easing`: Can be a string reference to an easing function set on the
  25287. * `Math` object or a function. See the _Custom easing function_ demo below.
  25288. *
  25289. * Due to poor performance, animation is disabled in old IE browsers for
  25290. * several chart types.
  25291. */
  25292. animation?: (boolean|PlotBarAnimationOptions|Partial<AnimationOptionsObject>);
  25293. /**
  25294. * (Highcharts) For some series, there is a limit that shuts down initial
  25295. * animation by default when the total number of points in the chart is too
  25296. * high. For example, for a column chart and its derivatives, animation does
  25297. * not run if there is more than 250 points totally. To disable this cap,
  25298. * set `animationLimit` to `Infinity`.
  25299. */
  25300. animationLimit?: number;
  25301. /**
  25302. * (Highcharts) Sets the color blending in the boost module.
  25303. */
  25304. boostBlending?: OptionsBoostBlendingValue;
  25305. /**
  25306. * (Highcharts) Set the point threshold for when a series should enter boost
  25307. * mode.
  25308. *
  25309. * Setting it to e.g. 2000 will cause the series to enter boost mode when
  25310. * there are 2000 or more points in the series.
  25311. *
  25312. * To disable boosting on the series, set the `boostThreshold` to 0. Setting
  25313. * it to 1 will force boosting.
  25314. *
  25315. * Note that the cropThreshold also affects this setting. When zooming in on
  25316. * a series that has fewer points than the `cropThreshold`, all points are
  25317. * rendered although outside the visible plot area, and the `boostThreshold`
  25318. * won't take effect.
  25319. */
  25320. boostThreshold?: number;
  25321. /**
  25322. * (Highcharts, Highstock, Gantt) The color of the border surrounding each
  25323. * column or bar.
  25324. *
  25325. * In styled mode, the border stroke can be set with the `.highcharts-point`
  25326. * rule.
  25327. */
  25328. borderColor?: (ColorString|GradientColorObject|PatternObject);
  25329. /**
  25330. * (Highcharts, Highstock, Gantt) The corner radius of the border
  25331. * surrounding each column or bar.
  25332. */
  25333. borderRadius?: number;
  25334. /**
  25335. * (Highcharts, Highstock, Gantt) The width of the border surrounding each
  25336. * column or bar. Defaults to `1` when there is room for a border, but to
  25337. * `0` when the columns are so dense that a border would cover the next
  25338. * column.
  25339. *
  25340. * In styled mode, the stroke width can be set with the `.highcharts-point`
  25341. * rule.
  25342. */
  25343. borderWidth?: number;
  25344. /**
  25345. * (Highcharts, Highstock, Gantt) When `true`, the columns will center in
  25346. * the category, ignoring null or missing points. When `false`, space will
  25347. * be reserved for null or missing points.
  25348. */
  25349. centerInCategory?: boolean;
  25350. /**
  25351. * (Highcharts) An additional class name to apply to the series' graphical
  25352. * elements. This option does not replace default class names of the
  25353. * graphical element.
  25354. */
  25355. className?: string;
  25356. /**
  25357. * (Highcharts) Disable this option to allow series rendering in the whole
  25358. * plotting area.
  25359. *
  25360. * **Note:** Clipping should be always enabled when chart.zoomType is set
  25361. */
  25362. clip?: boolean;
  25363. /**
  25364. * (Highcharts) The main color of the series. In line type series it applies
  25365. * to the line and the point markers unless otherwise specified. In bar type
  25366. * series it applies to the bars unless a color is specified per point. The
  25367. * default value is pulled from the `options.colors` array.
  25368. *
  25369. * In styled mode, the color can be defined by the colorIndex option. Also,
  25370. * the series color can be set with the `.highcharts-series`,
  25371. * `.highcharts-color-{n}`, `.highcharts-{type}-series` or
  25372. * `.highcharts-series-{n}` class, or individual classes given by the
  25373. * `className` option.
  25374. */
  25375. color?: (ColorString|GradientColorObject|PatternObject);
  25376. /**
  25377. * (Highcharts, Highstock, Highmaps) When using dual or multiple color axes,
  25378. * this number defines which colorAxis the particular series is connected
  25379. * to. It refers to either the axis id or the index of the axis in the
  25380. * colorAxis array, with 0 being the first. Set this option to false to
  25381. * prevent a series from connecting to the default color axis.
  25382. *
  25383. * Since v7.2.0 the option can also be an axis id or an axis index instead
  25384. * of a boolean flag.
  25385. */
  25386. colorAxis?: (boolean|number|string);
  25387. /**
  25388. * (Highcharts, Highstock, Gantt) When using automatic point colors pulled
  25389. * from the global colors or series-specific plotOptions.column.colors
  25390. * collections, this option determines whether the chart should receive one
  25391. * color per series or one color per point.
  25392. *
  25393. * In styled mode, the `colors` or `series.colors` arrays are not supported,
  25394. * and instead this option gives the points individual color class names on
  25395. * the form `highcharts-color-{n}`.
  25396. */
  25397. colorByPoint?: boolean;
  25398. /**
  25399. * (Highcharts) Styled mode only. A specific color index to use for the
  25400. * series, so its graphic representations are given the class name
  25401. * `highcharts-color-{n}`.
  25402. */
  25403. colorIndex?: number;
  25404. /**
  25405. * (Highcharts, Highstock, Highmaps) Determines what data value should be
  25406. * used to calculate point color if `colorAxis` is used. Requires to set
  25407. * `min` and `max` if some custom point property is used or if approximation
  25408. * for data grouping is set to `'sum'`.
  25409. */
  25410. colorKey?: string;
  25411. /**
  25412. * (Highcharts, Highstock, Gantt) A series specific or series type specific
  25413. * color set to apply instead of the global colors when colorByPoint is
  25414. * true.
  25415. */
  25416. colors?: Array<(ColorString|GradientColorObject|PatternObject)>;
  25417. /**
  25418. * (Highstock) Compare the values of the series against the first non-null,
  25419. * non- zero value in the visible range. The y axis will show percentage or
  25420. * absolute change depending on whether `compare` is set to `"percent"` or
  25421. * `"value"`. When this is applied to multiple series, it allows comparing
  25422. * the development of the series against each other. Adds a `change` field
  25423. * to every point object.
  25424. */
  25425. compare?: string;
  25426. /**
  25427. * (Highstock) When compare is `percent`, this option dictates whether to
  25428. * use 0 or 100 as the base of comparison.
  25429. */
  25430. compareBase?: (0|100);
  25431. /**
  25432. * (Highstock) Defines if comparison should start from the first point
  25433. * within the visible range or should start from the first point **before**
  25434. * the range.
  25435. *
  25436. * In other words, this flag determines if first point within the visible
  25437. * range will have 0% (`compareStart=true`) or should have been already
  25438. * calculated according to the previous point (`compareStart=false`).
  25439. */
  25440. compareStart?: boolean;
  25441. /**
  25442. * (Gantt) Override Pathfinder connector options for a series. Requires
  25443. * Highcharts Gantt to be loaded.
  25444. */
  25445. connectors?: SeriesConnectorsOptionsObject;
  25446. /**
  25447. * (Highcharts, Highstock, Gantt) When true, each point or column edge is
  25448. * rounded to its nearest pixel in order to render sharp on screen. In some
  25449. * cases, when there are a lot of densely packed columns, this leads to
  25450. * visible difference in column widths or distance between columns. In these
  25451. * cases, setting `crisp` to `false` may look better, even though each
  25452. * column is rendered blurry.
  25453. */
  25454. crisp?: boolean;
  25455. /**
  25456. * (Highcharts, Highstock, Gantt) When the series contains less points than
  25457. * the crop threshold, all points are drawn, event if the points fall
  25458. * outside the visible plot area at the current zoom. The advantage of
  25459. * drawing all points (including markers and columns), is that animation is
  25460. * performed on updates. On the other hand, when the series contains more
  25461. * points than the crop threshold, the series data is cropped to only
  25462. * contain points that fall within the plot area. The advantage of cropping
  25463. * away invisible points is to increase performance on large series.
  25464. */
  25465. cropThreshold?: number;
  25466. /**
  25467. * (Highcharts) You can set the cursor to "pointer" if you have click events
  25468. * attached to the series, to signal to the user that the points and lines
  25469. * can be clicked.
  25470. *
  25471. * In styled mode, the series cursor can be set with the same classes as
  25472. * listed under series.color.
  25473. */
  25474. cursor?: (string|CursorValue);
  25475. /**
  25476. * (Highcharts) A reserved subspace to store options and values for
  25477. * customized functionality. Here you can add additional data for your own
  25478. * event callbacks and formatter callbacks.
  25479. */
  25480. custom?: Dictionary<any>;
  25481. /**
  25482. * (Highcharts) Name of the dash style to use for the graph, or for some
  25483. * series types the outline of each shape.
  25484. *
  25485. * In styled mode, the stroke dash-array can be set with the same classes as
  25486. * listed under series.color.
  25487. */
  25488. dashStyle?: DashStyleValue;
  25489. /**
  25490. * (Highstock) Data grouping is the concept of sampling the data values into
  25491. * larger blocks in order to ease readability and increase performance of
  25492. * the JavaScript charts. Highstock by default applies data grouping when
  25493. * the points become closer than a certain pixel value, determined by the
  25494. * `groupPixelWidth` option.
  25495. *
  25496. * If data grouping is applied, the grouping information of grouped points
  25497. * can be read from the Point.dataGroup. If point options other than the
  25498. * data itself are set, for example `name` or `color` or custom properties,
  25499. * the grouping logic doesn't know how to group it. In this case the options
  25500. * of the first point instance are copied over to the group point. This can
  25501. * be altered through a custom `approximation` callback function.
  25502. */
  25503. dataGrouping?: DataGroupingOptionsObject;
  25504. /**
  25505. * (Highcharts, Highstock, Highmaps, Gantt) Options for the series data
  25506. * labels, appearing next to each data point.
  25507. *
  25508. * Since v6.2.0, multiple data labels can be applied to each single point by
  25509. * defining them as an array of configs.
  25510. *
  25511. * In styled mode, the data labels can be styled with the
  25512. * `.highcharts-data-label-box` and `.highcharts-data-label` class names
  25513. * (see example).
  25514. */
  25515. dataLabels?: (PlotBarDataLabelsOptions|Array<PlotBarDataLabelsOptions>);
  25516. /**
  25517. * (Highcharts, Highstock) Options for the series data sorting.
  25518. */
  25519. dataSorting?: (DataSortingOptionsObject|PlotBarDataSortingOptions);
  25520. /**
  25521. * (Highcharts) Depth of the columns in a 3D column chart.
  25522. */
  25523. depth?: number;
  25524. /**
  25525. * (Highcharts) A description of the series to add to the screen reader
  25526. * information about the series.
  25527. */
  25528. description?: string;
  25529. /**
  25530. * (Highcharts) The draggable-points module allows points to be moved around
  25531. * or modified in the chart. In addition to the options mentioned under the
  25532. * `dragDrop` API structure, the module fires three events, point.dragStart,
  25533. * point.drag and point.drop.
  25534. */
  25535. dragDrop?: SeriesDragDropOptionsObject;
  25536. /**
  25537. * (Highcharts) 3D columns only. The color of the edges. Similar to
  25538. * `borderColor`, except it defaults to the same color as the column.
  25539. */
  25540. edgeColor?: ColorString;
  25541. /**
  25542. * (Highcharts) 3D columns only. The width of the colored edges.
  25543. */
  25544. edgeWidth?: number;
  25545. /**
  25546. * (Highcharts) Enable or disable the mouse tracking for a specific series.
  25547. * This includes point tooltips and click events on graphs and points. For
  25548. * large datasets it improves performance.
  25549. */
  25550. enableMouseTracking?: boolean;
  25551. /**
  25552. * (Highcharts) General event handlers for the series items. These event
  25553. * hooks can also be attached to the series at run time using the
  25554. * `Highcharts.addEvent` function.
  25555. */
  25556. events?: SeriesEventsOptionsObject;
  25557. /**
  25558. * (Highcharts) Determines whether the series should look for the nearest
  25559. * point in both dimensions or just the x-dimension when hovering the
  25560. * series. Defaults to `'xy'` for scatter series and `'x'` for most other
  25561. * series. If the data has duplicate x-values, it is recommended to set this
  25562. * to `'xy'` to allow hovering over all points.
  25563. *
  25564. * Applies only to series types using nearest neighbor search (not direct
  25565. * hover) for tooltip.
  25566. */
  25567. findNearestPointBy?: OptionsFindNearestPointByValue;
  25568. /**
  25569. * (Highcharts, Highstock, Gantt) Whether to use the Y extremes of the total
  25570. * chart width or only the zoomed area when zooming in on parts of the X
  25571. * axis. By default, the Y axis adjusts to the min and max of the visible
  25572. * data. Cartesian series only.
  25573. */
  25574. getExtremesFromAll?: boolean;
  25575. /**
  25576. * (Highcharts, Highstock, Gantt) Whether to group non-stacked columns or to
  25577. * let them render independent of each other. Non-grouped columns will be
  25578. * laid out individually and overlap each other.
  25579. */
  25580. grouping?: boolean;
  25581. /**
  25582. * (Highcharts, Highstock, Gantt) Padding between each value groups, in x
  25583. * axis units.
  25584. */
  25585. groupPadding?: number;
  25586. /**
  25587. * (Highcharts) The spacing between columns on the Z Axis in a 3D chart.
  25588. */
  25589. groupZPadding?: number;
  25590. /**
  25591. * (Highcharts) When set to `false` will prevent the series data from being
  25592. * included in any form of data export.
  25593. *
  25594. * Since version 6.0.0 until 7.1.0 the option was existing undocumented as
  25595. * `includeInCSVExport`.
  25596. */
  25597. includeInDataExport?: boolean;
  25598. /**
  25599. * (Highmaps) What property to join the `mapData` to the value data. For
  25600. * example, if joinBy is "code", the mapData items with a specific code is
  25601. * merged into the data with the same code. For maps loaded from GeoJSON,
  25602. * the keys may be held in each point's `properties` object.
  25603. *
  25604. * The joinBy option can also be an array of two values, where the first
  25605. * points to a key in the `mapData`, and the second points to another key in
  25606. * the `data`.
  25607. *
  25608. * When joinBy is `null`, the map items are joined by their position in the
  25609. * array, which performs much better in maps with many data points. This is
  25610. * the recommended option if you are printing more than a thousand data
  25611. * points and have a backend that can preprocess the data into a parallel
  25612. * array of the mapData.
  25613. */
  25614. joinBy?: (string|Array<string>);
  25615. /**
  25616. * (Highcharts) An array specifying which option maps to which key in the
  25617. * data point array. This makes it convenient to work with unstructured data
  25618. * arrays from different sources.
  25619. */
  25620. keys?: Array<string>;
  25621. /**
  25622. * (Highcharts, Highstock, Gantt) Series labels are placed as close to the
  25623. * series as possible in a natural way, seeking to avoid other series. The
  25624. * goal of this feature is to make the chart more easily readable, like if a
  25625. * human designer placed the labels in the optimal position.
  25626. *
  25627. * The series labels currently work with series types having a `graph` or an
  25628. * `area`.
  25629. */
  25630. label?: SeriesLabelOptionsObject;
  25631. /**
  25632. * (Highstock) The line marks the last price from all points.
  25633. */
  25634. lastPrice?: SeriesLastPriceOptionsObject;
  25635. /**
  25636. * (Highstock) The line marks the last price from visible range of points.
  25637. */
  25638. lastVisiblePrice?: SeriesLastVisiblePriceOptionsObject;
  25639. /**
  25640. * (Highcharts, Highstock, Gantt) The id of another series to link to.
  25641. * Additionally, the value can be ":previous" to link to the previous
  25642. * series. When two series are linked, only the first one appears in the
  25643. * legend. Toggling the visibility of this also toggles the linked series.
  25644. *
  25645. * If master series uses data sorting and linked series does not have its
  25646. * own sorting definition, the linked series will be sorted in the same
  25647. * order as the master one.
  25648. */
  25649. linkedTo?: string;
  25650. /**
  25651. * (Highcharts, Highstock, Gantt) The maximum allowed pixel width for a
  25652. * column, translated to the height of a bar in a bar chart. This prevents
  25653. * the columns from becoming too wide when there is a small number of points
  25654. * in the chart.
  25655. */
  25656. maxPointWidth?: number;
  25657. /**
  25658. * (Highcharts, Highstock, Gantt) The minimal height for a column or width
  25659. * for a bar. By default, 0 values are not shown. To visualize a 0 (or close
  25660. * to zero) point, set the minimal point length to a pixel value like 3\. In
  25661. * stacked column charts, minPointLength might not be respected for tightly
  25662. * packed values.
  25663. */
  25664. minPointLength?: number;
  25665. /**
  25666. * (Highstock) Options for the corresponding navigator series if
  25667. * `showInNavigator` is `true` for this series. Available options are the
  25668. * same as any series, documented at plotOptions and series.
  25669. *
  25670. * These options are merged with options in navigator.series, and will take
  25671. * precedence if the same option is defined both places.
  25672. */
  25673. navigatorOptions?: PlotSeriesOptions;
  25674. /**
  25675. * (Highcharts) The color for the parts of the graph or points that are
  25676. * below the threshold. Note that `zones` takes precedence over the negative
  25677. * color. Using `negativeColor` is equivalent to applying a zone with value
  25678. * of 0.
  25679. */
  25680. negativeColor?: (ColorString|GradientColorObject|PatternObject);
  25681. /**
  25682. * (Highcharts) Opacity of a series parts: line, fill (e.g. area) and
  25683. * dataLabels.
  25684. */
  25685. opacity?: number;
  25686. /**
  25687. * (Highcharts) Properties for each single point.
  25688. */
  25689. point?: PlotSeriesPointOptions;
  25690. /**
  25691. * (Highcharts) Same as accessibility.pointDescriptionFormatter, but for an
  25692. * individual series. Overrides the chart wide configuration.
  25693. */
  25694. pointDescriptionFormatter?: Function;
  25695. /**
  25696. * (Highcharts, Highstock, Gantt) If no x values are given for the points in
  25697. * a series, `pointInterval` defines the interval of the x values. For
  25698. * example, if a series contains one value every decade starting from year
  25699. * 0, set `pointInterval` to `10`. In true `datetime` axes, the
  25700. * `pointInterval` is set in milliseconds.
  25701. *
  25702. * It can be also be combined with `pointIntervalUnit` to draw irregular
  25703. * time intervals.
  25704. *
  25705. * Please note that this options applies to the _series data_, not the
  25706. * interval of the axis ticks, which is independent.
  25707. */
  25708. pointInterval?: number;
  25709. /**
  25710. * (Highcharts, Highstock, Gantt) On datetime series, this allows for
  25711. * setting the pointInterval to irregular time units, `day`, `month` and
  25712. * `year`. A day is usually the same as 24 hours, but `pointIntervalUnit`
  25713. * also takes the DST crossover into consideration when dealing with local
  25714. * time. Combine this option with `pointInterval` to draw weeks, quarters, 6
  25715. * months, 10 years etc.
  25716. *
  25717. * Please note that this options applies to the _series data_, not the
  25718. * interval of the axis ticks, which is independent.
  25719. */
  25720. pointIntervalUnit?: OptionsPointIntervalUnitValue;
  25721. /**
  25722. * (Highcharts, Highstock, Gantt) Padding between each column or bar, in x
  25723. * axis units.
  25724. */
  25725. pointPadding?: number;
  25726. /**
  25727. * (Highcharts, Highstock, Gantt) Possible values: `"on"`, `"between"`,
  25728. * `number`.
  25729. *
  25730. * In a column chart, when pointPlacement is `"on"`, the point will not
  25731. * create any padding of the X axis. In a polar column chart this means that
  25732. * the first column points directly north. If the pointPlacement is
  25733. * `"between"`, the columns will be laid out between ticks. This is useful
  25734. * for example for visualising an amount between two points in time or in a
  25735. * certain sector of a polar chart.
  25736. *
  25737. * Since Highcharts 3.0.2, the point placement can also be numeric, where 0
  25738. * is on the axis value, -0.5 is between this value and the previous, and
  25739. * 0.5 is between this value and the next. Unlike the textual options,
  25740. * numeric point placement options won't affect axis padding.
  25741. *
  25742. * Note that pointPlacement needs a pointRange to work. For column series
  25743. * this is computed, but for line-type series it needs to be set.
  25744. *
  25745. * For the `xrange` series type and gantt charts, if the Y axis is a
  25746. * category axis, the `pointPlacement` applies to the Y axis rather than the
  25747. * (typically datetime) X axis.
  25748. *
  25749. * Defaults to `undefined` in cartesian charts, `"between"` in polar charts.
  25750. */
  25751. pointPlacement?: (number|string);
  25752. /**
  25753. * (Highcharts, Highstock, Gantt) The X axis range that each point is valid
  25754. * for. This determines the width of the column. On a categorized axis, the
  25755. * range will be 1 by default (one category unit). On linear and datetime
  25756. * axes, the range will be computed as the distance between the two closest
  25757. * data points.
  25758. *
  25759. * The default `null` means it is computed automatically, but this option
  25760. * can be used to override the automatic value.
  25761. *
  25762. * This option is set by default to 1 if data sorting is enabled.
  25763. */
  25764. pointRange?: (number|null);
  25765. /**
  25766. * (Highcharts, Highstock, Gantt) If no x values are given for the points in
  25767. * a series, pointStart defines on what value to start. For example, if a
  25768. * series contains one yearly value starting from 1945, set pointStart to
  25769. * 1945.
  25770. */
  25771. pointStart?: number;
  25772. /**
  25773. * (Highcharts, Highstock, Gantt) A pixel value specifying a fixed width for
  25774. * each column or bar point. When set to `undefined`, the width is
  25775. * calculated from the `pointPadding` and `groupPadding`. The width effects
  25776. * the dimension that is not based on the point value. For column series it
  25777. * is the hoizontal length and for bar series it is the vertical length.
  25778. */
  25779. pointWidth?: number;
  25780. /**
  25781. * (Highcharts) Whether to select the series initially. If `showCheckbox` is
  25782. * true, the checkbox next to the series name in the legend will be checked
  25783. * for a selected series.
  25784. */
  25785. selected?: boolean;
  25786. /**
  25787. * (Highcharts) Whether to apply a drop shadow to the graph line. Since 2.3
  25788. * the shadow can be an object configuration containing `color`, `offsetX`,
  25789. * `offsetY`, `opacity` and `width`.
  25790. */
  25791. shadow?: (boolean|ShadowOptionsObject);
  25792. /**
  25793. * (Highcharts) If true, a checkbox is displayed next to the legend item to
  25794. * allow selecting the series. The state of the checkbox is determined by
  25795. * the `selected` option.
  25796. */
  25797. showCheckbox?: boolean;
  25798. /**
  25799. * (Highcharts) Whether to display this particular series or series type in
  25800. * the legend. Standalone series are shown in legend by default, and linked
  25801. * series are not. Since v7.2.0 it is possible to show series that use
  25802. * colorAxis by setting this option to `true`.
  25803. */
  25804. showInLegend?: boolean;
  25805. /**
  25806. * (Highstock) Whether or not to show the series in the navigator. Takes
  25807. * precedence over navigator.baseSeries if defined.
  25808. */
  25809. showInNavigator?: boolean;
  25810. /**
  25811. * (Highcharts) If set to `true`, the accessibility module will skip past
  25812. * the points in this series for keyboard navigation.
  25813. */
  25814. skipKeyboardNavigation?: boolean;
  25815. /**
  25816. * (Highcharts, Highstock) When this is true, the series will not cause the
  25817. * Y axis to cross the zero plane (or threshold option) unless the data
  25818. * actually crosses the plane.
  25819. *
  25820. * For example, if `softThreshold` is `false`, a series of 0, 1, 2, 3 will
  25821. * make the Y axis show negative values according to the `minPadding`
  25822. * option. If `softThreshold` is `true`, the Y axis starts at 0.
  25823. */
  25824. softThreshold?: boolean;
  25825. /**
  25826. * (Highcharts, Highstock) Whether to stack the values of each series on top
  25827. * of each other. Possible values are `undefined` to disable, `"normal"` to
  25828. * stack by value or `"percent"`.
  25829. *
  25830. * When stacking is enabled, data must be sorted in ascending X order.
  25831. *
  25832. * Some stacking options are related to specific series types. In the
  25833. * streamgraph series type, the stacking option is set to `"stream"`. The
  25834. * second one is `"overlap"`, which only applies to waterfall series.
  25835. */
  25836. stacking?: OptionsStackingValue;
  25837. states?: SeriesStatesOptionsObject;
  25838. /**
  25839. * (Highcharts) Sticky tracking of mouse events. When true, the `mouseOut`
  25840. * event on a series isn't triggered until the mouse moves over another
  25841. * series, or out of the plot area. When false, the `mouseOut` event on a
  25842. * series is triggered when the mouse leaves the area around the series'
  25843. * graph or markers. This also implies the tooltip when not shared. When
  25844. * `stickyTracking` is false and `tooltip.shared` is false, the tooltip will
  25845. * be hidden when moving the mouse between series. Defaults to true for line
  25846. * and area type series, but to false for columns, pies etc.
  25847. *
  25848. * **Note:** The boost module will force this option because of technical
  25849. * limitations.
  25850. */
  25851. stickyTracking?: boolean;
  25852. /**
  25853. * (Highcharts) The Y axis value to serve as the base for the columns, for
  25854. * distinguishing between values above and below a threshold. If `null`, the
  25855. * columns extend from the padding Y axis minimum.
  25856. */
  25857. threshold?: (number|null);
  25858. /**
  25859. * (Highcharts) A configuration object for the tooltip rendering of each
  25860. * single series. Properties are inherited from tooltip, but only the
  25861. * following properties can be defined on a series level.
  25862. */
  25863. tooltip?: SeriesTooltipOptionsObject;
  25864. /**
  25865. * (Highcharts, Highstock, Gantt) When a series contains a data array that
  25866. * is longer than this, only one dimensional arrays of numbers, or two
  25867. * dimensional arrays with x and y values are allowed. Also, only the first
  25868. * point is tested, and the rest are assumed to be the same format. This
  25869. * saves expensive data checking and indexing in long series. Set it to `0`
  25870. * disable.
  25871. *
  25872. * Note: In boost mode turbo threshold is forced. Only array of numbers or
  25873. * two dimensional arrays are allowed.
  25874. */
  25875. turboThreshold?: number;
  25876. /**
  25877. * (Highcharts) Set the initial visibility of the series.
  25878. */
  25879. visible?: boolean;
  25880. /**
  25881. * (Highmaps) Define the z index of the series.
  25882. */
  25883. zIndex?: number;
  25884. /**
  25885. * (Highcharts, Highstock) Defines the Axis on which the zones are applied.
  25886. */
  25887. zoneAxis?: string;
  25888. /**
  25889. * (Highcharts, Highstock) An array defining zones within a series. Zones
  25890. * can be applied to the X axis, Y axis or Z axis for bubbles, according to
  25891. * the `zoneAxis` option. The zone definitions have to be in ascending order
  25892. * regarding to the value.
  25893. *
  25894. * In styled mode, the color zones are styled with the
  25895. * `.highcharts-zone-{n}` class, or custom classed from the `className`
  25896. * option (view live demo).
  25897. */
  25898. zones?: Array<SeriesZonesOptionsObject>;
  25899. }
  25900. /**
  25901. * (Highstock) Enable or disable the initial animation when a series is
  25902. * displayed. The animation can also be set as a configuration object. Please
  25903. * note that this option only applies to the initial animation of the series
  25904. * itself. For other animations, see chart.animation and the animation parameter
  25905. * under the API methods. The following properties are supported:
  25906. *
  25907. * - `defer`: The animation delay time in milliseconds.
  25908. *
  25909. * - `duration`: The duration of the animation in milliseconds.
  25910. *
  25911. * - `easing`: Can be a string reference to an easing function set on the `Math`
  25912. * object or a function. See the _Custom easing function_ demo below.
  25913. *
  25914. * Due to poor performance, animation is disabled in old IE browsers for several
  25915. * chart types.
  25916. */
  25917. export interface PlotBbAnimationOptions {
  25918. defer?: number;
  25919. }
  25920. /**
  25921. * (Highstock) Bottom line options.
  25922. */
  25923. export interface PlotBbBottomLineOptions {
  25924. /**
  25925. * (Highstock) Styles for a bottom line.
  25926. */
  25927. styles?: PlotBbBottomLineStylesOptions;
  25928. }
  25929. /**
  25930. * (Highstock) Styles for a bottom line.
  25931. */
  25932. export interface PlotBbBottomLineStylesOptions {
  25933. /**
  25934. * (Highstock) Color of the line. If not set, it's inherited from
  25935. * plotOptions.bb.color.
  25936. */
  25937. lineColor?: ColorString;
  25938. /**
  25939. * (Highstock) Pixel width of the line.
  25940. */
  25941. lineWidth?: number;
  25942. }
  25943. /**
  25944. * (Highcharts, Highstock, Highmaps, Gantt) Enable or disable the initial
  25945. * animation when a series is displayed for the `dataLabels`. The animation can
  25946. * also be set as a configuration object. Please note that this option only
  25947. * applies to the initial animation. For other animations, see chart.animation
  25948. * and the animation parameter under the API methods. The following properties
  25949. * are supported:
  25950. *
  25951. * - `defer`: The animation delay time in milliseconds.
  25952. */
  25953. export interface PlotBbDataLabelsAnimationOptions {
  25954. /**
  25955. * (Highcharts, Highstock, Highmaps, Gantt) The animation delay time in
  25956. * milliseconds. Set to `0` renders dataLabel immediately. As `undefined`
  25957. * inherits defer time from the series.animation.defer.
  25958. */
  25959. defer?: number;
  25960. }
  25961. /**
  25962. * (Highcharts, Highstock, Highmaps, Gantt) Options for the series data labels,
  25963. * appearing next to each data point.
  25964. *
  25965. * Since v6.2.0, multiple data labels can be applied to each single point by
  25966. * defining them as an array of configs.
  25967. *
  25968. * In styled mode, the data labels can be styled with the
  25969. * `.highcharts-data-label-box` and `.highcharts-data-label` class names (see
  25970. * example).
  25971. */
  25972. export interface PlotBbDataLabelsOptions {
  25973. /**
  25974. * (Highcharts, Highstock, Highmaps, Gantt) The alignment of the data label
  25975. * compared to the point. If `right`, the right side of the label should be
  25976. * touching the point. For points with an extent, like columns, the
  25977. * alignments also dictates how to align it inside the box, as given with
  25978. * the inside option. Can be one of `left`, `center` or `right`.
  25979. */
  25980. align?: (AlignValue|null);
  25981. /**
  25982. * (Highcharts, Highstock, Highmaps, Gantt) Whether to allow data labels to
  25983. * overlap. To make the labels less sensitive for overlapping, the
  25984. * dataLabels.padding can be set to 0.
  25985. */
  25986. allowOverlap?: boolean;
  25987. /**
  25988. * (Highcharts, Highstock, Highmaps, Gantt) Enable or disable the initial
  25989. * animation when a series is displayed for the `dataLabels`. The animation
  25990. * can also be set as a configuration object. Please note that this option
  25991. * only applies to the initial animation. For other animations, see
  25992. * chart.animation and the animation parameter under the API methods. The
  25993. * following properties are supported:
  25994. *
  25995. * - `defer`: The animation delay time in milliseconds.
  25996. */
  25997. animation?: (boolean|PlotBbDataLabelsAnimationOptions|Partial<AnimationOptionsObject>);
  25998. /**
  25999. * (Highcharts, Highstock, Highmaps, Gantt) The background color or gradient
  26000. * for the data label.
  26001. */
  26002. backgroundColor?: (ColorString|GradientColorObject|PatternObject);
  26003. /**
  26004. * (Highcharts, Highstock, Highmaps, Gantt) The border color for the data
  26005. * label. Defaults to `undefined`.
  26006. */
  26007. borderColor?: (ColorString|GradientColorObject|PatternObject);
  26008. /**
  26009. * (Highcharts, Highstock, Highmaps, Gantt) The border radius in pixels for
  26010. * the data label.
  26011. */
  26012. borderRadius?: number;
  26013. /**
  26014. * (Highcharts, Highstock, Highmaps, Gantt) The border width in pixels for
  26015. * the data label.
  26016. */
  26017. borderWidth?: number;
  26018. /**
  26019. * (Highcharts, Highstock, Highmaps, Gantt) A class name for the data label.
  26020. * Particularly in styled mode, this can be used to give each series' or
  26021. * point's data label unique styling. In addition to this option, a default
  26022. * color class name is added so that we can give the labels a contrast text
  26023. * shadow.
  26024. */
  26025. className?: string;
  26026. /**
  26027. * (Highcharts, Highstock, Highmaps, Gantt) The text color for the data
  26028. * labels. Defaults to `undefined`. For certain series types, like column or
  26029. * map, the data labels can be drawn inside the points. In this case the
  26030. * data label will be drawn with maximum contrast by default. Additionally,
  26031. * it will be given a `text-outline` style with the opposite color, to
  26032. * further increase the contrast. This can be overridden by setting the
  26033. * `text-outline` style to `none` in the `dataLabels.style` option.
  26034. */
  26035. color?: (ColorString|GradientColorObject|PatternObject);
  26036. /**
  26037. * (Highcharts, Highstock, Highmaps, Gantt) Whether to hide data labels that
  26038. * are outside the plot area. By default, the data label is moved inside the
  26039. * plot area according to the overflow option.
  26040. */
  26041. crop?: boolean;
  26042. /**
  26043. * (Highcharts, Highstock, Gantt) Whether to defer displaying the data
  26044. * labels until the initial series animation has finished. Setting to
  26045. * `false` renders the data label immediately. If set to `true` inherits the
  26046. * defer time set in plotOptions.series.animation.
  26047. */
  26048. defer?: boolean;
  26049. /**
  26050. * (Highcharts, Highstock, Highmaps, Gantt) Enable or disable the data
  26051. * labels.
  26052. */
  26053. enabled?: boolean;
  26054. /**
  26055. * (Highcharts, Highstock, Highmaps, Gantt) A declarative filter to control
  26056. * of which data labels to display. The declarative filter is designed for
  26057. * use when callback functions are not available, like when the chart
  26058. * options require a pure JSON structure or for use with graphical editors.
  26059. * For programmatic control, use the `formatter` instead, and return
  26060. * `undefined` to disable a single data label.
  26061. */
  26062. filter?: DataLabelsFilterOptionsObject;
  26063. /**
  26064. * (Highcharts, Highstock, Highmaps, Gantt) A format string for the data
  26065. * label. Available variables are the same as for `formatter`.
  26066. */
  26067. format?: string;
  26068. /**
  26069. * (Highcharts, Highstock, Highmaps, Gantt) Callback JavaScript function to
  26070. * format the data label. Note that if a `format` is defined, the format
  26071. * takes precedence and the formatter is ignored.
  26072. */
  26073. formatter?: DataLabelsFormatterCallbackFunction;
  26074. /**
  26075. * (Highcharts, Highstock, Highmaps, Gantt) For points with an extent, like
  26076. * columns or map areas, whether to align the data label inside the box or
  26077. * to the actual value point. Defaults to `false` in most cases, `true` in
  26078. * stacked columns.
  26079. */
  26080. inside?: boolean;
  26081. /**
  26082. * (Highcharts, Highstock, Highmaps, Gantt) Format for points with the value
  26083. * of null. Works analogously to format. `nullFormat` can be applied only to
  26084. * series which support displaying null points.
  26085. */
  26086. nullFormat?: (boolean|string);
  26087. /**
  26088. * (Highcharts, Highstock, Highmaps, Gantt) Callback JavaScript function
  26089. * that defines formatting for points with the value of null. Works
  26090. * analogously to formatter. `nullPointFormatter` can be applied only to
  26091. * series which support displaying null points.
  26092. */
  26093. nullFormatter?: DataLabelsFormatterCallbackFunction;
  26094. /**
  26095. * (Highcharts, Highstock, Highmaps, Gantt) How to handle data labels that
  26096. * flow outside the plot area. The default is `"justify"`, which aligns them
  26097. * inside the plot area. For columns and bars, this means it will be moved
  26098. * inside the bar. To display data labels outside the plot area, set `crop`
  26099. * to `false` and `overflow` to `"allow"`.
  26100. */
  26101. overflow?: DataLabelsOverflowValue;
  26102. /**
  26103. * (Highcharts, Highstock, Highmaps, Gantt) When either the `borderWidth` or
  26104. * the `backgroundColor` is set, this is the padding within the box.
  26105. */
  26106. padding?: number;
  26107. /**
  26108. * (Highcharts, Highstock, Highmaps, Gantt) Aligns data labels relative to
  26109. * points. If `center` alignment is not possible, it defaults to `right`.
  26110. */
  26111. position?: AlignValue;
  26112. /**
  26113. * (Highcharts, Highstock, Highmaps, Gantt) Text rotation in degrees. Note
  26114. * that due to a more complex structure, backgrounds, borders and padding
  26115. * will be lost on a rotated data label.
  26116. */
  26117. rotation?: number;
  26118. /**
  26119. * (Highcharts, Highstock, Highmaps, Gantt) The shadow of the box. Works
  26120. * best with `borderWidth` or `backgroundColor`. Since 2.3 the shadow can be
  26121. * an object configuration containing `color`, `offsetX`, `offsetY`,
  26122. * `opacity` and `width`.
  26123. */
  26124. shadow?: (boolean|ShadowOptionsObject);
  26125. /**
  26126. * (Highcharts, Highstock, Highmaps, Gantt) The name of a symbol to use for
  26127. * the border around the label. Symbols are predefined functions on the
  26128. * Renderer object.
  26129. */
  26130. shape?: string;
  26131. /**
  26132. * (Highcharts, Highstock, Highmaps, Gantt) Styles for the label. The
  26133. * default `color` setting is `"contrast"`, which is a pseudo color that
  26134. * Highcharts picks up and applies the maximum contrast to the underlying
  26135. * point item, for example the bar in a bar chart.
  26136. *
  26137. * The `textOutline` is a pseudo property that applies an outline of the
  26138. * given width with the given color, which by default is the maximum
  26139. * contrast to the text. So a bright text color will result in a black text
  26140. * outline for maximum readability on a mixed background. In some cases,
  26141. * especially with grayscale text, the text outline doesn't work well, in
  26142. * which cases it can be disabled by setting it to `"none"`. When `useHTML`
  26143. * is true, the `textOutline` will not be picked up. In this, case, the same
  26144. * effect can be acheived through the `text-shadow` CSS property.
  26145. *
  26146. * For some series types, where each point has an extent, like for example
  26147. * tree maps, the data label may overflow the point. There are two
  26148. * strategies for handling overflow. By default, the text will wrap to
  26149. * multiple lines. The other strategy is to set `style.textOverflow` to
  26150. * `ellipsis`, which will keep the text on one line plus it will break
  26151. * inside long words.
  26152. */
  26153. style?: CSSObject;
  26154. /**
  26155. * (Highcharts, Highstock, Highmaps, Gantt) Options for a label text which
  26156. * should follow marker's shape. Border and background are disabled for a
  26157. * label that follows a path.
  26158. *
  26159. * **Note:** Only SVG-based renderer supports this option. Setting `useHTML`
  26160. * to true will disable this option.
  26161. */
  26162. textPath?: DataLabelsTextPathOptionsObject;
  26163. /**
  26164. * (Highcharts, Highstock, Highmaps, Gantt) Whether to use HTML to render
  26165. * the labels.
  26166. */
  26167. useHTML?: boolean;
  26168. /**
  26169. * (Highcharts, Highstock, Highmaps, Gantt) The vertical alignment of a data
  26170. * label. Can be one of `top`, `middle` or `bottom`. The default value
  26171. * depends on the data, for instance in a column chart, the label is above
  26172. * positive values and below negative values.
  26173. */
  26174. verticalAlign?: (VerticalAlignValue|null);
  26175. /**
  26176. * (Highcharts, Highstock, Highmaps, Gantt) The x position offset of the
  26177. * label relative to the point in pixels.
  26178. */
  26179. x?: number;
  26180. /**
  26181. * (Highcharts, Highstock, Highmaps, Gantt) The y position offset of the
  26182. * label relative to the point in pixels.
  26183. */
  26184. y?: number;
  26185. /**
  26186. * (Highcharts, Highstock, Highmaps, Gantt) The Z index of the data labels.
  26187. * The default Z index puts it above the series. Use a Z index of 2 to
  26188. * display it behind the series.
  26189. */
  26190. z?: number;
  26191. }
  26192. /**
  26193. * (Highcharts, Highstock) Options for the series data sorting.
  26194. */
  26195. export interface PlotBbDataSortingOptions {
  26196. /**
  26197. * (Highcharts, Highstock) Enable or disable data sorting for the series.
  26198. * Use xAxis.reversed to change the sorting order.
  26199. */
  26200. enabled?: boolean;
  26201. /**
  26202. * (Highcharts, Highstock) Whether to allow matching points by name in an
  26203. * update. If this option is disabled, points will be matched by order.
  26204. */
  26205. matchByName?: boolean;
  26206. /**
  26207. * (Highcharts, Highstock) Determines what data value should be used to sort
  26208. * by.
  26209. */
  26210. sortKey?: string;
  26211. }
  26212. /**
  26213. * (Highstock) Bollinger bands (BB). This series requires the `linkedTo` option
  26214. * to be set and should be loaded after the `stock/indicators/indicators.js`
  26215. * file.
  26216. *
  26217. * In TypeScript the type option must always be set.
  26218. *
  26219. * Configuration options for the series are given in three levels:
  26220. *
  26221. * 1. Options for all series in a chart are defined in the plotOptions.series
  26222. * object.
  26223. *
  26224. * 2. Options for all `bb` series are defined in plotOptions.bb.
  26225. *
  26226. * 3. Options for one single series are given in the series instance array. (see
  26227. * online documentation for example)
  26228. */
  26229. export interface PlotBbOptions {
  26230. /**
  26231. * (Highstock) Accessibility options for a series.
  26232. */
  26233. accessibility?: SeriesAccessibilityOptionsObject;
  26234. /**
  26235. * (Highstock) Allow this series' points to be selected by clicking on the
  26236. * graphic (columns, point markers, pie slices, map areas etc).
  26237. *
  26238. * The selected points can be handled by point select and unselect events,
  26239. * or collectively by the getSelectedPoints function.
  26240. *
  26241. * And alternative way of selecting points is through dragging.
  26242. */
  26243. allowPointSelect?: boolean;
  26244. /**
  26245. * (Highstock) Enable or disable the initial animation when a series is
  26246. * displayed. The animation can also be set as a configuration object.
  26247. * Please note that this option only applies to the initial animation of the
  26248. * series itself. For other animations, see chart.animation and the
  26249. * animation parameter under the API methods. The following properties are
  26250. * supported:
  26251. *
  26252. * - `defer`: The animation delay time in milliseconds.
  26253. *
  26254. * - `duration`: The duration of the animation in milliseconds.
  26255. *
  26256. * - `easing`: Can be a string reference to an easing function set on the
  26257. * `Math` object or a function. See the _Custom easing function_ demo below.
  26258. *
  26259. * Due to poor performance, animation is disabled in old IE browsers for
  26260. * several chart types.
  26261. */
  26262. animation?: (boolean|PlotBbAnimationOptions|Partial<AnimationOptionsObject>);
  26263. /**
  26264. * (Highstock) For some series, there is a limit that shuts down initial
  26265. * animation by default when the total number of points in the chart is too
  26266. * high. For example, for a column chart and its derivatives, animation does
  26267. * not run if there is more than 250 points totally. To disable this cap,
  26268. * set `animationLimit` to `Infinity`.
  26269. */
  26270. animationLimit?: number;
  26271. /**
  26272. * (Highstock) Sets the color blending in the boost module.
  26273. */
  26274. boostBlending?: OptionsBoostBlendingValue;
  26275. /**
  26276. * (Highstock) Set the point threshold for when a series should enter boost
  26277. * mode.
  26278. *
  26279. * Setting it to e.g. 2000 will cause the series to enter boost mode when
  26280. * there are 2000 or more points in the series.
  26281. *
  26282. * To disable boosting on the series, set the `boostThreshold` to 0. Setting
  26283. * it to 1 will force boosting.
  26284. *
  26285. * Note that the cropThreshold also affects this setting. When zooming in on
  26286. * a series that has fewer points than the `cropThreshold`, all points are
  26287. * rendered although outside the visible plot area, and the `boostThreshold`
  26288. * won't take effect.
  26289. */
  26290. boostThreshold?: number;
  26291. /**
  26292. * (Highmaps) The border color of the map areas.
  26293. *
  26294. * In styled mode, the border stroke is given in the `.highcharts-point`
  26295. * class.
  26296. */
  26297. borderColor?: (ColorString|GradientColorObject|PatternObject);
  26298. /**
  26299. * (Highmaps) The border width of each map area.
  26300. *
  26301. * In styled mode, the border stroke width is given in the
  26302. * `.highcharts-point` class.
  26303. */
  26304. borderWidth?: number;
  26305. /**
  26306. * (Highstock) Bottom line options.
  26307. */
  26308. bottomLine?: PlotBbBottomLineOptions;
  26309. /**
  26310. * (Highstock) An additional class name to apply to the series' graphical
  26311. * elements. This option does not replace default class names of the
  26312. * graphical element.
  26313. */
  26314. className?: string;
  26315. /**
  26316. * (Highstock) Disable this option to allow series rendering in the whole
  26317. * plotting area.
  26318. *
  26319. * **Note:** Clipping should be always enabled when chart.zoomType is set
  26320. */
  26321. clip?: boolean;
  26322. /**
  26323. * (Highstock) The main color of the series. In line type series it applies
  26324. * to the line and the point markers unless otherwise specified. In bar type
  26325. * series it applies to the bars unless a color is specified per point. The
  26326. * default value is pulled from the `options.colors` array.
  26327. *
  26328. * In styled mode, the color can be defined by the colorIndex option. Also,
  26329. * the series color can be set with the `.highcharts-series`,
  26330. * `.highcharts-color-{n}`, `.highcharts-{type}-series` or
  26331. * `.highcharts-series-{n}` class, or individual classes given by the
  26332. * `className` option.
  26333. */
  26334. color?: (ColorString|GradientColorObject|PatternObject);
  26335. /**
  26336. * (Highstock) Styled mode only. A specific color index to use for the
  26337. * series, so its graphic representations are given the class name
  26338. * `highcharts-color-{n}`.
  26339. */
  26340. colorIndex?: number;
  26341. /**
  26342. * (Highcharts, Highstock, Highmaps) Determines what data value should be
  26343. * used to calculate point color if `colorAxis` is used. Requires to set
  26344. * `min` and `max` if some custom point property is used or if approximation
  26345. * for data grouping is set to `'sum'`.
  26346. */
  26347. colorKey?: string;
  26348. /**
  26349. * (Highstock) Compare the values of the series against the first non-null,
  26350. * non- zero value in the visible range. The y axis will show percentage or
  26351. * absolute change depending on whether `compare` is set to `"percent"` or
  26352. * `"value"`. When this is applied to multiple series, it allows comparing
  26353. * the development of the series against each other. Adds a `change` field
  26354. * to every point object.
  26355. */
  26356. compare?: string;
  26357. /**
  26358. * (Highstock) When compare is `percent`, this option dictates whether to
  26359. * use 0 or 100 as the base of comparison.
  26360. */
  26361. compareBase?: (0|100);
  26362. /**
  26363. * (Highstock) Defines if comparison should start from the first point
  26364. * within the visible range or should start from the first point **before**
  26365. * the range.
  26366. *
  26367. * In other words, this flag determines if first point within the visible
  26368. * range will have 0% (`compareStart=true`) or should have been already
  26369. * calculated according to the previous point (`compareStart=false`).
  26370. */
  26371. compareStart?: boolean;
  26372. /**
  26373. * (Highstock) Whether to compare indicator to the main series values or
  26374. * indicator values.
  26375. */
  26376. compareToMain?: boolean;
  26377. /**
  26378. * (Highcharts) Polar charts only. Whether to connect the ends of a line
  26379. * series plot across the extremes.
  26380. */
  26381. connectEnds?: boolean;
  26382. /**
  26383. * (Highcharts, Highstock) Whether to connect a graph line across null
  26384. * points, or render a gap between the two points on either side of the
  26385. * null.
  26386. */
  26387. connectNulls?: boolean;
  26388. /**
  26389. * (Gantt) Override Pathfinder connector options for a series. Requires
  26390. * Highcharts Gantt to be loaded.
  26391. */
  26392. connectors?: SeriesConnectorsOptionsObject;
  26393. /**
  26394. * (Highcharts, Highstock, Gantt) When true, each point or column edge is
  26395. * rounded to its nearest pixel in order to render sharp on screen. In some
  26396. * cases, when there are a lot of densely packed columns, this leads to
  26397. * visible difference in column widths or distance between columns. In these
  26398. * cases, setting `crisp` to `false` may look better, even though each
  26399. * column is rendered blurry.
  26400. */
  26401. crisp?: boolean;
  26402. /**
  26403. * (Highcharts, Highstock) When the series contains less points than the
  26404. * crop threshold, all points are drawn, even if the points fall outside the
  26405. * visible plot area at the current zoom. The advantage of drawing all
  26406. * points (including markers and columns), is that animation is performed on
  26407. * updates. On the other hand, when the series contains more points than the
  26408. * crop threshold, the series data is cropped to only contain points that
  26409. * fall within the plot area. The advantage of cropping away invisible
  26410. * points is to increase performance on large series.
  26411. */
  26412. cropThreshold?: number;
  26413. /**
  26414. * (Highstock) You can set the cursor to "pointer" if you have click events
  26415. * attached to the series, to signal to the user that the points and lines
  26416. * can be clicked.
  26417. *
  26418. * In styled mode, the series cursor can be set with the same classes as
  26419. * listed under series.color.
  26420. */
  26421. cursor?: (string|CursorValue);
  26422. /**
  26423. * (Highstock) A reserved subspace to store options and values for
  26424. * customized functionality. Here you can add additional data for your own
  26425. * event callbacks and formatter callbacks.
  26426. */
  26427. custom?: Dictionary<any>;
  26428. /**
  26429. * (Highstock) Name of the dash style to use for the graph, or for some
  26430. * series types the outline of each shape.
  26431. *
  26432. * In styled mode, the stroke dash-array can be set with the same classes as
  26433. * listed under series.color.
  26434. */
  26435. dashStyle?: DashStyleValue;
  26436. /**
  26437. * (Highstock) Data grouping is the concept of sampling the data values into
  26438. * larger blocks in order to ease readability and increase performance of
  26439. * the JavaScript charts. Highstock by default applies data grouping when
  26440. * the points become closer than a certain pixel value, determined by the
  26441. * `groupPixelWidth` option.
  26442. *
  26443. * If data grouping is applied, the grouping information of grouped points
  26444. * can be read from the Point.dataGroup. If point options other than the
  26445. * data itself are set, for example `name` or `color` or custom properties,
  26446. * the grouping logic doesn't know how to group it. In this case the options
  26447. * of the first point instance are copied over to the group point. This can
  26448. * be altered through a custom `approximation` callback function.
  26449. */
  26450. dataGrouping?: DataGroupingOptionsObject;
  26451. /**
  26452. * (Highcharts, Highstock, Highmaps, Gantt) Options for the series data
  26453. * labels, appearing next to each data point.
  26454. *
  26455. * Since v6.2.0, multiple data labels can be applied to each single point by
  26456. * defining them as an array of configs.
  26457. *
  26458. * In styled mode, the data labels can be styled with the
  26459. * `.highcharts-data-label-box` and `.highcharts-data-label` class names
  26460. * (see example).
  26461. */
  26462. dataLabels?: (PlotBbDataLabelsOptions|Array<PlotBbDataLabelsOptions>);
  26463. /**
  26464. * (Highcharts, Highstock) Options for the series data sorting.
  26465. */
  26466. dataSorting?: (DataSortingOptionsObject|PlotBbDataSortingOptions);
  26467. /**
  26468. * (Highstock) A description of the series to add to the screen reader
  26469. * information about the series.
  26470. */
  26471. description?: string;
  26472. /**
  26473. * (Highstock) Enable or disable the mouse tracking for a specific series.
  26474. * This includes point tooltips and click events on graphs and points. For
  26475. * large datasets it improves performance.
  26476. */
  26477. enableMouseTracking?: boolean;
  26478. /**
  26479. * (Highstock) General event handlers for the series items. These event
  26480. * hooks can also be attached to the series at run time using the
  26481. * `Highcharts.addEvent` function.
  26482. */
  26483. events?: SeriesEventsOptionsObject;
  26484. /**
  26485. * (Highstock) Determines whether the series should look for the nearest
  26486. * point in both dimensions or just the x-dimension when hovering the
  26487. * series. Defaults to `'xy'` for scatter series and `'x'` for most other
  26488. * series. If the data has duplicate x-values, it is recommended to set this
  26489. * to `'xy'` to allow hovering over all points.
  26490. *
  26491. * Applies only to series types using nearest neighbor search (not direct
  26492. * hover) for tooltip.
  26493. */
  26494. findNearestPointBy?: OptionsFindNearestPointByValue;
  26495. /**
  26496. * (Highstock) Defines when to display a gap in the graph, together with the
  26497. * gapUnit option.
  26498. *
  26499. * In case when `dataGrouping` is enabled, points can be grouped into a
  26500. * larger time span. This can make the grouped points to have a greater
  26501. * distance than the absolute value of `gapSize` property, which will result
  26502. * in disappearing graph completely. To prevent this situation the mentioned
  26503. * distance between grouped points is used instead of previously defined
  26504. * `gapSize`.
  26505. *
  26506. * In practice, this option is most often used to visualize gaps in time
  26507. * series. In a stock chart, intraday data is available for daytime hours,
  26508. * while gaps will appear in nights and weekends.
  26509. */
  26510. gapSize?: number;
  26511. /**
  26512. * (Highstock) Together with gapSize, this option defines where to draw gaps
  26513. * in the graph.
  26514. *
  26515. * When the `gapUnit` is `"relative"` (default), a gap size of 5 means that
  26516. * if the distance between two points is greater than 5 times that of the
  26517. * two closest points, the graph will be broken.
  26518. *
  26519. * When the `gapUnit` is `"value"`, the gap is based on absolute axis
  26520. * values, which on a datetime axis is milliseconds. This also applies to
  26521. * the navigator series that inherits gap options from the base series.
  26522. */
  26523. gapUnit?: OptionsGapUnitValue;
  26524. /**
  26525. * (Highcharts, Highstock, Gantt) Whether to use the Y extremes of the total
  26526. * chart width or only the zoomed area when zooming in on parts of the X
  26527. * axis. By default, the Y axis adjusts to the min and max of the visible
  26528. * data. Cartesian series only.
  26529. */
  26530. getExtremesFromAll?: boolean;
  26531. /**
  26532. * (Highstock) When set to `false` will prevent the series data from being
  26533. * included in any form of data export.
  26534. *
  26535. * Since version 6.0.0 until 7.1.0 the option was existing undocumented as
  26536. * `includeInCSVExport`.
  26537. */
  26538. includeInDataExport?: boolean;
  26539. /**
  26540. * (Highcharts, Highstock, Gantt) Series labels are placed as close to the
  26541. * series as possible in a natural way, seeking to avoid other series. The
  26542. * goal of this feature is to make the chart more easily readable, like if a
  26543. * human designer placed the labels in the optimal position.
  26544. *
  26545. * The series labels currently work with series types having a `graph` or an
  26546. * `area`.
  26547. */
  26548. label?: SeriesLabelOptionsObject;
  26549. /**
  26550. * (Highstock) The line marks the last price from all points.
  26551. */
  26552. lastPrice?: SeriesLastPriceOptionsObject;
  26553. /**
  26554. * (Highstock) The line marks the last price from visible range of points.
  26555. */
  26556. lastVisiblePrice?: SeriesLastVisiblePriceOptionsObject;
  26557. /**
  26558. * (Highcharts, Highstock) The SVG value used for the `stroke-linecap` and
  26559. * `stroke-linejoin` of a line graph. Round means that lines are rounded in
  26560. * the ends and bends.
  26561. */
  26562. linecap?: SeriesLinecapValue;
  26563. /**
  26564. * (Highcharts, Highstock) Pixel width of the graph line.
  26565. */
  26566. lineWidth?: number;
  26567. /**
  26568. * (Highcharts, Highstock, Gantt) The main series ID that indicator will be
  26569. * based on. Required for this indicator.
  26570. */
  26571. linkedTo?: string;
  26572. /**
  26573. * (Highstock) Options for the point markers of line-like series. Properties
  26574. * like `fillColor`, `lineColor` and `lineWidth` define the visual
  26575. * appearance of the markers. Other series types, like column series, don't
  26576. * have markers, but have visual options on the series level instead.
  26577. *
  26578. * In styled mode, the markers can be styled with the `.highcharts-point`,
  26579. * `.highcharts-point-hover` and `.highcharts-point-select` class names.
  26580. */
  26581. marker?: PointMarkerOptionsObject;
  26582. /**
  26583. * (Highstock) The name of the series as shown in the legend, tooltip etc.
  26584. * If not set, it will be based on a technical indicator type and default
  26585. * params.
  26586. */
  26587. name?: string;
  26588. /**
  26589. * (Highstock) The color for the parts of the graph or points that are below
  26590. * the threshold. Note that `zones` takes precedence over the negative
  26591. * color. Using `negativeColor` is equivalent to applying a zone with value
  26592. * of 0.
  26593. */
  26594. negativeColor?: (ColorString|GradientColorObject|PatternObject);
  26595. /**
  26596. * (Highstock) Opacity of a series parts: line, fill (e.g. area) and
  26597. * dataLabels.
  26598. */
  26599. opacity?: number;
  26600. /**
  26601. * (Highstock) Paramters used in calculation of regression series' points.
  26602. */
  26603. params?: PlotBbParamsOptions;
  26604. /**
  26605. * (Highstock) Properties for each single point.
  26606. */
  26607. point?: PlotSeriesPointOptions;
  26608. /**
  26609. * (Highstock) Same as accessibility.pointDescriptionFormatter, but for an
  26610. * individual series. Overrides the chart wide configuration.
  26611. */
  26612. pointDescriptionFormatter?: Function;
  26613. /**
  26614. * (Highstock) Whether to select the series initially. If `showCheckbox` is
  26615. * true, the checkbox next to the series name in the legend will be checked
  26616. * for a selected series.
  26617. */
  26618. selected?: boolean;
  26619. /**
  26620. * (Highstock) Whether to apply a drop shadow to the graph line. Since 2.3
  26621. * the shadow can be an object configuration containing `color`, `offsetX`,
  26622. * `offsetY`, `opacity` and `width`.
  26623. */
  26624. shadow?: (boolean|ShadowOptionsObject);
  26625. /**
  26626. * (Highstock) If true, a checkbox is displayed next to the legend item to
  26627. * allow selecting the series. The state of the checkbox is determined by
  26628. * the `selected` option.
  26629. */
  26630. showCheckbox?: boolean;
  26631. /**
  26632. * (Highstock) Whether to display this particular series or series type in
  26633. * the legend. Standalone series are shown in legend by default, and linked
  26634. * series are not. Since v7.2.0 it is possible to show series that use
  26635. * colorAxis by setting this option to `true`.
  26636. */
  26637. showInLegend?: boolean;
  26638. /**
  26639. * (Highstock) If set to `true`, the accessibility module will skip past the
  26640. * points in this series for keyboard navigation.
  26641. */
  26642. skipKeyboardNavigation?: boolean;
  26643. /**
  26644. * (Highcharts, Highstock) When this is true, the series will not cause the
  26645. * Y axis to cross the zero plane (or threshold option) unless the data
  26646. * actually crosses the plane.
  26647. *
  26648. * For example, if `softThreshold` is `false`, a series of 0, 1, 2, 3 will
  26649. * make the Y axis show negative values according to the `minPadding`
  26650. * option. If `softThreshold` is `true`, the Y axis starts at 0.
  26651. */
  26652. softThreshold?: boolean;
  26653. states?: SeriesStatesOptionsObject;
  26654. /**
  26655. * (Highcharts, Highstock) Whether to apply steps to the line. Possible
  26656. * values are `left`, `center` and `right`.
  26657. */
  26658. step?: OptionsStepValue;
  26659. /**
  26660. * (Highstock) Sticky tracking of mouse events. When true, the `mouseOut`
  26661. * event on a series isn't triggered until the mouse moves over another
  26662. * series, or out of the plot area. When false, the `mouseOut` event on a
  26663. * series is triggered when the mouse leaves the area around the series'
  26664. * graph or markers. This also implies the tooltip when not shared. When
  26665. * `stickyTracking` is false and `tooltip.shared` is false, the tooltip will
  26666. * be hidden when moving the mouse between series. Defaults to true for line
  26667. * and area type series, but to false for columns, pies etc.
  26668. *
  26669. * **Note:** The boost module will force this option because of technical
  26670. * limitations.
  26671. */
  26672. stickyTracking?: boolean;
  26673. /**
  26674. * (Highcharts, Highstock) The threshold, also called zero level or base
  26675. * level. For line type series this is only used in conjunction with
  26676. * negativeColor.
  26677. */
  26678. threshold?: (number|null);
  26679. /**
  26680. * (Highstock) A configuration object for the tooltip rendering of each
  26681. * single series. Properties are inherited from tooltip, but only the
  26682. * following properties can be defined on a series level.
  26683. */
  26684. tooltip?: SeriesTooltipOptionsObject;
  26685. /**
  26686. * (Highstock) Top line options.
  26687. */
  26688. topLine?: PlotBbTopLineOptions;
  26689. /**
  26690. * (Highcharts, Highstock, Gantt) When a series contains a data array that
  26691. * is longer than this, only one dimensional arrays of numbers, or two
  26692. * dimensional arrays with x and y values are allowed. Also, only the first
  26693. * point is tested, and the rest are assumed to be the same format. This
  26694. * saves expensive data checking and indexing in long series. Set it to `0`
  26695. * disable.
  26696. *
  26697. * Note: In boost mode turbo threshold is forced. Only array of numbers or
  26698. * two dimensional arrays are allowed.
  26699. */
  26700. turboThreshold?: number;
  26701. /**
  26702. * (Highstock) Set the initial visibility of the series.
  26703. */
  26704. visible?: boolean;
  26705. /**
  26706. * (Highmaps) Define the z index of the series.
  26707. */
  26708. zIndex?: number;
  26709. /**
  26710. * (Highcharts, Highstock) Defines the Axis on which the zones are applied.
  26711. */
  26712. zoneAxis?: string;
  26713. /**
  26714. * (Highcharts, Highstock) An array defining zones within a series. Zones
  26715. * can be applied to the X axis, Y axis or Z axis for bubbles, according to
  26716. * the `zoneAxis` option. The zone definitions have to be in ascending order
  26717. * regarding to the value.
  26718. *
  26719. * In styled mode, the color zones are styled with the
  26720. * `.highcharts-zone-{n}` class, or custom classed from the `className`
  26721. * option (view live demo).
  26722. */
  26723. zones?: Array<SeriesZonesOptionsObject>;
  26724. }
  26725. /**
  26726. * (Highstock) Paramters used in calculation of regression series' points.
  26727. */
  26728. export interface PlotBbParamsOptions {
  26729. /**
  26730. * (Highstock) The point index which indicator calculations will base. For
  26731. * example using OHLC data, index=2 means the indicator will be calculated
  26732. * using Low values.
  26733. */
  26734. index?: number;
  26735. /**
  26736. * (Highstock) The base period for indicator calculations. This is the
  26737. * number of data points which are taken into account for the indicator
  26738. * calculations.
  26739. */
  26740. period?: number;
  26741. /**
  26742. * (Highstock) Standard deviation for top and bottom bands.
  26743. */
  26744. standardDeviation?: number;
  26745. }
  26746. /**
  26747. * (Highstock) Top line options.
  26748. */
  26749. export interface PlotBbTopLineOptions {
  26750. /**
  26751. * (Highstock) Styles for a bottom line.
  26752. */
  26753. styles?: PlotBbTopLineStylesOptions;
  26754. }
  26755. /**
  26756. * (Highstock) Styles for a bottom line.
  26757. */
  26758. export interface PlotBbTopLineStylesOptions {
  26759. /**
  26760. * (Highstock) Color of the line. If not set, it's inherited from
  26761. * plotOptions.bb.color.
  26762. */
  26763. lineColor?: ColorString;
  26764. /**
  26765. * (Highstock) Pixel width of the line.
  26766. */
  26767. lineWidth?: number;
  26768. }
  26769. /**
  26770. * (Highcharts) Enable or disable the initial animation when a series is
  26771. * displayed. The animation can also be set as a configuration object. Please
  26772. * note that this option only applies to the initial animation of the series
  26773. * itself. For other animations, see chart.animation and the animation parameter
  26774. * under the API methods. The following properties are supported:
  26775. *
  26776. * - `defer`: The animation delay time in milliseconds.
  26777. *
  26778. * - `duration`: The duration of the animation in milliseconds.
  26779. *
  26780. * - `easing`: Can be a string reference to an easing function set on the `Math`
  26781. * object or a function. See the _Custom easing function_ demo below.
  26782. *
  26783. * Due to poor performance, animation is disabled in old IE browsers for several
  26784. * chart types.
  26785. */
  26786. export interface PlotBellcurveAnimationOptions {
  26787. defer?: number;
  26788. }
  26789. /**
  26790. * (Highcharts, Highstock, Highmaps, Gantt) Enable or disable the initial
  26791. * animation when a series is displayed for the `dataLabels`. The animation can
  26792. * also be set as a configuration object. Please note that this option only
  26793. * applies to the initial animation. For other animations, see chart.animation
  26794. * and the animation parameter under the API methods. The following properties
  26795. * are supported:
  26796. *
  26797. * - `defer`: The animation delay time in milliseconds.
  26798. */
  26799. export interface PlotBellcurveDataLabelsAnimationOptions {
  26800. /**
  26801. * (Highcharts, Highstock, Highmaps, Gantt) The animation delay time in
  26802. * milliseconds. Set to `0` renders dataLabel immediately. As `undefined`
  26803. * inherits defer time from the series.animation.defer.
  26804. */
  26805. defer?: number;
  26806. }
  26807. /**
  26808. * (Highcharts, Highstock, Highmaps, Gantt) Options for the series data labels,
  26809. * appearing next to each data point.
  26810. *
  26811. * Since v6.2.0, multiple data labels can be applied to each single point by
  26812. * defining them as an array of configs.
  26813. *
  26814. * In styled mode, the data labels can be styled with the
  26815. * `.highcharts-data-label-box` and `.highcharts-data-label` class names (see
  26816. * example).
  26817. */
  26818. export interface PlotBellcurveDataLabelsOptions {
  26819. /**
  26820. * (Highcharts, Highstock, Highmaps, Gantt) The alignment of the data label
  26821. * compared to the point. If `right`, the right side of the label should be
  26822. * touching the point. For points with an extent, like columns, the
  26823. * alignments also dictates how to align it inside the box, as given with
  26824. * the inside option. Can be one of `left`, `center` or `right`.
  26825. */
  26826. align?: (AlignValue|null);
  26827. /**
  26828. * (Highcharts, Highstock, Highmaps, Gantt) Whether to allow data labels to
  26829. * overlap. To make the labels less sensitive for overlapping, the
  26830. * dataLabels.padding can be set to 0.
  26831. */
  26832. allowOverlap?: boolean;
  26833. /**
  26834. * (Highcharts, Highstock, Highmaps, Gantt) Enable or disable the initial
  26835. * animation when a series is displayed for the `dataLabels`. The animation
  26836. * can also be set as a configuration object. Please note that this option
  26837. * only applies to the initial animation. For other animations, see
  26838. * chart.animation and the animation parameter under the API methods. The
  26839. * following properties are supported:
  26840. *
  26841. * - `defer`: The animation delay time in milliseconds.
  26842. */
  26843. animation?: (boolean|PlotBellcurveDataLabelsAnimationOptions|Partial<AnimationOptionsObject>);
  26844. /**
  26845. * (Highcharts, Highstock, Highmaps, Gantt) The background color or gradient
  26846. * for the data label.
  26847. */
  26848. backgroundColor?: (ColorString|GradientColorObject|PatternObject);
  26849. /**
  26850. * (Highcharts, Highstock, Highmaps, Gantt) The border color for the data
  26851. * label. Defaults to `undefined`.
  26852. */
  26853. borderColor?: (ColorString|GradientColorObject|PatternObject);
  26854. /**
  26855. * (Highcharts, Highstock, Highmaps, Gantt) The border radius in pixels for
  26856. * the data label.
  26857. */
  26858. borderRadius?: number;
  26859. /**
  26860. * (Highcharts, Highstock, Highmaps, Gantt) The border width in pixels for
  26861. * the data label.
  26862. */
  26863. borderWidth?: number;
  26864. /**
  26865. * (Highcharts, Highstock, Highmaps, Gantt) A class name for the data label.
  26866. * Particularly in styled mode, this can be used to give each series' or
  26867. * point's data label unique styling. In addition to this option, a default
  26868. * color class name is added so that we can give the labels a contrast text
  26869. * shadow.
  26870. */
  26871. className?: string;
  26872. /**
  26873. * (Highcharts, Highstock, Highmaps, Gantt) The text color for the data
  26874. * labels. Defaults to `undefined`. For certain series types, like column or
  26875. * map, the data labels can be drawn inside the points. In this case the
  26876. * data label will be drawn with maximum contrast by default. Additionally,
  26877. * it will be given a `text-outline` style with the opposite color, to
  26878. * further increase the contrast. This can be overridden by setting the
  26879. * `text-outline` style to `none` in the `dataLabels.style` option.
  26880. */
  26881. color?: (ColorString|GradientColorObject|PatternObject);
  26882. /**
  26883. * (Highcharts, Highstock, Highmaps, Gantt) Whether to hide data labels that
  26884. * are outside the plot area. By default, the data label is moved inside the
  26885. * plot area according to the overflow option.
  26886. */
  26887. crop?: boolean;
  26888. /**
  26889. * (Highcharts, Highstock, Gantt) Whether to defer displaying the data
  26890. * labels until the initial series animation has finished. Setting to
  26891. * `false` renders the data label immediately. If set to `true` inherits the
  26892. * defer time set in plotOptions.series.animation.
  26893. */
  26894. defer?: boolean;
  26895. /**
  26896. * (Highcharts, Highstock, Highmaps, Gantt) Enable or disable the data
  26897. * labels.
  26898. */
  26899. enabled?: boolean;
  26900. /**
  26901. * (Highcharts, Highstock, Highmaps, Gantt) A declarative filter to control
  26902. * of which data labels to display. The declarative filter is designed for
  26903. * use when callback functions are not available, like when the chart
  26904. * options require a pure JSON structure or for use with graphical editors.
  26905. * For programmatic control, use the `formatter` instead, and return
  26906. * `undefined` to disable a single data label.
  26907. */
  26908. filter?: DataLabelsFilterOptionsObject;
  26909. /**
  26910. * (Highcharts, Highstock, Highmaps, Gantt) A format string for the data
  26911. * label. Available variables are the same as for `formatter`.
  26912. */
  26913. format?: string;
  26914. /**
  26915. * (Highcharts, Highstock, Highmaps, Gantt) Callback JavaScript function to
  26916. * format the data label. Note that if a `format` is defined, the format
  26917. * takes precedence and the formatter is ignored.
  26918. */
  26919. formatter?: DataLabelsFormatterCallbackFunction;
  26920. /**
  26921. * (Highcharts, Highstock, Highmaps, Gantt) For points with an extent, like
  26922. * columns or map areas, whether to align the data label inside the box or
  26923. * to the actual value point. Defaults to `false` in most cases, `true` in
  26924. * stacked columns.
  26925. */
  26926. inside?: boolean;
  26927. /**
  26928. * (Highcharts, Highstock, Highmaps, Gantt) Format for points with the value
  26929. * of null. Works analogously to format. `nullFormat` can be applied only to
  26930. * series which support displaying null points.
  26931. */
  26932. nullFormat?: (boolean|string);
  26933. /**
  26934. * (Highcharts, Highstock, Highmaps, Gantt) Callback JavaScript function
  26935. * that defines formatting for points with the value of null. Works
  26936. * analogously to formatter. `nullPointFormatter` can be applied only to
  26937. * series which support displaying null points.
  26938. */
  26939. nullFormatter?: DataLabelsFormatterCallbackFunction;
  26940. /**
  26941. * (Highcharts, Highstock, Highmaps, Gantt) How to handle data labels that
  26942. * flow outside the plot area. The default is `"justify"`, which aligns them
  26943. * inside the plot area. For columns and bars, this means it will be moved
  26944. * inside the bar. To display data labels outside the plot area, set `crop`
  26945. * to `false` and `overflow` to `"allow"`.
  26946. */
  26947. overflow?: DataLabelsOverflowValue;
  26948. /**
  26949. * (Highcharts, Highstock, Highmaps, Gantt) When either the `borderWidth` or
  26950. * the `backgroundColor` is set, this is the padding within the box.
  26951. */
  26952. padding?: number;
  26953. /**
  26954. * (Highcharts, Highstock, Highmaps, Gantt) Aligns data labels relative to
  26955. * points. If `center` alignment is not possible, it defaults to `right`.
  26956. */
  26957. position?: AlignValue;
  26958. /**
  26959. * (Highcharts, Highstock, Highmaps, Gantt) Text rotation in degrees. Note
  26960. * that due to a more complex structure, backgrounds, borders and padding
  26961. * will be lost on a rotated data label.
  26962. */
  26963. rotation?: number;
  26964. /**
  26965. * (Highcharts, Highstock, Highmaps, Gantt) The shadow of the box. Works
  26966. * best with `borderWidth` or `backgroundColor`. Since 2.3 the shadow can be
  26967. * an object configuration containing `color`, `offsetX`, `offsetY`,
  26968. * `opacity` and `width`.
  26969. */
  26970. shadow?: (boolean|ShadowOptionsObject);
  26971. /**
  26972. * (Highcharts, Highstock, Highmaps, Gantt) The name of a symbol to use for
  26973. * the border around the label. Symbols are predefined functions on the
  26974. * Renderer object.
  26975. */
  26976. shape?: string;
  26977. /**
  26978. * (Highcharts, Highstock, Highmaps, Gantt) Styles for the label. The
  26979. * default `color` setting is `"contrast"`, which is a pseudo color that
  26980. * Highcharts picks up and applies the maximum contrast to the underlying
  26981. * point item, for example the bar in a bar chart.
  26982. *
  26983. * The `textOutline` is a pseudo property that applies an outline of the
  26984. * given width with the given color, which by default is the maximum
  26985. * contrast to the text. So a bright text color will result in a black text
  26986. * outline for maximum readability on a mixed background. In some cases,
  26987. * especially with grayscale text, the text outline doesn't work well, in
  26988. * which cases it can be disabled by setting it to `"none"`. When `useHTML`
  26989. * is true, the `textOutline` will not be picked up. In this, case, the same
  26990. * effect can be acheived through the `text-shadow` CSS property.
  26991. *
  26992. * For some series types, where each point has an extent, like for example
  26993. * tree maps, the data label may overflow the point. There are two
  26994. * strategies for handling overflow. By default, the text will wrap to
  26995. * multiple lines. The other strategy is to set `style.textOverflow` to
  26996. * `ellipsis`, which will keep the text on one line plus it will break
  26997. * inside long words.
  26998. */
  26999. style?: CSSObject;
  27000. /**
  27001. * (Highcharts, Highstock, Highmaps, Gantt) Options for a label text which
  27002. * should follow marker's shape. Border and background are disabled for a
  27003. * label that follows a path.
  27004. *
  27005. * **Note:** Only SVG-based renderer supports this option. Setting `useHTML`
  27006. * to true will disable this option.
  27007. */
  27008. textPath?: DataLabelsTextPathOptionsObject;
  27009. /**
  27010. * (Highcharts, Highstock, Highmaps, Gantt) Whether to use HTML to render
  27011. * the labels.
  27012. */
  27013. useHTML?: boolean;
  27014. /**
  27015. * (Highcharts, Highstock, Highmaps, Gantt) The vertical alignment of a data
  27016. * label. Can be one of `top`, `middle` or `bottom`. The default value
  27017. * depends on the data, for instance in a column chart, the label is above
  27018. * positive values and below negative values.
  27019. */
  27020. verticalAlign?: (VerticalAlignValue|null);
  27021. /**
  27022. * (Highcharts, Highstock, Highmaps, Gantt) The x position offset of the
  27023. * label relative to the point in pixels.
  27024. */
  27025. x?: number;
  27026. /**
  27027. * (Highcharts, Highstock, Highmaps, Gantt) The y position offset of the
  27028. * label relative to the point in pixels.
  27029. */
  27030. y?: number;
  27031. /**
  27032. * (Highcharts, Highstock, Highmaps, Gantt) The Z index of the data labels.
  27033. * The default Z index puts it above the series. Use a Z index of 2 to
  27034. * display it behind the series.
  27035. */
  27036. z?: number;
  27037. }
  27038. /**
  27039. * (Highcharts, Highstock) Options for the series data sorting.
  27040. */
  27041. export interface PlotBellcurveDataSortingOptions {
  27042. /**
  27043. * (Highcharts, Highstock) Enable or disable data sorting for the series.
  27044. * Use xAxis.reversed to change the sorting order.
  27045. */
  27046. enabled?: boolean;
  27047. /**
  27048. * (Highcharts, Highstock) Whether to allow matching points by name in an
  27049. * update. If this option is disabled, points will be matched by order.
  27050. */
  27051. matchByName?: boolean;
  27052. /**
  27053. * (Highcharts, Highstock) Determines what data value should be used to sort
  27054. * by.
  27055. */
  27056. sortKey?: string;
  27057. }
  27058. /**
  27059. * (Highcharts) A bell curve is an areaspline series which represents the
  27060. * probability density function of the normal distribution. It calculates mean
  27061. * and standard deviation of the base series data and plots the curve according
  27062. * to the calculated parameters.
  27063. *
  27064. * In TypeScript the type option must always be set.
  27065. *
  27066. * Configuration options for the series are given in three levels:
  27067. *
  27068. * 1. Options for all series in a chart are defined in the plotOptions.series
  27069. * object.
  27070. *
  27071. * 2. Options for all `bellcurve` series are defined in plotOptions.bellcurve.
  27072. *
  27073. * 3. Options for one single series are given in the series instance array. (see
  27074. * online documentation for example)
  27075. */
  27076. export interface PlotBellcurveOptions {
  27077. /**
  27078. * (Highcharts) Accessibility options for a series.
  27079. */
  27080. accessibility?: SeriesAccessibilityOptionsObject;
  27081. /**
  27082. * (Highmaps) Whether all areas of the map defined in `mapData` should be
  27083. * rendered. If `true`, areas which don't correspond to a data point, are
  27084. * rendered as `null` points. If `false`, those areas are skipped.
  27085. */
  27086. allAreas?: boolean;
  27087. /**
  27088. * (Highcharts) Allow this series' points to be selected by clicking on the
  27089. * graphic (columns, point markers, pie slices, map areas etc).
  27090. *
  27091. * The selected points can be handled by point select and unselect events,
  27092. * or collectively by the getSelectedPoints function.
  27093. *
  27094. * And alternative way of selecting points is through dragging.
  27095. */
  27096. allowPointSelect?: boolean;
  27097. /**
  27098. * (Highcharts) Enable or disable the initial animation when a series is
  27099. * displayed. The animation can also be set as a configuration object.
  27100. * Please note that this option only applies to the initial animation of the
  27101. * series itself. For other animations, see chart.animation and the
  27102. * animation parameter under the API methods. The following properties are
  27103. * supported:
  27104. *
  27105. * - `defer`: The animation delay time in milliseconds.
  27106. *
  27107. * - `duration`: The duration of the animation in milliseconds.
  27108. *
  27109. * - `easing`: Can be a string reference to an easing function set on the
  27110. * `Math` object or a function. See the _Custom easing function_ demo below.
  27111. *
  27112. * Due to poor performance, animation is disabled in old IE browsers for
  27113. * several chart types.
  27114. */
  27115. animation?: (boolean|PlotBellcurveAnimationOptions|Partial<AnimationOptionsObject>);
  27116. /**
  27117. * (Highcharts) For some series, there is a limit that shuts down initial
  27118. * animation by default when the total number of points in the chart is too
  27119. * high. For example, for a column chart and its derivatives, animation does
  27120. * not run if there is more than 250 points totally. To disable this cap,
  27121. * set `animationLimit` to `Infinity`.
  27122. */
  27123. animationLimit?: number;
  27124. /**
  27125. * (Highmaps) The border color of the map areas.
  27126. *
  27127. * In styled mode, the border stroke is given in the `.highcharts-point`
  27128. * class.
  27129. */
  27130. borderColor?: (ColorString|GradientColorObject|PatternObject);
  27131. /**
  27132. * (Highmaps) The border width of each map area.
  27133. *
  27134. * In styled mode, the border stroke width is given in the
  27135. * `.highcharts-point` class.
  27136. */
  27137. borderWidth?: number;
  27138. /**
  27139. * (Highcharts) An additional class name to apply to the series' graphical
  27140. * elements. This option does not replace default class names of the
  27141. * graphical element.
  27142. */
  27143. className?: string;
  27144. /**
  27145. * (Highcharts) Disable this option to allow series rendering in the whole
  27146. * plotting area.
  27147. *
  27148. * **Note:** Clipping should be always enabled when chart.zoomType is set
  27149. */
  27150. clip?: boolean;
  27151. /**
  27152. * (Highcharts) The main color of the series. In line type series it applies
  27153. * to the line and the point markers unless otherwise specified. In bar type
  27154. * series it applies to the bars unless a color is specified per point. The
  27155. * default value is pulled from the `options.colors` array.
  27156. *
  27157. * In styled mode, the color can be defined by the colorIndex option. Also,
  27158. * the series color can be set with the `.highcharts-series`,
  27159. * `.highcharts-color-{n}`, `.highcharts-{type}-series` or
  27160. * `.highcharts-series-{n}` class, or individual classes given by the
  27161. * `className` option.
  27162. */
  27163. color?: (ColorString|GradientColorObject|PatternObject);
  27164. /**
  27165. * (Highcharts, Highstock, Highmaps) When using dual or multiple color axes,
  27166. * this number defines which colorAxis the particular series is connected
  27167. * to. It refers to either the axis id or the index of the axis in the
  27168. * colorAxis array, with 0 being the first. Set this option to false to
  27169. * prevent a series from connecting to the default color axis.
  27170. *
  27171. * Since v7.2.0 the option can also be an axis id or an axis index instead
  27172. * of a boolean flag.
  27173. */
  27174. colorAxis?: (boolean|number|string);
  27175. /**
  27176. * (Highcharts) Styled mode only. A specific color index to use for the
  27177. * series, so its graphic representations are given the class name
  27178. * `highcharts-color-{n}`.
  27179. */
  27180. colorIndex?: number;
  27181. /**
  27182. * (Highcharts, Highstock, Highmaps) Determines what data value should be
  27183. * used to calculate point color if `colorAxis` is used. Requires to set
  27184. * `min` and `max` if some custom point property is used or if approximation
  27185. * for data grouping is set to `'sum'`.
  27186. */
  27187. colorKey?: string;
  27188. /**
  27189. * (Highstock) Compare the values of the series against the first non-null,
  27190. * non- zero value in the visible range. The y axis will show percentage or
  27191. * absolute change depending on whether `compare` is set to `"percent"` or
  27192. * `"value"`. When this is applied to multiple series, it allows comparing
  27193. * the development of the series against each other. Adds a `change` field
  27194. * to every point object.
  27195. */
  27196. compare?: string;
  27197. /**
  27198. * (Highstock) When compare is `percent`, this option dictates whether to
  27199. * use 0 or 100 as the base of comparison.
  27200. */
  27201. compareBase?: (0|100);
  27202. /**
  27203. * (Highstock) Defines if comparison should start from the first point
  27204. * within the visible range or should start from the first point **before**
  27205. * the range.
  27206. *
  27207. * In other words, this flag determines if first point within the visible
  27208. * range will have 0% (`compareStart=true`) or should have been already
  27209. * calculated according to the previous point (`compareStart=false`).
  27210. */
  27211. compareStart?: boolean;
  27212. /**
  27213. * (Highcharts) Polar charts only. Whether to connect the ends of a line
  27214. * series plot across the extremes.
  27215. */
  27216. connectEnds?: boolean;
  27217. /**
  27218. * (Gantt) Override Pathfinder connector options for a series. Requires
  27219. * Highcharts Gantt to be loaded.
  27220. */
  27221. connectors?: SeriesConnectorsOptionsObject;
  27222. /**
  27223. * (Highcharts, Highstock, Gantt) When true, each point or column edge is
  27224. * rounded to its nearest pixel in order to render sharp on screen. In some
  27225. * cases, when there are a lot of densely packed columns, this leads to
  27226. * visible difference in column widths or distance between columns. In these
  27227. * cases, setting `crisp` to `false` may look better, even though each
  27228. * column is rendered blurry.
  27229. */
  27230. crisp?: boolean;
  27231. /**
  27232. * (Highcharts, Highstock) When the series contains less points than the
  27233. * crop threshold, all points are drawn, even if the points fall outside the
  27234. * visible plot area at the current zoom. The advantage of drawing all
  27235. * points (including markers and columns), is that animation is performed on
  27236. * updates. On the other hand, when the series contains more points than the
  27237. * crop threshold, the series data is cropped to only contain points that
  27238. * fall within the plot area. The advantage of cropping away invisible
  27239. * points is to increase performance on large series.
  27240. */
  27241. cropThreshold?: number;
  27242. /**
  27243. * (Highcharts) You can set the cursor to "pointer" if you have click events
  27244. * attached to the series, to signal to the user that the points and lines
  27245. * can be clicked.
  27246. *
  27247. * In styled mode, the series cursor can be set with the same classes as
  27248. * listed under series.color.
  27249. */
  27250. cursor?: (string|CursorValue);
  27251. /**
  27252. * (Highcharts) A reserved subspace to store options and values for
  27253. * customized functionality. Here you can add additional data for your own
  27254. * event callbacks and formatter callbacks.
  27255. */
  27256. custom?: Dictionary<any>;
  27257. /**
  27258. * (Highcharts) Name of the dash style to use for the graph, or for some
  27259. * series types the outline of each shape.
  27260. *
  27261. * In styled mode, the stroke dash-array can be set with the same classes as
  27262. * listed under series.color.
  27263. */
  27264. dashStyle?: DashStyleValue;
  27265. /**
  27266. * (Highstock) Data grouping is the concept of sampling the data values into
  27267. * larger blocks in order to ease readability and increase performance of
  27268. * the JavaScript charts. Highstock by default applies data grouping when
  27269. * the points become closer than a certain pixel value, determined by the
  27270. * `groupPixelWidth` option.
  27271. *
  27272. * If data grouping is applied, the grouping information of grouped points
  27273. * can be read from the Point.dataGroup. If point options other than the
  27274. * data itself are set, for example `name` or `color` or custom properties,
  27275. * the grouping logic doesn't know how to group it. In this case the options
  27276. * of the first point instance are copied over to the group point. This can
  27277. * be altered through a custom `approximation` callback function.
  27278. */
  27279. dataGrouping?: DataGroupingOptionsObject;
  27280. /**
  27281. * (Highcharts, Highstock, Highmaps, Gantt) Options for the series data
  27282. * labels, appearing next to each data point.
  27283. *
  27284. * Since v6.2.0, multiple data labels can be applied to each single point by
  27285. * defining them as an array of configs.
  27286. *
  27287. * In styled mode, the data labels can be styled with the
  27288. * `.highcharts-data-label-box` and `.highcharts-data-label` class names
  27289. * (see example).
  27290. */
  27291. dataLabels?: (PlotBellcurveDataLabelsOptions|Array<PlotBellcurveDataLabelsOptions>);
  27292. /**
  27293. * (Highcharts, Highstock) Options for the series data sorting.
  27294. */
  27295. dataSorting?: (DataSortingOptionsObject|PlotBellcurveDataSortingOptions);
  27296. /**
  27297. * (Highcharts) A description of the series to add to the screen reader
  27298. * information about the series.
  27299. */
  27300. description?: string;
  27301. /**
  27302. * (Highcharts) Enable or disable the mouse tracking for a specific series.
  27303. * This includes point tooltips and click events on graphs and points. For
  27304. * large datasets it improves performance.
  27305. */
  27306. enableMouseTracking?: boolean;
  27307. /**
  27308. * (Highcharts) General event handlers for the series items. These event
  27309. * hooks can also be attached to the series at run time using the
  27310. * `Highcharts.addEvent` function.
  27311. */
  27312. events?: SeriesEventsOptionsObject;
  27313. /**
  27314. * (Highcharts, Highstock) Fill color or gradient for the area. When `null`,
  27315. * the series' `color` is used with the series' `fillOpacity`.
  27316. *
  27317. * In styled mode, the fill color can be set with the `.highcharts-area`
  27318. * class name.
  27319. */
  27320. fillColor?: (ColorString|GradientColorObject|PatternObject);
  27321. /**
  27322. * (Highcharts, Highstock) Fill opacity for the area. When you set an
  27323. * explicit `fillColor`, the `fillOpacity` is not applied. Instead, you
  27324. * should define the opacity in the `fillColor` with an rgba color
  27325. * definition. The `fillOpacity` setting, also the default setting,
  27326. * overrides the alpha component of the `color` setting.
  27327. *
  27328. * In styled mode, the fill opacity can be set with the `.highcharts-area`
  27329. * class name.
  27330. */
  27331. fillOpacity?: number;
  27332. /**
  27333. * (Highcharts) Determines whether the series should look for the nearest
  27334. * point in both dimensions or just the x-dimension when hovering the
  27335. * series. Defaults to `'xy'` for scatter series and `'x'` for most other
  27336. * series. If the data has duplicate x-values, it is recommended to set this
  27337. * to `'xy'` to allow hovering over all points.
  27338. *
  27339. * Applies only to series types using nearest neighbor search (not direct
  27340. * hover) for tooltip.
  27341. */
  27342. findNearestPointBy?: OptionsFindNearestPointByValue;
  27343. /**
  27344. * (Highstock) Defines when to display a gap in the graph, together with the
  27345. * gapUnit option.
  27346. *
  27347. * In case when `dataGrouping` is enabled, points can be grouped into a
  27348. * larger time span. This can make the grouped points to have a greater
  27349. * distance than the absolute value of `gapSize` property, which will result
  27350. * in disappearing graph completely. To prevent this situation the mentioned
  27351. * distance between grouped points is used instead of previously defined
  27352. * `gapSize`.
  27353. *
  27354. * In practice, this option is most often used to visualize gaps in time
  27355. * series. In a stock chart, intraday data is available for daytime hours,
  27356. * while gaps will appear in nights and weekends.
  27357. */
  27358. gapSize?: number;
  27359. /**
  27360. * (Highstock) Together with gapSize, this option defines where to draw gaps
  27361. * in the graph.
  27362. *
  27363. * When the `gapUnit` is `"relative"` (default), a gap size of 5 means that
  27364. * if the distance between two points is greater than 5 times that of the
  27365. * two closest points, the graph will be broken.
  27366. *
  27367. * When the `gapUnit` is `"value"`, the gap is based on absolute axis
  27368. * values, which on a datetime axis is milliseconds. This also applies to
  27369. * the navigator series that inherits gap options from the base series.
  27370. */
  27371. gapUnit?: OptionsGapUnitValue;
  27372. /**
  27373. * (Highcharts, Highstock, Gantt) Whether to use the Y extremes of the total
  27374. * chart width or only the zoomed area when zooming in on parts of the X
  27375. * axis. By default, the Y axis adjusts to the min and max of the visible
  27376. * data. Cartesian series only.
  27377. */
  27378. getExtremesFromAll?: boolean;
  27379. /**
  27380. * (Highcharts) When set to `false` will prevent the series data from being
  27381. * included in any form of data export.
  27382. *
  27383. * Since version 6.0.0 until 7.1.0 the option was existing undocumented as
  27384. * `includeInCSVExport`.
  27385. */
  27386. includeInDataExport?: boolean;
  27387. /**
  27388. * (Highcharts) This option allows to define the length of the bell curve. A
  27389. * unit of the length of the bell curve is standard deviation.
  27390. */
  27391. intervals?: number;
  27392. /**
  27393. * (Highmaps) What property to join the `mapData` to the value data. For
  27394. * example, if joinBy is "code", the mapData items with a specific code is
  27395. * merged into the data with the same code. For maps loaded from GeoJSON,
  27396. * the keys may be held in each point's `properties` object.
  27397. *
  27398. * The joinBy option can also be an array of two values, where the first
  27399. * points to a key in the `mapData`, and the second points to another key in
  27400. * the `data`.
  27401. *
  27402. * When joinBy is `null`, the map items are joined by their position in the
  27403. * array, which performs much better in maps with many data points. This is
  27404. * the recommended option if you are printing more than a thousand data
  27405. * points and have a backend that can preprocess the data into a parallel
  27406. * array of the mapData.
  27407. */
  27408. joinBy?: (string|Array<string>);
  27409. /**
  27410. * (Highcharts) An array specifying which option maps to which key in the
  27411. * data point array. This makes it convenient to work with unstructured data
  27412. * arrays from different sources.
  27413. */
  27414. keys?: Array<string>;
  27415. /**
  27416. * (Highcharts, Highstock, Gantt) Series labels are placed as close to the
  27417. * series as possible in a natural way, seeking to avoid other series. The
  27418. * goal of this feature is to make the chart more easily readable, like if a
  27419. * human designer placed the labels in the optimal position.
  27420. *
  27421. * The series labels currently work with series types having a `graph` or an
  27422. * `area`.
  27423. */
  27424. label?: SeriesLabelOptionsObject;
  27425. /**
  27426. * (Highstock) The line marks the last price from all points.
  27427. */
  27428. lastPrice?: SeriesLastPriceOptionsObject;
  27429. /**
  27430. * (Highstock) The line marks the last price from visible range of points.
  27431. */
  27432. lastVisiblePrice?: SeriesLastVisiblePriceOptionsObject;
  27433. /**
  27434. * (Highcharts, Highstock) The SVG value used for the `stroke-linecap` and
  27435. * `stroke-linejoin` of a line graph. Round means that lines are rounded in
  27436. * the ends and bends.
  27437. */
  27438. linecap?: SeriesLinecapValue;
  27439. /**
  27440. * (Highcharts, Highstock) A separate color for the graph line. By default
  27441. * the line takes the `color` of the series, but the lineColor setting
  27442. * allows setting a separate color for the line without altering the
  27443. * `fillColor`.
  27444. *
  27445. * In styled mode, the line stroke can be set with the `.highcharts-graph`
  27446. * class name.
  27447. */
  27448. lineColor?: (ColorString|GradientColorObject|PatternObject);
  27449. /**
  27450. * (Highcharts, Highstock) Pixel width of the graph line.
  27451. */
  27452. lineWidth?: number;
  27453. /**
  27454. * (Highcharts, Highstock, Gantt) The id of another series to link to.
  27455. * Additionally, the value can be ":previous" to link to the previous
  27456. * series. When two series are linked, only the first one appears in the
  27457. * legend. Toggling the visibility of this also toggles the linked series.
  27458. *
  27459. * If master series uses data sorting and linked series does not have its
  27460. * own sorting definition, the linked series will be sorted in the same
  27461. * order as the master one.
  27462. */
  27463. linkedTo?: string;
  27464. /**
  27465. * (Highcharts) Options for the point markers of line-like series.
  27466. * Properties like `fillColor`, `lineColor` and `lineWidth` define the
  27467. * visual appearance of the markers. Other series types, like column series,
  27468. * don't have markers, but have visual options on the series level instead.
  27469. *
  27470. * In styled mode, the markers can be styled with the `.highcharts-point`,
  27471. * `.highcharts-point-hover` and `.highcharts-point-select` class names.
  27472. */
  27473. marker?: PointMarkerOptionsObject;
  27474. /**
  27475. * (Highstock) Options for the corresponding navigator series if
  27476. * `showInNavigator` is `true` for this series. Available options are the
  27477. * same as any series, documented at plotOptions and series.
  27478. *
  27479. * These options are merged with options in navigator.series, and will take
  27480. * precedence if the same option is defined both places.
  27481. */
  27482. navigatorOptions?: PlotSeriesOptions;
  27483. /**
  27484. * (Highcharts) The color for the parts of the graph or points that are
  27485. * below the threshold. Note that `zones` takes precedence over the negative
  27486. * color. Using `negativeColor` is equivalent to applying a zone with value
  27487. * of 0.
  27488. */
  27489. negativeColor?: (ColorString|GradientColorObject|PatternObject);
  27490. /**
  27491. * (Highcharts) A separate color for the negative part of the area.
  27492. *
  27493. * In styled mode, a negative color is set with the `.highcharts-negative`
  27494. * class name.
  27495. */
  27496. negativeFillColor?: (ColorString|GradientColorObject|PatternObject);
  27497. /**
  27498. * (Highcharts) Opacity of a series parts: line, fill (e.g. area) and
  27499. * dataLabels.
  27500. */
  27501. opacity?: number;
  27502. /**
  27503. * (Highcharts) Properties for each single point.
  27504. */
  27505. point?: PlotSeriesPointOptions;
  27506. /**
  27507. * (Highcharts) Same as accessibility.pointDescriptionFormatter, but for an
  27508. * individual series. Overrides the chart wide configuration.
  27509. */
  27510. pointDescriptionFormatter?: Function;
  27511. /**
  27512. * (Highcharts, Highstock, Gantt) Possible values: `"on"`, `"between"`,
  27513. * `number`.
  27514. *
  27515. * In a column chart, when pointPlacement is `"on"`, the point will not
  27516. * create any padding of the X axis. In a polar column chart this means that
  27517. * the first column points directly north. If the pointPlacement is
  27518. * `"between"`, the columns will be laid out between ticks. This is useful
  27519. * for example for visualising an amount between two points in time or in a
  27520. * certain sector of a polar chart.
  27521. *
  27522. * Since Highcharts 3.0.2, the point placement can also be numeric, where 0
  27523. * is on the axis value, -0.5 is between this value and the previous, and
  27524. * 0.5 is between this value and the next. Unlike the textual options,
  27525. * numeric point placement options won't affect axis padding.
  27526. *
  27527. * Note that pointPlacement needs a pointRange to work. For column series
  27528. * this is computed, but for line-type series it needs to be set.
  27529. *
  27530. * For the `xrange` series type and gantt charts, if the Y axis is a
  27531. * category axis, the `pointPlacement` applies to the Y axis rather than the
  27532. * (typically datetime) X axis.
  27533. *
  27534. * Defaults to `undefined` in cartesian charts, `"between"` in polar charts.
  27535. */
  27536. pointPlacement?: (number|string);
  27537. /**
  27538. * (Highstock) The width of each point on the x axis. For example in a
  27539. * column chart with one value each day, the pointRange would be 1 day (= 24
  27540. * * 3600
  27541. *
  27542. * * 1000 milliseconds). This is normally computed automatically, but this
  27543. * option can be used to override the automatic value.
  27544. */
  27545. pointRange?: number;
  27546. /**
  27547. * (Highcharts) Defines how many points should be plotted within 1 interval.
  27548. * See `plotOptions.bellcurve.intervals`.
  27549. */
  27550. pointsInInterval?: number;
  27551. /**
  27552. * (Highcharts, Highstock, Gantt) If no x values are given for the points in
  27553. * a series, pointStart defines on what value to start. For example, if a
  27554. * series contains one yearly value starting from 1945, set pointStart to
  27555. * 1945.
  27556. */
  27557. pointStart?: number;
  27558. /**
  27559. * (Highcharts) Whether to select the series initially. If `showCheckbox` is
  27560. * true, the checkbox next to the series name in the legend will be checked
  27561. * for a selected series.
  27562. */
  27563. selected?: boolean;
  27564. /**
  27565. * (Highcharts) Whether to apply a drop shadow to the graph line. Since 2.3
  27566. * the shadow can be an object configuration containing `color`, `offsetX`,
  27567. * `offsetY`, `opacity` and `width`.
  27568. */
  27569. shadow?: (boolean|ShadowOptionsObject);
  27570. /**
  27571. * (Highcharts) If true, a checkbox is displayed next to the legend item to
  27572. * allow selecting the series. The state of the checkbox is determined by
  27573. * the `selected` option.
  27574. */
  27575. showCheckbox?: boolean;
  27576. /**
  27577. * (Highcharts) Whether to display this particular series or series type in
  27578. * the legend. Standalone series are shown in legend by default, and linked
  27579. * series are not. Since v7.2.0 it is possible to show series that use
  27580. * colorAxis by setting this option to `true`.
  27581. */
  27582. showInLegend?: boolean;
  27583. /**
  27584. * (Highstock) Whether or not to show the series in the navigator. Takes
  27585. * precedence over navigator.baseSeries if defined.
  27586. */
  27587. showInNavigator?: boolean;
  27588. /**
  27589. * (Highcharts) If set to `true`, the accessibility module will skip past
  27590. * the points in this series for keyboard navigation.
  27591. */
  27592. skipKeyboardNavigation?: boolean;
  27593. /**
  27594. * (Highcharts, Highstock) When this is true, the series will not cause the
  27595. * Y axis to cross the zero plane (or threshold option) unless the data
  27596. * actually crosses the plane.
  27597. *
  27598. * For example, if `softThreshold` is `false`, a series of 0, 1, 2, 3 will
  27599. * make the Y axis show negative values according to the `minPadding`
  27600. * option. If `softThreshold` is `true`, the Y axis starts at 0.
  27601. */
  27602. softThreshold?: boolean;
  27603. states?: SeriesStatesOptionsObject;
  27604. /**
  27605. * (Highcharts) Sticky tracking of mouse events. When true, the `mouseOut`
  27606. * event on a series isn't triggered until the mouse moves over another
  27607. * series, or out of the plot area. When false, the `mouseOut` event on a
  27608. * series is triggered when the mouse leaves the area around the series'
  27609. * graph or markers. This also implies the tooltip when not shared. When
  27610. * `stickyTracking` is false and `tooltip.shared` is false, the tooltip will
  27611. * be hidden when moving the mouse between series. Defaults to true for line
  27612. * and area type series, but to false for columns, pies etc.
  27613. *
  27614. * **Note:** The boost module will force this option because of technical
  27615. * limitations.
  27616. */
  27617. stickyTracking?: boolean;
  27618. /**
  27619. * (Highcharts, Highstock) The Y axis value to serve as the base for the
  27620. * area, for distinguishing between values above and below a threshold. The
  27621. * area between the graph and the threshold is filled.
  27622. *
  27623. * * If a number is given, the Y axis will scale to the threshold.
  27624. *
  27625. * * If `null`, the scaling behaves like a line series with fill between the
  27626. * graph and the Y axis minimum.
  27627. *
  27628. * * If `Infinity` or `-Infinity`, the area between the graph and the
  27629. * corresponding Y axis extreme is filled (since v6.1.0).
  27630. */
  27631. threshold?: (number|null);
  27632. /**
  27633. * (Highcharts) A configuration object for the tooltip rendering of each
  27634. * single series. Properties are inherited from tooltip, but only the
  27635. * following properties can be defined on a series level.
  27636. */
  27637. tooltip?: SeriesTooltipOptionsObject;
  27638. /**
  27639. * (Highcharts, Highstock) Whether the whole area or just the line should
  27640. * respond to mouseover tooltips and other mouse or touch events.
  27641. */
  27642. trackByArea?: boolean;
  27643. /**
  27644. * (Highcharts, Highstock, Gantt) When a series contains a data array that
  27645. * is longer than this, only one dimensional arrays of numbers, or two
  27646. * dimensional arrays with x and y values are allowed. Also, only the first
  27647. * point is tested, and the rest are assumed to be the same format. This
  27648. * saves expensive data checking and indexing in long series. Set it to `0`
  27649. * disable.
  27650. *
  27651. * Note: In boost mode turbo threshold is forced. Only array of numbers or
  27652. * two dimensional arrays are allowed.
  27653. */
  27654. turboThreshold?: number;
  27655. /**
  27656. * (Highcharts) Set the initial visibility of the series.
  27657. */
  27658. visible?: boolean;
  27659. /**
  27660. * (Highmaps) Define the z index of the series.
  27661. */
  27662. zIndex?: number;
  27663. /**
  27664. * (Highcharts, Highstock) Defines the Axis on which the zones are applied.
  27665. */
  27666. zoneAxis?: string;
  27667. /**
  27668. * (Highcharts, Highstock) An array defining zones within a series. Zones
  27669. * can be applied to the X axis, Y axis or Z axis for bubbles, according to
  27670. * the `zoneAxis` option. The zone definitions have to be in ascending order
  27671. * regarding to the value.
  27672. *
  27673. * In styled mode, the color zones are styled with the
  27674. * `.highcharts-zone-{n}` class, or custom classed from the `className`
  27675. * option (view live demo).
  27676. */
  27677. zones?: Array<SeriesZonesOptionsObject>;
  27678. }
  27679. /**
  27680. * (Highcharts) Enable or disable the initial animation when a series is
  27681. * displayed. The animation can also be set as a configuration object. Please
  27682. * note that this option only applies to the initial animation of the series
  27683. * itself. For other animations, see chart.animation and the animation parameter
  27684. * under the API methods. The following properties are supported:
  27685. *
  27686. * - `defer`: The animation delay time in milliseconds.
  27687. *
  27688. * - `duration`: The duration of the animation in milliseconds.
  27689. *
  27690. * - `easing`: Can be a string reference to an easing function set on the `Math`
  27691. * object or a function. See the _Custom easing function_ demo below.
  27692. *
  27693. * Due to poor performance, animation is disabled in old IE browsers for several
  27694. * chart types.
  27695. */
  27696. export interface PlotBoxplotAnimationOptions {
  27697. defer?: number;
  27698. }
  27699. /**
  27700. * (Highcharts, Highstock, Highmaps, Gantt) Enable or disable the initial
  27701. * animation when a series is displayed for the `dataLabels`. The animation can
  27702. * also be set as a configuration object. Please note that this option only
  27703. * applies to the initial animation. For other animations, see chart.animation
  27704. * and the animation parameter under the API methods. The following properties
  27705. * are supported:
  27706. *
  27707. * - `defer`: The animation delay time in milliseconds.
  27708. */
  27709. export interface PlotBoxplotDataLabelsAnimationOptions {
  27710. /**
  27711. * (Highcharts, Highstock, Highmaps, Gantt) The animation delay time in
  27712. * milliseconds. Set to `0` renders dataLabel immediately. As `undefined`
  27713. * inherits defer time from the series.animation.defer.
  27714. */
  27715. defer?: number;
  27716. }
  27717. /**
  27718. * (Highcharts, Highstock, Highmaps, Gantt) Options for the series data labels,
  27719. * appearing next to each data point.
  27720. *
  27721. * Since v6.2.0, multiple data labels can be applied to each single point by
  27722. * defining them as an array of configs.
  27723. *
  27724. * In styled mode, the data labels can be styled with the
  27725. * `.highcharts-data-label-box` and `.highcharts-data-label` class names (see
  27726. * example).
  27727. */
  27728. export interface PlotBoxplotDataLabelsOptions {
  27729. /**
  27730. * (Highcharts, Highstock, Highmaps, Gantt) The alignment of the data label
  27731. * compared to the point. If `right`, the right side of the label should be
  27732. * touching the point. For points with an extent, like columns, the
  27733. * alignments also dictates how to align it inside the box, as given with
  27734. * the inside option. Can be one of `left`, `center` or `right`.
  27735. */
  27736. align?: string;
  27737. /**
  27738. * (Highcharts, Highstock, Highmaps, Gantt) Whether to allow data labels to
  27739. * overlap. To make the labels less sensitive for overlapping, the
  27740. * dataLabels.padding can be set to 0.
  27741. */
  27742. allowOverlap?: boolean;
  27743. /**
  27744. * (Highcharts, Highstock, Highmaps, Gantt) Enable or disable the initial
  27745. * animation when a series is displayed for the `dataLabels`. The animation
  27746. * can also be set as a configuration object. Please note that this option
  27747. * only applies to the initial animation. For other animations, see
  27748. * chart.animation and the animation parameter under the API methods. The
  27749. * following properties are supported:
  27750. *
  27751. * - `defer`: The animation delay time in milliseconds.
  27752. */
  27753. animation?: (boolean|PlotBoxplotDataLabelsAnimationOptions|Partial<AnimationOptionsObject>);
  27754. /**
  27755. * (Highcharts, Highstock, Highmaps, Gantt) The background color or gradient
  27756. * for the data label.
  27757. */
  27758. backgroundColor?: (ColorString|GradientColorObject|PatternObject);
  27759. /**
  27760. * (Highcharts, Highstock, Highmaps, Gantt) The border color for the data
  27761. * label. Defaults to `undefined`.
  27762. */
  27763. borderColor?: (ColorString|GradientColorObject|PatternObject);
  27764. /**
  27765. * (Highcharts, Highstock, Highmaps, Gantt) The border radius in pixels for
  27766. * the data label.
  27767. */
  27768. borderRadius?: number;
  27769. /**
  27770. * (Highcharts, Highstock, Highmaps, Gantt) The border width in pixels for
  27771. * the data label.
  27772. */
  27773. borderWidth?: number;
  27774. /**
  27775. * (Highcharts, Highstock, Highmaps, Gantt) A class name for the data label.
  27776. * Particularly in styled mode, this can be used to give each series' or
  27777. * point's data label unique styling. In addition to this option, a default
  27778. * color class name is added so that we can give the labels a contrast text
  27779. * shadow.
  27780. */
  27781. className?: string;
  27782. /**
  27783. * (Highcharts, Highstock, Highmaps, Gantt) The text color for the data
  27784. * labels. Defaults to `undefined`. For certain series types, like column or
  27785. * map, the data labels can be drawn inside the points. In this case the
  27786. * data label will be drawn with maximum contrast by default. Additionally,
  27787. * it will be given a `text-outline` style with the opposite color, to
  27788. * further increase the contrast. This can be overridden by setting the
  27789. * `text-outline` style to `none` in the `dataLabels.style` option.
  27790. */
  27791. color?: (ColorString|GradientColorObject|PatternObject);
  27792. /**
  27793. * (Highcharts, Highstock, Highmaps, Gantt) Whether to hide data labels that
  27794. * are outside the plot area. By default, the data label is moved inside the
  27795. * plot area according to the overflow option.
  27796. */
  27797. crop?: boolean;
  27798. /**
  27799. * (Highcharts, Highstock, Gantt) Whether to defer displaying the data
  27800. * labels until the initial series animation has finished. Setting to
  27801. * `false` renders the data label immediately. If set to `true` inherits the
  27802. * defer time set in plotOptions.series.animation.
  27803. */
  27804. defer?: boolean;
  27805. /**
  27806. * (Highcharts, Highstock, Highmaps, Gantt) Enable or disable the data
  27807. * labels.
  27808. */
  27809. enabled?: boolean;
  27810. /**
  27811. * (Highcharts, Highstock, Highmaps, Gantt) A declarative filter to control
  27812. * of which data labels to display. The declarative filter is designed for
  27813. * use when callback functions are not available, like when the chart
  27814. * options require a pure JSON structure or for use with graphical editors.
  27815. * For programmatic control, use the `formatter` instead, and return
  27816. * `undefined` to disable a single data label.
  27817. */
  27818. filter?: DataLabelsFilterOptionsObject;
  27819. /**
  27820. * (Highcharts, Highstock, Highmaps, Gantt) A format string for the data
  27821. * label. Available variables are the same as for `formatter`.
  27822. */
  27823. format?: string;
  27824. /**
  27825. * (Highcharts, Highstock, Highmaps, Gantt) Callback JavaScript function to
  27826. * format the data label. Note that if a `format` is defined, the format
  27827. * takes precedence and the formatter is ignored.
  27828. */
  27829. formatter?: DataLabelsFormatterCallbackFunction;
  27830. /**
  27831. * (Highcharts, Highstock, Highmaps, Gantt) For points with an extent, like
  27832. * columns or map areas, whether to align the data label inside the box or
  27833. * to the actual value point. Defaults to `false` in most cases, `true` in
  27834. * stacked columns.
  27835. */
  27836. inside?: boolean;
  27837. /**
  27838. * (Highcharts, Highstock, Highmaps, Gantt) Format for points with the value
  27839. * of null. Works analogously to format. `nullFormat` can be applied only to
  27840. * series which support displaying null points.
  27841. */
  27842. nullFormat?: (boolean|string);
  27843. /**
  27844. * (Highcharts, Highstock, Highmaps, Gantt) Callback JavaScript function
  27845. * that defines formatting for points with the value of null. Works
  27846. * analogously to formatter. `nullPointFormatter` can be applied only to
  27847. * series which support displaying null points.
  27848. */
  27849. nullFormatter?: DataLabelsFormatterCallbackFunction;
  27850. /**
  27851. * (Highcharts, Highstock, Highmaps, Gantt) How to handle data labels that
  27852. * flow outside the plot area. The default is `"justify"`, which aligns them
  27853. * inside the plot area. For columns and bars, this means it will be moved
  27854. * inside the bar. To display data labels outside the plot area, set `crop`
  27855. * to `false` and `overflow` to `"allow"`.
  27856. */
  27857. overflow?: DataLabelsOverflowValue;
  27858. /**
  27859. * (Highcharts, Highstock, Highmaps, Gantt) When either the `borderWidth` or
  27860. * the `backgroundColor` is set, this is the padding within the box.
  27861. */
  27862. padding?: number;
  27863. /**
  27864. * (Highcharts, Highstock, Highmaps, Gantt) Aligns data labels relative to
  27865. * points. If `center` alignment is not possible, it defaults to `right`.
  27866. */
  27867. position?: AlignValue;
  27868. /**
  27869. * (Highcharts, Highstock, Highmaps, Gantt) Text rotation in degrees. Note
  27870. * that due to a more complex structure, backgrounds, borders and padding
  27871. * will be lost on a rotated data label.
  27872. */
  27873. rotation?: number;
  27874. /**
  27875. * (Highcharts, Highstock, Highmaps, Gantt) The shadow of the box. Works
  27876. * best with `borderWidth` or `backgroundColor`. Since 2.3 the shadow can be
  27877. * an object configuration containing `color`, `offsetX`, `offsetY`,
  27878. * `opacity` and `width`.
  27879. */
  27880. shadow?: (boolean|ShadowOptionsObject);
  27881. /**
  27882. * (Highcharts, Highstock, Highmaps, Gantt) The name of a symbol to use for
  27883. * the border around the label. Symbols are predefined functions on the
  27884. * Renderer object.
  27885. */
  27886. shape?: string;
  27887. /**
  27888. * (Highcharts, Highstock, Highmaps, Gantt) Styles for the label. The
  27889. * default `color` setting is `"contrast"`, which is a pseudo color that
  27890. * Highcharts picks up and applies the maximum contrast to the underlying
  27891. * point item, for example the bar in a bar chart.
  27892. *
  27893. * The `textOutline` is a pseudo property that applies an outline of the
  27894. * given width with the given color, which by default is the maximum
  27895. * contrast to the text. So a bright text color will result in a black text
  27896. * outline for maximum readability on a mixed background. In some cases,
  27897. * especially with grayscale text, the text outline doesn't work well, in
  27898. * which cases it can be disabled by setting it to `"none"`. When `useHTML`
  27899. * is true, the `textOutline` will not be picked up. In this, case, the same
  27900. * effect can be acheived through the `text-shadow` CSS property.
  27901. *
  27902. * For some series types, where each point has an extent, like for example
  27903. * tree maps, the data label may overflow the point. There are two
  27904. * strategies for handling overflow. By default, the text will wrap to
  27905. * multiple lines. The other strategy is to set `style.textOverflow` to
  27906. * `ellipsis`, which will keep the text on one line plus it will break
  27907. * inside long words.
  27908. */
  27909. style?: CSSObject;
  27910. /**
  27911. * (Highcharts, Highstock, Highmaps, Gantt) Options for a label text which
  27912. * should follow marker's shape. Border and background are disabled for a
  27913. * label that follows a path.
  27914. *
  27915. * **Note:** Only SVG-based renderer supports this option. Setting `useHTML`
  27916. * to true will disable this option.
  27917. */
  27918. textPath?: DataLabelsTextPathOptionsObject;
  27919. /**
  27920. * (Highcharts, Highstock, Highmaps, Gantt) Whether to use HTML to render
  27921. * the labels.
  27922. */
  27923. useHTML?: boolean;
  27924. /**
  27925. * (Highcharts, Highstock, Highmaps, Gantt) The vertical alignment of a data
  27926. * label. Can be one of `top`, `middle` or `bottom`. The default value
  27927. * depends on the data, for instance in a column chart, the label is above
  27928. * positive values and below negative values.
  27929. */
  27930. verticalAlign?: string;
  27931. /**
  27932. * (Highcharts, Highstock, Highmaps, Gantt) The x position offset of the
  27933. * label relative to the point in pixels.
  27934. */
  27935. x?: number;
  27936. /**
  27937. * (Highcharts, Highstock, Highmaps, Gantt) The y position offset of the
  27938. * label relative to the point in pixels.
  27939. */
  27940. y?: number;
  27941. /**
  27942. * (Highcharts, Highstock, Highmaps, Gantt) The Z index of the data labels.
  27943. * The default Z index puts it above the series. Use a Z index of 2 to
  27944. * display it behind the series.
  27945. */
  27946. z?: number;
  27947. }
  27948. /**
  27949. * (Highcharts, Highstock) Options for the series data sorting.
  27950. */
  27951. export interface PlotBoxplotDataSortingOptions {
  27952. /**
  27953. * (Highcharts, Highstock) Enable or disable data sorting for the series.
  27954. * Use xAxis.reversed to change the sorting order.
  27955. */
  27956. enabled?: boolean;
  27957. /**
  27958. * (Highcharts, Highstock) Whether to allow matching points by name in an
  27959. * update. If this option is disabled, points will be matched by order.
  27960. */
  27961. matchByName?: boolean;
  27962. /**
  27963. * (Highcharts, Highstock) Determines what data value should be used to sort
  27964. * by.
  27965. */
  27966. sortKey?: string;
  27967. }
  27968. /**
  27969. * (Highcharts) Style options for the guide box. The guide box has one state by
  27970. * default, the `default` state.
  27971. */
  27972. export interface PlotBoxplotDragDropGuideBoxOptions {
  27973. /**
  27974. * (Highcharts) Style options for the guide box default state.
  27975. */
  27976. default?: DragDropGuideBoxOptionsObject;
  27977. }
  27978. /**
  27979. * (Highcharts) A box plot is a convenient way of depicting groups of data
  27980. * through their five-number summaries: the smallest observation (sample
  27981. * minimum), lower quartile (Q1), median (Q2), upper quartile (Q3), and largest
  27982. * observation (sample maximum).
  27983. *
  27984. * In TypeScript the type option must always be set.
  27985. *
  27986. * Configuration options for the series are given in three levels:
  27987. *
  27988. * 1. Options for all series in a chart are defined in the plotOptions.series
  27989. * object.
  27990. *
  27991. * 2. Options for all `boxplot` series are defined in plotOptions.boxplot.
  27992. *
  27993. * 3. Options for one single series are given in the series instance array. (see
  27994. * online documentation for example)
  27995. */
  27996. export interface PlotBoxplotOptions {
  27997. /**
  27998. * (Highcharts) Accessibility options for a series.
  27999. */
  28000. accessibility?: SeriesAccessibilityOptionsObject;
  28001. /**
  28002. * (Highmaps) Whether all areas of the map defined in `mapData` should be
  28003. * rendered. If `true`, areas which don't correspond to a data point, are
  28004. * rendered as `null` points. If `false`, those areas are skipped.
  28005. */
  28006. allAreas?: boolean;
  28007. /**
  28008. * (Highcharts) Allow this series' points to be selected by clicking on the
  28009. * graphic (columns, point markers, pie slices, map areas etc).
  28010. *
  28011. * The selected points can be handled by point select and unselect events,
  28012. * or collectively by the getSelectedPoints function.
  28013. *
  28014. * And alternative way of selecting points is through dragging.
  28015. */
  28016. allowPointSelect?: boolean;
  28017. /**
  28018. * (Highcharts) Enable or disable the initial animation when a series is
  28019. * displayed. The animation can also be set as a configuration object.
  28020. * Please note that this option only applies to the initial animation of the
  28021. * series itself. For other animations, see chart.animation and the
  28022. * animation parameter under the API methods. The following properties are
  28023. * supported:
  28024. *
  28025. * - `defer`: The animation delay time in milliseconds.
  28026. *
  28027. * - `duration`: The duration of the animation in milliseconds.
  28028. *
  28029. * - `easing`: Can be a string reference to an easing function set on the
  28030. * `Math` object or a function. See the _Custom easing function_ demo below.
  28031. *
  28032. * Due to poor performance, animation is disabled in old IE browsers for
  28033. * several chart types.
  28034. */
  28035. animation?: (boolean|PlotBoxplotAnimationOptions|Partial<AnimationOptionsObject>);
  28036. /**
  28037. * (Highcharts) For some series, there is a limit that shuts down initial
  28038. * animation by default when the total number of points in the chart is too
  28039. * high. For example, for a column chart and its derivatives, animation does
  28040. * not run if there is more than 250 points totally. To disable this cap,
  28041. * set `animationLimit` to `Infinity`.
  28042. */
  28043. animationLimit?: number;
  28044. /**
  28045. * (Highcharts) The dash style of the box.
  28046. */
  28047. boxDashStyle?: DashStyleValue;
  28048. /**
  28049. * (Highcharts, Highstock, Gantt) When `true`, the columns will center in
  28050. * the category, ignoring null or missing points. When `false`, space will
  28051. * be reserved for null or missing points.
  28052. */
  28053. centerInCategory?: boolean;
  28054. /**
  28055. * (Highcharts) An additional class name to apply to the series' graphical
  28056. * elements. This option does not replace default class names of the
  28057. * graphical element.
  28058. */
  28059. className?: string;
  28060. /**
  28061. * (Highcharts) Disable this option to allow series rendering in the whole
  28062. * plotting area.
  28063. *
  28064. * **Note:** Clipping should be always enabled when chart.zoomType is set
  28065. */
  28066. clip?: boolean;
  28067. /**
  28068. * (Highcharts) The main color of the series. In line type series it applies
  28069. * to the line and the point markers unless otherwise specified. In bar type
  28070. * series it applies to the bars unless a color is specified per point. The
  28071. * default value is pulled from the `options.colors` array.
  28072. *
  28073. * In styled mode, the color can be defined by the colorIndex option. Also,
  28074. * the series color can be set with the `.highcharts-series`,
  28075. * `.highcharts-color-{n}`, `.highcharts-{type}-series` or
  28076. * `.highcharts-series-{n}` class, or individual classes given by the
  28077. * `className` option.
  28078. */
  28079. color?: (ColorString|GradientColorObject|PatternObject);
  28080. /**
  28081. * (Highcharts, Highstock, Highmaps) When using dual or multiple color axes,
  28082. * this number defines which colorAxis the particular series is connected
  28083. * to. It refers to either the axis id or the index of the axis in the
  28084. * colorAxis array, with 0 being the first. Set this option to false to
  28085. * prevent a series from connecting to the default color axis.
  28086. *
  28087. * Since v7.2.0 the option can also be an axis id or an axis index instead
  28088. * of a boolean flag.
  28089. */
  28090. colorAxis?: (boolean|number|string);
  28091. /**
  28092. * (Highcharts, Highstock, Gantt) When using automatic point colors pulled
  28093. * from the global colors or series-specific plotOptions.column.colors
  28094. * collections, this option determines whether the chart should receive one
  28095. * color per series or one color per point.
  28096. *
  28097. * In styled mode, the `colors` or `series.colors` arrays are not supported,
  28098. * and instead this option gives the points individual color class names on
  28099. * the form `highcharts-color-{n}`.
  28100. */
  28101. colorByPoint?: boolean;
  28102. /**
  28103. * (Highcharts) Styled mode only. A specific color index to use for the
  28104. * series, so its graphic representations are given the class name
  28105. * `highcharts-color-{n}`.
  28106. */
  28107. colorIndex?: number;
  28108. /**
  28109. * (Highcharts, Highstock, Highmaps) Determines what data value should be
  28110. * used to calculate point color if `colorAxis` is used. Requires to set
  28111. * `min` and `max` if some custom point property is used or if approximation
  28112. * for data grouping is set to `'sum'`.
  28113. */
  28114. colorKey?: string;
  28115. /**
  28116. * (Highcharts, Highstock, Gantt) A series specific or series type specific
  28117. * color set to apply instead of the global colors when colorByPoint is
  28118. * true.
  28119. */
  28120. colors?: Array<(ColorString|GradientColorObject|PatternObject)>;
  28121. /**
  28122. * (Highstock) Compare the values of the series against the first non-null,
  28123. * non- zero value in the visible range. The y axis will show percentage or
  28124. * absolute change depending on whether `compare` is set to `"percent"` or
  28125. * `"value"`. When this is applied to multiple series, it allows comparing
  28126. * the development of the series against each other. Adds a `change` field
  28127. * to every point object.
  28128. */
  28129. compare?: string;
  28130. /**
  28131. * (Highstock) When compare is `percent`, this option dictates whether to
  28132. * use 0 or 100 as the base of comparison.
  28133. */
  28134. compareBase?: (0|100);
  28135. /**
  28136. * (Highstock) Defines if comparison should start from the first point
  28137. * within the visible range or should start from the first point **before**
  28138. * the range.
  28139. *
  28140. * In other words, this flag determines if first point within the visible
  28141. * range will have 0% (`compareStart=true`) or should have been already
  28142. * calculated according to the previous point (`compareStart=false`).
  28143. */
  28144. compareStart?: boolean;
  28145. /**
  28146. * (Gantt) Override Pathfinder connector options for a series. Requires
  28147. * Highcharts Gantt to be loaded.
  28148. */
  28149. connectors?: SeriesConnectorsOptionsObject;
  28150. /**
  28151. * (Highcharts, Highstock, Gantt) When true, each point or column edge is
  28152. * rounded to its nearest pixel in order to render sharp on screen. In some
  28153. * cases, when there are a lot of densely packed columns, this leads to
  28154. * visible difference in column widths or distance between columns. In these
  28155. * cases, setting `crisp` to `false` may look better, even though each
  28156. * column is rendered blurry.
  28157. */
  28158. crisp?: boolean;
  28159. /**
  28160. * (Highcharts, Highstock, Gantt) When the series contains less points than
  28161. * the crop threshold, all points are drawn, event if the points fall
  28162. * outside the visible plot area at the current zoom. The advantage of
  28163. * drawing all points (including markers and columns), is that animation is
  28164. * performed on updates. On the other hand, when the series contains more
  28165. * points than the crop threshold, the series data is cropped to only
  28166. * contain points that fall within the plot area. The advantage of cropping
  28167. * away invisible points is to increase performance on large series.
  28168. */
  28169. cropThreshold?: number;
  28170. /**
  28171. * (Highcharts) You can set the cursor to "pointer" if you have click events
  28172. * attached to the series, to signal to the user that the points and lines
  28173. * can be clicked.
  28174. *
  28175. * In styled mode, the series cursor can be set with the same classes as
  28176. * listed under series.color.
  28177. */
  28178. cursor?: (string|CursorValue);
  28179. /**
  28180. * (Highcharts) A reserved subspace to store options and values for
  28181. * customized functionality. Here you can add additional data for your own
  28182. * event callbacks and formatter callbacks.
  28183. */
  28184. custom?: Dictionary<any>;
  28185. /**
  28186. * (Highcharts) Name of the dash style to use for the graph, or for some
  28187. * series types the outline of each shape.
  28188. *
  28189. * In styled mode, the stroke dash-array can be set with the same classes as
  28190. * listed under series.color.
  28191. */
  28192. dashStyle?: DashStyleValue;
  28193. /**
  28194. * (Highstock) Data grouping is the concept of sampling the data values into
  28195. * larger blocks in order to ease readability and increase performance of
  28196. * the JavaScript charts. Highstock by default applies data grouping when
  28197. * the points become closer than a certain pixel value, determined by the
  28198. * `groupPixelWidth` option.
  28199. *
  28200. * If data grouping is applied, the grouping information of grouped points
  28201. * can be read from the Point.dataGroup. If point options other than the
  28202. * data itself are set, for example `name` or `color` or custom properties,
  28203. * the grouping logic doesn't know how to group it. In this case the options
  28204. * of the first point instance are copied over to the group point. This can
  28205. * be altered through a custom `approximation` callback function.
  28206. */
  28207. dataGrouping?: DataGroupingOptionsObject;
  28208. /**
  28209. * (Highcharts, Highstock, Highmaps, Gantt) Options for the series data
  28210. * labels, appearing next to each data point.
  28211. *
  28212. * Since v6.2.0, multiple data labels can be applied to each single point by
  28213. * defining them as an array of configs.
  28214. *
  28215. * In styled mode, the data labels can be styled with the
  28216. * `.highcharts-data-label-box` and `.highcharts-data-label` class names
  28217. * (see example).
  28218. */
  28219. dataLabels?: (PlotBoxplotDataLabelsOptions|Array<PlotBoxplotDataLabelsOptions>);
  28220. /**
  28221. * (Highcharts, Highstock) Options for the series data sorting.
  28222. */
  28223. dataSorting?: (DataSortingOptionsObject|PlotBoxplotDataSortingOptions);
  28224. /**
  28225. * (Highcharts) Depth of the columns in a 3D column chart.
  28226. */
  28227. depth?: number;
  28228. /**
  28229. * (Highcharts) A description of the series to add to the screen reader
  28230. * information about the series.
  28231. */
  28232. description?: string;
  28233. /**
  28234. * (Highcharts) The draggable-points module allows points to be moved around
  28235. * or modified in the chart. In addition to the options mentioned under the
  28236. * `dragDrop` API structure, the module fires three events, point.dragStart,
  28237. * point.drag and point.drop.
  28238. */
  28239. dragDrop?: SeriesDragDropOptionsObject;
  28240. /**
  28241. * (Highcharts) 3D columns only. The color of the edges. Similar to
  28242. * `borderColor`, except it defaults to the same color as the column.
  28243. */
  28244. edgeColor?: ColorString;
  28245. /**
  28246. * (Highcharts) 3D columns only. The width of the colored edges.
  28247. */
  28248. edgeWidth?: number;
  28249. /**
  28250. * (Highcharts) Enable or disable the mouse tracking for a specific series.
  28251. * This includes point tooltips and click events on graphs and points. For
  28252. * large datasets it improves performance.
  28253. */
  28254. enableMouseTracking?: boolean;
  28255. /**
  28256. * (Highcharts) General event handlers for the series items. These event
  28257. * hooks can also be attached to the series at run time using the
  28258. * `Highcharts.addEvent` function.
  28259. */
  28260. events?: SeriesEventsOptionsObject;
  28261. /**
  28262. * (Highcharts) The fill color of the box.
  28263. *
  28264. * In styled mode, the fill color can be set with the
  28265. * `.highcharts-boxplot-box` class.
  28266. */
  28267. fillColor?: (ColorString|GradientColorObject|PatternObject);
  28268. /**
  28269. * (Highcharts) Determines whether the series should look for the nearest
  28270. * point in both dimensions or just the x-dimension when hovering the
  28271. * series. Defaults to `'xy'` for scatter series and `'x'` for most other
  28272. * series. If the data has duplicate x-values, it is recommended to set this
  28273. * to `'xy'` to allow hovering over all points.
  28274. *
  28275. * Applies only to series types using nearest neighbor search (not direct
  28276. * hover) for tooltip.
  28277. */
  28278. findNearestPointBy?: OptionsFindNearestPointByValue;
  28279. /**
  28280. * (Highcharts, Highstock, Gantt) Whether to use the Y extremes of the total
  28281. * chart width or only the zoomed area when zooming in on parts of the X
  28282. * axis. By default, the Y axis adjusts to the min and max of the visible
  28283. * data. Cartesian series only.
  28284. */
  28285. getExtremesFromAll?: boolean;
  28286. /**
  28287. * (Highcharts, Highstock, Gantt) Whether to group non-stacked columns or to
  28288. * let them render independent of each other. Non-grouped columns will be
  28289. * laid out individually and overlap each other.
  28290. */
  28291. grouping?: boolean;
  28292. /**
  28293. * (Highcharts, Highstock, Gantt) Padding between each value groups, in x
  28294. * axis units.
  28295. */
  28296. groupPadding?: number;
  28297. /**
  28298. * (Highcharts) When set to `false` will prevent the series data from being
  28299. * included in any form of data export.
  28300. *
  28301. * Since version 6.0.0 until 7.1.0 the option was existing undocumented as
  28302. * `includeInCSVExport`.
  28303. */
  28304. includeInDataExport?: boolean;
  28305. /**
  28306. * (Highmaps) What property to join the `mapData` to the value data. For
  28307. * example, if joinBy is "code", the mapData items with a specific code is
  28308. * merged into the data with the same code. For maps loaded from GeoJSON,
  28309. * the keys may be held in each point's `properties` object.
  28310. *
  28311. * The joinBy option can also be an array of two values, where the first
  28312. * points to a key in the `mapData`, and the second points to another key in
  28313. * the `data`.
  28314. *
  28315. * When joinBy is `null`, the map items are joined by their position in the
  28316. * array, which performs much better in maps with many data points. This is
  28317. * the recommended option if you are printing more than a thousand data
  28318. * points and have a backend that can preprocess the data into a parallel
  28319. * array of the mapData.
  28320. */
  28321. joinBy?: (string|Array<string>);
  28322. /**
  28323. * (Highcharts) An array specifying which option maps to which key in the
  28324. * data point array. This makes it convenient to work with unstructured data
  28325. * arrays from different sources.
  28326. */
  28327. keys?: Array<string>;
  28328. /**
  28329. * (Highcharts, Highstock, Gantt) Series labels are placed as close to the
  28330. * series as possible in a natural way, seeking to avoid other series. The
  28331. * goal of this feature is to make the chart more easily readable, like if a
  28332. * human designer placed the labels in the optimal position.
  28333. *
  28334. * The series labels currently work with series types having a `graph` or an
  28335. * `area`.
  28336. */
  28337. label?: SeriesLabelOptionsObject;
  28338. /**
  28339. * (Highstock) The line marks the last price from all points.
  28340. */
  28341. lastPrice?: SeriesLastPriceOptionsObject;
  28342. /**
  28343. * (Highstock) The line marks the last price from visible range of points.
  28344. */
  28345. lastVisiblePrice?: SeriesLastVisiblePriceOptionsObject;
  28346. /**
  28347. * (Highcharts) The width of the line surrounding the box. If any of
  28348. * stemWidth, medianWidth or whiskerWidth are `null`, the lineWidth also
  28349. * applies to these lines.
  28350. */
  28351. lineWidth?: number;
  28352. /**
  28353. * (Highcharts, Highstock, Gantt) The id of another series to link to.
  28354. * Additionally, the value can be ":previous" to link to the previous
  28355. * series. When two series are linked, only the first one appears in the
  28356. * legend. Toggling the visibility of this also toggles the linked series.
  28357. *
  28358. * If master series uses data sorting and linked series does not have its
  28359. * own sorting definition, the linked series will be sorted in the same
  28360. * order as the master one.
  28361. */
  28362. linkedTo?: string;
  28363. /**
  28364. * (Highcharts, Highstock, Gantt) The maximum allowed pixel width for a
  28365. * column, translated to the height of a bar in a bar chart. This prevents
  28366. * the columns from becoming too wide when there is a small number of points
  28367. * in the chart.
  28368. */
  28369. maxPointWidth?: number;
  28370. /**
  28371. * (Highcharts) The color of the median line. If `undefined`, the general
  28372. * series color applies.
  28373. *
  28374. * In styled mode, the median stroke width can be set with the
  28375. * `.highcharts-boxplot-median` class.
  28376. */
  28377. medianColor?: (ColorString|GradientColorObject);
  28378. /**
  28379. * (Highcharts) The dash style of the median.
  28380. */
  28381. medianDashStyle?: DashStyleValue;
  28382. /**
  28383. * (Highcharts) The pixel width of the median line. If `null`, the lineWidth
  28384. * is used.
  28385. *
  28386. * In styled mode, the median stroke width can be set with the
  28387. * `.highcharts-boxplot-median` class.
  28388. */
  28389. medianWidth?: (number|null);
  28390. /**
  28391. * (Highcharts, Highstock, Gantt) The minimal height for a column or width
  28392. * for a bar. By default, 0 values are not shown. To visualize a 0 (or close
  28393. * to zero) point, set the minimal point length to a pixel value like 3\. In
  28394. * stacked column charts, minPointLength might not be respected for tightly
  28395. * packed values.
  28396. */
  28397. minPointLength?: number;
  28398. /**
  28399. * (Highstock) Options for the corresponding navigator series if
  28400. * `showInNavigator` is `true` for this series. Available options are the
  28401. * same as any series, documented at plotOptions and series.
  28402. *
  28403. * These options are merged with options in navigator.series, and will take
  28404. * precedence if the same option is defined both places.
  28405. */
  28406. navigatorOptions?: PlotSeriesOptions;
  28407. /**
  28408. * (Highcharts) The color for the parts of the graph or points that are
  28409. * below the threshold. Note that `zones` takes precedence over the negative
  28410. * color. Using `negativeColor` is equivalent to applying a zone with value
  28411. * of 0.
  28412. */
  28413. negativeColor?: (ColorString|GradientColorObject|PatternObject);
  28414. /**
  28415. * (Highcharts) Opacity of a series parts: line, fill (e.g. area) and
  28416. * dataLabels.
  28417. */
  28418. opacity?: number;
  28419. /**
  28420. * (Highcharts) Properties for each single point.
  28421. */
  28422. point?: PlotSeriesPointOptions;
  28423. /**
  28424. * (Highcharts) Same as accessibility.pointDescriptionFormatter, but for an
  28425. * individual series. Overrides the chart wide configuration.
  28426. */
  28427. pointDescriptionFormatter?: Function;
  28428. /**
  28429. * (Highcharts, Highstock, Gantt) If no x values are given for the points in
  28430. * a series, `pointInterval` defines the interval of the x values. For
  28431. * example, if a series contains one value every decade starting from year
  28432. * 0, set `pointInterval` to `10`. In true `datetime` axes, the
  28433. * `pointInterval` is set in milliseconds.
  28434. *
  28435. * It can be also be combined with `pointIntervalUnit` to draw irregular
  28436. * time intervals.
  28437. *
  28438. * Please note that this options applies to the _series data_, not the
  28439. * interval of the axis ticks, which is independent.
  28440. */
  28441. pointInterval?: number;
  28442. /**
  28443. * (Highcharts, Highstock, Gantt) On datetime series, this allows for
  28444. * setting the pointInterval to irregular time units, `day`, `month` and
  28445. * `year`. A day is usually the same as 24 hours, but `pointIntervalUnit`
  28446. * also takes the DST crossover into consideration when dealing with local
  28447. * time. Combine this option with `pointInterval` to draw weeks, quarters, 6
  28448. * months, 10 years etc.
  28449. *
  28450. * Please note that this options applies to the _series data_, not the
  28451. * interval of the axis ticks, which is independent.
  28452. */
  28453. pointIntervalUnit?: OptionsPointIntervalUnitValue;
  28454. /**
  28455. * (Highcharts, Highstock, Gantt) Padding between each column or bar, in x
  28456. * axis units.
  28457. */
  28458. pointPadding?: number;
  28459. /**
  28460. * (Highcharts, Highstock, Gantt) Possible values: `"on"`, `"between"`,
  28461. * `number`.
  28462. *
  28463. * In a column chart, when pointPlacement is `"on"`, the point will not
  28464. * create any padding of the X axis. In a polar column chart this means that
  28465. * the first column points directly north. If the pointPlacement is
  28466. * `"between"`, the columns will be laid out between ticks. This is useful
  28467. * for example for visualising an amount between two points in time or in a
  28468. * certain sector of a polar chart.
  28469. *
  28470. * Since Highcharts 3.0.2, the point placement can also be numeric, where 0
  28471. * is on the axis value, -0.5 is between this value and the previous, and
  28472. * 0.5 is between this value and the next. Unlike the textual options,
  28473. * numeric point placement options won't affect axis padding.
  28474. *
  28475. * Note that pointPlacement needs a pointRange to work. For column series
  28476. * this is computed, but for line-type series it needs to be set.
  28477. *
  28478. * For the `xrange` series type and gantt charts, if the Y axis is a
  28479. * category axis, the `pointPlacement` applies to the Y axis rather than the
  28480. * (typically datetime) X axis.
  28481. *
  28482. * Defaults to `undefined` in cartesian charts, `"between"` in polar charts.
  28483. */
  28484. pointPlacement?: (number|string);
  28485. /**
  28486. * (Highcharts, Highstock, Gantt) The X axis range that each point is valid
  28487. * for. This determines the width of the column. On a categorized axis, the
  28488. * range will be 1 by default (one category unit). On linear and datetime
  28489. * axes, the range will be computed as the distance between the two closest
  28490. * data points.
  28491. *
  28492. * The default `null` means it is computed automatically, but this option
  28493. * can be used to override the automatic value.
  28494. *
  28495. * This option is set by default to 1 if data sorting is enabled.
  28496. */
  28497. pointRange?: (number|null);
  28498. /**
  28499. * (Highcharts, Highstock, Gantt) If no x values are given for the points in
  28500. * a series, pointStart defines on what value to start. For example, if a
  28501. * series contains one yearly value starting from 1945, set pointStart to
  28502. * 1945.
  28503. */
  28504. pointStart?: number;
  28505. /**
  28506. * (Highcharts, Highstock, Gantt) A pixel value specifying a fixed width for
  28507. * each column or bar point. When set to `undefined`, the width is
  28508. * calculated from the `pointPadding` and `groupPadding`. The width effects
  28509. * the dimension that is not based on the point value. For column series it
  28510. * is the hoizontal length and for bar series it is the vertical length.
  28511. */
  28512. pointWidth?: number;
  28513. /**
  28514. * (Highcharts) Whether to select the series initially. If `showCheckbox` is
  28515. * true, the checkbox next to the series name in the legend will be checked
  28516. * for a selected series.
  28517. */
  28518. selected?: boolean;
  28519. /**
  28520. * (Highcharts) Whether to apply a drop shadow to the graph line. Since 2.3
  28521. * the shadow can be an object configuration containing `color`, `offsetX`,
  28522. * `offsetY`, `opacity` and `width`.
  28523. */
  28524. shadow?: (boolean|ShadowOptionsObject);
  28525. /**
  28526. * (Highcharts) If true, a checkbox is displayed next to the legend item to
  28527. * allow selecting the series. The state of the checkbox is determined by
  28528. * the `selected` option.
  28529. */
  28530. showCheckbox?: boolean;
  28531. /**
  28532. * (Highcharts) Whether to display this particular series or series type in
  28533. * the legend. Standalone series are shown in legend by default, and linked
  28534. * series are not. Since v7.2.0 it is possible to show series that use
  28535. * colorAxis by setting this option to `true`.
  28536. */
  28537. showInLegend?: boolean;
  28538. /**
  28539. * (Highstock) Whether or not to show the series in the navigator. Takes
  28540. * precedence over navigator.baseSeries if defined.
  28541. */
  28542. showInNavigator?: boolean;
  28543. /**
  28544. * (Highcharts) If set to `true`, the accessibility module will skip past
  28545. * the points in this series for keyboard navigation.
  28546. */
  28547. skipKeyboardNavigation?: boolean;
  28548. /**
  28549. * (Highcharts, Highstock) When this is true, the series will not cause the
  28550. * Y axis to cross the zero plane (or threshold option) unless the data
  28551. * actually crosses the plane.
  28552. *
  28553. * For example, if `softThreshold` is `false`, a series of 0, 1, 2, 3 will
  28554. * make the Y axis show negative values according to the `minPadding`
  28555. * option. If `softThreshold` is `true`, the Y axis starts at 0.
  28556. */
  28557. softThreshold?: boolean;
  28558. /**
  28559. * (Highcharts, Highstock) Whether to stack the values of each series on top
  28560. * of each other. Possible values are `undefined` to disable, `"normal"` to
  28561. * stack by value or `"percent"`.
  28562. *
  28563. * When stacking is enabled, data must be sorted in ascending X order.
  28564. *
  28565. * Some stacking options are related to specific series types. In the
  28566. * streamgraph series type, the stacking option is set to `"stream"`. The
  28567. * second one is `"overlap"`, which only applies to waterfall series.
  28568. */
  28569. stacking?: OptionsStackingValue;
  28570. /**
  28571. * (Highcharts) The dash style of the stem, the vertical line extending from
  28572. * the box to the whiskers.
  28573. */
  28574. stemDashStyle?: DashStyleValue;
  28575. /**
  28576. * (Highcharts) The width of the stem, the vertical line extending from the
  28577. * box to the whiskers. If `undefined`, the width is inherited from the
  28578. * lineWidth option.
  28579. *
  28580. * In styled mode, the stem stroke width can be set with the
  28581. * `.highcharts-boxplot-stem` class.
  28582. */
  28583. stemWidth?: number;
  28584. /**
  28585. * (Highcharts) Sticky tracking of mouse events. When true, the `mouseOut`
  28586. * event on a series isn't triggered until the mouse moves over another
  28587. * series, or out of the plot area. When false, the `mouseOut` event on a
  28588. * series is triggered when the mouse leaves the area around the series'
  28589. * graph or markers. This also implies the tooltip when not shared. When
  28590. * `stickyTracking` is false and `tooltip.shared` is false, the tooltip will
  28591. * be hidden when moving the mouse between series. Defaults to true for line
  28592. * and area type series, but to false for columns, pies etc.
  28593. *
  28594. * **Note:** The boost module will force this option because of technical
  28595. * limitations.
  28596. */
  28597. stickyTracking?: boolean;
  28598. /**
  28599. * (Highcharts) The Y axis value to serve as the base for the columns, for
  28600. * distinguishing between values above and below a threshold. If `null`, the
  28601. * columns extend from the padding Y axis minimum.
  28602. */
  28603. threshold?: (number|null);
  28604. /**
  28605. * (Highcharts) A configuration object for the tooltip rendering of each
  28606. * single series. Properties are inherited from tooltip, but only the
  28607. * following properties can be defined on a series level.
  28608. */
  28609. tooltip?: SeriesTooltipOptionsObject;
  28610. /**
  28611. * (Highcharts, Highstock, Gantt) When a series contains a data array that
  28612. * is longer than this, only one dimensional arrays of numbers, or two
  28613. * dimensional arrays with x and y values are allowed. Also, only the first
  28614. * point is tested, and the rest are assumed to be the same format. This
  28615. * saves expensive data checking and indexing in long series. Set it to `0`
  28616. * disable.
  28617. *
  28618. * Note: In boost mode turbo threshold is forced. Only array of numbers or
  28619. * two dimensional arrays are allowed.
  28620. */
  28621. turboThreshold?: number;
  28622. /**
  28623. * (Highcharts) Set the initial visibility of the series.
  28624. */
  28625. visible?: boolean;
  28626. /**
  28627. * (Highcharts) The color of the whiskers, the horizontal lines marking low
  28628. * and high values. When `undefined`, the general series color is used.
  28629. *
  28630. * In styled mode, the whisker stroke can be set with the
  28631. * `.highcharts-boxplot-whisker` class .
  28632. */
  28633. whiskerColor?: (ColorString|GradientColorObject|PatternObject);
  28634. /**
  28635. * (Highcharts) The dash style of the whiskers.
  28636. */
  28637. whiskerDashStyle?: DashStyleValue;
  28638. /**
  28639. * (Highcharts) The length of the whiskers, the horizontal lines marking low
  28640. * and high values. It can be a numerical pixel value, or a percentage value
  28641. * of the box width. Set `0` to disable whiskers.
  28642. */
  28643. whiskerLength?: (number|string);
  28644. /**
  28645. * (Highcharts) The line width of the whiskers, the horizontal lines marking
  28646. * low and high values. When `undefined`, the general lineWidth applies.
  28647. *
  28648. * In styled mode, the whisker stroke width can be set with the
  28649. * `.highcharts-boxplot-whisker` class.
  28650. */
  28651. whiskerWidth?: number;
  28652. /**
  28653. * (Highmaps) Define the z index of the series.
  28654. */
  28655. zIndex?: number;
  28656. /**
  28657. * (Highcharts, Highstock) Defines the Axis on which the zones are applied.
  28658. */
  28659. zoneAxis?: string;
  28660. /**
  28661. * (Highcharts, Highstock) An array defining zones within a series. Zones
  28662. * can be applied to the X axis, Y axis or Z axis for bubbles, according to
  28663. * the `zoneAxis` option. The zone definitions have to be in ascending order
  28664. * regarding to the value.
  28665. *
  28666. * In styled mode, the color zones are styled with the
  28667. * `.highcharts-zone-{n}` class, or custom classed from the `className`
  28668. * option (view live demo).
  28669. */
  28670. zones?: Array<SeriesZonesOptionsObject>;
  28671. }
  28672. /**
  28673. * (Highcharts, Highstock) Enable or disable the initial animation when a series
  28674. * is displayed. The animation can also be set as a configuration object. Please
  28675. * note that this option only applies to the initial animation of the series
  28676. * itself. For other animations, see chart.animation and the animation parameter
  28677. * under the API methods. The following properties are supported:
  28678. *
  28679. * - `defer`: The animation delay time in milliseconds.
  28680. *
  28681. * - `duration`: The duration of the animation in milliseconds.
  28682. *
  28683. * - `easing`: Can be a string reference to an easing function set on the `Math`
  28684. * object or a function. See the _Custom easing function_ demo below.
  28685. *
  28686. * Due to poor performance, animation is disabled in old IE browsers for several
  28687. * chart types.
  28688. */
  28689. export interface PlotBubbleAnimationOptions {
  28690. defer?: number;
  28691. }
  28692. /**
  28693. * (Highcharts, Highstock, Highmaps, Gantt) Enable or disable the initial
  28694. * animation when a series is displayed for the `dataLabels`. The animation can
  28695. * also be set as a configuration object. Please note that this option only
  28696. * applies to the initial animation. For other animations, see chart.animation
  28697. * and the animation parameter under the API methods. The following properties
  28698. * are supported:
  28699. *
  28700. * - `defer`: The animation delay time in milliseconds.
  28701. */
  28702. export interface PlotBubbleDataLabelsAnimationOptions {
  28703. /**
  28704. * (Highcharts, Highstock, Highmaps, Gantt) The animation delay time in
  28705. * milliseconds. Set to `0` renders dataLabel immediately. As `undefined`
  28706. * inherits defer time from the series.animation.defer.
  28707. */
  28708. defer?: number;
  28709. }
  28710. /**
  28711. * (Highcharts, Highstock, Highmaps, Gantt) Options for the series data labels,
  28712. * appearing next to each data point.
  28713. *
  28714. * Since v6.2.0, multiple data labels can be applied to each single point by
  28715. * defining them as an array of configs.
  28716. *
  28717. * In styled mode, the data labels can be styled with the
  28718. * `.highcharts-data-label-box` and `.highcharts-data-label` class names (see
  28719. * example).
  28720. */
  28721. export interface PlotBubbleDataLabelsOptions {
  28722. /**
  28723. * (Highcharts, Highstock, Highmaps, Gantt) The alignment of the data label
  28724. * compared to the point. If `right`, the right side of the label should be
  28725. * touching the point. For points with an extent, like columns, the
  28726. * alignments also dictates how to align it inside the box, as given with
  28727. * the inside option. Can be one of `left`, `center` or `right`.
  28728. */
  28729. align?: (AlignValue|null);
  28730. /**
  28731. * (Highcharts, Highstock, Highmaps, Gantt) Whether to allow data labels to
  28732. * overlap. To make the labels less sensitive for overlapping, the
  28733. * dataLabels.padding can be set to 0.
  28734. */
  28735. allowOverlap?: boolean;
  28736. /**
  28737. * (Highcharts, Highstock, Highmaps, Gantt) Enable or disable the initial
  28738. * animation when a series is displayed for the `dataLabels`. The animation
  28739. * can also be set as a configuration object. Please note that this option
  28740. * only applies to the initial animation. For other animations, see
  28741. * chart.animation and the animation parameter under the API methods. The
  28742. * following properties are supported:
  28743. *
  28744. * - `defer`: The animation delay time in milliseconds.
  28745. */
  28746. animation?: (boolean|PlotBubbleDataLabelsAnimationOptions|Partial<AnimationOptionsObject>);
  28747. /**
  28748. * (Highcharts, Highstock, Highmaps, Gantt) The background color or gradient
  28749. * for the data label.
  28750. */
  28751. backgroundColor?: (ColorString|GradientColorObject|PatternObject);
  28752. /**
  28753. * (Highcharts, Highstock, Highmaps, Gantt) The border color for the data
  28754. * label. Defaults to `undefined`.
  28755. */
  28756. borderColor?: (ColorString|GradientColorObject|PatternObject);
  28757. /**
  28758. * (Highcharts, Highstock, Highmaps, Gantt) The border radius in pixels for
  28759. * the data label.
  28760. */
  28761. borderRadius?: number;
  28762. /**
  28763. * (Highcharts, Highstock, Highmaps, Gantt) The border width in pixels for
  28764. * the data label.
  28765. */
  28766. borderWidth?: number;
  28767. /**
  28768. * (Highcharts, Highstock, Highmaps, Gantt) A class name for the data label.
  28769. * Particularly in styled mode, this can be used to give each series' or
  28770. * point's data label unique styling. In addition to this option, a default
  28771. * color class name is added so that we can give the labels a contrast text
  28772. * shadow.
  28773. */
  28774. className?: string;
  28775. /**
  28776. * (Highcharts, Highstock, Highmaps, Gantt) The text color for the data
  28777. * labels. Defaults to `undefined`. For certain series types, like column or
  28778. * map, the data labels can be drawn inside the points. In this case the
  28779. * data label will be drawn with maximum contrast by default. Additionally,
  28780. * it will be given a `text-outline` style with the opposite color, to
  28781. * further increase the contrast. This can be overridden by setting the
  28782. * `text-outline` style to `none` in the `dataLabels.style` option.
  28783. */
  28784. color?: (ColorString|GradientColorObject|PatternObject);
  28785. /**
  28786. * (Highcharts, Highstock, Highmaps, Gantt) Whether to hide data labels that
  28787. * are outside the plot area. By default, the data label is moved inside the
  28788. * plot area according to the overflow option.
  28789. */
  28790. crop?: boolean;
  28791. /**
  28792. * (Highcharts, Highstock, Gantt) Whether to defer displaying the data
  28793. * labels until the initial series animation has finished. Setting to
  28794. * `false` renders the data label immediately. If set to `true` inherits the
  28795. * defer time set in plotOptions.series.animation.
  28796. */
  28797. defer?: boolean;
  28798. /**
  28799. * (Highcharts, Highstock, Highmaps, Gantt) Enable or disable the data
  28800. * labels.
  28801. */
  28802. enabled?: boolean;
  28803. /**
  28804. * (Highcharts, Highstock, Highmaps, Gantt) A declarative filter to control
  28805. * of which data labels to display. The declarative filter is designed for
  28806. * use when callback functions are not available, like when the chart
  28807. * options require a pure JSON structure or for use with graphical editors.
  28808. * For programmatic control, use the `formatter` instead, and return
  28809. * `undefined` to disable a single data label.
  28810. */
  28811. filter?: DataLabelsFilterOptionsObject;
  28812. /**
  28813. * (Highcharts, Highstock, Highmaps, Gantt) A format string for the data
  28814. * label. Available variables are the same as for `formatter`.
  28815. */
  28816. format?: string;
  28817. /**
  28818. * (Highcharts, Highstock, Highmaps, Gantt) Callback JavaScript function to
  28819. * format the data label. Note that if a `format` is defined, the format
  28820. * takes precedence and the formatter is ignored.
  28821. */
  28822. formatter?: DataLabelsFormatterCallbackFunction;
  28823. /**
  28824. * (Highcharts, Highstock, Highmaps, Gantt) For points with an extent, like
  28825. * columns or map areas, whether to align the data label inside the box or
  28826. * to the actual value point. Defaults to `false` in most cases, `true` in
  28827. * stacked columns.
  28828. */
  28829. inside?: boolean;
  28830. /**
  28831. * (Highcharts, Highstock, Highmaps, Gantt) Format for points with the value
  28832. * of null. Works analogously to format. `nullFormat` can be applied only to
  28833. * series which support displaying null points.
  28834. */
  28835. nullFormat?: (boolean|string);
  28836. /**
  28837. * (Highcharts, Highstock, Highmaps, Gantt) Callback JavaScript function
  28838. * that defines formatting for points with the value of null. Works
  28839. * analogously to formatter. `nullPointFormatter` can be applied only to
  28840. * series which support displaying null points.
  28841. */
  28842. nullFormatter?: DataLabelsFormatterCallbackFunction;
  28843. /**
  28844. * (Highcharts, Highstock, Highmaps, Gantt) How to handle data labels that
  28845. * flow outside the plot area. The default is `"justify"`, which aligns them
  28846. * inside the plot area. For columns and bars, this means it will be moved
  28847. * inside the bar. To display data labels outside the plot area, set `crop`
  28848. * to `false` and `overflow` to `"allow"`.
  28849. */
  28850. overflow?: DataLabelsOverflowValue;
  28851. /**
  28852. * (Highcharts, Highstock, Highmaps, Gantt) When either the `borderWidth` or
  28853. * the `backgroundColor` is set, this is the padding within the box.
  28854. */
  28855. padding?: number;
  28856. /**
  28857. * (Highcharts, Highstock, Highmaps, Gantt) Aligns data labels relative to
  28858. * points. If `center` alignment is not possible, it defaults to `right`.
  28859. */
  28860. position?: AlignValue;
  28861. /**
  28862. * (Highcharts, Highstock, Highmaps, Gantt) Text rotation in degrees. Note
  28863. * that due to a more complex structure, backgrounds, borders and padding
  28864. * will be lost on a rotated data label.
  28865. */
  28866. rotation?: number;
  28867. /**
  28868. * (Highcharts, Highstock, Highmaps, Gantt) The shadow of the box. Works
  28869. * best with `borderWidth` or `backgroundColor`. Since 2.3 the shadow can be
  28870. * an object configuration containing `color`, `offsetX`, `offsetY`,
  28871. * `opacity` and `width`.
  28872. */
  28873. shadow?: (boolean|ShadowOptionsObject);
  28874. /**
  28875. * (Highcharts, Highstock, Highmaps, Gantt) The name of a symbol to use for
  28876. * the border around the label. Symbols are predefined functions on the
  28877. * Renderer object.
  28878. */
  28879. shape?: string;
  28880. /**
  28881. * (Highcharts, Highstock, Highmaps, Gantt) Styles for the label. The
  28882. * default `color` setting is `"contrast"`, which is a pseudo color that
  28883. * Highcharts picks up and applies the maximum contrast to the underlying
  28884. * point item, for example the bar in a bar chart.
  28885. *
  28886. * The `textOutline` is a pseudo property that applies an outline of the
  28887. * given width with the given color, which by default is the maximum
  28888. * contrast to the text. So a bright text color will result in a black text
  28889. * outline for maximum readability on a mixed background. In some cases,
  28890. * especially with grayscale text, the text outline doesn't work well, in
  28891. * which cases it can be disabled by setting it to `"none"`. When `useHTML`
  28892. * is true, the `textOutline` will not be picked up. In this, case, the same
  28893. * effect can be acheived through the `text-shadow` CSS property.
  28894. *
  28895. * For some series types, where each point has an extent, like for example
  28896. * tree maps, the data label may overflow the point. There are two
  28897. * strategies for handling overflow. By default, the text will wrap to
  28898. * multiple lines. The other strategy is to set `style.textOverflow` to
  28899. * `ellipsis`, which will keep the text on one line plus it will break
  28900. * inside long words.
  28901. */
  28902. style?: CSSObject;
  28903. /**
  28904. * (Highcharts, Highstock, Highmaps, Gantt) Options for a label text which
  28905. * should follow marker's shape. Border and background are disabled for a
  28906. * label that follows a path.
  28907. *
  28908. * **Note:** Only SVG-based renderer supports this option. Setting `useHTML`
  28909. * to true will disable this option.
  28910. */
  28911. textPath?: DataLabelsTextPathOptionsObject;
  28912. /**
  28913. * (Highcharts, Highstock, Highmaps, Gantt) Whether to use HTML to render
  28914. * the labels.
  28915. */
  28916. useHTML?: boolean;
  28917. /**
  28918. * (Highcharts, Highstock, Highmaps, Gantt) The vertical alignment of a data
  28919. * label. Can be one of `top`, `middle` or `bottom`. The default value
  28920. * depends on the data, for instance in a column chart, the label is above
  28921. * positive values and below negative values.
  28922. */
  28923. verticalAlign?: string;
  28924. /**
  28925. * (Highcharts, Highstock, Highmaps, Gantt) The x position offset of the
  28926. * label relative to the point in pixels.
  28927. */
  28928. x?: number;
  28929. /**
  28930. * (Highcharts, Highstock, Highmaps, Gantt) The y position offset of the
  28931. * label relative to the point in pixels.
  28932. */
  28933. y?: number;
  28934. /**
  28935. * (Highcharts, Highstock, Highmaps, Gantt) The Z index of the data labels.
  28936. * The default Z index puts it above the series. Use a Z index of 2 to
  28937. * display it behind the series.
  28938. */
  28939. z?: number;
  28940. }
  28941. /**
  28942. * (Highcharts, Highstock) Options for the series data sorting.
  28943. */
  28944. export interface PlotBubbleDataSortingOptions {
  28945. /**
  28946. * (Highcharts, Highstock) Enable or disable data sorting for the series.
  28947. * Use xAxis.reversed to change the sorting order.
  28948. */
  28949. enabled?: boolean;
  28950. /**
  28951. * (Highcharts, Highstock) Whether to allow matching points by name in an
  28952. * update. If this option is disabled, points will be matched by order.
  28953. */
  28954. matchByName?: boolean;
  28955. /**
  28956. * (Highcharts, Highstock) Determines what data value should be used to sort
  28957. * by.
  28958. */
  28959. sortKey?: string;
  28960. }
  28961. /**
  28962. * (Highcharts, Highstock) Style options for the guide box. The guide box has
  28963. * one state by default, the `default` state.
  28964. */
  28965. export interface PlotBubbleDragDropGuideBoxOptions {
  28966. /**
  28967. * (Highcharts, Highstock) Style options for the guide box default state.
  28968. */
  28969. default?: DragDropGuideBoxOptionsObject;
  28970. }
  28971. /**
  28972. * (Highcharts, Highstock) Apply a jitter effect for the rendered markers. When
  28973. * plotting discrete values, a little random noise may help telling the points
  28974. * apart. The jitter setting applies a random displacement of up to `n` axis
  28975. * units in either direction. So for example on a horizontal X axis, setting the
  28976. * `jitter.x` to 0.24 will render the point in a random position between 0.24
  28977. * units to the left and 0.24 units to the right of the true axis position. On a
  28978. * category axis, setting it to 0.5 will fill up the bin and make the data
  28979. * appear continuous.
  28980. *
  28981. * When rendered on top of a box plot or a column series, a jitter value of 0.24
  28982. * will correspond to the underlying series' default groupPadding and
  28983. * pointPadding settings.
  28984. */
  28985. export interface PlotBubbleJitterOptions {
  28986. /**
  28987. * (Highcharts, Highstock) The maximal X offset for the random jitter
  28988. * effect.
  28989. */
  28990. x?: number;
  28991. /**
  28992. * (Highcharts, Highstock) The maximal Y offset for the random jitter
  28993. * effect.
  28994. */
  28995. y?: number;
  28996. }
  28997. /**
  28998. * (Highcharts, Highstock) A bubble series is a three dimensional series type
  28999. * where each point renders an X, Y and Z value. Each points is drawn as a
  29000. * bubble where the position along the X and Y axes mark the X and Y values, and
  29001. * the size of the bubble relates to the Z value.
  29002. *
  29003. * In TypeScript the type option must always be set.
  29004. *
  29005. * Configuration options for the series are given in three levels:
  29006. *
  29007. * 1. Options for all series in a chart are defined in the plotOptions.series
  29008. * object.
  29009. *
  29010. * 2. Options for all `bubble` series are defined in plotOptions.bubble.
  29011. *
  29012. * 3. Options for one single series are given in the series instance array. (see
  29013. * online documentation for example)
  29014. */
  29015. export interface PlotBubbleOptions {
  29016. /**
  29017. * (Highcharts, Highstock) Accessibility options for a series.
  29018. */
  29019. accessibility?: SeriesAccessibilityOptionsObject;
  29020. /**
  29021. * (Highmaps) Whether all areas of the map defined in `mapData` should be
  29022. * rendered. If `true`, areas which don't correspond to a data point, are
  29023. * rendered as `null` points. If `false`, those areas are skipped.
  29024. */
  29025. allAreas?: boolean;
  29026. /**
  29027. * (Highcharts, Highstock) Allow this series' points to be selected by
  29028. * clicking on the graphic (columns, point markers, pie slices, map areas
  29029. * etc).
  29030. *
  29031. * The selected points can be handled by point select and unselect events,
  29032. * or collectively by the getSelectedPoints function.
  29033. *
  29034. * And alternative way of selecting points is through dragging.
  29035. */
  29036. allowPointSelect?: boolean;
  29037. /**
  29038. * (Highcharts, Highstock) Enable or disable the initial animation when a
  29039. * series is displayed. The animation can also be set as a configuration
  29040. * object. Please note that this option only applies to the initial
  29041. * animation of the series itself. For other animations, see chart.animation
  29042. * and the animation parameter under the API methods. The following
  29043. * properties are supported:
  29044. *
  29045. * - `defer`: The animation delay time in milliseconds.
  29046. *
  29047. * - `duration`: The duration of the animation in milliseconds.
  29048. *
  29049. * - `easing`: Can be a string reference to an easing function set on the
  29050. * `Math` object or a function. See the _Custom easing function_ demo below.
  29051. *
  29052. * Due to poor performance, animation is disabled in old IE browsers for
  29053. * several chart types.
  29054. */
  29055. animation?: (boolean|PlotBubbleAnimationOptions|Partial<AnimationOptionsObject>);
  29056. /**
  29057. * (Highcharts, Highstock) If there are more points in the series than the
  29058. * `animationLimit`, the animation won't run. Animation affects overall
  29059. * performance and doesn't work well with heavy data series.
  29060. */
  29061. animationLimit?: number;
  29062. /**
  29063. * (Highcharts, Highstock) Sets the color blending in the boost module.
  29064. */
  29065. boostBlending?: OptionsBoostBlendingValue;
  29066. /**
  29067. * (Highcharts, Highstock) Set the point threshold for when a series should
  29068. * enter boost mode.
  29069. *
  29070. * Setting it to e.g. 2000 will cause the series to enter boost mode when
  29071. * there are 2000 or more points in the series.
  29072. *
  29073. * To disable boosting on the series, set the `boostThreshold` to 0. Setting
  29074. * it to 1 will force boosting.
  29075. *
  29076. * Note that the cropThreshold also affects this setting. When zooming in on
  29077. * a series that has fewer points than the `cropThreshold`, all points are
  29078. * rendered although outside the visible plot area, and the `boostThreshold`
  29079. * won't take effect.
  29080. */
  29081. boostThreshold?: number;
  29082. /**
  29083. * (Highmaps) The border color of the map areas.
  29084. *
  29085. * In styled mode, the border stroke is given in the `.highcharts-point`
  29086. * class.
  29087. */
  29088. borderColor?: (ColorString|GradientColorObject|PatternObject);
  29089. /**
  29090. * (Highmaps) The border width of each map area.
  29091. *
  29092. * In styled mode, the border stroke width is given in the
  29093. * `.highcharts-point` class.
  29094. */
  29095. borderWidth?: number;
  29096. /**
  29097. * (Highcharts, Highstock) An additional class name to apply to the series'
  29098. * graphical elements. This option does not replace default class names of
  29099. * the graphical element.
  29100. */
  29101. className?: string;
  29102. /**
  29103. * (Highcharts, Highstock) Disable this option to allow series rendering in
  29104. * the whole plotting area.
  29105. *
  29106. * **Note:** Clipping should be always enabled when chart.zoomType is set
  29107. */
  29108. clip?: boolean;
  29109. /**
  29110. * (Highcharts, Highstock) The main color of the series. In line type series
  29111. * it applies to the line and the point markers unless otherwise specified.
  29112. * In bar type series it applies to the bars unless a color is specified per
  29113. * point. The default value is pulled from the `options.colors` array.
  29114. *
  29115. * In styled mode, the color can be defined by the colorIndex option. Also,
  29116. * the series color can be set with the `.highcharts-series`,
  29117. * `.highcharts-color-{n}`, `.highcharts-{type}-series` or
  29118. * `.highcharts-series-{n}` class, or individual classes given by the
  29119. * `className` option.
  29120. */
  29121. color?: (ColorString|GradientColorObject|PatternObject);
  29122. /**
  29123. * (Highcharts, Highstock, Highmaps) When using dual or multiple color axes,
  29124. * this number defines which colorAxis the particular series is connected
  29125. * to. It refers to either the axis id or the index of the axis in the
  29126. * colorAxis array, with 0 being the first. Set this option to false to
  29127. * prevent a series from connecting to the default color axis.
  29128. *
  29129. * Since v7.2.0 the option can also be an axis id or an axis index instead
  29130. * of a boolean flag.
  29131. */
  29132. colorAxis?: (boolean|number|string);
  29133. /**
  29134. * (Highcharts, Highstock) Styled mode only. A specific color index to use
  29135. * for the series, so its graphic representations are given the class name
  29136. * `highcharts-color-{n}`.
  29137. */
  29138. colorIndex?: number;
  29139. /**
  29140. * (Highcharts, Highstock, Highmaps) Determines what data value should be
  29141. * used to calculate point color if `colorAxis` is used. Requires to set
  29142. * `min` and `max` if some custom point property is used or if approximation
  29143. * for data grouping is set to `'sum'`.
  29144. */
  29145. colorKey?: string;
  29146. /**
  29147. * (Highstock) Compare the values of the series against the first non-null,
  29148. * non- zero value in the visible range. The y axis will show percentage or
  29149. * absolute change depending on whether `compare` is set to `"percent"` or
  29150. * `"value"`. When this is applied to multiple series, it allows comparing
  29151. * the development of the series against each other. Adds a `change` field
  29152. * to every point object.
  29153. */
  29154. compare?: string;
  29155. /**
  29156. * (Highstock) When compare is `percent`, this option dictates whether to
  29157. * use 0 or 100 as the base of comparison.
  29158. */
  29159. compareBase?: (0|100);
  29160. /**
  29161. * (Highstock) Defines if comparison should start from the first point
  29162. * within the visible range or should start from the first point **before**
  29163. * the range.
  29164. *
  29165. * In other words, this flag determines if first point within the visible
  29166. * range will have 0% (`compareStart=true`) or should have been already
  29167. * calculated according to the previous point (`compareStart=false`).
  29168. */
  29169. compareStart?: boolean;
  29170. /**
  29171. * (Highcharts) Polar charts only. Whether to connect the ends of a line
  29172. * series plot across the extremes.
  29173. */
  29174. connectEnds?: boolean;
  29175. /**
  29176. * (Highcharts, Highstock) Whether to connect a graph line across null
  29177. * points, or render a gap between the two points on either side of the
  29178. * null.
  29179. */
  29180. connectNulls?: boolean;
  29181. /**
  29182. * (Gantt) Override Pathfinder connector options for a series. Requires
  29183. * Highcharts Gantt to be loaded.
  29184. */
  29185. connectors?: SeriesConnectorsOptionsObject;
  29186. /**
  29187. * (Highcharts, Highstock, Gantt) When true, each point or column edge is
  29188. * rounded to its nearest pixel in order to render sharp on screen. In some
  29189. * cases, when there are a lot of densely packed columns, this leads to
  29190. * visible difference in column widths or distance between columns. In these
  29191. * cases, setting `crisp` to `false` may look better, even though each
  29192. * column is rendered blurry.
  29193. */
  29194. crisp?: boolean;
  29195. /**
  29196. * (Highcharts, Highstock) You can set the cursor to "pointer" if you have
  29197. * click events attached to the series, to signal to the user that the
  29198. * points and lines can be clicked.
  29199. *
  29200. * In styled mode, the series cursor can be set with the same classes as
  29201. * listed under series.color.
  29202. */
  29203. cursor?: (string|CursorValue);
  29204. /**
  29205. * (Highcharts, Highstock) A reserved subspace to store options and values
  29206. * for customized functionality. Here you can add additional data for your
  29207. * own event callbacks and formatter callbacks.
  29208. */
  29209. custom?: Dictionary<any>;
  29210. /**
  29211. * (Highcharts, Highstock) Name of the dash style to use for the graph, or
  29212. * for some series types the outline of each shape.
  29213. *
  29214. * In styled mode, the stroke dash-array can be set with the same classes as
  29215. * listed under series.color.
  29216. */
  29217. dashStyle?: DashStyleValue;
  29218. /**
  29219. * (Highstock) Data grouping is the concept of sampling the data values into
  29220. * larger blocks in order to ease readability and increase performance of
  29221. * the JavaScript charts. Highstock by default applies data grouping when
  29222. * the points become closer than a certain pixel value, determined by the
  29223. * `groupPixelWidth` option.
  29224. *
  29225. * If data grouping is applied, the grouping information of grouped points
  29226. * can be read from the Point.dataGroup. If point options other than the
  29227. * data itself are set, for example `name` or `color` or custom properties,
  29228. * the grouping logic doesn't know how to group it. In this case the options
  29229. * of the first point instance are copied over to the group point. This can
  29230. * be altered through a custom `approximation` callback function.
  29231. */
  29232. dataGrouping?: DataGroupingOptionsObject;
  29233. /**
  29234. * (Highcharts, Highstock, Highmaps, Gantt) Options for the series data
  29235. * labels, appearing next to each data point.
  29236. *
  29237. * Since v6.2.0, multiple data labels can be applied to each single point by
  29238. * defining them as an array of configs.
  29239. *
  29240. * In styled mode, the data labels can be styled with the
  29241. * `.highcharts-data-label-box` and `.highcharts-data-label` class names
  29242. * (see example).
  29243. */
  29244. dataLabels?: (PlotBubbleDataLabelsOptions|Array<PlotBubbleDataLabelsOptions>);
  29245. /**
  29246. * (Highcharts, Highstock) Options for the series data sorting.
  29247. */
  29248. dataSorting?: (DataSortingOptionsObject|PlotBubbleDataSortingOptions);
  29249. /**
  29250. * (Highcharts, Highstock) A description of the series to add to the screen
  29251. * reader information about the series.
  29252. */
  29253. description?: string;
  29254. /**
  29255. * (Highcharts, Highstock) Whether to display negative sized bubbles. The
  29256. * threshold is given by the zThreshold option, and negative bubbles can be
  29257. * visualized by setting negativeColor.
  29258. */
  29259. displayNegative?: boolean;
  29260. /**
  29261. * (Highcharts, Highstock) The draggable-points module allows points to be
  29262. * moved around or modified in the chart. In addition to the options
  29263. * mentioned under the `dragDrop` API structure, the module fires three
  29264. * events, point.dragStart, point.drag and point.drop.
  29265. */
  29266. dragDrop?: SeriesDragDropOptionsObject;
  29267. /**
  29268. * (Highcharts, Highstock) Enable or disable the mouse tracking for a
  29269. * specific series. This includes point tooltips and click events on graphs
  29270. * and points. For large datasets it improves performance.
  29271. */
  29272. enableMouseTracking?: boolean;
  29273. /**
  29274. * (Highcharts, Highstock) General event handlers for the series items.
  29275. * These event hooks can also be attached to the series at run time using
  29276. * the `Highcharts.addEvent` function.
  29277. */
  29278. events?: SeriesEventsOptionsObject;
  29279. /**
  29280. * (Highcharts, Highstock) Determines whether the series should look for the
  29281. * nearest point in both dimensions or just the x-dimension when hovering
  29282. * the series. Defaults to `'xy'` for scatter series and `'x'` for most
  29283. * other series. If the data has duplicate x-values, it is recommended to
  29284. * set this to `'xy'` to allow hovering over all points.
  29285. *
  29286. * Applies only to series types using nearest neighbor search (not direct
  29287. * hover) for tooltip.
  29288. */
  29289. findNearestPointBy?: OptionsFindNearestPointByValue;
  29290. /**
  29291. * (Highstock) Defines when to display a gap in the graph, together with the
  29292. * gapUnit option.
  29293. *
  29294. * In case when `dataGrouping` is enabled, points can be grouped into a
  29295. * larger time span. This can make the grouped points to have a greater
  29296. * distance than the absolute value of `gapSize` property, which will result
  29297. * in disappearing graph completely. To prevent this situation the mentioned
  29298. * distance between grouped points is used instead of previously defined
  29299. * `gapSize`.
  29300. *
  29301. * In practice, this option is most often used to visualize gaps in time
  29302. * series. In a stock chart, intraday data is available for daytime hours,
  29303. * while gaps will appear in nights and weekends.
  29304. */
  29305. gapSize?: number;
  29306. /**
  29307. * (Highstock) Together with gapSize, this option defines where to draw gaps
  29308. * in the graph.
  29309. *
  29310. * When the `gapUnit` is `"relative"` (default), a gap size of 5 means that
  29311. * if the distance between two points is greater than 5 times that of the
  29312. * two closest points, the graph will be broken.
  29313. *
  29314. * When the `gapUnit` is `"value"`, the gap is based on absolute axis
  29315. * values, which on a datetime axis is milliseconds. This also applies to
  29316. * the navigator series that inherits gap options from the base series.
  29317. */
  29318. gapUnit?: OptionsGapUnitValue;
  29319. /**
  29320. * (Highcharts, Highstock, Gantt) Whether to use the Y extremes of the total
  29321. * chart width or only the zoomed area when zooming in on parts of the X
  29322. * axis. By default, the Y axis adjusts to the min and max of the visible
  29323. * data. Cartesian series only.
  29324. */
  29325. getExtremesFromAll?: boolean;
  29326. /**
  29327. * (Highcharts, Highstock) When set to `false` will prevent the series data
  29328. * from being included in any form of data export.
  29329. *
  29330. * Since version 6.0.0 until 7.1.0 the option was existing undocumented as
  29331. * `includeInCSVExport`.
  29332. */
  29333. includeInDataExport?: boolean;
  29334. /**
  29335. * (Highcharts, Highstock) Apply a jitter effect for the rendered markers.
  29336. * When plotting discrete values, a little random noise may help telling the
  29337. * points apart. The jitter setting applies a random displacement of up to
  29338. * `n` axis units in either direction. So for example on a horizontal X
  29339. * axis, setting the `jitter.x` to 0.24 will render the point in a random
  29340. * position between 0.24 units to the left and 0.24 units to the right of
  29341. * the true axis position. On a category axis, setting it to 0.5 will fill
  29342. * up the bin and make the data appear continuous.
  29343. *
  29344. * When rendered on top of a box plot or a column series, a jitter value of
  29345. * 0.24 will correspond to the underlying series' default groupPadding and
  29346. * pointPadding settings.
  29347. */
  29348. jitter?: PlotBubbleJitterOptions;
  29349. /**
  29350. * (Highmaps) What property to join the `mapData` to the value data. For
  29351. * example, if joinBy is "code", the mapData items with a specific code is
  29352. * merged into the data with the same code. For maps loaded from GeoJSON,
  29353. * the keys may be held in each point's `properties` object.
  29354. *
  29355. * The joinBy option can also be an array of two values, where the first
  29356. * points to a key in the `mapData`, and the second points to another key in
  29357. * the `data`.
  29358. *
  29359. * When joinBy is `null`, the map items are joined by their position in the
  29360. * array, which performs much better in maps with many data points. This is
  29361. * the recommended option if you are printing more than a thousand data
  29362. * points and have a backend that can preprocess the data into a parallel
  29363. * array of the mapData.
  29364. */
  29365. joinBy?: (string|Array<string>);
  29366. /**
  29367. * (Highcharts, Highstock) An array specifying which option maps to which
  29368. * key in the data point array. This makes it convenient to work with
  29369. * unstructured data arrays from different sources.
  29370. */
  29371. keys?: Array<string>;
  29372. /**
  29373. * (Highcharts, Highstock, Gantt) Series labels are placed as close to the
  29374. * series as possible in a natural way, seeking to avoid other series. The
  29375. * goal of this feature is to make the chart more easily readable, like if a
  29376. * human designer placed the labels in the optimal position.
  29377. *
  29378. * The series labels currently work with series types having a `graph` or an
  29379. * `area`.
  29380. */
  29381. label?: SeriesLabelOptionsObject;
  29382. /**
  29383. * (Highstock) The line marks the last price from all points.
  29384. */
  29385. lastPrice?: SeriesLastPriceOptionsObject;
  29386. /**
  29387. * (Highstock) The line marks the last price from visible range of points.
  29388. */
  29389. lastVisiblePrice?: SeriesLastVisiblePriceOptionsObject;
  29390. /**
  29391. * (Highcharts, Highstock) The SVG value used for the `stroke-linecap` and
  29392. * `stroke-linejoin` of a line graph. Round means that lines are rounded in
  29393. * the ends and bends.
  29394. */
  29395. linecap?: SeriesLinecapValue;
  29396. /**
  29397. * (Highcharts, Highstock) The width of the line connecting the data points.
  29398. */
  29399. lineWidth?: number;
  29400. /**
  29401. * (Highcharts, Highstock, Gantt) The id of another series to link to.
  29402. * Additionally, the value can be ":previous" to link to the previous
  29403. * series. When two series are linked, only the first one appears in the
  29404. * legend. Toggling the visibility of this also toggles the linked series.
  29405. *
  29406. * If master series uses data sorting and linked series does not have its
  29407. * own sorting definition, the linked series will be sorted in the same
  29408. * order as the master one.
  29409. */
  29410. linkedTo?: string;
  29411. /**
  29412. * (Highcharts, Highstock) Options for the point markers of line-like
  29413. * series. Properties like `fillColor`, `lineColor` and `lineWidth` define
  29414. * the visual appearance of the markers. Other series types, like column
  29415. * series, don't have markers, but have visual options on the series level
  29416. * instead.
  29417. *
  29418. * In styled mode, the markers can be styled with the `.highcharts-point`,
  29419. * `.highcharts-point-hover` and `.highcharts-point-select` class names.
  29420. */
  29421. marker?: PointMarkerOptionsObject;
  29422. /**
  29423. * (Highcharts, Highstock) Maximum bubble size. Bubbles will automatically
  29424. * size between the `minSize` and `maxSize` to reflect the `z` value of each
  29425. * bubble. Can be either pixels (when no unit is given), or a percentage of
  29426. * the smallest one of the plot width and height.
  29427. */
  29428. maxSize?: (number|string);
  29429. /**
  29430. * (Highcharts, Highstock) Minimum bubble size. Bubbles will automatically
  29431. * size between the `minSize` and `maxSize` to reflect the `z` value of each
  29432. * bubble. Can be either pixels (when no unit is given), or a percentage of
  29433. * the smallest one of the plot width and height.
  29434. */
  29435. minSize?: (number|string);
  29436. /**
  29437. * (Highstock) Options for the corresponding navigator series if
  29438. * `showInNavigator` is `true` for this series. Available options are the
  29439. * same as any series, documented at plotOptions and series.
  29440. *
  29441. * These options are merged with options in navigator.series, and will take
  29442. * precedence if the same option is defined both places.
  29443. */
  29444. navigatorOptions?: PlotSeriesOptions;
  29445. /**
  29446. * (Highcharts) When a point's Z value is below the zThreshold setting, this
  29447. * color is used.
  29448. */
  29449. negativeColor?: (ColorString|GradientColorObject|PatternObject);
  29450. /**
  29451. * (Highcharts, Highstock) Opacity of a series parts: line, fill (e.g. area)
  29452. * and dataLabels.
  29453. */
  29454. opacity?: number;
  29455. /**
  29456. * (Highcharts, Highstock) Properties for each single point.
  29457. */
  29458. point?: PlotSeriesPointOptions;
  29459. /**
  29460. * (Highcharts, Highstock) Same as accessibility.pointDescriptionFormatter,
  29461. * but for an individual series. Overrides the chart wide configuration.
  29462. */
  29463. pointDescriptionFormatter?: Function;
  29464. /**
  29465. * (Highcharts, Highstock, Gantt) If no x values are given for the points in
  29466. * a series, `pointInterval` defines the interval of the x values. For
  29467. * example, if a series contains one value every decade starting from year
  29468. * 0, set `pointInterval` to `10`. In true `datetime` axes, the
  29469. * `pointInterval` is set in milliseconds.
  29470. *
  29471. * It can be also be combined with `pointIntervalUnit` to draw irregular
  29472. * time intervals.
  29473. *
  29474. * Please note that this options applies to the _series data_, not the
  29475. * interval of the axis ticks, which is independent.
  29476. */
  29477. pointInterval?: number;
  29478. /**
  29479. * (Highcharts, Highstock, Gantt) On datetime series, this allows for
  29480. * setting the pointInterval to irregular time units, `day`, `month` and
  29481. * `year`. A day is usually the same as 24 hours, but `pointIntervalUnit`
  29482. * also takes the DST crossover into consideration when dealing with local
  29483. * time. Combine this option with `pointInterval` to draw weeks, quarters, 6
  29484. * months, 10 years etc.
  29485. *
  29486. * Please note that this options applies to the _series data_, not the
  29487. * interval of the axis ticks, which is independent.
  29488. */
  29489. pointIntervalUnit?: OptionsPointIntervalUnitValue;
  29490. /**
  29491. * (Highstock) The width of each point on the x axis. For example in a
  29492. * column chart with one value each day, the pointRange would be 1 day (= 24
  29493. * * 3600
  29494. *
  29495. * * 1000 milliseconds). This is normally computed automatically, but this
  29496. * option can be used to override the automatic value.
  29497. */
  29498. pointRange?: number;
  29499. /**
  29500. * (Highcharts, Highstock, Gantt) If no x values are given for the points in
  29501. * a series, pointStart defines on what value to start. For example, if a
  29502. * series contains one yearly value starting from 1945, set pointStart to
  29503. * 1945.
  29504. */
  29505. pointStart?: number;
  29506. /**
  29507. * (Highcharts, Highstock) Whether to select the series initially. If
  29508. * `showCheckbox` is true, the checkbox next to the series name in the
  29509. * legend will be checked for a selected series.
  29510. */
  29511. selected?: boolean;
  29512. /**
  29513. * (Highcharts, Highstock) If true, a checkbox is displayed next to the
  29514. * legend item to allow selecting the series. The state of the checkbox is
  29515. * determined by the `selected` option.
  29516. */
  29517. showCheckbox?: boolean;
  29518. /**
  29519. * (Highcharts, Highstock) Whether to display this particular series or
  29520. * series type in the legend. Standalone series are shown in legend by
  29521. * default, and linked series are not. Since v7.2.0 it is possible to show
  29522. * series that use colorAxis by setting this option to `true`.
  29523. */
  29524. showInLegend?: boolean;
  29525. /**
  29526. * (Highstock) Whether or not to show the series in the navigator. Takes
  29527. * precedence over navigator.baseSeries if defined.
  29528. */
  29529. showInNavigator?: boolean;
  29530. /**
  29531. * (Highcharts, Highstock) Whether the bubble's value should be represented
  29532. * by the area or the width of the bubble. The default, `area`, corresponds
  29533. * best to the human perception of the size of each bubble.
  29534. */
  29535. sizeBy?: BubbleSizeByValue;
  29536. /**
  29537. * (Highcharts) When this is true, the absolute value of z determines the
  29538. * size of the bubble. This means that with the default `zThreshold` of 0, a
  29539. * bubble of value -1 will have the same size as a bubble of value 1, while
  29540. * a bubble of value 0 will have a smaller size according to `minSize`.
  29541. */
  29542. sizeByAbsoluteValue?: boolean;
  29543. /**
  29544. * (Highcharts, Highstock) If set to `true`, the accessibility module will
  29545. * skip past the points in this series for keyboard navigation.
  29546. */
  29547. skipKeyboardNavigation?: boolean;
  29548. /**
  29549. * (Highcharts) When this is true, the series will not cause the Y axis to
  29550. * cross the zero plane (or threshold option) unless the data actually
  29551. * crosses the plane.
  29552. *
  29553. * For example, if `softThreshold` is `false`, a series of 0, 1, 2, 3 will
  29554. * make the Y axis show negative values according to the `minPadding`
  29555. * option. If `softThreshold` is `true`, the Y axis starts at 0.
  29556. */
  29557. softThreshold?: boolean;
  29558. /**
  29559. * (Highcharts, Highstock) Whether to stack the values of each series on top
  29560. * of each other. Possible values are `undefined` to disable, `"normal"` to
  29561. * stack by value or `"percent"`.
  29562. *
  29563. * When stacking is enabled, data must be sorted in ascending X order.
  29564. *
  29565. * Some stacking options are related to specific series types. In the
  29566. * streamgraph series type, the stacking option is set to `"stream"`. The
  29567. * second one is `"overlap"`, which only applies to waterfall series.
  29568. */
  29569. stacking?: OptionsStackingValue;
  29570. states?: SeriesStatesOptionsObject;
  29571. /**
  29572. * (Highcharts, Highstock) Whether to apply steps to the line. Possible
  29573. * values are `left`, `center` and `right`.
  29574. */
  29575. step?: OptionsStepValue;
  29576. /**
  29577. * (Highcharts, Highstock) Sticky tracking of mouse events. When true, the
  29578. * `mouseOut` event on a series isn't triggered until the mouse moves over
  29579. * another series, or out of the plot area. When false, the `mouseOut` event
  29580. * on a series is triggered when the mouse leaves the area around the
  29581. * series' graph or markers. This also implies the tooltip. When
  29582. * `stickyTracking` is false and `tooltip.shared` is false, the tooltip will
  29583. * be hidden when moving the mouse between series.
  29584. */
  29585. stickyTracking?: boolean;
  29586. /**
  29587. * (Highcharts, Highstock) The threshold, also called zero level or base
  29588. * level. For line type series this is only used in conjunction with
  29589. * negativeColor.
  29590. */
  29591. threshold?: (number|null);
  29592. /**
  29593. * (Highcharts, Highstock) A configuration object for the tooltip rendering
  29594. * of each single series. Properties are inherited from tooltip. Overridable
  29595. * properties are `headerFormat`, `pointFormat`, `yDecimals`, `xDateFormat`,
  29596. * `yPrefix` and `ySuffix`. Unlike other series, in a scatter plot the
  29597. * series.name by default shows in the headerFormat and point.x and point.y
  29598. * in the pointFormat.
  29599. */
  29600. tooltip?: SeriesTooltipOptionsObject;
  29601. /**
  29602. * (Highcharts, Highstock, Gantt) When a series contains a data array that
  29603. * is longer than this, only one dimensional arrays of numbers, or two
  29604. * dimensional arrays with x and y values are allowed. Also, only the first
  29605. * point is tested, and the rest are assumed to be the same format. This
  29606. * saves expensive data checking and indexing in long series. Set it to `0`
  29607. * disable.
  29608. *
  29609. * Note: In boost mode turbo threshold is forced. Only array of numbers or
  29610. * two dimensional arrays are allowed.
  29611. */
  29612. turboThreshold?: number;
  29613. /**
  29614. * (Highcharts, Highstock) Set the initial visibility of the series.
  29615. */
  29616. visible?: boolean;
  29617. /**
  29618. * (Highmaps) Define the z index of the series.
  29619. */
  29620. zIndex?: number;
  29621. /**
  29622. * (Highcharts) The minimum for the Z value range. Defaults to the highest Z
  29623. * value in the data.
  29624. */
  29625. zMax?: number;
  29626. /**
  29627. * (Highcharts) The minimum for the Z value range. Defaults to the lowest Z
  29628. * value in the data.
  29629. */
  29630. zMin?: number;
  29631. /**
  29632. * (Highcharts, Highstock) Defines the Axis on which the zones are applied.
  29633. */
  29634. zoneAxis?: string;
  29635. /**
  29636. * (Highcharts, Highstock) An array defining zones within a series. Zones
  29637. * can be applied to the X axis, Y axis or Z axis for bubbles, according to
  29638. * the `zoneAxis` option. The zone definitions have to be in ascending order
  29639. * regarding to the value.
  29640. *
  29641. * In styled mode, the color zones are styled with the
  29642. * `.highcharts-zone-{n}` class, or custom classed from the `className`
  29643. * option (view live demo).
  29644. */
  29645. zones?: Array<SeriesZonesOptionsObject>;
  29646. /**
  29647. * (Highcharts) When displayNegative is `false`, bubbles with lower Z values
  29648. * are skipped. When `displayNegative` is `true` and a negativeColor is
  29649. * given, points with lower Z is colored.
  29650. */
  29651. zThreshold?: number;
  29652. }
  29653. /**
  29654. * (Highcharts) Enable or disable the initial animation when a series is
  29655. * displayed. The animation can also be set as a configuration object. Please
  29656. * note that this option only applies to the initial animation of the series
  29657. * itself. For other animations, see chart.animation and the animation parameter
  29658. * under the API methods. The following properties are supported:
  29659. *
  29660. * - `defer`: The animation delay time in milliseconds.
  29661. *
  29662. * - `duration`: The duration of the animation in milliseconds.
  29663. *
  29664. * - `easing`: Can be a string reference to an easing function set on the `Math`
  29665. * object or a function. See the _Custom easing function_ demo below.
  29666. *
  29667. * Due to poor performance, animation is disabled in old IE browsers for several
  29668. * chart types.
  29669. */
  29670. export interface PlotBulletAnimationOptions {
  29671. defer?: number;
  29672. }
  29673. /**
  29674. * (Highcharts, Highstock, Highmaps, Gantt) Enable or disable the initial
  29675. * animation when a series is displayed for the `dataLabels`. The animation can
  29676. * also be set as a configuration object. Please note that this option only
  29677. * applies to the initial animation. For other animations, see chart.animation
  29678. * and the animation parameter under the API methods. The following properties
  29679. * are supported:
  29680. *
  29681. * - `defer`: The animation delay time in milliseconds.
  29682. */
  29683. export interface PlotBulletDataLabelsAnimationOptions {
  29684. /**
  29685. * (Highcharts, Highstock, Highmaps, Gantt) The animation delay time in
  29686. * milliseconds. Set to `0` renders dataLabel immediately. As `undefined`
  29687. * inherits defer time from the series.animation.defer.
  29688. */
  29689. defer?: number;
  29690. }
  29691. /**
  29692. * (Highcharts, Highstock, Highmaps, Gantt) Options for the series data labels,
  29693. * appearing next to each data point.
  29694. *
  29695. * Since v6.2.0, multiple data labels can be applied to each single point by
  29696. * defining them as an array of configs.
  29697. *
  29698. * In styled mode, the data labels can be styled with the
  29699. * `.highcharts-data-label-box` and `.highcharts-data-label` class names (see
  29700. * example).
  29701. */
  29702. export interface PlotBulletDataLabelsOptions {
  29703. /**
  29704. * (Highcharts, Highstock, Highmaps, Gantt) The alignment of the data label
  29705. * compared to the point. If `right`, the right side of the label should be
  29706. * touching the point. For points with an extent, like columns, the
  29707. * alignments also dictates how to align it inside the box, as given with
  29708. * the inside option. Can be one of `left`, `center` or `right`.
  29709. */
  29710. align?: string;
  29711. /**
  29712. * (Highcharts, Highstock, Highmaps, Gantt) Whether to allow data labels to
  29713. * overlap. To make the labels less sensitive for overlapping, the
  29714. * dataLabels.padding can be set to 0.
  29715. */
  29716. allowOverlap?: boolean;
  29717. /**
  29718. * (Highcharts, Highstock, Highmaps, Gantt) Enable or disable the initial
  29719. * animation when a series is displayed for the `dataLabels`. The animation
  29720. * can also be set as a configuration object. Please note that this option
  29721. * only applies to the initial animation. For other animations, see
  29722. * chart.animation and the animation parameter under the API methods. The
  29723. * following properties are supported:
  29724. *
  29725. * - `defer`: The animation delay time in milliseconds.
  29726. */
  29727. animation?: (boolean|PlotBulletDataLabelsAnimationOptions|Partial<AnimationOptionsObject>);
  29728. /**
  29729. * (Highcharts, Highstock, Highmaps, Gantt) The background color or gradient
  29730. * for the data label.
  29731. */
  29732. backgroundColor?: (ColorString|GradientColorObject|PatternObject);
  29733. /**
  29734. * (Highcharts, Highstock, Highmaps, Gantt) The border color for the data
  29735. * label. Defaults to `undefined`.
  29736. */
  29737. borderColor?: (ColorString|GradientColorObject|PatternObject);
  29738. /**
  29739. * (Highcharts, Highstock, Highmaps, Gantt) The border radius in pixels for
  29740. * the data label.
  29741. */
  29742. borderRadius?: number;
  29743. /**
  29744. * (Highcharts, Highstock, Highmaps, Gantt) The border width in pixels for
  29745. * the data label.
  29746. */
  29747. borderWidth?: number;
  29748. /**
  29749. * (Highcharts, Highstock, Highmaps, Gantt) A class name for the data label.
  29750. * Particularly in styled mode, this can be used to give each series' or
  29751. * point's data label unique styling. In addition to this option, a default
  29752. * color class name is added so that we can give the labels a contrast text
  29753. * shadow.
  29754. */
  29755. className?: string;
  29756. /**
  29757. * (Highcharts, Highstock, Highmaps, Gantt) The text color for the data
  29758. * labels. Defaults to `undefined`. For certain series types, like column or
  29759. * map, the data labels can be drawn inside the points. In this case the
  29760. * data label will be drawn with maximum contrast by default. Additionally,
  29761. * it will be given a `text-outline` style with the opposite color, to
  29762. * further increase the contrast. This can be overridden by setting the
  29763. * `text-outline` style to `none` in the `dataLabels.style` option.
  29764. */
  29765. color?: (ColorString|GradientColorObject|PatternObject);
  29766. /**
  29767. * (Highcharts, Highstock, Highmaps, Gantt) Whether to hide data labels that
  29768. * are outside the plot area. By default, the data label is moved inside the
  29769. * plot area according to the overflow option.
  29770. */
  29771. crop?: boolean;
  29772. /**
  29773. * (Highcharts, Highstock, Gantt) Whether to defer displaying the data
  29774. * labels until the initial series animation has finished. Setting to
  29775. * `false` renders the data label immediately. If set to `true` inherits the
  29776. * defer time set in plotOptions.series.animation.
  29777. */
  29778. defer?: boolean;
  29779. /**
  29780. * (Highcharts, Highstock, Highmaps, Gantt) Enable or disable the data
  29781. * labels.
  29782. */
  29783. enabled?: boolean;
  29784. /**
  29785. * (Highcharts, Highstock, Highmaps, Gantt) A declarative filter to control
  29786. * of which data labels to display. The declarative filter is designed for
  29787. * use when callback functions are not available, like when the chart
  29788. * options require a pure JSON structure or for use with graphical editors.
  29789. * For programmatic control, use the `formatter` instead, and return
  29790. * `undefined` to disable a single data label.
  29791. */
  29792. filter?: DataLabelsFilterOptionsObject;
  29793. /**
  29794. * (Highcharts, Highstock, Highmaps, Gantt) A format string for the data
  29795. * label. Available variables are the same as for `formatter`.
  29796. */
  29797. format?: string;
  29798. /**
  29799. * (Highcharts, Highstock, Highmaps, Gantt) Callback JavaScript function to
  29800. * format the data label. Note that if a `format` is defined, the format
  29801. * takes precedence and the formatter is ignored.
  29802. */
  29803. formatter?: DataLabelsFormatterCallbackFunction;
  29804. /**
  29805. * (Highcharts, Highstock, Highmaps, Gantt) For points with an extent, like
  29806. * columns or map areas, whether to align the data label inside the box or
  29807. * to the actual value point. Defaults to `false` in most cases, `true` in
  29808. * stacked columns.
  29809. */
  29810. inside?: boolean;
  29811. /**
  29812. * (Highcharts, Highstock, Highmaps, Gantt) Format for points with the value
  29813. * of null. Works analogously to format. `nullFormat` can be applied only to
  29814. * series which support displaying null points.
  29815. */
  29816. nullFormat?: (boolean|string);
  29817. /**
  29818. * (Highcharts, Highstock, Highmaps, Gantt) Callback JavaScript function
  29819. * that defines formatting for points with the value of null. Works
  29820. * analogously to formatter. `nullPointFormatter` can be applied only to
  29821. * series which support displaying null points.
  29822. */
  29823. nullFormatter?: DataLabelsFormatterCallbackFunction;
  29824. /**
  29825. * (Highcharts, Highstock, Highmaps, Gantt) How to handle data labels that
  29826. * flow outside the plot area. The default is `"justify"`, which aligns them
  29827. * inside the plot area. For columns and bars, this means it will be moved
  29828. * inside the bar. To display data labels outside the plot area, set `crop`
  29829. * to `false` and `overflow` to `"allow"`.
  29830. */
  29831. overflow?: DataLabelsOverflowValue;
  29832. /**
  29833. * (Highcharts, Highstock, Highmaps, Gantt) When either the `borderWidth` or
  29834. * the `backgroundColor` is set, this is the padding within the box.
  29835. */
  29836. padding?: number;
  29837. /**
  29838. * (Highcharts, Highstock, Highmaps, Gantt) Aligns data labels relative to
  29839. * points. If `center` alignment is not possible, it defaults to `right`.
  29840. */
  29841. position?: AlignValue;
  29842. /**
  29843. * (Highcharts, Highstock, Highmaps, Gantt) Text rotation in degrees. Note
  29844. * that due to a more complex structure, backgrounds, borders and padding
  29845. * will be lost on a rotated data label.
  29846. */
  29847. rotation?: number;
  29848. /**
  29849. * (Highcharts, Highstock, Highmaps, Gantt) The shadow of the box. Works
  29850. * best with `borderWidth` or `backgroundColor`. Since 2.3 the shadow can be
  29851. * an object configuration containing `color`, `offsetX`, `offsetY`,
  29852. * `opacity` and `width`.
  29853. */
  29854. shadow?: (boolean|ShadowOptionsObject);
  29855. /**
  29856. * (Highcharts, Highstock, Highmaps, Gantt) The name of a symbol to use for
  29857. * the border around the label. Symbols are predefined functions on the
  29858. * Renderer object.
  29859. */
  29860. shape?: string;
  29861. /**
  29862. * (Highcharts, Highstock, Highmaps, Gantt) Styles for the label. The
  29863. * default `color` setting is `"contrast"`, which is a pseudo color that
  29864. * Highcharts picks up and applies the maximum contrast to the underlying
  29865. * point item, for example the bar in a bar chart.
  29866. *
  29867. * The `textOutline` is a pseudo property that applies an outline of the
  29868. * given width with the given color, which by default is the maximum
  29869. * contrast to the text. So a bright text color will result in a black text
  29870. * outline for maximum readability on a mixed background. In some cases,
  29871. * especially with grayscale text, the text outline doesn't work well, in
  29872. * which cases it can be disabled by setting it to `"none"`. When `useHTML`
  29873. * is true, the `textOutline` will not be picked up. In this, case, the same
  29874. * effect can be acheived through the `text-shadow` CSS property.
  29875. *
  29876. * For some series types, where each point has an extent, like for example
  29877. * tree maps, the data label may overflow the point. There are two
  29878. * strategies for handling overflow. By default, the text will wrap to
  29879. * multiple lines. The other strategy is to set `style.textOverflow` to
  29880. * `ellipsis`, which will keep the text on one line plus it will break
  29881. * inside long words.
  29882. */
  29883. style?: CSSObject;
  29884. /**
  29885. * (Highcharts, Highstock, Highmaps, Gantt) Options for a label text which
  29886. * should follow marker's shape. Border and background are disabled for a
  29887. * label that follows a path.
  29888. *
  29889. * **Note:** Only SVG-based renderer supports this option. Setting `useHTML`
  29890. * to true will disable this option.
  29891. */
  29892. textPath?: DataLabelsTextPathOptionsObject;
  29893. /**
  29894. * (Highcharts, Highstock, Highmaps, Gantt) Whether to use HTML to render
  29895. * the labels.
  29896. */
  29897. useHTML?: boolean;
  29898. /**
  29899. * (Highcharts, Highstock, Highmaps, Gantt) The vertical alignment of a data
  29900. * label. Can be one of `top`, `middle` or `bottom`. The default value
  29901. * depends on the data, for instance in a column chart, the label is above
  29902. * positive values and below negative values.
  29903. */
  29904. verticalAlign?: string;
  29905. /**
  29906. * (Highcharts, Highstock, Highmaps, Gantt) The x position offset of the
  29907. * label relative to the point in pixels.
  29908. */
  29909. x?: number;
  29910. /**
  29911. * (Highcharts, Highstock, Highmaps, Gantt) The y position offset of the
  29912. * label relative to the point in pixels.
  29913. */
  29914. y?: number;
  29915. /**
  29916. * (Highcharts, Highstock, Highmaps, Gantt) The Z index of the data labels.
  29917. * The default Z index puts it above the series. Use a Z index of 2 to
  29918. * display it behind the series.
  29919. */
  29920. z?: number;
  29921. }
  29922. /**
  29923. * (Highcharts) Style options for the guide box. The guide box has one state by
  29924. * default, the `default` state.
  29925. */
  29926. export interface PlotBulletDragDropGuideBoxOptions {
  29927. /**
  29928. * (Highcharts) Style options for the guide box default state.
  29929. */
  29930. default?: DragDropGuideBoxOptionsObject;
  29931. }
  29932. /**
  29933. * (Highcharts) A bullet graph is a variation of a bar graph. The bullet graph
  29934. * features a single measure, compares it to a target, and displays it in the
  29935. * context of qualitative ranges of performance that could be set using
  29936. * plotBands on yAxis.
  29937. *
  29938. * In TypeScript the type option must always be set.
  29939. *
  29940. * Configuration options for the series are given in three levels:
  29941. *
  29942. * 1. Options for all series in a chart are defined in the plotOptions.series
  29943. * object.
  29944. *
  29945. * 2. Options for all `bullet` series are defined in plotOptions.bullet.
  29946. *
  29947. * 3. Options for one single series are given in the series instance array. (see
  29948. * online documentation for example)
  29949. */
  29950. export interface PlotBulletOptions {
  29951. /**
  29952. * (Highcharts) Accessibility options for a series.
  29953. */
  29954. accessibility?: SeriesAccessibilityOptionsObject;
  29955. /**
  29956. * (Highcharts) Allow this series' points to be selected by clicking on the
  29957. * graphic (columns, point markers, pie slices, map areas etc).
  29958. *
  29959. * The selected points can be handled by point select and unselect events,
  29960. * or collectively by the getSelectedPoints function.
  29961. *
  29962. * And alternative way of selecting points is through dragging.
  29963. */
  29964. allowPointSelect?: boolean;
  29965. /**
  29966. * (Highcharts) Enable or disable the initial animation when a series is
  29967. * displayed. The animation can also be set as a configuration object.
  29968. * Please note that this option only applies to the initial animation of the
  29969. * series itself. For other animations, see chart.animation and the
  29970. * animation parameter under the API methods. The following properties are
  29971. * supported:
  29972. *
  29973. * - `defer`: The animation delay time in milliseconds.
  29974. *
  29975. * - `duration`: The duration of the animation in milliseconds.
  29976. *
  29977. * - `easing`: Can be a string reference to an easing function set on the
  29978. * `Math` object or a function. See the _Custom easing function_ demo below.
  29979. *
  29980. * Due to poor performance, animation is disabled in old IE browsers for
  29981. * several chart types.
  29982. */
  29983. animation?: (boolean|PlotBulletAnimationOptions|Partial<AnimationOptionsObject>);
  29984. /**
  29985. * (Highcharts) For some series, there is a limit that shuts down initial
  29986. * animation by default when the total number of points in the chart is too
  29987. * high. For example, for a column chart and its derivatives, animation does
  29988. * not run if there is more than 250 points totally. To disable this cap,
  29989. * set `animationLimit` to `Infinity`.
  29990. */
  29991. animationLimit?: number;
  29992. /**
  29993. * (Highcharts, Highstock, Gantt) The color of the border surrounding each
  29994. * column or bar.
  29995. *
  29996. * In styled mode, the border stroke can be set with the `.highcharts-point`
  29997. * rule.
  29998. */
  29999. borderColor?: (ColorString|GradientColorObject|PatternObject);
  30000. /**
  30001. * (Highcharts, Highstock, Gantt) The corner radius of the border
  30002. * surrounding each column or bar.
  30003. */
  30004. borderRadius?: number;
  30005. /**
  30006. * (Highcharts, Highstock, Gantt) The width of the border surrounding each
  30007. * column or bar. Defaults to `1` when there is room for a border, but to
  30008. * `0` when the columns are so dense that a border would cover the next
  30009. * column.
  30010. *
  30011. * In styled mode, the stroke width can be set with the `.highcharts-point`
  30012. * rule.
  30013. */
  30014. borderWidth?: number;
  30015. /**
  30016. * (Highcharts, Highstock, Gantt) When `true`, the columns will center in
  30017. * the category, ignoring null or missing points. When `false`, space will
  30018. * be reserved for null or missing points.
  30019. */
  30020. centerInCategory?: boolean;
  30021. /**
  30022. * (Highcharts) An additional class name to apply to the series' graphical
  30023. * elements. This option does not replace default class names of the
  30024. * graphical element.
  30025. */
  30026. className?: string;
  30027. /**
  30028. * (Highcharts) Disable this option to allow series rendering in the whole
  30029. * plotting area.
  30030. *
  30031. * **Note:** Clipping should be always enabled when chart.zoomType is set
  30032. */
  30033. clip?: boolean;
  30034. /**
  30035. * (Highcharts) The main color of the series. In line type series it applies
  30036. * to the line and the point markers unless otherwise specified. In bar type
  30037. * series it applies to the bars unless a color is specified per point. The
  30038. * default value is pulled from the `options.colors` array.
  30039. *
  30040. * In styled mode, the color can be defined by the colorIndex option. Also,
  30041. * the series color can be set with the `.highcharts-series`,
  30042. * `.highcharts-color-{n}`, `.highcharts-{type}-series` or
  30043. * `.highcharts-series-{n}` class, or individual classes given by the
  30044. * `className` option.
  30045. */
  30046. color?: (ColorString|GradientColorObject|PatternObject);
  30047. /**
  30048. * (Highcharts, Highstock, Gantt) When using automatic point colors pulled
  30049. * from the global colors or series-specific plotOptions.column.colors
  30050. * collections, this option determines whether the chart should receive one
  30051. * color per series or one color per point.
  30052. *
  30053. * In styled mode, the `colors` or `series.colors` arrays are not supported,
  30054. * and instead this option gives the points individual color class names on
  30055. * the form `highcharts-color-{n}`.
  30056. */
  30057. colorByPoint?: boolean;
  30058. /**
  30059. * (Highcharts) Styled mode only. A specific color index to use for the
  30060. * series, so its graphic representations are given the class name
  30061. * `highcharts-color-{n}`.
  30062. */
  30063. colorIndex?: number;
  30064. /**
  30065. * (Highcharts, Highstock, Highmaps) Determines what data value should be
  30066. * used to calculate point color if `colorAxis` is used. Requires to set
  30067. * `min` and `max` if some custom point property is used or if approximation
  30068. * for data grouping is set to `'sum'`.
  30069. */
  30070. colorKey?: string;
  30071. /**
  30072. * (Highcharts, Highstock, Gantt) A series specific or series type specific
  30073. * color set to apply instead of the global colors when colorByPoint is
  30074. * true.
  30075. */
  30076. colors?: Array<(ColorString|GradientColorObject|PatternObject)>;
  30077. /**
  30078. * (Highstock) Defines if comparison should start from the first point
  30079. * within the visible range or should start from the first point **before**
  30080. * the range.
  30081. *
  30082. * In other words, this flag determines if first point within the visible
  30083. * range will have 0% (`compareStart=true`) or should have been already
  30084. * calculated according to the previous point (`compareStart=false`).
  30085. */
  30086. compareStart?: boolean;
  30087. /**
  30088. * (Gantt) Override Pathfinder connector options for a series. Requires
  30089. * Highcharts Gantt to be loaded.
  30090. */
  30091. connectors?: SeriesConnectorsOptionsObject;
  30092. /**
  30093. * (Highcharts, Highstock, Gantt) When true, each point or column edge is
  30094. * rounded to its nearest pixel in order to render sharp on screen. In some
  30095. * cases, when there are a lot of densely packed columns, this leads to
  30096. * visible difference in column widths or distance between columns. In these
  30097. * cases, setting `crisp` to `false` may look better, even though each
  30098. * column is rendered blurry.
  30099. */
  30100. crisp?: boolean;
  30101. /**
  30102. * (Highcharts, Highstock, Gantt) When the series contains less points than
  30103. * the crop threshold, all points are drawn, event if the points fall
  30104. * outside the visible plot area at the current zoom. The advantage of
  30105. * drawing all points (including markers and columns), is that animation is
  30106. * performed on updates. On the other hand, when the series contains more
  30107. * points than the crop threshold, the series data is cropped to only
  30108. * contain points that fall within the plot area. The advantage of cropping
  30109. * away invisible points is to increase performance on large series.
  30110. */
  30111. cropThreshold?: number;
  30112. /**
  30113. * (Highcharts) You can set the cursor to "pointer" if you have click events
  30114. * attached to the series, to signal to the user that the points and lines
  30115. * can be clicked.
  30116. *
  30117. * In styled mode, the series cursor can be set with the same classes as
  30118. * listed under series.color.
  30119. */
  30120. cursor?: (string|CursorValue);
  30121. /**
  30122. * (Highcharts) A reserved subspace to store options and values for
  30123. * customized functionality. Here you can add additional data for your own
  30124. * event callbacks and formatter callbacks.
  30125. */
  30126. custom?: Dictionary<any>;
  30127. /**
  30128. * (Highcharts) Name of the dash style to use for the graph, or for some
  30129. * series types the outline of each shape.
  30130. *
  30131. * In styled mode, the stroke dash-array can be set with the same classes as
  30132. * listed under series.color.
  30133. */
  30134. dashStyle?: DashStyleValue;
  30135. /**
  30136. * (Highstock) Data grouping is the concept of sampling the data values into
  30137. * larger blocks in order to ease readability and increase performance of
  30138. * the JavaScript charts. Highstock by default applies data grouping when
  30139. * the points become closer than a certain pixel value, determined by the
  30140. * `groupPixelWidth` option.
  30141. *
  30142. * If data grouping is applied, the grouping information of grouped points
  30143. * can be read from the Point.dataGroup. If point options other than the
  30144. * data itself are set, for example `name` or `color` or custom properties,
  30145. * the grouping logic doesn't know how to group it. In this case the options
  30146. * of the first point instance are copied over to the group point. This can
  30147. * be altered through a custom `approximation` callback function.
  30148. */
  30149. dataGrouping?: DataGroupingOptionsObject;
  30150. /**
  30151. * (Highcharts, Highstock, Highmaps, Gantt) Options for the series data
  30152. * labels, appearing next to each data point.
  30153. *
  30154. * Since v6.2.0, multiple data labels can be applied to each single point by
  30155. * defining them as an array of configs.
  30156. *
  30157. * In styled mode, the data labels can be styled with the
  30158. * `.highcharts-data-label-box` and `.highcharts-data-label` class names
  30159. * (see example).
  30160. */
  30161. dataLabels?: (PlotBulletDataLabelsOptions|Array<PlotBulletDataLabelsOptions>);
  30162. /**
  30163. * (Highcharts) Depth of the columns in a 3D column chart.
  30164. */
  30165. depth?: number;
  30166. /**
  30167. * (Highcharts) A description of the series to add to the screen reader
  30168. * information about the series.
  30169. */
  30170. description?: string;
  30171. /**
  30172. * (Highcharts) The draggable-points module allows points to be moved around
  30173. * or modified in the chart. In addition to the options mentioned under the
  30174. * `dragDrop` API structure, the module fires three events, point.dragStart,
  30175. * point.drag and point.drop.
  30176. */
  30177. dragDrop?: SeriesDragDropOptionsObject;
  30178. /**
  30179. * (Highcharts) 3D columns only. The color of the edges. Similar to
  30180. * `borderColor`, except it defaults to the same color as the column.
  30181. */
  30182. edgeColor?: ColorString;
  30183. /**
  30184. * (Highcharts) 3D columns only. The width of the colored edges.
  30185. */
  30186. edgeWidth?: number;
  30187. /**
  30188. * (Highcharts) Enable or disable the mouse tracking for a specific series.
  30189. * This includes point tooltips and click events on graphs and points. For
  30190. * large datasets it improves performance.
  30191. */
  30192. enableMouseTracking?: boolean;
  30193. /**
  30194. * (Highcharts) General event handlers for the series items. These event
  30195. * hooks can also be attached to the series at run time using the
  30196. * `Highcharts.addEvent` function.
  30197. */
  30198. events?: SeriesEventsOptionsObject;
  30199. /**
  30200. * (Highcharts) Determines whether the series should look for the nearest
  30201. * point in both dimensions or just the x-dimension when hovering the
  30202. * series. Defaults to `'xy'` for scatter series and `'x'` for most other
  30203. * series. If the data has duplicate x-values, it is recommended to set this
  30204. * to `'xy'` to allow hovering over all points.
  30205. *
  30206. * Applies only to series types using nearest neighbor search (not direct
  30207. * hover) for tooltip.
  30208. */
  30209. findNearestPointBy?: OptionsFindNearestPointByValue;
  30210. /**
  30211. * (Highcharts, Highstock, Gantt) Whether to use the Y extremes of the total
  30212. * chart width or only the zoomed area when zooming in on parts of the X
  30213. * axis. By default, the Y axis adjusts to the min and max of the visible
  30214. * data. Cartesian series only.
  30215. */
  30216. getExtremesFromAll?: boolean;
  30217. /**
  30218. * (Highcharts, Highstock, Gantt) Whether to group non-stacked columns or to
  30219. * let them render independent of each other. Non-grouped columns will be
  30220. * laid out individually and overlap each other.
  30221. */
  30222. grouping?: boolean;
  30223. /**
  30224. * (Highcharts, Highstock, Gantt) Padding between each value groups, in x
  30225. * axis units.
  30226. */
  30227. groupPadding?: number;
  30228. /**
  30229. * (Highcharts) The spacing between columns on the Z Axis in a 3D chart.
  30230. */
  30231. groupZPadding?: number;
  30232. /**
  30233. * (Highcharts) When set to `false` will prevent the series data from being
  30234. * included in any form of data export.
  30235. *
  30236. * Since version 6.0.0 until 7.1.0 the option was existing undocumented as
  30237. * `includeInCSVExport`.
  30238. */
  30239. includeInDataExport?: boolean;
  30240. /**
  30241. * (Highmaps) What property to join the `mapData` to the value data. For
  30242. * example, if joinBy is "code", the mapData items with a specific code is
  30243. * merged into the data with the same code. For maps loaded from GeoJSON,
  30244. * the keys may be held in each point's `properties` object.
  30245. *
  30246. * The joinBy option can also be an array of two values, where the first
  30247. * points to a key in the `mapData`, and the second points to another key in
  30248. * the `data`.
  30249. *
  30250. * When joinBy is `null`, the map items are joined by their position in the
  30251. * array, which performs much better in maps with many data points. This is
  30252. * the recommended option if you are printing more than a thousand data
  30253. * points and have a backend that can preprocess the data into a parallel
  30254. * array of the mapData.
  30255. */
  30256. joinBy?: (string|Array<string>);
  30257. /**
  30258. * (Highcharts) An array specifying which option maps to which key in the
  30259. * data point array. This makes it convenient to work with unstructured data
  30260. * arrays from different sources.
  30261. */
  30262. keys?: Array<string>;
  30263. /**
  30264. * (Highcharts, Highstock, Gantt) Series labels are placed as close to the
  30265. * series as possible in a natural way, seeking to avoid other series. The
  30266. * goal of this feature is to make the chart more easily readable, like if a
  30267. * human designer placed the labels in the optimal position.
  30268. *
  30269. * The series labels currently work with series types having a `graph` or an
  30270. * `area`.
  30271. */
  30272. label?: SeriesLabelOptionsObject;
  30273. /**
  30274. * (Highstock) The line marks the last price from all points.
  30275. */
  30276. lastPrice?: SeriesLastPriceOptionsObject;
  30277. /**
  30278. * (Highstock) The line marks the last price from visible range of points.
  30279. */
  30280. lastVisiblePrice?: SeriesLastVisiblePriceOptionsObject;
  30281. /**
  30282. * (Highcharts, Highstock, Gantt) The id of another series to link to.
  30283. * Additionally, the value can be ":previous" to link to the previous
  30284. * series. When two series are linked, only the first one appears in the
  30285. * legend. Toggling the visibility of this also toggles the linked series.
  30286. *
  30287. * If master series uses data sorting and linked series does not have its
  30288. * own sorting definition, the linked series will be sorted in the same
  30289. * order as the master one.
  30290. */
  30291. linkedTo?: string;
  30292. /**
  30293. * (Highcharts, Highstock, Gantt) The maximum allowed pixel width for a
  30294. * column, translated to the height of a bar in a bar chart. This prevents
  30295. * the columns from becoming too wide when there is a small number of points
  30296. * in the chart.
  30297. */
  30298. maxPointWidth?: number;
  30299. /**
  30300. * (Highcharts, Highstock, Gantt) The minimal height for a column or width
  30301. * for a bar. By default, 0 values are not shown. To visualize a 0 (or close
  30302. * to zero) point, set the minimal point length to a pixel value like 3\. In
  30303. * stacked column charts, minPointLength might not be respected for tightly
  30304. * packed values.
  30305. */
  30306. minPointLength?: number;
  30307. /**
  30308. * (Highstock) Options for the corresponding navigator series if
  30309. * `showInNavigator` is `true` for this series. Available options are the
  30310. * same as any series, documented at plotOptions and series.
  30311. *
  30312. * These options are merged with options in navigator.series, and will take
  30313. * precedence if the same option is defined both places.
  30314. */
  30315. navigatorOptions?: PlotSeriesOptions;
  30316. /**
  30317. * (Highcharts) The color for the parts of the graph or points that are
  30318. * below the threshold. Note that `zones` takes precedence over the negative
  30319. * color. Using `negativeColor` is equivalent to applying a zone with value
  30320. * of 0.
  30321. */
  30322. negativeColor?: (ColorString|GradientColorObject|PatternObject);
  30323. /**
  30324. * (Highcharts) Opacity of a series parts: line, fill (e.g. area) and
  30325. * dataLabels.
  30326. */
  30327. opacity?: number;
  30328. /**
  30329. * (Highcharts) Properties for each single point.
  30330. */
  30331. point?: PlotSeriesPointOptions;
  30332. /**
  30333. * (Highcharts) Same as accessibility.pointDescriptionFormatter, but for an
  30334. * individual series. Overrides the chart wide configuration.
  30335. */
  30336. pointDescriptionFormatter?: Function;
  30337. /**
  30338. * (Highcharts, Highstock, Gantt) If no x values are given for the points in
  30339. * a series, `pointInterval` defines the interval of the x values. For
  30340. * example, if a series contains one value every decade starting from year
  30341. * 0, set `pointInterval` to `10`. In true `datetime` axes, the
  30342. * `pointInterval` is set in milliseconds.
  30343. *
  30344. * It can be also be combined with `pointIntervalUnit` to draw irregular
  30345. * time intervals.
  30346. *
  30347. * Please note that this options applies to the _series data_, not the
  30348. * interval of the axis ticks, which is independent.
  30349. */
  30350. pointInterval?: number;
  30351. /**
  30352. * (Highcharts, Highstock, Gantt) On datetime series, this allows for
  30353. * setting the pointInterval to irregular time units, `day`, `month` and
  30354. * `year`. A day is usually the same as 24 hours, but `pointIntervalUnit`
  30355. * also takes the DST crossover into consideration when dealing with local
  30356. * time. Combine this option with `pointInterval` to draw weeks, quarters, 6
  30357. * months, 10 years etc.
  30358. *
  30359. * Please note that this options applies to the _series data_, not the
  30360. * interval of the axis ticks, which is independent.
  30361. */
  30362. pointIntervalUnit?: OptionsPointIntervalUnitValue;
  30363. /**
  30364. * (Highcharts, Highstock, Gantt) Padding between each column or bar, in x
  30365. * axis units.
  30366. */
  30367. pointPadding?: number;
  30368. /**
  30369. * (Highcharts, Highstock, Gantt) Possible values: `"on"`, `"between"`,
  30370. * `number`.
  30371. *
  30372. * In a column chart, when pointPlacement is `"on"`, the point will not
  30373. * create any padding of the X axis. In a polar column chart this means that
  30374. * the first column points directly north. If the pointPlacement is
  30375. * `"between"`, the columns will be laid out between ticks. This is useful
  30376. * for example for visualising an amount between two points in time or in a
  30377. * certain sector of a polar chart.
  30378. *
  30379. * Since Highcharts 3.0.2, the point placement can also be numeric, where 0
  30380. * is on the axis value, -0.5 is between this value and the previous, and
  30381. * 0.5 is between this value and the next. Unlike the textual options,
  30382. * numeric point placement options won't affect axis padding.
  30383. *
  30384. * Note that pointPlacement needs a pointRange to work. For column series
  30385. * this is computed, but for line-type series it needs to be set.
  30386. *
  30387. * For the `xrange` series type and gantt charts, if the Y axis is a
  30388. * category axis, the `pointPlacement` applies to the Y axis rather than the
  30389. * (typically datetime) X axis.
  30390. *
  30391. * Defaults to `undefined` in cartesian charts, `"between"` in polar charts.
  30392. */
  30393. pointPlacement?: (number|string);
  30394. /**
  30395. * (Highcharts, Highstock, Gantt) The X axis range that each point is valid
  30396. * for. This determines the width of the column. On a categorized axis, the
  30397. * range will be 1 by default (one category unit). On linear and datetime
  30398. * axes, the range will be computed as the distance between the two closest
  30399. * data points.
  30400. *
  30401. * The default `null` means it is computed automatically, but this option
  30402. * can be used to override the automatic value.
  30403. *
  30404. * This option is set by default to 1 if data sorting is enabled.
  30405. */
  30406. pointRange?: (number|null);
  30407. /**
  30408. * (Highcharts, Highstock, Gantt) If no x values are given for the points in
  30409. * a series, pointStart defines on what value to start. For example, if a
  30410. * series contains one yearly value starting from 1945, set pointStart to
  30411. * 1945.
  30412. */
  30413. pointStart?: number;
  30414. /**
  30415. * (Highcharts, Highstock, Gantt) A pixel value specifying a fixed width for
  30416. * each column or bar point. When set to `undefined`, the width is
  30417. * calculated from the `pointPadding` and `groupPadding`. The width effects
  30418. * the dimension that is not based on the point value. For column series it
  30419. * is the hoizontal length and for bar series it is the vertical length.
  30420. */
  30421. pointWidth?: number;
  30422. /**
  30423. * (Highcharts) Whether to select the series initially. If `showCheckbox` is
  30424. * true, the checkbox next to the series name in the legend will be checked
  30425. * for a selected series.
  30426. */
  30427. selected?: boolean;
  30428. /**
  30429. * (Highcharts) Whether to apply a drop shadow to the graph line. Since 2.3
  30430. * the shadow can be an object configuration containing `color`, `offsetX`,
  30431. * `offsetY`, `opacity` and `width`.
  30432. */
  30433. shadow?: (boolean|ShadowOptionsObject);
  30434. /**
  30435. * (Highcharts) If true, a checkbox is displayed next to the legend item to
  30436. * allow selecting the series. The state of the checkbox is determined by
  30437. * the `selected` option.
  30438. */
  30439. showCheckbox?: boolean;
  30440. /**
  30441. * (Highcharts) Whether to display this particular series or series type in
  30442. * the legend. Standalone series are shown in legend by default, and linked
  30443. * series are not. Since v7.2.0 it is possible to show series that use
  30444. * colorAxis by setting this option to `true`.
  30445. */
  30446. showInLegend?: boolean;
  30447. /**
  30448. * (Highstock) Whether or not to show the series in the navigator. Takes
  30449. * precedence over navigator.baseSeries if defined.
  30450. */
  30451. showInNavigator?: boolean;
  30452. /**
  30453. * (Highcharts) If set to `true`, the accessibility module will skip past
  30454. * the points in this series for keyboard navigation.
  30455. */
  30456. skipKeyboardNavigation?: boolean;
  30457. /**
  30458. * (Highcharts, Highstock) When this is true, the series will not cause the
  30459. * Y axis to cross the zero plane (or threshold option) unless the data
  30460. * actually crosses the plane.
  30461. *
  30462. * For example, if `softThreshold` is `false`, a series of 0, 1, 2, 3 will
  30463. * make the Y axis show negative values according to the `minPadding`
  30464. * option. If `softThreshold` is `true`, the Y axis starts at 0.
  30465. */
  30466. softThreshold?: boolean;
  30467. /**
  30468. * (Highcharts, Highstock) Whether to stack the values of each series on top
  30469. * of each other. Possible values are `undefined` to disable, `"normal"` to
  30470. * stack by value or `"percent"`.
  30471. *
  30472. * When stacking is enabled, data must be sorted in ascending X order.
  30473. *
  30474. * Some stacking options are related to specific series types. In the
  30475. * streamgraph series type, the stacking option is set to `"stream"`. The
  30476. * second one is `"overlap"`, which only applies to waterfall series.
  30477. */
  30478. stacking?: OptionsStackingValue;
  30479. states?: SeriesStatesOptionsObject;
  30480. /**
  30481. * (Highcharts) Sticky tracking of mouse events. When true, the `mouseOut`
  30482. * event on a series isn't triggered until the mouse moves over another
  30483. * series, or out of the plot area. When false, the `mouseOut` event on a
  30484. * series is triggered when the mouse leaves the area around the series'
  30485. * graph or markers. This also implies the tooltip when not shared. When
  30486. * `stickyTracking` is false and `tooltip.shared` is false, the tooltip will
  30487. * be hidden when moving the mouse between series. Defaults to true for line
  30488. * and area type series, but to false for columns, pies etc.
  30489. *
  30490. * **Note:** The boost module will force this option because of technical
  30491. * limitations.
  30492. */
  30493. stickyTracking?: boolean;
  30494. /**
  30495. * (Highcharts) All options related with look and positiong of targets.
  30496. */
  30497. targetOptions?: PlotBulletTargetOptions;
  30498. /**
  30499. * (Highcharts) The Y axis value to serve as the base for the columns, for
  30500. * distinguishing between values above and below a threshold. If `null`, the
  30501. * columns extend from the padding Y axis minimum.
  30502. */
  30503. threshold?: (number|null);
  30504. /**
  30505. * (Highcharts) A configuration object for the tooltip rendering of each
  30506. * single series. Properties are inherited from tooltip, but only the
  30507. * following properties can be defined on a series level.
  30508. */
  30509. tooltip?: SeriesTooltipOptionsObject;
  30510. /**
  30511. * (Highcharts, Highstock, Gantt) When a series contains a data array that
  30512. * is longer than this, only one dimensional arrays of numbers, or two
  30513. * dimensional arrays with x and y values are allowed. Also, only the first
  30514. * point is tested, and the rest are assumed to be the same format. This
  30515. * saves expensive data checking and indexing in long series. Set it to `0`
  30516. * disable.
  30517. *
  30518. * Note: In boost mode turbo threshold is forced. Only array of numbers or
  30519. * two dimensional arrays are allowed.
  30520. */
  30521. turboThreshold?: number;
  30522. /**
  30523. * (Highcharts) Set the initial visibility of the series.
  30524. */
  30525. visible?: boolean;
  30526. /**
  30527. * (Highmaps) Define the z index of the series.
  30528. */
  30529. zIndex?: number;
  30530. /**
  30531. * (Highcharts, Highstock) Defines the Axis on which the zones are applied.
  30532. */
  30533. zoneAxis?: string;
  30534. /**
  30535. * (Highcharts, Highstock) An array defining zones within a series. Zones
  30536. * can be applied to the X axis, Y axis or Z axis for bubbles, according to
  30537. * the `zoneAxis` option. The zone definitions have to be in ascending order
  30538. * regarding to the value.
  30539. *
  30540. * In styled mode, the color zones are styled with the
  30541. * `.highcharts-zone-{n}` class, or custom classed from the `className`
  30542. * option (view live demo).
  30543. */
  30544. zones?: Array<SeriesZonesOptionsObject>;
  30545. }
  30546. /**
  30547. * (Highcharts) All options related with look and positiong of targets.
  30548. */
  30549. export interface PlotBulletTargetOptions {
  30550. /**
  30551. * (Highcharts) The border color of the rectangle representing the target.
  30552. * When not set, the point's border color is used.
  30553. *
  30554. * In styled mode, use class `highcharts-bullet-target` instead.
  30555. */
  30556. borderColor?: ColorString;
  30557. /**
  30558. * (Highcharts) The border width of the rectangle representing the target.
  30559. *
  30560. * In styled mode, use class `highcharts-bullet-target` instead.
  30561. */
  30562. borderWidth?: number;
  30563. /**
  30564. * (Highcharts) The color of the rectangle representing the target. When not
  30565. * set, point's color (if set in point's options - `color`) or zone of the
  30566. * target value (if `zones` or `negativeColor` are set) or the same color as
  30567. * the point has is used.
  30568. *
  30569. * In styled mode, use class `highcharts-bullet-target` instead.
  30570. */
  30571. color?: (ColorString|GradientColorObject|PatternObject);
  30572. /**
  30573. * (Highcharts) The height of the rectangle representing the target.
  30574. */
  30575. height?: number;
  30576. /**
  30577. * (Highcharts) The width of the rectangle representing the target. Could be
  30578. * set as a pixel value or as a percentage of a column width.
  30579. */
  30580. width?: (number|string);
  30581. }
  30582. /**
  30583. * (Highstock) Enable or disable the initial animation when a series is
  30584. * displayed. The animation can also be set as a configuration object. Please
  30585. * note that this option only applies to the initial animation of the series
  30586. * itself. For other animations, see chart.animation and the animation parameter
  30587. * under the API methods. The following properties are supported:
  30588. *
  30589. * - `defer`: The animation delay time in milliseconds.
  30590. *
  30591. * - `duration`: The duration of the animation in milliseconds.
  30592. *
  30593. * - `easing`: Can be a string reference to an easing function set on the `Math`
  30594. * object or a function. See the _Custom easing function_ demo below.
  30595. *
  30596. * Due to poor performance, animation is disabled in old IE browsers for several
  30597. * chart types.
  30598. */
  30599. export interface PlotCandlestickAnimationOptions {
  30600. defer?: number;
  30601. }
  30602. /**
  30603. * (Highcharts, Highstock, Highmaps, Gantt) Enable or disable the initial
  30604. * animation when a series is displayed for the `dataLabels`. The animation can
  30605. * also be set as a configuration object. Please note that this option only
  30606. * applies to the initial animation. For other animations, see chart.animation
  30607. * and the animation parameter under the API methods. The following properties
  30608. * are supported:
  30609. *
  30610. * - `defer`: The animation delay time in milliseconds.
  30611. */
  30612. export interface PlotCandlestickDataLabelsAnimationOptions {
  30613. /**
  30614. * (Highcharts, Highstock, Highmaps, Gantt) The animation delay time in
  30615. * milliseconds. Set to `0` renders dataLabel immediately. As `undefined`
  30616. * inherits defer time from the series.animation.defer.
  30617. */
  30618. defer?: number;
  30619. }
  30620. /**
  30621. * (Highcharts, Highstock, Highmaps, Gantt) Options for the series data labels,
  30622. * appearing next to each data point.
  30623. *
  30624. * Since v6.2.0, multiple data labels can be applied to each single point by
  30625. * defining them as an array of configs.
  30626. *
  30627. * In styled mode, the data labels can be styled with the
  30628. * `.highcharts-data-label-box` and `.highcharts-data-label` class names (see
  30629. * example).
  30630. */
  30631. export interface PlotCandlestickDataLabelsOptions {
  30632. /**
  30633. * (Highcharts, Highstock, Highmaps, Gantt) The alignment of the data label
  30634. * compared to the point. If `right`, the right side of the label should be
  30635. * touching the point. For points with an extent, like columns, the
  30636. * alignments also dictates how to align it inside the box, as given with
  30637. * the inside option. Can be one of `left`, `center` or `right`.
  30638. */
  30639. align?: string;
  30640. /**
  30641. * (Highcharts, Highstock, Highmaps, Gantt) Whether to allow data labels to
  30642. * overlap. To make the labels less sensitive for overlapping, the
  30643. * dataLabels.padding can be set to 0.
  30644. */
  30645. allowOverlap?: boolean;
  30646. /**
  30647. * (Highcharts, Highstock, Highmaps, Gantt) Enable or disable the initial
  30648. * animation when a series is displayed for the `dataLabels`. The animation
  30649. * can also be set as a configuration object. Please note that this option
  30650. * only applies to the initial animation. For other animations, see
  30651. * chart.animation and the animation parameter under the API methods. The
  30652. * following properties are supported:
  30653. *
  30654. * - `defer`: The animation delay time in milliseconds.
  30655. */
  30656. animation?: (boolean|PlotCandlestickDataLabelsAnimationOptions|Partial<AnimationOptionsObject>);
  30657. /**
  30658. * (Highcharts, Highstock, Highmaps, Gantt) The background color or gradient
  30659. * for the data label.
  30660. */
  30661. backgroundColor?: (ColorString|GradientColorObject|PatternObject);
  30662. /**
  30663. * (Highcharts, Highstock, Highmaps, Gantt) The border color for the data
  30664. * label. Defaults to `undefined`.
  30665. */
  30666. borderColor?: (ColorString|GradientColorObject|PatternObject);
  30667. /**
  30668. * (Highcharts, Highstock, Highmaps, Gantt) The border radius in pixels for
  30669. * the data label.
  30670. */
  30671. borderRadius?: number;
  30672. /**
  30673. * (Highcharts, Highstock, Highmaps, Gantt) The border width in pixels for
  30674. * the data label.
  30675. */
  30676. borderWidth?: number;
  30677. /**
  30678. * (Highcharts, Highstock, Highmaps, Gantt) A class name for the data label.
  30679. * Particularly in styled mode, this can be used to give each series' or
  30680. * point's data label unique styling. In addition to this option, a default
  30681. * color class name is added so that we can give the labels a contrast text
  30682. * shadow.
  30683. */
  30684. className?: string;
  30685. /**
  30686. * (Highcharts, Highstock, Highmaps, Gantt) The text color for the data
  30687. * labels. Defaults to `undefined`. For certain series types, like column or
  30688. * map, the data labels can be drawn inside the points. In this case the
  30689. * data label will be drawn with maximum contrast by default. Additionally,
  30690. * it will be given a `text-outline` style with the opposite color, to
  30691. * further increase the contrast. This can be overridden by setting the
  30692. * `text-outline` style to `none` in the `dataLabels.style` option.
  30693. */
  30694. color?: (ColorString|GradientColorObject|PatternObject);
  30695. /**
  30696. * (Highcharts, Highstock, Highmaps, Gantt) Whether to hide data labels that
  30697. * are outside the plot area. By default, the data label is moved inside the
  30698. * plot area according to the overflow option.
  30699. */
  30700. crop?: boolean;
  30701. /**
  30702. * (Highcharts, Highstock, Gantt) Whether to defer displaying the data
  30703. * labels until the initial series animation has finished. Setting to
  30704. * `false` renders the data label immediately. If set to `true` inherits the
  30705. * defer time set in plotOptions.series.animation.
  30706. */
  30707. defer?: boolean;
  30708. /**
  30709. * (Highcharts, Highstock, Highmaps, Gantt) Enable or disable the data
  30710. * labels.
  30711. */
  30712. enabled?: boolean;
  30713. /**
  30714. * (Highcharts, Highstock, Highmaps, Gantt) A declarative filter to control
  30715. * of which data labels to display. The declarative filter is designed for
  30716. * use when callback functions are not available, like when the chart
  30717. * options require a pure JSON structure or for use with graphical editors.
  30718. * For programmatic control, use the `formatter` instead, and return
  30719. * `undefined` to disable a single data label.
  30720. */
  30721. filter?: DataLabelsFilterOptionsObject;
  30722. /**
  30723. * (Highcharts, Highstock, Highmaps, Gantt) A format string for the data
  30724. * label. Available variables are the same as for `formatter`.
  30725. */
  30726. format?: string;
  30727. /**
  30728. * (Highcharts, Highstock, Highmaps, Gantt) Callback JavaScript function to
  30729. * format the data label. Note that if a `format` is defined, the format
  30730. * takes precedence and the formatter is ignored.
  30731. */
  30732. formatter?: DataLabelsFormatterCallbackFunction;
  30733. /**
  30734. * (Highcharts, Highstock, Highmaps, Gantt) For points with an extent, like
  30735. * columns or map areas, whether to align the data label inside the box or
  30736. * to the actual value point. Defaults to `false` in most cases, `true` in
  30737. * stacked columns.
  30738. */
  30739. inside?: boolean;
  30740. /**
  30741. * (Highcharts, Highstock, Highmaps, Gantt) Format for points with the value
  30742. * of null. Works analogously to format. `nullFormat` can be applied only to
  30743. * series which support displaying null points.
  30744. */
  30745. nullFormat?: (boolean|string);
  30746. /**
  30747. * (Highcharts, Highstock, Highmaps, Gantt) Callback JavaScript function
  30748. * that defines formatting for points with the value of null. Works
  30749. * analogously to formatter. `nullPointFormatter` can be applied only to
  30750. * series which support displaying null points.
  30751. */
  30752. nullFormatter?: DataLabelsFormatterCallbackFunction;
  30753. /**
  30754. * (Highcharts, Highstock, Highmaps, Gantt) How to handle data labels that
  30755. * flow outside the plot area. The default is `"justify"`, which aligns them
  30756. * inside the plot area. For columns and bars, this means it will be moved
  30757. * inside the bar. To display data labels outside the plot area, set `crop`
  30758. * to `false` and `overflow` to `"allow"`.
  30759. */
  30760. overflow?: DataLabelsOverflowValue;
  30761. /**
  30762. * (Highcharts, Highstock, Highmaps, Gantt) When either the `borderWidth` or
  30763. * the `backgroundColor` is set, this is the padding within the box.
  30764. */
  30765. padding?: number;
  30766. /**
  30767. * (Highcharts, Highstock, Highmaps, Gantt) Aligns data labels relative to
  30768. * points. If `center` alignment is not possible, it defaults to `right`.
  30769. */
  30770. position?: AlignValue;
  30771. /**
  30772. * (Highcharts, Highstock, Highmaps, Gantt) Text rotation in degrees. Note
  30773. * that due to a more complex structure, backgrounds, borders and padding
  30774. * will be lost on a rotated data label.
  30775. */
  30776. rotation?: number;
  30777. /**
  30778. * (Highcharts, Highstock, Highmaps, Gantt) The shadow of the box. Works
  30779. * best with `borderWidth` or `backgroundColor`. Since 2.3 the shadow can be
  30780. * an object configuration containing `color`, `offsetX`, `offsetY`,
  30781. * `opacity` and `width`.
  30782. */
  30783. shadow?: (boolean|ShadowOptionsObject);
  30784. /**
  30785. * (Highcharts, Highstock, Highmaps, Gantt) The name of a symbol to use for
  30786. * the border around the label. Symbols are predefined functions on the
  30787. * Renderer object.
  30788. */
  30789. shape?: string;
  30790. /**
  30791. * (Highcharts, Highstock, Highmaps, Gantt) Styles for the label. The
  30792. * default `color` setting is `"contrast"`, which is a pseudo color that
  30793. * Highcharts picks up and applies the maximum contrast to the underlying
  30794. * point item, for example the bar in a bar chart.
  30795. *
  30796. * The `textOutline` is a pseudo property that applies an outline of the
  30797. * given width with the given color, which by default is the maximum
  30798. * contrast to the text. So a bright text color will result in a black text
  30799. * outline for maximum readability on a mixed background. In some cases,
  30800. * especially with grayscale text, the text outline doesn't work well, in
  30801. * which cases it can be disabled by setting it to `"none"`. When `useHTML`
  30802. * is true, the `textOutline` will not be picked up. In this, case, the same
  30803. * effect can be acheived through the `text-shadow` CSS property.
  30804. *
  30805. * For some series types, where each point has an extent, like for example
  30806. * tree maps, the data label may overflow the point. There are two
  30807. * strategies for handling overflow. By default, the text will wrap to
  30808. * multiple lines. The other strategy is to set `style.textOverflow` to
  30809. * `ellipsis`, which will keep the text on one line plus it will break
  30810. * inside long words.
  30811. */
  30812. style?: CSSObject;
  30813. /**
  30814. * (Highcharts, Highstock, Highmaps, Gantt) Options for a label text which
  30815. * should follow marker's shape. Border and background are disabled for a
  30816. * label that follows a path.
  30817. *
  30818. * **Note:** Only SVG-based renderer supports this option. Setting `useHTML`
  30819. * to true will disable this option.
  30820. */
  30821. textPath?: DataLabelsTextPathOptionsObject;
  30822. /**
  30823. * (Highcharts, Highstock, Highmaps, Gantt) Whether to use HTML to render
  30824. * the labels.
  30825. */
  30826. useHTML?: boolean;
  30827. /**
  30828. * (Highcharts, Highstock, Highmaps, Gantt) The vertical alignment of a data
  30829. * label. Can be one of `top`, `middle` or `bottom`. The default value
  30830. * depends on the data, for instance in a column chart, the label is above
  30831. * positive values and below negative values.
  30832. */
  30833. verticalAlign?: string;
  30834. /**
  30835. * (Highcharts, Highstock, Highmaps, Gantt) The x position offset of the
  30836. * label relative to the point in pixels.
  30837. */
  30838. x?: number;
  30839. /**
  30840. * (Highcharts, Highstock, Highmaps, Gantt) The y position offset of the
  30841. * label relative to the point in pixels.
  30842. */
  30843. y?: number;
  30844. /**
  30845. * (Highcharts, Highstock, Highmaps, Gantt) The Z index of the data labels.
  30846. * The default Z index puts it above the series. Use a Z index of 2 to
  30847. * display it behind the series.
  30848. */
  30849. z?: number;
  30850. }
  30851. /**
  30852. * (Highcharts, Highstock) Options for the series data sorting.
  30853. */
  30854. export interface PlotCandlestickDataSortingOptions {
  30855. /**
  30856. * (Highcharts, Highstock) Enable or disable data sorting for the series.
  30857. * Use xAxis.reversed to change the sorting order.
  30858. */
  30859. enabled?: boolean;
  30860. /**
  30861. * (Highcharts, Highstock) Whether to allow matching points by name in an
  30862. * update. If this option is disabled, points will be matched by order.
  30863. */
  30864. matchByName?: boolean;
  30865. /**
  30866. * (Highcharts, Highstock) Determines what data value should be used to sort
  30867. * by.
  30868. */
  30869. sortKey?: string;
  30870. }
  30871. /**
  30872. * (Highstock) Style options for the guide box. The guide box has one state by
  30873. * default, the `default` state.
  30874. */
  30875. export interface PlotCandlestickDragDropGuideBoxOptions {
  30876. /**
  30877. * (Highstock) Style options for the guide box default state.
  30878. */
  30879. default?: DragDropGuideBoxOptionsObject;
  30880. }
  30881. /**
  30882. * (Highstock) A candlestick chart is a style of financial chart used to
  30883. * describe price movements over time.
  30884. *
  30885. * In TypeScript the type option must always be set.
  30886. *
  30887. * Configuration options for the series are given in three levels:
  30888. *
  30889. * 1. Options for all series in a chart are defined in the plotOptions.series
  30890. * object.
  30891. *
  30892. * 2. Options for all `candlestick` series are defined in
  30893. * plotOptions.candlestick.
  30894. *
  30895. * 3. Options for one single series are given in the series instance array. (see
  30896. * online documentation for example)
  30897. */
  30898. export interface PlotCandlestickOptions {
  30899. /**
  30900. * (Highstock) Accessibility options for a series.
  30901. */
  30902. accessibility?: SeriesAccessibilityOptionsObject;
  30903. /**
  30904. * (Highmaps) Whether all areas of the map defined in `mapData` should be
  30905. * rendered. If `true`, areas which don't correspond to a data point, are
  30906. * rendered as `null` points. If `false`, those areas are skipped.
  30907. */
  30908. allAreas?: boolean;
  30909. /**
  30910. * (Highstock) Allow this series' points to be selected by clicking on the
  30911. * graphic (columns, point markers, pie slices, map areas etc).
  30912. *
  30913. * The selected points can be handled by point select and unselect events,
  30914. * or collectively by the getSelectedPoints function.
  30915. *
  30916. * And alternative way of selecting points is through dragging.
  30917. */
  30918. allowPointSelect?: boolean;
  30919. /**
  30920. * (Highstock) Enable or disable the initial animation when a series is
  30921. * displayed. The animation can also be set as a configuration object.
  30922. * Please note that this option only applies to the initial animation of the
  30923. * series itself. For other animations, see chart.animation and the
  30924. * animation parameter under the API methods. The following properties are
  30925. * supported:
  30926. *
  30927. * - `defer`: The animation delay time in milliseconds.
  30928. *
  30929. * - `duration`: The duration of the animation in milliseconds.
  30930. *
  30931. * - `easing`: Can be a string reference to an easing function set on the
  30932. * `Math` object or a function. See the _Custom easing function_ demo below.
  30933. *
  30934. * Due to poor performance, animation is disabled in old IE browsers for
  30935. * several chart types.
  30936. */
  30937. animation?: (boolean|PlotCandlestickAnimationOptions|Partial<AnimationOptionsObject>);
  30938. /**
  30939. * (Highstock) For some series, there is a limit that shuts down initial
  30940. * animation by default when the total number of points in the chart is too
  30941. * high. For example, for a column chart and its derivatives, animation does
  30942. * not run if there is more than 250 points totally. To disable this cap,
  30943. * set `animationLimit` to `Infinity`.
  30944. */
  30945. animationLimit?: number;
  30946. /**
  30947. * (Highstock) Sets the color blending in the boost module.
  30948. */
  30949. boostBlending?: OptionsBoostBlendingValue;
  30950. /**
  30951. * (Highstock) Set the point threshold for when a series should enter boost
  30952. * mode.
  30953. *
  30954. * Setting it to e.g. 2000 will cause the series to enter boost mode when
  30955. * there are 2000 or more points in the series.
  30956. *
  30957. * To disable boosting on the series, set the `boostThreshold` to 0. Setting
  30958. * it to 1 will force boosting.
  30959. *
  30960. * Note that the cropThreshold also affects this setting. When zooming in on
  30961. * a series that has fewer points than the `cropThreshold`, all points are
  30962. * rendered although outside the visible plot area, and the `boostThreshold`
  30963. * won't take effect.
  30964. */
  30965. boostThreshold?: number;
  30966. /**
  30967. * (Highcharts, Highstock, Gantt) When `true`, the columns will center in
  30968. * the category, ignoring null or missing points. When `false`, space will
  30969. * be reserved for null or missing points.
  30970. */
  30971. centerInCategory?: boolean;
  30972. /**
  30973. * (Highstock) An additional class name to apply to the series' graphical
  30974. * elements. This option does not replace default class names of the
  30975. * graphical element.
  30976. */
  30977. className?: string;
  30978. /**
  30979. * (Highstock) Disable this option to allow series rendering in the whole
  30980. * plotting area.
  30981. *
  30982. * **Note:** Clipping should be always enabled when chart.zoomType is set
  30983. */
  30984. clip?: boolean;
  30985. /**
  30986. * (Highstock) The main color of the series. In line type series it applies
  30987. * to the line and the point markers unless otherwise specified. In bar type
  30988. * series it applies to the bars unless a color is specified per point. The
  30989. * default value is pulled from the `options.colors` array.
  30990. *
  30991. * In styled mode, the color can be defined by the colorIndex option. Also,
  30992. * the series color can be set with the `.highcharts-series`,
  30993. * `.highcharts-color-{n}`, `.highcharts-{type}-series` or
  30994. * `.highcharts-series-{n}` class, or individual classes given by the
  30995. * `className` option.
  30996. */
  30997. color?: (ColorString|GradientColorObject|PatternObject);
  30998. /**
  30999. * (Highcharts, Highstock, Highmaps) When using dual or multiple color axes,
  31000. * this number defines which colorAxis the particular series is connected
  31001. * to. It refers to either the axis id or the index of the axis in the
  31002. * colorAxis array, with 0 being the first. Set this option to false to
  31003. * prevent a series from connecting to the default color axis.
  31004. *
  31005. * Since v7.2.0 the option can also be an axis id or an axis index instead
  31006. * of a boolean flag.
  31007. */
  31008. colorAxis?: (boolean|number|string);
  31009. /**
  31010. * (Highcharts, Highstock, Gantt) When using automatic point colors pulled
  31011. * from the global colors or series-specific plotOptions.column.colors
  31012. * collections, this option determines whether the chart should receive one
  31013. * color per series or one color per point.
  31014. *
  31015. * In styled mode, the `colors` or `series.colors` arrays are not supported,
  31016. * and instead this option gives the points individual color class names on
  31017. * the form `highcharts-color-{n}`.
  31018. */
  31019. colorByPoint?: boolean;
  31020. /**
  31021. * (Highstock) Styled mode only. A specific color index to use for the
  31022. * series, so its graphic representations are given the class name
  31023. * `highcharts-color-{n}`.
  31024. */
  31025. colorIndex?: number;
  31026. /**
  31027. * (Highcharts, Highstock, Highmaps) Determines what data value should be
  31028. * used to calculate point color if `colorAxis` is used. Requires to set
  31029. * `min` and `max` if some custom point property is used or if approximation
  31030. * for data grouping is set to `'sum'`.
  31031. */
  31032. colorKey?: string;
  31033. /**
  31034. * (Highcharts, Highstock, Gantt) A series specific or series type specific
  31035. * color set to apply instead of the global colors when colorByPoint is
  31036. * true.
  31037. */
  31038. colors?: Array<(ColorString|GradientColorObject|PatternObject)>;
  31039. /**
  31040. * (Highstock) Compare the values of the series against the first non-null,
  31041. * non- zero value in the visible range. The y axis will show percentage or
  31042. * absolute change depending on whether `compare` is set to `"percent"` or
  31043. * `"value"`. When this is applied to multiple series, it allows comparing
  31044. * the development of the series against each other. Adds a `change` field
  31045. * to every point object.
  31046. */
  31047. compare?: string;
  31048. /**
  31049. * (Highstock) When compare is `percent`, this option dictates whether to
  31050. * use 0 or 100 as the base of comparison.
  31051. */
  31052. compareBase?: (0|100);
  31053. /**
  31054. * (Highstock) Defines if comparison should start from the first point
  31055. * within the visible range or should start from the first point **before**
  31056. * the range.
  31057. *
  31058. * In other words, this flag determines if first point within the visible
  31059. * range will have 0% (`compareStart=true`) or should have been already
  31060. * calculated according to the previous point (`compareStart=false`).
  31061. */
  31062. compareStart?: boolean;
  31063. /**
  31064. * (Gantt) Override Pathfinder connector options for a series. Requires
  31065. * Highcharts Gantt to be loaded.
  31066. */
  31067. connectors?: SeriesConnectorsOptionsObject;
  31068. /**
  31069. * (Highcharts, Highstock, Gantt) When the series contains less points than
  31070. * the crop threshold, all points are drawn, event if the points fall
  31071. * outside the visible plot area at the current zoom. The advantage of
  31072. * drawing all points (including markers and columns), is that animation is
  31073. * performed on updates. On the other hand, when the series contains more
  31074. * points than the crop threshold, the series data is cropped to only
  31075. * contain points that fall within the plot area. The advantage of cropping
  31076. * away invisible points is to increase performance on large series.
  31077. */
  31078. cropThreshold?: number;
  31079. /**
  31080. * (Highstock) You can set the cursor to "pointer" if you have click events
  31081. * attached to the series, to signal to the user that the points and lines
  31082. * can be clicked.
  31083. *
  31084. * In styled mode, the series cursor can be set with the same classes as
  31085. * listed under series.color.
  31086. */
  31087. cursor?: (string|CursorValue);
  31088. /**
  31089. * (Highstock) A reserved subspace to store options and values for
  31090. * customized functionality. Here you can add additional data for your own
  31091. * event callbacks and formatter callbacks.
  31092. */
  31093. custom?: Dictionary<any>;
  31094. /**
  31095. * (Highstock) Name of the dash style to use for the graph, or for some
  31096. * series types the outline of each shape.
  31097. *
  31098. * In styled mode, the stroke dash-array can be set with the same classes as
  31099. * listed under series.color.
  31100. */
  31101. dashStyle?: DashStyleValue;
  31102. /**
  31103. * (Highstock) Data grouping is the concept of sampling the data values into
  31104. * larger blocks in order to ease readability and increase performance of
  31105. * the JavaScript charts. Highstock by default applies data grouping when
  31106. * the points become closer than a certain pixel value, determined by the
  31107. * `groupPixelWidth` option.
  31108. *
  31109. * If data grouping is applied, the grouping information of grouped points
  31110. * can be read from the Point.dataGroup. If point options other than the
  31111. * data itself are set, for example `name` or `color` or custom properties,
  31112. * the grouping logic doesn't know how to group it. In this case the options
  31113. * of the first point instance are copied over to the group point. This can
  31114. * be altered through a custom `approximation` callback function.
  31115. */
  31116. dataGrouping?: DataGroupingOptionsObject;
  31117. /**
  31118. * (Highcharts, Highstock, Highmaps, Gantt) Options for the series data
  31119. * labels, appearing next to each data point.
  31120. *
  31121. * Since v6.2.0, multiple data labels can be applied to each single point by
  31122. * defining them as an array of configs.
  31123. *
  31124. * In styled mode, the data labels can be styled with the
  31125. * `.highcharts-data-label-box` and `.highcharts-data-label` class names
  31126. * (see example).
  31127. */
  31128. dataLabels?: (PlotCandlestickDataLabelsOptions|Array<PlotCandlestickDataLabelsOptions>);
  31129. /**
  31130. * (Highcharts, Highstock) Options for the series data sorting.
  31131. */
  31132. dataSorting?: (DataSortingOptionsObject|PlotCandlestickDataSortingOptions);
  31133. /**
  31134. * (Highcharts) Depth of the columns in a 3D column chart.
  31135. */
  31136. depth?: number;
  31137. /**
  31138. * (Highstock) A description of the series to add to the screen reader
  31139. * information about the series.
  31140. */
  31141. description?: string;
  31142. /**
  31143. * (Highstock) The draggable-points module allows points to be moved around
  31144. * or modified in the chart. In addition to the options mentioned under the
  31145. * `dragDrop` API structure, the module fires three events, point.dragStart,
  31146. * point.drag and point.drop.
  31147. */
  31148. dragDrop?: SeriesDragDropOptionsObject;
  31149. /**
  31150. * (Highcharts) 3D columns only. The color of the edges. Similar to
  31151. * `borderColor`, except it defaults to the same color as the column.
  31152. */
  31153. edgeColor?: ColorString;
  31154. /**
  31155. * (Highcharts) 3D columns only. The width of the colored edges.
  31156. */
  31157. edgeWidth?: number;
  31158. /**
  31159. * (Highstock) Enable or disable the mouse tracking for a specific series.
  31160. * This includes point tooltips and click events on graphs and points. For
  31161. * large datasets it improves performance.
  31162. */
  31163. enableMouseTracking?: boolean;
  31164. /**
  31165. * (Highstock) General event handlers for the series items. These event
  31166. * hooks can also be attached to the series at run time using the
  31167. * `Highcharts.addEvent` function.
  31168. */
  31169. events?: SeriesEventsOptionsObject;
  31170. /**
  31171. * (Highstock) Determines whether the series should look for the nearest
  31172. * point in both dimensions or just the x-dimension when hovering the
  31173. * series. Defaults to `'xy'` for scatter series and `'x'` for most other
  31174. * series. If the data has duplicate x-values, it is recommended to set this
  31175. * to `'xy'` to allow hovering over all points.
  31176. *
  31177. * Applies only to series types using nearest neighbor search (not direct
  31178. * hover) for tooltip.
  31179. */
  31180. findNearestPointBy?: OptionsFindNearestPointByValue;
  31181. /**
  31182. * (Highcharts, Highstock, Gantt) Whether to use the Y extremes of the total
  31183. * chart width or only the zoomed area when zooming in on parts of the X
  31184. * axis. By default, the Y axis adjusts to the min and max of the visible
  31185. * data. Cartesian series only.
  31186. */
  31187. getExtremesFromAll?: boolean;
  31188. /**
  31189. * (Highcharts, Highstock, Gantt) Whether to group non-stacked columns or to
  31190. * let them render independent of each other. Non-grouped columns will be
  31191. * laid out individually and overlap each other.
  31192. */
  31193. grouping?: boolean;
  31194. /**
  31195. * (Highcharts, Highstock, Gantt) Padding between each value groups, in x
  31196. * axis units.
  31197. */
  31198. groupPadding?: number;
  31199. /**
  31200. * (Highcharts) The spacing between columns on the Z Axis in a 3D chart.
  31201. */
  31202. groupZPadding?: number;
  31203. /**
  31204. * (Highstock) When set to `false` will prevent the series data from being
  31205. * included in any form of data export.
  31206. *
  31207. * Since version 6.0.0 until 7.1.0 the option was existing undocumented as
  31208. * `includeInCSVExport`.
  31209. */
  31210. includeInDataExport?: boolean;
  31211. /**
  31212. * (Highmaps) What property to join the `mapData` to the value data. For
  31213. * example, if joinBy is "code", the mapData items with a specific code is
  31214. * merged into the data with the same code. For maps loaded from GeoJSON,
  31215. * the keys may be held in each point's `properties` object.
  31216. *
  31217. * The joinBy option can also be an array of two values, where the first
  31218. * points to a key in the `mapData`, and the second points to another key in
  31219. * the `data`.
  31220. *
  31221. * When joinBy is `null`, the map items are joined by their position in the
  31222. * array, which performs much better in maps with many data points. This is
  31223. * the recommended option if you are printing more than a thousand data
  31224. * points and have a backend that can preprocess the data into a parallel
  31225. * array of the mapData.
  31226. */
  31227. joinBy?: (string|Array<string>);
  31228. /**
  31229. * (Highstock) An array specifying which option maps to which key in the
  31230. * data point array. This makes it convenient to work with unstructured data
  31231. * arrays from different sources.
  31232. */
  31233. keys?: Array<string>;
  31234. /**
  31235. * (Highcharts, Highstock, Gantt) Series labels are placed as close to the
  31236. * series as possible in a natural way, seeking to avoid other series. The
  31237. * goal of this feature is to make the chart more easily readable, like if a
  31238. * human designer placed the labels in the optimal position.
  31239. *
  31240. * The series labels currently work with series types having a `graph` or an
  31241. * `area`.
  31242. */
  31243. label?: SeriesLabelOptionsObject;
  31244. /**
  31245. * (Highstock) The line marks the last price from all points.
  31246. */
  31247. lastPrice?: SeriesLastPriceOptionsObject;
  31248. /**
  31249. * (Highstock) The line marks the last price from visible range of points.
  31250. */
  31251. lastVisiblePrice?: SeriesLastVisiblePriceOptionsObject;
  31252. /**
  31253. * (Highstock) The pixel width of the line/border. Defaults to `1`.
  31254. */
  31255. lineWidth?: number;
  31256. /**
  31257. * (Highcharts, Highstock, Gantt) The id of another series to link to.
  31258. * Additionally, the value can be ":previous" to link to the previous
  31259. * series. When two series are linked, only the first one appears in the
  31260. * legend. Toggling the visibility of this also toggles the linked series.
  31261. *
  31262. * If master series uses data sorting and linked series does not have its
  31263. * own sorting definition, the linked series will be sorted in the same
  31264. * order as the master one.
  31265. */
  31266. linkedTo?: string;
  31267. /**
  31268. * (Highcharts, Highstock, Gantt) The maximum allowed pixel width for a
  31269. * column, translated to the height of a bar in a bar chart. This prevents
  31270. * the columns from becoming too wide when there is a small number of points
  31271. * in the chart.
  31272. */
  31273. maxPointWidth?: number;
  31274. /**
  31275. * (Highcharts, Highstock, Gantt) The minimal height for a column or width
  31276. * for a bar. By default, 0 values are not shown. To visualize a 0 (or close
  31277. * to zero) point, set the minimal point length to a pixel value like 3\. In
  31278. * stacked column charts, minPointLength might not be respected for tightly
  31279. * packed values.
  31280. */
  31281. minPointLength?: number;
  31282. /**
  31283. * (Highstock) Options for the corresponding navigator series if
  31284. * `showInNavigator` is `true` for this series. Available options are the
  31285. * same as any series, documented at plotOptions and series.
  31286. *
  31287. * These options are merged with options in navigator.series, and will take
  31288. * precedence if the same option is defined both places.
  31289. */
  31290. navigatorOptions?: PlotSeriesOptions;
  31291. /**
  31292. * (Highstock) The color for the parts of the graph or points that are below
  31293. * the threshold. Note that `zones` takes precedence over the negative
  31294. * color. Using `negativeColor` is equivalent to applying a zone with value
  31295. * of 0.
  31296. */
  31297. negativeColor?: (ColorString|GradientColorObject|PatternObject);
  31298. /**
  31299. * (Highstock) Opacity of a series parts: line, fill (e.g. area) and
  31300. * dataLabels.
  31301. */
  31302. opacity?: number;
  31303. /**
  31304. * (Highstock) Properties for each single point.
  31305. */
  31306. point?: PlotSeriesPointOptions;
  31307. /**
  31308. * (Highstock) Same as accessibility.pointDescriptionFormatter, but for an
  31309. * individual series. Overrides the chart wide configuration.
  31310. */
  31311. pointDescriptionFormatter?: Function;
  31312. /**
  31313. * (Highcharts, Highstock, Gantt) If no x values are given for the points in
  31314. * a series, `pointInterval` defines the interval of the x values. For
  31315. * example, if a series contains one value every decade starting from year
  31316. * 0, set `pointInterval` to `10`. In true `datetime` axes, the
  31317. * `pointInterval` is set in milliseconds.
  31318. *
  31319. * It can be also be combined with `pointIntervalUnit` to draw irregular
  31320. * time intervals.
  31321. *
  31322. * Please note that this options applies to the _series data_, not the
  31323. * interval of the axis ticks, which is independent.
  31324. */
  31325. pointInterval?: number;
  31326. /**
  31327. * (Highcharts, Highstock, Gantt) On datetime series, this allows for
  31328. * setting the pointInterval to irregular time units, `day`, `month` and
  31329. * `year`. A day is usually the same as 24 hours, but `pointIntervalUnit`
  31330. * also takes the DST crossover into consideration when dealing with local
  31331. * time. Combine this option with `pointInterval` to draw weeks, quarters, 6
  31332. * months, 10 years etc.
  31333. *
  31334. * Please note that this options applies to the _series data_, not the
  31335. * interval of the axis ticks, which is independent.
  31336. */
  31337. pointIntervalUnit?: OptionsPointIntervalUnitValue;
  31338. /**
  31339. * (Highcharts, Highstock, Gantt) Padding between each column or bar, in x
  31340. * axis units.
  31341. */
  31342. pointPadding?: number;
  31343. /**
  31344. * (Highcharts, Highstock, Gantt) Possible values: `"on"`, `"between"`,
  31345. * `number`.
  31346. *
  31347. * In a column chart, when pointPlacement is `"on"`, the point will not
  31348. * create any padding of the X axis. In a polar column chart this means that
  31349. * the first column points directly north. If the pointPlacement is
  31350. * `"between"`, the columns will be laid out between ticks. This is useful
  31351. * for example for visualising an amount between two points in time or in a
  31352. * certain sector of a polar chart.
  31353. *
  31354. * Since Highcharts 3.0.2, the point placement can also be numeric, where 0
  31355. * is on the axis value, -0.5 is between this value and the previous, and
  31356. * 0.5 is between this value and the next. Unlike the textual options,
  31357. * numeric point placement options won't affect axis padding.
  31358. *
  31359. * Note that pointPlacement needs a pointRange to work. For column series
  31360. * this is computed, but for line-type series it needs to be set.
  31361. *
  31362. * For the `xrange` series type and gantt charts, if the Y axis is a
  31363. * category axis, the `pointPlacement` applies to the Y axis rather than the
  31364. * (typically datetime) X axis.
  31365. *
  31366. * Defaults to `undefined` in cartesian charts, `"between"` in polar charts.
  31367. */
  31368. pointPlacement?: (number|string);
  31369. /**
  31370. * (Highcharts, Highstock, Gantt) The X axis range that each point is valid
  31371. * for. This determines the width of the column. On a categorized axis, the
  31372. * range will be 1 by default (one category unit). On linear and datetime
  31373. * axes, the range will be computed as the distance between the two closest
  31374. * data points.
  31375. *
  31376. * The default `null` means it is computed automatically, but this option
  31377. * can be used to override the automatic value.
  31378. *
  31379. * This option is set by default to 1 if data sorting is enabled.
  31380. */
  31381. pointRange?: (number|null);
  31382. /**
  31383. * (Highcharts, Highstock, Gantt) If no x values are given for the points in
  31384. * a series, pointStart defines on what value to start. For example, if a
  31385. * series contains one yearly value starting from 1945, set pointStart to
  31386. * 1945.
  31387. */
  31388. pointStart?: number;
  31389. /**
  31390. * (Highstock) Determines which one of `open`, `high`, `low`, `close` values
  31391. * should be represented as `point.y`, which is later used to set dataLabel
  31392. * position and compare.
  31393. */
  31394. pointValKey?: OptionsPointValKeyValue;
  31395. /**
  31396. * (Highcharts, Highstock, Gantt) A pixel value specifying a fixed width for
  31397. * each column or bar point. When set to `undefined`, the width is
  31398. * calculated from the `pointPadding` and `groupPadding`. The width effects
  31399. * the dimension that is not based on the point value. For column series it
  31400. * is the hoizontal length and for bar series it is the vertical length.
  31401. */
  31402. pointWidth?: number;
  31403. /**
  31404. * (Highstock) Whether to select the series initially. If `showCheckbox` is
  31405. * true, the checkbox next to the series name in the legend will be checked
  31406. * for a selected series.
  31407. */
  31408. selected?: boolean;
  31409. /**
  31410. * (Highstock) Whether to apply a drop shadow to the graph line. Since 2.3
  31411. * the shadow can be an object configuration containing `color`, `offsetX`,
  31412. * `offsetY`, `opacity` and `width`.
  31413. */
  31414. shadow?: (boolean|ShadowOptionsObject);
  31415. /**
  31416. * (Highstock) If true, a checkbox is displayed next to the legend item to
  31417. * allow selecting the series. The state of the checkbox is determined by
  31418. * the `selected` option.
  31419. */
  31420. showCheckbox?: boolean;
  31421. /**
  31422. * (Highstock) Whether to display this particular series or series type in
  31423. * the legend. Standalone series are shown in legend by default, and linked
  31424. * series are not. Since v7.2.0 it is possible to show series that use
  31425. * colorAxis by setting this option to `true`.
  31426. */
  31427. showInLegend?: boolean;
  31428. /**
  31429. * (Highstock) Whether or not to show the series in the navigator. Takes
  31430. * precedence over navigator.baseSeries if defined.
  31431. */
  31432. showInNavigator?: boolean;
  31433. /**
  31434. * (Highstock) If set to `true`, the accessibility module will skip past the
  31435. * points in this series for keyboard navigation.
  31436. */
  31437. skipKeyboardNavigation?: boolean;
  31438. /**
  31439. * (Highcharts, Highstock) When this is true, the series will not cause the
  31440. * Y axis to cross the zero plane (or threshold option) unless the data
  31441. * actually crosses the plane.
  31442. *
  31443. * For example, if `softThreshold` is `false`, a series of 0, 1, 2, 3 will
  31444. * make the Y axis show negative values according to the `minPadding`
  31445. * option. If `softThreshold` is `true`, the Y axis starts at 0.
  31446. */
  31447. softThreshold?: boolean;
  31448. states?: SeriesStatesOptionsObject;
  31449. /**
  31450. * (Highstock) Sticky tracking of mouse events. When true, the `mouseOut`
  31451. * event on a series isn't triggered until the mouse moves over another
  31452. * series, or out of the plot area. When false, the `mouseOut` event on a
  31453. * series is triggered when the mouse leaves the area around the series'
  31454. * graph or markers. This also implies the tooltip when not shared. When
  31455. * `stickyTracking` is false and `tooltip.shared` is false, the tooltip will
  31456. * be hidden when moving the mouse between series. Defaults to true for line
  31457. * and area type series, but to false for columns, pies etc.
  31458. *
  31459. * **Note:** The boost module will force this option because of technical
  31460. * limitations.
  31461. */
  31462. stickyTracking?: boolean;
  31463. /**
  31464. * (Highcharts) The Y axis value to serve as the base for the columns, for
  31465. * distinguishing between values above and below a threshold. If `null`, the
  31466. * columns extend from the padding Y axis minimum.
  31467. */
  31468. threshold?: (number|null);
  31469. /**
  31470. * (Highstock) A configuration object for the tooltip rendering of each
  31471. * single series. Properties are inherited from tooltip, but only the
  31472. * following properties can be defined on a series level.
  31473. */
  31474. tooltip?: SeriesTooltipOptionsObject;
  31475. /**
  31476. * (Highcharts, Highstock, Gantt) When a series contains a data array that
  31477. * is longer than this, only one dimensional arrays of numbers, or two
  31478. * dimensional arrays with x and y values are allowed. Also, only the first
  31479. * point is tested, and the rest are assumed to be the same format. This
  31480. * saves expensive data checking and indexing in long series. Set it to `0`
  31481. * disable.
  31482. *
  31483. * Note: In boost mode turbo threshold is forced. Only array of numbers or
  31484. * two dimensional arrays are allowed.
  31485. */
  31486. turboThreshold?: number;
  31487. /**
  31488. * (Highstock) Line color for up points.
  31489. */
  31490. upColor?: (ColorString|GradientColorObject|PatternObject);
  31491. /**
  31492. * (Highstock) The specific line color for up candle sticks. The default is
  31493. * to inherit the general `lineColor` setting.
  31494. */
  31495. upLineColor?: (ColorString|GradientColorObject|PatternObject);
  31496. /**
  31497. * (Highstock) Set the initial visibility of the series.
  31498. */
  31499. visible?: boolean;
  31500. /**
  31501. * (Highmaps) Define the z index of the series.
  31502. */
  31503. zIndex?: number;
  31504. /**
  31505. * (Highcharts, Highstock) Defines the Axis on which the zones are applied.
  31506. */
  31507. zoneAxis?: string;
  31508. /**
  31509. * (Highcharts, Highstock) An array defining zones within a series. Zones
  31510. * can be applied to the X axis, Y axis or Z axis for bubbles, according to
  31511. * the `zoneAxis` option. The zone definitions have to be in ascending order
  31512. * regarding to the value.
  31513. *
  31514. * In styled mode, the color zones are styled with the
  31515. * `.highcharts-zone-{n}` class, or custom classed from the `className`
  31516. * option (view live demo).
  31517. */
  31518. zones?: Array<SeriesZonesOptionsObject>;
  31519. }
  31520. /**
  31521. * (Highstock) Enable or disable the initial animation when a series is
  31522. * displayed. The animation can also be set as a configuration object. Please
  31523. * note that this option only applies to the initial animation of the series
  31524. * itself. For other animations, see chart.animation and the animation parameter
  31525. * under the API methods. The following properties are supported:
  31526. *
  31527. * - `defer`: The animation delay time in milliseconds.
  31528. *
  31529. * - `duration`: The duration of the animation in milliseconds.
  31530. *
  31531. * - `easing`: Can be a string reference to an easing function set on the `Math`
  31532. * object or a function. See the _Custom easing function_ demo below.
  31533. *
  31534. * Due to poor performance, animation is disabled in old IE browsers for several
  31535. * chart types.
  31536. */
  31537. export interface PlotCciAnimationOptions {
  31538. defer?: number;
  31539. }
  31540. /**
  31541. * (Highcharts, Highstock, Highmaps, Gantt) Enable or disable the initial
  31542. * animation when a series is displayed for the `dataLabels`. The animation can
  31543. * also be set as a configuration object. Please note that this option only
  31544. * applies to the initial animation. For other animations, see chart.animation
  31545. * and the animation parameter under the API methods. The following properties
  31546. * are supported:
  31547. *
  31548. * - `defer`: The animation delay time in milliseconds.
  31549. */
  31550. export interface PlotCciDataLabelsAnimationOptions {
  31551. /**
  31552. * (Highcharts, Highstock, Highmaps, Gantt) The animation delay time in
  31553. * milliseconds. Set to `0` renders dataLabel immediately. As `undefined`
  31554. * inherits defer time from the series.animation.defer.
  31555. */
  31556. defer?: number;
  31557. }
  31558. /**
  31559. * (Highcharts, Highstock, Highmaps, Gantt) Options for the series data labels,
  31560. * appearing next to each data point.
  31561. *
  31562. * Since v6.2.0, multiple data labels can be applied to each single point by
  31563. * defining them as an array of configs.
  31564. *
  31565. * In styled mode, the data labels can be styled with the
  31566. * `.highcharts-data-label-box` and `.highcharts-data-label` class names (see
  31567. * example).
  31568. */
  31569. export interface PlotCciDataLabelsOptions {
  31570. /**
  31571. * (Highcharts, Highstock, Highmaps, Gantt) The alignment of the data label
  31572. * compared to the point. If `right`, the right side of the label should be
  31573. * touching the point. For points with an extent, like columns, the
  31574. * alignments also dictates how to align it inside the box, as given with
  31575. * the inside option. Can be one of `left`, `center` or `right`.
  31576. */
  31577. align?: (AlignValue|null);
  31578. /**
  31579. * (Highcharts, Highstock, Highmaps, Gantt) Whether to allow data labels to
  31580. * overlap. To make the labels less sensitive for overlapping, the
  31581. * dataLabels.padding can be set to 0.
  31582. */
  31583. allowOverlap?: boolean;
  31584. /**
  31585. * (Highcharts, Highstock, Highmaps, Gantt) Enable or disable the initial
  31586. * animation when a series is displayed for the `dataLabels`. The animation
  31587. * can also be set as a configuration object. Please note that this option
  31588. * only applies to the initial animation. For other animations, see
  31589. * chart.animation and the animation parameter under the API methods. The
  31590. * following properties are supported:
  31591. *
  31592. * - `defer`: The animation delay time in milliseconds.
  31593. */
  31594. animation?: (boolean|PlotCciDataLabelsAnimationOptions|Partial<AnimationOptionsObject>);
  31595. /**
  31596. * (Highcharts, Highstock, Highmaps, Gantt) The background color or gradient
  31597. * for the data label.
  31598. */
  31599. backgroundColor?: (ColorString|GradientColorObject|PatternObject);
  31600. /**
  31601. * (Highcharts, Highstock, Highmaps, Gantt) The border color for the data
  31602. * label. Defaults to `undefined`.
  31603. */
  31604. borderColor?: (ColorString|GradientColorObject|PatternObject);
  31605. /**
  31606. * (Highcharts, Highstock, Highmaps, Gantt) The border radius in pixels for
  31607. * the data label.
  31608. */
  31609. borderRadius?: number;
  31610. /**
  31611. * (Highcharts, Highstock, Highmaps, Gantt) The border width in pixels for
  31612. * the data label.
  31613. */
  31614. borderWidth?: number;
  31615. /**
  31616. * (Highcharts, Highstock, Highmaps, Gantt) A class name for the data label.
  31617. * Particularly in styled mode, this can be used to give each series' or
  31618. * point's data label unique styling. In addition to this option, a default
  31619. * color class name is added so that we can give the labels a contrast text
  31620. * shadow.
  31621. */
  31622. className?: string;
  31623. /**
  31624. * (Highcharts, Highstock, Highmaps, Gantt) The text color for the data
  31625. * labels. Defaults to `undefined`. For certain series types, like column or
  31626. * map, the data labels can be drawn inside the points. In this case the
  31627. * data label will be drawn with maximum contrast by default. Additionally,
  31628. * it will be given a `text-outline` style with the opposite color, to
  31629. * further increase the contrast. This can be overridden by setting the
  31630. * `text-outline` style to `none` in the `dataLabels.style` option.
  31631. */
  31632. color?: (ColorString|GradientColorObject|PatternObject);
  31633. /**
  31634. * (Highcharts, Highstock, Highmaps, Gantt) Whether to hide data labels that
  31635. * are outside the plot area. By default, the data label is moved inside the
  31636. * plot area according to the overflow option.
  31637. */
  31638. crop?: boolean;
  31639. /**
  31640. * (Highcharts, Highstock, Gantt) Whether to defer displaying the data
  31641. * labels until the initial series animation has finished. Setting to
  31642. * `false` renders the data label immediately. If set to `true` inherits the
  31643. * defer time set in plotOptions.series.animation.
  31644. */
  31645. defer?: boolean;
  31646. /**
  31647. * (Highcharts, Highstock, Highmaps, Gantt) Enable or disable the data
  31648. * labels.
  31649. */
  31650. enabled?: boolean;
  31651. /**
  31652. * (Highcharts, Highstock, Highmaps, Gantt) A declarative filter to control
  31653. * of which data labels to display. The declarative filter is designed for
  31654. * use when callback functions are not available, like when the chart
  31655. * options require a pure JSON structure or for use with graphical editors.
  31656. * For programmatic control, use the `formatter` instead, and return
  31657. * `undefined` to disable a single data label.
  31658. */
  31659. filter?: DataLabelsFilterOptionsObject;
  31660. /**
  31661. * (Highcharts, Highstock, Highmaps, Gantt) A format string for the data
  31662. * label. Available variables are the same as for `formatter`.
  31663. */
  31664. format?: string;
  31665. /**
  31666. * (Highcharts, Highstock, Highmaps, Gantt) Callback JavaScript function to
  31667. * format the data label. Note that if a `format` is defined, the format
  31668. * takes precedence and the formatter is ignored.
  31669. */
  31670. formatter?: DataLabelsFormatterCallbackFunction;
  31671. /**
  31672. * (Highcharts, Highstock, Highmaps, Gantt) For points with an extent, like
  31673. * columns or map areas, whether to align the data label inside the box or
  31674. * to the actual value point. Defaults to `false` in most cases, `true` in
  31675. * stacked columns.
  31676. */
  31677. inside?: boolean;
  31678. /**
  31679. * (Highcharts, Highstock, Highmaps, Gantt) Format for points with the value
  31680. * of null. Works analogously to format. `nullFormat` can be applied only to
  31681. * series which support displaying null points.
  31682. */
  31683. nullFormat?: (boolean|string);
  31684. /**
  31685. * (Highcharts, Highstock, Highmaps, Gantt) Callback JavaScript function
  31686. * that defines formatting for points with the value of null. Works
  31687. * analogously to formatter. `nullPointFormatter` can be applied only to
  31688. * series which support displaying null points.
  31689. */
  31690. nullFormatter?: DataLabelsFormatterCallbackFunction;
  31691. /**
  31692. * (Highcharts, Highstock, Highmaps, Gantt) How to handle data labels that
  31693. * flow outside the plot area. The default is `"justify"`, which aligns them
  31694. * inside the plot area. For columns and bars, this means it will be moved
  31695. * inside the bar. To display data labels outside the plot area, set `crop`
  31696. * to `false` and `overflow` to `"allow"`.
  31697. */
  31698. overflow?: DataLabelsOverflowValue;
  31699. /**
  31700. * (Highcharts, Highstock, Highmaps, Gantt) When either the `borderWidth` or
  31701. * the `backgroundColor` is set, this is the padding within the box.
  31702. */
  31703. padding?: number;
  31704. /**
  31705. * (Highcharts, Highstock, Highmaps, Gantt) Aligns data labels relative to
  31706. * points. If `center` alignment is not possible, it defaults to `right`.
  31707. */
  31708. position?: AlignValue;
  31709. /**
  31710. * (Highcharts, Highstock, Highmaps, Gantt) Text rotation in degrees. Note
  31711. * that due to a more complex structure, backgrounds, borders and padding
  31712. * will be lost on a rotated data label.
  31713. */
  31714. rotation?: number;
  31715. /**
  31716. * (Highcharts, Highstock, Highmaps, Gantt) The shadow of the box. Works
  31717. * best with `borderWidth` or `backgroundColor`. Since 2.3 the shadow can be
  31718. * an object configuration containing `color`, `offsetX`, `offsetY`,
  31719. * `opacity` and `width`.
  31720. */
  31721. shadow?: (boolean|ShadowOptionsObject);
  31722. /**
  31723. * (Highcharts, Highstock, Highmaps, Gantt) The name of a symbol to use for
  31724. * the border around the label. Symbols are predefined functions on the
  31725. * Renderer object.
  31726. */
  31727. shape?: string;
  31728. /**
  31729. * (Highcharts, Highstock, Highmaps, Gantt) Styles for the label. The
  31730. * default `color` setting is `"contrast"`, which is a pseudo color that
  31731. * Highcharts picks up and applies the maximum contrast to the underlying
  31732. * point item, for example the bar in a bar chart.
  31733. *
  31734. * The `textOutline` is a pseudo property that applies an outline of the
  31735. * given width with the given color, which by default is the maximum
  31736. * contrast to the text. So a bright text color will result in a black text
  31737. * outline for maximum readability on a mixed background. In some cases,
  31738. * especially with grayscale text, the text outline doesn't work well, in
  31739. * which cases it can be disabled by setting it to `"none"`. When `useHTML`
  31740. * is true, the `textOutline` will not be picked up. In this, case, the same
  31741. * effect can be acheived through the `text-shadow` CSS property.
  31742. *
  31743. * For some series types, where each point has an extent, like for example
  31744. * tree maps, the data label may overflow the point. There are two
  31745. * strategies for handling overflow. By default, the text will wrap to
  31746. * multiple lines. The other strategy is to set `style.textOverflow` to
  31747. * `ellipsis`, which will keep the text on one line plus it will break
  31748. * inside long words.
  31749. */
  31750. style?: CSSObject;
  31751. /**
  31752. * (Highcharts, Highstock, Highmaps, Gantt) Options for a label text which
  31753. * should follow marker's shape. Border and background are disabled for a
  31754. * label that follows a path.
  31755. *
  31756. * **Note:** Only SVG-based renderer supports this option. Setting `useHTML`
  31757. * to true will disable this option.
  31758. */
  31759. textPath?: DataLabelsTextPathOptionsObject;
  31760. /**
  31761. * (Highcharts, Highstock, Highmaps, Gantt) Whether to use HTML to render
  31762. * the labels.
  31763. */
  31764. useHTML?: boolean;
  31765. /**
  31766. * (Highcharts, Highstock, Highmaps, Gantt) The vertical alignment of a data
  31767. * label. Can be one of `top`, `middle` or `bottom`. The default value
  31768. * depends on the data, for instance in a column chart, the label is above
  31769. * positive values and below negative values.
  31770. */
  31771. verticalAlign?: (VerticalAlignValue|null);
  31772. /**
  31773. * (Highcharts, Highstock, Highmaps, Gantt) The x position offset of the
  31774. * label relative to the point in pixels.
  31775. */
  31776. x?: number;
  31777. /**
  31778. * (Highcharts, Highstock, Highmaps, Gantt) The y position offset of the
  31779. * label relative to the point in pixels.
  31780. */
  31781. y?: number;
  31782. /**
  31783. * (Highcharts, Highstock, Highmaps, Gantt) The Z index of the data labels.
  31784. * The default Z index puts it above the series. Use a Z index of 2 to
  31785. * display it behind the series.
  31786. */
  31787. z?: number;
  31788. }
  31789. /**
  31790. * (Highcharts, Highstock) Options for the series data sorting.
  31791. */
  31792. export interface PlotCciDataSortingOptions {
  31793. /**
  31794. * (Highcharts, Highstock) Enable or disable data sorting for the series.
  31795. * Use xAxis.reversed to change the sorting order.
  31796. */
  31797. enabled?: boolean;
  31798. /**
  31799. * (Highcharts, Highstock) Whether to allow matching points by name in an
  31800. * update. If this option is disabled, points will be matched by order.
  31801. */
  31802. matchByName?: boolean;
  31803. /**
  31804. * (Highcharts, Highstock) Determines what data value should be used to sort
  31805. * by.
  31806. */
  31807. sortKey?: string;
  31808. }
  31809. /**
  31810. * (Highstock) Commodity Channel Index (CCI). This series requires `linkedTo`
  31811. * option to be set.
  31812. *
  31813. * In TypeScript the type option must always be set.
  31814. *
  31815. * Configuration options for the series are given in three levels:
  31816. *
  31817. * 1. Options for all series in a chart are defined in the plotOptions.series
  31818. * object.
  31819. *
  31820. * 2. Options for all `cci` series are defined in plotOptions.cci.
  31821. *
  31822. * 3. Options for one single series are given in the series instance array. (see
  31823. * online documentation for example)
  31824. */
  31825. export interface PlotCciOptions {
  31826. /**
  31827. * (Highstock) Accessibility options for a series.
  31828. */
  31829. accessibility?: SeriesAccessibilityOptionsObject;
  31830. /**
  31831. * (Highstock) Allow this series' points to be selected by clicking on the
  31832. * graphic (columns, point markers, pie slices, map areas etc).
  31833. *
  31834. * The selected points can be handled by point select and unselect events,
  31835. * or collectively by the getSelectedPoints function.
  31836. *
  31837. * And alternative way of selecting points is through dragging.
  31838. */
  31839. allowPointSelect?: boolean;
  31840. /**
  31841. * (Highstock) Enable or disable the initial animation when a series is
  31842. * displayed. The animation can also be set as a configuration object.
  31843. * Please note that this option only applies to the initial animation of the
  31844. * series itself. For other animations, see chart.animation and the
  31845. * animation parameter under the API methods. The following properties are
  31846. * supported:
  31847. *
  31848. * - `defer`: The animation delay time in milliseconds.
  31849. *
  31850. * - `duration`: The duration of the animation in milliseconds.
  31851. *
  31852. * - `easing`: Can be a string reference to an easing function set on the
  31853. * `Math` object or a function. See the _Custom easing function_ demo below.
  31854. *
  31855. * Due to poor performance, animation is disabled in old IE browsers for
  31856. * several chart types.
  31857. */
  31858. animation?: (boolean|PlotCciAnimationOptions|Partial<AnimationOptionsObject>);
  31859. /**
  31860. * (Highstock) For some series, there is a limit that shuts down initial
  31861. * animation by default when the total number of points in the chart is too
  31862. * high. For example, for a column chart and its derivatives, animation does
  31863. * not run if there is more than 250 points totally. To disable this cap,
  31864. * set `animationLimit` to `Infinity`.
  31865. */
  31866. animationLimit?: number;
  31867. /**
  31868. * (Highstock) Sets the color blending in the boost module.
  31869. */
  31870. boostBlending?: OptionsBoostBlendingValue;
  31871. /**
  31872. * (Highstock) Set the point threshold for when a series should enter boost
  31873. * mode.
  31874. *
  31875. * Setting it to e.g. 2000 will cause the series to enter boost mode when
  31876. * there are 2000 or more points in the series.
  31877. *
  31878. * To disable boosting on the series, set the `boostThreshold` to 0. Setting
  31879. * it to 1 will force boosting.
  31880. *
  31881. * Note that the cropThreshold also affects this setting. When zooming in on
  31882. * a series that has fewer points than the `cropThreshold`, all points are
  31883. * rendered although outside the visible plot area, and the `boostThreshold`
  31884. * won't take effect.
  31885. */
  31886. boostThreshold?: number;
  31887. /**
  31888. * (Highmaps) The border color of the map areas.
  31889. *
  31890. * In styled mode, the border stroke is given in the `.highcharts-point`
  31891. * class.
  31892. */
  31893. borderColor?: (ColorString|GradientColorObject|PatternObject);
  31894. /**
  31895. * (Highmaps) The border width of each map area.
  31896. *
  31897. * In styled mode, the border stroke width is given in the
  31898. * `.highcharts-point` class.
  31899. */
  31900. borderWidth?: number;
  31901. /**
  31902. * (Highstock) An additional class name to apply to the series' graphical
  31903. * elements. This option does not replace default class names of the
  31904. * graphical element.
  31905. */
  31906. className?: string;
  31907. /**
  31908. * (Highstock) Disable this option to allow series rendering in the whole
  31909. * plotting area.
  31910. *
  31911. * **Note:** Clipping should be always enabled when chart.zoomType is set
  31912. */
  31913. clip?: boolean;
  31914. /**
  31915. * (Highstock) The main color of the series. In line type series it applies
  31916. * to the line and the point markers unless otherwise specified. In bar type
  31917. * series it applies to the bars unless a color is specified per point. The
  31918. * default value is pulled from the `options.colors` array.
  31919. *
  31920. * In styled mode, the color can be defined by the colorIndex option. Also,
  31921. * the series color can be set with the `.highcharts-series`,
  31922. * `.highcharts-color-{n}`, `.highcharts-{type}-series` or
  31923. * `.highcharts-series-{n}` class, or individual classes given by the
  31924. * `className` option.
  31925. */
  31926. color?: (ColorString|GradientColorObject|PatternObject);
  31927. /**
  31928. * (Highstock) Styled mode only. A specific color index to use for the
  31929. * series, so its graphic representations are given the class name
  31930. * `highcharts-color-{n}`.
  31931. */
  31932. colorIndex?: number;
  31933. /**
  31934. * (Highcharts, Highstock, Highmaps) Determines what data value should be
  31935. * used to calculate point color if `colorAxis` is used. Requires to set
  31936. * `min` and `max` if some custom point property is used or if approximation
  31937. * for data grouping is set to `'sum'`.
  31938. */
  31939. colorKey?: string;
  31940. /**
  31941. * (Highstock) Compare the values of the series against the first non-null,
  31942. * non- zero value in the visible range. The y axis will show percentage or
  31943. * absolute change depending on whether `compare` is set to `"percent"` or
  31944. * `"value"`. When this is applied to multiple series, it allows comparing
  31945. * the development of the series against each other. Adds a `change` field
  31946. * to every point object.
  31947. */
  31948. compare?: string;
  31949. /**
  31950. * (Highstock) When compare is `percent`, this option dictates whether to
  31951. * use 0 or 100 as the base of comparison.
  31952. */
  31953. compareBase?: (0|100);
  31954. /**
  31955. * (Highstock) Defines if comparison should start from the first point
  31956. * within the visible range or should start from the first point **before**
  31957. * the range.
  31958. *
  31959. * In other words, this flag determines if first point within the visible
  31960. * range will have 0% (`compareStart=true`) or should have been already
  31961. * calculated according to the previous point (`compareStart=false`).
  31962. */
  31963. compareStart?: boolean;
  31964. /**
  31965. * (Highstock) Whether to compare indicator to the main series values or
  31966. * indicator values.
  31967. */
  31968. compareToMain?: boolean;
  31969. /**
  31970. * (Highcharts) Polar charts only. Whether to connect the ends of a line
  31971. * series plot across the extremes.
  31972. */
  31973. connectEnds?: boolean;
  31974. /**
  31975. * (Highcharts, Highstock) Whether to connect a graph line across null
  31976. * points, or render a gap between the two points on either side of the
  31977. * null.
  31978. */
  31979. connectNulls?: boolean;
  31980. /**
  31981. * (Gantt) Override Pathfinder connector options for a series. Requires
  31982. * Highcharts Gantt to be loaded.
  31983. */
  31984. connectors?: SeriesConnectorsOptionsObject;
  31985. /**
  31986. * (Highcharts, Highstock, Gantt) When true, each point or column edge is
  31987. * rounded to its nearest pixel in order to render sharp on screen. In some
  31988. * cases, when there are a lot of densely packed columns, this leads to
  31989. * visible difference in column widths or distance between columns. In these
  31990. * cases, setting `crisp` to `false` may look better, even though each
  31991. * column is rendered blurry.
  31992. */
  31993. crisp?: boolean;
  31994. /**
  31995. * (Highcharts, Highstock) When the series contains less points than the
  31996. * crop threshold, all points are drawn, even if the points fall outside the
  31997. * visible plot area at the current zoom. The advantage of drawing all
  31998. * points (including markers and columns), is that animation is performed on
  31999. * updates. On the other hand, when the series contains more points than the
  32000. * crop threshold, the series data is cropped to only contain points that
  32001. * fall within the plot area. The advantage of cropping away invisible
  32002. * points is to increase performance on large series.
  32003. */
  32004. cropThreshold?: number;
  32005. /**
  32006. * (Highstock) You can set the cursor to "pointer" if you have click events
  32007. * attached to the series, to signal to the user that the points and lines
  32008. * can be clicked.
  32009. *
  32010. * In styled mode, the series cursor can be set with the same classes as
  32011. * listed under series.color.
  32012. */
  32013. cursor?: (string|CursorValue);
  32014. /**
  32015. * (Highstock) A reserved subspace to store options and values for
  32016. * customized functionality. Here you can add additional data for your own
  32017. * event callbacks and formatter callbacks.
  32018. */
  32019. custom?: Dictionary<any>;
  32020. /**
  32021. * (Highstock) Name of the dash style to use for the graph, or for some
  32022. * series types the outline of each shape.
  32023. *
  32024. * In styled mode, the stroke dash-array can be set with the same classes as
  32025. * listed under series.color.
  32026. */
  32027. dashStyle?: DashStyleValue;
  32028. /**
  32029. * (Highstock) Data grouping is the concept of sampling the data values into
  32030. * larger blocks in order to ease readability and increase performance of
  32031. * the JavaScript charts. Highstock by default applies data grouping when
  32032. * the points become closer than a certain pixel value, determined by the
  32033. * `groupPixelWidth` option.
  32034. *
  32035. * If data grouping is applied, the grouping information of grouped points
  32036. * can be read from the Point.dataGroup. If point options other than the
  32037. * data itself are set, for example `name` or `color` or custom properties,
  32038. * the grouping logic doesn't know how to group it. In this case the options
  32039. * of the first point instance are copied over to the group point. This can
  32040. * be altered through a custom `approximation` callback function.
  32041. */
  32042. dataGrouping?: DataGroupingOptionsObject;
  32043. /**
  32044. * (Highcharts, Highstock, Highmaps, Gantt) Options for the series data
  32045. * labels, appearing next to each data point.
  32046. *
  32047. * Since v6.2.0, multiple data labels can be applied to each single point by
  32048. * defining them as an array of configs.
  32049. *
  32050. * In styled mode, the data labels can be styled with the
  32051. * `.highcharts-data-label-box` and `.highcharts-data-label` class names
  32052. * (see example).
  32053. */
  32054. dataLabels?: (PlotCciDataLabelsOptions|Array<PlotCciDataLabelsOptions>);
  32055. /**
  32056. * (Highcharts, Highstock) Options for the series data sorting.
  32057. */
  32058. dataSorting?: (DataSortingOptionsObject|PlotCciDataSortingOptions);
  32059. /**
  32060. * (Highstock) A description of the series to add to the screen reader
  32061. * information about the series.
  32062. */
  32063. description?: string;
  32064. /**
  32065. * (Highstock) Enable or disable the mouse tracking for a specific series.
  32066. * This includes point tooltips and click events on graphs and points. For
  32067. * large datasets it improves performance.
  32068. */
  32069. enableMouseTracking?: boolean;
  32070. /**
  32071. * (Highstock) General event handlers for the series items. These event
  32072. * hooks can also be attached to the series at run time using the
  32073. * `Highcharts.addEvent` function.
  32074. */
  32075. events?: SeriesEventsOptionsObject;
  32076. /**
  32077. * (Highstock) Determines whether the series should look for the nearest
  32078. * point in both dimensions or just the x-dimension when hovering the
  32079. * series. Defaults to `'xy'` for scatter series and `'x'` for most other
  32080. * series. If the data has duplicate x-values, it is recommended to set this
  32081. * to `'xy'` to allow hovering over all points.
  32082. *
  32083. * Applies only to series types using nearest neighbor search (not direct
  32084. * hover) for tooltip.
  32085. */
  32086. findNearestPointBy?: OptionsFindNearestPointByValue;
  32087. /**
  32088. * (Highstock) Defines when to display a gap in the graph, together with the
  32089. * gapUnit option.
  32090. *
  32091. * In case when `dataGrouping` is enabled, points can be grouped into a
  32092. * larger time span. This can make the grouped points to have a greater
  32093. * distance than the absolute value of `gapSize` property, which will result
  32094. * in disappearing graph completely. To prevent this situation the mentioned
  32095. * distance between grouped points is used instead of previously defined
  32096. * `gapSize`.
  32097. *
  32098. * In practice, this option is most often used to visualize gaps in time
  32099. * series. In a stock chart, intraday data is available for daytime hours,
  32100. * while gaps will appear in nights and weekends.
  32101. */
  32102. gapSize?: number;
  32103. /**
  32104. * (Highstock) Together with gapSize, this option defines where to draw gaps
  32105. * in the graph.
  32106. *
  32107. * When the `gapUnit` is `"relative"` (default), a gap size of 5 means that
  32108. * if the distance between two points is greater than 5 times that of the
  32109. * two closest points, the graph will be broken.
  32110. *
  32111. * When the `gapUnit` is `"value"`, the gap is based on absolute axis
  32112. * values, which on a datetime axis is milliseconds. This also applies to
  32113. * the navigator series that inherits gap options from the base series.
  32114. */
  32115. gapUnit?: OptionsGapUnitValue;
  32116. /**
  32117. * (Highcharts, Highstock, Gantt) Whether to use the Y extremes of the total
  32118. * chart width or only the zoomed area when zooming in on parts of the X
  32119. * axis. By default, the Y axis adjusts to the min and max of the visible
  32120. * data. Cartesian series only.
  32121. */
  32122. getExtremesFromAll?: boolean;
  32123. /**
  32124. * (Highstock) When set to `false` will prevent the series data from being
  32125. * included in any form of data export.
  32126. *
  32127. * Since version 6.0.0 until 7.1.0 the option was existing undocumented as
  32128. * `includeInCSVExport`.
  32129. */
  32130. includeInDataExport?: boolean;
  32131. /**
  32132. * (Highcharts, Highstock, Gantt) Series labels are placed as close to the
  32133. * series as possible in a natural way, seeking to avoid other series. The
  32134. * goal of this feature is to make the chart more easily readable, like if a
  32135. * human designer placed the labels in the optimal position.
  32136. *
  32137. * The series labels currently work with series types having a `graph` or an
  32138. * `area`.
  32139. */
  32140. label?: SeriesLabelOptionsObject;
  32141. /**
  32142. * (Highstock) The line marks the last price from all points.
  32143. */
  32144. lastPrice?: SeriesLastPriceOptionsObject;
  32145. /**
  32146. * (Highstock) The line marks the last price from visible range of points.
  32147. */
  32148. lastVisiblePrice?: SeriesLastVisiblePriceOptionsObject;
  32149. /**
  32150. * (Highcharts, Highstock) The SVG value used for the `stroke-linecap` and
  32151. * `stroke-linejoin` of a line graph. Round means that lines are rounded in
  32152. * the ends and bends.
  32153. */
  32154. linecap?: SeriesLinecapValue;
  32155. /**
  32156. * (Highcharts, Highstock) Pixel width of the graph line.
  32157. */
  32158. lineWidth?: number;
  32159. /**
  32160. * (Highcharts, Highstock, Gantt) The main series ID that indicator will be
  32161. * based on. Required for this indicator.
  32162. */
  32163. linkedTo?: string;
  32164. /**
  32165. * (Highstock) Options for the point markers of line-like series. Properties
  32166. * like `fillColor`, `lineColor` and `lineWidth` define the visual
  32167. * appearance of the markers. Other series types, like column series, don't
  32168. * have markers, but have visual options on the series level instead.
  32169. *
  32170. * In styled mode, the markers can be styled with the `.highcharts-point`,
  32171. * `.highcharts-point-hover` and `.highcharts-point-select` class names.
  32172. */
  32173. marker?: PointMarkerOptionsObject;
  32174. /**
  32175. * (Highstock) The name of the series as shown in the legend, tooltip etc.
  32176. * If not set, it will be based on a technical indicator type and default
  32177. * params.
  32178. */
  32179. name?: string;
  32180. /**
  32181. * (Highstock) The color for the parts of the graph or points that are below
  32182. * the threshold. Note that `zones` takes precedence over the negative
  32183. * color. Using `negativeColor` is equivalent to applying a zone with value
  32184. * of 0.
  32185. */
  32186. negativeColor?: (ColorString|GradientColorObject|PatternObject);
  32187. /**
  32188. * (Highstock) Opacity of a series parts: line, fill (e.g. area) and
  32189. * dataLabels.
  32190. */
  32191. opacity?: number;
  32192. /**
  32193. * (Highstock) Paramters used in calculation of regression series' points.
  32194. */
  32195. params?: PlotCciParamsOptions;
  32196. /**
  32197. * (Highstock) Properties for each single point.
  32198. */
  32199. point?: PlotSeriesPointOptions;
  32200. /**
  32201. * (Highstock) Same as accessibility.pointDescriptionFormatter, but for an
  32202. * individual series. Overrides the chart wide configuration.
  32203. */
  32204. pointDescriptionFormatter?: Function;
  32205. /**
  32206. * (Highstock) Whether to select the series initially. If `showCheckbox` is
  32207. * true, the checkbox next to the series name in the legend will be checked
  32208. * for a selected series.
  32209. */
  32210. selected?: boolean;
  32211. /**
  32212. * (Highstock) Whether to apply a drop shadow to the graph line. Since 2.3
  32213. * the shadow can be an object configuration containing `color`, `offsetX`,
  32214. * `offsetY`, `opacity` and `width`.
  32215. */
  32216. shadow?: (boolean|ShadowOptionsObject);
  32217. /**
  32218. * (Highstock) If true, a checkbox is displayed next to the legend item to
  32219. * allow selecting the series. The state of the checkbox is determined by
  32220. * the `selected` option.
  32221. */
  32222. showCheckbox?: boolean;
  32223. /**
  32224. * (Highstock) Whether to display this particular series or series type in
  32225. * the legend. Standalone series are shown in legend by default, and linked
  32226. * series are not. Since v7.2.0 it is possible to show series that use
  32227. * colorAxis by setting this option to `true`.
  32228. */
  32229. showInLegend?: boolean;
  32230. /**
  32231. * (Highstock) If set to `true`, the accessibility module will skip past the
  32232. * points in this series for keyboard navigation.
  32233. */
  32234. skipKeyboardNavigation?: boolean;
  32235. /**
  32236. * (Highcharts, Highstock) When this is true, the series will not cause the
  32237. * Y axis to cross the zero plane (or threshold option) unless the data
  32238. * actually crosses the plane.
  32239. *
  32240. * For example, if `softThreshold` is `false`, a series of 0, 1, 2, 3 will
  32241. * make the Y axis show negative values according to the `minPadding`
  32242. * option. If `softThreshold` is `true`, the Y axis starts at 0.
  32243. */
  32244. softThreshold?: boolean;
  32245. states?: SeriesStatesOptionsObject;
  32246. /**
  32247. * (Highcharts, Highstock) Whether to apply steps to the line. Possible
  32248. * values are `left`, `center` and `right`.
  32249. */
  32250. step?: OptionsStepValue;
  32251. /**
  32252. * (Highstock) Sticky tracking of mouse events. When true, the `mouseOut`
  32253. * event on a series isn't triggered until the mouse moves over another
  32254. * series, or out of the plot area. When false, the `mouseOut` event on a
  32255. * series is triggered when the mouse leaves the area around the series'
  32256. * graph or markers. This also implies the tooltip when not shared. When
  32257. * `stickyTracking` is false and `tooltip.shared` is false, the tooltip will
  32258. * be hidden when moving the mouse between series. Defaults to true for line
  32259. * and area type series, but to false for columns, pies etc.
  32260. *
  32261. * **Note:** The boost module will force this option because of technical
  32262. * limitations.
  32263. */
  32264. stickyTracking?: boolean;
  32265. /**
  32266. * (Highcharts, Highstock) The threshold, also called zero level or base
  32267. * level. For line type series this is only used in conjunction with
  32268. * negativeColor.
  32269. */
  32270. threshold?: (number|null);
  32271. /**
  32272. * (Highstock) A configuration object for the tooltip rendering of each
  32273. * single series. Properties are inherited from tooltip, but only the
  32274. * following properties can be defined on a series level.
  32275. */
  32276. tooltip?: SeriesTooltipOptionsObject;
  32277. /**
  32278. * (Highcharts, Highstock, Gantt) When a series contains a data array that
  32279. * is longer than this, only one dimensional arrays of numbers, or two
  32280. * dimensional arrays with x and y values are allowed. Also, only the first
  32281. * point is tested, and the rest are assumed to be the same format. This
  32282. * saves expensive data checking and indexing in long series. Set it to `0`
  32283. * disable.
  32284. *
  32285. * Note: In boost mode turbo threshold is forced. Only array of numbers or
  32286. * two dimensional arrays are allowed.
  32287. */
  32288. turboThreshold?: number;
  32289. /**
  32290. * (Highstock) Set the initial visibility of the series.
  32291. */
  32292. visible?: boolean;
  32293. /**
  32294. * (Highmaps) Define the z index of the series.
  32295. */
  32296. zIndex?: number;
  32297. /**
  32298. * (Highcharts, Highstock) Defines the Axis on which the zones are applied.
  32299. */
  32300. zoneAxis?: string;
  32301. /**
  32302. * (Highcharts, Highstock) An array defining zones within a series. Zones
  32303. * can be applied to the X axis, Y axis or Z axis for bubbles, according to
  32304. * the `zoneAxis` option. The zone definitions have to be in ascending order
  32305. * regarding to the value.
  32306. *
  32307. * In styled mode, the color zones are styled with the
  32308. * `.highcharts-zone-{n}` class, or custom classed from the `className`
  32309. * option (view live demo).
  32310. */
  32311. zones?: Array<SeriesZonesOptionsObject>;
  32312. }
  32313. /**
  32314. * (Highstock) Paramters used in calculation of regression series' points.
  32315. */
  32316. export interface PlotCciParamsOptions {
  32317. /**
  32318. * (Highstock) The point index which indicator calculations will base. For
  32319. * example using OHLC data, index=2 means the indicator will be calculated
  32320. * using Low values.
  32321. */
  32322. index?: number;
  32323. /**
  32324. * (Highstock) The base period for indicator calculations. This is the
  32325. * number of data points which are taken into account for the indicator
  32326. * calculations.
  32327. */
  32328. period?: number;
  32329. }
  32330. /**
  32331. * (Highstock) Enable or disable the initial animation when a series is
  32332. * displayed. The animation can also be set as a configuration object. Please
  32333. * note that this option only applies to the initial animation of the series
  32334. * itself. For other animations, see chart.animation and the animation parameter
  32335. * under the API methods. The following properties are supported:
  32336. *
  32337. * - `defer`: The animation delay time in milliseconds.
  32338. *
  32339. * - `duration`: The duration of the animation in milliseconds.
  32340. *
  32341. * - `easing`: Can be a string reference to an easing function set on the `Math`
  32342. * object or a function. See the _Custom easing function_ demo below.
  32343. *
  32344. * Due to poor performance, animation is disabled in old IE browsers for several
  32345. * chart types.
  32346. */
  32347. export interface PlotChaikinAnimationOptions {
  32348. defer?: number;
  32349. }
  32350. /**
  32351. * (Highcharts, Highstock, Highmaps, Gantt) Enable or disable the initial
  32352. * animation when a series is displayed for the `dataLabels`. The animation can
  32353. * also be set as a configuration object. Please note that this option only
  32354. * applies to the initial animation. For other animations, see chart.animation
  32355. * and the animation parameter under the API methods. The following properties
  32356. * are supported:
  32357. *
  32358. * - `defer`: The animation delay time in milliseconds.
  32359. */
  32360. export interface PlotChaikinDataLabelsAnimationOptions {
  32361. /**
  32362. * (Highcharts, Highstock, Highmaps, Gantt) The animation delay time in
  32363. * milliseconds. Set to `0` renders dataLabel immediately. As `undefined`
  32364. * inherits defer time from the series.animation.defer.
  32365. */
  32366. defer?: number;
  32367. }
  32368. /**
  32369. * (Highcharts, Highstock, Highmaps, Gantt) Options for the series data labels,
  32370. * appearing next to each data point.
  32371. *
  32372. * Since v6.2.0, multiple data labels can be applied to each single point by
  32373. * defining them as an array of configs.
  32374. *
  32375. * In styled mode, the data labels can be styled with the
  32376. * `.highcharts-data-label-box` and `.highcharts-data-label` class names (see
  32377. * example).
  32378. */
  32379. export interface PlotChaikinDataLabelsOptions {
  32380. /**
  32381. * (Highcharts, Highstock, Highmaps, Gantt) The alignment of the data label
  32382. * compared to the point. If `right`, the right side of the label should be
  32383. * touching the point. For points with an extent, like columns, the
  32384. * alignments also dictates how to align it inside the box, as given with
  32385. * the inside option. Can be one of `left`, `center` or `right`.
  32386. */
  32387. align?: (AlignValue|null);
  32388. /**
  32389. * (Highcharts, Highstock, Highmaps, Gantt) Whether to allow data labels to
  32390. * overlap. To make the labels less sensitive for overlapping, the
  32391. * dataLabels.padding can be set to 0.
  32392. */
  32393. allowOverlap?: boolean;
  32394. /**
  32395. * (Highcharts, Highstock, Highmaps, Gantt) Enable or disable the initial
  32396. * animation when a series is displayed for the `dataLabels`. The animation
  32397. * can also be set as a configuration object. Please note that this option
  32398. * only applies to the initial animation. For other animations, see
  32399. * chart.animation and the animation parameter under the API methods. The
  32400. * following properties are supported:
  32401. *
  32402. * - `defer`: The animation delay time in milliseconds.
  32403. */
  32404. animation?: (boolean|PlotChaikinDataLabelsAnimationOptions|Partial<AnimationOptionsObject>);
  32405. /**
  32406. * (Highcharts, Highstock, Highmaps, Gantt) The background color or gradient
  32407. * for the data label.
  32408. */
  32409. backgroundColor?: (ColorString|GradientColorObject|PatternObject);
  32410. /**
  32411. * (Highcharts, Highstock, Highmaps, Gantt) The border color for the data
  32412. * label. Defaults to `undefined`.
  32413. */
  32414. borderColor?: (ColorString|GradientColorObject|PatternObject);
  32415. /**
  32416. * (Highcharts, Highstock, Highmaps, Gantt) The border radius in pixels for
  32417. * the data label.
  32418. */
  32419. borderRadius?: number;
  32420. /**
  32421. * (Highcharts, Highstock, Highmaps, Gantt) The border width in pixels for
  32422. * the data label.
  32423. */
  32424. borderWidth?: number;
  32425. /**
  32426. * (Highcharts, Highstock, Highmaps, Gantt) A class name for the data label.
  32427. * Particularly in styled mode, this can be used to give each series' or
  32428. * point's data label unique styling. In addition to this option, a default
  32429. * color class name is added so that we can give the labels a contrast text
  32430. * shadow.
  32431. */
  32432. className?: string;
  32433. /**
  32434. * (Highcharts, Highstock, Highmaps, Gantt) The text color for the data
  32435. * labels. Defaults to `undefined`. For certain series types, like column or
  32436. * map, the data labels can be drawn inside the points. In this case the
  32437. * data label will be drawn with maximum contrast by default. Additionally,
  32438. * it will be given a `text-outline` style with the opposite color, to
  32439. * further increase the contrast. This can be overridden by setting the
  32440. * `text-outline` style to `none` in the `dataLabels.style` option.
  32441. */
  32442. color?: (ColorString|GradientColorObject|PatternObject);
  32443. /**
  32444. * (Highcharts, Highstock, Highmaps, Gantt) Whether to hide data labels that
  32445. * are outside the plot area. By default, the data label is moved inside the
  32446. * plot area according to the overflow option.
  32447. */
  32448. crop?: boolean;
  32449. /**
  32450. * (Highcharts, Highstock, Gantt) Whether to defer displaying the data
  32451. * labels until the initial series animation has finished. Setting to
  32452. * `false` renders the data label immediately. If set to `true` inherits the
  32453. * defer time set in plotOptions.series.animation.
  32454. */
  32455. defer?: boolean;
  32456. /**
  32457. * (Highcharts, Highstock, Highmaps, Gantt) Enable or disable the data
  32458. * labels.
  32459. */
  32460. enabled?: boolean;
  32461. /**
  32462. * (Highcharts, Highstock, Highmaps, Gantt) A declarative filter to control
  32463. * of which data labels to display. The declarative filter is designed for
  32464. * use when callback functions are not available, like when the chart
  32465. * options require a pure JSON structure or for use with graphical editors.
  32466. * For programmatic control, use the `formatter` instead, and return
  32467. * `undefined` to disable a single data label.
  32468. */
  32469. filter?: DataLabelsFilterOptionsObject;
  32470. /**
  32471. * (Highcharts, Highstock, Highmaps, Gantt) A format string for the data
  32472. * label. Available variables are the same as for `formatter`.
  32473. */
  32474. format?: string;
  32475. /**
  32476. * (Highcharts, Highstock, Highmaps, Gantt) Callback JavaScript function to
  32477. * format the data label. Note that if a `format` is defined, the format
  32478. * takes precedence and the formatter is ignored.
  32479. */
  32480. formatter?: DataLabelsFormatterCallbackFunction;
  32481. /**
  32482. * (Highcharts, Highstock, Highmaps, Gantt) For points with an extent, like
  32483. * columns or map areas, whether to align the data label inside the box or
  32484. * to the actual value point. Defaults to `false` in most cases, `true` in
  32485. * stacked columns.
  32486. */
  32487. inside?: boolean;
  32488. /**
  32489. * (Highcharts, Highstock, Highmaps, Gantt) Format for points with the value
  32490. * of null. Works analogously to format. `nullFormat` can be applied only to
  32491. * series which support displaying null points.
  32492. */
  32493. nullFormat?: (boolean|string);
  32494. /**
  32495. * (Highcharts, Highstock, Highmaps, Gantt) Callback JavaScript function
  32496. * that defines formatting for points with the value of null. Works
  32497. * analogously to formatter. `nullPointFormatter` can be applied only to
  32498. * series which support displaying null points.
  32499. */
  32500. nullFormatter?: DataLabelsFormatterCallbackFunction;
  32501. /**
  32502. * (Highcharts, Highstock, Highmaps, Gantt) How to handle data labels that
  32503. * flow outside the plot area. The default is `"justify"`, which aligns them
  32504. * inside the plot area. For columns and bars, this means it will be moved
  32505. * inside the bar. To display data labels outside the plot area, set `crop`
  32506. * to `false` and `overflow` to `"allow"`.
  32507. */
  32508. overflow?: DataLabelsOverflowValue;
  32509. /**
  32510. * (Highcharts, Highstock, Highmaps, Gantt) When either the `borderWidth` or
  32511. * the `backgroundColor` is set, this is the padding within the box.
  32512. */
  32513. padding?: number;
  32514. /**
  32515. * (Highcharts, Highstock, Highmaps, Gantt) Aligns data labels relative to
  32516. * points. If `center` alignment is not possible, it defaults to `right`.
  32517. */
  32518. position?: AlignValue;
  32519. /**
  32520. * (Highcharts, Highstock, Highmaps, Gantt) Text rotation in degrees. Note
  32521. * that due to a more complex structure, backgrounds, borders and padding
  32522. * will be lost on a rotated data label.
  32523. */
  32524. rotation?: number;
  32525. /**
  32526. * (Highcharts, Highstock, Highmaps, Gantt) The shadow of the box. Works
  32527. * best with `borderWidth` or `backgroundColor`. Since 2.3 the shadow can be
  32528. * an object configuration containing `color`, `offsetX`, `offsetY`,
  32529. * `opacity` and `width`.
  32530. */
  32531. shadow?: (boolean|ShadowOptionsObject);
  32532. /**
  32533. * (Highcharts, Highstock, Highmaps, Gantt) The name of a symbol to use for
  32534. * the border around the label. Symbols are predefined functions on the
  32535. * Renderer object.
  32536. */
  32537. shape?: string;
  32538. /**
  32539. * (Highcharts, Highstock, Highmaps, Gantt) Styles for the label. The
  32540. * default `color` setting is `"contrast"`, which is a pseudo color that
  32541. * Highcharts picks up and applies the maximum contrast to the underlying
  32542. * point item, for example the bar in a bar chart.
  32543. *
  32544. * The `textOutline` is a pseudo property that applies an outline of the
  32545. * given width with the given color, which by default is the maximum
  32546. * contrast to the text. So a bright text color will result in a black text
  32547. * outline for maximum readability on a mixed background. In some cases,
  32548. * especially with grayscale text, the text outline doesn't work well, in
  32549. * which cases it can be disabled by setting it to `"none"`. When `useHTML`
  32550. * is true, the `textOutline` will not be picked up. In this, case, the same
  32551. * effect can be acheived through the `text-shadow` CSS property.
  32552. *
  32553. * For some series types, where each point has an extent, like for example
  32554. * tree maps, the data label may overflow the point. There are two
  32555. * strategies for handling overflow. By default, the text will wrap to
  32556. * multiple lines. The other strategy is to set `style.textOverflow` to
  32557. * `ellipsis`, which will keep the text on one line plus it will break
  32558. * inside long words.
  32559. */
  32560. style?: CSSObject;
  32561. /**
  32562. * (Highcharts, Highstock, Highmaps, Gantt) Options for a label text which
  32563. * should follow marker's shape. Border and background are disabled for a
  32564. * label that follows a path.
  32565. *
  32566. * **Note:** Only SVG-based renderer supports this option. Setting `useHTML`
  32567. * to true will disable this option.
  32568. */
  32569. textPath?: DataLabelsTextPathOptionsObject;
  32570. /**
  32571. * (Highcharts, Highstock, Highmaps, Gantt) Whether to use HTML to render
  32572. * the labels.
  32573. */
  32574. useHTML?: boolean;
  32575. /**
  32576. * (Highcharts, Highstock, Highmaps, Gantt) The vertical alignment of a data
  32577. * label. Can be one of `top`, `middle` or `bottom`. The default value
  32578. * depends on the data, for instance in a column chart, the label is above
  32579. * positive values and below negative values.
  32580. */
  32581. verticalAlign?: (VerticalAlignValue|null);
  32582. /**
  32583. * (Highcharts, Highstock, Highmaps, Gantt) The x position offset of the
  32584. * label relative to the point in pixels.
  32585. */
  32586. x?: number;
  32587. /**
  32588. * (Highcharts, Highstock, Highmaps, Gantt) The y position offset of the
  32589. * label relative to the point in pixels.
  32590. */
  32591. y?: number;
  32592. /**
  32593. * (Highcharts, Highstock, Highmaps, Gantt) The Z index of the data labels.
  32594. * The default Z index puts it above the series. Use a Z index of 2 to
  32595. * display it behind the series.
  32596. */
  32597. z?: number;
  32598. }
  32599. /**
  32600. * (Highcharts, Highstock) Options for the series data sorting.
  32601. */
  32602. export interface PlotChaikinDataSortingOptions {
  32603. /**
  32604. * (Highcharts, Highstock) Enable or disable data sorting for the series.
  32605. * Use xAxis.reversed to change the sorting order.
  32606. */
  32607. enabled?: boolean;
  32608. /**
  32609. * (Highcharts, Highstock) Whether to allow matching points by name in an
  32610. * update. If this option is disabled, points will be matched by order.
  32611. */
  32612. matchByName?: boolean;
  32613. /**
  32614. * (Highcharts, Highstock) Determines what data value should be used to sort
  32615. * by.
  32616. */
  32617. sortKey?: string;
  32618. }
  32619. /**
  32620. * (Highstock) Chaikin Oscillator. This series requires the `linkedTo` option to
  32621. * be set and should be loaded after the `stock/indicators/indicators.js` and
  32622. * `stock/indicators/ema.js`.
  32623. *
  32624. * In TypeScript the type option must always be set.
  32625. *
  32626. * Configuration options for the series are given in three levels:
  32627. *
  32628. * 1. Options for all series in a chart are defined in the plotOptions.series
  32629. * object.
  32630. *
  32631. * 2. Options for all `chaikin` series are defined in plotOptions.chaikin.
  32632. *
  32633. * 3. Options for one single series are given in the series instance array. (see
  32634. * online documentation for example)
  32635. */
  32636. export interface PlotChaikinOptions {
  32637. /**
  32638. * (Highstock) Accessibility options for a series.
  32639. */
  32640. accessibility?: SeriesAccessibilityOptionsObject;
  32641. /**
  32642. * (Highstock) Allow this series' points to be selected by clicking on the
  32643. * graphic (columns, point markers, pie slices, map areas etc).
  32644. *
  32645. * The selected points can be handled by point select and unselect events,
  32646. * or collectively by the getSelectedPoints function.
  32647. *
  32648. * And alternative way of selecting points is through dragging.
  32649. */
  32650. allowPointSelect?: boolean;
  32651. /**
  32652. * (Highstock) Enable or disable the initial animation when a series is
  32653. * displayed. The animation can also be set as a configuration object.
  32654. * Please note that this option only applies to the initial animation of the
  32655. * series itself. For other animations, see chart.animation and the
  32656. * animation parameter under the API methods. The following properties are
  32657. * supported:
  32658. *
  32659. * - `defer`: The animation delay time in milliseconds.
  32660. *
  32661. * - `duration`: The duration of the animation in milliseconds.
  32662. *
  32663. * - `easing`: Can be a string reference to an easing function set on the
  32664. * `Math` object or a function. See the _Custom easing function_ demo below.
  32665. *
  32666. * Due to poor performance, animation is disabled in old IE browsers for
  32667. * several chart types.
  32668. */
  32669. animation?: (boolean|PlotChaikinAnimationOptions|Partial<AnimationOptionsObject>);
  32670. /**
  32671. * (Highstock) For some series, there is a limit that shuts down initial
  32672. * animation by default when the total number of points in the chart is too
  32673. * high. For example, for a column chart and its derivatives, animation does
  32674. * not run if there is more than 250 points totally. To disable this cap,
  32675. * set `animationLimit` to `Infinity`.
  32676. */
  32677. animationLimit?: number;
  32678. /**
  32679. * (Highstock) Sets the color blending in the boost module.
  32680. */
  32681. boostBlending?: OptionsBoostBlendingValue;
  32682. /**
  32683. * (Highstock) Set the point threshold for when a series should enter boost
  32684. * mode.
  32685. *
  32686. * Setting it to e.g. 2000 will cause the series to enter boost mode when
  32687. * there are 2000 or more points in the series.
  32688. *
  32689. * To disable boosting on the series, set the `boostThreshold` to 0. Setting
  32690. * it to 1 will force boosting.
  32691. *
  32692. * Note that the cropThreshold also affects this setting. When zooming in on
  32693. * a series that has fewer points than the `cropThreshold`, all points are
  32694. * rendered although outside the visible plot area, and the `boostThreshold`
  32695. * won't take effect.
  32696. */
  32697. boostThreshold?: number;
  32698. /**
  32699. * (Highmaps) The border color of the map areas.
  32700. *
  32701. * In styled mode, the border stroke is given in the `.highcharts-point`
  32702. * class.
  32703. */
  32704. borderColor?: (ColorString|GradientColorObject|PatternObject);
  32705. /**
  32706. * (Highmaps) The border width of each map area.
  32707. *
  32708. * In styled mode, the border stroke width is given in the
  32709. * `.highcharts-point` class.
  32710. */
  32711. borderWidth?: number;
  32712. /**
  32713. * (Highstock) An additional class name to apply to the series' graphical
  32714. * elements. This option does not replace default class names of the
  32715. * graphical element.
  32716. */
  32717. className?: string;
  32718. /**
  32719. * (Highstock) Disable this option to allow series rendering in the whole
  32720. * plotting area.
  32721. *
  32722. * **Note:** Clipping should be always enabled when chart.zoomType is set
  32723. */
  32724. clip?: boolean;
  32725. /**
  32726. * (Highstock) The main color of the series. In line type series it applies
  32727. * to the line and the point markers unless otherwise specified. In bar type
  32728. * series it applies to the bars unless a color is specified per point. The
  32729. * default value is pulled from the `options.colors` array.
  32730. *
  32731. * In styled mode, the color can be defined by the colorIndex option. Also,
  32732. * the series color can be set with the `.highcharts-series`,
  32733. * `.highcharts-color-{n}`, `.highcharts-{type}-series` or
  32734. * `.highcharts-series-{n}` class, or individual classes given by the
  32735. * `className` option.
  32736. */
  32737. color?: (ColorString|GradientColorObject|PatternObject);
  32738. /**
  32739. * (Highstock) Styled mode only. A specific color index to use for the
  32740. * series, so its graphic representations are given the class name
  32741. * `highcharts-color-{n}`.
  32742. */
  32743. colorIndex?: number;
  32744. /**
  32745. * (Highcharts, Highstock, Highmaps) Determines what data value should be
  32746. * used to calculate point color if `colorAxis` is used. Requires to set
  32747. * `min` and `max` if some custom point property is used or if approximation
  32748. * for data grouping is set to `'sum'`.
  32749. */
  32750. colorKey?: string;
  32751. /**
  32752. * (Highstock) Compare the values of the series against the first non-null,
  32753. * non- zero value in the visible range. The y axis will show percentage or
  32754. * absolute change depending on whether `compare` is set to `"percent"` or
  32755. * `"value"`. When this is applied to multiple series, it allows comparing
  32756. * the development of the series against each other. Adds a `change` field
  32757. * to every point object.
  32758. */
  32759. compare?: string;
  32760. /**
  32761. * (Highstock) When compare is `percent`, this option dictates whether to
  32762. * use 0 or 100 as the base of comparison.
  32763. */
  32764. compareBase?: (0|100);
  32765. /**
  32766. * (Highstock) Defines if comparison should start from the first point
  32767. * within the visible range or should start from the first point **before**
  32768. * the range.
  32769. *
  32770. * In other words, this flag determines if first point within the visible
  32771. * range will have 0% (`compareStart=true`) or should have been already
  32772. * calculated according to the previous point (`compareStart=false`).
  32773. */
  32774. compareStart?: boolean;
  32775. /**
  32776. * (Highstock) Whether to compare indicator to the main series values or
  32777. * indicator values.
  32778. */
  32779. compareToMain?: boolean;
  32780. /**
  32781. * (Highcharts) Polar charts only. Whether to connect the ends of a line
  32782. * series plot across the extremes.
  32783. */
  32784. connectEnds?: boolean;
  32785. /**
  32786. * (Highcharts, Highstock) Whether to connect a graph line across null
  32787. * points, or render a gap between the two points on either side of the
  32788. * null.
  32789. */
  32790. connectNulls?: boolean;
  32791. /**
  32792. * (Gantt) Override Pathfinder connector options for a series. Requires
  32793. * Highcharts Gantt to be loaded.
  32794. */
  32795. connectors?: SeriesConnectorsOptionsObject;
  32796. /**
  32797. * (Highcharts, Highstock, Gantt) When true, each point or column edge is
  32798. * rounded to its nearest pixel in order to render sharp on screen. In some
  32799. * cases, when there are a lot of densely packed columns, this leads to
  32800. * visible difference in column widths or distance between columns. In these
  32801. * cases, setting `crisp` to `false` may look better, even though each
  32802. * column is rendered blurry.
  32803. */
  32804. crisp?: boolean;
  32805. /**
  32806. * (Highcharts, Highstock) When the series contains less points than the
  32807. * crop threshold, all points are drawn, even if the points fall outside the
  32808. * visible plot area at the current zoom. The advantage of drawing all
  32809. * points (including markers and columns), is that animation is performed on
  32810. * updates. On the other hand, when the series contains more points than the
  32811. * crop threshold, the series data is cropped to only contain points that
  32812. * fall within the plot area. The advantage of cropping away invisible
  32813. * points is to increase performance on large series.
  32814. */
  32815. cropThreshold?: number;
  32816. /**
  32817. * (Highstock) You can set the cursor to "pointer" if you have click events
  32818. * attached to the series, to signal to the user that the points and lines
  32819. * can be clicked.
  32820. *
  32821. * In styled mode, the series cursor can be set with the same classes as
  32822. * listed under series.color.
  32823. */
  32824. cursor?: (string|CursorValue);
  32825. /**
  32826. * (Highstock) A reserved subspace to store options and values for
  32827. * customized functionality. Here you can add additional data for your own
  32828. * event callbacks and formatter callbacks.
  32829. */
  32830. custom?: Dictionary<any>;
  32831. /**
  32832. * (Highstock) Name of the dash style to use for the graph, or for some
  32833. * series types the outline of each shape.
  32834. *
  32835. * In styled mode, the stroke dash-array can be set with the same classes as
  32836. * listed under series.color.
  32837. */
  32838. dashStyle?: DashStyleValue;
  32839. /**
  32840. * (Highstock) Data grouping is the concept of sampling the data values into
  32841. * larger blocks in order to ease readability and increase performance of
  32842. * the JavaScript charts. Highstock by default applies data grouping when
  32843. * the points become closer than a certain pixel value, determined by the
  32844. * `groupPixelWidth` option.
  32845. *
  32846. * If data grouping is applied, the grouping information of grouped points
  32847. * can be read from the Point.dataGroup. If point options other than the
  32848. * data itself are set, for example `name` or `color` or custom properties,
  32849. * the grouping logic doesn't know how to group it. In this case the options
  32850. * of the first point instance are copied over to the group point. This can
  32851. * be altered through a custom `approximation` callback function.
  32852. */
  32853. dataGrouping?: DataGroupingOptionsObject;
  32854. /**
  32855. * (Highcharts, Highstock, Highmaps, Gantt) Options for the series data
  32856. * labels, appearing next to each data point.
  32857. *
  32858. * Since v6.2.0, multiple data labels can be applied to each single point by
  32859. * defining them as an array of configs.
  32860. *
  32861. * In styled mode, the data labels can be styled with the
  32862. * `.highcharts-data-label-box` and `.highcharts-data-label` class names
  32863. * (see example).
  32864. */
  32865. dataLabels?: (PlotChaikinDataLabelsOptions|Array<PlotChaikinDataLabelsOptions>);
  32866. /**
  32867. * (Highcharts, Highstock) Options for the series data sorting.
  32868. */
  32869. dataSorting?: (DataSortingOptionsObject|PlotChaikinDataSortingOptions);
  32870. /**
  32871. * (Highstock) A description of the series to add to the screen reader
  32872. * information about the series.
  32873. */
  32874. description?: string;
  32875. /**
  32876. * (Highstock) Enable or disable the mouse tracking for a specific series.
  32877. * This includes point tooltips and click events on graphs and points. For
  32878. * large datasets it improves performance.
  32879. */
  32880. enableMouseTracking?: boolean;
  32881. /**
  32882. * (Highstock) General event handlers for the series items. These event
  32883. * hooks can also be attached to the series at run time using the
  32884. * `Highcharts.addEvent` function.
  32885. */
  32886. events?: SeriesEventsOptionsObject;
  32887. /**
  32888. * (Highstock) Determines whether the series should look for the nearest
  32889. * point in both dimensions or just the x-dimension when hovering the
  32890. * series. Defaults to `'xy'` for scatter series and `'x'` for most other
  32891. * series. If the data has duplicate x-values, it is recommended to set this
  32892. * to `'xy'` to allow hovering over all points.
  32893. *
  32894. * Applies only to series types using nearest neighbor search (not direct
  32895. * hover) for tooltip.
  32896. */
  32897. findNearestPointBy?: OptionsFindNearestPointByValue;
  32898. /**
  32899. * (Highstock) Defines when to display a gap in the graph, together with the
  32900. * gapUnit option.
  32901. *
  32902. * In case when `dataGrouping` is enabled, points can be grouped into a
  32903. * larger time span. This can make the grouped points to have a greater
  32904. * distance than the absolute value of `gapSize` property, which will result
  32905. * in disappearing graph completely. To prevent this situation the mentioned
  32906. * distance between grouped points is used instead of previously defined
  32907. * `gapSize`.
  32908. *
  32909. * In practice, this option is most often used to visualize gaps in time
  32910. * series. In a stock chart, intraday data is available for daytime hours,
  32911. * while gaps will appear in nights and weekends.
  32912. */
  32913. gapSize?: number;
  32914. /**
  32915. * (Highstock) Together with gapSize, this option defines where to draw gaps
  32916. * in the graph.
  32917. *
  32918. * When the `gapUnit` is `"relative"` (default), a gap size of 5 means that
  32919. * if the distance between two points is greater than 5 times that of the
  32920. * two closest points, the graph will be broken.
  32921. *
  32922. * When the `gapUnit` is `"value"`, the gap is based on absolute axis
  32923. * values, which on a datetime axis is milliseconds. This also applies to
  32924. * the navigator series that inherits gap options from the base series.
  32925. */
  32926. gapUnit?: OptionsGapUnitValue;
  32927. /**
  32928. * (Highcharts, Highstock, Gantt) Whether to use the Y extremes of the total
  32929. * chart width or only the zoomed area when zooming in on parts of the X
  32930. * axis. By default, the Y axis adjusts to the min and max of the visible
  32931. * data. Cartesian series only.
  32932. */
  32933. getExtremesFromAll?: boolean;
  32934. /**
  32935. * (Highstock) When set to `false` will prevent the series data from being
  32936. * included in any form of data export.
  32937. *
  32938. * Since version 6.0.0 until 7.1.0 the option was existing undocumented as
  32939. * `includeInCSVExport`.
  32940. */
  32941. includeInDataExport?: boolean;
  32942. /**
  32943. * (Highcharts, Highstock, Gantt) Series labels are placed as close to the
  32944. * series as possible in a natural way, seeking to avoid other series. The
  32945. * goal of this feature is to make the chart more easily readable, like if a
  32946. * human designer placed the labels in the optimal position.
  32947. *
  32948. * The series labels currently work with series types having a `graph` or an
  32949. * `area`.
  32950. */
  32951. label?: SeriesLabelOptionsObject;
  32952. /**
  32953. * (Highstock) The line marks the last price from all points.
  32954. */
  32955. lastPrice?: SeriesLastPriceOptionsObject;
  32956. /**
  32957. * (Highstock) The line marks the last price from visible range of points.
  32958. */
  32959. lastVisiblePrice?: SeriesLastVisiblePriceOptionsObject;
  32960. /**
  32961. * (Highcharts, Highstock) The SVG value used for the `stroke-linecap` and
  32962. * `stroke-linejoin` of a line graph. Round means that lines are rounded in
  32963. * the ends and bends.
  32964. */
  32965. linecap?: SeriesLinecapValue;
  32966. /**
  32967. * (Highcharts, Highstock) Pixel width of the graph line.
  32968. */
  32969. lineWidth?: number;
  32970. /**
  32971. * (Highcharts, Highstock, Gantt) The main series ID that indicator will be
  32972. * based on. Required for this indicator.
  32973. */
  32974. linkedTo?: string;
  32975. /**
  32976. * (Highstock) Options for the point markers of line-like series. Properties
  32977. * like `fillColor`, `lineColor` and `lineWidth` define the visual
  32978. * appearance of the markers. Other series types, like column series, don't
  32979. * have markers, but have visual options on the series level instead.
  32980. *
  32981. * In styled mode, the markers can be styled with the `.highcharts-point`,
  32982. * `.highcharts-point-hover` and `.highcharts-point-select` class names.
  32983. */
  32984. marker?: PointMarkerOptionsObject;
  32985. /**
  32986. * (Highstock) The name of the series as shown in the legend, tooltip etc.
  32987. * If not set, it will be based on a technical indicator type and default
  32988. * params.
  32989. */
  32990. name?: string;
  32991. /**
  32992. * (Highstock) The color for the parts of the graph or points that are below
  32993. * the threshold. Note that `zones` takes precedence over the negative
  32994. * color. Using `negativeColor` is equivalent to applying a zone with value
  32995. * of 0.
  32996. */
  32997. negativeColor?: (ColorString|GradientColorObject|PatternObject);
  32998. /**
  32999. * (Highstock) Opacity of a series parts: line, fill (e.g. area) and
  33000. * dataLabels.
  33001. */
  33002. opacity?: number;
  33003. /**
  33004. * (Highstock) Paramters used in calculation of Chaikin Oscillator series
  33005. * points.
  33006. */
  33007. params?: PlotChaikinParamsOptions;
  33008. /**
  33009. * (Highstock) Properties for each single point.
  33010. */
  33011. point?: PlotSeriesPointOptions;
  33012. /**
  33013. * (Highstock) Same as accessibility.pointDescriptionFormatter, but for an
  33014. * individual series. Overrides the chart wide configuration.
  33015. */
  33016. pointDescriptionFormatter?: Function;
  33017. /**
  33018. * (Highstock) Whether to select the series initially. If `showCheckbox` is
  33019. * true, the checkbox next to the series name in the legend will be checked
  33020. * for a selected series.
  33021. */
  33022. selected?: boolean;
  33023. /**
  33024. * (Highstock) Whether to apply a drop shadow to the graph line. Since 2.3
  33025. * the shadow can be an object configuration containing `color`, `offsetX`,
  33026. * `offsetY`, `opacity` and `width`.
  33027. */
  33028. shadow?: (boolean|ShadowOptionsObject);
  33029. /**
  33030. * (Highstock) If true, a checkbox is displayed next to the legend item to
  33031. * allow selecting the series. The state of the checkbox is determined by
  33032. * the `selected` option.
  33033. */
  33034. showCheckbox?: boolean;
  33035. /**
  33036. * (Highstock) Whether to display this particular series or series type in
  33037. * the legend. Standalone series are shown in legend by default, and linked
  33038. * series are not. Since v7.2.0 it is possible to show series that use
  33039. * colorAxis by setting this option to `true`.
  33040. */
  33041. showInLegend?: boolean;
  33042. /**
  33043. * (Highstock) If set to `true`, the accessibility module will skip past the
  33044. * points in this series for keyboard navigation.
  33045. */
  33046. skipKeyboardNavigation?: boolean;
  33047. /**
  33048. * (Highcharts, Highstock) When this is true, the series will not cause the
  33049. * Y axis to cross the zero plane (or threshold option) unless the data
  33050. * actually crosses the plane.
  33051. *
  33052. * For example, if `softThreshold` is `false`, a series of 0, 1, 2, 3 will
  33053. * make the Y axis show negative values according to the `minPadding`
  33054. * option. If `softThreshold` is `true`, the Y axis starts at 0.
  33055. */
  33056. softThreshold?: boolean;
  33057. states?: SeriesStatesOptionsObject;
  33058. /**
  33059. * (Highcharts, Highstock) Whether to apply steps to the line. Possible
  33060. * values are `left`, `center` and `right`.
  33061. */
  33062. step?: OptionsStepValue;
  33063. /**
  33064. * (Highstock) Sticky tracking of mouse events. When true, the `mouseOut`
  33065. * event on a series isn't triggered until the mouse moves over another
  33066. * series, or out of the plot area. When false, the `mouseOut` event on a
  33067. * series is triggered when the mouse leaves the area around the series'
  33068. * graph or markers. This also implies the tooltip when not shared. When
  33069. * `stickyTracking` is false and `tooltip.shared` is false, the tooltip will
  33070. * be hidden when moving the mouse between series. Defaults to true for line
  33071. * and area type series, but to false for columns, pies etc.
  33072. *
  33073. * **Note:** The boost module will force this option because of technical
  33074. * limitations.
  33075. */
  33076. stickyTracking?: boolean;
  33077. /**
  33078. * (Highcharts, Highstock) The threshold, also called zero level or base
  33079. * level. For line type series this is only used in conjunction with
  33080. * negativeColor.
  33081. */
  33082. threshold?: (number|null);
  33083. /**
  33084. * (Highstock) A configuration object for the tooltip rendering of each
  33085. * single series. Properties are inherited from tooltip, but only the
  33086. * following properties can be defined on a series level.
  33087. */
  33088. tooltip?: SeriesTooltipOptionsObject;
  33089. /**
  33090. * (Highcharts, Highstock, Gantt) When a series contains a data array that
  33091. * is longer than this, only one dimensional arrays of numbers, or two
  33092. * dimensional arrays with x and y values are allowed. Also, only the first
  33093. * point is tested, and the rest are assumed to be the same format. This
  33094. * saves expensive data checking and indexing in long series. Set it to `0`
  33095. * disable.
  33096. *
  33097. * Note: In boost mode turbo threshold is forced. Only array of numbers or
  33098. * two dimensional arrays are allowed.
  33099. */
  33100. turboThreshold?: number;
  33101. /**
  33102. * (Highstock) Set the initial visibility of the series.
  33103. */
  33104. visible?: boolean;
  33105. /**
  33106. * (Highmaps) Define the z index of the series.
  33107. */
  33108. zIndex?: number;
  33109. /**
  33110. * (Highcharts, Highstock) Defines the Axis on which the zones are applied.
  33111. */
  33112. zoneAxis?: string;
  33113. /**
  33114. * (Highcharts, Highstock) An array defining zones within a series. Zones
  33115. * can be applied to the X axis, Y axis or Z axis for bubbles, according to
  33116. * the `zoneAxis` option. The zone definitions have to be in ascending order
  33117. * regarding to the value.
  33118. *
  33119. * In styled mode, the color zones are styled with the
  33120. * `.highcharts-zone-{n}` class, or custom classed from the `className`
  33121. * option (view live demo).
  33122. */
  33123. zones?: Array<SeriesZonesOptionsObject>;
  33124. }
  33125. /**
  33126. * (Highstock) Paramters used in calculation of Chaikin Oscillator series
  33127. * points.
  33128. */
  33129. export interface PlotChaikinParamsOptions {
  33130. /**
  33131. * (Highstock) Periods for Chaikin Oscillator calculations.
  33132. */
  33133. periods?: Array<number>;
  33134. /**
  33135. * (Highstock) The id of volume series which is mandatory. For example using
  33136. * OHLC data, volumeSeriesID='volume' means the indicator will be calculated
  33137. * using OHLC and volume values.
  33138. */
  33139. volumeSeriesID?: string;
  33140. }
  33141. /**
  33142. * (Highstock) Enable or disable the initial animation when a series is
  33143. * displayed. The animation can also be set as a configuration object. Please
  33144. * note that this option only applies to the initial animation of the series
  33145. * itself. For other animations, see chart.animation and the animation parameter
  33146. * under the API methods. The following properties are supported:
  33147. *
  33148. * - `defer`: The animation delay time in milliseconds.
  33149. *
  33150. * - `duration`: The duration of the animation in milliseconds.
  33151. *
  33152. * - `easing`: Can be a string reference to an easing function set on the `Math`
  33153. * object or a function. See the _Custom easing function_ demo below.
  33154. *
  33155. * Due to poor performance, animation is disabled in old IE browsers for several
  33156. * chart types.
  33157. */
  33158. export interface PlotCmfAnimationOptions {
  33159. defer?: number;
  33160. }
  33161. /**
  33162. * (Highcharts, Highstock, Highmaps, Gantt) Enable or disable the initial
  33163. * animation when a series is displayed for the `dataLabels`. The animation can
  33164. * also be set as a configuration object. Please note that this option only
  33165. * applies to the initial animation. For other animations, see chart.animation
  33166. * and the animation parameter under the API methods. The following properties
  33167. * are supported:
  33168. *
  33169. * - `defer`: The animation delay time in milliseconds.
  33170. */
  33171. export interface PlotCmfDataLabelsAnimationOptions {
  33172. /**
  33173. * (Highcharts, Highstock, Highmaps, Gantt) The animation delay time in
  33174. * milliseconds. Set to `0` renders dataLabel immediately. As `undefined`
  33175. * inherits defer time from the series.animation.defer.
  33176. */
  33177. defer?: number;
  33178. }
  33179. /**
  33180. * (Highcharts, Highstock, Highmaps, Gantt) Options for the series data labels,
  33181. * appearing next to each data point.
  33182. *
  33183. * Since v6.2.0, multiple data labels can be applied to each single point by
  33184. * defining them as an array of configs.
  33185. *
  33186. * In styled mode, the data labels can be styled with the
  33187. * `.highcharts-data-label-box` and `.highcharts-data-label` class names (see
  33188. * example).
  33189. */
  33190. export interface PlotCmfDataLabelsOptions {
  33191. /**
  33192. * (Highcharts, Highstock, Highmaps, Gantt) The alignment of the data label
  33193. * compared to the point. If `right`, the right side of the label should be
  33194. * touching the point. For points with an extent, like columns, the
  33195. * alignments also dictates how to align it inside the box, as given with
  33196. * the inside option. Can be one of `left`, `center` or `right`.
  33197. */
  33198. align?: (AlignValue|null);
  33199. /**
  33200. * (Highcharts, Highstock, Highmaps, Gantt) Whether to allow data labels to
  33201. * overlap. To make the labels less sensitive for overlapping, the
  33202. * dataLabels.padding can be set to 0.
  33203. */
  33204. allowOverlap?: boolean;
  33205. /**
  33206. * (Highcharts, Highstock, Highmaps, Gantt) Enable or disable the initial
  33207. * animation when a series is displayed for the `dataLabels`. The animation
  33208. * can also be set as a configuration object. Please note that this option
  33209. * only applies to the initial animation. For other animations, see
  33210. * chart.animation and the animation parameter under the API methods. The
  33211. * following properties are supported:
  33212. *
  33213. * - `defer`: The animation delay time in milliseconds.
  33214. */
  33215. animation?: (boolean|PlotCmfDataLabelsAnimationOptions|Partial<AnimationOptionsObject>);
  33216. /**
  33217. * (Highcharts, Highstock, Highmaps, Gantt) The background color or gradient
  33218. * for the data label.
  33219. */
  33220. backgroundColor?: (ColorString|GradientColorObject|PatternObject);
  33221. /**
  33222. * (Highcharts, Highstock, Highmaps, Gantt) The border color for the data
  33223. * label. Defaults to `undefined`.
  33224. */
  33225. borderColor?: (ColorString|GradientColorObject|PatternObject);
  33226. /**
  33227. * (Highcharts, Highstock, Highmaps, Gantt) The border radius in pixels for
  33228. * the data label.
  33229. */
  33230. borderRadius?: number;
  33231. /**
  33232. * (Highcharts, Highstock, Highmaps, Gantt) The border width in pixels for
  33233. * the data label.
  33234. */
  33235. borderWidth?: number;
  33236. /**
  33237. * (Highcharts, Highstock, Highmaps, Gantt) A class name for the data label.
  33238. * Particularly in styled mode, this can be used to give each series' or
  33239. * point's data label unique styling. In addition to this option, a default
  33240. * color class name is added so that we can give the labels a contrast text
  33241. * shadow.
  33242. */
  33243. className?: string;
  33244. /**
  33245. * (Highcharts, Highstock, Highmaps, Gantt) The text color for the data
  33246. * labels. Defaults to `undefined`. For certain series types, like column or
  33247. * map, the data labels can be drawn inside the points. In this case the
  33248. * data label will be drawn with maximum contrast by default. Additionally,
  33249. * it will be given a `text-outline` style with the opposite color, to
  33250. * further increase the contrast. This can be overridden by setting the
  33251. * `text-outline` style to `none` in the `dataLabels.style` option.
  33252. */
  33253. color?: (ColorString|GradientColorObject|PatternObject);
  33254. /**
  33255. * (Highcharts, Highstock, Highmaps, Gantt) Whether to hide data labels that
  33256. * are outside the plot area. By default, the data label is moved inside the
  33257. * plot area according to the overflow option.
  33258. */
  33259. crop?: boolean;
  33260. /**
  33261. * (Highcharts, Highstock, Gantt) Whether to defer displaying the data
  33262. * labels until the initial series animation has finished. Setting to
  33263. * `false` renders the data label immediately. If set to `true` inherits the
  33264. * defer time set in plotOptions.series.animation.
  33265. */
  33266. defer?: boolean;
  33267. /**
  33268. * (Highcharts, Highstock, Highmaps, Gantt) Enable or disable the data
  33269. * labels.
  33270. */
  33271. enabled?: boolean;
  33272. /**
  33273. * (Highcharts, Highstock, Highmaps, Gantt) A declarative filter to control
  33274. * of which data labels to display. The declarative filter is designed for
  33275. * use when callback functions are not available, like when the chart
  33276. * options require a pure JSON structure or for use with graphical editors.
  33277. * For programmatic control, use the `formatter` instead, and return
  33278. * `undefined` to disable a single data label.
  33279. */
  33280. filter?: DataLabelsFilterOptionsObject;
  33281. /**
  33282. * (Highcharts, Highstock, Highmaps, Gantt) A format string for the data
  33283. * label. Available variables are the same as for `formatter`.
  33284. */
  33285. format?: string;
  33286. /**
  33287. * (Highcharts, Highstock, Highmaps, Gantt) Callback JavaScript function to
  33288. * format the data label. Note that if a `format` is defined, the format
  33289. * takes precedence and the formatter is ignored.
  33290. */
  33291. formatter?: DataLabelsFormatterCallbackFunction;
  33292. /**
  33293. * (Highcharts, Highstock, Highmaps, Gantt) For points with an extent, like
  33294. * columns or map areas, whether to align the data label inside the box or
  33295. * to the actual value point. Defaults to `false` in most cases, `true` in
  33296. * stacked columns.
  33297. */
  33298. inside?: boolean;
  33299. /**
  33300. * (Highcharts, Highstock, Highmaps, Gantt) Format for points with the value
  33301. * of null. Works analogously to format. `nullFormat` can be applied only to
  33302. * series which support displaying null points.
  33303. */
  33304. nullFormat?: (boolean|string);
  33305. /**
  33306. * (Highcharts, Highstock, Highmaps, Gantt) Callback JavaScript function
  33307. * that defines formatting for points with the value of null. Works
  33308. * analogously to formatter. `nullPointFormatter` can be applied only to
  33309. * series which support displaying null points.
  33310. */
  33311. nullFormatter?: DataLabelsFormatterCallbackFunction;
  33312. /**
  33313. * (Highcharts, Highstock, Highmaps, Gantt) How to handle data labels that
  33314. * flow outside the plot area. The default is `"justify"`, which aligns them
  33315. * inside the plot area. For columns and bars, this means it will be moved
  33316. * inside the bar. To display data labels outside the plot area, set `crop`
  33317. * to `false` and `overflow` to `"allow"`.
  33318. */
  33319. overflow?: DataLabelsOverflowValue;
  33320. /**
  33321. * (Highcharts, Highstock, Highmaps, Gantt) When either the `borderWidth` or
  33322. * the `backgroundColor` is set, this is the padding within the box.
  33323. */
  33324. padding?: number;
  33325. /**
  33326. * (Highcharts, Highstock, Highmaps, Gantt) Aligns data labels relative to
  33327. * points. If `center` alignment is not possible, it defaults to `right`.
  33328. */
  33329. position?: AlignValue;
  33330. /**
  33331. * (Highcharts, Highstock, Highmaps, Gantt) Text rotation in degrees. Note
  33332. * that due to a more complex structure, backgrounds, borders and padding
  33333. * will be lost on a rotated data label.
  33334. */
  33335. rotation?: number;
  33336. /**
  33337. * (Highcharts, Highstock, Highmaps, Gantt) The shadow of the box. Works
  33338. * best with `borderWidth` or `backgroundColor`. Since 2.3 the shadow can be
  33339. * an object configuration containing `color`, `offsetX`, `offsetY`,
  33340. * `opacity` and `width`.
  33341. */
  33342. shadow?: (boolean|ShadowOptionsObject);
  33343. /**
  33344. * (Highcharts, Highstock, Highmaps, Gantt) The name of a symbol to use for
  33345. * the border around the label. Symbols are predefined functions on the
  33346. * Renderer object.
  33347. */
  33348. shape?: string;
  33349. /**
  33350. * (Highcharts, Highstock, Highmaps, Gantt) Styles for the label. The
  33351. * default `color` setting is `"contrast"`, which is a pseudo color that
  33352. * Highcharts picks up and applies the maximum contrast to the underlying
  33353. * point item, for example the bar in a bar chart.
  33354. *
  33355. * The `textOutline` is a pseudo property that applies an outline of the
  33356. * given width with the given color, which by default is the maximum
  33357. * contrast to the text. So a bright text color will result in a black text
  33358. * outline for maximum readability on a mixed background. In some cases,
  33359. * especially with grayscale text, the text outline doesn't work well, in
  33360. * which cases it can be disabled by setting it to `"none"`. When `useHTML`
  33361. * is true, the `textOutline` will not be picked up. In this, case, the same
  33362. * effect can be acheived through the `text-shadow` CSS property.
  33363. *
  33364. * For some series types, where each point has an extent, like for example
  33365. * tree maps, the data label may overflow the point. There are two
  33366. * strategies for handling overflow. By default, the text will wrap to
  33367. * multiple lines. The other strategy is to set `style.textOverflow` to
  33368. * `ellipsis`, which will keep the text on one line plus it will break
  33369. * inside long words.
  33370. */
  33371. style?: CSSObject;
  33372. /**
  33373. * (Highcharts, Highstock, Highmaps, Gantt) Options for a label text which
  33374. * should follow marker's shape. Border and background are disabled for a
  33375. * label that follows a path.
  33376. *
  33377. * **Note:** Only SVG-based renderer supports this option. Setting `useHTML`
  33378. * to true will disable this option.
  33379. */
  33380. textPath?: DataLabelsTextPathOptionsObject;
  33381. /**
  33382. * (Highcharts, Highstock, Highmaps, Gantt) Whether to use HTML to render
  33383. * the labels.
  33384. */
  33385. useHTML?: boolean;
  33386. /**
  33387. * (Highcharts, Highstock, Highmaps, Gantt) The vertical alignment of a data
  33388. * label. Can be one of `top`, `middle` or `bottom`. The default value
  33389. * depends on the data, for instance in a column chart, the label is above
  33390. * positive values and below negative values.
  33391. */
  33392. verticalAlign?: (VerticalAlignValue|null);
  33393. /**
  33394. * (Highcharts, Highstock, Highmaps, Gantt) The x position offset of the
  33395. * label relative to the point in pixels.
  33396. */
  33397. x?: number;
  33398. /**
  33399. * (Highcharts, Highstock, Highmaps, Gantt) The y position offset of the
  33400. * label relative to the point in pixels.
  33401. */
  33402. y?: number;
  33403. /**
  33404. * (Highcharts, Highstock, Highmaps, Gantt) The Z index of the data labels.
  33405. * The default Z index puts it above the series. Use a Z index of 2 to
  33406. * display it behind the series.
  33407. */
  33408. z?: number;
  33409. }
  33410. /**
  33411. * (Highcharts, Highstock) Options for the series data sorting.
  33412. */
  33413. export interface PlotCmfDataSortingOptions {
  33414. /**
  33415. * (Highcharts, Highstock) Enable or disable data sorting for the series.
  33416. * Use xAxis.reversed to change the sorting order.
  33417. */
  33418. enabled?: boolean;
  33419. /**
  33420. * (Highcharts, Highstock) Whether to allow matching points by name in an
  33421. * update. If this option is disabled, points will be matched by order.
  33422. */
  33423. matchByName?: boolean;
  33424. /**
  33425. * (Highcharts, Highstock) Determines what data value should be used to sort
  33426. * by.
  33427. */
  33428. sortKey?: string;
  33429. }
  33430. /**
  33431. * (Highstock) Chaikin Money Flow indicator (cmf).
  33432. *
  33433. * In TypeScript the type option must always be set.
  33434. *
  33435. * Configuration options for the series are given in three levels:
  33436. *
  33437. * 1. Options for all series in a chart are defined in the plotOptions.series
  33438. * object.
  33439. *
  33440. * 2. Options for all `cmf` series are defined in plotOptions.cmf.
  33441. *
  33442. * 3. Options for one single series are given in the series instance array. (see
  33443. * online documentation for example)
  33444. */
  33445. export interface PlotCmfOptions {
  33446. /**
  33447. * (Highstock) Accessibility options for a series.
  33448. */
  33449. accessibility?: SeriesAccessibilityOptionsObject;
  33450. /**
  33451. * (Highstock) Allow this series' points to be selected by clicking on the
  33452. * graphic (columns, point markers, pie slices, map areas etc).
  33453. *
  33454. * The selected points can be handled by point select and unselect events,
  33455. * or collectively by the getSelectedPoints function.
  33456. *
  33457. * And alternative way of selecting points is through dragging.
  33458. */
  33459. allowPointSelect?: boolean;
  33460. /**
  33461. * (Highstock) Enable or disable the initial animation when a series is
  33462. * displayed. The animation can also be set as a configuration object.
  33463. * Please note that this option only applies to the initial animation of the
  33464. * series itself. For other animations, see chart.animation and the
  33465. * animation parameter under the API methods. The following properties are
  33466. * supported:
  33467. *
  33468. * - `defer`: The animation delay time in milliseconds.
  33469. *
  33470. * - `duration`: The duration of the animation in milliseconds.
  33471. *
  33472. * - `easing`: Can be a string reference to an easing function set on the
  33473. * `Math` object or a function. See the _Custom easing function_ demo below.
  33474. *
  33475. * Due to poor performance, animation is disabled in old IE browsers for
  33476. * several chart types.
  33477. */
  33478. animation?: (boolean|PlotCmfAnimationOptions|Partial<AnimationOptionsObject>);
  33479. /**
  33480. * (Highstock) Sets the color blending in the boost module.
  33481. */
  33482. boostBlending?: OptionsBoostBlendingValue;
  33483. /**
  33484. * (Highstock) Set the point threshold for when a series should enter boost
  33485. * mode.
  33486. *
  33487. * Setting it to e.g. 2000 will cause the series to enter boost mode when
  33488. * there are 2000 or more points in the series.
  33489. *
  33490. * To disable boosting on the series, set the `boostThreshold` to 0. Setting
  33491. * it to 1 will force boosting.
  33492. *
  33493. * Note that the cropThreshold also affects this setting. When zooming in on
  33494. * a series that has fewer points than the `cropThreshold`, all points are
  33495. * rendered although outside the visible plot area, and the `boostThreshold`
  33496. * won't take effect.
  33497. */
  33498. boostThreshold?: number;
  33499. /**
  33500. * (Highmaps) The border color of the map areas.
  33501. *
  33502. * In styled mode, the border stroke is given in the `.highcharts-point`
  33503. * class.
  33504. */
  33505. borderColor?: (ColorString|GradientColorObject|PatternObject);
  33506. /**
  33507. * (Highmaps) The border width of each map area.
  33508. *
  33509. * In styled mode, the border stroke width is given in the
  33510. * `.highcharts-point` class.
  33511. */
  33512. borderWidth?: number;
  33513. /**
  33514. * (Highstock) An additional class name to apply to the series' graphical
  33515. * elements. This option does not replace default class names of the
  33516. * graphical element.
  33517. */
  33518. className?: string;
  33519. /**
  33520. * (Highstock) Disable this option to allow series rendering in the whole
  33521. * plotting area.
  33522. *
  33523. * **Note:** Clipping should be always enabled when chart.zoomType is set
  33524. */
  33525. clip?: boolean;
  33526. /**
  33527. * (Highstock) The main color of the series. In line type series it applies
  33528. * to the line and the point markers unless otherwise specified. In bar type
  33529. * series it applies to the bars unless a color is specified per point. The
  33530. * default value is pulled from the `options.colors` array.
  33531. *
  33532. * In styled mode, the color can be defined by the colorIndex option. Also,
  33533. * the series color can be set with the `.highcharts-series`,
  33534. * `.highcharts-color-{n}`, `.highcharts-{type}-series` or
  33535. * `.highcharts-series-{n}` class, or individual classes given by the
  33536. * `className` option.
  33537. */
  33538. color?: (ColorString|GradientColorObject|PatternObject);
  33539. /**
  33540. * (Highstock) Styled mode only. A specific color index to use for the
  33541. * series, so its graphic representations are given the class name
  33542. * `highcharts-color-{n}`.
  33543. */
  33544. colorIndex?: number;
  33545. /**
  33546. * (Highcharts, Highstock, Highmaps) Determines what data value should be
  33547. * used to calculate point color if `colorAxis` is used. Requires to set
  33548. * `min` and `max` if some custom point property is used or if approximation
  33549. * for data grouping is set to `'sum'`.
  33550. */
  33551. colorKey?: string;
  33552. /**
  33553. * (Highstock) Compare the values of the series against the first non-null,
  33554. * non- zero value in the visible range. The y axis will show percentage or
  33555. * absolute change depending on whether `compare` is set to `"percent"` or
  33556. * `"value"`. When this is applied to multiple series, it allows comparing
  33557. * the development of the series against each other. Adds a `change` field
  33558. * to every point object.
  33559. */
  33560. compare?: string;
  33561. /**
  33562. * (Highstock) When compare is `percent`, this option dictates whether to
  33563. * use 0 or 100 as the base of comparison.
  33564. */
  33565. compareBase?: (0|100);
  33566. /**
  33567. * (Highstock) Defines if comparison should start from the first point
  33568. * within the visible range or should start from the first point **before**
  33569. * the range.
  33570. *
  33571. * In other words, this flag determines if first point within the visible
  33572. * range will have 0% (`compareStart=true`) or should have been already
  33573. * calculated according to the previous point (`compareStart=false`).
  33574. */
  33575. compareStart?: boolean;
  33576. /**
  33577. * (Highstock) Whether to compare indicator to the main series values or
  33578. * indicator values.
  33579. */
  33580. compareToMain?: boolean;
  33581. /**
  33582. * (Highcharts) Polar charts only. Whether to connect the ends of a line
  33583. * series plot across the extremes.
  33584. */
  33585. connectEnds?: boolean;
  33586. /**
  33587. * (Highcharts, Highstock) Whether to connect a graph line across null
  33588. * points, or render a gap between the two points on either side of the
  33589. * null.
  33590. */
  33591. connectNulls?: boolean;
  33592. /**
  33593. * (Gantt) Override Pathfinder connector options for a series. Requires
  33594. * Highcharts Gantt to be loaded.
  33595. */
  33596. connectors?: SeriesConnectorsOptionsObject;
  33597. /**
  33598. * (Highcharts, Highstock, Gantt) When true, each point or column edge is
  33599. * rounded to its nearest pixel in order to render sharp on screen. In some
  33600. * cases, when there are a lot of densely packed columns, this leads to
  33601. * visible difference in column widths or distance between columns. In these
  33602. * cases, setting `crisp` to `false` may look better, even though each
  33603. * column is rendered blurry.
  33604. */
  33605. crisp?: boolean;
  33606. /**
  33607. * (Highcharts, Highstock) When the series contains less points than the
  33608. * crop threshold, all points are drawn, even if the points fall outside the
  33609. * visible plot area at the current zoom. The advantage of drawing all
  33610. * points (including markers and columns), is that animation is performed on
  33611. * updates. On the other hand, when the series contains more points than the
  33612. * crop threshold, the series data is cropped to only contain points that
  33613. * fall within the plot area. The advantage of cropping away invisible
  33614. * points is to increase performance on large series.
  33615. */
  33616. cropThreshold?: number;
  33617. /**
  33618. * (Highstock) You can set the cursor to "pointer" if you have click events
  33619. * attached to the series, to signal to the user that the points and lines
  33620. * can be clicked.
  33621. *
  33622. * In styled mode, the series cursor can be set with the same classes as
  33623. * listed under series.color.
  33624. */
  33625. cursor?: (string|CursorValue);
  33626. /**
  33627. * (Highstock) A reserved subspace to store options and values for
  33628. * customized functionality. Here you can add additional data for your own
  33629. * event callbacks and formatter callbacks.
  33630. */
  33631. custom?: Dictionary<any>;
  33632. /**
  33633. * (Highstock) Name of the dash style to use for the graph, or for some
  33634. * series types the outline of each shape.
  33635. *
  33636. * In styled mode, the stroke dash-array can be set with the same classes as
  33637. * listed under series.color.
  33638. */
  33639. dashStyle?: DashStyleValue;
  33640. /**
  33641. * (Highstock) Data grouping is the concept of sampling the data values into
  33642. * larger blocks in order to ease readability and increase performance of
  33643. * the JavaScript charts. Highstock by default applies data grouping when
  33644. * the points become closer than a certain pixel value, determined by the
  33645. * `groupPixelWidth` option.
  33646. *
  33647. * If data grouping is applied, the grouping information of grouped points
  33648. * can be read from the Point.dataGroup. If point options other than the
  33649. * data itself are set, for example `name` or `color` or custom properties,
  33650. * the grouping logic doesn't know how to group it. In this case the options
  33651. * of the first point instance are copied over to the group point. This can
  33652. * be altered through a custom `approximation` callback function.
  33653. */
  33654. dataGrouping?: DataGroupingOptionsObject;
  33655. /**
  33656. * (Highcharts, Highstock, Highmaps, Gantt) Options for the series data
  33657. * labels, appearing next to each data point.
  33658. *
  33659. * Since v6.2.0, multiple data labels can be applied to each single point by
  33660. * defining them as an array of configs.
  33661. *
  33662. * In styled mode, the data labels can be styled with the
  33663. * `.highcharts-data-label-box` and `.highcharts-data-label` class names
  33664. * (see example).
  33665. */
  33666. dataLabels?: (PlotCmfDataLabelsOptions|Array<PlotCmfDataLabelsOptions>);
  33667. /**
  33668. * (Highcharts, Highstock) Options for the series data sorting.
  33669. */
  33670. dataSorting?: (DataSortingOptionsObject|PlotCmfDataSortingOptions);
  33671. /**
  33672. * (Highstock) A description of the series to add to the screen reader
  33673. * information about the series.
  33674. */
  33675. description?: string;
  33676. /**
  33677. * (Highstock) Enable or disable the mouse tracking for a specific series.
  33678. * This includes point tooltips and click events on graphs and points. For
  33679. * large datasets it improves performance.
  33680. */
  33681. enableMouseTracking?: boolean;
  33682. /**
  33683. * (Highstock) General event handlers for the series items. These event
  33684. * hooks can also be attached to the series at run time using the
  33685. * `Highcharts.addEvent` function.
  33686. */
  33687. events?: SeriesEventsOptionsObject;
  33688. /**
  33689. * (Highstock) Determines whether the series should look for the nearest
  33690. * point in both dimensions or just the x-dimension when hovering the
  33691. * series. Defaults to `'xy'` for scatter series and `'x'` for most other
  33692. * series. If the data has duplicate x-values, it is recommended to set this
  33693. * to `'xy'` to allow hovering over all points.
  33694. *
  33695. * Applies only to series types using nearest neighbor search (not direct
  33696. * hover) for tooltip.
  33697. */
  33698. findNearestPointBy?: OptionsFindNearestPointByValue;
  33699. /**
  33700. * (Highstock) Defines when to display a gap in the graph, together with the
  33701. * gapUnit option.
  33702. *
  33703. * In case when `dataGrouping` is enabled, points can be grouped into a
  33704. * larger time span. This can make the grouped points to have a greater
  33705. * distance than the absolute value of `gapSize` property, which will result
  33706. * in disappearing graph completely. To prevent this situation the mentioned
  33707. * distance between grouped points is used instead of previously defined
  33708. * `gapSize`.
  33709. *
  33710. * In practice, this option is most often used to visualize gaps in time
  33711. * series. In a stock chart, intraday data is available for daytime hours,
  33712. * while gaps will appear in nights and weekends.
  33713. */
  33714. gapSize?: number;
  33715. /**
  33716. * (Highstock) Together with gapSize, this option defines where to draw gaps
  33717. * in the graph.
  33718. *
  33719. * When the `gapUnit` is `"relative"` (default), a gap size of 5 means that
  33720. * if the distance between two points is greater than 5 times that of the
  33721. * two closest points, the graph will be broken.
  33722. *
  33723. * When the `gapUnit` is `"value"`, the gap is based on absolute axis
  33724. * values, which on a datetime axis is milliseconds. This also applies to
  33725. * the navigator series that inherits gap options from the base series.
  33726. */
  33727. gapUnit?: OptionsGapUnitValue;
  33728. /**
  33729. * (Highcharts, Highstock, Gantt) Whether to use the Y extremes of the total
  33730. * chart width or only the zoomed area when zooming in on parts of the X
  33731. * axis. By default, the Y axis adjusts to the min and max of the visible
  33732. * data. Cartesian series only.
  33733. */
  33734. getExtremesFromAll?: boolean;
  33735. /**
  33736. * (Highstock) When set to `false` will prevent the series data from being
  33737. * included in any form of data export.
  33738. *
  33739. * Since version 6.0.0 until 7.1.0 the option was existing undocumented as
  33740. * `includeInCSVExport`.
  33741. */
  33742. includeInDataExport?: boolean;
  33743. /**
  33744. * (Highcharts, Highstock, Gantt) Series labels are placed as close to the
  33745. * series as possible in a natural way, seeking to avoid other series. The
  33746. * goal of this feature is to make the chart more easily readable, like if a
  33747. * human designer placed the labels in the optimal position.
  33748. *
  33749. * The series labels currently work with series types having a `graph` or an
  33750. * `area`.
  33751. */
  33752. label?: SeriesLabelOptionsObject;
  33753. /**
  33754. * (Highstock) The line marks the last price from all points.
  33755. */
  33756. lastPrice?: SeriesLastPriceOptionsObject;
  33757. /**
  33758. * (Highstock) The line marks the last price from visible range of points.
  33759. */
  33760. lastVisiblePrice?: SeriesLastVisiblePriceOptionsObject;
  33761. /**
  33762. * (Highcharts, Highstock) The SVG value used for the `stroke-linecap` and
  33763. * `stroke-linejoin` of a line graph. Round means that lines are rounded in
  33764. * the ends and bends.
  33765. */
  33766. linecap?: SeriesLinecapValue;
  33767. /**
  33768. * (Highcharts, Highstock) Pixel width of the graph line.
  33769. */
  33770. lineWidth?: number;
  33771. /**
  33772. * (Highcharts, Highstock, Gantt) The main series ID that indicator will be
  33773. * based on. Required for this indicator.
  33774. */
  33775. linkedTo?: string;
  33776. /**
  33777. * (Highstock) Options for the point markers of line-like series. Properties
  33778. * like `fillColor`, `lineColor` and `lineWidth` define the visual
  33779. * appearance of the markers. Other series types, like column series, don't
  33780. * have markers, but have visual options on the series level instead.
  33781. *
  33782. * In styled mode, the markers can be styled with the `.highcharts-point`,
  33783. * `.highcharts-point-hover` and `.highcharts-point-select` class names.
  33784. */
  33785. marker?: PointMarkerOptionsObject;
  33786. /**
  33787. * (Highstock) The name of the series as shown in the legend, tooltip etc.
  33788. * If not set, it will be based on a technical indicator type and default
  33789. * params.
  33790. */
  33791. name?: string;
  33792. /**
  33793. * (Highstock) The color for the parts of the graph or points that are below
  33794. * the threshold. Note that `zones` takes precedence over the negative
  33795. * color. Using `negativeColor` is equivalent to applying a zone with value
  33796. * of 0.
  33797. */
  33798. negativeColor?: (ColorString|GradientColorObject|PatternObject);
  33799. /**
  33800. * (Highstock) Opacity of a series parts: line, fill (e.g. area) and
  33801. * dataLabels.
  33802. */
  33803. opacity?: number;
  33804. /**
  33805. * (Highstock) Paramters used in calculation of regression series' points.
  33806. */
  33807. params?: PlotCmfParamsOptions;
  33808. /**
  33809. * (Highstock) Properties for each single point.
  33810. */
  33811. point?: PlotSeriesPointOptions;
  33812. /**
  33813. * (Highstock) Same as accessibility.pointDescriptionFormatter, but for an
  33814. * individual series. Overrides the chart wide configuration.
  33815. */
  33816. pointDescriptionFormatter?: Function;
  33817. /**
  33818. * (Highstock) Whether to select the series initially. If `showCheckbox` is
  33819. * true, the checkbox next to the series name in the legend will be checked
  33820. * for a selected series.
  33821. */
  33822. selected?: boolean;
  33823. /**
  33824. * (Highstock) Whether to apply a drop shadow to the graph line. Since 2.3
  33825. * the shadow can be an object configuration containing `color`, `offsetX`,
  33826. * `offsetY`, `opacity` and `width`.
  33827. */
  33828. shadow?: (boolean|ShadowOptionsObject);
  33829. /**
  33830. * (Highstock) If true, a checkbox is displayed next to the legend item to
  33831. * allow selecting the series. The state of the checkbox is determined by
  33832. * the `selected` option.
  33833. */
  33834. showCheckbox?: boolean;
  33835. /**
  33836. * (Highstock) Whether to display this particular series or series type in
  33837. * the legend. Standalone series are shown in legend by default, and linked
  33838. * series are not. Since v7.2.0 it is possible to show series that use
  33839. * colorAxis by setting this option to `true`.
  33840. */
  33841. showInLegend?: boolean;
  33842. /**
  33843. * (Highstock) If set to `true`, the accessibility module will skip past the
  33844. * points in this series for keyboard navigation.
  33845. */
  33846. skipKeyboardNavigation?: boolean;
  33847. /**
  33848. * (Highcharts, Highstock) When this is true, the series will not cause the
  33849. * Y axis to cross the zero plane (or threshold option) unless the data
  33850. * actually crosses the plane.
  33851. *
  33852. * For example, if `softThreshold` is `false`, a series of 0, 1, 2, 3 will
  33853. * make the Y axis show negative values according to the `minPadding`
  33854. * option. If `softThreshold` is `true`, the Y axis starts at 0.
  33855. */
  33856. softThreshold?: boolean;
  33857. states?: SeriesStatesOptionsObject;
  33858. /**
  33859. * (Highcharts, Highstock) Whether to apply steps to the line. Possible
  33860. * values are `left`, `center` and `right`.
  33861. */
  33862. step?: OptionsStepValue;
  33863. /**
  33864. * (Highstock) Sticky tracking of mouse events. When true, the `mouseOut`
  33865. * event on a series isn't triggered until the mouse moves over another
  33866. * series, or out of the plot area. When false, the `mouseOut` event on a
  33867. * series is triggered when the mouse leaves the area around the series'
  33868. * graph or markers. This also implies the tooltip when not shared. When
  33869. * `stickyTracking` is false and `tooltip.shared` is false, the tooltip will
  33870. * be hidden when moving the mouse between series. Defaults to true for line
  33871. * and area type series, but to false for columns, pies etc.
  33872. *
  33873. * **Note:** The boost module will force this option because of technical
  33874. * limitations.
  33875. */
  33876. stickyTracking?: boolean;
  33877. /**
  33878. * (Highcharts, Highstock) The threshold, also called zero level or base
  33879. * level. For line type series this is only used in conjunction with
  33880. * negativeColor.
  33881. */
  33882. threshold?: (number|null);
  33883. /**
  33884. * (Highstock) A configuration object for the tooltip rendering of each
  33885. * single series. Properties are inherited from tooltip, but only the
  33886. * following properties can be defined on a series level.
  33887. */
  33888. tooltip?: SeriesTooltipOptionsObject;
  33889. /**
  33890. * (Highcharts, Highstock, Gantt) When a series contains a data array that
  33891. * is longer than this, only one dimensional arrays of numbers, or two
  33892. * dimensional arrays with x and y values are allowed. Also, only the first
  33893. * point is tested, and the rest are assumed to be the same format. This
  33894. * saves expensive data checking and indexing in long series. Set it to `0`
  33895. * disable.
  33896. *
  33897. * Note: In boost mode turbo threshold is forced. Only array of numbers or
  33898. * two dimensional arrays are allowed.
  33899. */
  33900. turboThreshold?: number;
  33901. /**
  33902. * (Highstock) Set the initial visibility of the series.
  33903. */
  33904. visible?: boolean;
  33905. /**
  33906. * (Highmaps) Define the z index of the series.
  33907. */
  33908. zIndex?: number;
  33909. /**
  33910. * (Highcharts, Highstock) Defines the Axis on which the zones are applied.
  33911. */
  33912. zoneAxis?: string;
  33913. /**
  33914. * (Highcharts, Highstock) An array defining zones within a series. Zones
  33915. * can be applied to the X axis, Y axis or Z axis for bubbles, according to
  33916. * the `zoneAxis` option. The zone definitions have to be in ascending order
  33917. * regarding to the value.
  33918. *
  33919. * In styled mode, the color zones are styled with the
  33920. * `.highcharts-zone-{n}` class, or custom classed from the `className`
  33921. * option (view live demo).
  33922. */
  33923. zones?: Array<SeriesZonesOptionsObject>;
  33924. }
  33925. /**
  33926. * (Highstock) Paramters used in calculation of regression series' points.
  33927. */
  33928. export interface PlotCmfParamsOptions {
  33929. /**
  33930. * (Highstock) The point index which indicator calculations will base. For
  33931. * example using OHLC data, index=2 means the indicator will be calculated
  33932. * using Low values.
  33933. */
  33934. index?: number;
  33935. /**
  33936. * (Highstock) The base period for indicator calculations. This is the
  33937. * number of data points which are taken into account for the indicator
  33938. * calculations.
  33939. */
  33940. period?: number;
  33941. /**
  33942. * (Highstock) The id of another series to use its data as volume data for
  33943. * the indiator calculation.
  33944. */
  33945. volumeSeriesID?: string;
  33946. }
  33947. /**
  33948. * (Highcharts, Highstock) Enable or disable the initial animation when a series
  33949. * is displayed. The animation can also be set as a configuration object. Please
  33950. * note that this option only applies to the initial animation of the series
  33951. * itself. For other animations, see chart.animation and the animation parameter
  33952. * under the API methods. The following properties are supported:
  33953. *
  33954. * - `defer`: The animation delay time in milliseconds.
  33955. *
  33956. * - `duration`: The duration of the animation in milliseconds.
  33957. *
  33958. * - `easing`: Can be a string reference to an easing function set on the `Math`
  33959. * object or a function. See the _Custom easing function_ demo below.
  33960. *
  33961. * Due to poor performance, animation is disabled in old IE browsers for several
  33962. * chart types.
  33963. */
  33964. export interface PlotColumnAnimationOptions {
  33965. defer?: number;
  33966. }
  33967. /**
  33968. * (Highcharts, Highstock, Highmaps, Gantt) Enable or disable the initial
  33969. * animation when a series is displayed for the `dataLabels`. The animation can
  33970. * also be set as a configuration object. Please note that this option only
  33971. * applies to the initial animation. For other animations, see chart.animation
  33972. * and the animation parameter under the API methods. The following properties
  33973. * are supported:
  33974. *
  33975. * - `defer`: The animation delay time in milliseconds.
  33976. */
  33977. export interface PlotColumnDataLabelsAnimationOptions {
  33978. /**
  33979. * (Highcharts, Highstock, Highmaps, Gantt) The animation delay time in
  33980. * milliseconds. Set to `0` renders dataLabel immediately. As `undefined`
  33981. * inherits defer time from the series.animation.defer.
  33982. */
  33983. defer?: number;
  33984. }
  33985. /**
  33986. * (Highcharts, Highstock, Highmaps, Gantt) Options for the series data labels,
  33987. * appearing next to each data point.
  33988. *
  33989. * Since v6.2.0, multiple data labels can be applied to each single point by
  33990. * defining them as an array of configs.
  33991. *
  33992. * In styled mode, the data labels can be styled with the
  33993. * `.highcharts-data-label-box` and `.highcharts-data-label` class names (see
  33994. * example).
  33995. */
  33996. export interface PlotColumnDataLabelsOptions {
  33997. /**
  33998. * (Highcharts, Highstock, Highmaps, Gantt) The alignment of the data label
  33999. * compared to the point. If `right`, the right side of the label should be
  34000. * touching the point. For points with an extent, like columns, the
  34001. * alignments also dictates how to align it inside the box, as given with
  34002. * the inside option. Can be one of `left`, `center` or `right`.
  34003. */
  34004. align?: string;
  34005. /**
  34006. * (Highcharts, Highstock, Highmaps, Gantt) Whether to allow data labels to
  34007. * overlap. To make the labels less sensitive for overlapping, the
  34008. * dataLabels.padding can be set to 0.
  34009. */
  34010. allowOverlap?: boolean;
  34011. /**
  34012. * (Highcharts, Highstock, Highmaps, Gantt) Enable or disable the initial
  34013. * animation when a series is displayed for the `dataLabels`. The animation
  34014. * can also be set as a configuration object. Please note that this option
  34015. * only applies to the initial animation. For other animations, see
  34016. * chart.animation and the animation parameter under the API methods. The
  34017. * following properties are supported:
  34018. *
  34019. * - `defer`: The animation delay time in milliseconds.
  34020. */
  34021. animation?: (boolean|PlotColumnDataLabelsAnimationOptions|Partial<AnimationOptionsObject>);
  34022. /**
  34023. * (Highcharts, Highstock, Highmaps, Gantt) The background color or gradient
  34024. * for the data label.
  34025. */
  34026. backgroundColor?: (ColorString|GradientColorObject|PatternObject);
  34027. /**
  34028. * (Highcharts, Highstock, Highmaps, Gantt) The border color for the data
  34029. * label. Defaults to `undefined`.
  34030. */
  34031. borderColor?: (ColorString|GradientColorObject|PatternObject);
  34032. /**
  34033. * (Highcharts, Highstock, Highmaps, Gantt) The border radius in pixels for
  34034. * the data label.
  34035. */
  34036. borderRadius?: number;
  34037. /**
  34038. * (Highcharts, Highstock, Highmaps, Gantt) The border width in pixels for
  34039. * the data label.
  34040. */
  34041. borderWidth?: number;
  34042. /**
  34043. * (Highcharts, Highstock, Highmaps, Gantt) A class name for the data label.
  34044. * Particularly in styled mode, this can be used to give each series' or
  34045. * point's data label unique styling. In addition to this option, a default
  34046. * color class name is added so that we can give the labels a contrast text
  34047. * shadow.
  34048. */
  34049. className?: string;
  34050. /**
  34051. * (Highcharts, Highstock, Highmaps, Gantt) The text color for the data
  34052. * labels. Defaults to `undefined`. For certain series types, like column or
  34053. * map, the data labels can be drawn inside the points. In this case the
  34054. * data label will be drawn with maximum contrast by default. Additionally,
  34055. * it will be given a `text-outline` style with the opposite color, to
  34056. * further increase the contrast. This can be overridden by setting the
  34057. * `text-outline` style to `none` in the `dataLabels.style` option.
  34058. */
  34059. color?: (ColorString|GradientColorObject|PatternObject);
  34060. /**
  34061. * (Highcharts, Highstock, Highmaps, Gantt) Whether to hide data labels that
  34062. * are outside the plot area. By default, the data label is moved inside the
  34063. * plot area according to the overflow option.
  34064. */
  34065. crop?: boolean;
  34066. /**
  34067. * (Highcharts, Highstock, Gantt) Whether to defer displaying the data
  34068. * labels until the initial series animation has finished. Setting to
  34069. * `false` renders the data label immediately. If set to `true` inherits the
  34070. * defer time set in plotOptions.series.animation.
  34071. */
  34072. defer?: boolean;
  34073. /**
  34074. * (Highcharts, Highstock, Highmaps, Gantt) Enable or disable the data
  34075. * labels.
  34076. */
  34077. enabled?: boolean;
  34078. /**
  34079. * (Highcharts, Highstock, Highmaps, Gantt) A declarative filter to control
  34080. * of which data labels to display. The declarative filter is designed for
  34081. * use when callback functions are not available, like when the chart
  34082. * options require a pure JSON structure or for use with graphical editors.
  34083. * For programmatic control, use the `formatter` instead, and return
  34084. * `undefined` to disable a single data label.
  34085. */
  34086. filter?: DataLabelsFilterOptionsObject;
  34087. /**
  34088. * (Highcharts, Highstock, Highmaps, Gantt) A format string for the data
  34089. * label. Available variables are the same as for `formatter`.
  34090. */
  34091. format?: string;
  34092. /**
  34093. * (Highcharts, Highstock, Highmaps, Gantt) Callback JavaScript function to
  34094. * format the data label. Note that if a `format` is defined, the format
  34095. * takes precedence and the formatter is ignored.
  34096. */
  34097. formatter?: DataLabelsFormatterCallbackFunction;
  34098. /**
  34099. * (Highcharts, Highstock, Highmaps, Gantt) For points with an extent, like
  34100. * columns or map areas, whether to align the data label inside the box or
  34101. * to the actual value point. Defaults to `false` in most cases, `true` in
  34102. * stacked columns.
  34103. */
  34104. inside?: boolean;
  34105. /**
  34106. * (Highcharts, Highstock, Highmaps, Gantt) Format for points with the value
  34107. * of null. Works analogously to format. `nullFormat` can be applied only to
  34108. * series which support displaying null points.
  34109. */
  34110. nullFormat?: (boolean|string);
  34111. /**
  34112. * (Highcharts, Highstock, Highmaps, Gantt) Callback JavaScript function
  34113. * that defines formatting for points with the value of null. Works
  34114. * analogously to formatter. `nullPointFormatter` can be applied only to
  34115. * series which support displaying null points.
  34116. */
  34117. nullFormatter?: DataLabelsFormatterCallbackFunction;
  34118. /**
  34119. * (Highcharts, Highstock, Highmaps, Gantt) How to handle data labels that
  34120. * flow outside the plot area. The default is `"justify"`, which aligns them
  34121. * inside the plot area. For columns and bars, this means it will be moved
  34122. * inside the bar. To display data labels outside the plot area, set `crop`
  34123. * to `false` and `overflow` to `"allow"`.
  34124. */
  34125. overflow?: DataLabelsOverflowValue;
  34126. /**
  34127. * (Highcharts, Highstock, Highmaps, Gantt) When either the `borderWidth` or
  34128. * the `backgroundColor` is set, this is the padding within the box.
  34129. */
  34130. padding?: number;
  34131. /**
  34132. * (Highcharts, Highstock, Highmaps, Gantt) Aligns data labels relative to
  34133. * points. If `center` alignment is not possible, it defaults to `right`.
  34134. */
  34135. position?: AlignValue;
  34136. /**
  34137. * (Highcharts, Highstock, Highmaps, Gantt) Text rotation in degrees. Note
  34138. * that due to a more complex structure, backgrounds, borders and padding
  34139. * will be lost on a rotated data label.
  34140. */
  34141. rotation?: number;
  34142. /**
  34143. * (Highcharts, Highstock, Highmaps, Gantt) The shadow of the box. Works
  34144. * best with `borderWidth` or `backgroundColor`. Since 2.3 the shadow can be
  34145. * an object configuration containing `color`, `offsetX`, `offsetY`,
  34146. * `opacity` and `width`.
  34147. */
  34148. shadow?: (boolean|ShadowOptionsObject);
  34149. /**
  34150. * (Highcharts, Highstock, Highmaps, Gantt) The name of a symbol to use for
  34151. * the border around the label. Symbols are predefined functions on the
  34152. * Renderer object.
  34153. */
  34154. shape?: string;
  34155. /**
  34156. * (Highcharts, Highstock, Highmaps, Gantt) Styles for the label. The
  34157. * default `color` setting is `"contrast"`, which is a pseudo color that
  34158. * Highcharts picks up and applies the maximum contrast to the underlying
  34159. * point item, for example the bar in a bar chart.
  34160. *
  34161. * The `textOutline` is a pseudo property that applies an outline of the
  34162. * given width with the given color, which by default is the maximum
  34163. * contrast to the text. So a bright text color will result in a black text
  34164. * outline for maximum readability on a mixed background. In some cases,
  34165. * especially with grayscale text, the text outline doesn't work well, in
  34166. * which cases it can be disabled by setting it to `"none"`. When `useHTML`
  34167. * is true, the `textOutline` will not be picked up. In this, case, the same
  34168. * effect can be acheived through the `text-shadow` CSS property.
  34169. *
  34170. * For some series types, where each point has an extent, like for example
  34171. * tree maps, the data label may overflow the point. There are two
  34172. * strategies for handling overflow. By default, the text will wrap to
  34173. * multiple lines. The other strategy is to set `style.textOverflow` to
  34174. * `ellipsis`, which will keep the text on one line plus it will break
  34175. * inside long words.
  34176. */
  34177. style?: CSSObject;
  34178. /**
  34179. * (Highcharts, Highstock, Highmaps, Gantt) Options for a label text which
  34180. * should follow marker's shape. Border and background are disabled for a
  34181. * label that follows a path.
  34182. *
  34183. * **Note:** Only SVG-based renderer supports this option. Setting `useHTML`
  34184. * to true will disable this option.
  34185. */
  34186. textPath?: DataLabelsTextPathOptionsObject;
  34187. /**
  34188. * (Highcharts, Highstock, Highmaps, Gantt) Whether to use HTML to render
  34189. * the labels.
  34190. */
  34191. useHTML?: boolean;
  34192. /**
  34193. * (Highcharts, Highstock, Highmaps, Gantt) The vertical alignment of a data
  34194. * label. Can be one of `top`, `middle` or `bottom`. The default value
  34195. * depends on the data, for instance in a column chart, the label is above
  34196. * positive values and below negative values.
  34197. */
  34198. verticalAlign?: string;
  34199. /**
  34200. * (Highcharts, Highstock, Highmaps, Gantt) The x position offset of the
  34201. * label relative to the point in pixels.
  34202. */
  34203. x?: number;
  34204. /**
  34205. * (Highcharts, Highstock, Highmaps, Gantt) The y position offset of the
  34206. * label relative to the point in pixels.
  34207. */
  34208. y?: number;
  34209. /**
  34210. * (Highcharts, Highstock, Highmaps, Gantt) The Z index of the data labels.
  34211. * The default Z index puts it above the series. Use a Z index of 2 to
  34212. * display it behind the series.
  34213. */
  34214. z?: number;
  34215. }
  34216. /**
  34217. * (Highcharts, Highstock) Options for the series data sorting.
  34218. */
  34219. export interface PlotColumnDataSortingOptions {
  34220. /**
  34221. * (Highcharts, Highstock) Enable or disable data sorting for the series.
  34222. * Use xAxis.reversed to change the sorting order.
  34223. */
  34224. enabled?: boolean;
  34225. /**
  34226. * (Highcharts, Highstock) Whether to allow matching points by name in an
  34227. * update. If this option is disabled, points will be matched by order.
  34228. */
  34229. matchByName?: boolean;
  34230. /**
  34231. * (Highcharts, Highstock) Determines what data value should be used to sort
  34232. * by.
  34233. */
  34234. sortKey?: string;
  34235. }
  34236. /**
  34237. * (Highcharts, Highstock) Style options for the guide box. The guide box has
  34238. * one state by default, the `default` state.
  34239. */
  34240. export interface PlotColumnDragDropGuideBoxOptions {
  34241. /**
  34242. * (Highcharts, Highstock) Style options for the guide box default state.
  34243. */
  34244. default?: DragDropGuideBoxOptionsObject;
  34245. }
  34246. /**
  34247. * (Highcharts, Highstock) Column series display one column per value along an X
  34248. * axis.
  34249. *
  34250. * In TypeScript the type option must always be set.
  34251. *
  34252. * Configuration options for the series are given in three levels:
  34253. *
  34254. * 1. Options for all series in a chart are defined in the plotOptions.series
  34255. * object.
  34256. *
  34257. * 2. Options for all `column` series are defined in plotOptions.column.
  34258. *
  34259. * 3. Options for one single series are given in the series instance array. (see
  34260. * online documentation for example)
  34261. */
  34262. export interface PlotColumnOptions {
  34263. /**
  34264. * (Highcharts, Highstock) Accessibility options for a series.
  34265. */
  34266. accessibility?: SeriesAccessibilityOptionsObject;
  34267. /**
  34268. * (Highmaps) Whether all areas of the map defined in `mapData` should be
  34269. * rendered. If `true`, areas which don't correspond to a data point, are
  34270. * rendered as `null` points. If `false`, those areas are skipped.
  34271. */
  34272. allAreas?: boolean;
  34273. /**
  34274. * (Highcharts, Highstock) Allow this series' points to be selected by
  34275. * clicking on the graphic (columns, point markers, pie slices, map areas
  34276. * etc).
  34277. *
  34278. * The selected points can be handled by point select and unselect events,
  34279. * or collectively by the getSelectedPoints function.
  34280. *
  34281. * And alternative way of selecting points is through dragging.
  34282. */
  34283. allowPointSelect?: boolean;
  34284. /**
  34285. * (Highcharts, Highstock) Enable or disable the initial animation when a
  34286. * series is displayed. The animation can also be set as a configuration
  34287. * object. Please note that this option only applies to the initial
  34288. * animation of the series itself. For other animations, see chart.animation
  34289. * and the animation parameter under the API methods. The following
  34290. * properties are supported:
  34291. *
  34292. * - `defer`: The animation delay time in milliseconds.
  34293. *
  34294. * - `duration`: The duration of the animation in milliseconds.
  34295. *
  34296. * - `easing`: Can be a string reference to an easing function set on the
  34297. * `Math` object or a function. See the _Custom easing function_ demo below.
  34298. *
  34299. * Due to poor performance, animation is disabled in old IE browsers for
  34300. * several chart types.
  34301. */
  34302. animation?: (boolean|PlotColumnAnimationOptions|Partial<AnimationOptionsObject>);
  34303. /**
  34304. * (Highcharts, Highstock) For some series, there is a limit that shuts down
  34305. * initial animation by default when the total number of points in the chart
  34306. * is too high. For example, for a column chart and its derivatives,
  34307. * animation does not run if there is more than 250 points totally. To
  34308. * disable this cap, set `animationLimit` to `Infinity`.
  34309. */
  34310. animationLimit?: number;
  34311. /**
  34312. * (Highcharts, Highstock) Sets the color blending in the boost module.
  34313. */
  34314. boostBlending?: OptionsBoostBlendingValue;
  34315. /**
  34316. * (Highcharts, Highstock) Set the point threshold for when a series should
  34317. * enter boost mode.
  34318. *
  34319. * Setting it to e.g. 2000 will cause the series to enter boost mode when
  34320. * there are 2000 or more points in the series.
  34321. *
  34322. * To disable boosting on the series, set the `boostThreshold` to 0. Setting
  34323. * it to 1 will force boosting.
  34324. *
  34325. * Note that the cropThreshold also affects this setting. When zooming in on
  34326. * a series that has fewer points than the `cropThreshold`, all points are
  34327. * rendered although outside the visible plot area, and the `boostThreshold`
  34328. * won't take effect.
  34329. */
  34330. boostThreshold?: number;
  34331. /**
  34332. * (Highcharts, Highstock, Gantt) The color of the border surrounding each
  34333. * column or bar.
  34334. *
  34335. * In styled mode, the border stroke can be set with the `.highcharts-point`
  34336. * rule.
  34337. */
  34338. borderColor?: (ColorString|GradientColorObject|PatternObject);
  34339. /**
  34340. * (Highcharts, Highstock, Gantt) The corner radius of the border
  34341. * surrounding each column or bar.
  34342. */
  34343. borderRadius?: number;
  34344. /**
  34345. * (Highcharts, Highstock, Gantt) The width of the border surrounding each
  34346. * column or bar. Defaults to `1` when there is room for a border, but to
  34347. * `0` when the columns are so dense that a border would cover the next
  34348. * column.
  34349. *
  34350. * In styled mode, the stroke width can be set with the `.highcharts-point`
  34351. * rule.
  34352. */
  34353. borderWidth?: number;
  34354. /**
  34355. * (Highcharts, Highstock, Gantt) When `true`, the columns will center in
  34356. * the category, ignoring null or missing points. When `false`, space will
  34357. * be reserved for null or missing points.
  34358. */
  34359. centerInCategory?: boolean;
  34360. /**
  34361. * (Highcharts, Highstock) An additional class name to apply to the series'
  34362. * graphical elements. This option does not replace default class names of
  34363. * the graphical element.
  34364. */
  34365. className?: string;
  34366. /**
  34367. * (Highcharts, Highstock) Disable this option to allow series rendering in
  34368. * the whole plotting area.
  34369. *
  34370. * **Note:** Clipping should be always enabled when chart.zoomType is set
  34371. */
  34372. clip?: boolean;
  34373. /**
  34374. * (Highcharts, Highstock) The main color of the series. In line type series
  34375. * it applies to the line and the point markers unless otherwise specified.
  34376. * In bar type series it applies to the bars unless a color is specified per
  34377. * point. The default value is pulled from the `options.colors` array.
  34378. *
  34379. * In styled mode, the color can be defined by the colorIndex option. Also,
  34380. * the series color can be set with the `.highcharts-series`,
  34381. * `.highcharts-color-{n}`, `.highcharts-{type}-series` or
  34382. * `.highcharts-series-{n}` class, or individual classes given by the
  34383. * `className` option.
  34384. */
  34385. color?: (ColorString|GradientColorObject|PatternObject);
  34386. /**
  34387. * (Highcharts, Highstock, Highmaps) When using dual or multiple color axes,
  34388. * this number defines which colorAxis the particular series is connected
  34389. * to. It refers to either the axis id or the index of the axis in the
  34390. * colorAxis array, with 0 being the first. Set this option to false to
  34391. * prevent a series from connecting to the default color axis.
  34392. *
  34393. * Since v7.2.0 the option can also be an axis id or an axis index instead
  34394. * of a boolean flag.
  34395. */
  34396. colorAxis?: (boolean|number|string);
  34397. /**
  34398. * (Highcharts, Highstock, Gantt) When using automatic point colors pulled
  34399. * from the global colors or series-specific plotOptions.column.colors
  34400. * collections, this option determines whether the chart should receive one
  34401. * color per series or one color per point.
  34402. *
  34403. * In styled mode, the `colors` or `series.colors` arrays are not supported,
  34404. * and instead this option gives the points individual color class names on
  34405. * the form `highcharts-color-{n}`.
  34406. */
  34407. colorByPoint?: boolean;
  34408. /**
  34409. * (Highcharts, Highstock) Styled mode only. A specific color index to use
  34410. * for the series, so its graphic representations are given the class name
  34411. * `highcharts-color-{n}`.
  34412. */
  34413. colorIndex?: number;
  34414. /**
  34415. * (Highcharts, Highstock, Highmaps) Determines what data value should be
  34416. * used to calculate point color if `colorAxis` is used. Requires to set
  34417. * `min` and `max` if some custom point property is used or if approximation
  34418. * for data grouping is set to `'sum'`.
  34419. */
  34420. colorKey?: string;
  34421. /**
  34422. * (Highcharts, Highstock, Gantt) A series specific or series type specific
  34423. * color set to apply instead of the global colors when colorByPoint is
  34424. * true.
  34425. */
  34426. colors?: Array<(ColorString|GradientColorObject|PatternObject)>;
  34427. /**
  34428. * (Highstock) Compare the values of the series against the first non-null,
  34429. * non- zero value in the visible range. The y axis will show percentage or
  34430. * absolute change depending on whether `compare` is set to `"percent"` or
  34431. * `"value"`. When this is applied to multiple series, it allows comparing
  34432. * the development of the series against each other. Adds a `change` field
  34433. * to every point object.
  34434. */
  34435. compare?: string;
  34436. /**
  34437. * (Highstock) When compare is `percent`, this option dictates whether to
  34438. * use 0 or 100 as the base of comparison.
  34439. */
  34440. compareBase?: (0|100);
  34441. /**
  34442. * (Highstock) Defines if comparison should start from the first point
  34443. * within the visible range or should start from the first point **before**
  34444. * the range.
  34445. *
  34446. * In other words, this flag determines if first point within the visible
  34447. * range will have 0% (`compareStart=true`) or should have been already
  34448. * calculated according to the previous point (`compareStart=false`).
  34449. */
  34450. compareStart?: boolean;
  34451. /**
  34452. * (Gantt) Override Pathfinder connector options for a series. Requires
  34453. * Highcharts Gantt to be loaded.
  34454. */
  34455. connectors?: SeriesConnectorsOptionsObject;
  34456. /**
  34457. * (Highcharts, Highstock, Gantt) When true, each point or column edge is
  34458. * rounded to its nearest pixel in order to render sharp on screen. In some
  34459. * cases, when there are a lot of densely packed columns, this leads to
  34460. * visible difference in column widths or distance between columns. In these
  34461. * cases, setting `crisp` to `false` may look better, even though each
  34462. * column is rendered blurry.
  34463. */
  34464. crisp?: boolean;
  34465. /**
  34466. * (Highcharts, Highstock, Gantt) When the series contains less points than
  34467. * the crop threshold, all points are drawn, event if the points fall
  34468. * outside the visible plot area at the current zoom. The advantage of
  34469. * drawing all points (including markers and columns), is that animation is
  34470. * performed on updates. On the other hand, when the series contains more
  34471. * points than the crop threshold, the series data is cropped to only
  34472. * contain points that fall within the plot area. The advantage of cropping
  34473. * away invisible points is to increase performance on large series.
  34474. */
  34475. cropThreshold?: number;
  34476. /**
  34477. * (Highcharts, Highstock) You can set the cursor to "pointer" if you have
  34478. * click events attached to the series, to signal to the user that the
  34479. * points and lines can be clicked.
  34480. *
  34481. * In styled mode, the series cursor can be set with the same classes as
  34482. * listed under series.color.
  34483. */
  34484. cursor?: (string|CursorValue);
  34485. /**
  34486. * (Highcharts, Highstock) A reserved subspace to store options and values
  34487. * for customized functionality. Here you can add additional data for your
  34488. * own event callbacks and formatter callbacks.
  34489. */
  34490. custom?: Dictionary<any>;
  34491. /**
  34492. * (Highcharts, Highstock) Name of the dash style to use for the graph, or
  34493. * for some series types the outline of each shape.
  34494. *
  34495. * In styled mode, the stroke dash-array can be set with the same classes as
  34496. * listed under series.color.
  34497. */
  34498. dashStyle?: DashStyleValue;
  34499. /**
  34500. * (Highstock) Data grouping is the concept of sampling the data values into
  34501. * larger blocks in order to ease readability and increase performance of
  34502. * the JavaScript charts. Highstock by default applies data grouping when
  34503. * the points become closer than a certain pixel value, determined by the
  34504. * `groupPixelWidth` option.
  34505. *
  34506. * If data grouping is applied, the grouping information of grouped points
  34507. * can be read from the Point.dataGroup. If point options other than the
  34508. * data itself are set, for example `name` or `color` or custom properties,
  34509. * the grouping logic doesn't know how to group it. In this case the options
  34510. * of the first point instance are copied over to the group point. This can
  34511. * be altered through a custom `approximation` callback function.
  34512. */
  34513. dataGrouping?: DataGroupingOptionsObject;
  34514. /**
  34515. * (Highcharts, Highstock, Highmaps, Gantt) Options for the series data
  34516. * labels, appearing next to each data point.
  34517. *
  34518. * Since v6.2.0, multiple data labels can be applied to each single point by
  34519. * defining them as an array of configs.
  34520. *
  34521. * In styled mode, the data labels can be styled with the
  34522. * `.highcharts-data-label-box` and `.highcharts-data-label` class names
  34523. * (see example).
  34524. */
  34525. dataLabels?: (PlotColumnDataLabelsOptions|Array<PlotColumnDataLabelsOptions>);
  34526. /**
  34527. * (Highcharts, Highstock) Options for the series data sorting.
  34528. */
  34529. dataSorting?: (DataSortingOptionsObject|PlotColumnDataSortingOptions);
  34530. /**
  34531. * (Highcharts) Depth of the columns in a 3D column chart.
  34532. */
  34533. depth?: number;
  34534. /**
  34535. * (Highcharts, Highstock) A description of the series to add to the screen
  34536. * reader information about the series.
  34537. */
  34538. description?: string;
  34539. /**
  34540. * (Highcharts, Highstock) The draggable-points module allows points to be
  34541. * moved around or modified in the chart. In addition to the options
  34542. * mentioned under the `dragDrop` API structure, the module fires three
  34543. * events, point.dragStart, point.drag and point.drop.
  34544. */
  34545. dragDrop?: SeriesDragDropOptionsObject;
  34546. /**
  34547. * (Highcharts) 3D columns only. The color of the edges. Similar to
  34548. * `borderColor`, except it defaults to the same color as the column.
  34549. */
  34550. edgeColor?: ColorString;
  34551. /**
  34552. * (Highcharts) 3D columns only. The width of the colored edges.
  34553. */
  34554. edgeWidth?: number;
  34555. /**
  34556. * (Highcharts, Highstock) Enable or disable the mouse tracking for a
  34557. * specific series. This includes point tooltips and click events on graphs
  34558. * and points. For large datasets it improves performance.
  34559. */
  34560. enableMouseTracking?: boolean;
  34561. /**
  34562. * (Highcharts, Highstock) General event handlers for the series items.
  34563. * These event hooks can also be attached to the series at run time using
  34564. * the `Highcharts.addEvent` function.
  34565. */
  34566. events?: SeriesEventsOptionsObject;
  34567. /**
  34568. * (Highcharts, Highstock) Determines whether the series should look for the
  34569. * nearest point in both dimensions or just the x-dimension when hovering
  34570. * the series. Defaults to `'xy'` for scatter series and `'x'` for most
  34571. * other series. If the data has duplicate x-values, it is recommended to
  34572. * set this to `'xy'` to allow hovering over all points.
  34573. *
  34574. * Applies only to series types using nearest neighbor search (not direct
  34575. * hover) for tooltip.
  34576. */
  34577. findNearestPointBy?: OptionsFindNearestPointByValue;
  34578. /**
  34579. * (Highcharts, Highstock, Gantt) Whether to use the Y extremes of the total
  34580. * chart width or only the zoomed area when zooming in on parts of the X
  34581. * axis. By default, the Y axis adjusts to the min and max of the visible
  34582. * data. Cartesian series only.
  34583. */
  34584. getExtremesFromAll?: boolean;
  34585. /**
  34586. * (Highcharts, Highstock, Gantt) Whether to group non-stacked columns or to
  34587. * let them render independent of each other. Non-grouped columns will be
  34588. * laid out individually and overlap each other.
  34589. */
  34590. grouping?: boolean;
  34591. /**
  34592. * (Highcharts, Highstock, Gantt) Padding between each value groups, in x
  34593. * axis units.
  34594. */
  34595. groupPadding?: number;
  34596. /**
  34597. * (Highcharts) The spacing between columns on the Z Axis in a 3D chart.
  34598. */
  34599. groupZPadding?: number;
  34600. /**
  34601. * (Highcharts, Highstock) When set to `false` will prevent the series data
  34602. * from being included in any form of data export.
  34603. *
  34604. * Since version 6.0.0 until 7.1.0 the option was existing undocumented as
  34605. * `includeInCSVExport`.
  34606. */
  34607. includeInDataExport?: boolean;
  34608. /**
  34609. * (Highmaps) What property to join the `mapData` to the value data. For
  34610. * example, if joinBy is "code", the mapData items with a specific code is
  34611. * merged into the data with the same code. For maps loaded from GeoJSON,
  34612. * the keys may be held in each point's `properties` object.
  34613. *
  34614. * The joinBy option can also be an array of two values, where the first
  34615. * points to a key in the `mapData`, and the second points to another key in
  34616. * the `data`.
  34617. *
  34618. * When joinBy is `null`, the map items are joined by their position in the
  34619. * array, which performs much better in maps with many data points. This is
  34620. * the recommended option if you are printing more than a thousand data
  34621. * points and have a backend that can preprocess the data into a parallel
  34622. * array of the mapData.
  34623. */
  34624. joinBy?: (string|Array<string>);
  34625. /**
  34626. * (Highcharts, Highstock) An array specifying which option maps to which
  34627. * key in the data point array. This makes it convenient to work with
  34628. * unstructured data arrays from different sources.
  34629. */
  34630. keys?: Array<string>;
  34631. /**
  34632. * (Highcharts, Highstock, Gantt) Series labels are placed as close to the
  34633. * series as possible in a natural way, seeking to avoid other series. The
  34634. * goal of this feature is to make the chart more easily readable, like if a
  34635. * human designer placed the labels in the optimal position.
  34636. *
  34637. * The series labels currently work with series types having a `graph` or an
  34638. * `area`.
  34639. */
  34640. label?: SeriesLabelOptionsObject;
  34641. /**
  34642. * (Highstock) The line marks the last price from all points.
  34643. */
  34644. lastPrice?: SeriesLastPriceOptionsObject;
  34645. /**
  34646. * (Highstock) The line marks the last price from visible range of points.
  34647. */
  34648. lastVisiblePrice?: SeriesLastVisiblePriceOptionsObject;
  34649. /**
  34650. * (Highcharts, Highstock, Gantt) The id of another series to link to.
  34651. * Additionally, the value can be ":previous" to link to the previous
  34652. * series. When two series are linked, only the first one appears in the
  34653. * legend. Toggling the visibility of this also toggles the linked series.
  34654. *
  34655. * If master series uses data sorting and linked series does not have its
  34656. * own sorting definition, the linked series will be sorted in the same
  34657. * order as the master one.
  34658. */
  34659. linkedTo?: string;
  34660. /**
  34661. * (Highcharts, Highstock, Gantt) The maximum allowed pixel width for a
  34662. * column, translated to the height of a bar in a bar chart. This prevents
  34663. * the columns from becoming too wide when there is a small number of points
  34664. * in the chart.
  34665. */
  34666. maxPointWidth?: number;
  34667. /**
  34668. * (Highcharts, Highstock, Gantt) The minimal height for a column or width
  34669. * for a bar. By default, 0 values are not shown. To visualize a 0 (or close
  34670. * to zero) point, set the minimal point length to a pixel value like 3\. In
  34671. * stacked column charts, minPointLength might not be respected for tightly
  34672. * packed values.
  34673. */
  34674. minPointLength?: number;
  34675. /**
  34676. * (Highstock) Options for the corresponding navigator series if
  34677. * `showInNavigator` is `true` for this series. Available options are the
  34678. * same as any series, documented at plotOptions and series.
  34679. *
  34680. * These options are merged with options in navigator.series, and will take
  34681. * precedence if the same option is defined both places.
  34682. */
  34683. navigatorOptions?: PlotSeriesOptions;
  34684. /**
  34685. * (Highcharts, Highstock) The color for the parts of the graph or points
  34686. * that are below the threshold. Note that `zones` takes precedence over the
  34687. * negative color. Using `negativeColor` is equivalent to applying a zone
  34688. * with value of 0.
  34689. */
  34690. negativeColor?: (ColorString|GradientColorObject|PatternObject);
  34691. /**
  34692. * (Highcharts, Highstock) Opacity of a series parts: line, fill (e.g. area)
  34693. * and dataLabels.
  34694. */
  34695. opacity?: number;
  34696. /**
  34697. * (Highcharts, Highstock) Properties for each single point.
  34698. */
  34699. point?: PlotSeriesPointOptions;
  34700. /**
  34701. * (Highcharts, Highstock) Same as accessibility.pointDescriptionFormatter,
  34702. * but for an individual series. Overrides the chart wide configuration.
  34703. */
  34704. pointDescriptionFormatter?: Function;
  34705. /**
  34706. * (Highcharts, Highstock, Gantt) If no x values are given for the points in
  34707. * a series, `pointInterval` defines the interval of the x values. For
  34708. * example, if a series contains one value every decade starting from year
  34709. * 0, set `pointInterval` to `10`. In true `datetime` axes, the
  34710. * `pointInterval` is set in milliseconds.
  34711. *
  34712. * It can be also be combined with `pointIntervalUnit` to draw irregular
  34713. * time intervals.
  34714. *
  34715. * Please note that this options applies to the _series data_, not the
  34716. * interval of the axis ticks, which is independent.
  34717. */
  34718. pointInterval?: number;
  34719. /**
  34720. * (Highcharts, Highstock, Gantt) On datetime series, this allows for
  34721. * setting the pointInterval to irregular time units, `day`, `month` and
  34722. * `year`. A day is usually the same as 24 hours, but `pointIntervalUnit`
  34723. * also takes the DST crossover into consideration when dealing with local
  34724. * time. Combine this option with `pointInterval` to draw weeks, quarters, 6
  34725. * months, 10 years etc.
  34726. *
  34727. * Please note that this options applies to the _series data_, not the
  34728. * interval of the axis ticks, which is independent.
  34729. */
  34730. pointIntervalUnit?: OptionsPointIntervalUnitValue;
  34731. /**
  34732. * (Highcharts, Highstock, Gantt) Padding between each column or bar, in x
  34733. * axis units.
  34734. */
  34735. pointPadding?: number;
  34736. /**
  34737. * (Highcharts, Highstock, Gantt) Possible values: `"on"`, `"between"`,
  34738. * `number`.
  34739. *
  34740. * In a column chart, when pointPlacement is `"on"`, the point will not
  34741. * create any padding of the X axis. In a polar column chart this means that
  34742. * the first column points directly north. If the pointPlacement is
  34743. * `"between"`, the columns will be laid out between ticks. This is useful
  34744. * for example for visualising an amount between two points in time or in a
  34745. * certain sector of a polar chart.
  34746. *
  34747. * Since Highcharts 3.0.2, the point placement can also be numeric, where 0
  34748. * is on the axis value, -0.5 is between this value and the previous, and
  34749. * 0.5 is between this value and the next. Unlike the textual options,
  34750. * numeric point placement options won't affect axis padding.
  34751. *
  34752. * Note that pointPlacement needs a pointRange to work. For column series
  34753. * this is computed, but for line-type series it needs to be set.
  34754. *
  34755. * For the `xrange` series type and gantt charts, if the Y axis is a
  34756. * category axis, the `pointPlacement` applies to the Y axis rather than the
  34757. * (typically datetime) X axis.
  34758. *
  34759. * Defaults to `undefined` in cartesian charts, `"between"` in polar charts.
  34760. */
  34761. pointPlacement?: (number|string);
  34762. /**
  34763. * (Highcharts, Highstock, Gantt) The X axis range that each point is valid
  34764. * for. This determines the width of the column. On a categorized axis, the
  34765. * range will be 1 by default (one category unit). On linear and datetime
  34766. * axes, the range will be computed as the distance between the two closest
  34767. * data points.
  34768. *
  34769. * The default `null` means it is computed automatically, but this option
  34770. * can be used to override the automatic value.
  34771. *
  34772. * This option is set by default to 1 if data sorting is enabled.
  34773. */
  34774. pointRange?: (number|null);
  34775. /**
  34776. * (Highcharts, Highstock, Gantt) If no x values are given for the points in
  34777. * a series, pointStart defines on what value to start. For example, if a
  34778. * series contains one yearly value starting from 1945, set pointStart to
  34779. * 1945.
  34780. */
  34781. pointStart?: number;
  34782. /**
  34783. * (Highcharts, Highstock, Gantt) A pixel value specifying a fixed width for
  34784. * each column or bar point. When set to `undefined`, the width is
  34785. * calculated from the `pointPadding` and `groupPadding`. The width effects
  34786. * the dimension that is not based on the point value. For column series it
  34787. * is the hoizontal length and for bar series it is the vertical length.
  34788. */
  34789. pointWidth?: number;
  34790. /**
  34791. * (Highcharts, Highstock) Whether to select the series initially. If
  34792. * `showCheckbox` is true, the checkbox next to the series name in the
  34793. * legend will be checked for a selected series.
  34794. */
  34795. selected?: boolean;
  34796. /**
  34797. * (Highcharts, Highstock) Whether to apply a drop shadow to the graph line.
  34798. * Since 2.3 the shadow can be an object configuration containing `color`,
  34799. * `offsetX`, `offsetY`, `opacity` and `width`.
  34800. */
  34801. shadow?: (boolean|ShadowOptionsObject);
  34802. /**
  34803. * (Highcharts, Highstock) If true, a checkbox is displayed next to the
  34804. * legend item to allow selecting the series. The state of the checkbox is
  34805. * determined by the `selected` option.
  34806. */
  34807. showCheckbox?: boolean;
  34808. /**
  34809. * (Highcharts, Highstock) Whether to display this particular series or
  34810. * series type in the legend. Standalone series are shown in legend by
  34811. * default, and linked series are not. Since v7.2.0 it is possible to show
  34812. * series that use colorAxis by setting this option to `true`.
  34813. */
  34814. showInLegend?: boolean;
  34815. /**
  34816. * (Highstock) Whether or not to show the series in the navigator. Takes
  34817. * precedence over navigator.baseSeries if defined.
  34818. */
  34819. showInNavigator?: boolean;
  34820. /**
  34821. * (Highcharts, Highstock) If set to `true`, the accessibility module will
  34822. * skip past the points in this series for keyboard navigation.
  34823. */
  34824. skipKeyboardNavigation?: boolean;
  34825. /**
  34826. * (Highcharts, Highstock) When this is true, the series will not cause the
  34827. * Y axis to cross the zero plane (or threshold option) unless the data
  34828. * actually crosses the plane.
  34829. *
  34830. * For example, if `softThreshold` is `false`, a series of 0, 1, 2, 3 will
  34831. * make the Y axis show negative values according to the `minPadding`
  34832. * option. If `softThreshold` is `true`, the Y axis starts at 0.
  34833. */
  34834. softThreshold?: boolean;
  34835. /**
  34836. * (Highcharts, Highstock) Whether to stack the values of each series on top
  34837. * of each other. Possible values are `undefined` to disable, `"normal"` to
  34838. * stack by value or `"percent"`.
  34839. *
  34840. * When stacking is enabled, data must be sorted in ascending X order.
  34841. *
  34842. * Some stacking options are related to specific series types. In the
  34843. * streamgraph series type, the stacking option is set to `"stream"`. The
  34844. * second one is `"overlap"`, which only applies to waterfall series.
  34845. */
  34846. stacking?: OptionsStackingValue;
  34847. states?: SeriesStatesOptionsObject;
  34848. /**
  34849. * (Highcharts, Highstock) Sticky tracking of mouse events. When true, the
  34850. * `mouseOut` event on a series isn't triggered until the mouse moves over
  34851. * another series, or out of the plot area. When false, the `mouseOut` event
  34852. * on a series is triggered when the mouse leaves the area around the
  34853. * series' graph or markers. This also implies the tooltip when not shared.
  34854. * When `stickyTracking` is false and `tooltip.shared` is false, the tooltip
  34855. * will be hidden when moving the mouse between series. Defaults to true for
  34856. * line and area type series, but to false for columns, pies etc.
  34857. *
  34858. * **Note:** The boost module will force this option because of technical
  34859. * limitations.
  34860. */
  34861. stickyTracking?: boolean;
  34862. /**
  34863. * (Highcharts) The Y axis value to serve as the base for the columns, for
  34864. * distinguishing between values above and below a threshold. If `null`, the
  34865. * columns extend from the padding Y axis minimum.
  34866. */
  34867. threshold?: (number|null);
  34868. /**
  34869. * (Highcharts, Highstock) A configuration object for the tooltip rendering
  34870. * of each single series. Properties are inherited from tooltip, but only
  34871. * the following properties can be defined on a series level.
  34872. */
  34873. tooltip?: SeriesTooltipOptionsObject;
  34874. /**
  34875. * (Highcharts, Highstock, Gantt) When a series contains a data array that
  34876. * is longer than this, only one dimensional arrays of numbers, or two
  34877. * dimensional arrays with x and y values are allowed. Also, only the first
  34878. * point is tested, and the rest are assumed to be the same format. This
  34879. * saves expensive data checking and indexing in long series. Set it to `0`
  34880. * disable.
  34881. *
  34882. * Note: In boost mode turbo threshold is forced. Only array of numbers or
  34883. * two dimensional arrays are allowed.
  34884. */
  34885. turboThreshold?: number;
  34886. /**
  34887. * (Highcharts, Highstock) Set the initial visibility of the series.
  34888. */
  34889. visible?: boolean;
  34890. /**
  34891. * (Highmaps) Define the z index of the series.
  34892. */
  34893. zIndex?: number;
  34894. /**
  34895. * (Highcharts, Highstock) Defines the Axis on which the zones are applied.
  34896. */
  34897. zoneAxis?: string;
  34898. /**
  34899. * (Highcharts, Highstock) An array defining zones within a series. Zones
  34900. * can be applied to the X axis, Y axis or Z axis for bubbles, according to
  34901. * the `zoneAxis` option. The zone definitions have to be in ascending order
  34902. * regarding to the value.
  34903. *
  34904. * In styled mode, the color zones are styled with the
  34905. * `.highcharts-zone-{n}` class, or custom classed from the `className`
  34906. * option (view live demo).
  34907. */
  34908. zones?: Array<SeriesZonesOptionsObject>;
  34909. }
  34910. /**
  34911. * (Highcharts, Highstock) Enable or disable the initial animation when a series
  34912. * is displayed. The animation can also be set as a configuration object. Please
  34913. * note that this option only applies to the initial animation of the series
  34914. * itself. For other animations, see chart.animation and the animation parameter
  34915. * under the API methods. The following properties are supported:
  34916. *
  34917. * - `defer`: The animation delay time in milliseconds.
  34918. *
  34919. * - `duration`: The duration of the animation in milliseconds.
  34920. *
  34921. * - `easing`: Can be a string reference to an easing function set on the `Math`
  34922. * object or a function. See the _Custom easing function_ demo below.
  34923. *
  34924. * Due to poor performance, animation is disabled in old IE browsers for several
  34925. * chart types.
  34926. */
  34927. export interface PlotColumnpyramidAnimationOptions {
  34928. defer?: number;
  34929. }
  34930. /**
  34931. * (Highcharts, Highstock, Highmaps, Gantt) Enable or disable the initial
  34932. * animation when a series is displayed for the `dataLabels`. The animation can
  34933. * also be set as a configuration object. Please note that this option only
  34934. * applies to the initial animation. For other animations, see chart.animation
  34935. * and the animation parameter under the API methods. The following properties
  34936. * are supported:
  34937. *
  34938. * - `defer`: The animation delay time in milliseconds.
  34939. */
  34940. export interface PlotColumnpyramidDataLabelsAnimationOptions {
  34941. /**
  34942. * (Highcharts, Highstock, Highmaps, Gantt) The animation delay time in
  34943. * milliseconds. Set to `0` renders dataLabel immediately. As `undefined`
  34944. * inherits defer time from the series.animation.defer.
  34945. */
  34946. defer?: number;
  34947. }
  34948. /**
  34949. * (Highcharts, Highstock, Highmaps, Gantt) Options for the series data labels,
  34950. * appearing next to each data point.
  34951. *
  34952. * Since v6.2.0, multiple data labels can be applied to each single point by
  34953. * defining them as an array of configs.
  34954. *
  34955. * In styled mode, the data labels can be styled with the
  34956. * `.highcharts-data-label-box` and `.highcharts-data-label` class names (see
  34957. * example).
  34958. */
  34959. export interface PlotColumnpyramidDataLabelsOptions {
  34960. /**
  34961. * (Highcharts, Highstock, Highmaps, Gantt) The alignment of the data label
  34962. * compared to the point. If `right`, the right side of the label should be
  34963. * touching the point. For points with an extent, like columns, the
  34964. * alignments also dictates how to align it inside the box, as given with
  34965. * the inside option. Can be one of `left`, `center` or `right`.
  34966. */
  34967. align?: string;
  34968. /**
  34969. * (Highcharts, Highstock, Highmaps, Gantt) Whether to allow data labels to
  34970. * overlap. To make the labels less sensitive for overlapping, the
  34971. * dataLabels.padding can be set to 0.
  34972. */
  34973. allowOverlap?: boolean;
  34974. /**
  34975. * (Highcharts, Highstock, Highmaps, Gantt) Enable or disable the initial
  34976. * animation when a series is displayed for the `dataLabels`. The animation
  34977. * can also be set as a configuration object. Please note that this option
  34978. * only applies to the initial animation. For other animations, see
  34979. * chart.animation and the animation parameter under the API methods. The
  34980. * following properties are supported:
  34981. *
  34982. * - `defer`: The animation delay time in milliseconds.
  34983. */
  34984. animation?: (boolean|PlotColumnpyramidDataLabelsAnimationOptions|Partial<AnimationOptionsObject>);
  34985. /**
  34986. * (Highcharts, Highstock, Highmaps, Gantt) The background color or gradient
  34987. * for the data label.
  34988. */
  34989. backgroundColor?: (ColorString|GradientColorObject|PatternObject);
  34990. /**
  34991. * (Highcharts, Highstock, Highmaps, Gantt) The border color for the data
  34992. * label. Defaults to `undefined`.
  34993. */
  34994. borderColor?: (ColorString|GradientColorObject|PatternObject);
  34995. /**
  34996. * (Highcharts, Highstock, Highmaps, Gantt) The border radius in pixels for
  34997. * the data label.
  34998. */
  34999. borderRadius?: number;
  35000. /**
  35001. * (Highcharts, Highstock, Highmaps, Gantt) The border width in pixels for
  35002. * the data label.
  35003. */
  35004. borderWidth?: number;
  35005. /**
  35006. * (Highcharts, Highstock, Highmaps, Gantt) A class name for the data label.
  35007. * Particularly in styled mode, this can be used to give each series' or
  35008. * point's data label unique styling. In addition to this option, a default
  35009. * color class name is added so that we can give the labels a contrast text
  35010. * shadow.
  35011. */
  35012. className?: string;
  35013. /**
  35014. * (Highcharts, Highstock, Highmaps, Gantt) The text color for the data
  35015. * labels. Defaults to `undefined`. For certain series types, like column or
  35016. * map, the data labels can be drawn inside the points. In this case the
  35017. * data label will be drawn with maximum contrast by default. Additionally,
  35018. * it will be given a `text-outline` style with the opposite color, to
  35019. * further increase the contrast. This can be overridden by setting the
  35020. * `text-outline` style to `none` in the `dataLabels.style` option.
  35021. */
  35022. color?: (ColorString|GradientColorObject|PatternObject);
  35023. /**
  35024. * (Highcharts, Highstock, Highmaps, Gantt) Whether to hide data labels that
  35025. * are outside the plot area. By default, the data label is moved inside the
  35026. * plot area according to the overflow option.
  35027. */
  35028. crop?: boolean;
  35029. /**
  35030. * (Highcharts, Highstock, Gantt) Whether to defer displaying the data
  35031. * labels until the initial series animation has finished. Setting to
  35032. * `false` renders the data label immediately. If set to `true` inherits the
  35033. * defer time set in plotOptions.series.animation.
  35034. */
  35035. defer?: boolean;
  35036. /**
  35037. * (Highcharts, Highstock, Highmaps, Gantt) Enable or disable the data
  35038. * labels.
  35039. */
  35040. enabled?: boolean;
  35041. /**
  35042. * (Highcharts, Highstock, Highmaps, Gantt) A declarative filter to control
  35043. * of which data labels to display. The declarative filter is designed for
  35044. * use when callback functions are not available, like when the chart
  35045. * options require a pure JSON structure or for use with graphical editors.
  35046. * For programmatic control, use the `formatter` instead, and return
  35047. * `undefined` to disable a single data label.
  35048. */
  35049. filter?: DataLabelsFilterOptionsObject;
  35050. /**
  35051. * (Highcharts, Highstock, Highmaps, Gantt) A format string for the data
  35052. * label. Available variables are the same as for `formatter`.
  35053. */
  35054. format?: string;
  35055. /**
  35056. * (Highcharts, Highstock, Highmaps, Gantt) Callback JavaScript function to
  35057. * format the data label. Note that if a `format` is defined, the format
  35058. * takes precedence and the formatter is ignored.
  35059. */
  35060. formatter?: DataLabelsFormatterCallbackFunction;
  35061. /**
  35062. * (Highcharts, Highstock, Highmaps, Gantt) For points with an extent, like
  35063. * columns or map areas, whether to align the data label inside the box or
  35064. * to the actual value point. Defaults to `false` in most cases, `true` in
  35065. * stacked columns.
  35066. */
  35067. inside?: boolean;
  35068. /**
  35069. * (Highcharts, Highstock, Highmaps, Gantt) Format for points with the value
  35070. * of null. Works analogously to format. `nullFormat` can be applied only to
  35071. * series which support displaying null points.
  35072. */
  35073. nullFormat?: (boolean|string);
  35074. /**
  35075. * (Highcharts, Highstock, Highmaps, Gantt) Callback JavaScript function
  35076. * that defines formatting for points with the value of null. Works
  35077. * analogously to formatter. `nullPointFormatter` can be applied only to
  35078. * series which support displaying null points.
  35079. */
  35080. nullFormatter?: DataLabelsFormatterCallbackFunction;
  35081. /**
  35082. * (Highcharts, Highstock, Highmaps, Gantt) How to handle data labels that
  35083. * flow outside the plot area. The default is `"justify"`, which aligns them
  35084. * inside the plot area. For columns and bars, this means it will be moved
  35085. * inside the bar. To display data labels outside the plot area, set `crop`
  35086. * to `false` and `overflow` to `"allow"`.
  35087. */
  35088. overflow?: DataLabelsOverflowValue;
  35089. /**
  35090. * (Highcharts, Highstock, Highmaps, Gantt) When either the `borderWidth` or
  35091. * the `backgroundColor` is set, this is the padding within the box.
  35092. */
  35093. padding?: number;
  35094. /**
  35095. * (Highcharts, Highstock, Highmaps, Gantt) Aligns data labels relative to
  35096. * points. If `center` alignment is not possible, it defaults to `right`.
  35097. */
  35098. position?: AlignValue;
  35099. /**
  35100. * (Highcharts, Highstock, Highmaps, Gantt) Text rotation in degrees. Note
  35101. * that due to a more complex structure, backgrounds, borders and padding
  35102. * will be lost on a rotated data label.
  35103. */
  35104. rotation?: number;
  35105. /**
  35106. * (Highcharts, Highstock, Highmaps, Gantt) The shadow of the box. Works
  35107. * best with `borderWidth` or `backgroundColor`. Since 2.3 the shadow can be
  35108. * an object configuration containing `color`, `offsetX`, `offsetY`,
  35109. * `opacity` and `width`.
  35110. */
  35111. shadow?: (boolean|ShadowOptionsObject);
  35112. /**
  35113. * (Highcharts, Highstock, Highmaps, Gantt) The name of a symbol to use for
  35114. * the border around the label. Symbols are predefined functions on the
  35115. * Renderer object.
  35116. */
  35117. shape?: string;
  35118. /**
  35119. * (Highcharts, Highstock, Highmaps, Gantt) Styles for the label. The
  35120. * default `color` setting is `"contrast"`, which is a pseudo color that
  35121. * Highcharts picks up and applies the maximum contrast to the underlying
  35122. * point item, for example the bar in a bar chart.
  35123. *
  35124. * The `textOutline` is a pseudo property that applies an outline of the
  35125. * given width with the given color, which by default is the maximum
  35126. * contrast to the text. So a bright text color will result in a black text
  35127. * outline for maximum readability on a mixed background. In some cases,
  35128. * especially with grayscale text, the text outline doesn't work well, in
  35129. * which cases it can be disabled by setting it to `"none"`. When `useHTML`
  35130. * is true, the `textOutline` will not be picked up. In this, case, the same
  35131. * effect can be acheived through the `text-shadow` CSS property.
  35132. *
  35133. * For some series types, where each point has an extent, like for example
  35134. * tree maps, the data label may overflow the point. There are two
  35135. * strategies for handling overflow. By default, the text will wrap to
  35136. * multiple lines. The other strategy is to set `style.textOverflow` to
  35137. * `ellipsis`, which will keep the text on one line plus it will break
  35138. * inside long words.
  35139. */
  35140. style?: CSSObject;
  35141. /**
  35142. * (Highcharts, Highstock, Highmaps, Gantt) Options for a label text which
  35143. * should follow marker's shape. Border and background are disabled for a
  35144. * label that follows a path.
  35145. *
  35146. * **Note:** Only SVG-based renderer supports this option. Setting `useHTML`
  35147. * to true will disable this option.
  35148. */
  35149. textPath?: DataLabelsTextPathOptionsObject;
  35150. /**
  35151. * (Highcharts, Highstock, Highmaps, Gantt) Whether to use HTML to render
  35152. * the labels.
  35153. */
  35154. useHTML?: boolean;
  35155. /**
  35156. * (Highcharts, Highstock, Highmaps, Gantt) The vertical alignment of a data
  35157. * label. Can be one of `top`, `middle` or `bottom`. The default value
  35158. * depends on the data, for instance in a column chart, the label is above
  35159. * positive values and below negative values.
  35160. */
  35161. verticalAlign?: string;
  35162. /**
  35163. * (Highcharts, Highstock, Highmaps, Gantt) The x position offset of the
  35164. * label relative to the point in pixels.
  35165. */
  35166. x?: number;
  35167. /**
  35168. * (Highcharts, Highstock, Highmaps, Gantt) The y position offset of the
  35169. * label relative to the point in pixels.
  35170. */
  35171. y?: number;
  35172. /**
  35173. * (Highcharts, Highstock, Highmaps, Gantt) The Z index of the data labels.
  35174. * The default Z index puts it above the series. Use a Z index of 2 to
  35175. * display it behind the series.
  35176. */
  35177. z?: number;
  35178. }
  35179. /**
  35180. * (Highcharts, Highstock) Options for the series data sorting.
  35181. */
  35182. export interface PlotColumnpyramidDataSortingOptions {
  35183. /**
  35184. * (Highcharts, Highstock) Enable or disable data sorting for the series.
  35185. * Use xAxis.reversed to change the sorting order.
  35186. */
  35187. enabled?: boolean;
  35188. /**
  35189. * (Highcharts, Highstock) Whether to allow matching points by name in an
  35190. * update. If this option is disabled, points will be matched by order.
  35191. */
  35192. matchByName?: boolean;
  35193. /**
  35194. * (Highcharts, Highstock) Determines what data value should be used to sort
  35195. * by.
  35196. */
  35197. sortKey?: string;
  35198. }
  35199. /**
  35200. * (Highcharts, Highstock) Style options for the guide box. The guide box has
  35201. * one state by default, the `default` state.
  35202. */
  35203. export interface PlotColumnpyramidDragDropGuideBoxOptions {
  35204. /**
  35205. * (Highcharts, Highstock) Style options for the guide box default state.
  35206. */
  35207. default?: DragDropGuideBoxOptionsObject;
  35208. }
  35209. /**
  35210. * (Highcharts, Highstock) Column pyramid series display one pyramid per value
  35211. * along an X axis. To display horizontal pyramids, set chart.inverted to
  35212. * `true`.
  35213. *
  35214. * In TypeScript the type option must always be set.
  35215. *
  35216. * Configuration options for the series are given in three levels:
  35217. *
  35218. * 1. Options for all series in a chart are defined in the plotOptions.series
  35219. * object.
  35220. *
  35221. * 2. Options for all `columnpyramid` series are defined in
  35222. * plotOptions.columnpyramid.
  35223. *
  35224. * 3. Options for one single series are given in the series instance array. (see
  35225. * online documentation for example)
  35226. */
  35227. export interface PlotColumnpyramidOptions {
  35228. /**
  35229. * (Highcharts, Highstock) Accessibility options for a series.
  35230. */
  35231. accessibility?: SeriesAccessibilityOptionsObject;
  35232. /**
  35233. * (Highmaps) Whether all areas of the map defined in `mapData` should be
  35234. * rendered. If `true`, areas which don't correspond to a data point, are
  35235. * rendered as `null` points. If `false`, those areas are skipped.
  35236. */
  35237. allAreas?: boolean;
  35238. /**
  35239. * (Highcharts, Highstock) Allow this series' points to be selected by
  35240. * clicking on the graphic (columns, point markers, pie slices, map areas
  35241. * etc).
  35242. *
  35243. * The selected points can be handled by point select and unselect events,
  35244. * or collectively by the getSelectedPoints function.
  35245. *
  35246. * And alternative way of selecting points is through dragging.
  35247. */
  35248. allowPointSelect?: boolean;
  35249. /**
  35250. * (Highcharts, Highstock) Enable or disable the initial animation when a
  35251. * series is displayed. The animation can also be set as a configuration
  35252. * object. Please note that this option only applies to the initial
  35253. * animation of the series itself. For other animations, see chart.animation
  35254. * and the animation parameter under the API methods. The following
  35255. * properties are supported:
  35256. *
  35257. * - `defer`: The animation delay time in milliseconds.
  35258. *
  35259. * - `duration`: The duration of the animation in milliseconds.
  35260. *
  35261. * - `easing`: Can be a string reference to an easing function set on the
  35262. * `Math` object or a function. See the _Custom easing function_ demo below.
  35263. *
  35264. * Due to poor performance, animation is disabled in old IE browsers for
  35265. * several chart types.
  35266. */
  35267. animation?: (boolean|PlotColumnpyramidAnimationOptions|Partial<AnimationOptionsObject>);
  35268. /**
  35269. * (Highcharts, Highstock) For some series, there is a limit that shuts down
  35270. * initial animation by default when the total number of points in the chart
  35271. * is too high. For example, for a column chart and its derivatives,
  35272. * animation does not run if there is more than 250 points totally. To
  35273. * disable this cap, set `animationLimit` to `Infinity`.
  35274. */
  35275. animationLimit?: number;
  35276. /**
  35277. * (Highcharts, Highstock, Gantt) The color of the border surrounding each
  35278. * column or bar.
  35279. *
  35280. * In styled mode, the border stroke can be set with the `.highcharts-point`
  35281. * rule.
  35282. */
  35283. borderColor?: (ColorString|GradientColorObject|PatternObject);
  35284. /**
  35285. * (Highcharts, Highstock, Gantt) The width of the border surrounding each
  35286. * column or bar. Defaults to `1` when there is room for a border, but to
  35287. * `0` when the columns are so dense that a border would cover the next
  35288. * column.
  35289. *
  35290. * In styled mode, the stroke width can be set with the `.highcharts-point`
  35291. * rule.
  35292. */
  35293. borderWidth?: number;
  35294. /**
  35295. * (Highcharts, Highstock, Gantt) When `true`, the columns will center in
  35296. * the category, ignoring null or missing points. When `false`, space will
  35297. * be reserved for null or missing points.
  35298. */
  35299. centerInCategory?: boolean;
  35300. /**
  35301. * (Highcharts, Highstock) An additional class name to apply to the series'
  35302. * graphical elements. This option does not replace default class names of
  35303. * the graphical element.
  35304. */
  35305. className?: string;
  35306. /**
  35307. * (Highcharts, Highstock) Disable this option to allow series rendering in
  35308. * the whole plotting area.
  35309. *
  35310. * **Note:** Clipping should be always enabled when chart.zoomType is set
  35311. */
  35312. clip?: boolean;
  35313. /**
  35314. * (Highcharts, Highstock) The main color of the series. In line type series
  35315. * it applies to the line and the point markers unless otherwise specified.
  35316. * In bar type series it applies to the bars unless a color is specified per
  35317. * point. The default value is pulled from the `options.colors` array.
  35318. *
  35319. * In styled mode, the color can be defined by the colorIndex option. Also,
  35320. * the series color can be set with the `.highcharts-series`,
  35321. * `.highcharts-color-{n}`, `.highcharts-{type}-series` or
  35322. * `.highcharts-series-{n}` class, or individual classes given by the
  35323. * `className` option.
  35324. */
  35325. color?: (ColorString|GradientColorObject|PatternObject);
  35326. /**
  35327. * (Highcharts, Highstock, Highmaps) When using dual or multiple color axes,
  35328. * this number defines which colorAxis the particular series is connected
  35329. * to. It refers to either the axis id or the index of the axis in the
  35330. * colorAxis array, with 0 being the first. Set this option to false to
  35331. * prevent a series from connecting to the default color axis.
  35332. *
  35333. * Since v7.2.0 the option can also be an axis id or an axis index instead
  35334. * of a boolean flag.
  35335. */
  35336. colorAxis?: (boolean|number|string);
  35337. /**
  35338. * (Highcharts, Highstock, Gantt) When using automatic point colors pulled
  35339. * from the global colors or series-specific plotOptions.column.colors
  35340. * collections, this option determines whether the chart should receive one
  35341. * color per series or one color per point.
  35342. *
  35343. * In styled mode, the `colors` or `series.colors` arrays are not supported,
  35344. * and instead this option gives the points individual color class names on
  35345. * the form `highcharts-color-{n}`.
  35346. */
  35347. colorByPoint?: boolean;
  35348. /**
  35349. * (Highcharts, Highstock) Styled mode only. A specific color index to use
  35350. * for the series, so its graphic representations are given the class name
  35351. * `highcharts-color-{n}`.
  35352. */
  35353. colorIndex?: number;
  35354. /**
  35355. * (Highcharts, Highstock, Highmaps) Determines what data value should be
  35356. * used to calculate point color if `colorAxis` is used. Requires to set
  35357. * `min` and `max` if some custom point property is used or if approximation
  35358. * for data grouping is set to `'sum'`.
  35359. */
  35360. colorKey?: string;
  35361. /**
  35362. * (Highcharts, Highstock, Gantt) A series specific or series type specific
  35363. * color set to apply instead of the global colors when colorByPoint is
  35364. * true.
  35365. */
  35366. colors?: Array<(ColorString|GradientColorObject|PatternObject)>;
  35367. /**
  35368. * (Highstock) Compare the values of the series against the first non-null,
  35369. * non- zero value in the visible range. The y axis will show percentage or
  35370. * absolute change depending on whether `compare` is set to `"percent"` or
  35371. * `"value"`. When this is applied to multiple series, it allows comparing
  35372. * the development of the series against each other. Adds a `change` field
  35373. * to every point object.
  35374. */
  35375. compare?: string;
  35376. /**
  35377. * (Highstock) When compare is `percent`, this option dictates whether to
  35378. * use 0 or 100 as the base of comparison.
  35379. */
  35380. compareBase?: (0|100);
  35381. /**
  35382. * (Highstock) Defines if comparison should start from the first point
  35383. * within the visible range or should start from the first point **before**
  35384. * the range.
  35385. *
  35386. * In other words, this flag determines if first point within the visible
  35387. * range will have 0% (`compareStart=true`) or should have been already
  35388. * calculated according to the previous point (`compareStart=false`).
  35389. */
  35390. compareStart?: boolean;
  35391. /**
  35392. * (Gantt) Override Pathfinder connector options for a series. Requires
  35393. * Highcharts Gantt to be loaded.
  35394. */
  35395. connectors?: SeriesConnectorsOptionsObject;
  35396. /**
  35397. * (Highcharts, Highstock, Gantt) When the series contains less points than
  35398. * the crop threshold, all points are drawn, event if the points fall
  35399. * outside the visible plot area at the current zoom. The advantage of
  35400. * drawing all points (including markers and columns), is that animation is
  35401. * performed on updates. On the other hand, when the series contains more
  35402. * points than the crop threshold, the series data is cropped to only
  35403. * contain points that fall within the plot area. The advantage of cropping
  35404. * away invisible points is to increase performance on large series.
  35405. */
  35406. cropThreshold?: number;
  35407. /**
  35408. * (Highcharts, Highstock) You can set the cursor to "pointer" if you have
  35409. * click events attached to the series, to signal to the user that the
  35410. * points and lines can be clicked.
  35411. *
  35412. * In styled mode, the series cursor can be set with the same classes as
  35413. * listed under series.color.
  35414. */
  35415. cursor?: (string|CursorValue);
  35416. /**
  35417. * (Highcharts, Highstock) A reserved subspace to store options and values
  35418. * for customized functionality. Here you can add additional data for your
  35419. * own event callbacks and formatter callbacks.
  35420. */
  35421. custom?: Dictionary<any>;
  35422. /**
  35423. * (Highcharts, Highstock) Name of the dash style to use for the graph, or
  35424. * for some series types the outline of each shape.
  35425. *
  35426. * In styled mode, the stroke dash-array can be set with the same classes as
  35427. * listed under series.color.
  35428. */
  35429. dashStyle?: DashStyleValue;
  35430. /**
  35431. * (Highstock) Data grouping is the concept of sampling the data values into
  35432. * larger blocks in order to ease readability and increase performance of
  35433. * the JavaScript charts. Highstock by default applies data grouping when
  35434. * the points become closer than a certain pixel value, determined by the
  35435. * `groupPixelWidth` option.
  35436. *
  35437. * If data grouping is applied, the grouping information of grouped points
  35438. * can be read from the Point.dataGroup. If point options other than the
  35439. * data itself are set, for example `name` or `color` or custom properties,
  35440. * the grouping logic doesn't know how to group it. In this case the options
  35441. * of the first point instance are copied over to the group point. This can
  35442. * be altered through a custom `approximation` callback function.
  35443. */
  35444. dataGrouping?: DataGroupingOptionsObject;
  35445. /**
  35446. * (Highcharts, Highstock, Highmaps, Gantt) Options for the series data
  35447. * labels, appearing next to each data point.
  35448. *
  35449. * Since v6.2.0, multiple data labels can be applied to each single point by
  35450. * defining them as an array of configs.
  35451. *
  35452. * In styled mode, the data labels can be styled with the
  35453. * `.highcharts-data-label-box` and `.highcharts-data-label` class names
  35454. * (see example).
  35455. */
  35456. dataLabels?: (PlotColumnpyramidDataLabelsOptions|Array<PlotColumnpyramidDataLabelsOptions>);
  35457. /**
  35458. * (Highcharts, Highstock) Options for the series data sorting.
  35459. */
  35460. dataSorting?: (DataSortingOptionsObject|PlotColumnpyramidDataSortingOptions);
  35461. /**
  35462. * (Highcharts, Highstock) A description of the series to add to the screen
  35463. * reader information about the series.
  35464. */
  35465. description?: string;
  35466. /**
  35467. * (Highcharts, Highstock) The draggable-points module allows points to be
  35468. * moved around or modified in the chart. In addition to the options
  35469. * mentioned under the `dragDrop` API structure, the module fires three
  35470. * events, point.dragStart, point.drag and point.drop.
  35471. */
  35472. dragDrop?: SeriesDragDropOptionsObject;
  35473. /**
  35474. * (Highcharts, Highstock) Enable or disable the mouse tracking for a
  35475. * specific series. This includes point tooltips and click events on graphs
  35476. * and points. For large datasets it improves performance.
  35477. */
  35478. enableMouseTracking?: boolean;
  35479. /**
  35480. * (Highcharts, Highstock) General event handlers for the series items.
  35481. * These event hooks can also be attached to the series at run time using
  35482. * the `Highcharts.addEvent` function.
  35483. */
  35484. events?: SeriesEventsOptionsObject;
  35485. /**
  35486. * (Highcharts, Highstock) Determines whether the series should look for the
  35487. * nearest point in both dimensions or just the x-dimension when hovering
  35488. * the series. Defaults to `'xy'` for scatter series and `'x'` for most
  35489. * other series. If the data has duplicate x-values, it is recommended to
  35490. * set this to `'xy'` to allow hovering over all points.
  35491. *
  35492. * Applies only to series types using nearest neighbor search (not direct
  35493. * hover) for tooltip.
  35494. */
  35495. findNearestPointBy?: OptionsFindNearestPointByValue;
  35496. /**
  35497. * (Highcharts, Highstock, Gantt) Whether to use the Y extremes of the total
  35498. * chart width or only the zoomed area when zooming in on parts of the X
  35499. * axis. By default, the Y axis adjusts to the min and max of the visible
  35500. * data. Cartesian series only.
  35501. */
  35502. getExtremesFromAll?: boolean;
  35503. /**
  35504. * (Highcharts, Highstock, Gantt) Whether to group non-stacked columns or to
  35505. * let them render independent of each other. Non-grouped columns will be
  35506. * laid out individually and overlap each other.
  35507. */
  35508. grouping?: boolean;
  35509. /**
  35510. * (Highcharts, Highstock, Gantt) Padding between each value groups, in x
  35511. * axis units.
  35512. */
  35513. groupPadding?: number;
  35514. /**
  35515. * (Highcharts, Highstock) When set to `false` will prevent the series data
  35516. * from being included in any form of data export.
  35517. *
  35518. * Since version 6.0.0 until 7.1.0 the option was existing undocumented as
  35519. * `includeInCSVExport`.
  35520. */
  35521. includeInDataExport?: boolean;
  35522. /**
  35523. * (Highmaps) What property to join the `mapData` to the value data. For
  35524. * example, if joinBy is "code", the mapData items with a specific code is
  35525. * merged into the data with the same code. For maps loaded from GeoJSON,
  35526. * the keys may be held in each point's `properties` object.
  35527. *
  35528. * The joinBy option can also be an array of two values, where the first
  35529. * points to a key in the `mapData`, and the second points to another key in
  35530. * the `data`.
  35531. *
  35532. * When joinBy is `null`, the map items are joined by their position in the
  35533. * array, which performs much better in maps with many data points. This is
  35534. * the recommended option if you are printing more than a thousand data
  35535. * points and have a backend that can preprocess the data into a parallel
  35536. * array of the mapData.
  35537. */
  35538. joinBy?: (string|Array<string>);
  35539. /**
  35540. * (Highcharts, Highstock) An array specifying which option maps to which
  35541. * key in the data point array. This makes it convenient to work with
  35542. * unstructured data arrays from different sources.
  35543. */
  35544. keys?: Array<string>;
  35545. /**
  35546. * (Highcharts, Highstock, Gantt) Series labels are placed as close to the
  35547. * series as possible in a natural way, seeking to avoid other series. The
  35548. * goal of this feature is to make the chart more easily readable, like if a
  35549. * human designer placed the labels in the optimal position.
  35550. *
  35551. * The series labels currently work with series types having a `graph` or an
  35552. * `area`.
  35553. */
  35554. label?: SeriesLabelOptionsObject;
  35555. /**
  35556. * (Highstock) The line marks the last price from all points.
  35557. */
  35558. lastPrice?: SeriesLastPriceOptionsObject;
  35559. /**
  35560. * (Highstock) The line marks the last price from visible range of points.
  35561. */
  35562. lastVisiblePrice?: SeriesLastVisiblePriceOptionsObject;
  35563. /**
  35564. * (Highcharts, Highstock, Gantt) The id of another series to link to.
  35565. * Additionally, the value can be ":previous" to link to the previous
  35566. * series. When two series are linked, only the first one appears in the
  35567. * legend. Toggling the visibility of this also toggles the linked series.
  35568. *
  35569. * If master series uses data sorting and linked series does not have its
  35570. * own sorting definition, the linked series will be sorted in the same
  35571. * order as the master one.
  35572. */
  35573. linkedTo?: string;
  35574. /**
  35575. * (Highcharts, Highstock, Gantt) The maximum allowed pixel width for a
  35576. * column, translated to the height of a bar in a bar chart. This prevents
  35577. * the columns from becoming too wide when there is a small number of points
  35578. * in the chart.
  35579. */
  35580. maxPointWidth?: number;
  35581. /**
  35582. * (Highcharts, Highstock, Gantt) The minimal height for a column or width
  35583. * for a bar. By default, 0 values are not shown. To visualize a 0 (or close
  35584. * to zero) point, set the minimal point length to a pixel value like 3\. In
  35585. * stacked column charts, minPointLength might not be respected for tightly
  35586. * packed values.
  35587. */
  35588. minPointLength?: number;
  35589. /**
  35590. * (Highstock) Options for the corresponding navigator series if
  35591. * `showInNavigator` is `true` for this series. Available options are the
  35592. * same as any series, documented at plotOptions and series.
  35593. *
  35594. * These options are merged with options in navigator.series, and will take
  35595. * precedence if the same option is defined both places.
  35596. */
  35597. navigatorOptions?: PlotSeriesOptions;
  35598. /**
  35599. * (Highcharts, Highstock) Opacity of a series parts: line, fill (e.g. area)
  35600. * and dataLabels.
  35601. */
  35602. opacity?: number;
  35603. /**
  35604. * (Highcharts, Highstock) Properties for each single point.
  35605. */
  35606. point?: PlotSeriesPointOptions;
  35607. /**
  35608. * (Highcharts, Highstock) Same as accessibility.pointDescriptionFormatter,
  35609. * but for an individual series. Overrides the chart wide configuration.
  35610. */
  35611. pointDescriptionFormatter?: Function;
  35612. /**
  35613. * (Highcharts, Highstock, Gantt) If no x values are given for the points in
  35614. * a series, `pointInterval` defines the interval of the x values. For
  35615. * example, if a series contains one value every decade starting from year
  35616. * 0, set `pointInterval` to `10`. In true `datetime` axes, the
  35617. * `pointInterval` is set in milliseconds.
  35618. *
  35619. * It can be also be combined with `pointIntervalUnit` to draw irregular
  35620. * time intervals.
  35621. *
  35622. * Please note that this options applies to the _series data_, not the
  35623. * interval of the axis ticks, which is independent.
  35624. */
  35625. pointInterval?: number;
  35626. /**
  35627. * (Highcharts, Highstock, Gantt) On datetime series, this allows for
  35628. * setting the pointInterval to irregular time units, `day`, `month` and
  35629. * `year`. A day is usually the same as 24 hours, but `pointIntervalUnit`
  35630. * also takes the DST crossover into consideration when dealing with local
  35631. * time. Combine this option with `pointInterval` to draw weeks, quarters, 6
  35632. * months, 10 years etc.
  35633. *
  35634. * Please note that this options applies to the _series data_, not the
  35635. * interval of the axis ticks, which is independent.
  35636. */
  35637. pointIntervalUnit?: OptionsPointIntervalUnitValue;
  35638. /**
  35639. * (Highcharts, Highstock, Gantt) Padding between each column or bar, in x
  35640. * axis units.
  35641. */
  35642. pointPadding?: number;
  35643. /**
  35644. * (Highcharts, Highstock, Gantt) Possible values: `"on"`, `"between"`,
  35645. * `number`.
  35646. *
  35647. * In a column chart, when pointPlacement is `"on"`, the point will not
  35648. * create any padding of the X axis. In a polar column chart this means that
  35649. * the first column points directly north. If the pointPlacement is
  35650. * `"between"`, the columns will be laid out between ticks. This is useful
  35651. * for example for visualising an amount between two points in time or in a
  35652. * certain sector of a polar chart.
  35653. *
  35654. * Since Highcharts 3.0.2, the point placement can also be numeric, where 0
  35655. * is on the axis value, -0.5 is between this value and the previous, and
  35656. * 0.5 is between this value and the next. Unlike the textual options,
  35657. * numeric point placement options won't affect axis padding.
  35658. *
  35659. * Note that pointPlacement needs a pointRange to work. For column series
  35660. * this is computed, but for line-type series it needs to be set.
  35661. *
  35662. * For the `xrange` series type and gantt charts, if the Y axis is a
  35663. * category axis, the `pointPlacement` applies to the Y axis rather than the
  35664. * (typically datetime) X axis.
  35665. *
  35666. * Defaults to `undefined` in cartesian charts, `"between"` in polar charts.
  35667. */
  35668. pointPlacement?: (number|string);
  35669. /**
  35670. * (Highcharts, Highstock, Gantt) The X axis range that each point is valid
  35671. * for. This determines the width of the column. On a categorized axis, the
  35672. * range will be 1 by default (one category unit). On linear and datetime
  35673. * axes, the range will be computed as the distance between the two closest
  35674. * data points.
  35675. *
  35676. * The default `null` means it is computed automatically, but this option
  35677. * can be used to override the automatic value.
  35678. *
  35679. * This option is set by default to 1 if data sorting is enabled.
  35680. */
  35681. pointRange?: (number|null);
  35682. /**
  35683. * (Highcharts, Highstock, Gantt) If no x values are given for the points in
  35684. * a series, pointStart defines on what value to start. For example, if a
  35685. * series contains one yearly value starting from 1945, set pointStart to
  35686. * 1945.
  35687. */
  35688. pointStart?: number;
  35689. /**
  35690. * (Highcharts, Highstock, Gantt) A pixel value specifying a fixed width for
  35691. * each column or bar point. When set to `undefined`, the width is
  35692. * calculated from the `pointPadding` and `groupPadding`. The width effects
  35693. * the dimension that is not based on the point value. For column series it
  35694. * is the hoizontal length and for bar series it is the vertical length.
  35695. */
  35696. pointWidth?: number;
  35697. /**
  35698. * (Highcharts, Highstock) Whether to select the series initially. If
  35699. * `showCheckbox` is true, the checkbox next to the series name in the
  35700. * legend will be checked for a selected series.
  35701. */
  35702. selected?: boolean;
  35703. /**
  35704. * (Highcharts, Highstock) Whether to apply a drop shadow to the graph line.
  35705. * Since 2.3 the shadow can be an object configuration containing `color`,
  35706. * `offsetX`, `offsetY`, `opacity` and `width`.
  35707. */
  35708. shadow?: (boolean|ShadowOptionsObject);
  35709. /**
  35710. * (Highcharts, Highstock) If true, a checkbox is displayed next to the
  35711. * legend item to allow selecting the series. The state of the checkbox is
  35712. * determined by the `selected` option.
  35713. */
  35714. showCheckbox?: boolean;
  35715. /**
  35716. * (Highcharts, Highstock) Whether to display this particular series or
  35717. * series type in the legend. Standalone series are shown in legend by
  35718. * default, and linked series are not. Since v7.2.0 it is possible to show
  35719. * series that use colorAxis by setting this option to `true`.
  35720. */
  35721. showInLegend?: boolean;
  35722. /**
  35723. * (Highstock) Whether or not to show the series in the navigator. Takes
  35724. * precedence over navigator.baseSeries if defined.
  35725. */
  35726. showInNavigator?: boolean;
  35727. /**
  35728. * (Highcharts, Highstock) If set to `true`, the accessibility module will
  35729. * skip past the points in this series for keyboard navigation.
  35730. */
  35731. skipKeyboardNavigation?: boolean;
  35732. /**
  35733. * (Highcharts, Highstock) Whether to stack the values of each series on top
  35734. * of each other. Possible values are `undefined` to disable, `"normal"` to
  35735. * stack by value or `"percent"`.
  35736. *
  35737. * When stacking is enabled, data must be sorted in ascending X order.
  35738. *
  35739. * Some stacking options are related to specific series types. In the
  35740. * streamgraph series type, the stacking option is set to `"stream"`. The
  35741. * second one is `"overlap"`, which only applies to waterfall series.
  35742. */
  35743. stacking?: OptionsStackingValue;
  35744. states?: SeriesStatesOptionsObject;
  35745. /**
  35746. * (Highcharts, Highstock) Sticky tracking of mouse events. When true, the
  35747. * `mouseOut` event on a series isn't triggered until the mouse moves over
  35748. * another series, or out of the plot area. When false, the `mouseOut` event
  35749. * on a series is triggered when the mouse leaves the area around the
  35750. * series' graph or markers. This also implies the tooltip when not shared.
  35751. * When `stickyTracking` is false and `tooltip.shared` is false, the tooltip
  35752. * will be hidden when moving the mouse between series. Defaults to true for
  35753. * line and area type series, but to false for columns, pies etc.
  35754. *
  35755. * **Note:** The boost module will force this option because of technical
  35756. * limitations.
  35757. */
  35758. stickyTracking?: boolean;
  35759. /**
  35760. * (Highcharts, Highstock) A configuration object for the tooltip rendering
  35761. * of each single series. Properties are inherited from tooltip, but only
  35762. * the following properties can be defined on a series level.
  35763. */
  35764. tooltip?: SeriesTooltipOptionsObject;
  35765. /**
  35766. * (Highcharts, Highstock, Gantt) When a series contains a data array that
  35767. * is longer than this, only one dimensional arrays of numbers, or two
  35768. * dimensional arrays with x and y values are allowed. Also, only the first
  35769. * point is tested, and the rest are assumed to be the same format. This
  35770. * saves expensive data checking and indexing in long series. Set it to `0`
  35771. * disable.
  35772. *
  35773. * Note: In boost mode turbo threshold is forced. Only array of numbers or
  35774. * two dimensional arrays are allowed.
  35775. */
  35776. turboThreshold?: number;
  35777. /**
  35778. * (Highcharts, Highstock) Set the initial visibility of the series.
  35779. */
  35780. visible?: boolean;
  35781. /**
  35782. * (Highmaps) Define the z index of the series.
  35783. */
  35784. zIndex?: number;
  35785. }
  35786. /**
  35787. * (Highcharts, Highstock) Enable or disable the initial animation when a series
  35788. * is displayed. The animation can also be set as a configuration object. Please
  35789. * note that this option only applies to the initial animation of the series
  35790. * itself. For other animations, see chart.animation and the animation parameter
  35791. * under the API methods. The following properties are supported:
  35792. *
  35793. * - `defer`: The animation delay time in milliseconds.
  35794. *
  35795. * - `duration`: The duration of the animation in milliseconds.
  35796. *
  35797. * - `easing`: Can be a string reference to an easing function set on the `Math`
  35798. * object or a function. See the _Custom easing function_ demo below.
  35799. *
  35800. * Due to poor performance, animation is disabled in old IE browsers for several
  35801. * chart types.
  35802. */
  35803. export interface PlotColumnrangeAnimationOptions {
  35804. defer?: number;
  35805. }
  35806. /**
  35807. * (Highcharts, Highstock) Enable or disable the initial animation when a series
  35808. * is displayed for the `dataLabels`. The animation can also be set as a
  35809. * configuration object. Please note that this option only applies to the
  35810. * initial animation. For other animations, see chart.animation and the
  35811. * animation parameter under the API methods. The following properties are
  35812. * supported:
  35813. *
  35814. * - `defer`: The animation delay time in milliseconds.
  35815. */
  35816. export interface PlotColumnrangeDataLabelsAnimationOptions {
  35817. /**
  35818. * (Highcharts, Highstock) The animation delay time in milliseconds. Set to
  35819. * `0` renders dataLabel immediately. As `undefined` inherits defer time
  35820. * from the series.animation.defer.
  35821. */
  35822. defer?: number;
  35823. }
  35824. /**
  35825. * (Highcharts, Highstock) Options for the series data sorting.
  35826. */
  35827. export interface PlotColumnrangeDataSortingOptions {
  35828. /**
  35829. * (Highcharts, Highstock) Enable or disable data sorting for the series.
  35830. * Use xAxis.reversed to change the sorting order.
  35831. */
  35832. enabled?: boolean;
  35833. /**
  35834. * (Highcharts, Highstock) Whether to allow matching points by name in an
  35835. * update. If this option is disabled, points will be matched by order.
  35836. */
  35837. matchByName?: boolean;
  35838. /**
  35839. * (Highcharts, Highstock) Determines what data value should be used to sort
  35840. * by.
  35841. */
  35842. sortKey?: string;
  35843. }
  35844. /**
  35845. * (Highcharts, Highstock) Style options for the guide box. The guide box has
  35846. * one state by default, the `default` state.
  35847. */
  35848. export interface PlotColumnrangeDragDropGuideBoxOptions {
  35849. /**
  35850. * (Highcharts, Highstock) Style options for the guide box default state.
  35851. */
  35852. default?: DragDropGuideBoxOptionsObject;
  35853. }
  35854. /**
  35855. * (Highcharts, Highstock) The column range is a cartesian series type with
  35856. * higher and lower Y values along an X axis. To display horizontal bars, set
  35857. * chart.inverted to `true`.
  35858. *
  35859. * In TypeScript the type option must always be set.
  35860. *
  35861. * Configuration options for the series are given in three levels:
  35862. *
  35863. * 1. Options for all series in a chart are defined in the plotOptions.series
  35864. * object.
  35865. *
  35866. * 2. Options for all `columnrange` series are defined in
  35867. * plotOptions.columnrange.
  35868. *
  35869. * 3. Options for one single series are given in the series instance array. (see
  35870. * online documentation for example)
  35871. */
  35872. export interface PlotColumnrangeOptions {
  35873. /**
  35874. * (Highcharts, Highstock) Accessibility options for a series.
  35875. */
  35876. accessibility?: SeriesAccessibilityOptionsObject;
  35877. /**
  35878. * (Highmaps) Whether all areas of the map defined in `mapData` should be
  35879. * rendered. If `true`, areas which don't correspond to a data point, are
  35880. * rendered as `null` points. If `false`, those areas are skipped.
  35881. */
  35882. allAreas?: boolean;
  35883. /**
  35884. * (Highcharts, Highstock) Allow this series' points to be selected by
  35885. * clicking on the graphic (columns, point markers, pie slices, map areas
  35886. * etc).
  35887. *
  35888. * The selected points can be handled by point select and unselect events,
  35889. * or collectively by the getSelectedPoints function.
  35890. *
  35891. * And alternative way of selecting points is through dragging.
  35892. */
  35893. allowPointSelect?: boolean;
  35894. /**
  35895. * (Highcharts, Highstock) Enable or disable the initial animation when a
  35896. * series is displayed. The animation can also be set as a configuration
  35897. * object. Please note that this option only applies to the initial
  35898. * animation of the series itself. For other animations, see chart.animation
  35899. * and the animation parameter under the API methods. The following
  35900. * properties are supported:
  35901. *
  35902. * - `defer`: The animation delay time in milliseconds.
  35903. *
  35904. * - `duration`: The duration of the animation in milliseconds.
  35905. *
  35906. * - `easing`: Can be a string reference to an easing function set on the
  35907. * `Math` object or a function. See the _Custom easing function_ demo below.
  35908. *
  35909. * Due to poor performance, animation is disabled in old IE browsers for
  35910. * several chart types.
  35911. */
  35912. animation?: (boolean|PlotColumnrangeAnimationOptions|Partial<AnimationOptionsObject>);
  35913. /**
  35914. * (Highcharts, Highstock) For some series, there is a limit that shuts down
  35915. * initial animation by default when the total number of points in the chart
  35916. * is too high. For example, for a column chart and its derivatives,
  35917. * animation does not run if there is more than 250 points totally. To
  35918. * disable this cap, set `animationLimit` to `Infinity`.
  35919. */
  35920. animationLimit?: number;
  35921. /**
  35922. * (Highcharts, Highstock) Sets the color blending in the boost module.
  35923. */
  35924. boostBlending?: OptionsBoostBlendingValue;
  35925. /**
  35926. * (Highcharts, Highstock) Set the point threshold for when a series should
  35927. * enter boost mode.
  35928. *
  35929. * Setting it to e.g. 2000 will cause the series to enter boost mode when
  35930. * there are 2000 or more points in the series.
  35931. *
  35932. * To disable boosting on the series, set the `boostThreshold` to 0. Setting
  35933. * it to 1 will force boosting.
  35934. *
  35935. * Note that the cropThreshold also affects this setting. When zooming in on
  35936. * a series that has fewer points than the `cropThreshold`, all points are
  35937. * rendered although outside the visible plot area, and the `boostThreshold`
  35938. * won't take effect.
  35939. */
  35940. boostThreshold?: number;
  35941. /**
  35942. * (Highcharts, Highstock, Gantt) The color of the border surrounding each
  35943. * column or bar.
  35944. *
  35945. * In styled mode, the border stroke can be set with the `.highcharts-point`
  35946. * rule.
  35947. */
  35948. borderColor?: (ColorString|GradientColorObject|PatternObject);
  35949. /**
  35950. * (Highcharts, Highstock, Gantt) The corner radius of the border
  35951. * surrounding each column or bar.
  35952. */
  35953. borderRadius?: number;
  35954. /**
  35955. * (Highcharts, Highstock, Gantt) The width of the border surrounding each
  35956. * column or bar. Defaults to `1` when there is room for a border, but to
  35957. * `0` when the columns are so dense that a border would cover the next
  35958. * column.
  35959. *
  35960. * In styled mode, the stroke width can be set with the `.highcharts-point`
  35961. * rule.
  35962. */
  35963. borderWidth?: number;
  35964. /**
  35965. * (Highcharts, Highstock, Gantt) When `true`, the columns will center in
  35966. * the category, ignoring null or missing points. When `false`, space will
  35967. * be reserved for null or missing points.
  35968. */
  35969. centerInCategory?: boolean;
  35970. /**
  35971. * (Highcharts, Highstock) An additional class name to apply to the series'
  35972. * graphical elements. This option does not replace default class names of
  35973. * the graphical element.
  35974. */
  35975. className?: string;
  35976. /**
  35977. * (Highcharts, Highstock) Disable this option to allow series rendering in
  35978. * the whole plotting area.
  35979. *
  35980. * **Note:** Clipping should be always enabled when chart.zoomType is set
  35981. */
  35982. clip?: boolean;
  35983. /**
  35984. * (Highcharts, Highstock) The main color of the series. In line type series
  35985. * it applies to the line and the point markers unless otherwise specified.
  35986. * In bar type series it applies to the bars unless a color is specified per
  35987. * point. The default value is pulled from the `options.colors` array.
  35988. *
  35989. * In styled mode, the color can be defined by the colorIndex option. Also,
  35990. * the series color can be set with the `.highcharts-series`,
  35991. * `.highcharts-color-{n}`, `.highcharts-{type}-series` or
  35992. * `.highcharts-series-{n}` class, or individual classes given by the
  35993. * `className` option.
  35994. */
  35995. color?: (ColorString|GradientColorObject|PatternObject);
  35996. /**
  35997. * (Highcharts, Highstock, Highmaps) When using dual or multiple color axes,
  35998. * this number defines which colorAxis the particular series is connected
  35999. * to. It refers to either the axis id or the index of the axis in the
  36000. * colorAxis array, with 0 being the first. Set this option to false to
  36001. * prevent a series from connecting to the default color axis.
  36002. *
  36003. * Since v7.2.0 the option can also be an axis id or an axis index instead
  36004. * of a boolean flag.
  36005. */
  36006. colorAxis?: (boolean|number|string);
  36007. /**
  36008. * (Highcharts, Highstock, Gantt) When using automatic point colors pulled
  36009. * from the global colors or series-specific plotOptions.column.colors
  36010. * collections, this option determines whether the chart should receive one
  36011. * color per series or one color per point.
  36012. *
  36013. * In styled mode, the `colors` or `series.colors` arrays are not supported,
  36014. * and instead this option gives the points individual color class names on
  36015. * the form `highcharts-color-{n}`.
  36016. */
  36017. colorByPoint?: boolean;
  36018. /**
  36019. * (Highcharts, Highstock) Styled mode only. A specific color index to use
  36020. * for the series, so its graphic representations are given the class name
  36021. * `highcharts-color-{n}`.
  36022. */
  36023. colorIndex?: number;
  36024. /**
  36025. * (Highcharts, Highstock, Highmaps) Determines what data value should be
  36026. * used to calculate point color if `colorAxis` is used. Requires to set
  36027. * `min` and `max` if some custom point property is used or if approximation
  36028. * for data grouping is set to `'sum'`.
  36029. */
  36030. colorKey?: string;
  36031. /**
  36032. * (Highcharts, Highstock, Gantt) A series specific or series type specific
  36033. * color set to apply instead of the global colors when colorByPoint is
  36034. * true.
  36035. */
  36036. colors?: Array<(ColorString|GradientColorObject|PatternObject)>;
  36037. /**
  36038. * (Highstock) Compare the values of the series against the first non-null,
  36039. * non- zero value in the visible range. The y axis will show percentage or
  36040. * absolute change depending on whether `compare` is set to `"percent"` or
  36041. * `"value"`. When this is applied to multiple series, it allows comparing
  36042. * the development of the series against each other. Adds a `change` field
  36043. * to every point object.
  36044. */
  36045. compare?: string;
  36046. /**
  36047. * (Highstock) When compare is `percent`, this option dictates whether to
  36048. * use 0 or 100 as the base of comparison.
  36049. */
  36050. compareBase?: (0|100);
  36051. /**
  36052. * (Highstock) Defines if comparison should start from the first point
  36053. * within the visible range or should start from the first point **before**
  36054. * the range.
  36055. *
  36056. * In other words, this flag determines if first point within the visible
  36057. * range will have 0% (`compareStart=true`) or should have been already
  36058. * calculated according to the previous point (`compareStart=false`).
  36059. */
  36060. compareStart?: boolean;
  36061. /**
  36062. * (Gantt) Override Pathfinder connector options for a series. Requires
  36063. * Highcharts Gantt to be loaded.
  36064. */
  36065. connectors?: SeriesConnectorsOptionsObject;
  36066. /**
  36067. * (Highcharts, Highstock, Gantt) When true, each point or column edge is
  36068. * rounded to its nearest pixel in order to render sharp on screen. In some
  36069. * cases, when there are a lot of densely packed columns, this leads to
  36070. * visible difference in column widths or distance between columns. In these
  36071. * cases, setting `crisp` to `false` may look better, even though each
  36072. * column is rendered blurry.
  36073. */
  36074. crisp?: boolean;
  36075. /**
  36076. * (Highcharts, Highstock, Gantt) When the series contains less points than
  36077. * the crop threshold, all points are drawn, event if the points fall
  36078. * outside the visible plot area at the current zoom. The advantage of
  36079. * drawing all points (including markers and columns), is that animation is
  36080. * performed on updates. On the other hand, when the series contains more
  36081. * points than the crop threshold, the series data is cropped to only
  36082. * contain points that fall within the plot area. The advantage of cropping
  36083. * away invisible points is to increase performance on large series.
  36084. */
  36085. cropThreshold?: number;
  36086. /**
  36087. * (Highcharts, Highstock) You can set the cursor to "pointer" if you have
  36088. * click events attached to the series, to signal to the user that the
  36089. * points and lines can be clicked.
  36090. *
  36091. * In styled mode, the series cursor can be set with the same classes as
  36092. * listed under series.color.
  36093. */
  36094. cursor?: (string|CursorValue);
  36095. /**
  36096. * (Highcharts, Highstock) A reserved subspace to store options and values
  36097. * for customized functionality. Here you can add additional data for your
  36098. * own event callbacks and formatter callbacks.
  36099. */
  36100. custom?: Dictionary<any>;
  36101. /**
  36102. * (Highcharts, Highstock) Name of the dash style to use for the graph, or
  36103. * for some series types the outline of each shape.
  36104. *
  36105. * In styled mode, the stroke dash-array can be set with the same classes as
  36106. * listed under series.color.
  36107. */
  36108. dashStyle?: DashStyleValue;
  36109. /**
  36110. * (Highstock) Data grouping is the concept of sampling the data values into
  36111. * larger blocks in order to ease readability and increase performance of
  36112. * the JavaScript charts. Highstock by default applies data grouping when
  36113. * the points become closer than a certain pixel value, determined by the
  36114. * `groupPixelWidth` option.
  36115. *
  36116. * If data grouping is applied, the grouping information of grouped points
  36117. * can be read from the Point.dataGroup. If point options other than the
  36118. * data itself are set, for example `name` or `color` or custom properties,
  36119. * the grouping logic doesn't know how to group it. In this case the options
  36120. * of the first point instance are copied over to the group point. This can
  36121. * be altered through a custom `approximation` callback function.
  36122. */
  36123. dataGrouping?: DataGroupingOptionsObject;
  36124. /**
  36125. * (Highcharts, Highstock) Extended data labels for range series types.
  36126. * Range series data labels have no `x` and `y` options. Instead, they have
  36127. * `xLow`, `xHigh`, `yLow` and `yHigh` options to allow the higher and lower
  36128. * data label sets individually.
  36129. */
  36130. dataLabels?: (SeriesAreaRangeDataLabelsOptionsObject|Array<SeriesAreaRangeDataLabelsOptionsObject>);
  36131. /**
  36132. * (Highcharts, Highstock) Options for the series data sorting.
  36133. */
  36134. dataSorting?: (DataSortingOptionsObject|PlotColumnrangeDataSortingOptions);
  36135. /**
  36136. * (Highcharts) Depth of the columns in a 3D column chart.
  36137. */
  36138. depth?: number;
  36139. /**
  36140. * (Highcharts, Highstock) A description of the series to add to the screen
  36141. * reader information about the series.
  36142. */
  36143. description?: string;
  36144. /**
  36145. * (Highcharts, Highstock) The draggable-points module allows points to be
  36146. * moved around or modified in the chart. In addition to the options
  36147. * mentioned under the `dragDrop` API structure, the module fires three
  36148. * events, point.dragStart, point.drag and point.drop.
  36149. */
  36150. dragDrop?: SeriesDragDropOptionsObject;
  36151. /**
  36152. * (Highcharts) 3D columns only. The color of the edges. Similar to
  36153. * `borderColor`, except it defaults to the same color as the column.
  36154. */
  36155. edgeColor?: ColorString;
  36156. /**
  36157. * (Highcharts) 3D columns only. The width of the colored edges.
  36158. */
  36159. edgeWidth?: number;
  36160. /**
  36161. * (Highcharts, Highstock) Enable or disable the mouse tracking for a
  36162. * specific series. This includes point tooltips and click events on graphs
  36163. * and points. For large datasets it improves performance.
  36164. */
  36165. enableMouseTracking?: boolean;
  36166. /**
  36167. * (Highcharts, Highstock) General event handlers for the series items.
  36168. * These event hooks can also be attached to the series at run time using
  36169. * the `Highcharts.addEvent` function.
  36170. */
  36171. events?: SeriesEventsOptionsObject;
  36172. /**
  36173. * (Highcharts, Highstock) Determines whether the series should look for the
  36174. * nearest point in both dimensions or just the x-dimension when hovering
  36175. * the series. Defaults to `'xy'` for scatter series and `'x'` for most
  36176. * other series. If the data has duplicate x-values, it is recommended to
  36177. * set this to `'xy'` to allow hovering over all points.
  36178. *
  36179. * Applies only to series types using nearest neighbor search (not direct
  36180. * hover) for tooltip.
  36181. */
  36182. findNearestPointBy?: OptionsFindNearestPointByValue;
  36183. /**
  36184. * (Highcharts, Highstock, Gantt) Whether to use the Y extremes of the total
  36185. * chart width or only the zoomed area when zooming in on parts of the X
  36186. * axis. By default, the Y axis adjusts to the min and max of the visible
  36187. * data. Cartesian series only.
  36188. */
  36189. getExtremesFromAll?: boolean;
  36190. /**
  36191. * (Highcharts, Highstock, Gantt) Whether to group non-stacked columns or to
  36192. * let them render independent of each other. Non-grouped columns will be
  36193. * laid out individually and overlap each other.
  36194. */
  36195. grouping?: boolean;
  36196. /**
  36197. * (Highcharts, Highstock, Gantt) Padding between each value groups, in x
  36198. * axis units.
  36199. */
  36200. groupPadding?: number;
  36201. /**
  36202. * (Highcharts) The spacing between columns on the Z Axis in a 3D chart.
  36203. */
  36204. groupZPadding?: number;
  36205. /**
  36206. * (Highcharts, Highstock) When set to `false` will prevent the series data
  36207. * from being included in any form of data export.
  36208. *
  36209. * Since version 6.0.0 until 7.1.0 the option was existing undocumented as
  36210. * `includeInCSVExport`.
  36211. */
  36212. includeInDataExport?: boolean;
  36213. /**
  36214. * (Highmaps) What property to join the `mapData` to the value data. For
  36215. * example, if joinBy is "code", the mapData items with a specific code is
  36216. * merged into the data with the same code. For maps loaded from GeoJSON,
  36217. * the keys may be held in each point's `properties` object.
  36218. *
  36219. * The joinBy option can also be an array of two values, where the first
  36220. * points to a key in the `mapData`, and the second points to another key in
  36221. * the `data`.
  36222. *
  36223. * When joinBy is `null`, the map items are joined by their position in the
  36224. * array, which performs much better in maps with many data points. This is
  36225. * the recommended option if you are printing more than a thousand data
  36226. * points and have a backend that can preprocess the data into a parallel
  36227. * array of the mapData.
  36228. */
  36229. joinBy?: (string|Array<string>);
  36230. /**
  36231. * (Highcharts, Highstock) An array specifying which option maps to which
  36232. * key in the data point array. This makes it convenient to work with
  36233. * unstructured data arrays from different sources.
  36234. */
  36235. keys?: Array<string>;
  36236. /**
  36237. * (Highcharts, Highstock, Gantt) Series labels are placed as close to the
  36238. * series as possible in a natural way, seeking to avoid other series. The
  36239. * goal of this feature is to make the chart more easily readable, like if a
  36240. * human designer placed the labels in the optimal position.
  36241. *
  36242. * The series labels currently work with series types having a `graph` or an
  36243. * `area`.
  36244. */
  36245. label?: SeriesLabelOptionsObject;
  36246. /**
  36247. * (Highstock) The line marks the last price from all points.
  36248. */
  36249. lastPrice?: SeriesLastPriceOptionsObject;
  36250. /**
  36251. * (Highstock) The line marks the last price from visible range of points.
  36252. */
  36253. lastVisiblePrice?: SeriesLastVisiblePriceOptionsObject;
  36254. /**
  36255. * (Highcharts, Highstock, Gantt) The id of another series to link to.
  36256. * Additionally, the value can be ":previous" to link to the previous
  36257. * series. When two series are linked, only the first one appears in the
  36258. * legend. Toggling the visibility of this also toggles the linked series.
  36259. *
  36260. * If master series uses data sorting and linked series does not have its
  36261. * own sorting definition, the linked series will be sorted in the same
  36262. * order as the master one.
  36263. */
  36264. linkedTo?: string;
  36265. /**
  36266. * (Highcharts, Highstock, Gantt) The maximum allowed pixel width for a
  36267. * column, translated to the height of a bar in a bar chart. This prevents
  36268. * the columns from becoming too wide when there is a small number of points
  36269. * in the chart.
  36270. */
  36271. maxPointWidth?: number;
  36272. /**
  36273. * (Highcharts, Highstock, Gantt) The minimal height for a column or width
  36274. * for a bar. By default, 0 values are not shown. To visualize a 0 (or close
  36275. * to zero) point, set the minimal point length to a pixel value like 3\. In
  36276. * stacked column charts, minPointLength might not be respected for tightly
  36277. * packed values.
  36278. */
  36279. minPointLength?: number;
  36280. /**
  36281. * (Highstock) Options for the corresponding navigator series if
  36282. * `showInNavigator` is `true` for this series. Available options are the
  36283. * same as any series, documented at plotOptions and series.
  36284. *
  36285. * These options are merged with options in navigator.series, and will take
  36286. * precedence if the same option is defined both places.
  36287. */
  36288. navigatorOptions?: PlotSeriesOptions;
  36289. /**
  36290. * (Highcharts, Highstock) Opacity of a series parts: line, fill (e.g. area)
  36291. * and dataLabels.
  36292. */
  36293. opacity?: number;
  36294. /**
  36295. * (Highcharts, Highstock) Properties for each single point.
  36296. */
  36297. point?: PlotSeriesPointOptions;
  36298. /**
  36299. * (Highcharts, Highstock) Same as accessibility.pointDescriptionFormatter,
  36300. * but for an individual series. Overrides the chart wide configuration.
  36301. */
  36302. pointDescriptionFormatter?: Function;
  36303. /**
  36304. * (Highcharts, Highstock, Gantt) If no x values are given for the points in
  36305. * a series, `pointInterval` defines the interval of the x values. For
  36306. * example, if a series contains one value every decade starting from year
  36307. * 0, set `pointInterval` to `10`. In true `datetime` axes, the
  36308. * `pointInterval` is set in milliseconds.
  36309. *
  36310. * It can be also be combined with `pointIntervalUnit` to draw irregular
  36311. * time intervals.
  36312. *
  36313. * Please note that this options applies to the _series data_, not the
  36314. * interval of the axis ticks, which is independent.
  36315. */
  36316. pointInterval?: number;
  36317. /**
  36318. * (Highcharts, Highstock, Gantt) On datetime series, this allows for
  36319. * setting the pointInterval to irregular time units, `day`, `month` and
  36320. * `year`. A day is usually the same as 24 hours, but `pointIntervalUnit`
  36321. * also takes the DST crossover into consideration when dealing with local
  36322. * time. Combine this option with `pointInterval` to draw weeks, quarters, 6
  36323. * months, 10 years etc.
  36324. *
  36325. * Please note that this options applies to the _series data_, not the
  36326. * interval of the axis ticks, which is independent.
  36327. */
  36328. pointIntervalUnit?: OptionsPointIntervalUnitValue;
  36329. /**
  36330. * (Highcharts, Highstock, Gantt) Padding between each column or bar, in x
  36331. * axis units.
  36332. */
  36333. pointPadding?: number;
  36334. /**
  36335. * (Highcharts, Highstock, Gantt) Possible values: `"on"`, `"between"`,
  36336. * `number`.
  36337. *
  36338. * In a column chart, when pointPlacement is `"on"`, the point will not
  36339. * create any padding of the X axis. In a polar column chart this means that
  36340. * the first column points directly north. If the pointPlacement is
  36341. * `"between"`, the columns will be laid out between ticks. This is useful
  36342. * for example for visualising an amount between two points in time or in a
  36343. * certain sector of a polar chart.
  36344. *
  36345. * Since Highcharts 3.0.2, the point placement can also be numeric, where 0
  36346. * is on the axis value, -0.5 is between this value and the previous, and
  36347. * 0.5 is between this value and the next. Unlike the textual options,
  36348. * numeric point placement options won't affect axis padding.
  36349. *
  36350. * Note that pointPlacement needs a pointRange to work. For column series
  36351. * this is computed, but for line-type series it needs to be set.
  36352. *
  36353. * For the `xrange` series type and gantt charts, if the Y axis is a
  36354. * category axis, the `pointPlacement` applies to the Y axis rather than the
  36355. * (typically datetime) X axis.
  36356. *
  36357. * Defaults to `undefined` in cartesian charts, `"between"` in polar charts.
  36358. */
  36359. pointPlacement?: (number|string);
  36360. /**
  36361. * (Highcharts, Highstock, Gantt) The X axis range that each point is valid
  36362. * for. This determines the width of the column. On a categorized axis, the
  36363. * range will be 1 by default (one category unit). On linear and datetime
  36364. * axes, the range will be computed as the distance between the two closest
  36365. * data points.
  36366. *
  36367. * The default `null` means it is computed automatically, but this option
  36368. * can be used to override the automatic value.
  36369. *
  36370. * This option is set by default to 1 if data sorting is enabled.
  36371. */
  36372. pointRange?: (number|null);
  36373. /**
  36374. * (Highcharts, Highstock, Gantt) If no x values are given for the points in
  36375. * a series, pointStart defines on what value to start. For example, if a
  36376. * series contains one yearly value starting from 1945, set pointStart to
  36377. * 1945.
  36378. */
  36379. pointStart?: number;
  36380. /**
  36381. * (Highcharts, Highstock, Gantt) A pixel value specifying a fixed width for
  36382. * each column or bar point. When set to `undefined`, the width is
  36383. * calculated from the `pointPadding` and `groupPadding`. The width effects
  36384. * the dimension that is not based on the point value. For column series it
  36385. * is the hoizontal length and for bar series it is the vertical length.
  36386. */
  36387. pointWidth?: number;
  36388. /**
  36389. * (Highcharts, Highstock) Whether to select the series initially. If
  36390. * `showCheckbox` is true, the checkbox next to the series name in the
  36391. * legend will be checked for a selected series.
  36392. */
  36393. selected?: boolean;
  36394. /**
  36395. * (Highcharts, Highstock) Whether to apply a drop shadow to the graph line.
  36396. * Since 2.3 the shadow can be an object configuration containing `color`,
  36397. * `offsetX`, `offsetY`, `opacity` and `width`.
  36398. */
  36399. shadow?: (boolean|ShadowOptionsObject);
  36400. /**
  36401. * (Highcharts, Highstock) If true, a checkbox is displayed next to the
  36402. * legend item to allow selecting the series. The state of the checkbox is
  36403. * determined by the `selected` option.
  36404. */
  36405. showCheckbox?: boolean;
  36406. /**
  36407. * (Highcharts, Highstock) Whether to display this particular series or
  36408. * series type in the legend. Standalone series are shown in legend by
  36409. * default, and linked series are not. Since v7.2.0 it is possible to show
  36410. * series that use colorAxis by setting this option to `true`.
  36411. */
  36412. showInLegend?: boolean;
  36413. /**
  36414. * (Highstock) Whether or not to show the series in the navigator. Takes
  36415. * precedence over navigator.baseSeries if defined.
  36416. */
  36417. showInNavigator?: boolean;
  36418. /**
  36419. * (Highcharts, Highstock) If set to `true`, the accessibility module will
  36420. * skip past the points in this series for keyboard navigation.
  36421. */
  36422. skipKeyboardNavigation?: boolean;
  36423. states?: SeriesStatesOptionsObject;
  36424. /**
  36425. * (Highcharts, Highstock) Sticky tracking of mouse events. When true, the
  36426. * `mouseOut` event on a series isn't triggered until the mouse moves over
  36427. * another series, or out of the plot area. When false, the `mouseOut` event
  36428. * on a series is triggered when the mouse leaves the area around the
  36429. * series' graph or markers. This also implies the tooltip when not shared.
  36430. * When `stickyTracking` is false and `tooltip.shared` is false, the tooltip
  36431. * will be hidden when moving the mouse between series. Defaults to true for
  36432. * line and area type series, but to false for columns, pies etc.
  36433. *
  36434. * **Note:** The boost module will force this option because of technical
  36435. * limitations.
  36436. */
  36437. stickyTracking?: boolean;
  36438. /**
  36439. * (Highcharts, Highstock) A configuration object for the tooltip rendering
  36440. * of each single series. Properties are inherited from tooltip, but only
  36441. * the following properties can be defined on a series level.
  36442. */
  36443. tooltip?: SeriesTooltipOptionsObject;
  36444. /**
  36445. * (Highcharts, Highstock, Gantt) When a series contains a data array that
  36446. * is longer than this, only one dimensional arrays of numbers, or two
  36447. * dimensional arrays with x and y values are allowed. Also, only the first
  36448. * point is tested, and the rest are assumed to be the same format. This
  36449. * saves expensive data checking and indexing in long series. Set it to `0`
  36450. * disable.
  36451. *
  36452. * Note: In boost mode turbo threshold is forced. Only array of numbers or
  36453. * two dimensional arrays are allowed.
  36454. */
  36455. turboThreshold?: number;
  36456. /**
  36457. * (Highcharts, Highstock) Set the initial visibility of the series.
  36458. */
  36459. visible?: boolean;
  36460. /**
  36461. * (Highmaps) Define the z index of the series.
  36462. */
  36463. zIndex?: number;
  36464. /**
  36465. * (Highcharts, Highstock) Defines the Axis on which the zones are applied.
  36466. */
  36467. zoneAxis?: string;
  36468. /**
  36469. * (Highcharts, Highstock) An array defining zones within a series. Zones
  36470. * can be applied to the X axis, Y axis or Z axis for bubbles, according to
  36471. * the `zoneAxis` option. The zone definitions have to be in ascending order
  36472. * regarding to the value.
  36473. *
  36474. * In styled mode, the color zones are styled with the
  36475. * `.highcharts-zone-{n}` class, or custom classed from the `className`
  36476. * option (view live demo).
  36477. */
  36478. zones?: Array<SeriesZonesOptionsObject>;
  36479. }
  36480. /**
  36481. * (Highcharts) Enable or disable the initial animation when a series is
  36482. * displayed. The animation can also be set as a configuration object. Please
  36483. * note that this option only applies to the initial animation of the series
  36484. * itself. For other animations, see chart.animation and the animation parameter
  36485. * under the API methods. The following properties are supported:
  36486. *
  36487. * - `defer`: The animation delay time in milliseconds.
  36488. *
  36489. * - `duration`: The duration of the animation in milliseconds.
  36490. *
  36491. * - `easing`: Can be a string reference to an easing function set on the `Math`
  36492. * object or a function. See the _Custom easing function_ demo below.
  36493. *
  36494. * Due to poor performance, animation is disabled in old IE browsers for several
  36495. * chart types.
  36496. */
  36497. export interface PlotCylinderAnimationOptions {
  36498. defer?: number;
  36499. }
  36500. /**
  36501. * (Highcharts, Highstock, Highmaps, Gantt) Enable or disable the initial
  36502. * animation when a series is displayed for the `dataLabels`. The animation can
  36503. * also be set as a configuration object. Please note that this option only
  36504. * applies to the initial animation. For other animations, see chart.animation
  36505. * and the animation parameter under the API methods. The following properties
  36506. * are supported:
  36507. *
  36508. * - `defer`: The animation delay time in milliseconds.
  36509. */
  36510. export interface PlotCylinderDataLabelsAnimationOptions {
  36511. /**
  36512. * (Highcharts, Highstock, Highmaps, Gantt) The animation delay time in
  36513. * milliseconds. Set to `0` renders dataLabel immediately. As `undefined`
  36514. * inherits defer time from the series.animation.defer.
  36515. */
  36516. defer?: number;
  36517. }
  36518. /**
  36519. * (Highcharts, Highstock, Highmaps, Gantt) Options for the series data labels,
  36520. * appearing next to each data point.
  36521. *
  36522. * Since v6.2.0, multiple data labels can be applied to each single point by
  36523. * defining them as an array of configs.
  36524. *
  36525. * In styled mode, the data labels can be styled with the
  36526. * `.highcharts-data-label-box` and `.highcharts-data-label` class names (see
  36527. * example).
  36528. */
  36529. export interface PlotCylinderDataLabelsOptions {
  36530. /**
  36531. * (Highcharts, Highstock, Highmaps, Gantt) The alignment of the data label
  36532. * compared to the point. If `right`, the right side of the label should be
  36533. * touching the point. For points with an extent, like columns, the
  36534. * alignments also dictates how to align it inside the box, as given with
  36535. * the inside option. Can be one of `left`, `center` or `right`.
  36536. */
  36537. align?: string;
  36538. /**
  36539. * (Highcharts, Highstock, Highmaps, Gantt) Whether to allow data labels to
  36540. * overlap. To make the labels less sensitive for overlapping, the
  36541. * dataLabels.padding can be set to 0.
  36542. */
  36543. allowOverlap?: boolean;
  36544. /**
  36545. * (Highcharts, Highstock, Highmaps, Gantt) Enable or disable the initial
  36546. * animation when a series is displayed for the `dataLabels`. The animation
  36547. * can also be set as a configuration object. Please note that this option
  36548. * only applies to the initial animation. For other animations, see
  36549. * chart.animation and the animation parameter under the API methods. The
  36550. * following properties are supported:
  36551. *
  36552. * - `defer`: The animation delay time in milliseconds.
  36553. */
  36554. animation?: (boolean|PlotCylinderDataLabelsAnimationOptions|Partial<AnimationOptionsObject>);
  36555. /**
  36556. * (Highcharts, Highstock, Highmaps, Gantt) The background color or gradient
  36557. * for the data label.
  36558. */
  36559. backgroundColor?: (ColorString|GradientColorObject|PatternObject);
  36560. /**
  36561. * (Highcharts, Highstock, Highmaps, Gantt) The border color for the data
  36562. * label. Defaults to `undefined`.
  36563. */
  36564. borderColor?: (ColorString|GradientColorObject|PatternObject);
  36565. /**
  36566. * (Highcharts, Highstock, Highmaps, Gantt) The border radius in pixels for
  36567. * the data label.
  36568. */
  36569. borderRadius?: number;
  36570. /**
  36571. * (Highcharts, Highstock, Highmaps, Gantt) The border width in pixels for
  36572. * the data label.
  36573. */
  36574. borderWidth?: number;
  36575. /**
  36576. * (Highcharts, Highstock, Highmaps, Gantt) A class name for the data label.
  36577. * Particularly in styled mode, this can be used to give each series' or
  36578. * point's data label unique styling. In addition to this option, a default
  36579. * color class name is added so that we can give the labels a contrast text
  36580. * shadow.
  36581. */
  36582. className?: string;
  36583. /**
  36584. * (Highcharts, Highstock, Highmaps, Gantt) The text color for the data
  36585. * labels. Defaults to `undefined`. For certain series types, like column or
  36586. * map, the data labels can be drawn inside the points. In this case the
  36587. * data label will be drawn with maximum contrast by default. Additionally,
  36588. * it will be given a `text-outline` style with the opposite color, to
  36589. * further increase the contrast. This can be overridden by setting the
  36590. * `text-outline` style to `none` in the `dataLabels.style` option.
  36591. */
  36592. color?: (ColorString|GradientColorObject|PatternObject);
  36593. /**
  36594. * (Highcharts, Highstock, Highmaps, Gantt) Whether to hide data labels that
  36595. * are outside the plot area. By default, the data label is moved inside the
  36596. * plot area according to the overflow option.
  36597. */
  36598. crop?: boolean;
  36599. /**
  36600. * (Highcharts, Highstock, Gantt) Whether to defer displaying the data
  36601. * labels until the initial series animation has finished. Setting to
  36602. * `false` renders the data label immediately. If set to `true` inherits the
  36603. * defer time set in plotOptions.series.animation.
  36604. */
  36605. defer?: boolean;
  36606. /**
  36607. * (Highcharts, Highstock, Highmaps, Gantt) Enable or disable the data
  36608. * labels.
  36609. */
  36610. enabled?: boolean;
  36611. /**
  36612. * (Highcharts, Highstock, Highmaps, Gantt) A declarative filter to control
  36613. * of which data labels to display. The declarative filter is designed for
  36614. * use when callback functions are not available, like when the chart
  36615. * options require a pure JSON structure or for use with graphical editors.
  36616. * For programmatic control, use the `formatter` instead, and return
  36617. * `undefined` to disable a single data label.
  36618. */
  36619. filter?: DataLabelsFilterOptionsObject;
  36620. /**
  36621. * (Highcharts, Highstock, Highmaps, Gantt) A format string for the data
  36622. * label. Available variables are the same as for `formatter`.
  36623. */
  36624. format?: string;
  36625. /**
  36626. * (Highcharts, Highstock, Highmaps, Gantt) Callback JavaScript function to
  36627. * format the data label. Note that if a `format` is defined, the format
  36628. * takes precedence and the formatter is ignored.
  36629. */
  36630. formatter?: DataLabelsFormatterCallbackFunction;
  36631. /**
  36632. * (Highcharts, Highstock, Highmaps, Gantt) For points with an extent, like
  36633. * columns or map areas, whether to align the data label inside the box or
  36634. * to the actual value point. Defaults to `false` in most cases, `true` in
  36635. * stacked columns.
  36636. */
  36637. inside?: boolean;
  36638. /**
  36639. * (Highcharts, Highstock, Highmaps, Gantt) Format for points with the value
  36640. * of null. Works analogously to format. `nullFormat` can be applied only to
  36641. * series which support displaying null points.
  36642. */
  36643. nullFormat?: (boolean|string);
  36644. /**
  36645. * (Highcharts, Highstock, Highmaps, Gantt) Callback JavaScript function
  36646. * that defines formatting for points with the value of null. Works
  36647. * analogously to formatter. `nullPointFormatter` can be applied only to
  36648. * series which support displaying null points.
  36649. */
  36650. nullFormatter?: DataLabelsFormatterCallbackFunction;
  36651. /**
  36652. * (Highcharts, Highstock, Highmaps, Gantt) How to handle data labels that
  36653. * flow outside the plot area. The default is `"justify"`, which aligns them
  36654. * inside the plot area. For columns and bars, this means it will be moved
  36655. * inside the bar. To display data labels outside the plot area, set `crop`
  36656. * to `false` and `overflow` to `"allow"`.
  36657. */
  36658. overflow?: DataLabelsOverflowValue;
  36659. /**
  36660. * (Highcharts, Highstock, Highmaps, Gantt) When either the `borderWidth` or
  36661. * the `backgroundColor` is set, this is the padding within the box.
  36662. */
  36663. padding?: number;
  36664. /**
  36665. * (Highcharts, Highstock, Highmaps, Gantt) Aligns data labels relative to
  36666. * points. If `center` alignment is not possible, it defaults to `right`.
  36667. */
  36668. position?: AlignValue;
  36669. /**
  36670. * (Highcharts, Highstock, Highmaps, Gantt) Text rotation in degrees. Note
  36671. * that due to a more complex structure, backgrounds, borders and padding
  36672. * will be lost on a rotated data label.
  36673. */
  36674. rotation?: number;
  36675. /**
  36676. * (Highcharts, Highstock, Highmaps, Gantt) The shadow of the box. Works
  36677. * best with `borderWidth` or `backgroundColor`. Since 2.3 the shadow can be
  36678. * an object configuration containing `color`, `offsetX`, `offsetY`,
  36679. * `opacity` and `width`.
  36680. */
  36681. shadow?: (boolean|ShadowOptionsObject);
  36682. /**
  36683. * (Highcharts, Highstock, Highmaps, Gantt) The name of a symbol to use for
  36684. * the border around the label. Symbols are predefined functions on the
  36685. * Renderer object.
  36686. */
  36687. shape?: string;
  36688. /**
  36689. * (Highcharts, Highstock, Highmaps, Gantt) Styles for the label. The
  36690. * default `color` setting is `"contrast"`, which is a pseudo color that
  36691. * Highcharts picks up and applies the maximum contrast to the underlying
  36692. * point item, for example the bar in a bar chart.
  36693. *
  36694. * The `textOutline` is a pseudo property that applies an outline of the
  36695. * given width with the given color, which by default is the maximum
  36696. * contrast to the text. So a bright text color will result in a black text
  36697. * outline for maximum readability on a mixed background. In some cases,
  36698. * especially with grayscale text, the text outline doesn't work well, in
  36699. * which cases it can be disabled by setting it to `"none"`. When `useHTML`
  36700. * is true, the `textOutline` will not be picked up. In this, case, the same
  36701. * effect can be acheived through the `text-shadow` CSS property.
  36702. *
  36703. * For some series types, where each point has an extent, like for example
  36704. * tree maps, the data label may overflow the point. There are two
  36705. * strategies for handling overflow. By default, the text will wrap to
  36706. * multiple lines. The other strategy is to set `style.textOverflow` to
  36707. * `ellipsis`, which will keep the text on one line plus it will break
  36708. * inside long words.
  36709. */
  36710. style?: CSSObject;
  36711. /**
  36712. * (Highcharts, Highstock, Highmaps, Gantt) Options for a label text which
  36713. * should follow marker's shape. Border and background are disabled for a
  36714. * label that follows a path.
  36715. *
  36716. * **Note:** Only SVG-based renderer supports this option. Setting `useHTML`
  36717. * to true will disable this option.
  36718. */
  36719. textPath?: DataLabelsTextPathOptionsObject;
  36720. /**
  36721. * (Highcharts, Highstock, Highmaps, Gantt) Whether to use HTML to render
  36722. * the labels.
  36723. */
  36724. useHTML?: boolean;
  36725. /**
  36726. * (Highcharts, Highstock, Highmaps, Gantt) The vertical alignment of a data
  36727. * label. Can be one of `top`, `middle` or `bottom`. The default value
  36728. * depends on the data, for instance in a column chart, the label is above
  36729. * positive values and below negative values.
  36730. */
  36731. verticalAlign?: string;
  36732. /**
  36733. * (Highcharts, Highstock, Highmaps, Gantt) The x position offset of the
  36734. * label relative to the point in pixels.
  36735. */
  36736. x?: number;
  36737. /**
  36738. * (Highcharts, Highstock, Highmaps, Gantt) The y position offset of the
  36739. * label relative to the point in pixels.
  36740. */
  36741. y?: number;
  36742. /**
  36743. * (Highcharts, Highstock, Highmaps, Gantt) The Z index of the data labels.
  36744. * The default Z index puts it above the series. Use a Z index of 2 to
  36745. * display it behind the series.
  36746. */
  36747. z?: number;
  36748. }
  36749. /**
  36750. * (Highcharts, Highstock) Options for the series data sorting.
  36751. */
  36752. export interface PlotCylinderDataSortingOptions {
  36753. /**
  36754. * (Highcharts, Highstock) Enable or disable data sorting for the series.
  36755. * Use xAxis.reversed to change the sorting order.
  36756. */
  36757. enabled?: boolean;
  36758. /**
  36759. * (Highcharts, Highstock) Whether to allow matching points by name in an
  36760. * update. If this option is disabled, points will be matched by order.
  36761. */
  36762. matchByName?: boolean;
  36763. /**
  36764. * (Highcharts, Highstock) Determines what data value should be used to sort
  36765. * by.
  36766. */
  36767. sortKey?: string;
  36768. }
  36769. /**
  36770. * (Highcharts) A cylinder graph is a variation of a 3d column graph. The
  36771. * cylinder graph features cylindrical points.
  36772. *
  36773. * In TypeScript the type option must always be set.
  36774. *
  36775. * Configuration options for the series are given in three levels:
  36776. *
  36777. * 1. Options for all series in a chart are defined in the plotOptions.series
  36778. * object.
  36779. *
  36780. * 2. Options for all `cylinder` series are defined in plotOptions.cylinder.
  36781. *
  36782. * 3. Options for one single series are given in the series instance array. (see
  36783. * online documentation for example)
  36784. */
  36785. export interface PlotCylinderOptions {
  36786. /**
  36787. * (Highcharts) Accessibility options for a series.
  36788. */
  36789. accessibility?: SeriesAccessibilityOptionsObject;
  36790. /**
  36791. * (Highcharts) Allow this series' points to be selected by clicking on the
  36792. * graphic (columns, point markers, pie slices, map areas etc).
  36793. *
  36794. * The selected points can be handled by point select and unselect events,
  36795. * or collectively by the getSelectedPoints function.
  36796. *
  36797. * And alternative way of selecting points is through dragging.
  36798. */
  36799. allowPointSelect?: boolean;
  36800. /**
  36801. * (Highcharts) Enable or disable the initial animation when a series is
  36802. * displayed. The animation can also be set as a configuration object.
  36803. * Please note that this option only applies to the initial animation of the
  36804. * series itself. For other animations, see chart.animation and the
  36805. * animation parameter under the API methods. The following properties are
  36806. * supported:
  36807. *
  36808. * - `defer`: The animation delay time in milliseconds.
  36809. *
  36810. * - `duration`: The duration of the animation in milliseconds.
  36811. *
  36812. * - `easing`: Can be a string reference to an easing function set on the
  36813. * `Math` object or a function. See the _Custom easing function_ demo below.
  36814. *
  36815. * Due to poor performance, animation is disabled in old IE browsers for
  36816. * several chart types.
  36817. */
  36818. animation?: (boolean|PlotCylinderAnimationOptions|Partial<AnimationOptionsObject>);
  36819. /**
  36820. * (Highcharts) For some series, there is a limit that shuts down initial
  36821. * animation by default when the total number of points in the chart is too
  36822. * high. For example, for a column chart and its derivatives, animation does
  36823. * not run if there is more than 250 points totally. To disable this cap,
  36824. * set `animationLimit` to `Infinity`.
  36825. */
  36826. animationLimit?: number;
  36827. /**
  36828. * (Highcharts, Highstock, Gantt) The color of the border surrounding each
  36829. * column or bar.
  36830. *
  36831. * In styled mode, the border stroke can be set with the `.highcharts-point`
  36832. * rule.
  36833. */
  36834. borderColor?: (ColorString|GradientColorObject|PatternObject);
  36835. /**
  36836. * (Highcharts, Highstock, Gantt) The corner radius of the border
  36837. * surrounding each column or bar.
  36838. */
  36839. borderRadius?: number;
  36840. /**
  36841. * (Highcharts, Highstock, Gantt) The width of the border surrounding each
  36842. * column or bar. Defaults to `1` when there is room for a border, but to
  36843. * `0` when the columns are so dense that a border would cover the next
  36844. * column.
  36845. *
  36846. * In styled mode, the stroke width can be set with the `.highcharts-point`
  36847. * rule.
  36848. */
  36849. borderWidth?: number;
  36850. /**
  36851. * (Highcharts, Highstock, Gantt) When `true`, the columns will center in
  36852. * the category, ignoring null or missing points. When `false`, space will
  36853. * be reserved for null or missing points.
  36854. */
  36855. centerInCategory?: boolean;
  36856. /**
  36857. * (Highcharts) An additional class name to apply to the series' graphical
  36858. * elements. This option does not replace default class names of the
  36859. * graphical element.
  36860. */
  36861. className?: string;
  36862. /**
  36863. * (Highcharts) Disable this option to allow series rendering in the whole
  36864. * plotting area.
  36865. *
  36866. * **Note:** Clipping should be always enabled when chart.zoomType is set
  36867. */
  36868. clip?: boolean;
  36869. /**
  36870. * (Highcharts) The main color of the series. In line type series it applies
  36871. * to the line and the point markers unless otherwise specified. In bar type
  36872. * series it applies to the bars unless a color is specified per point. The
  36873. * default value is pulled from the `options.colors` array.
  36874. *
  36875. * In styled mode, the color can be defined by the colorIndex option. Also,
  36876. * the series color can be set with the `.highcharts-series`,
  36877. * `.highcharts-color-{n}`, `.highcharts-{type}-series` or
  36878. * `.highcharts-series-{n}` class, or individual classes given by the
  36879. * `className` option.
  36880. */
  36881. color?: (ColorString|GradientColorObject|PatternObject);
  36882. /**
  36883. * (Highcharts, Highstock, Gantt) When using automatic point colors pulled
  36884. * from the global colors or series-specific plotOptions.column.colors
  36885. * collections, this option determines whether the chart should receive one
  36886. * color per series or one color per point.
  36887. *
  36888. * In styled mode, the `colors` or `series.colors` arrays are not supported,
  36889. * and instead this option gives the points individual color class names on
  36890. * the form `highcharts-color-{n}`.
  36891. */
  36892. colorByPoint?: boolean;
  36893. /**
  36894. * (Highcharts) Styled mode only. A specific color index to use for the
  36895. * series, so its graphic representations are given the class name
  36896. * `highcharts-color-{n}`.
  36897. */
  36898. colorIndex?: number;
  36899. /**
  36900. * (Highcharts, Highstock, Highmaps) Determines what data value should be
  36901. * used to calculate point color if `colorAxis` is used. Requires to set
  36902. * `min` and `max` if some custom point property is used or if approximation
  36903. * for data grouping is set to `'sum'`.
  36904. */
  36905. colorKey?: string;
  36906. /**
  36907. * (Highcharts, Highstock, Gantt) A series specific or series type specific
  36908. * color set to apply instead of the global colors when colorByPoint is
  36909. * true.
  36910. */
  36911. colors?: Array<(ColorString|GradientColorObject|PatternObject)>;
  36912. /**
  36913. * (Highstock) Defines if comparison should start from the first point
  36914. * within the visible range or should start from the first point **before**
  36915. * the range.
  36916. *
  36917. * In other words, this flag determines if first point within the visible
  36918. * range will have 0% (`compareStart=true`) or should have been already
  36919. * calculated according to the previous point (`compareStart=false`).
  36920. */
  36921. compareStart?: boolean;
  36922. /**
  36923. * (Gantt) Override Pathfinder connector options for a series. Requires
  36924. * Highcharts Gantt to be loaded.
  36925. */
  36926. connectors?: SeriesConnectorsOptionsObject;
  36927. /**
  36928. * (Highcharts, Highstock, Gantt) When true, each point or column edge is
  36929. * rounded to its nearest pixel in order to render sharp on screen. In some
  36930. * cases, when there are a lot of densely packed columns, this leads to
  36931. * visible difference in column widths or distance between columns. In these
  36932. * cases, setting `crisp` to `false` may look better, even though each
  36933. * column is rendered blurry.
  36934. */
  36935. crisp?: boolean;
  36936. /**
  36937. * (Highcharts, Highstock, Gantt) When the series contains less points than
  36938. * the crop threshold, all points are drawn, event if the points fall
  36939. * outside the visible plot area at the current zoom. The advantage of
  36940. * drawing all points (including markers and columns), is that animation is
  36941. * performed on updates. On the other hand, when the series contains more
  36942. * points than the crop threshold, the series data is cropped to only
  36943. * contain points that fall within the plot area. The advantage of cropping
  36944. * away invisible points is to increase performance on large series.
  36945. */
  36946. cropThreshold?: number;
  36947. /**
  36948. * (Highcharts) You can set the cursor to "pointer" if you have click events
  36949. * attached to the series, to signal to the user that the points and lines
  36950. * can be clicked.
  36951. *
  36952. * In styled mode, the series cursor can be set with the same classes as
  36953. * listed under series.color.
  36954. */
  36955. cursor?: (string|CursorValue);
  36956. /**
  36957. * (Highcharts) A reserved subspace to store options and values for
  36958. * customized functionality. Here you can add additional data for your own
  36959. * event callbacks and formatter callbacks.
  36960. */
  36961. custom?: Dictionary<any>;
  36962. /**
  36963. * (Highcharts) Name of the dash style to use for the graph, or for some
  36964. * series types the outline of each shape.
  36965. *
  36966. * In styled mode, the stroke dash-array can be set with the same classes as
  36967. * listed under series.color.
  36968. */
  36969. dashStyle?: DashStyleValue;
  36970. /**
  36971. * (Highstock) Data grouping is the concept of sampling the data values into
  36972. * larger blocks in order to ease readability and increase performance of
  36973. * the JavaScript charts. Highstock by default applies data grouping when
  36974. * the points become closer than a certain pixel value, determined by the
  36975. * `groupPixelWidth` option.
  36976. *
  36977. * If data grouping is applied, the grouping information of grouped points
  36978. * can be read from the Point.dataGroup. If point options other than the
  36979. * data itself are set, for example `name` or `color` or custom properties,
  36980. * the grouping logic doesn't know how to group it. In this case the options
  36981. * of the first point instance are copied over to the group point. This can
  36982. * be altered through a custom `approximation` callback function.
  36983. */
  36984. dataGrouping?: DataGroupingOptionsObject;
  36985. /**
  36986. * (Highcharts, Highstock, Highmaps, Gantt) Options for the series data
  36987. * labels, appearing next to each data point.
  36988. *
  36989. * Since v6.2.0, multiple data labels can be applied to each single point by
  36990. * defining them as an array of configs.
  36991. *
  36992. * In styled mode, the data labels can be styled with the
  36993. * `.highcharts-data-label-box` and `.highcharts-data-label` class names
  36994. * (see example).
  36995. */
  36996. dataLabels?: (PlotCylinderDataLabelsOptions|Array<PlotCylinderDataLabelsOptions>);
  36997. /**
  36998. * (Highcharts, Highstock) Options for the series data sorting.
  36999. */
  37000. dataSorting?: (DataSortingOptionsObject|PlotCylinderDataSortingOptions);
  37001. /**
  37002. * (Highcharts) Depth of the columns in a 3D column chart.
  37003. */
  37004. depth?: number;
  37005. /**
  37006. * (Highcharts) A description of the series to add to the screen reader
  37007. * information about the series.
  37008. */
  37009. description?: string;
  37010. /**
  37011. * (Highcharts) 3D columns only. The color of the edges. Similar to
  37012. * `borderColor`, except it defaults to the same color as the column.
  37013. */
  37014. edgeColor?: ColorString;
  37015. /**
  37016. * (Highcharts) 3D columns only. The width of the colored edges.
  37017. */
  37018. edgeWidth?: number;
  37019. /**
  37020. * (Highcharts) Enable or disable the mouse tracking for a specific series.
  37021. * This includes point tooltips and click events on graphs and points. For
  37022. * large datasets it improves performance.
  37023. */
  37024. enableMouseTracking?: boolean;
  37025. /**
  37026. * (Highcharts) General event handlers for the series items. These event
  37027. * hooks can also be attached to the series at run time using the
  37028. * `Highcharts.addEvent` function.
  37029. */
  37030. events?: SeriesEventsOptionsObject;
  37031. /**
  37032. * (Highcharts) Determines whether the series should look for the nearest
  37033. * point in both dimensions or just the x-dimension when hovering the
  37034. * series. Defaults to `'xy'` for scatter series and `'x'` for most other
  37035. * series. If the data has duplicate x-values, it is recommended to set this
  37036. * to `'xy'` to allow hovering over all points.
  37037. *
  37038. * Applies only to series types using nearest neighbor search (not direct
  37039. * hover) for tooltip.
  37040. */
  37041. findNearestPointBy?: OptionsFindNearestPointByValue;
  37042. /**
  37043. * (Highcharts, Highstock, Gantt) Whether to use the Y extremes of the total
  37044. * chart width or only the zoomed area when zooming in on parts of the X
  37045. * axis. By default, the Y axis adjusts to the min and max of the visible
  37046. * data. Cartesian series only.
  37047. */
  37048. getExtremesFromAll?: boolean;
  37049. /**
  37050. * (Highcharts, Highstock, Gantt) Whether to group non-stacked columns or to
  37051. * let them render independent of each other. Non-grouped columns will be
  37052. * laid out individually and overlap each other.
  37053. */
  37054. grouping?: boolean;
  37055. /**
  37056. * (Highcharts, Highstock, Gantt) Padding between each value groups, in x
  37057. * axis units.
  37058. */
  37059. groupPadding?: number;
  37060. /**
  37061. * (Highcharts) The spacing between columns on the Z Axis in a 3D chart.
  37062. */
  37063. groupZPadding?: number;
  37064. /**
  37065. * (Highcharts) When set to `false` will prevent the series data from being
  37066. * included in any form of data export.
  37067. *
  37068. * Since version 6.0.0 until 7.1.0 the option was existing undocumented as
  37069. * `includeInCSVExport`.
  37070. */
  37071. includeInDataExport?: boolean;
  37072. /**
  37073. * (Highmaps) What property to join the `mapData` to the value data. For
  37074. * example, if joinBy is "code", the mapData items with a specific code is
  37075. * merged into the data with the same code. For maps loaded from GeoJSON,
  37076. * the keys may be held in each point's `properties` object.
  37077. *
  37078. * The joinBy option can also be an array of two values, where the first
  37079. * points to a key in the `mapData`, and the second points to another key in
  37080. * the `data`.
  37081. *
  37082. * When joinBy is `null`, the map items are joined by their position in the
  37083. * array, which performs much better in maps with many data points. This is
  37084. * the recommended option if you are printing more than a thousand data
  37085. * points and have a backend that can preprocess the data into a parallel
  37086. * array of the mapData.
  37087. */
  37088. joinBy?: (string|Array<string>);
  37089. /**
  37090. * (Highcharts) An array specifying which option maps to which key in the
  37091. * data point array. This makes it convenient to work with unstructured data
  37092. * arrays from different sources.
  37093. */
  37094. keys?: Array<string>;
  37095. /**
  37096. * (Highcharts, Highstock, Gantt) Series labels are placed as close to the
  37097. * series as possible in a natural way, seeking to avoid other series. The
  37098. * goal of this feature is to make the chart more easily readable, like if a
  37099. * human designer placed the labels in the optimal position.
  37100. *
  37101. * The series labels currently work with series types having a `graph` or an
  37102. * `area`.
  37103. */
  37104. label?: SeriesLabelOptionsObject;
  37105. /**
  37106. * (Highstock) The line marks the last price from all points.
  37107. */
  37108. lastPrice?: SeriesLastPriceOptionsObject;
  37109. /**
  37110. * (Highstock) The line marks the last price from visible range of points.
  37111. */
  37112. lastVisiblePrice?: SeriesLastVisiblePriceOptionsObject;
  37113. /**
  37114. * (Highcharts, Highstock, Gantt) The id of another series to link to.
  37115. * Additionally, the value can be ":previous" to link to the previous
  37116. * series. When two series are linked, only the first one appears in the
  37117. * legend. Toggling the visibility of this also toggles the linked series.
  37118. *
  37119. * If master series uses data sorting and linked series does not have its
  37120. * own sorting definition, the linked series will be sorted in the same
  37121. * order as the master one.
  37122. */
  37123. linkedTo?: string;
  37124. /**
  37125. * (Highcharts, Highstock, Gantt) The maximum allowed pixel width for a
  37126. * column, translated to the height of a bar in a bar chart. This prevents
  37127. * the columns from becoming too wide when there is a small number of points
  37128. * in the chart.
  37129. */
  37130. maxPointWidth?: number;
  37131. /**
  37132. * (Highcharts, Highstock, Gantt) The minimal height for a column or width
  37133. * for a bar. By default, 0 values are not shown. To visualize a 0 (or close
  37134. * to zero) point, set the minimal point length to a pixel value like 3\. In
  37135. * stacked column charts, minPointLength might not be respected for tightly
  37136. * packed values.
  37137. */
  37138. minPointLength?: number;
  37139. /**
  37140. * (Highstock) Options for the corresponding navigator series if
  37141. * `showInNavigator` is `true` for this series. Available options are the
  37142. * same as any series, documented at plotOptions and series.
  37143. *
  37144. * These options are merged with options in navigator.series, and will take
  37145. * precedence if the same option is defined both places.
  37146. */
  37147. navigatorOptions?: PlotSeriesOptions;
  37148. /**
  37149. * (Highcharts) The color for the parts of the graph or points that are
  37150. * below the threshold. Note that `zones` takes precedence over the negative
  37151. * color. Using `negativeColor` is equivalent to applying a zone with value
  37152. * of 0.
  37153. */
  37154. negativeColor?: (ColorString|GradientColorObject|PatternObject);
  37155. /**
  37156. * (Highcharts) Opacity of a series parts: line, fill (e.g. area) and
  37157. * dataLabels.
  37158. */
  37159. opacity?: number;
  37160. /**
  37161. * (Highcharts) Properties for each single point.
  37162. */
  37163. point?: PlotSeriesPointOptions;
  37164. /**
  37165. * (Highcharts) Same as accessibility.pointDescriptionFormatter, but for an
  37166. * individual series. Overrides the chart wide configuration.
  37167. */
  37168. pointDescriptionFormatter?: Function;
  37169. /**
  37170. * (Highcharts, Highstock, Gantt) If no x values are given for the points in
  37171. * a series, `pointInterval` defines the interval of the x values. For
  37172. * example, if a series contains one value every decade starting from year
  37173. * 0, set `pointInterval` to `10`. In true `datetime` axes, the
  37174. * `pointInterval` is set in milliseconds.
  37175. *
  37176. * It can be also be combined with `pointIntervalUnit` to draw irregular
  37177. * time intervals.
  37178. *
  37179. * Please note that this options applies to the _series data_, not the
  37180. * interval of the axis ticks, which is independent.
  37181. */
  37182. pointInterval?: number;
  37183. /**
  37184. * (Highcharts, Highstock, Gantt) On datetime series, this allows for
  37185. * setting the pointInterval to irregular time units, `day`, `month` and
  37186. * `year`. A day is usually the same as 24 hours, but `pointIntervalUnit`
  37187. * also takes the DST crossover into consideration when dealing with local
  37188. * time. Combine this option with `pointInterval` to draw weeks, quarters, 6
  37189. * months, 10 years etc.
  37190. *
  37191. * Please note that this options applies to the _series data_, not the
  37192. * interval of the axis ticks, which is independent.
  37193. */
  37194. pointIntervalUnit?: OptionsPointIntervalUnitValue;
  37195. /**
  37196. * (Highcharts, Highstock, Gantt) Padding between each column or bar, in x
  37197. * axis units.
  37198. */
  37199. pointPadding?: number;
  37200. /**
  37201. * (Highcharts, Highstock, Gantt) Possible values: `"on"`, `"between"`,
  37202. * `number`.
  37203. *
  37204. * In a column chart, when pointPlacement is `"on"`, the point will not
  37205. * create any padding of the X axis. In a polar column chart this means that
  37206. * the first column points directly north. If the pointPlacement is
  37207. * `"between"`, the columns will be laid out between ticks. This is useful
  37208. * for example for visualising an amount between two points in time or in a
  37209. * certain sector of a polar chart.
  37210. *
  37211. * Since Highcharts 3.0.2, the point placement can also be numeric, where 0
  37212. * is on the axis value, -0.5 is between this value and the previous, and
  37213. * 0.5 is between this value and the next. Unlike the textual options,
  37214. * numeric point placement options won't affect axis padding.
  37215. *
  37216. * Note that pointPlacement needs a pointRange to work. For column series
  37217. * this is computed, but for line-type series it needs to be set.
  37218. *
  37219. * For the `xrange` series type and gantt charts, if the Y axis is a
  37220. * category axis, the `pointPlacement` applies to the Y axis rather than the
  37221. * (typically datetime) X axis.
  37222. *
  37223. * Defaults to `undefined` in cartesian charts, `"between"` in polar charts.
  37224. */
  37225. pointPlacement?: (number|string);
  37226. /**
  37227. * (Highcharts, Highstock, Gantt) The X axis range that each point is valid
  37228. * for. This determines the width of the column. On a categorized axis, the
  37229. * range will be 1 by default (one category unit). On linear and datetime
  37230. * axes, the range will be computed as the distance between the two closest
  37231. * data points.
  37232. *
  37233. * The default `null` means it is computed automatically, but this option
  37234. * can be used to override the automatic value.
  37235. *
  37236. * This option is set by default to 1 if data sorting is enabled.
  37237. */
  37238. pointRange?: (number|null);
  37239. /**
  37240. * (Highcharts, Highstock, Gantt) If no x values are given for the points in
  37241. * a series, pointStart defines on what value to start. For example, if a
  37242. * series contains one yearly value starting from 1945, set pointStart to
  37243. * 1945.
  37244. */
  37245. pointStart?: number;
  37246. /**
  37247. * (Highcharts, Highstock, Gantt) A pixel value specifying a fixed width for
  37248. * each column or bar point. When set to `undefined`, the width is
  37249. * calculated from the `pointPadding` and `groupPadding`. The width effects
  37250. * the dimension that is not based on the point value. For column series it
  37251. * is the hoizontal length and for bar series it is the vertical length.
  37252. */
  37253. pointWidth?: number;
  37254. /**
  37255. * (Highcharts) Whether to select the series initially. If `showCheckbox` is
  37256. * true, the checkbox next to the series name in the legend will be checked
  37257. * for a selected series.
  37258. */
  37259. selected?: boolean;
  37260. /**
  37261. * (Highcharts) Whether to apply a drop shadow to the graph line. Since 2.3
  37262. * the shadow can be an object configuration containing `color`, `offsetX`,
  37263. * `offsetY`, `opacity` and `width`.
  37264. */
  37265. shadow?: (boolean|ShadowOptionsObject);
  37266. /**
  37267. * (Highcharts) If true, a checkbox is displayed next to the legend item to
  37268. * allow selecting the series. The state of the checkbox is determined by
  37269. * the `selected` option.
  37270. */
  37271. showCheckbox?: boolean;
  37272. /**
  37273. * (Highcharts) Whether to display this particular series or series type in
  37274. * the legend. Standalone series are shown in legend by default, and linked
  37275. * series are not. Since v7.2.0 it is possible to show series that use
  37276. * colorAxis by setting this option to `true`.
  37277. */
  37278. showInLegend?: boolean;
  37279. /**
  37280. * (Highstock) Whether or not to show the series in the navigator. Takes
  37281. * precedence over navigator.baseSeries if defined.
  37282. */
  37283. showInNavigator?: boolean;
  37284. /**
  37285. * (Highcharts) If set to `true`, the accessibility module will skip past
  37286. * the points in this series for keyboard navigation.
  37287. */
  37288. skipKeyboardNavigation?: boolean;
  37289. /**
  37290. * (Highcharts, Highstock) When this is true, the series will not cause the
  37291. * Y axis to cross the zero plane (or threshold option) unless the data
  37292. * actually crosses the plane.
  37293. *
  37294. * For example, if `softThreshold` is `false`, a series of 0, 1, 2, 3 will
  37295. * make the Y axis show negative values according to the `minPadding`
  37296. * option. If `softThreshold` is `true`, the Y axis starts at 0.
  37297. */
  37298. softThreshold?: boolean;
  37299. /**
  37300. * (Highcharts, Highstock) Whether to stack the values of each series on top
  37301. * of each other. Possible values are `undefined` to disable, `"normal"` to
  37302. * stack by value or `"percent"`.
  37303. *
  37304. * When stacking is enabled, data must be sorted in ascending X order.
  37305. *
  37306. * Some stacking options are related to specific series types. In the
  37307. * streamgraph series type, the stacking option is set to `"stream"`. The
  37308. * second one is `"overlap"`, which only applies to waterfall series.
  37309. */
  37310. stacking?: OptionsStackingValue;
  37311. states?: SeriesStatesOptionsObject;
  37312. /**
  37313. * (Highcharts) Sticky tracking of mouse events. When true, the `mouseOut`
  37314. * event on a series isn't triggered until the mouse moves over another
  37315. * series, or out of the plot area. When false, the `mouseOut` event on a
  37316. * series is triggered when the mouse leaves the area around the series'
  37317. * graph or markers. This also implies the tooltip when not shared. When
  37318. * `stickyTracking` is false and `tooltip.shared` is false, the tooltip will
  37319. * be hidden when moving the mouse between series. Defaults to true for line
  37320. * and area type series, but to false for columns, pies etc.
  37321. *
  37322. * **Note:** The boost module will force this option because of technical
  37323. * limitations.
  37324. */
  37325. stickyTracking?: boolean;
  37326. /**
  37327. * (Highcharts) The Y axis value to serve as the base for the columns, for
  37328. * distinguishing between values above and below a threshold. If `null`, the
  37329. * columns extend from the padding Y axis minimum.
  37330. */
  37331. threshold?: (number|null);
  37332. /**
  37333. * (Highcharts) A configuration object for the tooltip rendering of each
  37334. * single series. Properties are inherited from tooltip, but only the
  37335. * following properties can be defined on a series level.
  37336. */
  37337. tooltip?: SeriesTooltipOptionsObject;
  37338. /**
  37339. * (Highcharts, Highstock, Gantt) When a series contains a data array that
  37340. * is longer than this, only one dimensional arrays of numbers, or two
  37341. * dimensional arrays with x and y values are allowed. Also, only the first
  37342. * point is tested, and the rest are assumed to be the same format. This
  37343. * saves expensive data checking and indexing in long series. Set it to `0`
  37344. * disable.
  37345. *
  37346. * Note: In boost mode turbo threshold is forced. Only array of numbers or
  37347. * two dimensional arrays are allowed.
  37348. */
  37349. turboThreshold?: number;
  37350. /**
  37351. * (Highcharts) Set the initial visibility of the series.
  37352. */
  37353. visible?: boolean;
  37354. /**
  37355. * (Highmaps) Define the z index of the series.
  37356. */
  37357. zIndex?: number;
  37358. /**
  37359. * (Highcharts, Highstock) Defines the Axis on which the zones are applied.
  37360. */
  37361. zoneAxis?: string;
  37362. /**
  37363. * (Highcharts, Highstock) An array defining zones within a series. Zones
  37364. * can be applied to the X axis, Y axis or Z axis for bubbles, according to
  37365. * the `zoneAxis` option. The zone definitions have to be in ascending order
  37366. * regarding to the value.
  37367. *
  37368. * In styled mode, the color zones are styled with the
  37369. * `.highcharts-zone-{n}` class, or custom classed from the `className`
  37370. * option (view live demo).
  37371. */
  37372. zones?: Array<SeriesZonesOptionsObject>;
  37373. }
  37374. /**
  37375. * (Highstock) Enable or disable the initial animation when a series is
  37376. * displayed. The animation can also be set as a configuration object. Please
  37377. * note that this option only applies to the initial animation of the series
  37378. * itself. For other animations, see chart.animation and the animation parameter
  37379. * under the API methods. The following properties are supported:
  37380. *
  37381. * - `defer`: The animation delay time in milliseconds.
  37382. *
  37383. * - `duration`: The duration of the animation in milliseconds.
  37384. *
  37385. * - `easing`: Can be a string reference to an easing function set on the `Math`
  37386. * object or a function. See the _Custom easing function_ demo below.
  37387. *
  37388. * Due to poor performance, animation is disabled in old IE browsers for several
  37389. * chart types.
  37390. */
  37391. export interface PlotDemaAnimationOptions {
  37392. defer?: number;
  37393. }
  37394. /**
  37395. * (Highcharts, Highstock, Highmaps, Gantt) Enable or disable the initial
  37396. * animation when a series is displayed for the `dataLabels`. The animation can
  37397. * also be set as a configuration object. Please note that this option only
  37398. * applies to the initial animation. For other animations, see chart.animation
  37399. * and the animation parameter under the API methods. The following properties
  37400. * are supported:
  37401. *
  37402. * - `defer`: The animation delay time in milliseconds.
  37403. */
  37404. export interface PlotDemaDataLabelsAnimationOptions {
  37405. /**
  37406. * (Highcharts, Highstock, Highmaps, Gantt) The animation delay time in
  37407. * milliseconds. Set to `0` renders dataLabel immediately. As `undefined`
  37408. * inherits defer time from the series.animation.defer.
  37409. */
  37410. defer?: number;
  37411. }
  37412. /**
  37413. * (Highcharts, Highstock, Highmaps, Gantt) Options for the series data labels,
  37414. * appearing next to each data point.
  37415. *
  37416. * Since v6.2.0, multiple data labels can be applied to each single point by
  37417. * defining them as an array of configs.
  37418. *
  37419. * In styled mode, the data labels can be styled with the
  37420. * `.highcharts-data-label-box` and `.highcharts-data-label` class names (see
  37421. * example).
  37422. */
  37423. export interface PlotDemaDataLabelsOptions {
  37424. /**
  37425. * (Highcharts, Highstock, Highmaps, Gantt) The alignment of the data label
  37426. * compared to the point. If `right`, the right side of the label should be
  37427. * touching the point. For points with an extent, like columns, the
  37428. * alignments also dictates how to align it inside the box, as given with
  37429. * the inside option. Can be one of `left`, `center` or `right`.
  37430. */
  37431. align?: (AlignValue|null);
  37432. /**
  37433. * (Highcharts, Highstock, Highmaps, Gantt) Whether to allow data labels to
  37434. * overlap. To make the labels less sensitive for overlapping, the
  37435. * dataLabels.padding can be set to 0.
  37436. */
  37437. allowOverlap?: boolean;
  37438. /**
  37439. * (Highcharts, Highstock, Highmaps, Gantt) Enable or disable the initial
  37440. * animation when a series is displayed for the `dataLabels`. The animation
  37441. * can also be set as a configuration object. Please note that this option
  37442. * only applies to the initial animation. For other animations, see
  37443. * chart.animation and the animation parameter under the API methods. The
  37444. * following properties are supported:
  37445. *
  37446. * - `defer`: The animation delay time in milliseconds.
  37447. */
  37448. animation?: (boolean|PlotDemaDataLabelsAnimationOptions|Partial<AnimationOptionsObject>);
  37449. /**
  37450. * (Highcharts, Highstock, Highmaps, Gantt) The background color or gradient
  37451. * for the data label.
  37452. */
  37453. backgroundColor?: (ColorString|GradientColorObject|PatternObject);
  37454. /**
  37455. * (Highcharts, Highstock, Highmaps, Gantt) The border color for the data
  37456. * label. Defaults to `undefined`.
  37457. */
  37458. borderColor?: (ColorString|GradientColorObject|PatternObject);
  37459. /**
  37460. * (Highcharts, Highstock, Highmaps, Gantt) The border radius in pixels for
  37461. * the data label.
  37462. */
  37463. borderRadius?: number;
  37464. /**
  37465. * (Highcharts, Highstock, Highmaps, Gantt) The border width in pixels for
  37466. * the data label.
  37467. */
  37468. borderWidth?: number;
  37469. /**
  37470. * (Highcharts, Highstock, Highmaps, Gantt) A class name for the data label.
  37471. * Particularly in styled mode, this can be used to give each series' or
  37472. * point's data label unique styling. In addition to this option, a default
  37473. * color class name is added so that we can give the labels a contrast text
  37474. * shadow.
  37475. */
  37476. className?: string;
  37477. /**
  37478. * (Highcharts, Highstock, Highmaps, Gantt) The text color for the data
  37479. * labels. Defaults to `undefined`. For certain series types, like column or
  37480. * map, the data labels can be drawn inside the points. In this case the
  37481. * data label will be drawn with maximum contrast by default. Additionally,
  37482. * it will be given a `text-outline` style with the opposite color, to
  37483. * further increase the contrast. This can be overridden by setting the
  37484. * `text-outline` style to `none` in the `dataLabels.style` option.
  37485. */
  37486. color?: (ColorString|GradientColorObject|PatternObject);
  37487. /**
  37488. * (Highcharts, Highstock, Highmaps, Gantt) Whether to hide data labels that
  37489. * are outside the plot area. By default, the data label is moved inside the
  37490. * plot area according to the overflow option.
  37491. */
  37492. crop?: boolean;
  37493. /**
  37494. * (Highcharts, Highstock, Gantt) Whether to defer displaying the data
  37495. * labels until the initial series animation has finished. Setting to
  37496. * `false` renders the data label immediately. If set to `true` inherits the
  37497. * defer time set in plotOptions.series.animation.
  37498. */
  37499. defer?: boolean;
  37500. /**
  37501. * (Highcharts, Highstock, Highmaps, Gantt) Enable or disable the data
  37502. * labels.
  37503. */
  37504. enabled?: boolean;
  37505. /**
  37506. * (Highcharts, Highstock, Highmaps, Gantt) A declarative filter to control
  37507. * of which data labels to display. The declarative filter is designed for
  37508. * use when callback functions are not available, like when the chart
  37509. * options require a pure JSON structure or for use with graphical editors.
  37510. * For programmatic control, use the `formatter` instead, and return
  37511. * `undefined` to disable a single data label.
  37512. */
  37513. filter?: DataLabelsFilterOptionsObject;
  37514. /**
  37515. * (Highcharts, Highstock, Highmaps, Gantt) A format string for the data
  37516. * label. Available variables are the same as for `formatter`.
  37517. */
  37518. format?: string;
  37519. /**
  37520. * (Highcharts, Highstock, Highmaps, Gantt) Callback JavaScript function to
  37521. * format the data label. Note that if a `format` is defined, the format
  37522. * takes precedence and the formatter is ignored.
  37523. */
  37524. formatter?: DataLabelsFormatterCallbackFunction;
  37525. /**
  37526. * (Highcharts, Highstock, Highmaps, Gantt) For points with an extent, like
  37527. * columns or map areas, whether to align the data label inside the box or
  37528. * to the actual value point. Defaults to `false` in most cases, `true` in
  37529. * stacked columns.
  37530. */
  37531. inside?: boolean;
  37532. /**
  37533. * (Highcharts, Highstock, Highmaps, Gantt) Format for points with the value
  37534. * of null. Works analogously to format. `nullFormat` can be applied only to
  37535. * series which support displaying null points.
  37536. */
  37537. nullFormat?: (boolean|string);
  37538. /**
  37539. * (Highcharts, Highstock, Highmaps, Gantt) Callback JavaScript function
  37540. * that defines formatting for points with the value of null. Works
  37541. * analogously to formatter. `nullPointFormatter` can be applied only to
  37542. * series which support displaying null points.
  37543. */
  37544. nullFormatter?: DataLabelsFormatterCallbackFunction;
  37545. /**
  37546. * (Highcharts, Highstock, Highmaps, Gantt) How to handle data labels that
  37547. * flow outside the plot area. The default is `"justify"`, which aligns them
  37548. * inside the plot area. For columns and bars, this means it will be moved
  37549. * inside the bar. To display data labels outside the plot area, set `crop`
  37550. * to `false` and `overflow` to `"allow"`.
  37551. */
  37552. overflow?: DataLabelsOverflowValue;
  37553. /**
  37554. * (Highcharts, Highstock, Highmaps, Gantt) When either the `borderWidth` or
  37555. * the `backgroundColor` is set, this is the padding within the box.
  37556. */
  37557. padding?: number;
  37558. /**
  37559. * (Highcharts, Highstock, Highmaps, Gantt) Aligns data labels relative to
  37560. * points. If `center` alignment is not possible, it defaults to `right`.
  37561. */
  37562. position?: AlignValue;
  37563. /**
  37564. * (Highcharts, Highstock, Highmaps, Gantt) Text rotation in degrees. Note
  37565. * that due to a more complex structure, backgrounds, borders and padding
  37566. * will be lost on a rotated data label.
  37567. */
  37568. rotation?: number;
  37569. /**
  37570. * (Highcharts, Highstock, Highmaps, Gantt) The shadow of the box. Works
  37571. * best with `borderWidth` or `backgroundColor`. Since 2.3 the shadow can be
  37572. * an object configuration containing `color`, `offsetX`, `offsetY`,
  37573. * `opacity` and `width`.
  37574. */
  37575. shadow?: (boolean|ShadowOptionsObject);
  37576. /**
  37577. * (Highcharts, Highstock, Highmaps, Gantt) The name of a symbol to use for
  37578. * the border around the label. Symbols are predefined functions on the
  37579. * Renderer object.
  37580. */
  37581. shape?: string;
  37582. /**
  37583. * (Highcharts, Highstock, Highmaps, Gantt) Styles for the label. The
  37584. * default `color` setting is `"contrast"`, which is a pseudo color that
  37585. * Highcharts picks up and applies the maximum contrast to the underlying
  37586. * point item, for example the bar in a bar chart.
  37587. *
  37588. * The `textOutline` is a pseudo property that applies an outline of the
  37589. * given width with the given color, which by default is the maximum
  37590. * contrast to the text. So a bright text color will result in a black text
  37591. * outline for maximum readability on a mixed background. In some cases,
  37592. * especially with grayscale text, the text outline doesn't work well, in
  37593. * which cases it can be disabled by setting it to `"none"`. When `useHTML`
  37594. * is true, the `textOutline` will not be picked up. In this, case, the same
  37595. * effect can be acheived through the `text-shadow` CSS property.
  37596. *
  37597. * For some series types, where each point has an extent, like for example
  37598. * tree maps, the data label may overflow the point. There are two
  37599. * strategies for handling overflow. By default, the text will wrap to
  37600. * multiple lines. The other strategy is to set `style.textOverflow` to
  37601. * `ellipsis`, which will keep the text on one line plus it will break
  37602. * inside long words.
  37603. */
  37604. style?: CSSObject;
  37605. /**
  37606. * (Highcharts, Highstock, Highmaps, Gantt) Options for a label text which
  37607. * should follow marker's shape. Border and background are disabled for a
  37608. * label that follows a path.
  37609. *
  37610. * **Note:** Only SVG-based renderer supports this option. Setting `useHTML`
  37611. * to true will disable this option.
  37612. */
  37613. textPath?: DataLabelsTextPathOptionsObject;
  37614. /**
  37615. * (Highcharts, Highstock, Highmaps, Gantt) Whether to use HTML to render
  37616. * the labels.
  37617. */
  37618. useHTML?: boolean;
  37619. /**
  37620. * (Highcharts, Highstock, Highmaps, Gantt) The vertical alignment of a data
  37621. * label. Can be one of `top`, `middle` or `bottom`. The default value
  37622. * depends on the data, for instance in a column chart, the label is above
  37623. * positive values and below negative values.
  37624. */
  37625. verticalAlign?: (VerticalAlignValue|null);
  37626. /**
  37627. * (Highcharts, Highstock, Highmaps, Gantt) The x position offset of the
  37628. * label relative to the point in pixels.
  37629. */
  37630. x?: number;
  37631. /**
  37632. * (Highcharts, Highstock, Highmaps, Gantt) The y position offset of the
  37633. * label relative to the point in pixels.
  37634. */
  37635. y?: number;
  37636. /**
  37637. * (Highcharts, Highstock, Highmaps, Gantt) The Z index of the data labels.
  37638. * The default Z index puts it above the series. Use a Z index of 2 to
  37639. * display it behind the series.
  37640. */
  37641. z?: number;
  37642. }
  37643. /**
  37644. * (Highcharts, Highstock) Options for the series data sorting.
  37645. */
  37646. export interface PlotDemaDataSortingOptions {
  37647. /**
  37648. * (Highcharts, Highstock) Enable or disable data sorting for the series.
  37649. * Use xAxis.reversed to change the sorting order.
  37650. */
  37651. enabled?: boolean;
  37652. /**
  37653. * (Highcharts, Highstock) Whether to allow matching points by name in an
  37654. * update. If this option is disabled, points will be matched by order.
  37655. */
  37656. matchByName?: boolean;
  37657. /**
  37658. * (Highcharts, Highstock) Determines what data value should be used to sort
  37659. * by.
  37660. */
  37661. sortKey?: string;
  37662. }
  37663. /**
  37664. * (Highstock) Double exponential moving average (DEMA) indicator. This series
  37665. * requires `linkedTo` option to be set and should be loaded after the
  37666. * `stock/indicators/indicators.js` and `stock/indicators/ema.js`.
  37667. *
  37668. * In TypeScript the type option must always be set.
  37669. *
  37670. * Configuration options for the series are given in three levels:
  37671. *
  37672. * 1. Options for all series in a chart are defined in the plotOptions.series
  37673. * object.
  37674. *
  37675. * 2. Options for all `dema` series are defined in plotOptions.dema.
  37676. *
  37677. * 3. Options for one single series are given in the series instance array. (see
  37678. * online documentation for example)
  37679. */
  37680. export interface PlotDemaOptions {
  37681. /**
  37682. * (Highstock) Accessibility options for a series.
  37683. */
  37684. accessibility?: SeriesAccessibilityOptionsObject;
  37685. /**
  37686. * (Highstock) Allow this series' points to be selected by clicking on the
  37687. * graphic (columns, point markers, pie slices, map areas etc).
  37688. *
  37689. * The selected points can be handled by point select and unselect events,
  37690. * or collectively by the getSelectedPoints function.
  37691. *
  37692. * And alternative way of selecting points is through dragging.
  37693. */
  37694. allowPointSelect?: boolean;
  37695. /**
  37696. * (Highstock) Enable or disable the initial animation when a series is
  37697. * displayed. The animation can also be set as a configuration object.
  37698. * Please note that this option only applies to the initial animation of the
  37699. * series itself. For other animations, see chart.animation and the
  37700. * animation parameter under the API methods. The following properties are
  37701. * supported:
  37702. *
  37703. * - `defer`: The animation delay time in milliseconds.
  37704. *
  37705. * - `duration`: The duration of the animation in milliseconds.
  37706. *
  37707. * - `easing`: Can be a string reference to an easing function set on the
  37708. * `Math` object or a function. See the _Custom easing function_ demo below.
  37709. *
  37710. * Due to poor performance, animation is disabled in old IE browsers for
  37711. * several chart types.
  37712. */
  37713. animation?: (boolean|PlotDemaAnimationOptions|Partial<AnimationOptionsObject>);
  37714. /**
  37715. * (Highstock) For some series, there is a limit that shuts down initial
  37716. * animation by default when the total number of points in the chart is too
  37717. * high. For example, for a column chart and its derivatives, animation does
  37718. * not run if there is more than 250 points totally. To disable this cap,
  37719. * set `animationLimit` to `Infinity`.
  37720. */
  37721. animationLimit?: number;
  37722. /**
  37723. * (Highstock) Sets the color blending in the boost module.
  37724. */
  37725. boostBlending?: OptionsBoostBlendingValue;
  37726. /**
  37727. * (Highstock) Set the point threshold for when a series should enter boost
  37728. * mode.
  37729. *
  37730. * Setting it to e.g. 2000 will cause the series to enter boost mode when
  37731. * there are 2000 or more points in the series.
  37732. *
  37733. * To disable boosting on the series, set the `boostThreshold` to 0. Setting
  37734. * it to 1 will force boosting.
  37735. *
  37736. * Note that the cropThreshold also affects this setting. When zooming in on
  37737. * a series that has fewer points than the `cropThreshold`, all points are
  37738. * rendered although outside the visible plot area, and the `boostThreshold`
  37739. * won't take effect.
  37740. */
  37741. boostThreshold?: number;
  37742. /**
  37743. * (Highmaps) The border color of the map areas.
  37744. *
  37745. * In styled mode, the border stroke is given in the `.highcharts-point`
  37746. * class.
  37747. */
  37748. borderColor?: (ColorString|GradientColorObject|PatternObject);
  37749. /**
  37750. * (Highmaps) The border width of each map area.
  37751. *
  37752. * In styled mode, the border stroke width is given in the
  37753. * `.highcharts-point` class.
  37754. */
  37755. borderWidth?: number;
  37756. /**
  37757. * (Highstock) An additional class name to apply to the series' graphical
  37758. * elements. This option does not replace default class names of the
  37759. * graphical element.
  37760. */
  37761. className?: string;
  37762. /**
  37763. * (Highstock) Disable this option to allow series rendering in the whole
  37764. * plotting area.
  37765. *
  37766. * **Note:** Clipping should be always enabled when chart.zoomType is set
  37767. */
  37768. clip?: boolean;
  37769. /**
  37770. * (Highstock) The main color of the series. In line type series it applies
  37771. * to the line and the point markers unless otherwise specified. In bar type
  37772. * series it applies to the bars unless a color is specified per point. The
  37773. * default value is pulled from the `options.colors` array.
  37774. *
  37775. * In styled mode, the color can be defined by the colorIndex option. Also,
  37776. * the series color can be set with the `.highcharts-series`,
  37777. * `.highcharts-color-{n}`, `.highcharts-{type}-series` or
  37778. * `.highcharts-series-{n}` class, or individual classes given by the
  37779. * `className` option.
  37780. */
  37781. color?: (ColorString|GradientColorObject|PatternObject);
  37782. /**
  37783. * (Highstock) Styled mode only. A specific color index to use for the
  37784. * series, so its graphic representations are given the class name
  37785. * `highcharts-color-{n}`.
  37786. */
  37787. colorIndex?: number;
  37788. /**
  37789. * (Highcharts, Highstock, Highmaps) Determines what data value should be
  37790. * used to calculate point color if `colorAxis` is used. Requires to set
  37791. * `min` and `max` if some custom point property is used or if approximation
  37792. * for data grouping is set to `'sum'`.
  37793. */
  37794. colorKey?: string;
  37795. /**
  37796. * (Highstock) Defines if comparison should start from the first point
  37797. * within the visible range or should start from the first point **before**
  37798. * the range.
  37799. *
  37800. * In other words, this flag determines if first point within the visible
  37801. * range will have 0% (`compareStart=true`) or should have been already
  37802. * calculated according to the previous point (`compareStart=false`).
  37803. */
  37804. compareStart?: boolean;
  37805. /**
  37806. * (Highstock) Whether to compare indicator to the main series values or
  37807. * indicator values.
  37808. */
  37809. compareToMain?: boolean;
  37810. /**
  37811. * (Highcharts) Polar charts only. Whether to connect the ends of a line
  37812. * series plot across the extremes.
  37813. */
  37814. connectEnds?: boolean;
  37815. /**
  37816. * (Highcharts, Highstock) Whether to connect a graph line across null
  37817. * points, or render a gap between the two points on either side of the
  37818. * null.
  37819. */
  37820. connectNulls?: boolean;
  37821. /**
  37822. * (Gantt) Override Pathfinder connector options for a series. Requires
  37823. * Highcharts Gantt to be loaded.
  37824. */
  37825. connectors?: SeriesConnectorsOptionsObject;
  37826. /**
  37827. * (Highcharts, Highstock, Gantt) When true, each point or column edge is
  37828. * rounded to its nearest pixel in order to render sharp on screen. In some
  37829. * cases, when there are a lot of densely packed columns, this leads to
  37830. * visible difference in column widths or distance between columns. In these
  37831. * cases, setting `crisp` to `false` may look better, even though each
  37832. * column is rendered blurry.
  37833. */
  37834. crisp?: boolean;
  37835. /**
  37836. * (Highcharts, Highstock) When the series contains less points than the
  37837. * crop threshold, all points are drawn, even if the points fall outside the
  37838. * visible plot area at the current zoom. The advantage of drawing all
  37839. * points (including markers and columns), is that animation is performed on
  37840. * updates. On the other hand, when the series contains more points than the
  37841. * crop threshold, the series data is cropped to only contain points that
  37842. * fall within the plot area. The advantage of cropping away invisible
  37843. * points is to increase performance on large series.
  37844. */
  37845. cropThreshold?: number;
  37846. /**
  37847. * (Highstock) You can set the cursor to "pointer" if you have click events
  37848. * attached to the series, to signal to the user that the points and lines
  37849. * can be clicked.
  37850. *
  37851. * In styled mode, the series cursor can be set with the same classes as
  37852. * listed under series.color.
  37853. */
  37854. cursor?: (string|CursorValue);
  37855. /**
  37856. * (Highstock) A reserved subspace to store options and values for
  37857. * customized functionality. Here you can add additional data for your own
  37858. * event callbacks and formatter callbacks.
  37859. */
  37860. custom?: Dictionary<any>;
  37861. /**
  37862. * (Highstock) Name of the dash style to use for the graph, or for some
  37863. * series types the outline of each shape.
  37864. *
  37865. * In styled mode, the stroke dash-array can be set with the same classes as
  37866. * listed under series.color.
  37867. */
  37868. dashStyle?: DashStyleValue;
  37869. /**
  37870. * (Highstock) Data grouping is the concept of sampling the data values into
  37871. * larger blocks in order to ease readability and increase performance of
  37872. * the JavaScript charts. Highstock by default applies data grouping when
  37873. * the points become closer than a certain pixel value, determined by the
  37874. * `groupPixelWidth` option.
  37875. *
  37876. * If data grouping is applied, the grouping information of grouped points
  37877. * can be read from the Point.dataGroup. If point options other than the
  37878. * data itself are set, for example `name` or `color` or custom properties,
  37879. * the grouping logic doesn't know how to group it. In this case the options
  37880. * of the first point instance are copied over to the group point. This can
  37881. * be altered through a custom `approximation` callback function.
  37882. */
  37883. dataGrouping?: DataGroupingOptionsObject;
  37884. /**
  37885. * (Highcharts, Highstock, Highmaps, Gantt) Options for the series data
  37886. * labels, appearing next to each data point.
  37887. *
  37888. * Since v6.2.0, multiple data labels can be applied to each single point by
  37889. * defining them as an array of configs.
  37890. *
  37891. * In styled mode, the data labels can be styled with the
  37892. * `.highcharts-data-label-box` and `.highcharts-data-label` class names
  37893. * (see example).
  37894. */
  37895. dataLabels?: (PlotDemaDataLabelsOptions|Array<PlotDemaDataLabelsOptions>);
  37896. /**
  37897. * (Highcharts, Highstock) Options for the series data sorting.
  37898. */
  37899. dataSorting?: (DataSortingOptionsObject|PlotDemaDataSortingOptions);
  37900. /**
  37901. * (Highstock) A description of the series to add to the screen reader
  37902. * information about the series.
  37903. */
  37904. description?: string;
  37905. /**
  37906. * (Highstock) Enable or disable the mouse tracking for a specific series.
  37907. * This includes point tooltips and click events on graphs and points. For
  37908. * large datasets it improves performance.
  37909. */
  37910. enableMouseTracking?: boolean;
  37911. /**
  37912. * (Highstock) General event handlers for the series items. These event
  37913. * hooks can also be attached to the series at run time using the
  37914. * `Highcharts.addEvent` function.
  37915. */
  37916. events?: SeriesEventsOptionsObject;
  37917. /**
  37918. * (Highstock) Determines whether the series should look for the nearest
  37919. * point in both dimensions or just the x-dimension when hovering the
  37920. * series. Defaults to `'xy'` for scatter series and `'x'` for most other
  37921. * series. If the data has duplicate x-values, it is recommended to set this
  37922. * to `'xy'` to allow hovering over all points.
  37923. *
  37924. * Applies only to series types using nearest neighbor search (not direct
  37925. * hover) for tooltip.
  37926. */
  37927. findNearestPointBy?: OptionsFindNearestPointByValue;
  37928. /**
  37929. * (Highstock) Defines when to display a gap in the graph, together with the
  37930. * gapUnit option.
  37931. *
  37932. * In case when `dataGrouping` is enabled, points can be grouped into a
  37933. * larger time span. This can make the grouped points to have a greater
  37934. * distance than the absolute value of `gapSize` property, which will result
  37935. * in disappearing graph completely. To prevent this situation the mentioned
  37936. * distance between grouped points is used instead of previously defined
  37937. * `gapSize`.
  37938. *
  37939. * In practice, this option is most often used to visualize gaps in time
  37940. * series. In a stock chart, intraday data is available for daytime hours,
  37941. * while gaps will appear in nights and weekends.
  37942. */
  37943. gapSize?: number;
  37944. /**
  37945. * (Highstock) Together with gapSize, this option defines where to draw gaps
  37946. * in the graph.
  37947. *
  37948. * When the `gapUnit` is `"relative"` (default), a gap size of 5 means that
  37949. * if the distance between two points is greater than 5 times that of the
  37950. * two closest points, the graph will be broken.
  37951. *
  37952. * When the `gapUnit` is `"value"`, the gap is based on absolute axis
  37953. * values, which on a datetime axis is milliseconds. This also applies to
  37954. * the navigator series that inherits gap options from the base series.
  37955. */
  37956. gapUnit?: OptionsGapUnitValue;
  37957. /**
  37958. * (Highcharts, Highstock, Gantt) Whether to use the Y extremes of the total
  37959. * chart width or only the zoomed area when zooming in on parts of the X
  37960. * axis. By default, the Y axis adjusts to the min and max of the visible
  37961. * data. Cartesian series only.
  37962. */
  37963. getExtremesFromAll?: boolean;
  37964. /**
  37965. * (Highstock) When set to `false` will prevent the series data from being
  37966. * included in any form of data export.
  37967. *
  37968. * Since version 6.0.0 until 7.1.0 the option was existing undocumented as
  37969. * `includeInCSVExport`.
  37970. */
  37971. includeInDataExport?: boolean;
  37972. /**
  37973. * (Highcharts, Highstock, Gantt) Series labels are placed as close to the
  37974. * series as possible in a natural way, seeking to avoid other series. The
  37975. * goal of this feature is to make the chart more easily readable, like if a
  37976. * human designer placed the labels in the optimal position.
  37977. *
  37978. * The series labels currently work with series types having a `graph` or an
  37979. * `area`.
  37980. */
  37981. label?: SeriesLabelOptionsObject;
  37982. /**
  37983. * (Highstock) The line marks the last price from all points.
  37984. */
  37985. lastPrice?: SeriesLastPriceOptionsObject;
  37986. /**
  37987. * (Highstock) The line marks the last price from visible range of points.
  37988. */
  37989. lastVisiblePrice?: SeriesLastVisiblePriceOptionsObject;
  37990. /**
  37991. * (Highcharts, Highstock) The SVG value used for the `stroke-linecap` and
  37992. * `stroke-linejoin` of a line graph. Round means that lines are rounded in
  37993. * the ends and bends.
  37994. */
  37995. linecap?: SeriesLinecapValue;
  37996. /**
  37997. * (Highcharts, Highstock) Pixel width of the graph line.
  37998. */
  37999. lineWidth?: number;
  38000. /**
  38001. * (Highcharts, Highstock, Gantt) The main series ID that indicator will be
  38002. * based on. Required for this indicator.
  38003. */
  38004. linkedTo?: string;
  38005. /**
  38006. * (Highstock) Options for the point markers of line-like series. Properties
  38007. * like `fillColor`, `lineColor` and `lineWidth` define the visual
  38008. * appearance of the markers. Other series types, like column series, don't
  38009. * have markers, but have visual options on the series level instead.
  38010. *
  38011. * In styled mode, the markers can be styled with the `.highcharts-point`,
  38012. * `.highcharts-point-hover` and `.highcharts-point-select` class names.
  38013. */
  38014. marker?: PointMarkerOptionsObject;
  38015. /**
  38016. * (Highstock) The name of the series as shown in the legend, tooltip etc.
  38017. * If not set, it will be based on a technical indicator type and default
  38018. * params.
  38019. */
  38020. name?: string;
  38021. /**
  38022. * (Highstock) The color for the parts of the graph or points that are below
  38023. * the threshold. Note that `zones` takes precedence over the negative
  38024. * color. Using `negativeColor` is equivalent to applying a zone with value
  38025. * of 0.
  38026. */
  38027. negativeColor?: (ColorString|GradientColorObject|PatternObject);
  38028. /**
  38029. * (Highstock) Opacity of a series parts: line, fill (e.g. area) and
  38030. * dataLabels.
  38031. */
  38032. opacity?: number;
  38033. /**
  38034. * (Highstock) Paramters used in calculation of regression series' points.
  38035. */
  38036. params?: PlotDemaParamsOptions;
  38037. /**
  38038. * (Highstock) Properties for each single point.
  38039. */
  38040. point?: PlotSeriesPointOptions;
  38041. /**
  38042. * (Highstock) Same as accessibility.pointDescriptionFormatter, but for an
  38043. * individual series. Overrides the chart wide configuration.
  38044. */
  38045. pointDescriptionFormatter?: Function;
  38046. /**
  38047. * (Highstock) Whether to select the series initially. If `showCheckbox` is
  38048. * true, the checkbox next to the series name in the legend will be checked
  38049. * for a selected series.
  38050. */
  38051. selected?: boolean;
  38052. /**
  38053. * (Highstock) Whether to apply a drop shadow to the graph line. Since 2.3
  38054. * the shadow can be an object configuration containing `color`, `offsetX`,
  38055. * `offsetY`, `opacity` and `width`.
  38056. */
  38057. shadow?: (boolean|ShadowOptionsObject);
  38058. /**
  38059. * (Highstock) If true, a checkbox is displayed next to the legend item to
  38060. * allow selecting the series. The state of the checkbox is determined by
  38061. * the `selected` option.
  38062. */
  38063. showCheckbox?: boolean;
  38064. /**
  38065. * (Highstock) Whether to display this particular series or series type in
  38066. * the legend. Standalone series are shown in legend by default, and linked
  38067. * series are not. Since v7.2.0 it is possible to show series that use
  38068. * colorAxis by setting this option to `true`.
  38069. */
  38070. showInLegend?: boolean;
  38071. /**
  38072. * (Highstock) If set to `true`, the accessibility module will skip past the
  38073. * points in this series for keyboard navigation.
  38074. */
  38075. skipKeyboardNavigation?: boolean;
  38076. /**
  38077. * (Highcharts, Highstock) When this is true, the series will not cause the
  38078. * Y axis to cross the zero plane (or threshold option) unless the data
  38079. * actually crosses the plane.
  38080. *
  38081. * For example, if `softThreshold` is `false`, a series of 0, 1, 2, 3 will
  38082. * make the Y axis show negative values according to the `minPadding`
  38083. * option. If `softThreshold` is `true`, the Y axis starts at 0.
  38084. */
  38085. softThreshold?: boolean;
  38086. states?: SeriesStatesOptionsObject;
  38087. /**
  38088. * (Highcharts, Highstock) Whether to apply steps to the line. Possible
  38089. * values are `left`, `center` and `right`.
  38090. */
  38091. step?: OptionsStepValue;
  38092. /**
  38093. * (Highstock) Sticky tracking of mouse events. When true, the `mouseOut`
  38094. * event on a series isn't triggered until the mouse moves over another
  38095. * series, or out of the plot area. When false, the `mouseOut` event on a
  38096. * series is triggered when the mouse leaves the area around the series'
  38097. * graph or markers. This also implies the tooltip when not shared. When
  38098. * `stickyTracking` is false and `tooltip.shared` is false, the tooltip will
  38099. * be hidden when moving the mouse between series. Defaults to true for line
  38100. * and area type series, but to false for columns, pies etc.
  38101. *
  38102. * **Note:** The boost module will force this option because of technical
  38103. * limitations.
  38104. */
  38105. stickyTracking?: boolean;
  38106. /**
  38107. * (Highcharts, Highstock) The threshold, also called zero level or base
  38108. * level. For line type series this is only used in conjunction with
  38109. * negativeColor.
  38110. */
  38111. threshold?: (number|null);
  38112. /**
  38113. * (Highstock) A configuration object for the tooltip rendering of each
  38114. * single series. Properties are inherited from tooltip, but only the
  38115. * following properties can be defined on a series level.
  38116. */
  38117. tooltip?: SeriesTooltipOptionsObject;
  38118. /**
  38119. * (Highcharts, Highstock, Gantt) When a series contains a data array that
  38120. * is longer than this, only one dimensional arrays of numbers, or two
  38121. * dimensional arrays with x and y values are allowed. Also, only the first
  38122. * point is tested, and the rest are assumed to be the same format. This
  38123. * saves expensive data checking and indexing in long series. Set it to `0`
  38124. * disable.
  38125. *
  38126. * Note: In boost mode turbo threshold is forced. Only array of numbers or
  38127. * two dimensional arrays are allowed.
  38128. */
  38129. turboThreshold?: number;
  38130. /**
  38131. * (Highstock) Set the initial visibility of the series.
  38132. */
  38133. visible?: boolean;
  38134. /**
  38135. * (Highmaps) Define the z index of the series.
  38136. */
  38137. zIndex?: number;
  38138. /**
  38139. * (Highcharts, Highstock) Defines the Axis on which the zones are applied.
  38140. */
  38141. zoneAxis?: string;
  38142. /**
  38143. * (Highcharts, Highstock) An array defining zones within a series. Zones
  38144. * can be applied to the X axis, Y axis or Z axis for bubbles, according to
  38145. * the `zoneAxis` option. The zone definitions have to be in ascending order
  38146. * regarding to the value.
  38147. *
  38148. * In styled mode, the color zones are styled with the
  38149. * `.highcharts-zone-{n}` class, or custom classed from the `className`
  38150. * option (view live demo).
  38151. */
  38152. zones?: Array<SeriesZonesOptionsObject>;
  38153. }
  38154. /**
  38155. * (Highstock) Paramters used in calculation of regression series' points.
  38156. */
  38157. export interface PlotDemaParamsOptions {
  38158. /**
  38159. * (Highstock) The point index which indicator calculations will base. For
  38160. * example using OHLC data, index=2 means the indicator will be calculated
  38161. * using Low values.
  38162. *
  38163. * By default index value used to be set to 0. Since Highstock 7 by default
  38164. * index is set to 3 which means that the ema indicator will be calculated
  38165. * using Close values.
  38166. */
  38167. index?: number;
  38168. /**
  38169. * (Highstock) The base period for indicator calculations. This is the
  38170. * number of data points which are taken into account for the indicator
  38171. * calculations.
  38172. */
  38173. period?: number;
  38174. }
  38175. /**
  38176. * (Highcharts) Enable or disable the initial animation when a series is
  38177. * displayed. The animation can also be set as a configuration object. Please
  38178. * note that this option only applies to the initial animation of the series
  38179. * itself. For other animations, see chart.animation and the animation parameter
  38180. * under the API methods. The following properties are supported:
  38181. *
  38182. * - `defer`: The animation delay time in milliseconds.
  38183. *
  38184. * - `duration`: The duration of the animation in milliseconds.
  38185. *
  38186. * - `easing`: Can be a string reference to an easing function set on the `Math`
  38187. * object or a function. See the _Custom easing function_ demo below.
  38188. *
  38189. * Due to poor performance, animation is disabled in old IE browsers for several
  38190. * chart types.
  38191. */
  38192. export interface PlotDependencywheelAnimationOptions {
  38193. defer?: number;
  38194. }
  38195. /**
  38196. * (Highcharts, Highstock, Highmaps, Gantt) Enable or disable the initial
  38197. * animation when a series is displayed for the `dataLabels`. The animation can
  38198. * also be set as a configuration object. Please note that this option only
  38199. * applies to the initial animation. For other animations, see chart.animation
  38200. * and the animation parameter under the API methods. The following properties
  38201. * are supported:
  38202. *
  38203. * - `defer`: The animation delay time in milliseconds.
  38204. */
  38205. export interface PlotDependencywheelDataLabelsAnimationOptions {
  38206. /**
  38207. * (Highcharts, Highstock, Highmaps, Gantt) The animation delay time in
  38208. * milliseconds. Set to `0` renders dataLabel immediately. As `undefined`
  38209. * inherits defer time from the series.animation.defer.
  38210. */
  38211. defer?: number;
  38212. }
  38213. /**
  38214. * (Highcharts, Highstock, Highmaps, Gantt) Enable or disable the initial
  38215. * animation when a series is displayed for the `dataLabels`. The animation can
  38216. * also be set as a configuration object. Please note that this option only
  38217. * applies to the initial animation. For other animations, see chart.animation
  38218. * and the animation parameter under the API methods. The following properties
  38219. * are supported:
  38220. *
  38221. * - `defer`: The animation delay time in milliseconds.
  38222. */
  38223. export interface PlotDependencywheelLevelsDataLabelsAnimationOptions {
  38224. /**
  38225. * (Highcharts, Highstock, Highmaps, Gantt) The animation delay time in
  38226. * milliseconds. Set to `0` renders dataLabel immediately. As `undefined`
  38227. * inherits defer time from the series.animation.defer.
  38228. */
  38229. defer?: number;
  38230. }
  38231. /**
  38232. * (Highcharts) Set options on specific levels. Takes precedence over series
  38233. * options, but not node and link options.
  38234. */
  38235. export interface PlotDependencywheelLevelsOptions {
  38236. /**
  38237. * (Highcharts) Can set `borderColor` on all nodes which lay on the same
  38238. * level.
  38239. */
  38240. borderColor?: ColorString;
  38241. /**
  38242. * (Highcharts) Can set `borderWidth` on all nodes which lay on the same
  38243. * level.
  38244. */
  38245. borderWidth?: number;
  38246. /**
  38247. * (Highcharts) Can set `color` on all nodes which lay on the same level.
  38248. */
  38249. color?: (ColorString|GradientColorObject|PatternObject);
  38250. /**
  38251. * (Highcharts) Can set `colorByPoint` on all nodes which lay on the same
  38252. * level.
  38253. */
  38254. colorByPoint?: boolean;
  38255. /**
  38256. * (Highcharts, Highstock, Highmaps, Gantt) Can set `dataLabels` on all
  38257. * points which lay on the same level.
  38258. */
  38259. dataLabels?: (SeriesSankeyDataLabelsOptionsObject|Array<SeriesSankeyDataLabelsOptionsObject>);
  38260. /**
  38261. * (Highcharts) Decides which level takes effect from the options set in the
  38262. * levels object.
  38263. */
  38264. level?: number;
  38265. /**
  38266. * (Highcharts) Can set `linkOpacity` on all points which lay on the same
  38267. * level.
  38268. */
  38269. linkOpacity?: number;
  38270. /**
  38271. * (Highcharts) Can set `states` on all nodes and points which lay on the
  38272. * same level.
  38273. */
  38274. states?: SeriesStatesOptionsObject;
  38275. }
  38276. /**
  38277. * (Highcharts) A dependency wheel chart is a type of flow diagram, where all
  38278. * nodes are laid out in a circle, and the flow between the are drawn as link
  38279. * bands.
  38280. *
  38281. * In TypeScript the type option must always be set.
  38282. *
  38283. * Configuration options for the series are given in three levels:
  38284. *
  38285. * 1. Options for all series in a chart are defined in the plotOptions.series
  38286. * object.
  38287. *
  38288. * 2. Options for all `dependencywheel` series are defined in
  38289. * plotOptions.dependencywheel.
  38290. *
  38291. * 3. Options for one single series are given in the series instance array. (see
  38292. * online documentation for example)
  38293. */
  38294. export interface PlotDependencywheelOptions {
  38295. /**
  38296. * (Highcharts) Accessibility options for a series.
  38297. */
  38298. accessibility?: SeriesAccessibilityOptionsObject;
  38299. /**
  38300. * (Highmaps) Whether all areas of the map defined in `mapData` should be
  38301. * rendered. If `true`, areas which don't correspond to a data point, are
  38302. * rendered as `null` points. If `false`, those areas are skipped.
  38303. */
  38304. allAreas?: boolean;
  38305. /**
  38306. * (Highcharts) Allow this series' points to be selected by clicking on the
  38307. * graphic (columns, point markers, pie slices, map areas etc).
  38308. *
  38309. * The selected points can be handled by point select and unselect events,
  38310. * or collectively by the getSelectedPoints function.
  38311. *
  38312. * And alternative way of selecting points is through dragging.
  38313. */
  38314. allowPointSelect?: boolean;
  38315. /**
  38316. * (Highcharts) Enable or disable the initial animation when a series is
  38317. * displayed. The animation can also be set as a configuration object.
  38318. * Please note that this option only applies to the initial animation of the
  38319. * series itself. For other animations, see chart.animation and the
  38320. * animation parameter under the API methods. The following properties are
  38321. * supported:
  38322. *
  38323. * - `defer`: The animation delay time in milliseconds.
  38324. *
  38325. * - `duration`: The duration of the animation in milliseconds.
  38326. *
  38327. * - `easing`: Can be a string reference to an easing function set on the
  38328. * `Math` object or a function. See the _Custom easing function_ demo below.
  38329. *
  38330. * Due to poor performance, animation is disabled in old IE browsers for
  38331. * several chart types.
  38332. */
  38333. animation?: (boolean|PlotDependencywheelAnimationOptions|Partial<AnimationOptionsObject>);
  38334. /**
  38335. * (Highcharts, Highstock, Gantt) The color of the border surrounding each
  38336. * column or bar.
  38337. *
  38338. * In styled mode, the border stroke can be set with the `.highcharts-point`
  38339. * rule.
  38340. */
  38341. borderColor?: (ColorString|GradientColorObject|PatternObject);
  38342. /**
  38343. * (Highcharts, Highstock, Gantt) The width of the border surrounding each
  38344. * column or bar. Defaults to `1` when there is room for a border, but to
  38345. * `0` when the columns are so dense that a border would cover the next
  38346. * column.
  38347. *
  38348. * In styled mode, the stroke width can be set with the `.highcharts-point`
  38349. * rule.
  38350. */
  38351. borderWidth?: number;
  38352. /**
  38353. * (Highcharts) The center of the wheel relative to the plot area. Can be
  38354. * percentages or pixel values. The default behaviour is to center the wheel
  38355. * inside the plot area.
  38356. */
  38357. center?: Array<(number|string|null)>;
  38358. /**
  38359. * (Highcharts, Highstock, Gantt) When `true`, the columns will center in
  38360. * the category, ignoring null or missing points. When `false`, space will
  38361. * be reserved for null or missing points.
  38362. */
  38363. centerInCategory?: boolean;
  38364. /**
  38365. * (Highcharts) An additional class name to apply to the series' graphical
  38366. * elements. This option does not replace default class names of the
  38367. * graphical element.
  38368. */
  38369. className?: string;
  38370. /**
  38371. * (Highcharts) Disable this option to allow series rendering in the whole
  38372. * plotting area.
  38373. *
  38374. * **Note:** Clipping should be always enabled when chart.zoomType is set
  38375. */
  38376. clip?: boolean;
  38377. /**
  38378. * (Highcharts) The main color of the series. In line type series it applies
  38379. * to the line and the point markers unless otherwise specified. In bar type
  38380. * series it applies to the bars unless a color is specified per point. The
  38381. * default value is pulled from the `options.colors` array.
  38382. *
  38383. * In styled mode, the color can be defined by the colorIndex option. Also,
  38384. * the series color can be set with the `.highcharts-series`,
  38385. * `.highcharts-color-{n}`, `.highcharts-{type}-series` or
  38386. * `.highcharts-series-{n}` class, or individual classes given by the
  38387. * `className` option.
  38388. */
  38389. color?: (ColorString|GradientColorObject|PatternObject);
  38390. /**
  38391. * (Highcharts, Highstock, Gantt) When using automatic point colors pulled
  38392. * from the global colors or series-specific plotOptions.column.colors
  38393. * collections, this option determines whether the chart should receive one
  38394. * color per series or one color per point.
  38395. *
  38396. * In styled mode, the `colors` or `series.colors` arrays are not supported,
  38397. * and instead this option gives the points individual color class names on
  38398. * the form `highcharts-color-{n}`.
  38399. */
  38400. colorByPoint?: boolean;
  38401. /**
  38402. * (Highcharts) Styled mode only. A specific color index to use for the
  38403. * series, so its graphic representations are given the class name
  38404. * `highcharts-color-{n}`.
  38405. */
  38406. colorIndex?: number;
  38407. /**
  38408. * (Highcharts, Highstock, Gantt) A series specific or series type specific
  38409. * color set to apply instead of the global colors when colorByPoint is
  38410. * true.
  38411. */
  38412. colors?: Array<(ColorString|GradientColorObject|PatternObject)>;
  38413. /**
  38414. * (Highstock) Compare the values of the series against the first non-null,
  38415. * non- zero value in the visible range. The y axis will show percentage or
  38416. * absolute change depending on whether `compare` is set to `"percent"` or
  38417. * `"value"`. When this is applied to multiple series, it allows comparing
  38418. * the development of the series against each other. Adds a `change` field
  38419. * to every point object.
  38420. */
  38421. compare?: string;
  38422. /**
  38423. * (Highstock) When compare is `percent`, this option dictates whether to
  38424. * use 0 or 100 as the base of comparison.
  38425. */
  38426. compareBase?: (0|100);
  38427. /**
  38428. * (Highstock) Defines if comparison should start from the first point
  38429. * within the visible range or should start from the first point **before**
  38430. * the range.
  38431. *
  38432. * In other words, this flag determines if first point within the visible
  38433. * range will have 0% (`compareStart=true`) or should have been already
  38434. * calculated according to the previous point (`compareStart=false`).
  38435. */
  38436. compareStart?: boolean;
  38437. /**
  38438. * (Gantt) Override Pathfinder connector options for a series. Requires
  38439. * Highcharts Gantt to be loaded.
  38440. */
  38441. connectors?: SeriesConnectorsOptionsObject;
  38442. /**
  38443. * (Highcharts) You can set the cursor to "pointer" if you have click events
  38444. * attached to the series, to signal to the user that the points and lines
  38445. * can be clicked.
  38446. *
  38447. * In styled mode, the series cursor can be set with the same classes as
  38448. * listed under series.color.
  38449. */
  38450. cursor?: (string|CursorValue);
  38451. /**
  38452. * (Highcharts) Higher numbers makes the links in a sankey diagram or
  38453. * dependency wheelrender more curved. A `curveFactor` of 0 makes the lines
  38454. * straight.
  38455. */
  38456. curveFactor?: number;
  38457. /**
  38458. * (Highcharts) A reserved subspace to store options and values for
  38459. * customized functionality. Here you can add additional data for your own
  38460. * event callbacks and formatter callbacks.
  38461. */
  38462. custom?: Dictionary<any>;
  38463. /**
  38464. * (Highcharts) Name of the dash style to use for the graph, or for some
  38465. * series types the outline of each shape.
  38466. *
  38467. * In styled mode, the stroke dash-array can be set with the same classes as
  38468. * listed under series.color.
  38469. */
  38470. dashStyle?: DashStyleValue;
  38471. /**
  38472. * (Highstock) Data grouping is the concept of sampling the data values into
  38473. * larger blocks in order to ease readability and increase performance of
  38474. * the JavaScript charts. Highstock by default applies data grouping when
  38475. * the points become closer than a certain pixel value, determined by the
  38476. * `groupPixelWidth` option.
  38477. *
  38478. * If data grouping is applied, the grouping information of grouped points
  38479. * can be read from the Point.dataGroup. If point options other than the
  38480. * data itself are set, for example `name` or `color` or custom properties,
  38481. * the grouping logic doesn't know how to group it. In this case the options
  38482. * of the first point instance are copied over to the group point. This can
  38483. * be altered through a custom `approximation` callback function.
  38484. */
  38485. dataGrouping?: DataGroupingOptionsObject;
  38486. /**
  38487. * (Highcharts, Highstock, Highmaps, Gantt) Options for the data labels
  38488. * appearing on top of the nodes and links. For sankey charts, data labels
  38489. * are visible for the nodes by default, but hidden for links. This is
  38490. * controlled by modifying the `nodeFormat`, and the `format` that applies
  38491. * to links and is an empty string by default.
  38492. */
  38493. dataLabels?: (SeriesSankeyDataLabelsOptionsObject|Array<SeriesSankeyDataLabelsOptionsObject>);
  38494. /**
  38495. * (Highcharts) A description of the series to add to the screen reader
  38496. * information about the series.
  38497. */
  38498. description?: string;
  38499. /**
  38500. * (Highcharts) Enable or disable the mouse tracking for a specific series.
  38501. * This includes point tooltips and click events on graphs and points. For
  38502. * large datasets it improves performance.
  38503. */
  38504. enableMouseTracking?: boolean;
  38505. /**
  38506. * (Highcharts) General event handlers for the series items. These event
  38507. * hooks can also be attached to the series at run time using the
  38508. * `Highcharts.addEvent` function.
  38509. */
  38510. events?: SeriesEventsOptionsObject;
  38511. /**
  38512. * (Highcharts, Highstock, Gantt) Whether to use the Y extremes of the total
  38513. * chart width or only the zoomed area when zooming in on parts of the X
  38514. * axis. By default, the Y axis adjusts to the min and max of the visible
  38515. * data. Cartesian series only.
  38516. */
  38517. getExtremesFromAll?: boolean;
  38518. /**
  38519. * (Highcharts) When set to `false` will prevent the series data from being
  38520. * included in any form of data export.
  38521. *
  38522. * Since version 6.0.0 until 7.1.0 the option was existing undocumented as
  38523. * `includeInCSVExport`.
  38524. */
  38525. includeInDataExport?: boolean;
  38526. /**
  38527. * (Highmaps) What property to join the `mapData` to the value data. For
  38528. * example, if joinBy is "code", the mapData items with a specific code is
  38529. * merged into the data with the same code. For maps loaded from GeoJSON,
  38530. * the keys may be held in each point's `properties` object.
  38531. *
  38532. * The joinBy option can also be an array of two values, where the first
  38533. * points to a key in the `mapData`, and the second points to another key in
  38534. * the `data`.
  38535. *
  38536. * When joinBy is `null`, the map items are joined by their position in the
  38537. * array, which performs much better in maps with many data points. This is
  38538. * the recommended option if you are printing more than a thousand data
  38539. * points and have a backend that can preprocess the data into a parallel
  38540. * array of the mapData.
  38541. */
  38542. joinBy?: (string|Array<string>);
  38543. /**
  38544. * (Highcharts) An array specifying which option maps to which key in the
  38545. * data point array. This makes it convenient to work with unstructured data
  38546. * arrays from different sources.
  38547. */
  38548. keys?: Array<string>;
  38549. /**
  38550. * (Highcharts, Highstock, Gantt) Series labels are placed as close to the
  38551. * series as possible in a natural way, seeking to avoid other series. The
  38552. * goal of this feature is to make the chart more easily readable, like if a
  38553. * human designer placed the labels in the optimal position.
  38554. *
  38555. * The series labels currently work with series types having a `graph` or an
  38556. * `area`.
  38557. */
  38558. label?: SeriesLabelOptionsObject;
  38559. /**
  38560. * (Highstock) The line marks the last price from all points.
  38561. */
  38562. lastPrice?: SeriesLastPriceOptionsObject;
  38563. /**
  38564. * (Highstock) The line marks the last price from visible range of points.
  38565. */
  38566. lastVisiblePrice?: SeriesLastVisiblePriceOptionsObject;
  38567. /**
  38568. * (Highcharts) Set options on specific levels. Takes precedence over series
  38569. * options, but not node and link options.
  38570. */
  38571. levels?: Array<PlotDependencywheelLevelsOptions>;
  38572. /**
  38573. * (Highcharts, Highstock, Gantt) The id of another series to link to.
  38574. * Additionally, the value can be ":previous" to link to the previous
  38575. * series. When two series are linked, only the first one appears in the
  38576. * legend. Toggling the visibility of this also toggles the linked series.
  38577. *
  38578. * If master series uses data sorting and linked series does not have its
  38579. * own sorting definition, the linked series will be sorted in the same
  38580. * order as the master one.
  38581. */
  38582. linkedTo?: string;
  38583. /**
  38584. * (Highcharts) Opacity for the links between nodes in the sankey diagram.
  38585. */
  38586. linkOpacity?: number;
  38587. /**
  38588. * (Highcharts) The minimal width for a line of a sankey. By default, 0
  38589. * values are not shown.
  38590. */
  38591. minLinkWidth?: number;
  38592. /**
  38593. * (Highstock) Options for the corresponding navigator series if
  38594. * `showInNavigator` is `true` for this series. Available options are the
  38595. * same as any series, documented at plotOptions and series.
  38596. *
  38597. * These options are merged with options in navigator.series, and will take
  38598. * precedence if the same option is defined both places.
  38599. */
  38600. navigatorOptions?: PlotSeriesOptions;
  38601. /**
  38602. * (Highcharts) The padding between nodes in a sankey diagram or dependency
  38603. * wheel, in pixels.
  38604. *
  38605. * If the number of nodes is so great that it is possible to lay them out
  38606. * within the plot area with the given `nodePadding`, they will be rendered
  38607. * with a smaller padding as a strategy to avoid overflow.
  38608. */
  38609. nodePadding?: number;
  38610. /**
  38611. * (Highcharts) The pixel width of each node in a sankey diagram or
  38612. * dependency wheel, or the height in case the chart is inverted.
  38613. */
  38614. nodeWidth?: number;
  38615. /**
  38616. * (Highcharts) Opacity of a series parts: line, fill (e.g. area) and
  38617. * dataLabels.
  38618. */
  38619. opacity?: number;
  38620. /**
  38621. * (Highcharts) Properties for each single point.
  38622. */
  38623. point?: PlotSeriesPointOptions;
  38624. /**
  38625. * (Highcharts) Same as accessibility.pointDescriptionFormatter, but for an
  38626. * individual series. Overrides the chart wide configuration.
  38627. */
  38628. pointDescriptionFormatter?: Function;
  38629. /**
  38630. * (Highcharts) Whether to select the series initially. If `showCheckbox` is
  38631. * true, the checkbox next to the series name in the legend will be checked
  38632. * for a selected series.
  38633. */
  38634. selected?: boolean;
  38635. /**
  38636. * (Highcharts) If true, a checkbox is displayed next to the legend item to
  38637. * allow selecting the series. The state of the checkbox is determined by
  38638. * the `selected` option.
  38639. */
  38640. showCheckbox?: boolean;
  38641. /**
  38642. * (Highcharts) Whether to display this particular series or series type in
  38643. * the legend. Standalone series are shown in legend by default, and linked
  38644. * series are not. Since v7.2.0 it is possible to show series that use
  38645. * colorAxis by setting this option to `true`.
  38646. */
  38647. showInLegend?: boolean;
  38648. /**
  38649. * (Highstock) Whether or not to show the series in the navigator. Takes
  38650. * precedence over navigator.baseSeries if defined.
  38651. */
  38652. showInNavigator?: boolean;
  38653. /**
  38654. * (Highcharts) If set to `true`, the accessibility module will skip past
  38655. * the points in this series for keyboard navigation.
  38656. */
  38657. skipKeyboardNavigation?: boolean;
  38658. /**
  38659. * (Highcharts) The start angle of the dependency wheel, in degrees where 0
  38660. * is up.
  38661. */
  38662. startAngle?: number;
  38663. states?: SeriesStatesOptionsObject;
  38664. /**
  38665. * (Highcharts) Sticky tracking of mouse events. When true, the `mouseOut`
  38666. * event on a series isn't triggered until the mouse moves over another
  38667. * series, or out of the plot area. When false, the `mouseOut` event on a
  38668. * series is triggered when the mouse leaves the area around the series'
  38669. * graph or markers. This also implies the tooltip when not shared. When
  38670. * `stickyTracking` is false and `tooltip.shared` is false, the tooltip will
  38671. * be hidden when moving the mouse between series. Defaults to true for line
  38672. * and area type series, but to false for columns, pies etc.
  38673. *
  38674. * **Note:** The boost module will force this option because of technical
  38675. * limitations.
  38676. */
  38677. stickyTracking?: boolean;
  38678. /**
  38679. * (Highcharts) A configuration object for the tooltip rendering of each
  38680. * single series. Properties are inherited from tooltip, but only the
  38681. * following properties can be defined on a series level.
  38682. */
  38683. tooltip?: SeriesTooltipOptionsObject;
  38684. /**
  38685. * (Highcharts, Highstock, Gantt) When a series contains a data array that
  38686. * is longer than this, only one dimensional arrays of numbers, or two
  38687. * dimensional arrays with x and y values are allowed. Also, only the first
  38688. * point is tested, and the rest are assumed to be the same format. This
  38689. * saves expensive data checking and indexing in long series. Set it to `0`
  38690. * disable.
  38691. *
  38692. * Note: In boost mode turbo threshold is forced. Only array of numbers or
  38693. * two dimensional arrays are allowed.
  38694. */
  38695. turboThreshold?: number;
  38696. /**
  38697. * (Highcharts) Set the initial visibility of the series.
  38698. */
  38699. visible?: boolean;
  38700. /**
  38701. * (Highmaps) Define the z index of the series.
  38702. */
  38703. zIndex?: number;
  38704. }
  38705. /**
  38706. * (Highstock) Enable or disable the initial animation when a series is
  38707. * displayed. The animation can also be set as a configuration object. Please
  38708. * note that this option only applies to the initial animation of the series
  38709. * itself. For other animations, see chart.animation and the animation parameter
  38710. * under the API methods. The following properties are supported:
  38711. *
  38712. * - `defer`: The animation delay time in milliseconds.
  38713. *
  38714. * - `duration`: The duration of the animation in milliseconds.
  38715. *
  38716. * - `easing`: Can be a string reference to an easing function set on the `Math`
  38717. * object or a function. See the _Custom easing function_ demo below.
  38718. *
  38719. * Due to poor performance, animation is disabled in old IE browsers for several
  38720. * chart types.
  38721. */
  38722. export interface PlotDpoAnimationOptions {
  38723. defer?: number;
  38724. }
  38725. /**
  38726. * (Highcharts, Highstock, Highmaps, Gantt) Enable or disable the initial
  38727. * animation when a series is displayed for the `dataLabels`. The animation can
  38728. * also be set as a configuration object. Please note that this option only
  38729. * applies to the initial animation. For other animations, see chart.animation
  38730. * and the animation parameter under the API methods. The following properties
  38731. * are supported:
  38732. *
  38733. * - `defer`: The animation delay time in milliseconds.
  38734. */
  38735. export interface PlotDpoDataLabelsAnimationOptions {
  38736. /**
  38737. * (Highcharts, Highstock, Highmaps, Gantt) The animation delay time in
  38738. * milliseconds. Set to `0` renders dataLabel immediately. As `undefined`
  38739. * inherits defer time from the series.animation.defer.
  38740. */
  38741. defer?: number;
  38742. }
  38743. /**
  38744. * (Highcharts, Highstock, Highmaps, Gantt) Options for the series data labels,
  38745. * appearing next to each data point.
  38746. *
  38747. * Since v6.2.0, multiple data labels can be applied to each single point by
  38748. * defining them as an array of configs.
  38749. *
  38750. * In styled mode, the data labels can be styled with the
  38751. * `.highcharts-data-label-box` and `.highcharts-data-label` class names (see
  38752. * example).
  38753. */
  38754. export interface PlotDpoDataLabelsOptions {
  38755. /**
  38756. * (Highcharts, Highstock, Highmaps, Gantt) The alignment of the data label
  38757. * compared to the point. If `right`, the right side of the label should be
  38758. * touching the point. For points with an extent, like columns, the
  38759. * alignments also dictates how to align it inside the box, as given with
  38760. * the inside option. Can be one of `left`, `center` or `right`.
  38761. */
  38762. align?: (AlignValue|null);
  38763. /**
  38764. * (Highcharts, Highstock, Highmaps, Gantt) Whether to allow data labels to
  38765. * overlap. To make the labels less sensitive for overlapping, the
  38766. * dataLabels.padding can be set to 0.
  38767. */
  38768. allowOverlap?: boolean;
  38769. /**
  38770. * (Highcharts, Highstock, Highmaps, Gantt) Enable or disable the initial
  38771. * animation when a series is displayed for the `dataLabels`. The animation
  38772. * can also be set as a configuration object. Please note that this option
  38773. * only applies to the initial animation. For other animations, see
  38774. * chart.animation and the animation parameter under the API methods. The
  38775. * following properties are supported:
  38776. *
  38777. * - `defer`: The animation delay time in milliseconds.
  38778. */
  38779. animation?: (boolean|PlotDpoDataLabelsAnimationOptions|Partial<AnimationOptionsObject>);
  38780. /**
  38781. * (Highcharts, Highstock, Highmaps, Gantt) The background color or gradient
  38782. * for the data label.
  38783. */
  38784. backgroundColor?: (ColorString|GradientColorObject|PatternObject);
  38785. /**
  38786. * (Highcharts, Highstock, Highmaps, Gantt) The border color for the data
  38787. * label. Defaults to `undefined`.
  38788. */
  38789. borderColor?: (ColorString|GradientColorObject|PatternObject);
  38790. /**
  38791. * (Highcharts, Highstock, Highmaps, Gantt) The border radius in pixels for
  38792. * the data label.
  38793. */
  38794. borderRadius?: number;
  38795. /**
  38796. * (Highcharts, Highstock, Highmaps, Gantt) The border width in pixels for
  38797. * the data label.
  38798. */
  38799. borderWidth?: number;
  38800. /**
  38801. * (Highcharts, Highstock, Highmaps, Gantt) A class name for the data label.
  38802. * Particularly in styled mode, this can be used to give each series' or
  38803. * point's data label unique styling. In addition to this option, a default
  38804. * color class name is added so that we can give the labels a contrast text
  38805. * shadow.
  38806. */
  38807. className?: string;
  38808. /**
  38809. * (Highcharts, Highstock, Highmaps, Gantt) The text color for the data
  38810. * labels. Defaults to `undefined`. For certain series types, like column or
  38811. * map, the data labels can be drawn inside the points. In this case the
  38812. * data label will be drawn with maximum contrast by default. Additionally,
  38813. * it will be given a `text-outline` style with the opposite color, to
  38814. * further increase the contrast. This can be overridden by setting the
  38815. * `text-outline` style to `none` in the `dataLabels.style` option.
  38816. */
  38817. color?: (ColorString|GradientColorObject|PatternObject);
  38818. /**
  38819. * (Highcharts, Highstock, Highmaps, Gantt) Whether to hide data labels that
  38820. * are outside the plot area. By default, the data label is moved inside the
  38821. * plot area according to the overflow option.
  38822. */
  38823. crop?: boolean;
  38824. /**
  38825. * (Highcharts, Highstock, Gantt) Whether to defer displaying the data
  38826. * labels until the initial series animation has finished. Setting to
  38827. * `false` renders the data label immediately. If set to `true` inherits the
  38828. * defer time set in plotOptions.series.animation.
  38829. */
  38830. defer?: boolean;
  38831. /**
  38832. * (Highcharts, Highstock, Highmaps, Gantt) Enable or disable the data
  38833. * labels.
  38834. */
  38835. enabled?: boolean;
  38836. /**
  38837. * (Highcharts, Highstock, Highmaps, Gantt) A declarative filter to control
  38838. * of which data labels to display. The declarative filter is designed for
  38839. * use when callback functions are not available, like when the chart
  38840. * options require a pure JSON structure or for use with graphical editors.
  38841. * For programmatic control, use the `formatter` instead, and return
  38842. * `undefined` to disable a single data label.
  38843. */
  38844. filter?: DataLabelsFilterOptionsObject;
  38845. /**
  38846. * (Highcharts, Highstock, Highmaps, Gantt) A format string for the data
  38847. * label. Available variables are the same as for `formatter`.
  38848. */
  38849. format?: string;
  38850. /**
  38851. * (Highcharts, Highstock, Highmaps, Gantt) Callback JavaScript function to
  38852. * format the data label. Note that if a `format` is defined, the format
  38853. * takes precedence and the formatter is ignored.
  38854. */
  38855. formatter?: DataLabelsFormatterCallbackFunction;
  38856. /**
  38857. * (Highcharts, Highstock, Highmaps, Gantt) For points with an extent, like
  38858. * columns or map areas, whether to align the data label inside the box or
  38859. * to the actual value point. Defaults to `false` in most cases, `true` in
  38860. * stacked columns.
  38861. */
  38862. inside?: boolean;
  38863. /**
  38864. * (Highcharts, Highstock, Highmaps, Gantt) Format for points with the value
  38865. * of null. Works analogously to format. `nullFormat` can be applied only to
  38866. * series which support displaying null points.
  38867. */
  38868. nullFormat?: (boolean|string);
  38869. /**
  38870. * (Highcharts, Highstock, Highmaps, Gantt) Callback JavaScript function
  38871. * that defines formatting for points with the value of null. Works
  38872. * analogously to formatter. `nullPointFormatter` can be applied only to
  38873. * series which support displaying null points.
  38874. */
  38875. nullFormatter?: DataLabelsFormatterCallbackFunction;
  38876. /**
  38877. * (Highcharts, Highstock, Highmaps, Gantt) How to handle data labels that
  38878. * flow outside the plot area. The default is `"justify"`, which aligns them
  38879. * inside the plot area. For columns and bars, this means it will be moved
  38880. * inside the bar. To display data labels outside the plot area, set `crop`
  38881. * to `false` and `overflow` to `"allow"`.
  38882. */
  38883. overflow?: DataLabelsOverflowValue;
  38884. /**
  38885. * (Highcharts, Highstock, Highmaps, Gantt) When either the `borderWidth` or
  38886. * the `backgroundColor` is set, this is the padding within the box.
  38887. */
  38888. padding?: number;
  38889. /**
  38890. * (Highcharts, Highstock, Highmaps, Gantt) Aligns data labels relative to
  38891. * points. If `center` alignment is not possible, it defaults to `right`.
  38892. */
  38893. position?: AlignValue;
  38894. /**
  38895. * (Highcharts, Highstock, Highmaps, Gantt) Text rotation in degrees. Note
  38896. * that due to a more complex structure, backgrounds, borders and padding
  38897. * will be lost on a rotated data label.
  38898. */
  38899. rotation?: number;
  38900. /**
  38901. * (Highcharts, Highstock, Highmaps, Gantt) The shadow of the box. Works
  38902. * best with `borderWidth` or `backgroundColor`. Since 2.3 the shadow can be
  38903. * an object configuration containing `color`, `offsetX`, `offsetY`,
  38904. * `opacity` and `width`.
  38905. */
  38906. shadow?: (boolean|ShadowOptionsObject);
  38907. /**
  38908. * (Highcharts, Highstock, Highmaps, Gantt) The name of a symbol to use for
  38909. * the border around the label. Symbols are predefined functions on the
  38910. * Renderer object.
  38911. */
  38912. shape?: string;
  38913. /**
  38914. * (Highcharts, Highstock, Highmaps, Gantt) Styles for the label. The
  38915. * default `color` setting is `"contrast"`, which is a pseudo color that
  38916. * Highcharts picks up and applies the maximum contrast to the underlying
  38917. * point item, for example the bar in a bar chart.
  38918. *
  38919. * The `textOutline` is a pseudo property that applies an outline of the
  38920. * given width with the given color, which by default is the maximum
  38921. * contrast to the text. So a bright text color will result in a black text
  38922. * outline for maximum readability on a mixed background. In some cases,
  38923. * especially with grayscale text, the text outline doesn't work well, in
  38924. * which cases it can be disabled by setting it to `"none"`. When `useHTML`
  38925. * is true, the `textOutline` will not be picked up. In this, case, the same
  38926. * effect can be acheived through the `text-shadow` CSS property.
  38927. *
  38928. * For some series types, where each point has an extent, like for example
  38929. * tree maps, the data label may overflow the point. There are two
  38930. * strategies for handling overflow. By default, the text will wrap to
  38931. * multiple lines. The other strategy is to set `style.textOverflow` to
  38932. * `ellipsis`, which will keep the text on one line plus it will break
  38933. * inside long words.
  38934. */
  38935. style?: CSSObject;
  38936. /**
  38937. * (Highcharts, Highstock, Highmaps, Gantt) Options for a label text which
  38938. * should follow marker's shape. Border and background are disabled for a
  38939. * label that follows a path.
  38940. *
  38941. * **Note:** Only SVG-based renderer supports this option. Setting `useHTML`
  38942. * to true will disable this option.
  38943. */
  38944. textPath?: DataLabelsTextPathOptionsObject;
  38945. /**
  38946. * (Highcharts, Highstock, Highmaps, Gantt) Whether to use HTML to render
  38947. * the labels.
  38948. */
  38949. useHTML?: boolean;
  38950. /**
  38951. * (Highcharts, Highstock, Highmaps, Gantt) The vertical alignment of a data
  38952. * label. Can be one of `top`, `middle` or `bottom`. The default value
  38953. * depends on the data, for instance in a column chart, the label is above
  38954. * positive values and below negative values.
  38955. */
  38956. verticalAlign?: (VerticalAlignValue|null);
  38957. /**
  38958. * (Highcharts, Highstock, Highmaps, Gantt) The x position offset of the
  38959. * label relative to the point in pixels.
  38960. */
  38961. x?: number;
  38962. /**
  38963. * (Highcharts, Highstock, Highmaps, Gantt) The y position offset of the
  38964. * label relative to the point in pixels.
  38965. */
  38966. y?: number;
  38967. /**
  38968. * (Highcharts, Highstock, Highmaps, Gantt) The Z index of the data labels.
  38969. * The default Z index puts it above the series. Use a Z index of 2 to
  38970. * display it behind the series.
  38971. */
  38972. z?: number;
  38973. }
  38974. /**
  38975. * (Highcharts, Highstock) Options for the series data sorting.
  38976. */
  38977. export interface PlotDpoDataSortingOptions {
  38978. /**
  38979. * (Highcharts, Highstock) Enable or disable data sorting for the series.
  38980. * Use xAxis.reversed to change the sorting order.
  38981. */
  38982. enabled?: boolean;
  38983. /**
  38984. * (Highcharts, Highstock) Whether to allow matching points by name in an
  38985. * update. If this option is disabled, points will be matched by order.
  38986. */
  38987. matchByName?: boolean;
  38988. /**
  38989. * (Highcharts, Highstock) Determines what data value should be used to sort
  38990. * by.
  38991. */
  38992. sortKey?: string;
  38993. }
  38994. /**
  38995. * (Highstock) Detrended Price Oscillator. This series requires the `linkedTo`
  38996. * option to be set and should be loaded after the
  38997. * `stock/indicators/indicators.js`.
  38998. *
  38999. * In TypeScript the type option must always be set.
  39000. *
  39001. * Configuration options for the series are given in three levels:
  39002. *
  39003. * 1. Options for all series in a chart are defined in the plotOptions.series
  39004. * object.
  39005. *
  39006. * 2. Options for all `dpo` series are defined in plotOptions.dpo.
  39007. *
  39008. * 3. Options for one single series are given in the series instance array. (see
  39009. * online documentation for example)
  39010. */
  39011. export interface PlotDpoOptions {
  39012. /**
  39013. * (Highstock) Accessibility options for a series.
  39014. */
  39015. accessibility?: SeriesAccessibilityOptionsObject;
  39016. /**
  39017. * (Highstock) Allow this series' points to be selected by clicking on the
  39018. * graphic (columns, point markers, pie slices, map areas etc).
  39019. *
  39020. * The selected points can be handled by point select and unselect events,
  39021. * or collectively by the getSelectedPoints function.
  39022. *
  39023. * And alternative way of selecting points is through dragging.
  39024. */
  39025. allowPointSelect?: boolean;
  39026. /**
  39027. * (Highstock) Enable or disable the initial animation when a series is
  39028. * displayed. The animation can also be set as a configuration object.
  39029. * Please note that this option only applies to the initial animation of the
  39030. * series itself. For other animations, see chart.animation and the
  39031. * animation parameter under the API methods. The following properties are
  39032. * supported:
  39033. *
  39034. * - `defer`: The animation delay time in milliseconds.
  39035. *
  39036. * - `duration`: The duration of the animation in milliseconds.
  39037. *
  39038. * - `easing`: Can be a string reference to an easing function set on the
  39039. * `Math` object or a function. See the _Custom easing function_ demo below.
  39040. *
  39041. * Due to poor performance, animation is disabled in old IE browsers for
  39042. * several chart types.
  39043. */
  39044. animation?: (boolean|PlotDpoAnimationOptions|Partial<AnimationOptionsObject>);
  39045. /**
  39046. * (Highstock) For some series, there is a limit that shuts down initial
  39047. * animation by default when the total number of points in the chart is too
  39048. * high. For example, for a column chart and its derivatives, animation does
  39049. * not run if there is more than 250 points totally. To disable this cap,
  39050. * set `animationLimit` to `Infinity`.
  39051. */
  39052. animationLimit?: number;
  39053. /**
  39054. * (Highstock) Sets the color blending in the boost module.
  39055. */
  39056. boostBlending?: OptionsBoostBlendingValue;
  39057. /**
  39058. * (Highstock) Set the point threshold for when a series should enter boost
  39059. * mode.
  39060. *
  39061. * Setting it to e.g. 2000 will cause the series to enter boost mode when
  39062. * there are 2000 or more points in the series.
  39063. *
  39064. * To disable boosting on the series, set the `boostThreshold` to 0. Setting
  39065. * it to 1 will force boosting.
  39066. *
  39067. * Note that the cropThreshold also affects this setting. When zooming in on
  39068. * a series that has fewer points than the `cropThreshold`, all points are
  39069. * rendered although outside the visible plot area, and the `boostThreshold`
  39070. * won't take effect.
  39071. */
  39072. boostThreshold?: number;
  39073. /**
  39074. * (Highmaps) The border color of the map areas.
  39075. *
  39076. * In styled mode, the border stroke is given in the `.highcharts-point`
  39077. * class.
  39078. */
  39079. borderColor?: (ColorString|GradientColorObject|PatternObject);
  39080. /**
  39081. * (Highmaps) The border width of each map area.
  39082. *
  39083. * In styled mode, the border stroke width is given in the
  39084. * `.highcharts-point` class.
  39085. */
  39086. borderWidth?: number;
  39087. /**
  39088. * (Highstock) An additional class name to apply to the series' graphical
  39089. * elements. This option does not replace default class names of the
  39090. * graphical element.
  39091. */
  39092. className?: string;
  39093. /**
  39094. * (Highstock) Disable this option to allow series rendering in the whole
  39095. * plotting area.
  39096. *
  39097. * **Note:** Clipping should be always enabled when chart.zoomType is set
  39098. */
  39099. clip?: boolean;
  39100. /**
  39101. * (Highstock) The main color of the series. In line type series it applies
  39102. * to the line and the point markers unless otherwise specified. In bar type
  39103. * series it applies to the bars unless a color is specified per point. The
  39104. * default value is pulled from the `options.colors` array.
  39105. *
  39106. * In styled mode, the color can be defined by the colorIndex option. Also,
  39107. * the series color can be set with the `.highcharts-series`,
  39108. * `.highcharts-color-{n}`, `.highcharts-{type}-series` or
  39109. * `.highcharts-series-{n}` class, or individual classes given by the
  39110. * `className` option.
  39111. */
  39112. color?: (ColorString|GradientColorObject|PatternObject);
  39113. /**
  39114. * (Highstock) Styled mode only. A specific color index to use for the
  39115. * series, so its graphic representations are given the class name
  39116. * `highcharts-color-{n}`.
  39117. */
  39118. colorIndex?: number;
  39119. /**
  39120. * (Highcharts, Highstock, Highmaps) Determines what data value should be
  39121. * used to calculate point color if `colorAxis` is used. Requires to set
  39122. * `min` and `max` if some custom point property is used or if approximation
  39123. * for data grouping is set to `'sum'`.
  39124. */
  39125. colorKey?: string;
  39126. /**
  39127. * (Highstock) Defines if comparison should start from the first point
  39128. * within the visible range or should start from the first point **before**
  39129. * the range.
  39130. *
  39131. * In other words, this flag determines if first point within the visible
  39132. * range will have 0% (`compareStart=true`) or should have been already
  39133. * calculated according to the previous point (`compareStart=false`).
  39134. */
  39135. compareStart?: boolean;
  39136. /**
  39137. * (Highstock) Whether to compare indicator to the main series values or
  39138. * indicator values.
  39139. */
  39140. compareToMain?: boolean;
  39141. /**
  39142. * (Highcharts) Polar charts only. Whether to connect the ends of a line
  39143. * series plot across the extremes.
  39144. */
  39145. connectEnds?: boolean;
  39146. /**
  39147. * (Highcharts, Highstock) Whether to connect a graph line across null
  39148. * points, or render a gap between the two points on either side of the
  39149. * null.
  39150. */
  39151. connectNulls?: boolean;
  39152. /**
  39153. * (Gantt) Override Pathfinder connector options for a series. Requires
  39154. * Highcharts Gantt to be loaded.
  39155. */
  39156. connectors?: SeriesConnectorsOptionsObject;
  39157. /**
  39158. * (Highcharts, Highstock, Gantt) When true, each point or column edge is
  39159. * rounded to its nearest pixel in order to render sharp on screen. In some
  39160. * cases, when there are a lot of densely packed columns, this leads to
  39161. * visible difference in column widths or distance between columns. In these
  39162. * cases, setting `crisp` to `false` may look better, even though each
  39163. * column is rendered blurry.
  39164. */
  39165. crisp?: boolean;
  39166. /**
  39167. * (Highcharts, Highstock) When the series contains less points than the
  39168. * crop threshold, all points are drawn, even if the points fall outside the
  39169. * visible plot area at the current zoom. The advantage of drawing all
  39170. * points (including markers and columns), is that animation is performed on
  39171. * updates. On the other hand, when the series contains more points than the
  39172. * crop threshold, the series data is cropped to only contain points that
  39173. * fall within the plot area. The advantage of cropping away invisible
  39174. * points is to increase performance on large series.
  39175. */
  39176. cropThreshold?: number;
  39177. /**
  39178. * (Highstock) You can set the cursor to "pointer" if you have click events
  39179. * attached to the series, to signal to the user that the points and lines
  39180. * can be clicked.
  39181. *
  39182. * In styled mode, the series cursor can be set with the same classes as
  39183. * listed under series.color.
  39184. */
  39185. cursor?: (string|CursorValue);
  39186. /**
  39187. * (Highstock) A reserved subspace to store options and values for
  39188. * customized functionality. Here you can add additional data for your own
  39189. * event callbacks and formatter callbacks.
  39190. */
  39191. custom?: Dictionary<any>;
  39192. /**
  39193. * (Highstock) Name of the dash style to use for the graph, or for some
  39194. * series types the outline of each shape.
  39195. *
  39196. * In styled mode, the stroke dash-array can be set with the same classes as
  39197. * listed under series.color.
  39198. */
  39199. dashStyle?: DashStyleValue;
  39200. /**
  39201. * (Highstock) Data grouping is the concept of sampling the data values into
  39202. * larger blocks in order to ease readability and increase performance of
  39203. * the JavaScript charts. Highstock by default applies data grouping when
  39204. * the points become closer than a certain pixel value, determined by the
  39205. * `groupPixelWidth` option.
  39206. *
  39207. * If data grouping is applied, the grouping information of grouped points
  39208. * can be read from the Point.dataGroup. If point options other than the
  39209. * data itself are set, for example `name` or `color` or custom properties,
  39210. * the grouping logic doesn't know how to group it. In this case the options
  39211. * of the first point instance are copied over to the group point. This can
  39212. * be altered through a custom `approximation` callback function.
  39213. */
  39214. dataGrouping?: DataGroupingOptionsObject;
  39215. /**
  39216. * (Highcharts, Highstock, Highmaps, Gantt) Options for the series data
  39217. * labels, appearing next to each data point.
  39218. *
  39219. * Since v6.2.0, multiple data labels can be applied to each single point by
  39220. * defining them as an array of configs.
  39221. *
  39222. * In styled mode, the data labels can be styled with the
  39223. * `.highcharts-data-label-box` and `.highcharts-data-label` class names
  39224. * (see example).
  39225. */
  39226. dataLabels?: (PlotDpoDataLabelsOptions|Array<PlotDpoDataLabelsOptions>);
  39227. /**
  39228. * (Highcharts, Highstock) Options for the series data sorting.
  39229. */
  39230. dataSorting?: (DataSortingOptionsObject|PlotDpoDataSortingOptions);
  39231. /**
  39232. * (Highstock) A description of the series to add to the screen reader
  39233. * information about the series.
  39234. */
  39235. description?: string;
  39236. /**
  39237. * (Highstock) Enable or disable the mouse tracking for a specific series.
  39238. * This includes point tooltips and click events on graphs and points. For
  39239. * large datasets it improves performance.
  39240. */
  39241. enableMouseTracking?: boolean;
  39242. /**
  39243. * (Highstock) General event handlers for the series items. These event
  39244. * hooks can also be attached to the series at run time using the
  39245. * `Highcharts.addEvent` function.
  39246. */
  39247. events?: SeriesEventsOptionsObject;
  39248. /**
  39249. * (Highstock) Determines whether the series should look for the nearest
  39250. * point in both dimensions or just the x-dimension when hovering the
  39251. * series. Defaults to `'xy'` for scatter series and `'x'` for most other
  39252. * series. If the data has duplicate x-values, it is recommended to set this
  39253. * to `'xy'` to allow hovering over all points.
  39254. *
  39255. * Applies only to series types using nearest neighbor search (not direct
  39256. * hover) for tooltip.
  39257. */
  39258. findNearestPointBy?: OptionsFindNearestPointByValue;
  39259. /**
  39260. * (Highstock) Defines when to display a gap in the graph, together with the
  39261. * gapUnit option.
  39262. *
  39263. * In case when `dataGrouping` is enabled, points can be grouped into a
  39264. * larger time span. This can make the grouped points to have a greater
  39265. * distance than the absolute value of `gapSize` property, which will result
  39266. * in disappearing graph completely. To prevent this situation the mentioned
  39267. * distance between grouped points is used instead of previously defined
  39268. * `gapSize`.
  39269. *
  39270. * In practice, this option is most often used to visualize gaps in time
  39271. * series. In a stock chart, intraday data is available for daytime hours,
  39272. * while gaps will appear in nights and weekends.
  39273. */
  39274. gapSize?: number;
  39275. /**
  39276. * (Highstock) Together with gapSize, this option defines where to draw gaps
  39277. * in the graph.
  39278. *
  39279. * When the `gapUnit` is `"relative"` (default), a gap size of 5 means that
  39280. * if the distance between two points is greater than 5 times that of the
  39281. * two closest points, the graph will be broken.
  39282. *
  39283. * When the `gapUnit` is `"value"`, the gap is based on absolute axis
  39284. * values, which on a datetime axis is milliseconds. This also applies to
  39285. * the navigator series that inherits gap options from the base series.
  39286. */
  39287. gapUnit?: OptionsGapUnitValue;
  39288. /**
  39289. * (Highcharts, Highstock, Gantt) Whether to use the Y extremes of the total
  39290. * chart width or only the zoomed area when zooming in on parts of the X
  39291. * axis. By default, the Y axis adjusts to the min and max of the visible
  39292. * data. Cartesian series only.
  39293. */
  39294. getExtremesFromAll?: boolean;
  39295. /**
  39296. * (Highstock) When set to `false` will prevent the series data from being
  39297. * included in any form of data export.
  39298. *
  39299. * Since version 6.0.0 until 7.1.0 the option was existing undocumented as
  39300. * `includeInCSVExport`.
  39301. */
  39302. includeInDataExport?: boolean;
  39303. /**
  39304. * (Highcharts, Highstock, Gantt) Series labels are placed as close to the
  39305. * series as possible in a natural way, seeking to avoid other series. The
  39306. * goal of this feature is to make the chart more easily readable, like if a
  39307. * human designer placed the labels in the optimal position.
  39308. *
  39309. * The series labels currently work with series types having a `graph` or an
  39310. * `area`.
  39311. */
  39312. label?: SeriesLabelOptionsObject;
  39313. /**
  39314. * (Highstock) The line marks the last price from all points.
  39315. */
  39316. lastPrice?: SeriesLastPriceOptionsObject;
  39317. /**
  39318. * (Highstock) The line marks the last price from visible range of points.
  39319. */
  39320. lastVisiblePrice?: SeriesLastVisiblePriceOptionsObject;
  39321. /**
  39322. * (Highcharts, Highstock) The SVG value used for the `stroke-linecap` and
  39323. * `stroke-linejoin` of a line graph. Round means that lines are rounded in
  39324. * the ends and bends.
  39325. */
  39326. linecap?: SeriesLinecapValue;
  39327. /**
  39328. * (Highcharts, Highstock) Pixel width of the graph line.
  39329. */
  39330. lineWidth?: number;
  39331. /**
  39332. * (Highcharts, Highstock, Gantt) The main series ID that indicator will be
  39333. * based on. Required for this indicator.
  39334. */
  39335. linkedTo?: string;
  39336. /**
  39337. * (Highstock) Options for the point markers of line-like series. Properties
  39338. * like `fillColor`, `lineColor` and `lineWidth` define the visual
  39339. * appearance of the markers. Other series types, like column series, don't
  39340. * have markers, but have visual options on the series level instead.
  39341. *
  39342. * In styled mode, the markers can be styled with the `.highcharts-point`,
  39343. * `.highcharts-point-hover` and `.highcharts-point-select` class names.
  39344. */
  39345. marker?: PointMarkerOptionsObject;
  39346. /**
  39347. * (Highstock) The name of the series as shown in the legend, tooltip etc.
  39348. * If not set, it will be based on a technical indicator type and default
  39349. * params.
  39350. */
  39351. name?: string;
  39352. /**
  39353. * (Highstock) The color for the parts of the graph or points that are below
  39354. * the threshold. Note that `zones` takes precedence over the negative
  39355. * color. Using `negativeColor` is equivalent to applying a zone with value
  39356. * of 0.
  39357. */
  39358. negativeColor?: (ColorString|GradientColorObject|PatternObject);
  39359. /**
  39360. * (Highstock) Opacity of a series parts: line, fill (e.g. area) and
  39361. * dataLabels.
  39362. */
  39363. opacity?: number;
  39364. /**
  39365. * (Highstock) Parameters used in calculation of Detrended Price Oscillator
  39366. * series points.
  39367. */
  39368. params?: PlotDpoParamsOptions;
  39369. /**
  39370. * (Highstock) Properties for each single point.
  39371. */
  39372. point?: PlotSeriesPointOptions;
  39373. /**
  39374. * (Highstock) Same as accessibility.pointDescriptionFormatter, but for an
  39375. * individual series. Overrides the chart wide configuration.
  39376. */
  39377. pointDescriptionFormatter?: Function;
  39378. /**
  39379. * (Highstock) Whether to select the series initially. If `showCheckbox` is
  39380. * true, the checkbox next to the series name in the legend will be checked
  39381. * for a selected series.
  39382. */
  39383. selected?: boolean;
  39384. /**
  39385. * (Highstock) Whether to apply a drop shadow to the graph line. Since 2.3
  39386. * the shadow can be an object configuration containing `color`, `offsetX`,
  39387. * `offsetY`, `opacity` and `width`.
  39388. */
  39389. shadow?: (boolean|ShadowOptionsObject);
  39390. /**
  39391. * (Highstock) If true, a checkbox is displayed next to the legend item to
  39392. * allow selecting the series. The state of the checkbox is determined by
  39393. * the `selected` option.
  39394. */
  39395. showCheckbox?: boolean;
  39396. /**
  39397. * (Highstock) Whether to display this particular series or series type in
  39398. * the legend. Standalone series are shown in legend by default, and linked
  39399. * series are not. Since v7.2.0 it is possible to show series that use
  39400. * colorAxis by setting this option to `true`.
  39401. */
  39402. showInLegend?: boolean;
  39403. /**
  39404. * (Highstock) If set to `true`, the accessibility module will skip past the
  39405. * points in this series for keyboard navigation.
  39406. */
  39407. skipKeyboardNavigation?: boolean;
  39408. /**
  39409. * (Highcharts, Highstock) When this is true, the series will not cause the
  39410. * Y axis to cross the zero plane (or threshold option) unless the data
  39411. * actually crosses the plane.
  39412. *
  39413. * For example, if `softThreshold` is `false`, a series of 0, 1, 2, 3 will
  39414. * make the Y axis show negative values according to the `minPadding`
  39415. * option. If `softThreshold` is `true`, the Y axis starts at 0.
  39416. */
  39417. softThreshold?: boolean;
  39418. states?: SeriesStatesOptionsObject;
  39419. /**
  39420. * (Highcharts, Highstock) Whether to apply steps to the line. Possible
  39421. * values are `left`, `center` and `right`.
  39422. */
  39423. step?: OptionsStepValue;
  39424. /**
  39425. * (Highstock) Sticky tracking of mouse events. When true, the `mouseOut`
  39426. * event on a series isn't triggered until the mouse moves over another
  39427. * series, or out of the plot area. When false, the `mouseOut` event on a
  39428. * series is triggered when the mouse leaves the area around the series'
  39429. * graph or markers. This also implies the tooltip when not shared. When
  39430. * `stickyTracking` is false and `tooltip.shared` is false, the tooltip will
  39431. * be hidden when moving the mouse between series. Defaults to true for line
  39432. * and area type series, but to false for columns, pies etc.
  39433. *
  39434. * **Note:** The boost module will force this option because of technical
  39435. * limitations.
  39436. */
  39437. stickyTracking?: boolean;
  39438. /**
  39439. * (Highcharts, Highstock) The threshold, also called zero level or base
  39440. * level. For line type series this is only used in conjunction with
  39441. * negativeColor.
  39442. */
  39443. threshold?: (number|null);
  39444. /**
  39445. * (Highstock) A configuration object for the tooltip rendering of each
  39446. * single series. Properties are inherited from tooltip, but only the
  39447. * following properties can be defined on a series level.
  39448. */
  39449. tooltip?: SeriesTooltipOptionsObject;
  39450. /**
  39451. * (Highcharts, Highstock, Gantt) When a series contains a data array that
  39452. * is longer than this, only one dimensional arrays of numbers, or two
  39453. * dimensional arrays with x and y values are allowed. Also, only the first
  39454. * point is tested, and the rest are assumed to be the same format. This
  39455. * saves expensive data checking and indexing in long series. Set it to `0`
  39456. * disable.
  39457. *
  39458. * Note: In boost mode turbo threshold is forced. Only array of numbers or
  39459. * two dimensional arrays are allowed.
  39460. */
  39461. turboThreshold?: number;
  39462. /**
  39463. * (Highstock) Set the initial visibility of the series.
  39464. */
  39465. visible?: boolean;
  39466. /**
  39467. * (Highmaps) Define the z index of the series.
  39468. */
  39469. zIndex?: number;
  39470. /**
  39471. * (Highcharts, Highstock) Defines the Axis on which the zones are applied.
  39472. */
  39473. zoneAxis?: string;
  39474. /**
  39475. * (Highcharts, Highstock) An array defining zones within a series. Zones
  39476. * can be applied to the X axis, Y axis or Z axis for bubbles, according to
  39477. * the `zoneAxis` option. The zone definitions have to be in ascending order
  39478. * regarding to the value.
  39479. *
  39480. * In styled mode, the color zones are styled with the
  39481. * `.highcharts-zone-{n}` class, or custom classed from the `className`
  39482. * option (view live demo).
  39483. */
  39484. zones?: Array<SeriesZonesOptionsObject>;
  39485. }
  39486. /**
  39487. * (Highstock) Parameters used in calculation of Detrended Price Oscillator
  39488. * series points.
  39489. */
  39490. export interface PlotDpoParamsOptions {
  39491. /**
  39492. * (Highstock) The point index which indicator calculations will base. For
  39493. * example using OHLC data, index=2 means the indicator will be calculated
  39494. * using Low values.
  39495. */
  39496. index?: number;
  39497. /**
  39498. * (Highstock) Period for Detrended Price Oscillator
  39499. */
  39500. period?: number;
  39501. }
  39502. /**
  39503. * (Highcharts, Highstock) Enable or disable the initial animation when a series
  39504. * is displayed. The animation can also be set as a configuration object. Please
  39505. * note that this option only applies to the initial animation of the series
  39506. * itself. For other animations, see chart.animation and the animation parameter
  39507. * under the API methods. The following properties are supported:
  39508. *
  39509. * - `defer`: The animation delay time in milliseconds.
  39510. *
  39511. * - `duration`: The duration of the animation in milliseconds.
  39512. *
  39513. * - `easing`: Can be a string reference to an easing function set on the `Math`
  39514. * object or a function. See the _Custom easing function_ demo below.
  39515. *
  39516. * Due to poor performance, animation is disabled in old IE browsers for several
  39517. * chart types.
  39518. */
  39519. export interface PlotDumbbellAnimationOptions {
  39520. defer?: number;
  39521. }
  39522. /**
  39523. * (Highcharts, Highstock) Enable or disable the initial animation when a series
  39524. * is displayed for the `dataLabels`. The animation can also be set as a
  39525. * configuration object. Please note that this option only applies to the
  39526. * initial animation. For other animations, see chart.animation and the
  39527. * animation parameter under the API methods. The following properties are
  39528. * supported:
  39529. *
  39530. * - `defer`: The animation delay time in milliseconds.
  39531. */
  39532. export interface PlotDumbbellDataLabelsAnimationOptions {
  39533. /**
  39534. * (Highcharts, Highstock) The animation delay time in milliseconds. Set to
  39535. * `0` renders dataLabel immediately. As `undefined` inherits defer time
  39536. * from the series.animation.defer.
  39537. */
  39538. defer?: number;
  39539. }
  39540. /**
  39541. * (Highcharts, Highstock) Options for the series data sorting.
  39542. */
  39543. export interface PlotDumbbellDataSortingOptions {
  39544. /**
  39545. * (Highcharts, Highstock) Enable or disable data sorting for the series.
  39546. * Use xAxis.reversed to change the sorting order.
  39547. */
  39548. enabled?: boolean;
  39549. /**
  39550. * (Highcharts, Highstock) Whether to allow matching points by name in an
  39551. * update. If this option is disabled, points will be matched by order.
  39552. */
  39553. matchByName?: boolean;
  39554. /**
  39555. * (Highcharts, Highstock) Determines what data value should be used to sort
  39556. * by.
  39557. */
  39558. sortKey?: string;
  39559. }
  39560. /**
  39561. * (Highcharts, Highstock) Style options for the guide box. The guide box has
  39562. * one state by default, the `default` state.
  39563. */
  39564. export interface PlotDumbbellDragDropGuideBoxOptions {
  39565. /**
  39566. * (Highcharts, Highstock) Style options for the guide box default state.
  39567. */
  39568. default?: DragDropGuideBoxOptionsObject;
  39569. }
  39570. /**
  39571. * (Highcharts, Highstock) The dumbbell series is a cartesian series with higher
  39572. * and lower values for each point along an X axis, connected with a line
  39573. * between the values.
  39574. *
  39575. * Requires `highcharts-more.js` and `modules/dumbbell.js`.
  39576. *
  39577. * In TypeScript the type option must always be set.
  39578. *
  39579. * Configuration options for the series are given in three levels:
  39580. *
  39581. * 1. Options for all series in a chart are defined in the plotOptions.series
  39582. * object.
  39583. *
  39584. * 2. Options for all `dumbbell` series are defined in plotOptions.dumbbell.
  39585. *
  39586. * 3. Options for one single series are given in the series instance array. (see
  39587. * online documentation for example)
  39588. */
  39589. export interface PlotDumbbellOptions {
  39590. /**
  39591. * (Highcharts, Highstock) Accessibility options for a series.
  39592. */
  39593. accessibility?: SeriesAccessibilityOptionsObject;
  39594. /**
  39595. * (Highmaps) Whether all areas of the map defined in `mapData` should be
  39596. * rendered. If `true`, areas which don't correspond to a data point, are
  39597. * rendered as `null` points. If `false`, those areas are skipped.
  39598. */
  39599. allAreas?: boolean;
  39600. /**
  39601. * (Highcharts, Highstock) Allow this series' points to be selected by
  39602. * clicking on the graphic (columns, point markers, pie slices, map areas
  39603. * etc).
  39604. *
  39605. * The selected points can be handled by point select and unselect events,
  39606. * or collectively by the getSelectedPoints function.
  39607. *
  39608. * And alternative way of selecting points is through dragging.
  39609. */
  39610. allowPointSelect?: boolean;
  39611. /**
  39612. * (Highcharts, Highstock) Enable or disable the initial animation when a
  39613. * series is displayed. The animation can also be set as a configuration
  39614. * object. Please note that this option only applies to the initial
  39615. * animation of the series itself. For other animations, see chart.animation
  39616. * and the animation parameter under the API methods. The following
  39617. * properties are supported:
  39618. *
  39619. * - `defer`: The animation delay time in milliseconds.
  39620. *
  39621. * - `duration`: The duration of the animation in milliseconds.
  39622. *
  39623. * - `easing`: Can be a string reference to an easing function set on the
  39624. * `Math` object or a function. See the _Custom easing function_ demo below.
  39625. *
  39626. * Due to poor performance, animation is disabled in old IE browsers for
  39627. * several chart types.
  39628. */
  39629. animation?: (boolean|PlotDumbbellAnimationOptions|Partial<AnimationOptionsObject>);
  39630. /**
  39631. * (Highcharts, Highstock) For some series, there is a limit that shuts down
  39632. * initial animation by default when the total number of points in the chart
  39633. * is too high. For example, for a column chart and its derivatives,
  39634. * animation does not run if there is more than 250 points totally. To
  39635. * disable this cap, set `animationLimit` to `Infinity`.
  39636. */
  39637. animationLimit?: number;
  39638. /**
  39639. * (Highmaps) The border color of the map areas.
  39640. *
  39641. * In styled mode, the border stroke is given in the `.highcharts-point`
  39642. * class.
  39643. */
  39644. borderColor?: (ColorString|GradientColorObject|PatternObject);
  39645. /**
  39646. * (Highmaps) The border width of each map area.
  39647. *
  39648. * In styled mode, the border stroke width is given in the
  39649. * `.highcharts-point` class.
  39650. */
  39651. borderWidth?: number;
  39652. /**
  39653. * (Highcharts, Highstock) An additional class name to apply to the series'
  39654. * graphical elements. This option does not replace default class names of
  39655. * the graphical element.
  39656. */
  39657. className?: string;
  39658. /**
  39659. * (Highcharts, Highstock) Disable this option to allow series rendering in
  39660. * the whole plotting area.
  39661. *
  39662. * **Note:** Clipping should be always enabled when chart.zoomType is set
  39663. */
  39664. clip?: boolean;
  39665. /**
  39666. * (Highcharts, Highstock) The main color of the series. In line type series
  39667. * it applies to the line and the point markers unless otherwise specified.
  39668. * In bar type series it applies to the bars unless a color is specified per
  39669. * point. The default value is pulled from the `options.colors` array.
  39670. *
  39671. * In styled mode, the color can be defined by the colorIndex option. Also,
  39672. * the series color can be set with the `.highcharts-series`,
  39673. * `.highcharts-color-{n}`, `.highcharts-{type}-series` or
  39674. * `.highcharts-series-{n}` class, or individual classes given by the
  39675. * `className` option.
  39676. */
  39677. color?: (ColorString|GradientColorObject|PatternObject);
  39678. /**
  39679. * (Highcharts, Highstock, Highmaps) When using dual or multiple color axes,
  39680. * this number defines which colorAxis the particular series is connected
  39681. * to. It refers to either the axis id or the index of the axis in the
  39682. * colorAxis array, with 0 being the first. Set this option to false to
  39683. * prevent a series from connecting to the default color axis.
  39684. *
  39685. * Since v7.2.0 the option can also be an axis id or an axis index instead
  39686. * of a boolean flag.
  39687. */
  39688. colorAxis?: (boolean|number|string);
  39689. /**
  39690. * (Highcharts, Highstock) Styled mode only. A specific color index to use
  39691. * for the series, so its graphic representations are given the class name
  39692. * `highcharts-color-{n}`.
  39693. */
  39694. colorIndex?: number;
  39695. /**
  39696. * (Highcharts, Highstock, Highmaps) Determines what data value should be
  39697. * used to calculate point color if `colorAxis` is used. Requires to set
  39698. * `min` and `max` if some custom point property is used or if approximation
  39699. * for data grouping is set to `'sum'`.
  39700. */
  39701. colorKey?: string;
  39702. /**
  39703. * (Highstock) Compare the values of the series against the first non-null,
  39704. * non- zero value in the visible range. The y axis will show percentage or
  39705. * absolute change depending on whether `compare` is set to `"percent"` or
  39706. * `"value"`. When this is applied to multiple series, it allows comparing
  39707. * the development of the series against each other. Adds a `change` field
  39708. * to every point object.
  39709. */
  39710. compare?: string;
  39711. /**
  39712. * (Highstock) When compare is `percent`, this option dictates whether to
  39713. * use 0 or 100 as the base of comparison.
  39714. */
  39715. compareBase?: (0|100);
  39716. /**
  39717. * (Highstock) Defines if comparison should start from the first point
  39718. * within the visible range or should start from the first point **before**
  39719. * the range.
  39720. *
  39721. * In other words, this flag determines if first point within the visible
  39722. * range will have 0% (`compareStart=true`) or should have been already
  39723. * calculated according to the previous point (`compareStart=false`).
  39724. */
  39725. compareStart?: boolean;
  39726. /**
  39727. * (Highcharts) Polar charts only. Whether to connect the ends of a line
  39728. * series plot across the extremes.
  39729. */
  39730. connectEnds?: boolean;
  39731. /**
  39732. * (Highcharts, Highstock) Whether to connect a graph line across null
  39733. * points, or render a gap between the two points on either side of the
  39734. * null.
  39735. */
  39736. connectNulls?: boolean;
  39737. /**
  39738. * (Highcharts, Highstock) Color of the line that connects the dumbbell
  39739. * point's values. By default it is the series' color.
  39740. */
  39741. connectorColor?: string;
  39742. /**
  39743. * (Gantt) Override Pathfinder connector options for a series. Requires
  39744. * Highcharts Gantt to be loaded.
  39745. */
  39746. connectors?: SeriesConnectorsOptionsObject;
  39747. /**
  39748. * (Highcharts, Highstock) Pixel width of the line that connects the
  39749. * dumbbell point's values.
  39750. */
  39751. connectorWidth?: number;
  39752. /**
  39753. * (Highcharts, Highstock, Gantt) When true, each point or column edge is
  39754. * rounded to its nearest pixel in order to render sharp on screen. In some
  39755. * cases, when there are a lot of densely packed columns, this leads to
  39756. * visible difference in column widths or distance between columns. In these
  39757. * cases, setting `crisp` to `false` may look better, even though each
  39758. * column is rendered blurry.
  39759. */
  39760. crisp?: boolean;
  39761. /**
  39762. * (Highcharts, Highstock) When the series contains less points than the
  39763. * crop threshold, all points are drawn, even if the points fall outside the
  39764. * visible plot area at the current zoom. The advantage of drawing all
  39765. * points (including markers and columns), is that animation is performed on
  39766. * updates. On the other hand, when the series contains more points than the
  39767. * crop threshold, the series data is cropped to only contain points that
  39768. * fall within the plot area. The advantage of cropping away invisible
  39769. * points is to increase performance on large series.
  39770. */
  39771. cropThreshold?: number;
  39772. /**
  39773. * (Highcharts, Highstock) You can set the cursor to "pointer" if you have
  39774. * click events attached to the series, to signal to the user that the
  39775. * points and lines can be clicked.
  39776. *
  39777. * In styled mode, the series cursor can be set with the same classes as
  39778. * listed under series.color.
  39779. */
  39780. cursor?: (string|CursorValue);
  39781. /**
  39782. * (Highcharts, Highstock) A reserved subspace to store options and values
  39783. * for customized functionality. Here you can add additional data for your
  39784. * own event callbacks and formatter callbacks.
  39785. */
  39786. custom?: Dictionary<any>;
  39787. /**
  39788. * (Highcharts, Highstock) Name of the dash style to use for the graph, or
  39789. * for some series types the outline of each shape.
  39790. *
  39791. * In styled mode, the stroke dash-array can be set with the same classes as
  39792. * listed under series.color.
  39793. */
  39794. dashStyle?: DashStyleValue;
  39795. /**
  39796. * (Highstock) Data grouping is the concept of sampling the data values into
  39797. * larger blocks in order to ease readability and increase performance of
  39798. * the JavaScript charts. Highstock by default applies data grouping when
  39799. * the points become closer than a certain pixel value, determined by the
  39800. * `groupPixelWidth` option.
  39801. *
  39802. * If data grouping is applied, the grouping information of grouped points
  39803. * can be read from the Point.dataGroup. If point options other than the
  39804. * data itself are set, for example `name` or `color` or custom properties,
  39805. * the grouping logic doesn't know how to group it. In this case the options
  39806. * of the first point instance are copied over to the group point. This can
  39807. * be altered through a custom `approximation` callback function.
  39808. */
  39809. dataGrouping?: DataGroupingOptionsObject;
  39810. /**
  39811. * (Highcharts, Highstock) Extended data labels for range series types.
  39812. * Range series data labels use no `x` and `y` options. Instead, they have
  39813. * `xLow`, `xHigh`, `yLow` and `yHigh` options to allow the higher and lower
  39814. * data label sets individually.
  39815. */
  39816. dataLabels?: (SeriesAreaRangeDataLabelsOptionsObject|Array<SeriesAreaRangeDataLabelsOptionsObject>);
  39817. /**
  39818. * (Highcharts, Highstock) Options for the series data sorting.
  39819. */
  39820. dataSorting?: (DataSortingOptionsObject|PlotDumbbellDataSortingOptions);
  39821. /**
  39822. * (Highcharts, Highstock) A description of the series to add to the screen
  39823. * reader information about the series.
  39824. */
  39825. description?: string;
  39826. /**
  39827. * (Highcharts, Highstock) The draggable-points module allows points to be
  39828. * moved around or modified in the chart. In addition to the options
  39829. * mentioned under the `dragDrop` API structure, the module fires three
  39830. * events, point.dragStart, point.drag and point.drop.
  39831. */
  39832. dragDrop?: SeriesDragDropOptionsObject;
  39833. /**
  39834. * (Highcharts, Highstock) Enable or disable the mouse tracking for a
  39835. * specific series. This includes point tooltips and click events on graphs
  39836. * and points. For large datasets it improves performance.
  39837. */
  39838. enableMouseTracking?: boolean;
  39839. /**
  39840. * (Highcharts, Highstock) General event handlers for the series items.
  39841. * These event hooks can also be attached to the series at run time using
  39842. * the `Highcharts.addEvent` function.
  39843. */
  39844. events?: SeriesEventsOptionsObject;
  39845. /**
  39846. * (Highcharts, Highstock) Determines whether the series should look for the
  39847. * nearest point in both dimensions or just the x-dimension when hovering
  39848. * the series. Defaults to `'xy'` for scatter series and `'x'` for most
  39849. * other series. If the data has duplicate x-values, it is recommended to
  39850. * set this to `'xy'` to allow hovering over all points.
  39851. *
  39852. * Applies only to series types using nearest neighbor search (not direct
  39853. * hover) for tooltip.
  39854. */
  39855. findNearestPointBy?: OptionsFindNearestPointByValue;
  39856. /**
  39857. * (Highstock) Defines when to display a gap in the graph, together with the
  39858. * gapUnit option.
  39859. *
  39860. * In case when `dataGrouping` is enabled, points can be grouped into a
  39861. * larger time span. This can make the grouped points to have a greater
  39862. * distance than the absolute value of `gapSize` property, which will result
  39863. * in disappearing graph completely. To prevent this situation the mentioned
  39864. * distance between grouped points is used instead of previously defined
  39865. * `gapSize`.
  39866. *
  39867. * In practice, this option is most often used to visualize gaps in time
  39868. * series. In a stock chart, intraday data is available for daytime hours,
  39869. * while gaps will appear in nights and weekends.
  39870. */
  39871. gapSize?: number;
  39872. /**
  39873. * (Highstock) Together with gapSize, this option defines where to draw gaps
  39874. * in the graph.
  39875. *
  39876. * When the `gapUnit` is `"relative"` (default), a gap size of 5 means that
  39877. * if the distance between two points is greater than 5 times that of the
  39878. * two closest points, the graph will be broken.
  39879. *
  39880. * When the `gapUnit` is `"value"`, the gap is based on absolute axis
  39881. * values, which on a datetime axis is milliseconds. This also applies to
  39882. * the navigator series that inherits gap options from the base series.
  39883. */
  39884. gapUnit?: OptionsGapUnitValue;
  39885. /**
  39886. * (Highcharts, Highstock, Gantt) Whether to use the Y extremes of the total
  39887. * chart width or only the zoomed area when zooming in on parts of the X
  39888. * axis. By default, the Y axis adjusts to the min and max of the visible
  39889. * data. Cartesian series only.
  39890. */
  39891. getExtremesFromAll?: boolean;
  39892. groupPadding?: number;
  39893. /**
  39894. * (Highcharts, Highstock) When set to `false` will prevent the series data
  39895. * from being included in any form of data export.
  39896. *
  39897. * Since version 6.0.0 until 7.1.0 the option was existing undocumented as
  39898. * `includeInCSVExport`.
  39899. */
  39900. includeInDataExport?: boolean;
  39901. /**
  39902. * (Highmaps) What property to join the `mapData` to the value data. For
  39903. * example, if joinBy is "code", the mapData items with a specific code is
  39904. * merged into the data with the same code. For maps loaded from GeoJSON,
  39905. * the keys may be held in each point's `properties` object.
  39906. *
  39907. * The joinBy option can also be an array of two values, where the first
  39908. * points to a key in the `mapData`, and the second points to another key in
  39909. * the `data`.
  39910. *
  39911. * When joinBy is `null`, the map items are joined by their position in the
  39912. * array, which performs much better in maps with many data points. This is
  39913. * the recommended option if you are printing more than a thousand data
  39914. * points and have a backend that can preprocess the data into a parallel
  39915. * array of the mapData.
  39916. */
  39917. joinBy?: (string|Array<string>);
  39918. /**
  39919. * (Highcharts, Highstock) An array specifying which option maps to which
  39920. * key in the data point array. This makes it convenient to work with
  39921. * unstructured data arrays from different sources.
  39922. */
  39923. keys?: Array<string>;
  39924. /**
  39925. * (Highcharts, Highstock, Gantt) Series labels are placed as close to the
  39926. * series as possible in a natural way, seeking to avoid other series. The
  39927. * goal of this feature is to make the chart more easily readable, like if a
  39928. * human designer placed the labels in the optimal position.
  39929. *
  39930. * The series labels currently work with series types having a `graph` or an
  39931. * `area`.
  39932. */
  39933. label?: SeriesLabelOptionsObject;
  39934. /**
  39935. * (Highstock) The line marks the last price from all points.
  39936. */
  39937. lastPrice?: SeriesLastPriceOptionsObject;
  39938. /**
  39939. * (Highstock) The line marks the last price from visible range of points.
  39940. */
  39941. lastVisiblePrice?: SeriesLastVisiblePriceOptionsObject;
  39942. /**
  39943. * (Highcharts, Highstock) The SVG value used for the `stroke-linecap` and
  39944. * `stroke-linejoin` of a line graph. Round means that lines are rounded in
  39945. * the ends and bends.
  39946. */
  39947. linecap?: SeriesLinecapValue;
  39948. /**
  39949. * (Highcharts, Highstock) A separate color for the graph line. By default
  39950. * the line takes the `color` of the series, but the lineColor setting
  39951. * allows setting a separate color for the line without altering the
  39952. * `fillColor`.
  39953. *
  39954. * In styled mode, the line stroke can be set with the `.highcharts-graph`
  39955. * class name.
  39956. */
  39957. lineColor?: (ColorString|GradientColorObject|PatternObject);
  39958. /**
  39959. * (Highcharts, Highstock, Gantt) The id of another series to link to.
  39960. * Additionally, the value can be ":previous" to link to the previous
  39961. * series. When two series are linked, only the first one appears in the
  39962. * legend. Toggling the visibility of this also toggles the linked series.
  39963. *
  39964. * If master series uses data sorting and linked series does not have its
  39965. * own sorting definition, the linked series will be sorted in the same
  39966. * order as the master one.
  39967. */
  39968. linkedTo?: string;
  39969. /**
  39970. * (Highcharts, Highstock) Color of the start markers in a dumbbell graph.
  39971. */
  39972. lowColor?: (ColorString|GradientColorObject|PatternObject);
  39973. /**
  39974. * (Highcharts, Highstock) Options for the point markers of line-like
  39975. * series. Properties like `fillColor`, `lineColor` and `lineWidth` define
  39976. * the visual appearance of the markers. Other series types, like column
  39977. * series, don't have markers, but have visual options on the series level
  39978. * instead.
  39979. *
  39980. * In styled mode, the markers can be styled with the `.highcharts-point`,
  39981. * `.highcharts-point-hover` and `.highcharts-point-select` class names.
  39982. */
  39983. marker?: PointMarkerOptionsObject;
  39984. /**
  39985. * (Highstock) Options for the corresponding navigator series if
  39986. * `showInNavigator` is `true` for this series. Available options are the
  39987. * same as any series, documented at plotOptions and series.
  39988. *
  39989. * These options are merged with options in navigator.series, and will take
  39990. * precedence if the same option is defined both places.
  39991. */
  39992. navigatorOptions?: PlotSeriesOptions;
  39993. /**
  39994. * (Highcharts, Highstock) The color for the parts of the graph or points
  39995. * that are below the threshold. Note that `zones` takes precedence over the
  39996. * negative color. Using `negativeColor` is equivalent to applying a zone
  39997. * with value of 0.
  39998. */
  39999. negativeColor?: (ColorString|GradientColorObject|PatternObject);
  40000. /**
  40001. * (Highcharts) A separate color for the negative part of the area.
  40002. *
  40003. * In styled mode, a negative color is set with the `.highcharts-negative`
  40004. * class name.
  40005. */
  40006. negativeFillColor?: (ColorString|GradientColorObject|PatternObject);
  40007. /**
  40008. * (Highcharts, Highstock) Opacity of a series parts: line, fill (e.g. area)
  40009. * and dataLabels.
  40010. */
  40011. opacity?: number;
  40012. /**
  40013. * (Highcharts, Highstock) Properties for each single point.
  40014. */
  40015. point?: PlotSeriesPointOptions;
  40016. /**
  40017. * (Highcharts, Highstock) Same as accessibility.pointDescriptionFormatter,
  40018. * but for an individual series. Overrides the chart wide configuration.
  40019. */
  40020. pointDescriptionFormatter?: Function;
  40021. /**
  40022. * (Highcharts, Highstock, Gantt) If no x values are given for the points in
  40023. * a series, `pointInterval` defines the interval of the x values. For
  40024. * example, if a series contains one value every decade starting from year
  40025. * 0, set `pointInterval` to `10`. In true `datetime` axes, the
  40026. * `pointInterval` is set in milliseconds.
  40027. *
  40028. * It can be also be combined with `pointIntervalUnit` to draw irregular
  40029. * time intervals.
  40030. *
  40031. * Please note that this options applies to the _series data_, not the
  40032. * interval of the axis ticks, which is independent.
  40033. */
  40034. pointInterval?: number;
  40035. /**
  40036. * (Highcharts, Highstock, Gantt) On datetime series, this allows for
  40037. * setting the pointInterval to irregular time units, `day`, `month` and
  40038. * `year`. A day is usually the same as 24 hours, but `pointIntervalUnit`
  40039. * also takes the DST crossover into consideration when dealing with local
  40040. * time. Combine this option with `pointInterval` to draw weeks, quarters, 6
  40041. * months, 10 years etc.
  40042. *
  40043. * Please note that this options applies to the _series data_, not the
  40044. * interval of the axis ticks, which is independent.
  40045. */
  40046. pointIntervalUnit?: OptionsPointIntervalUnitValue;
  40047. pointPadding?: number;
  40048. /**
  40049. * (Highcharts, Highstock, Gantt) Possible values: `"on"`, `"between"`,
  40050. * `number`.
  40051. *
  40052. * In a column chart, when pointPlacement is `"on"`, the point will not
  40053. * create any padding of the X axis. In a polar column chart this means that
  40054. * the first column points directly north. If the pointPlacement is
  40055. * `"between"`, the columns will be laid out between ticks. This is useful
  40056. * for example for visualising an amount between two points in time or in a
  40057. * certain sector of a polar chart.
  40058. *
  40059. * Since Highcharts 3.0.2, the point placement can also be numeric, where 0
  40060. * is on the axis value, -0.5 is between this value and the previous, and
  40061. * 0.5 is between this value and the next. Unlike the textual options,
  40062. * numeric point placement options won't affect axis padding.
  40063. *
  40064. * Note that pointPlacement needs a pointRange to work. For column series
  40065. * this is computed, but for line-type series it needs to be set.
  40066. *
  40067. * For the `xrange` series type and gantt charts, if the Y axis is a
  40068. * category axis, the `pointPlacement` applies to the Y axis rather than the
  40069. * (typically datetime) X axis.
  40070. *
  40071. * Defaults to `undefined` in cartesian charts, `"between"` in polar charts.
  40072. */
  40073. pointPlacement?: (number|string);
  40074. /**
  40075. * (Highstock) The width of each point on the x axis. For example in a
  40076. * column chart with one value each day, the pointRange would be 1 day (= 24
  40077. * * 3600
  40078. *
  40079. * * 1000 milliseconds). This is normally computed automatically, but this
  40080. * option can be used to override the automatic value.
  40081. */
  40082. pointRange?: number;
  40083. /**
  40084. * (Highcharts, Highstock, Gantt) If no x values are given for the points in
  40085. * a series, pointStart defines on what value to start. For example, if a
  40086. * series contains one yearly value starting from 1945, set pointStart to
  40087. * 1945.
  40088. */
  40089. pointStart?: number;
  40090. /**
  40091. * (Highcharts, Highstock) Whether to select the series initially. If
  40092. * `showCheckbox` is true, the checkbox next to the series name in the
  40093. * legend will be checked for a selected series.
  40094. */
  40095. selected?: boolean;
  40096. /**
  40097. * (Highcharts) Whether to apply a drop shadow to the graph line. Since 2.3
  40098. * the shadow can be an object configuration containing `color`, `offsetX`,
  40099. * `offsetY`, `opacity` and `width`.
  40100. */
  40101. shadow?: (boolean|ShadowOptionsObject);
  40102. /**
  40103. * (Highcharts, Highstock) If true, a checkbox is displayed next to the
  40104. * legend item to allow selecting the series. The state of the checkbox is
  40105. * determined by the `selected` option.
  40106. */
  40107. showCheckbox?: boolean;
  40108. /**
  40109. * (Highcharts, Highstock) Whether to display this particular series or
  40110. * series type in the legend. Standalone series are shown in legend by
  40111. * default, and linked series are not. Since v7.2.0 it is possible to show
  40112. * series that use colorAxis by setting this option to `true`.
  40113. */
  40114. showInLegend?: boolean;
  40115. /**
  40116. * (Highstock) Whether or not to show the series in the navigator. Takes
  40117. * precedence over navigator.baseSeries if defined.
  40118. */
  40119. showInNavigator?: boolean;
  40120. /**
  40121. * (Highcharts, Highstock) If set to `true`, the accessibility module will
  40122. * skip past the points in this series for keyboard navigation.
  40123. */
  40124. skipKeyboardNavigation?: boolean;
  40125. /**
  40126. * (Highcharts, Highstock) When this is true, the series will not cause the
  40127. * Y axis to cross the zero plane (or threshold option) unless the data
  40128. * actually crosses the plane.
  40129. *
  40130. * For example, if `softThreshold` is `false`, a series of 0, 1, 2, 3 will
  40131. * make the Y axis show negative values according to the `minPadding`
  40132. * option. If `softThreshold` is `true`, the Y axis starts at 0.
  40133. */
  40134. softThreshold?: boolean;
  40135. states?: SeriesStatesOptionsObject;
  40136. /**
  40137. * (Highcharts, Highstock) Whether to apply steps to the line. Possible
  40138. * values are `left`, `center` and `right`.
  40139. */
  40140. step?: OptionsStepValue;
  40141. /**
  40142. * (Highcharts, Highstock) The Y axis value to serve as the base for the
  40143. * area, for distinguishing between values above and below a threshold. The
  40144. * area between the graph and the threshold is filled.
  40145. *
  40146. * * If a number is given, the Y axis will scale to the threshold.
  40147. *
  40148. * * If `null`, the scaling behaves like a line series with fill between the
  40149. * graph and the Y axis minimum.
  40150. *
  40151. * * If `Infinity` or `-Infinity`, the area between the graph and the
  40152. * corresponding Y axis extreme is filled (since v6.1.0).
  40153. */
  40154. threshold?: (number|null);
  40155. /**
  40156. * (Highcharts, Highstock) A configuration object for the tooltip rendering
  40157. * of each single series. Properties are inherited from tooltip, but only
  40158. * the following properties can be defined on a series level.
  40159. */
  40160. tooltip?: SeriesTooltipOptionsObject;
  40161. /**
  40162. * (Highcharts, Highstock, Gantt) When a series contains a data array that
  40163. * is longer than this, only one dimensional arrays of numbers, or two
  40164. * dimensional arrays with x and y values are allowed. Also, only the first
  40165. * point is tested, and the rest are assumed to be the same format. This
  40166. * saves expensive data checking and indexing in long series. Set it to `0`
  40167. * disable.
  40168. *
  40169. * Note: In boost mode turbo threshold is forced. Only array of numbers or
  40170. * two dimensional arrays are allowed.
  40171. */
  40172. turboThreshold?: number;
  40173. /**
  40174. * (Highcharts, Highstock) Set the initial visibility of the series.
  40175. */
  40176. visible?: boolean;
  40177. /**
  40178. * (Highmaps) Define the z index of the series.
  40179. */
  40180. zIndex?: number;
  40181. /**
  40182. * (Highcharts, Highstock) Defines the Axis on which the zones are applied.
  40183. */
  40184. zoneAxis?: string;
  40185. /**
  40186. * (Highcharts, Highstock) An array defining zones within a series. Zones
  40187. * can be applied to the X axis, Y axis or Z axis for bubbles, according to
  40188. * the `zoneAxis` option. The zone definitions have to be in ascending order
  40189. * regarding to the value.
  40190. *
  40191. * In styled mode, the color zones are styled with the
  40192. * `.highcharts-zone-{n}` class, or custom classed from the `className`
  40193. * option (view live demo).
  40194. */
  40195. zones?: Array<SeriesZonesOptionsObject>;
  40196. }
  40197. /**
  40198. * (Highstock) Enable or disable the initial animation when a series is
  40199. * displayed. The animation can also be set as a configuration object. Please
  40200. * note that this option only applies to the initial animation of the series
  40201. * itself. For other animations, see chart.animation and the animation parameter
  40202. * under the API methods. The following properties are supported:
  40203. *
  40204. * - `defer`: The animation delay time in milliseconds.
  40205. *
  40206. * - `duration`: The duration of the animation in milliseconds.
  40207. *
  40208. * - `easing`: Can be a string reference to an easing function set on the `Math`
  40209. * object or a function. See the _Custom easing function_ demo below.
  40210. *
  40211. * Due to poor performance, animation is disabled in old IE browsers for several
  40212. * chart types.
  40213. */
  40214. export interface PlotEmaAnimationOptions {
  40215. defer?: number;
  40216. }
  40217. /**
  40218. * (Highcharts, Highstock, Highmaps, Gantt) Enable or disable the initial
  40219. * animation when a series is displayed for the `dataLabels`. The animation can
  40220. * also be set as a configuration object. Please note that this option only
  40221. * applies to the initial animation. For other animations, see chart.animation
  40222. * and the animation parameter under the API methods. The following properties
  40223. * are supported:
  40224. *
  40225. * - `defer`: The animation delay time in milliseconds.
  40226. */
  40227. export interface PlotEmaDataLabelsAnimationOptions {
  40228. /**
  40229. * (Highcharts, Highstock, Highmaps, Gantt) The animation delay time in
  40230. * milliseconds. Set to `0` renders dataLabel immediately. As `undefined`
  40231. * inherits defer time from the series.animation.defer.
  40232. */
  40233. defer?: number;
  40234. }
  40235. /**
  40236. * (Highcharts, Highstock, Highmaps, Gantt) Options for the series data labels,
  40237. * appearing next to each data point.
  40238. *
  40239. * Since v6.2.0, multiple data labels can be applied to each single point by
  40240. * defining them as an array of configs.
  40241. *
  40242. * In styled mode, the data labels can be styled with the
  40243. * `.highcharts-data-label-box` and `.highcharts-data-label` class names (see
  40244. * example).
  40245. */
  40246. export interface PlotEmaDataLabelsOptions {
  40247. /**
  40248. * (Highcharts, Highstock, Highmaps, Gantt) The alignment of the data label
  40249. * compared to the point. If `right`, the right side of the label should be
  40250. * touching the point. For points with an extent, like columns, the
  40251. * alignments also dictates how to align it inside the box, as given with
  40252. * the inside option. Can be one of `left`, `center` or `right`.
  40253. */
  40254. align?: (AlignValue|null);
  40255. /**
  40256. * (Highcharts, Highstock, Highmaps, Gantt) Whether to allow data labels to
  40257. * overlap. To make the labels less sensitive for overlapping, the
  40258. * dataLabels.padding can be set to 0.
  40259. */
  40260. allowOverlap?: boolean;
  40261. /**
  40262. * (Highcharts, Highstock, Highmaps, Gantt) Enable or disable the initial
  40263. * animation when a series is displayed for the `dataLabels`. The animation
  40264. * can also be set as a configuration object. Please note that this option
  40265. * only applies to the initial animation. For other animations, see
  40266. * chart.animation and the animation parameter under the API methods. The
  40267. * following properties are supported:
  40268. *
  40269. * - `defer`: The animation delay time in milliseconds.
  40270. */
  40271. animation?: (boolean|PlotEmaDataLabelsAnimationOptions|Partial<AnimationOptionsObject>);
  40272. /**
  40273. * (Highcharts, Highstock, Highmaps, Gantt) The background color or gradient
  40274. * for the data label.
  40275. */
  40276. backgroundColor?: (ColorString|GradientColorObject|PatternObject);
  40277. /**
  40278. * (Highcharts, Highstock, Highmaps, Gantt) The border color for the data
  40279. * label. Defaults to `undefined`.
  40280. */
  40281. borderColor?: (ColorString|GradientColorObject|PatternObject);
  40282. /**
  40283. * (Highcharts, Highstock, Highmaps, Gantt) The border radius in pixels for
  40284. * the data label.
  40285. */
  40286. borderRadius?: number;
  40287. /**
  40288. * (Highcharts, Highstock, Highmaps, Gantt) The border width in pixels for
  40289. * the data label.
  40290. */
  40291. borderWidth?: number;
  40292. /**
  40293. * (Highcharts, Highstock, Highmaps, Gantt) A class name for the data label.
  40294. * Particularly in styled mode, this can be used to give each series' or
  40295. * point's data label unique styling. In addition to this option, a default
  40296. * color class name is added so that we can give the labels a contrast text
  40297. * shadow.
  40298. */
  40299. className?: string;
  40300. /**
  40301. * (Highcharts, Highstock, Highmaps, Gantt) The text color for the data
  40302. * labels. Defaults to `undefined`. For certain series types, like column or
  40303. * map, the data labels can be drawn inside the points. In this case the
  40304. * data label will be drawn with maximum contrast by default. Additionally,
  40305. * it will be given a `text-outline` style with the opposite color, to
  40306. * further increase the contrast. This can be overridden by setting the
  40307. * `text-outline` style to `none` in the `dataLabels.style` option.
  40308. */
  40309. color?: (ColorString|GradientColorObject|PatternObject);
  40310. /**
  40311. * (Highcharts, Highstock, Highmaps, Gantt) Whether to hide data labels that
  40312. * are outside the plot area. By default, the data label is moved inside the
  40313. * plot area according to the overflow option.
  40314. */
  40315. crop?: boolean;
  40316. /**
  40317. * (Highcharts, Highstock, Gantt) Whether to defer displaying the data
  40318. * labels until the initial series animation has finished. Setting to
  40319. * `false` renders the data label immediately. If set to `true` inherits the
  40320. * defer time set in plotOptions.series.animation.
  40321. */
  40322. defer?: boolean;
  40323. /**
  40324. * (Highcharts, Highstock, Highmaps, Gantt) Enable or disable the data
  40325. * labels.
  40326. */
  40327. enabled?: boolean;
  40328. /**
  40329. * (Highcharts, Highstock, Highmaps, Gantt) A declarative filter to control
  40330. * of which data labels to display. The declarative filter is designed for
  40331. * use when callback functions are not available, like when the chart
  40332. * options require a pure JSON structure or for use with graphical editors.
  40333. * For programmatic control, use the `formatter` instead, and return
  40334. * `undefined` to disable a single data label.
  40335. */
  40336. filter?: DataLabelsFilterOptionsObject;
  40337. /**
  40338. * (Highcharts, Highstock, Highmaps, Gantt) A format string for the data
  40339. * label. Available variables are the same as for `formatter`.
  40340. */
  40341. format?: string;
  40342. /**
  40343. * (Highcharts, Highstock, Highmaps, Gantt) Callback JavaScript function to
  40344. * format the data label. Note that if a `format` is defined, the format
  40345. * takes precedence and the formatter is ignored.
  40346. */
  40347. formatter?: DataLabelsFormatterCallbackFunction;
  40348. /**
  40349. * (Highcharts, Highstock, Highmaps, Gantt) For points with an extent, like
  40350. * columns or map areas, whether to align the data label inside the box or
  40351. * to the actual value point. Defaults to `false` in most cases, `true` in
  40352. * stacked columns.
  40353. */
  40354. inside?: boolean;
  40355. /**
  40356. * (Highcharts, Highstock, Highmaps, Gantt) Format for points with the value
  40357. * of null. Works analogously to format. `nullFormat` can be applied only to
  40358. * series which support displaying null points.
  40359. */
  40360. nullFormat?: (boolean|string);
  40361. /**
  40362. * (Highcharts, Highstock, Highmaps, Gantt) Callback JavaScript function
  40363. * that defines formatting for points with the value of null. Works
  40364. * analogously to formatter. `nullPointFormatter` can be applied only to
  40365. * series which support displaying null points.
  40366. */
  40367. nullFormatter?: DataLabelsFormatterCallbackFunction;
  40368. /**
  40369. * (Highcharts, Highstock, Highmaps, Gantt) How to handle data labels that
  40370. * flow outside the plot area. The default is `"justify"`, which aligns them
  40371. * inside the plot area. For columns and bars, this means it will be moved
  40372. * inside the bar. To display data labels outside the plot area, set `crop`
  40373. * to `false` and `overflow` to `"allow"`.
  40374. */
  40375. overflow?: DataLabelsOverflowValue;
  40376. /**
  40377. * (Highcharts, Highstock, Highmaps, Gantt) When either the `borderWidth` or
  40378. * the `backgroundColor` is set, this is the padding within the box.
  40379. */
  40380. padding?: number;
  40381. /**
  40382. * (Highcharts, Highstock, Highmaps, Gantt) Aligns data labels relative to
  40383. * points. If `center` alignment is not possible, it defaults to `right`.
  40384. */
  40385. position?: AlignValue;
  40386. /**
  40387. * (Highcharts, Highstock, Highmaps, Gantt) Text rotation in degrees. Note
  40388. * that due to a more complex structure, backgrounds, borders and padding
  40389. * will be lost on a rotated data label.
  40390. */
  40391. rotation?: number;
  40392. /**
  40393. * (Highcharts, Highstock, Highmaps, Gantt) The shadow of the box. Works
  40394. * best with `borderWidth` or `backgroundColor`. Since 2.3 the shadow can be
  40395. * an object configuration containing `color`, `offsetX`, `offsetY`,
  40396. * `opacity` and `width`.
  40397. */
  40398. shadow?: (boolean|ShadowOptionsObject);
  40399. /**
  40400. * (Highcharts, Highstock, Highmaps, Gantt) The name of a symbol to use for
  40401. * the border around the label. Symbols are predefined functions on the
  40402. * Renderer object.
  40403. */
  40404. shape?: string;
  40405. /**
  40406. * (Highcharts, Highstock, Highmaps, Gantt) Styles for the label. The
  40407. * default `color` setting is `"contrast"`, which is a pseudo color that
  40408. * Highcharts picks up and applies the maximum contrast to the underlying
  40409. * point item, for example the bar in a bar chart.
  40410. *
  40411. * The `textOutline` is a pseudo property that applies an outline of the
  40412. * given width with the given color, which by default is the maximum
  40413. * contrast to the text. So a bright text color will result in a black text
  40414. * outline for maximum readability on a mixed background. In some cases,
  40415. * especially with grayscale text, the text outline doesn't work well, in
  40416. * which cases it can be disabled by setting it to `"none"`. When `useHTML`
  40417. * is true, the `textOutline` will not be picked up. In this, case, the same
  40418. * effect can be acheived through the `text-shadow` CSS property.
  40419. *
  40420. * For some series types, where each point has an extent, like for example
  40421. * tree maps, the data label may overflow the point. There are two
  40422. * strategies for handling overflow. By default, the text will wrap to
  40423. * multiple lines. The other strategy is to set `style.textOverflow` to
  40424. * `ellipsis`, which will keep the text on one line plus it will break
  40425. * inside long words.
  40426. */
  40427. style?: CSSObject;
  40428. /**
  40429. * (Highcharts, Highstock, Highmaps, Gantt) Options for a label text which
  40430. * should follow marker's shape. Border and background are disabled for a
  40431. * label that follows a path.
  40432. *
  40433. * **Note:** Only SVG-based renderer supports this option. Setting `useHTML`
  40434. * to true will disable this option.
  40435. */
  40436. textPath?: DataLabelsTextPathOptionsObject;
  40437. /**
  40438. * (Highcharts, Highstock, Highmaps, Gantt) Whether to use HTML to render
  40439. * the labels.
  40440. */
  40441. useHTML?: boolean;
  40442. /**
  40443. * (Highcharts, Highstock, Highmaps, Gantt) The vertical alignment of a data
  40444. * label. Can be one of `top`, `middle` or `bottom`. The default value
  40445. * depends on the data, for instance in a column chart, the label is above
  40446. * positive values and below negative values.
  40447. */
  40448. verticalAlign?: (VerticalAlignValue|null);
  40449. /**
  40450. * (Highcharts, Highstock, Highmaps, Gantt) The x position offset of the
  40451. * label relative to the point in pixels.
  40452. */
  40453. x?: number;
  40454. /**
  40455. * (Highcharts, Highstock, Highmaps, Gantt) The y position offset of the
  40456. * label relative to the point in pixels.
  40457. */
  40458. y?: number;
  40459. /**
  40460. * (Highcharts, Highstock, Highmaps, Gantt) The Z index of the data labels.
  40461. * The default Z index puts it above the series. Use a Z index of 2 to
  40462. * display it behind the series.
  40463. */
  40464. z?: number;
  40465. }
  40466. /**
  40467. * (Highcharts, Highstock) Options for the series data sorting.
  40468. */
  40469. export interface PlotEmaDataSortingOptions {
  40470. /**
  40471. * (Highcharts, Highstock) Enable or disable data sorting for the series.
  40472. * Use xAxis.reversed to change the sorting order.
  40473. */
  40474. enabled?: boolean;
  40475. /**
  40476. * (Highcharts, Highstock) Whether to allow matching points by name in an
  40477. * update. If this option is disabled, points will be matched by order.
  40478. */
  40479. matchByName?: boolean;
  40480. /**
  40481. * (Highcharts, Highstock) Determines what data value should be used to sort
  40482. * by.
  40483. */
  40484. sortKey?: string;
  40485. }
  40486. /**
  40487. * (Highstock) Exponential moving average indicator (EMA). This series requires
  40488. * the `linkedTo` option to be set.
  40489. *
  40490. * In TypeScript the type option must always be set.
  40491. *
  40492. * Configuration options for the series are given in three levels:
  40493. *
  40494. * 1. Options for all series in a chart are defined in the plotOptions.series
  40495. * object.
  40496. *
  40497. * 2. Options for all `ema` series are defined in plotOptions.ema.
  40498. *
  40499. * 3. Options for one single series are given in the series instance array. (see
  40500. * online documentation for example)
  40501. */
  40502. export interface PlotEmaOptions {
  40503. /**
  40504. * (Highstock) Accessibility options for a series.
  40505. */
  40506. accessibility?: SeriesAccessibilityOptionsObject;
  40507. /**
  40508. * (Highstock) Allow this series' points to be selected by clicking on the
  40509. * graphic (columns, point markers, pie slices, map areas etc).
  40510. *
  40511. * The selected points can be handled by point select and unselect events,
  40512. * or collectively by the getSelectedPoints function.
  40513. *
  40514. * And alternative way of selecting points is through dragging.
  40515. */
  40516. allowPointSelect?: boolean;
  40517. /**
  40518. * (Highstock) Enable or disable the initial animation when a series is
  40519. * displayed. The animation can also be set as a configuration object.
  40520. * Please note that this option only applies to the initial animation of the
  40521. * series itself. For other animations, see chart.animation and the
  40522. * animation parameter under the API methods. The following properties are
  40523. * supported:
  40524. *
  40525. * - `defer`: The animation delay time in milliseconds.
  40526. *
  40527. * - `duration`: The duration of the animation in milliseconds.
  40528. *
  40529. * - `easing`: Can be a string reference to an easing function set on the
  40530. * `Math` object or a function. See the _Custom easing function_ demo below.
  40531. *
  40532. * Due to poor performance, animation is disabled in old IE browsers for
  40533. * several chart types.
  40534. */
  40535. animation?: (boolean|PlotEmaAnimationOptions|Partial<AnimationOptionsObject>);
  40536. /**
  40537. * (Highstock) For some series, there is a limit that shuts down initial
  40538. * animation by default when the total number of points in the chart is too
  40539. * high. For example, for a column chart and its derivatives, animation does
  40540. * not run if there is more than 250 points totally. To disable this cap,
  40541. * set `animationLimit` to `Infinity`.
  40542. */
  40543. animationLimit?: number;
  40544. /**
  40545. * (Highstock) Sets the color blending in the boost module.
  40546. */
  40547. boostBlending?: OptionsBoostBlendingValue;
  40548. /**
  40549. * (Highstock) Set the point threshold for when a series should enter boost
  40550. * mode.
  40551. *
  40552. * Setting it to e.g. 2000 will cause the series to enter boost mode when
  40553. * there are 2000 or more points in the series.
  40554. *
  40555. * To disable boosting on the series, set the `boostThreshold` to 0. Setting
  40556. * it to 1 will force boosting.
  40557. *
  40558. * Note that the cropThreshold also affects this setting. When zooming in on
  40559. * a series that has fewer points than the `cropThreshold`, all points are
  40560. * rendered although outside the visible plot area, and the `boostThreshold`
  40561. * won't take effect.
  40562. */
  40563. boostThreshold?: number;
  40564. /**
  40565. * (Highmaps) The border color of the map areas.
  40566. *
  40567. * In styled mode, the border stroke is given in the `.highcharts-point`
  40568. * class.
  40569. */
  40570. borderColor?: (ColorString|GradientColorObject|PatternObject);
  40571. /**
  40572. * (Highmaps) The border width of each map area.
  40573. *
  40574. * In styled mode, the border stroke width is given in the
  40575. * `.highcharts-point` class.
  40576. */
  40577. borderWidth?: number;
  40578. /**
  40579. * (Highstock) An additional class name to apply to the series' graphical
  40580. * elements. This option does not replace default class names of the
  40581. * graphical element.
  40582. */
  40583. className?: string;
  40584. /**
  40585. * (Highstock) Disable this option to allow series rendering in the whole
  40586. * plotting area.
  40587. *
  40588. * **Note:** Clipping should be always enabled when chart.zoomType is set
  40589. */
  40590. clip?: boolean;
  40591. /**
  40592. * (Highstock) The main color of the series. In line type series it applies
  40593. * to the line and the point markers unless otherwise specified. In bar type
  40594. * series it applies to the bars unless a color is specified per point. The
  40595. * default value is pulled from the `options.colors` array.
  40596. *
  40597. * In styled mode, the color can be defined by the colorIndex option. Also,
  40598. * the series color can be set with the `.highcharts-series`,
  40599. * `.highcharts-color-{n}`, `.highcharts-{type}-series` or
  40600. * `.highcharts-series-{n}` class, or individual classes given by the
  40601. * `className` option.
  40602. */
  40603. color?: (ColorString|GradientColorObject|PatternObject);
  40604. /**
  40605. * (Highstock) Styled mode only. A specific color index to use for the
  40606. * series, so its graphic representations are given the class name
  40607. * `highcharts-color-{n}`.
  40608. */
  40609. colorIndex?: number;
  40610. /**
  40611. * (Highcharts, Highstock, Highmaps) Determines what data value should be
  40612. * used to calculate point color if `colorAxis` is used. Requires to set
  40613. * `min` and `max` if some custom point property is used or if approximation
  40614. * for data grouping is set to `'sum'`.
  40615. */
  40616. colorKey?: string;
  40617. /**
  40618. * (Highstock) Compare the values of the series against the first non-null,
  40619. * non- zero value in the visible range. The y axis will show percentage or
  40620. * absolute change depending on whether `compare` is set to `"percent"` or
  40621. * `"value"`. When this is applied to multiple series, it allows comparing
  40622. * the development of the series against each other. Adds a `change` field
  40623. * to every point object.
  40624. */
  40625. compare?: string;
  40626. /**
  40627. * (Highstock) When compare is `percent`, this option dictates whether to
  40628. * use 0 or 100 as the base of comparison.
  40629. */
  40630. compareBase?: (0|100);
  40631. /**
  40632. * (Highstock) Defines if comparison should start from the first point
  40633. * within the visible range or should start from the first point **before**
  40634. * the range.
  40635. *
  40636. * In other words, this flag determines if first point within the visible
  40637. * range will have 0% (`compareStart=true`) or should have been already
  40638. * calculated according to the previous point (`compareStart=false`).
  40639. */
  40640. compareStart?: boolean;
  40641. /**
  40642. * (Highstock) Whether to compare indicator to the main series values or
  40643. * indicator values.
  40644. */
  40645. compareToMain?: boolean;
  40646. /**
  40647. * (Highcharts) Polar charts only. Whether to connect the ends of a line
  40648. * series plot across the extremes.
  40649. */
  40650. connectEnds?: boolean;
  40651. /**
  40652. * (Highcharts, Highstock) Whether to connect a graph line across null
  40653. * points, or render a gap between the two points on either side of the
  40654. * null.
  40655. */
  40656. connectNulls?: boolean;
  40657. /**
  40658. * (Gantt) Override Pathfinder connector options for a series. Requires
  40659. * Highcharts Gantt to be loaded.
  40660. */
  40661. connectors?: SeriesConnectorsOptionsObject;
  40662. /**
  40663. * (Highcharts, Highstock, Gantt) When true, each point or column edge is
  40664. * rounded to its nearest pixel in order to render sharp on screen. In some
  40665. * cases, when there are a lot of densely packed columns, this leads to
  40666. * visible difference in column widths or distance between columns. In these
  40667. * cases, setting `crisp` to `false` may look better, even though each
  40668. * column is rendered blurry.
  40669. */
  40670. crisp?: boolean;
  40671. /**
  40672. * (Highcharts, Highstock) When the series contains less points than the
  40673. * crop threshold, all points are drawn, even if the points fall outside the
  40674. * visible plot area at the current zoom. The advantage of drawing all
  40675. * points (including markers and columns), is that animation is performed on
  40676. * updates. On the other hand, when the series contains more points than the
  40677. * crop threshold, the series data is cropped to only contain points that
  40678. * fall within the plot area. The advantage of cropping away invisible
  40679. * points is to increase performance on large series.
  40680. */
  40681. cropThreshold?: number;
  40682. /**
  40683. * (Highstock) You can set the cursor to "pointer" if you have click events
  40684. * attached to the series, to signal to the user that the points and lines
  40685. * can be clicked.
  40686. *
  40687. * In styled mode, the series cursor can be set with the same classes as
  40688. * listed under series.color.
  40689. */
  40690. cursor?: (string|CursorValue);
  40691. /**
  40692. * (Highstock) A reserved subspace to store options and values for
  40693. * customized functionality. Here you can add additional data for your own
  40694. * event callbacks and formatter callbacks.
  40695. */
  40696. custom?: Dictionary<any>;
  40697. /**
  40698. * (Highstock) Name of the dash style to use for the graph, or for some
  40699. * series types the outline of each shape.
  40700. *
  40701. * In styled mode, the stroke dash-array can be set with the same classes as
  40702. * listed under series.color.
  40703. */
  40704. dashStyle?: DashStyleValue;
  40705. /**
  40706. * (Highstock) Data grouping is the concept of sampling the data values into
  40707. * larger blocks in order to ease readability and increase performance of
  40708. * the JavaScript charts. Highstock by default applies data grouping when
  40709. * the points become closer than a certain pixel value, determined by the
  40710. * `groupPixelWidth` option.
  40711. *
  40712. * If data grouping is applied, the grouping information of grouped points
  40713. * can be read from the Point.dataGroup. If point options other than the
  40714. * data itself are set, for example `name` or `color` or custom properties,
  40715. * the grouping logic doesn't know how to group it. In this case the options
  40716. * of the first point instance are copied over to the group point. This can
  40717. * be altered through a custom `approximation` callback function.
  40718. */
  40719. dataGrouping?: DataGroupingOptionsObject;
  40720. /**
  40721. * (Highcharts, Highstock, Highmaps, Gantt) Options for the series data
  40722. * labels, appearing next to each data point.
  40723. *
  40724. * Since v6.2.0, multiple data labels can be applied to each single point by
  40725. * defining them as an array of configs.
  40726. *
  40727. * In styled mode, the data labels can be styled with the
  40728. * `.highcharts-data-label-box` and `.highcharts-data-label` class names
  40729. * (see example).
  40730. */
  40731. dataLabels?: (PlotEmaDataLabelsOptions|Array<PlotEmaDataLabelsOptions>);
  40732. /**
  40733. * (Highcharts, Highstock) Options for the series data sorting.
  40734. */
  40735. dataSorting?: (DataSortingOptionsObject|PlotEmaDataSortingOptions);
  40736. /**
  40737. * (Highstock) A description of the series to add to the screen reader
  40738. * information about the series.
  40739. */
  40740. description?: string;
  40741. /**
  40742. * (Highstock) Enable or disable the mouse tracking for a specific series.
  40743. * This includes point tooltips and click events on graphs and points. For
  40744. * large datasets it improves performance.
  40745. */
  40746. enableMouseTracking?: boolean;
  40747. /**
  40748. * (Highstock) General event handlers for the series items. These event
  40749. * hooks can also be attached to the series at run time using the
  40750. * `Highcharts.addEvent` function.
  40751. */
  40752. events?: SeriesEventsOptionsObject;
  40753. /**
  40754. * (Highstock) Determines whether the series should look for the nearest
  40755. * point in both dimensions or just the x-dimension when hovering the
  40756. * series. Defaults to `'xy'` for scatter series and `'x'` for most other
  40757. * series. If the data has duplicate x-values, it is recommended to set this
  40758. * to `'xy'` to allow hovering over all points.
  40759. *
  40760. * Applies only to series types using nearest neighbor search (not direct
  40761. * hover) for tooltip.
  40762. */
  40763. findNearestPointBy?: OptionsFindNearestPointByValue;
  40764. /**
  40765. * (Highstock) Defines when to display a gap in the graph, together with the
  40766. * gapUnit option.
  40767. *
  40768. * In case when `dataGrouping` is enabled, points can be grouped into a
  40769. * larger time span. This can make the grouped points to have a greater
  40770. * distance than the absolute value of `gapSize` property, which will result
  40771. * in disappearing graph completely. To prevent this situation the mentioned
  40772. * distance between grouped points is used instead of previously defined
  40773. * `gapSize`.
  40774. *
  40775. * In practice, this option is most often used to visualize gaps in time
  40776. * series. In a stock chart, intraday data is available for daytime hours,
  40777. * while gaps will appear in nights and weekends.
  40778. */
  40779. gapSize?: number;
  40780. /**
  40781. * (Highstock) Together with gapSize, this option defines where to draw gaps
  40782. * in the graph.
  40783. *
  40784. * When the `gapUnit` is `"relative"` (default), a gap size of 5 means that
  40785. * if the distance between two points is greater than 5 times that of the
  40786. * two closest points, the graph will be broken.
  40787. *
  40788. * When the `gapUnit` is `"value"`, the gap is based on absolute axis
  40789. * values, which on a datetime axis is milliseconds. This also applies to
  40790. * the navigator series that inherits gap options from the base series.
  40791. */
  40792. gapUnit?: OptionsGapUnitValue;
  40793. /**
  40794. * (Highcharts, Highstock, Gantt) Whether to use the Y extremes of the total
  40795. * chart width or only the zoomed area when zooming in on parts of the X
  40796. * axis. By default, the Y axis adjusts to the min and max of the visible
  40797. * data. Cartesian series only.
  40798. */
  40799. getExtremesFromAll?: boolean;
  40800. /**
  40801. * (Highstock) When set to `false` will prevent the series data from being
  40802. * included in any form of data export.
  40803. *
  40804. * Since version 6.0.0 until 7.1.0 the option was existing undocumented as
  40805. * `includeInCSVExport`.
  40806. */
  40807. includeInDataExport?: boolean;
  40808. /**
  40809. * (Highcharts, Highstock, Gantt) Series labels are placed as close to the
  40810. * series as possible in a natural way, seeking to avoid other series. The
  40811. * goal of this feature is to make the chart more easily readable, like if a
  40812. * human designer placed the labels in the optimal position.
  40813. *
  40814. * The series labels currently work with series types having a `graph` or an
  40815. * `area`.
  40816. */
  40817. label?: SeriesLabelOptionsObject;
  40818. /**
  40819. * (Highstock) The line marks the last price from all points.
  40820. */
  40821. lastPrice?: SeriesLastPriceOptionsObject;
  40822. /**
  40823. * (Highstock) The line marks the last price from visible range of points.
  40824. */
  40825. lastVisiblePrice?: SeriesLastVisiblePriceOptionsObject;
  40826. /**
  40827. * (Highcharts, Highstock) The SVG value used for the `stroke-linecap` and
  40828. * `stroke-linejoin` of a line graph. Round means that lines are rounded in
  40829. * the ends and bends.
  40830. */
  40831. linecap?: SeriesLinecapValue;
  40832. /**
  40833. * (Highcharts, Highstock) Pixel width of the graph line.
  40834. */
  40835. lineWidth?: number;
  40836. /**
  40837. * (Highcharts, Highstock, Gantt) The main series ID that indicator will be
  40838. * based on. Required for this indicator.
  40839. */
  40840. linkedTo?: string;
  40841. /**
  40842. * (Highstock) Options for the point markers of line-like series. Properties
  40843. * like `fillColor`, `lineColor` and `lineWidth` define the visual
  40844. * appearance of the markers. Other series types, like column series, don't
  40845. * have markers, but have visual options on the series level instead.
  40846. *
  40847. * In styled mode, the markers can be styled with the `.highcharts-point`,
  40848. * `.highcharts-point-hover` and `.highcharts-point-select` class names.
  40849. */
  40850. marker?: PointMarkerOptionsObject;
  40851. /**
  40852. * (Highstock) The name of the series as shown in the legend, tooltip etc.
  40853. * If not set, it will be based on a technical indicator type and default
  40854. * params.
  40855. */
  40856. name?: string;
  40857. /**
  40858. * (Highstock) The color for the parts of the graph or points that are below
  40859. * the threshold. Note that `zones` takes precedence over the negative
  40860. * color. Using `negativeColor` is equivalent to applying a zone with value
  40861. * of 0.
  40862. */
  40863. negativeColor?: (ColorString|GradientColorObject|PatternObject);
  40864. /**
  40865. * (Highstock) Opacity of a series parts: line, fill (e.g. area) and
  40866. * dataLabels.
  40867. */
  40868. opacity?: number;
  40869. /**
  40870. * (Highstock) Paramters used in calculation of regression series' points.
  40871. */
  40872. params?: PlotEmaParamsOptions;
  40873. /**
  40874. * (Highstock) Properties for each single point.
  40875. */
  40876. point?: PlotSeriesPointOptions;
  40877. /**
  40878. * (Highstock) Same as accessibility.pointDescriptionFormatter, but for an
  40879. * individual series. Overrides the chart wide configuration.
  40880. */
  40881. pointDescriptionFormatter?: Function;
  40882. /**
  40883. * (Highstock) Whether to select the series initially. If `showCheckbox` is
  40884. * true, the checkbox next to the series name in the legend will be checked
  40885. * for a selected series.
  40886. */
  40887. selected?: boolean;
  40888. /**
  40889. * (Highstock) Whether to apply a drop shadow to the graph line. Since 2.3
  40890. * the shadow can be an object configuration containing `color`, `offsetX`,
  40891. * `offsetY`, `opacity` and `width`.
  40892. */
  40893. shadow?: (boolean|ShadowOptionsObject);
  40894. /**
  40895. * (Highstock) If true, a checkbox is displayed next to the legend item to
  40896. * allow selecting the series. The state of the checkbox is determined by
  40897. * the `selected` option.
  40898. */
  40899. showCheckbox?: boolean;
  40900. /**
  40901. * (Highstock) Whether to display this particular series or series type in
  40902. * the legend. Standalone series are shown in legend by default, and linked
  40903. * series are not. Since v7.2.0 it is possible to show series that use
  40904. * colorAxis by setting this option to `true`.
  40905. */
  40906. showInLegend?: boolean;
  40907. /**
  40908. * (Highstock) If set to `true`, the accessibility module will skip past the
  40909. * points in this series for keyboard navigation.
  40910. */
  40911. skipKeyboardNavigation?: boolean;
  40912. /**
  40913. * (Highcharts, Highstock) When this is true, the series will not cause the
  40914. * Y axis to cross the zero plane (or threshold option) unless the data
  40915. * actually crosses the plane.
  40916. *
  40917. * For example, if `softThreshold` is `false`, a series of 0, 1, 2, 3 will
  40918. * make the Y axis show negative values according to the `minPadding`
  40919. * option. If `softThreshold` is `true`, the Y axis starts at 0.
  40920. */
  40921. softThreshold?: boolean;
  40922. states?: SeriesStatesOptionsObject;
  40923. /**
  40924. * (Highcharts, Highstock) Whether to apply steps to the line. Possible
  40925. * values are `left`, `center` and `right`.
  40926. */
  40927. step?: OptionsStepValue;
  40928. /**
  40929. * (Highstock) Sticky tracking of mouse events. When true, the `mouseOut`
  40930. * event on a series isn't triggered until the mouse moves over another
  40931. * series, or out of the plot area. When false, the `mouseOut` event on a
  40932. * series is triggered when the mouse leaves the area around the series'
  40933. * graph or markers. This also implies the tooltip when not shared. When
  40934. * `stickyTracking` is false and `tooltip.shared` is false, the tooltip will
  40935. * be hidden when moving the mouse between series. Defaults to true for line
  40936. * and area type series, but to false for columns, pies etc.
  40937. *
  40938. * **Note:** The boost module will force this option because of technical
  40939. * limitations.
  40940. */
  40941. stickyTracking?: boolean;
  40942. /**
  40943. * (Highcharts, Highstock) The threshold, also called zero level or base
  40944. * level. For line type series this is only used in conjunction with
  40945. * negativeColor.
  40946. */
  40947. threshold?: (number|null);
  40948. /**
  40949. * (Highstock) A configuration object for the tooltip rendering of each
  40950. * single series. Properties are inherited from tooltip, but only the
  40951. * following properties can be defined on a series level.
  40952. */
  40953. tooltip?: SeriesTooltipOptionsObject;
  40954. /**
  40955. * (Highcharts, Highstock, Gantt) When a series contains a data array that
  40956. * is longer than this, only one dimensional arrays of numbers, or two
  40957. * dimensional arrays with x and y values are allowed. Also, only the first
  40958. * point is tested, and the rest are assumed to be the same format. This
  40959. * saves expensive data checking and indexing in long series. Set it to `0`
  40960. * disable.
  40961. *
  40962. * Note: In boost mode turbo threshold is forced. Only array of numbers or
  40963. * two dimensional arrays are allowed.
  40964. */
  40965. turboThreshold?: number;
  40966. /**
  40967. * (Highstock) Set the initial visibility of the series.
  40968. */
  40969. visible?: boolean;
  40970. /**
  40971. * (Highmaps) Define the z index of the series.
  40972. */
  40973. zIndex?: number;
  40974. /**
  40975. * (Highcharts, Highstock) Defines the Axis on which the zones are applied.
  40976. */
  40977. zoneAxis?: string;
  40978. /**
  40979. * (Highcharts, Highstock) An array defining zones within a series. Zones
  40980. * can be applied to the X axis, Y axis or Z axis for bubbles, according to
  40981. * the `zoneAxis` option. The zone definitions have to be in ascending order
  40982. * regarding to the value.
  40983. *
  40984. * In styled mode, the color zones are styled with the
  40985. * `.highcharts-zone-{n}` class, or custom classed from the `className`
  40986. * option (view live demo).
  40987. */
  40988. zones?: Array<SeriesZonesOptionsObject>;
  40989. }
  40990. /**
  40991. * (Highstock) Paramters used in calculation of regression series' points.
  40992. */
  40993. export interface PlotEmaParamsOptions {
  40994. /**
  40995. * (Highstock) The point index which indicator calculations will base. For
  40996. * example using OHLC data, index=2 means the indicator will be calculated
  40997. * using Low values.
  40998. *
  40999. * By default index value used to be set to 0. Since Highstock 7 by default
  41000. * index is set to 3 which means that the ema indicator will be calculated
  41001. * using Close values.
  41002. */
  41003. index?: number;
  41004. /**
  41005. * (Highstock) The base period for indicator calculations. This is the
  41006. * number of data points which are taken into account for the indicator
  41007. * calculations.
  41008. */
  41009. period?: number;
  41010. }
  41011. /**
  41012. * (Highcharts, Highstock) Enable or disable the initial animation when a series
  41013. * is displayed. The animation can also be set as a configuration object. Please
  41014. * note that this option only applies to the initial animation of the series
  41015. * itself. For other animations, see chart.animation and the animation parameter
  41016. * under the API methods. The following properties are supported:
  41017. *
  41018. * - `defer`: The animation delay time in milliseconds.
  41019. *
  41020. * - `duration`: The duration of the animation in milliseconds.
  41021. *
  41022. * - `easing`: Can be a string reference to an easing function set on the `Math`
  41023. * object or a function. See the _Custom easing function_ demo below.
  41024. *
  41025. * Due to poor performance, animation is disabled in old IE browsers for several
  41026. * chart types.
  41027. */
  41028. export interface PlotErrorbarAnimationOptions {
  41029. defer?: number;
  41030. }
  41031. /**
  41032. * (Highcharts, Highstock, Highmaps, Gantt) Enable or disable the initial
  41033. * animation when a series is displayed for the `dataLabels`. The animation can
  41034. * also be set as a configuration object. Please note that this option only
  41035. * applies to the initial animation. For other animations, see chart.animation
  41036. * and the animation parameter under the API methods. The following properties
  41037. * are supported:
  41038. *
  41039. * - `defer`: The animation delay time in milliseconds.
  41040. */
  41041. export interface PlotErrorbarDataLabelsAnimationOptions {
  41042. /**
  41043. * (Highcharts, Highstock, Highmaps, Gantt) The animation delay time in
  41044. * milliseconds. Set to `0` renders dataLabel immediately. As `undefined`
  41045. * inherits defer time from the series.animation.defer.
  41046. */
  41047. defer?: number;
  41048. }
  41049. /**
  41050. * (Highcharts, Highstock, Highmaps, Gantt) Options for the series data labels,
  41051. * appearing next to each data point.
  41052. *
  41053. * Since v6.2.0, multiple data labels can be applied to each single point by
  41054. * defining them as an array of configs.
  41055. *
  41056. * In styled mode, the data labels can be styled with the
  41057. * `.highcharts-data-label-box` and `.highcharts-data-label` class names (see
  41058. * example).
  41059. */
  41060. export interface PlotErrorbarDataLabelsOptions {
  41061. /**
  41062. * (Highcharts, Highstock, Highmaps, Gantt) The alignment of the data label
  41063. * compared to the point. If `right`, the right side of the label should be
  41064. * touching the point. For points with an extent, like columns, the
  41065. * alignments also dictates how to align it inside the box, as given with
  41066. * the inside option. Can be one of `left`, `center` or `right`.
  41067. */
  41068. align?: string;
  41069. /**
  41070. * (Highcharts, Highstock, Highmaps, Gantt) Whether to allow data labels to
  41071. * overlap. To make the labels less sensitive for overlapping, the
  41072. * dataLabels.padding can be set to 0.
  41073. */
  41074. allowOverlap?: boolean;
  41075. /**
  41076. * (Highcharts, Highstock, Highmaps, Gantt) Enable or disable the initial
  41077. * animation when a series is displayed for the `dataLabels`. The animation
  41078. * can also be set as a configuration object. Please note that this option
  41079. * only applies to the initial animation. For other animations, see
  41080. * chart.animation and the animation parameter under the API methods. The
  41081. * following properties are supported:
  41082. *
  41083. * - `defer`: The animation delay time in milliseconds.
  41084. */
  41085. animation?: (boolean|PlotErrorbarDataLabelsAnimationOptions|Partial<AnimationOptionsObject>);
  41086. /**
  41087. * (Highcharts, Highstock, Highmaps, Gantt) The background color or gradient
  41088. * for the data label.
  41089. */
  41090. backgroundColor?: (ColorString|GradientColorObject|PatternObject);
  41091. /**
  41092. * (Highcharts, Highstock, Highmaps, Gantt) The border color for the data
  41093. * label. Defaults to `undefined`.
  41094. */
  41095. borderColor?: (ColorString|GradientColorObject|PatternObject);
  41096. /**
  41097. * (Highcharts, Highstock, Highmaps, Gantt) The border radius in pixels for
  41098. * the data label.
  41099. */
  41100. borderRadius?: number;
  41101. /**
  41102. * (Highcharts, Highstock, Highmaps, Gantt) The border width in pixels for
  41103. * the data label.
  41104. */
  41105. borderWidth?: number;
  41106. /**
  41107. * (Highcharts, Highstock, Highmaps, Gantt) A class name for the data label.
  41108. * Particularly in styled mode, this can be used to give each series' or
  41109. * point's data label unique styling. In addition to this option, a default
  41110. * color class name is added so that we can give the labels a contrast text
  41111. * shadow.
  41112. */
  41113. className?: string;
  41114. /**
  41115. * (Highcharts, Highstock, Highmaps, Gantt) The text color for the data
  41116. * labels. Defaults to `undefined`. For certain series types, like column or
  41117. * map, the data labels can be drawn inside the points. In this case the
  41118. * data label will be drawn with maximum contrast by default. Additionally,
  41119. * it will be given a `text-outline` style with the opposite color, to
  41120. * further increase the contrast. This can be overridden by setting the
  41121. * `text-outline` style to `none` in the `dataLabels.style` option.
  41122. */
  41123. color?: (ColorString|GradientColorObject|PatternObject);
  41124. /**
  41125. * (Highcharts, Highstock, Highmaps, Gantt) Whether to hide data labels that
  41126. * are outside the plot area. By default, the data label is moved inside the
  41127. * plot area according to the overflow option.
  41128. */
  41129. crop?: boolean;
  41130. /**
  41131. * (Highcharts, Highstock, Gantt) Whether to defer displaying the data
  41132. * labels until the initial series animation has finished. Setting to
  41133. * `false` renders the data label immediately. If set to `true` inherits the
  41134. * defer time set in plotOptions.series.animation.
  41135. */
  41136. defer?: boolean;
  41137. /**
  41138. * (Highcharts, Highstock, Highmaps, Gantt) Enable or disable the data
  41139. * labels.
  41140. */
  41141. enabled?: boolean;
  41142. /**
  41143. * (Highcharts, Highstock, Highmaps, Gantt) A declarative filter to control
  41144. * of which data labels to display. The declarative filter is designed for
  41145. * use when callback functions are not available, like when the chart
  41146. * options require a pure JSON structure or for use with graphical editors.
  41147. * For programmatic control, use the `formatter` instead, and return
  41148. * `undefined` to disable a single data label.
  41149. */
  41150. filter?: DataLabelsFilterOptionsObject;
  41151. /**
  41152. * (Highcharts, Highstock, Highmaps, Gantt) A format string for the data
  41153. * label. Available variables are the same as for `formatter`.
  41154. */
  41155. format?: string;
  41156. /**
  41157. * (Highcharts, Highstock, Highmaps, Gantt) Callback JavaScript function to
  41158. * format the data label. Note that if a `format` is defined, the format
  41159. * takes precedence and the formatter is ignored.
  41160. */
  41161. formatter?: DataLabelsFormatterCallbackFunction;
  41162. /**
  41163. * (Highcharts, Highstock, Highmaps, Gantt) For points with an extent, like
  41164. * columns or map areas, whether to align the data label inside the box or
  41165. * to the actual value point. Defaults to `false` in most cases, `true` in
  41166. * stacked columns.
  41167. */
  41168. inside?: boolean;
  41169. /**
  41170. * (Highcharts, Highstock, Highmaps, Gantt) Format for points with the value
  41171. * of null. Works analogously to format. `nullFormat` can be applied only to
  41172. * series which support displaying null points.
  41173. */
  41174. nullFormat?: (boolean|string);
  41175. /**
  41176. * (Highcharts, Highstock, Highmaps, Gantt) Callback JavaScript function
  41177. * that defines formatting for points with the value of null. Works
  41178. * analogously to formatter. `nullPointFormatter` can be applied only to
  41179. * series which support displaying null points.
  41180. */
  41181. nullFormatter?: DataLabelsFormatterCallbackFunction;
  41182. /**
  41183. * (Highcharts, Highstock, Highmaps, Gantt) How to handle data labels that
  41184. * flow outside the plot area. The default is `"justify"`, which aligns them
  41185. * inside the plot area. For columns and bars, this means it will be moved
  41186. * inside the bar. To display data labels outside the plot area, set `crop`
  41187. * to `false` and `overflow` to `"allow"`.
  41188. */
  41189. overflow?: DataLabelsOverflowValue;
  41190. /**
  41191. * (Highcharts, Highstock, Highmaps, Gantt) When either the `borderWidth` or
  41192. * the `backgroundColor` is set, this is the padding within the box.
  41193. */
  41194. padding?: number;
  41195. /**
  41196. * (Highcharts, Highstock, Highmaps, Gantt) Aligns data labels relative to
  41197. * points. If `center` alignment is not possible, it defaults to `right`.
  41198. */
  41199. position?: AlignValue;
  41200. /**
  41201. * (Highcharts, Highstock, Highmaps, Gantt) Text rotation in degrees. Note
  41202. * that due to a more complex structure, backgrounds, borders and padding
  41203. * will be lost on a rotated data label.
  41204. */
  41205. rotation?: number;
  41206. /**
  41207. * (Highcharts, Highstock, Highmaps, Gantt) The shadow of the box. Works
  41208. * best with `borderWidth` or `backgroundColor`. Since 2.3 the shadow can be
  41209. * an object configuration containing `color`, `offsetX`, `offsetY`,
  41210. * `opacity` and `width`.
  41211. */
  41212. shadow?: (boolean|ShadowOptionsObject);
  41213. /**
  41214. * (Highcharts, Highstock, Highmaps, Gantt) The name of a symbol to use for
  41215. * the border around the label. Symbols are predefined functions on the
  41216. * Renderer object.
  41217. */
  41218. shape?: string;
  41219. /**
  41220. * (Highcharts, Highstock, Highmaps, Gantt) Styles for the label. The
  41221. * default `color` setting is `"contrast"`, which is a pseudo color that
  41222. * Highcharts picks up and applies the maximum contrast to the underlying
  41223. * point item, for example the bar in a bar chart.
  41224. *
  41225. * The `textOutline` is a pseudo property that applies an outline of the
  41226. * given width with the given color, which by default is the maximum
  41227. * contrast to the text. So a bright text color will result in a black text
  41228. * outline for maximum readability on a mixed background. In some cases,
  41229. * especially with grayscale text, the text outline doesn't work well, in
  41230. * which cases it can be disabled by setting it to `"none"`. When `useHTML`
  41231. * is true, the `textOutline` will not be picked up. In this, case, the same
  41232. * effect can be acheived through the `text-shadow` CSS property.
  41233. *
  41234. * For some series types, where each point has an extent, like for example
  41235. * tree maps, the data label may overflow the point. There are two
  41236. * strategies for handling overflow. By default, the text will wrap to
  41237. * multiple lines. The other strategy is to set `style.textOverflow` to
  41238. * `ellipsis`, which will keep the text on one line plus it will break
  41239. * inside long words.
  41240. */
  41241. style?: CSSObject;
  41242. /**
  41243. * (Highcharts, Highstock, Highmaps, Gantt) Options for a label text which
  41244. * should follow marker's shape. Border and background are disabled for a
  41245. * label that follows a path.
  41246. *
  41247. * **Note:** Only SVG-based renderer supports this option. Setting `useHTML`
  41248. * to true will disable this option.
  41249. */
  41250. textPath?: DataLabelsTextPathOptionsObject;
  41251. /**
  41252. * (Highcharts, Highstock, Highmaps, Gantt) Whether to use HTML to render
  41253. * the labels.
  41254. */
  41255. useHTML?: boolean;
  41256. /**
  41257. * (Highcharts, Highstock, Highmaps, Gantt) The vertical alignment of a data
  41258. * label. Can be one of `top`, `middle` or `bottom`. The default value
  41259. * depends on the data, for instance in a column chart, the label is above
  41260. * positive values and below negative values.
  41261. */
  41262. verticalAlign?: string;
  41263. /**
  41264. * (Highcharts, Highstock, Highmaps, Gantt) The x position offset of the
  41265. * label relative to the point in pixels.
  41266. */
  41267. x?: number;
  41268. /**
  41269. * (Highcharts, Highstock, Highmaps, Gantt) The y position offset of the
  41270. * label relative to the point in pixels.
  41271. */
  41272. y?: number;
  41273. /**
  41274. * (Highcharts, Highstock, Highmaps, Gantt) The Z index of the data labels.
  41275. * The default Z index puts it above the series. Use a Z index of 2 to
  41276. * display it behind the series.
  41277. */
  41278. z?: number;
  41279. }
  41280. /**
  41281. * (Highcharts, Highstock) Options for the series data sorting.
  41282. */
  41283. export interface PlotErrorbarDataSortingOptions {
  41284. /**
  41285. * (Highcharts, Highstock) Enable or disable data sorting for the series.
  41286. * Use xAxis.reversed to change the sorting order.
  41287. */
  41288. enabled?: boolean;
  41289. /**
  41290. * (Highcharts, Highstock) Whether to allow matching points by name in an
  41291. * update. If this option is disabled, points will be matched by order.
  41292. */
  41293. matchByName?: boolean;
  41294. /**
  41295. * (Highcharts, Highstock) Determines what data value should be used to sort
  41296. * by.
  41297. */
  41298. sortKey?: string;
  41299. }
  41300. /**
  41301. * (Highcharts, Highstock) Style options for the guide box. The guide box has
  41302. * one state by default, the `default` state.
  41303. */
  41304. export interface PlotErrorbarDragDropGuideBoxOptions {
  41305. /**
  41306. * (Highcharts, Highstock) Style options for the guide box default state.
  41307. */
  41308. default?: DragDropGuideBoxOptionsObject;
  41309. }
  41310. /**
  41311. * (Highcharts, Highstock) Error bars are a graphical representation of the
  41312. * variability of data and are used on graphs to indicate the error, or
  41313. * uncertainty in a reported measurement.
  41314. *
  41315. * In TypeScript the type option must always be set.
  41316. *
  41317. * Configuration options for the series are given in three levels:
  41318. *
  41319. * 1. Options for all series in a chart are defined in the plotOptions.series
  41320. * object.
  41321. *
  41322. * 2. Options for all `errorbar` series are defined in plotOptions.errorbar.
  41323. *
  41324. * 3. Options for one single series are given in the series instance array. (see
  41325. * online documentation for example)
  41326. */
  41327. export interface PlotErrorbarOptions {
  41328. /**
  41329. * (Highcharts, Highstock) Accessibility options for a series.
  41330. */
  41331. accessibility?: SeriesAccessibilityOptionsObject;
  41332. /**
  41333. * (Highmaps) Whether all areas of the map defined in `mapData` should be
  41334. * rendered. If `true`, areas which don't correspond to a data point, are
  41335. * rendered as `null` points. If `false`, those areas are skipped.
  41336. */
  41337. allAreas?: boolean;
  41338. /**
  41339. * (Highcharts, Highstock) Allow this series' points to be selected by
  41340. * clicking on the graphic (columns, point markers, pie slices, map areas
  41341. * etc).
  41342. *
  41343. * The selected points can be handled by point select and unselect events,
  41344. * or collectively by the getSelectedPoints function.
  41345. *
  41346. * And alternative way of selecting points is through dragging.
  41347. */
  41348. allowPointSelect?: boolean;
  41349. /**
  41350. * (Highcharts, Highstock) Enable or disable the initial animation when a
  41351. * series is displayed. The animation can also be set as a configuration
  41352. * object. Please note that this option only applies to the initial
  41353. * animation of the series itself. For other animations, see chart.animation
  41354. * and the animation parameter under the API methods. The following
  41355. * properties are supported:
  41356. *
  41357. * - `defer`: The animation delay time in milliseconds.
  41358. *
  41359. * - `duration`: The duration of the animation in milliseconds.
  41360. *
  41361. * - `easing`: Can be a string reference to an easing function set on the
  41362. * `Math` object or a function. See the _Custom easing function_ demo below.
  41363. *
  41364. * Due to poor performance, animation is disabled in old IE browsers for
  41365. * several chart types.
  41366. */
  41367. animation?: (boolean|PlotErrorbarAnimationOptions|Partial<AnimationOptionsObject>);
  41368. /**
  41369. * (Highcharts, Highstock) For some series, there is a limit that shuts down
  41370. * initial animation by default when the total number of points in the chart
  41371. * is too high. For example, for a column chart and its derivatives,
  41372. * animation does not run if there is more than 250 points totally. To
  41373. * disable this cap, set `animationLimit` to `Infinity`.
  41374. */
  41375. animationLimit?: number;
  41376. /**
  41377. * (Highcharts) The dash style of the box.
  41378. */
  41379. boxDashStyle?: DashStyleValue;
  41380. /**
  41381. * (Highcharts, Highstock, Gantt) When `true`, the columns will center in
  41382. * the category, ignoring null or missing points. When `false`, space will
  41383. * be reserved for null or missing points.
  41384. */
  41385. centerInCategory?: boolean;
  41386. /**
  41387. * (Highcharts, Highstock) An additional class name to apply to the series'
  41388. * graphical elements. This option does not replace default class names of
  41389. * the graphical element.
  41390. */
  41391. className?: string;
  41392. /**
  41393. * (Highcharts, Highstock) Disable this option to allow series rendering in
  41394. * the whole plotting area.
  41395. *
  41396. * **Note:** Clipping should be always enabled when chart.zoomType is set
  41397. */
  41398. clip?: boolean;
  41399. /**
  41400. * (Highcharts) The main color of the bars. This can be overridden by
  41401. * stemColor and whiskerColor individually.
  41402. */
  41403. color?: (ColorString|GradientColorObject|PatternObject);
  41404. /**
  41405. * (Highcharts, Highstock, Highmaps) When using dual or multiple color axes,
  41406. * this number defines which colorAxis the particular series is connected
  41407. * to. It refers to either the axis id or the index of the axis in the
  41408. * colorAxis array, with 0 being the first. Set this option to false to
  41409. * prevent a series from connecting to the default color axis.
  41410. *
  41411. * Since v7.2.0 the option can also be an axis id or an axis index instead
  41412. * of a boolean flag.
  41413. */
  41414. colorAxis?: (boolean|number|string);
  41415. /**
  41416. * (Highcharts, Highstock, Gantt) When using automatic point colors pulled
  41417. * from the global colors or series-specific plotOptions.column.colors
  41418. * collections, this option determines whether the chart should receive one
  41419. * color per series or one color per point.
  41420. *
  41421. * In styled mode, the `colors` or `series.colors` arrays are not supported,
  41422. * and instead this option gives the points individual color class names on
  41423. * the form `highcharts-color-{n}`.
  41424. */
  41425. colorByPoint?: boolean;
  41426. /**
  41427. * (Highcharts, Highstock) Styled mode only. A specific color index to use
  41428. * for the series, so its graphic representations are given the class name
  41429. * `highcharts-color-{n}`.
  41430. */
  41431. colorIndex?: number;
  41432. /**
  41433. * (Highcharts, Highstock, Highmaps) Determines what data value should be
  41434. * used to calculate point color if `colorAxis` is used. Requires to set
  41435. * `min` and `max` if some custom point property is used or if approximation
  41436. * for data grouping is set to `'sum'`.
  41437. */
  41438. colorKey?: string;
  41439. /**
  41440. * (Highcharts, Highstock, Gantt) A series specific or series type specific
  41441. * color set to apply instead of the global colors when colorByPoint is
  41442. * true.
  41443. */
  41444. colors?: Array<(ColorString|GradientColorObject|PatternObject)>;
  41445. /**
  41446. * (Highstock) Compare the values of the series against the first non-null,
  41447. * non- zero value in the visible range. The y axis will show percentage or
  41448. * absolute change depending on whether `compare` is set to `"percent"` or
  41449. * `"value"`. When this is applied to multiple series, it allows comparing
  41450. * the development of the series against each other. Adds a `change` field
  41451. * to every point object.
  41452. */
  41453. compare?: string;
  41454. /**
  41455. * (Highstock) When compare is `percent`, this option dictates whether to
  41456. * use 0 or 100 as the base of comparison.
  41457. */
  41458. compareBase?: (0|100);
  41459. /**
  41460. * (Highstock) Defines if comparison should start from the first point
  41461. * within the visible range or should start from the first point **before**
  41462. * the range.
  41463. *
  41464. * In other words, this flag determines if first point within the visible
  41465. * range will have 0% (`compareStart=true`) or should have been already
  41466. * calculated according to the previous point (`compareStart=false`).
  41467. */
  41468. compareStart?: boolean;
  41469. /**
  41470. * (Gantt) Override Pathfinder connector options for a series. Requires
  41471. * Highcharts Gantt to be loaded.
  41472. */
  41473. connectors?: SeriesConnectorsOptionsObject;
  41474. /**
  41475. * (Highcharts, Highstock, Gantt) When true, each point or column edge is
  41476. * rounded to its nearest pixel in order to render sharp on screen. In some
  41477. * cases, when there are a lot of densely packed columns, this leads to
  41478. * visible difference in column widths or distance between columns. In these
  41479. * cases, setting `crisp` to `false` may look better, even though each
  41480. * column is rendered blurry.
  41481. */
  41482. crisp?: boolean;
  41483. /**
  41484. * (Highcharts, Highstock, Gantt) When the series contains less points than
  41485. * the crop threshold, all points are drawn, event if the points fall
  41486. * outside the visible plot area at the current zoom. The advantage of
  41487. * drawing all points (including markers and columns), is that animation is
  41488. * performed on updates. On the other hand, when the series contains more
  41489. * points than the crop threshold, the series data is cropped to only
  41490. * contain points that fall within the plot area. The advantage of cropping
  41491. * away invisible points is to increase performance on large series.
  41492. */
  41493. cropThreshold?: number;
  41494. /**
  41495. * (Highcharts, Highstock) You can set the cursor to "pointer" if you have
  41496. * click events attached to the series, to signal to the user that the
  41497. * points and lines can be clicked.
  41498. *
  41499. * In styled mode, the series cursor can be set with the same classes as
  41500. * listed under series.color.
  41501. */
  41502. cursor?: (string|CursorValue);
  41503. /**
  41504. * (Highcharts, Highstock) A reserved subspace to store options and values
  41505. * for customized functionality. Here you can add additional data for your
  41506. * own event callbacks and formatter callbacks.
  41507. */
  41508. custom?: Dictionary<any>;
  41509. /**
  41510. * (Highcharts, Highstock) Name of the dash style to use for the graph, or
  41511. * for some series types the outline of each shape.
  41512. *
  41513. * In styled mode, the stroke dash-array can be set with the same classes as
  41514. * listed under series.color.
  41515. */
  41516. dashStyle?: DashStyleValue;
  41517. /**
  41518. * (Highstock) Data grouping is the concept of sampling the data values into
  41519. * larger blocks in order to ease readability and increase performance of
  41520. * the JavaScript charts. Highstock by default applies data grouping when
  41521. * the points become closer than a certain pixel value, determined by the
  41522. * `groupPixelWidth` option.
  41523. *
  41524. * If data grouping is applied, the grouping information of grouped points
  41525. * can be read from the Point.dataGroup. If point options other than the
  41526. * data itself are set, for example `name` or `color` or custom properties,
  41527. * the grouping logic doesn't know how to group it. In this case the options
  41528. * of the first point instance are copied over to the group point. This can
  41529. * be altered through a custom `approximation` callback function.
  41530. */
  41531. dataGrouping?: DataGroupingOptionsObject;
  41532. /**
  41533. * (Highcharts, Highstock, Highmaps, Gantt) Options for the series data
  41534. * labels, appearing next to each data point.
  41535. *
  41536. * Since v6.2.0, multiple data labels can be applied to each single point by
  41537. * defining them as an array of configs.
  41538. *
  41539. * In styled mode, the data labels can be styled with the
  41540. * `.highcharts-data-label-box` and `.highcharts-data-label` class names
  41541. * (see example).
  41542. */
  41543. dataLabels?: (PlotErrorbarDataLabelsOptions|Array<PlotErrorbarDataLabelsOptions>);
  41544. /**
  41545. * (Highcharts, Highstock) Options for the series data sorting.
  41546. */
  41547. dataSorting?: (DataSortingOptionsObject|PlotErrorbarDataSortingOptions);
  41548. /**
  41549. * (Highcharts) Depth of the columns in a 3D column chart.
  41550. */
  41551. depth?: number;
  41552. /**
  41553. * (Highcharts, Highstock) A description of the series to add to the screen
  41554. * reader information about the series.
  41555. */
  41556. description?: string;
  41557. /**
  41558. * (Highcharts, Highstock) The draggable-points module allows points to be
  41559. * moved around or modified in the chart. In addition to the options
  41560. * mentioned under the `dragDrop` API structure, the module fires three
  41561. * events, point.dragStart, point.drag and point.drop.
  41562. */
  41563. dragDrop?: SeriesDragDropOptionsObject;
  41564. /**
  41565. * (Highcharts) 3D columns only. The color of the edges. Similar to
  41566. * `borderColor`, except it defaults to the same color as the column.
  41567. */
  41568. edgeColor?: ColorString;
  41569. /**
  41570. * (Highcharts) 3D columns only. The width of the colored edges.
  41571. */
  41572. edgeWidth?: number;
  41573. /**
  41574. * (Highcharts, Highstock) Enable or disable the mouse tracking for a
  41575. * specific series. This includes point tooltips and click events on graphs
  41576. * and points. For large datasets it improves performance.
  41577. */
  41578. enableMouseTracking?: boolean;
  41579. /**
  41580. * (Highcharts, Highstock) General event handlers for the series items.
  41581. * These event hooks can also be attached to the series at run time using
  41582. * the `Highcharts.addEvent` function.
  41583. */
  41584. events?: SeriesEventsOptionsObject;
  41585. /**
  41586. * (Highcharts) The fill color of the box.
  41587. *
  41588. * In styled mode, the fill color can be set with the
  41589. * `.highcharts-boxplot-box` class.
  41590. */
  41591. fillColor?: (ColorString|GradientColorObject|PatternObject);
  41592. /**
  41593. * (Highcharts, Highstock) Determines whether the series should look for the
  41594. * nearest point in both dimensions or just the x-dimension when hovering
  41595. * the series. Defaults to `'xy'` for scatter series and `'x'` for most
  41596. * other series. If the data has duplicate x-values, it is recommended to
  41597. * set this to `'xy'` to allow hovering over all points.
  41598. *
  41599. * Applies only to series types using nearest neighbor search (not direct
  41600. * hover) for tooltip.
  41601. */
  41602. findNearestPointBy?: OptionsFindNearestPointByValue;
  41603. /**
  41604. * (Highcharts, Highstock, Gantt) Whether to use the Y extremes of the total
  41605. * chart width or only the zoomed area when zooming in on parts of the X
  41606. * axis. By default, the Y axis adjusts to the min and max of the visible
  41607. * data. Cartesian series only.
  41608. */
  41609. getExtremesFromAll?: boolean;
  41610. /**
  41611. * (Highcharts, Highstock, Gantt) Whether to group non-stacked columns or to
  41612. * let them render independent of each other. Non-grouped columns will be
  41613. * laid out individually and overlap each other.
  41614. */
  41615. grouping?: boolean;
  41616. /**
  41617. * (Highcharts, Highstock, Gantt) Padding between each value groups, in x
  41618. * axis units.
  41619. */
  41620. groupPadding?: number;
  41621. /**
  41622. * (Highcharts, Highstock) When set to `false` will prevent the series data
  41623. * from being included in any form of data export.
  41624. *
  41625. * Since version 6.0.0 until 7.1.0 the option was existing undocumented as
  41626. * `includeInCSVExport`.
  41627. */
  41628. includeInDataExport?: boolean;
  41629. /**
  41630. * (Highmaps) What property to join the `mapData` to the value data. For
  41631. * example, if joinBy is "code", the mapData items with a specific code is
  41632. * merged into the data with the same code. For maps loaded from GeoJSON,
  41633. * the keys may be held in each point's `properties` object.
  41634. *
  41635. * The joinBy option can also be an array of two values, where the first
  41636. * points to a key in the `mapData`, and the second points to another key in
  41637. * the `data`.
  41638. *
  41639. * When joinBy is `null`, the map items are joined by their position in the
  41640. * array, which performs much better in maps with many data points. This is
  41641. * the recommended option if you are printing more than a thousand data
  41642. * points and have a backend that can preprocess the data into a parallel
  41643. * array of the mapData.
  41644. */
  41645. joinBy?: (string|Array<string>);
  41646. /**
  41647. * (Highcharts, Highstock) An array specifying which option maps to which
  41648. * key in the data point array. This makes it convenient to work with
  41649. * unstructured data arrays from different sources.
  41650. */
  41651. keys?: Array<string>;
  41652. /**
  41653. * (Highcharts, Highstock, Gantt) Series labels are placed as close to the
  41654. * series as possible in a natural way, seeking to avoid other series. The
  41655. * goal of this feature is to make the chart more easily readable, like if a
  41656. * human designer placed the labels in the optimal position.
  41657. *
  41658. * The series labels currently work with series types having a `graph` or an
  41659. * `area`.
  41660. */
  41661. label?: SeriesLabelOptionsObject;
  41662. /**
  41663. * (Highstock) The line marks the last price from all points.
  41664. */
  41665. lastPrice?: SeriesLastPriceOptionsObject;
  41666. /**
  41667. * (Highstock) The line marks the last price from visible range of points.
  41668. */
  41669. lastVisiblePrice?: SeriesLastVisiblePriceOptionsObject;
  41670. /**
  41671. * (Highcharts) The width of the line surrounding the box. If any of
  41672. * stemWidth, medianWidth or whiskerWidth are `null`, the lineWidth also
  41673. * applies to these lines.
  41674. */
  41675. lineWidth?: number;
  41676. /**
  41677. * (Highcharts) The parent series of the error bar. The default value links
  41678. * it to the previous series. Otherwise, use the id of the parent series.
  41679. */
  41680. linkedTo?: string;
  41681. /**
  41682. * (Highcharts, Highstock, Gantt) The maximum allowed pixel width for a
  41683. * column, translated to the height of a bar in a bar chart. This prevents
  41684. * the columns from becoming too wide when there is a small number of points
  41685. * in the chart.
  41686. */
  41687. maxPointWidth?: number;
  41688. /**
  41689. * (Highcharts) The color of the median line. If `undefined`, the general
  41690. * series color applies.
  41691. *
  41692. * In styled mode, the median stroke width can be set with the
  41693. * `.highcharts-boxplot-median` class.
  41694. */
  41695. medianColor?: (ColorString|GradientColorObject);
  41696. /**
  41697. * (Highcharts) The dash style of the median.
  41698. */
  41699. medianDashStyle?: DashStyleValue;
  41700. /**
  41701. * (Highcharts) The pixel width of the median line. If `null`, the lineWidth
  41702. * is used.
  41703. *
  41704. * In styled mode, the median stroke width can be set with the
  41705. * `.highcharts-boxplot-median` class.
  41706. */
  41707. medianWidth?: (number|null);
  41708. /**
  41709. * (Highcharts, Highstock, Gantt) The minimal height for a column or width
  41710. * for a bar. By default, 0 values are not shown. To visualize a 0 (or close
  41711. * to zero) point, set the minimal point length to a pixel value like 3\. In
  41712. * stacked column charts, minPointLength might not be respected for tightly
  41713. * packed values.
  41714. */
  41715. minPointLength?: number;
  41716. /**
  41717. * (Highstock) Options for the corresponding navigator series if
  41718. * `showInNavigator` is `true` for this series. Available options are the
  41719. * same as any series, documented at plotOptions and series.
  41720. *
  41721. * These options are merged with options in navigator.series, and will take
  41722. * precedence if the same option is defined both places.
  41723. */
  41724. navigatorOptions?: PlotSeriesOptions;
  41725. /**
  41726. * (Highcharts, Highstock) The color for the parts of the graph or points
  41727. * that are below the threshold. Note that `zones` takes precedence over the
  41728. * negative color. Using `negativeColor` is equivalent to applying a zone
  41729. * with value of 0.
  41730. */
  41731. negativeColor?: (ColorString|GradientColorObject|PatternObject);
  41732. /**
  41733. * (Highcharts, Highstock) Opacity of a series parts: line, fill (e.g. area)
  41734. * and dataLabels.
  41735. */
  41736. opacity?: number;
  41737. /**
  41738. * (Highcharts, Highstock) Properties for each single point.
  41739. */
  41740. point?: PlotSeriesPointOptions;
  41741. /**
  41742. * (Highcharts, Highstock) Same as accessibility.pointDescriptionFormatter,
  41743. * but for an individual series. Overrides the chart wide configuration.
  41744. */
  41745. pointDescriptionFormatter?: Function;
  41746. /**
  41747. * (Highcharts, Highstock, Gantt) If no x values are given for the points in
  41748. * a series, `pointInterval` defines the interval of the x values. For
  41749. * example, if a series contains one value every decade starting from year
  41750. * 0, set `pointInterval` to `10`. In true `datetime` axes, the
  41751. * `pointInterval` is set in milliseconds.
  41752. *
  41753. * It can be also be combined with `pointIntervalUnit` to draw irregular
  41754. * time intervals.
  41755. *
  41756. * Please note that this options applies to the _series data_, not the
  41757. * interval of the axis ticks, which is independent.
  41758. */
  41759. pointInterval?: number;
  41760. /**
  41761. * (Highcharts, Highstock, Gantt) On datetime series, this allows for
  41762. * setting the pointInterval to irregular time units, `day`, `month` and
  41763. * `year`. A day is usually the same as 24 hours, but `pointIntervalUnit`
  41764. * also takes the DST crossover into consideration when dealing with local
  41765. * time. Combine this option with `pointInterval` to draw weeks, quarters, 6
  41766. * months, 10 years etc.
  41767. *
  41768. * Please note that this options applies to the _series data_, not the
  41769. * interval of the axis ticks, which is independent.
  41770. */
  41771. pointIntervalUnit?: OptionsPointIntervalUnitValue;
  41772. /**
  41773. * (Highcharts, Highstock, Gantt) Padding between each column or bar, in x
  41774. * axis units.
  41775. */
  41776. pointPadding?: number;
  41777. /**
  41778. * (Highcharts, Highstock, Gantt) Possible values: `"on"`, `"between"`,
  41779. * `number`.
  41780. *
  41781. * In a column chart, when pointPlacement is `"on"`, the point will not
  41782. * create any padding of the X axis. In a polar column chart this means that
  41783. * the first column points directly north. If the pointPlacement is
  41784. * `"between"`, the columns will be laid out between ticks. This is useful
  41785. * for example for visualising an amount between two points in time or in a
  41786. * certain sector of a polar chart.
  41787. *
  41788. * Since Highcharts 3.0.2, the point placement can also be numeric, where 0
  41789. * is on the axis value, -0.5 is between this value and the previous, and
  41790. * 0.5 is between this value and the next. Unlike the textual options,
  41791. * numeric point placement options won't affect axis padding.
  41792. *
  41793. * Note that pointPlacement needs a pointRange to work. For column series
  41794. * this is computed, but for line-type series it needs to be set.
  41795. *
  41796. * For the `xrange` series type and gantt charts, if the Y axis is a
  41797. * category axis, the `pointPlacement` applies to the Y axis rather than the
  41798. * (typically datetime) X axis.
  41799. *
  41800. * Defaults to `undefined` in cartesian charts, `"between"` in polar charts.
  41801. */
  41802. pointPlacement?: (number|string);
  41803. /**
  41804. * (Highcharts, Highstock, Gantt) The X axis range that each point is valid
  41805. * for. This determines the width of the column. On a categorized axis, the
  41806. * range will be 1 by default (one category unit). On linear and datetime
  41807. * axes, the range will be computed as the distance between the two closest
  41808. * data points.
  41809. *
  41810. * The default `null` means it is computed automatically, but this option
  41811. * can be used to override the automatic value.
  41812. *
  41813. * This option is set by default to 1 if data sorting is enabled.
  41814. */
  41815. pointRange?: (number|null);
  41816. /**
  41817. * (Highcharts, Highstock, Gantt) If no x values are given for the points in
  41818. * a series, pointStart defines on what value to start. For example, if a
  41819. * series contains one yearly value starting from 1945, set pointStart to
  41820. * 1945.
  41821. */
  41822. pointStart?: number;
  41823. /**
  41824. * (Highcharts, Highstock, Gantt) A pixel value specifying a fixed width for
  41825. * each column or bar point. When set to `undefined`, the width is
  41826. * calculated from the `pointPadding` and `groupPadding`. The width effects
  41827. * the dimension that is not based on the point value. For column series it
  41828. * is the hoizontal length and for bar series it is the vertical length.
  41829. */
  41830. pointWidth?: number;
  41831. /**
  41832. * (Highcharts, Highstock) Whether to select the series initially. If
  41833. * `showCheckbox` is true, the checkbox next to the series name in the
  41834. * legend will be checked for a selected series.
  41835. */
  41836. selected?: boolean;
  41837. /**
  41838. * (Highcharts, Highstock) Whether to apply a drop shadow to the graph line.
  41839. * Since 2.3 the shadow can be an object configuration containing `color`,
  41840. * `offsetX`, `offsetY`, `opacity` and `width`.
  41841. */
  41842. shadow?: (boolean|ShadowOptionsObject);
  41843. /**
  41844. * (Highcharts, Highstock) If true, a checkbox is displayed next to the
  41845. * legend item to allow selecting the series. The state of the checkbox is
  41846. * determined by the `selected` option.
  41847. */
  41848. showCheckbox?: boolean;
  41849. /**
  41850. * (Highcharts, Highstock) Whether to display this particular series or
  41851. * series type in the legend. Standalone series are shown in legend by
  41852. * default, and linked series are not. Since v7.2.0 it is possible to show
  41853. * series that use colorAxis by setting this option to `true`.
  41854. */
  41855. showInLegend?: boolean;
  41856. /**
  41857. * (Highstock) Whether or not to show the series in the navigator. Takes
  41858. * precedence over navigator.baseSeries if defined.
  41859. */
  41860. showInNavigator?: boolean;
  41861. /**
  41862. * (Highcharts, Highstock) If set to `true`, the accessibility module will
  41863. * skip past the points in this series for keyboard navigation.
  41864. */
  41865. skipKeyboardNavigation?: boolean;
  41866. /**
  41867. * (Highcharts, Highstock) When this is true, the series will not cause the
  41868. * Y axis to cross the zero plane (or threshold option) unless the data
  41869. * actually crosses the plane.
  41870. *
  41871. * For example, if `softThreshold` is `false`, a series of 0, 1, 2, 3 will
  41872. * make the Y axis show negative values according to the `minPadding`
  41873. * option. If `softThreshold` is `true`, the Y axis starts at 0.
  41874. */
  41875. softThreshold?: boolean;
  41876. /**
  41877. * (Highcharts, Highstock) Whether to stack the values of each series on top
  41878. * of each other. Possible values are `undefined` to disable, `"normal"` to
  41879. * stack by value or `"percent"`.
  41880. *
  41881. * When stacking is enabled, data must be sorted in ascending X order.
  41882. *
  41883. * Some stacking options are related to specific series types. In the
  41884. * streamgraph series type, the stacking option is set to `"stream"`. The
  41885. * second one is `"overlap"`, which only applies to waterfall series.
  41886. */
  41887. stacking?: OptionsStackingValue;
  41888. /**
  41889. * (Highcharts) The dash style of the stem, the vertical line extending from
  41890. * the box to the whiskers.
  41891. */
  41892. stemDashStyle?: DashStyleValue;
  41893. /**
  41894. * (Highcharts) The width of the stem, the vertical line extending from the
  41895. * box to the whiskers. If `undefined`, the width is inherited from the
  41896. * lineWidth option.
  41897. *
  41898. * In styled mode, the stem stroke width can be set with the
  41899. * `.highcharts-boxplot-stem` class.
  41900. */
  41901. stemWidth?: number;
  41902. /**
  41903. * (Highcharts, Highstock) Sticky tracking of mouse events. When true, the
  41904. * `mouseOut` event on a series isn't triggered until the mouse moves over
  41905. * another series, or out of the plot area. When false, the `mouseOut` event
  41906. * on a series is triggered when the mouse leaves the area around the
  41907. * series' graph or markers. This also implies the tooltip when not shared.
  41908. * When `stickyTracking` is false and `tooltip.shared` is false, the tooltip
  41909. * will be hidden when moving the mouse between series. Defaults to true for
  41910. * line and area type series, but to false for columns, pies etc.
  41911. *
  41912. * **Note:** The boost module will force this option because of technical
  41913. * limitations.
  41914. */
  41915. stickyTracking?: boolean;
  41916. /**
  41917. * (Highcharts) The Y axis value to serve as the base for the columns, for
  41918. * distinguishing between values above and below a threshold. If `null`, the
  41919. * columns extend from the padding Y axis minimum.
  41920. */
  41921. threshold?: (number|null);
  41922. /**
  41923. * (Highcharts, Highstock) A configuration object for the tooltip rendering
  41924. * of each single series. Properties are inherited from tooltip, but only
  41925. * the following properties can be defined on a series level.
  41926. */
  41927. tooltip?: SeriesTooltipOptionsObject;
  41928. /**
  41929. * (Highcharts, Highstock, Gantt) When a series contains a data array that
  41930. * is longer than this, only one dimensional arrays of numbers, or two
  41931. * dimensional arrays with x and y values are allowed. Also, only the first
  41932. * point is tested, and the rest are assumed to be the same format. This
  41933. * saves expensive data checking and indexing in long series. Set it to `0`
  41934. * disable.
  41935. *
  41936. * Note: In boost mode turbo threshold is forced. Only array of numbers or
  41937. * two dimensional arrays are allowed.
  41938. */
  41939. turboThreshold?: number;
  41940. /**
  41941. * (Highcharts, Highstock) Set the initial visibility of the series.
  41942. */
  41943. visible?: boolean;
  41944. /**
  41945. * (Highcharts) The color of the whiskers, the horizontal lines marking low
  41946. * and high values. When `undefined`, the general series color is used.
  41947. *
  41948. * In styled mode, the whisker stroke can be set with the
  41949. * `.highcharts-boxplot-whisker` class .
  41950. */
  41951. whiskerColor?: (ColorString|GradientColorObject|PatternObject);
  41952. /**
  41953. * (Highcharts) The dash style of the whiskers.
  41954. */
  41955. whiskerDashStyle?: DashStyleValue;
  41956. /**
  41957. * (Highcharts) The length of the whiskers, the horizontal lines marking low
  41958. * and high values. It can be a numerical pixel value, or a percentage value
  41959. * of the box width. Set `0` to disable whiskers.
  41960. */
  41961. whiskerLength?: (number|string);
  41962. /**
  41963. * (Highcharts) The line width of the whiskers, the horizontal lines marking
  41964. * low and high values. When `null`, the general lineWidth applies.
  41965. */
  41966. whiskerWidth?: number;
  41967. /**
  41968. * (Highmaps) Define the z index of the series.
  41969. */
  41970. zIndex?: number;
  41971. /**
  41972. * (Highcharts, Highstock) Defines the Axis on which the zones are applied.
  41973. */
  41974. zoneAxis?: string;
  41975. /**
  41976. * (Highcharts, Highstock) An array defining zones within a series. Zones
  41977. * can be applied to the X axis, Y axis or Z axis for bubbles, according to
  41978. * the `zoneAxis` option. The zone definitions have to be in ascending order
  41979. * regarding to the value.
  41980. *
  41981. * In styled mode, the color zones are styled with the
  41982. * `.highcharts-zone-{n}` class, or custom classed from the `className`
  41983. * option (view live demo).
  41984. */
  41985. zones?: Array<SeriesZonesOptionsObject>;
  41986. }
  41987. /**
  41988. * (Highcharts, Highstock, Highmaps, Gantt) Enable or disable the initial
  41989. * animation when a series is displayed for the `dataLabels`. The animation can
  41990. * also be set as a configuration object. Please note that this option only
  41991. * applies to the initial animation. For other animations, see chart.animation
  41992. * and the animation parameter under the API methods. The following properties
  41993. * are supported:
  41994. *
  41995. * - `defer`: The animation delay time in milliseconds.
  41996. */
  41997. export interface PlotFlagsDataLabelsAnimationOptions {
  41998. /**
  41999. * (Highcharts, Highstock, Highmaps, Gantt) The animation delay time in
  42000. * milliseconds. Set to `0` renders dataLabel immediately. As `undefined`
  42001. * inherits defer time from the series.animation.defer.
  42002. */
  42003. defer?: number;
  42004. }
  42005. /**
  42006. * (Highcharts, Highstock, Highmaps, Gantt) Options for the series data labels,
  42007. * appearing next to each data point.
  42008. *
  42009. * Since v6.2.0, multiple data labels can be applied to each single point by
  42010. * defining them as an array of configs.
  42011. *
  42012. * In styled mode, the data labels can be styled with the
  42013. * `.highcharts-data-label-box` and `.highcharts-data-label` class names (see
  42014. * example).
  42015. */
  42016. export interface PlotFlagsDataLabelsOptions {
  42017. /**
  42018. * (Highcharts, Highstock, Highmaps, Gantt) The alignment of the data label
  42019. * compared to the point. If `right`, the right side of the label should be
  42020. * touching the point. For points with an extent, like columns, the
  42021. * alignments also dictates how to align it inside the box, as given with
  42022. * the inside option. Can be one of `left`, `center` or `right`.
  42023. */
  42024. align?: string;
  42025. /**
  42026. * (Highcharts, Highstock, Highmaps, Gantt) Whether to allow data labels to
  42027. * overlap. To make the labels less sensitive for overlapping, the
  42028. * dataLabels.padding can be set to 0.
  42029. */
  42030. allowOverlap?: boolean;
  42031. /**
  42032. * (Highcharts, Highstock, Highmaps, Gantt) Enable or disable the initial
  42033. * animation when a series is displayed for the `dataLabels`. The animation
  42034. * can also be set as a configuration object. Please note that this option
  42035. * only applies to the initial animation. For other animations, see
  42036. * chart.animation and the animation parameter under the API methods. The
  42037. * following properties are supported:
  42038. *
  42039. * - `defer`: The animation delay time in milliseconds.
  42040. */
  42041. animation?: (boolean|PlotFlagsDataLabelsAnimationOptions|Partial<AnimationOptionsObject>);
  42042. /**
  42043. * (Highcharts, Highstock, Highmaps, Gantt) The background color or gradient
  42044. * for the data label.
  42045. */
  42046. backgroundColor?: (ColorString|GradientColorObject|PatternObject);
  42047. /**
  42048. * (Highcharts, Highstock, Highmaps, Gantt) The border color for the data
  42049. * label. Defaults to `undefined`.
  42050. */
  42051. borderColor?: (ColorString|GradientColorObject|PatternObject);
  42052. /**
  42053. * (Highcharts, Highstock, Highmaps, Gantt) The border radius in pixels for
  42054. * the data label.
  42055. */
  42056. borderRadius?: number;
  42057. /**
  42058. * (Highcharts, Highstock, Highmaps, Gantt) The border width in pixels for
  42059. * the data label.
  42060. */
  42061. borderWidth?: number;
  42062. /**
  42063. * (Highcharts, Highstock, Highmaps, Gantt) A class name for the data label.
  42064. * Particularly in styled mode, this can be used to give each series' or
  42065. * point's data label unique styling. In addition to this option, a default
  42066. * color class name is added so that we can give the labels a contrast text
  42067. * shadow.
  42068. */
  42069. className?: string;
  42070. /**
  42071. * (Highcharts, Highstock, Highmaps, Gantt) The text color for the data
  42072. * labels. Defaults to `undefined`. For certain series types, like column or
  42073. * map, the data labels can be drawn inside the points. In this case the
  42074. * data label will be drawn with maximum contrast by default. Additionally,
  42075. * it will be given a `text-outline` style with the opposite color, to
  42076. * further increase the contrast. This can be overridden by setting the
  42077. * `text-outline` style to `none` in the `dataLabels.style` option.
  42078. */
  42079. color?: (ColorString|GradientColorObject|PatternObject);
  42080. /**
  42081. * (Highcharts, Highstock, Highmaps, Gantt) Whether to hide data labels that
  42082. * are outside the plot area. By default, the data label is moved inside the
  42083. * plot area according to the overflow option.
  42084. */
  42085. crop?: boolean;
  42086. /**
  42087. * (Highcharts, Highstock, Gantt) Whether to defer displaying the data
  42088. * labels until the initial series animation has finished. Setting to
  42089. * `false` renders the data label immediately. If set to `true` inherits the
  42090. * defer time set in plotOptions.series.animation.
  42091. */
  42092. defer?: boolean;
  42093. /**
  42094. * (Highcharts, Highstock, Highmaps, Gantt) Enable or disable the data
  42095. * labels.
  42096. */
  42097. enabled?: boolean;
  42098. /**
  42099. * (Highcharts, Highstock, Highmaps, Gantt) A declarative filter to control
  42100. * of which data labels to display. The declarative filter is designed for
  42101. * use when callback functions are not available, like when the chart
  42102. * options require a pure JSON structure or for use with graphical editors.
  42103. * For programmatic control, use the `formatter` instead, and return
  42104. * `undefined` to disable a single data label.
  42105. */
  42106. filter?: DataLabelsFilterOptionsObject;
  42107. /**
  42108. * (Highcharts, Highstock, Highmaps, Gantt) A format string for the data
  42109. * label. Available variables are the same as for `formatter`.
  42110. */
  42111. format?: string;
  42112. /**
  42113. * (Highcharts, Highstock, Highmaps, Gantt) Callback JavaScript function to
  42114. * format the data label. Note that if a `format` is defined, the format
  42115. * takes precedence and the formatter is ignored.
  42116. */
  42117. formatter?: DataLabelsFormatterCallbackFunction;
  42118. /**
  42119. * (Highcharts, Highstock, Highmaps, Gantt) For points with an extent, like
  42120. * columns or map areas, whether to align the data label inside the box or
  42121. * to the actual value point. Defaults to `false` in most cases, `true` in
  42122. * stacked columns.
  42123. */
  42124. inside?: boolean;
  42125. /**
  42126. * (Highcharts, Highstock, Highmaps, Gantt) Format for points with the value
  42127. * of null. Works analogously to format. `nullFormat` can be applied only to
  42128. * series which support displaying null points.
  42129. */
  42130. nullFormat?: (boolean|string);
  42131. /**
  42132. * (Highcharts, Highstock, Highmaps, Gantt) Callback JavaScript function
  42133. * that defines formatting for points with the value of null. Works
  42134. * analogously to formatter. `nullPointFormatter` can be applied only to
  42135. * series which support displaying null points.
  42136. */
  42137. nullFormatter?: DataLabelsFormatterCallbackFunction;
  42138. /**
  42139. * (Highcharts, Highstock, Highmaps, Gantt) How to handle data labels that
  42140. * flow outside the plot area. The default is `"justify"`, which aligns them
  42141. * inside the plot area. For columns and bars, this means it will be moved
  42142. * inside the bar. To display data labels outside the plot area, set `crop`
  42143. * to `false` and `overflow` to `"allow"`.
  42144. */
  42145. overflow?: DataLabelsOverflowValue;
  42146. /**
  42147. * (Highcharts, Highstock, Highmaps, Gantt) When either the `borderWidth` or
  42148. * the `backgroundColor` is set, this is the padding within the box.
  42149. */
  42150. padding?: number;
  42151. /**
  42152. * (Highcharts, Highstock, Highmaps, Gantt) Aligns data labels relative to
  42153. * points. If `center` alignment is not possible, it defaults to `right`.
  42154. */
  42155. position?: AlignValue;
  42156. /**
  42157. * (Highcharts, Highstock, Highmaps, Gantt) Text rotation in degrees. Note
  42158. * that due to a more complex structure, backgrounds, borders and padding
  42159. * will be lost on a rotated data label.
  42160. */
  42161. rotation?: number;
  42162. /**
  42163. * (Highcharts, Highstock, Highmaps, Gantt) The shadow of the box. Works
  42164. * best with `borderWidth` or `backgroundColor`. Since 2.3 the shadow can be
  42165. * an object configuration containing `color`, `offsetX`, `offsetY`,
  42166. * `opacity` and `width`.
  42167. */
  42168. shadow?: (boolean|ShadowOptionsObject);
  42169. /**
  42170. * (Highcharts, Highstock, Highmaps, Gantt) The name of a symbol to use for
  42171. * the border around the label. Symbols are predefined functions on the
  42172. * Renderer object.
  42173. */
  42174. shape?: string;
  42175. /**
  42176. * (Highcharts, Highstock, Highmaps, Gantt) Styles for the label. The
  42177. * default `color` setting is `"contrast"`, which is a pseudo color that
  42178. * Highcharts picks up and applies the maximum contrast to the underlying
  42179. * point item, for example the bar in a bar chart.
  42180. *
  42181. * The `textOutline` is a pseudo property that applies an outline of the
  42182. * given width with the given color, which by default is the maximum
  42183. * contrast to the text. So a bright text color will result in a black text
  42184. * outline for maximum readability on a mixed background. In some cases,
  42185. * especially with grayscale text, the text outline doesn't work well, in
  42186. * which cases it can be disabled by setting it to `"none"`. When `useHTML`
  42187. * is true, the `textOutline` will not be picked up. In this, case, the same
  42188. * effect can be acheived through the `text-shadow` CSS property.
  42189. *
  42190. * For some series types, where each point has an extent, like for example
  42191. * tree maps, the data label may overflow the point. There are two
  42192. * strategies for handling overflow. By default, the text will wrap to
  42193. * multiple lines. The other strategy is to set `style.textOverflow` to
  42194. * `ellipsis`, which will keep the text on one line plus it will break
  42195. * inside long words.
  42196. */
  42197. style?: CSSObject;
  42198. /**
  42199. * (Highcharts, Highstock, Highmaps, Gantt) Options for a label text which
  42200. * should follow marker's shape. Border and background are disabled for a
  42201. * label that follows a path.
  42202. *
  42203. * **Note:** Only SVG-based renderer supports this option. Setting `useHTML`
  42204. * to true will disable this option.
  42205. */
  42206. textPath?: DataLabelsTextPathOptionsObject;
  42207. /**
  42208. * (Highcharts, Highstock, Highmaps, Gantt) Whether to use HTML to render
  42209. * the labels.
  42210. */
  42211. useHTML?: boolean;
  42212. /**
  42213. * (Highcharts, Highstock, Highmaps, Gantt) The vertical alignment of a data
  42214. * label. Can be one of `top`, `middle` or `bottom`. The default value
  42215. * depends on the data, for instance in a column chart, the label is above
  42216. * positive values and below negative values.
  42217. */
  42218. verticalAlign?: string;
  42219. /**
  42220. * (Highcharts, Highstock, Highmaps, Gantt) The x position offset of the
  42221. * label relative to the point in pixels.
  42222. */
  42223. x?: number;
  42224. /**
  42225. * (Highcharts, Highstock, Highmaps, Gantt) The y position offset of the
  42226. * label relative to the point in pixels.
  42227. */
  42228. y?: number;
  42229. /**
  42230. * (Highcharts, Highstock, Highmaps, Gantt) The Z index of the data labels.
  42231. * The default Z index puts it above the series. Use a Z index of 2 to
  42232. * display it behind the series.
  42233. */
  42234. z?: number;
  42235. }
  42236. /**
  42237. * (Highcharts, Highstock) Options for the series data sorting.
  42238. */
  42239. export interface PlotFlagsDataSortingOptions {
  42240. /**
  42241. * (Highcharts, Highstock) Enable or disable data sorting for the series.
  42242. * Use xAxis.reversed to change the sorting order.
  42243. */
  42244. enabled?: boolean;
  42245. /**
  42246. * (Highcharts, Highstock) Whether to allow matching points by name in an
  42247. * update. If this option is disabled, points will be matched by order.
  42248. */
  42249. matchByName?: boolean;
  42250. /**
  42251. * (Highcharts, Highstock) Determines what data value should be used to sort
  42252. * by.
  42253. */
  42254. sortKey?: string;
  42255. }
  42256. /**
  42257. * (Highstock) Style options for the guide box. The guide box has one state by
  42258. * default, the `default` state.
  42259. */
  42260. export interface PlotFlagsDragDropGuideBoxOptions {
  42261. /**
  42262. * (Highstock) Style options for the guide box default state.
  42263. */
  42264. default?: DragDropGuideBoxOptionsObject;
  42265. }
  42266. /**
  42267. * (Highstock) Flags are used to mark events in stock charts. They can be added
  42268. * on the timeline, or attached to a specific series.
  42269. *
  42270. * In TypeScript the type option must always be set.
  42271. *
  42272. * Configuration options for the series are given in three levels:
  42273. *
  42274. * 1. Options for all series in a chart are defined in the plotOptions.series
  42275. * object.
  42276. *
  42277. * 2. Options for all `flags` series are defined in plotOptions.flags.
  42278. *
  42279. * 3. Options for one single series are given in the series instance array. (see
  42280. * online documentation for example)
  42281. */
  42282. export interface PlotFlagsOptions {
  42283. /**
  42284. * (Highstock) Accessibility options for a series.
  42285. */
  42286. accessibility?: SeriesAccessibilityOptionsObject;
  42287. /**
  42288. * (Highmaps) Whether all areas of the map defined in `mapData` should be
  42289. * rendered. If `true`, areas which don't correspond to a data point, are
  42290. * rendered as `null` points. If `false`, those areas are skipped.
  42291. */
  42292. allAreas?: boolean;
  42293. /**
  42294. * (Highstock) Whether the flags are allowed to overlap sideways. If
  42295. * `false`, the flags are moved sideways using an algorithm that seeks to
  42296. * place every flag as close as possible to its original position.
  42297. */
  42298. allowOverlapX?: boolean;
  42299. /**
  42300. * (Highstock) Allow this series' points to be selected by clicking on the
  42301. * graphic (columns, point markers, pie slices, map areas etc).
  42302. *
  42303. * The selected points can be handled by point select and unselect events,
  42304. * or collectively by the getSelectedPoints function.
  42305. *
  42306. * And alternative way of selecting points is through dragging.
  42307. */
  42308. allowPointSelect?: boolean;
  42309. /**
  42310. * (Highstock) For some series, there is a limit that shuts down initial
  42311. * animation by default when the total number of points in the chart is too
  42312. * high. For example, for a column chart and its derivatives, animation does
  42313. * not run if there is more than 250 points totally. To disable this cap,
  42314. * set `animationLimit` to `Infinity`.
  42315. */
  42316. animationLimit?: number;
  42317. /**
  42318. * (Highstock) Sets the color blending in the boost module.
  42319. */
  42320. boostBlending?: OptionsBoostBlendingValue;
  42321. /**
  42322. * (Highstock) Set the point threshold for when a series should enter boost
  42323. * mode.
  42324. *
  42325. * Setting it to e.g. 2000 will cause the series to enter boost mode when
  42326. * there are 2000 or more points in the series.
  42327. *
  42328. * To disable boosting on the series, set the `boostThreshold` to 0. Setting
  42329. * it to 1 will force boosting.
  42330. *
  42331. * Note that the cropThreshold also affects this setting. When zooming in on
  42332. * a series that has fewer points than the `cropThreshold`, all points are
  42333. * rendered although outside the visible plot area, and the `boostThreshold`
  42334. * won't take effect.
  42335. */
  42336. boostThreshold?: number;
  42337. /**
  42338. * (Highcharts, Highstock, Gantt) When `true`, the columns will center in
  42339. * the category, ignoring null or missing points. When `false`, space will
  42340. * be reserved for null or missing points.
  42341. */
  42342. centerInCategory?: boolean;
  42343. /**
  42344. * (Highstock) An additional class name to apply to the series' graphical
  42345. * elements. This option does not replace default class names of the
  42346. * graphical element.
  42347. */
  42348. className?: string;
  42349. /**
  42350. * (Highstock) Disable this option to allow series rendering in the whole
  42351. * plotting area.
  42352. *
  42353. * **Note:** Clipping should be always enabled when chart.zoomType is set
  42354. */
  42355. clip?: boolean;
  42356. /**
  42357. * (Highstock) The main color of the series. In line type series it applies
  42358. * to the line and the point markers unless otherwise specified. In bar type
  42359. * series it applies to the bars unless a color is specified per point. The
  42360. * default value is pulled from the `options.colors` array.
  42361. *
  42362. * In styled mode, the color can be defined by the colorIndex option. Also,
  42363. * the series color can be set with the `.highcharts-series`,
  42364. * `.highcharts-color-{n}`, `.highcharts-{type}-series` or
  42365. * `.highcharts-series-{n}` class, or individual classes given by the
  42366. * `className` option.
  42367. */
  42368. color?: (ColorString|GradientColorObject|PatternObject);
  42369. /**
  42370. * (Highcharts, Highstock, Highmaps) When using dual or multiple color axes,
  42371. * this number defines which colorAxis the particular series is connected
  42372. * to. It refers to either the axis id or the index of the axis in the
  42373. * colorAxis array, with 0 being the first. Set this option to false to
  42374. * prevent a series from connecting to the default color axis.
  42375. *
  42376. * Since v7.2.0 the option can also be an axis id or an axis index instead
  42377. * of a boolean flag.
  42378. */
  42379. colorAxis?: (boolean|number|string);
  42380. /**
  42381. * (Highstock) Styled mode only. A specific color index to use for the
  42382. * series, so its graphic representations are given the class name
  42383. * `highcharts-color-{n}`.
  42384. */
  42385. colorIndex?: number;
  42386. /**
  42387. * (Highcharts, Highstock, Highmaps) Determines what data value should be
  42388. * used to calculate point color if `colorAxis` is used. Requires to set
  42389. * `min` and `max` if some custom point property is used or if approximation
  42390. * for data grouping is set to `'sum'`.
  42391. */
  42392. colorKey?: string;
  42393. /**
  42394. * (Highcharts, Highstock, Gantt) A series specific or series type specific
  42395. * color set to apply instead of the global colors when colorByPoint is
  42396. * true.
  42397. */
  42398. colors?: Array<(ColorString|GradientColorObject|PatternObject)>;
  42399. /**
  42400. * (Highstock) Compare the values of the series against the first non-null,
  42401. * non- zero value in the visible range. The y axis will show percentage or
  42402. * absolute change depending on whether `compare` is set to `"percent"` or
  42403. * `"value"`. When this is applied to multiple series, it allows comparing
  42404. * the development of the series against each other. Adds a `change` field
  42405. * to every point object.
  42406. */
  42407. compare?: string;
  42408. /**
  42409. * (Highstock) When compare is `percent`, this option dictates whether to
  42410. * use 0 or 100 as the base of comparison.
  42411. */
  42412. compareBase?: (0|100);
  42413. /**
  42414. * (Highstock) Defines if comparison should start from the first point
  42415. * within the visible range or should start from the first point **before**
  42416. * the range.
  42417. *
  42418. * In other words, this flag determines if first point within the visible
  42419. * range will have 0% (`compareStart=true`) or should have been already
  42420. * calculated according to the previous point (`compareStart=false`).
  42421. */
  42422. compareStart?: boolean;
  42423. /**
  42424. * (Gantt) Override Pathfinder connector options for a series. Requires
  42425. * Highcharts Gantt to be loaded.
  42426. */
  42427. connectors?: SeriesConnectorsOptionsObject;
  42428. /**
  42429. * (Highcharts, Highstock, Gantt) When true, each point or column edge is
  42430. * rounded to its nearest pixel in order to render sharp on screen. In some
  42431. * cases, when there are a lot of densely packed columns, this leads to
  42432. * visible difference in column widths or distance between columns. In these
  42433. * cases, setting `crisp` to `false` may look better, even though each
  42434. * column is rendered blurry.
  42435. */
  42436. crisp?: boolean;
  42437. /**
  42438. * (Highcharts, Highstock, Gantt) When the series contains less points than
  42439. * the crop threshold, all points are drawn, event if the points fall
  42440. * outside the visible plot area at the current zoom. The advantage of
  42441. * drawing all points (including markers and columns), is that animation is
  42442. * performed on updates. On the other hand, when the series contains more
  42443. * points than the crop threshold, the series data is cropped to only
  42444. * contain points that fall within the plot area. The advantage of cropping
  42445. * away invisible points is to increase performance on large series.
  42446. */
  42447. cropThreshold?: number;
  42448. /**
  42449. * (Highstock) You can set the cursor to "pointer" if you have click events
  42450. * attached to the series, to signal to the user that the points and lines
  42451. * can be clicked.
  42452. *
  42453. * In styled mode, the series cursor can be set with the same classes as
  42454. * listed under series.color.
  42455. */
  42456. cursor?: (string|CursorValue);
  42457. /**
  42458. * (Highstock) A reserved subspace to store options and values for
  42459. * customized functionality. Here you can add additional data for your own
  42460. * event callbacks and formatter callbacks.
  42461. */
  42462. custom?: Dictionary<any>;
  42463. /**
  42464. * (Highstock) Name of the dash style to use for the graph, or for some
  42465. * series types the outline of each shape.
  42466. *
  42467. * In styled mode, the stroke dash-array can be set with the same classes as
  42468. * listed under series.color.
  42469. */
  42470. dashStyle?: DashStyleValue;
  42471. /**
  42472. * (Highcharts, Highstock, Highmaps, Gantt) Options for the series data
  42473. * labels, appearing next to each data point.
  42474. *
  42475. * Since v6.2.0, multiple data labels can be applied to each single point by
  42476. * defining them as an array of configs.
  42477. *
  42478. * In styled mode, the data labels can be styled with the
  42479. * `.highcharts-data-label-box` and `.highcharts-data-label` class names
  42480. * (see example).
  42481. */
  42482. dataLabels?: (PlotFlagsDataLabelsOptions|Array<PlotFlagsDataLabelsOptions>);
  42483. /**
  42484. * (Highcharts, Highstock) Options for the series data sorting.
  42485. */
  42486. dataSorting?: (DataSortingOptionsObject|PlotFlagsDataSortingOptions);
  42487. /**
  42488. * (Highcharts) Depth of the columns in a 3D column chart.
  42489. */
  42490. depth?: number;
  42491. /**
  42492. * (Highstock) A description of the series to add to the screen reader
  42493. * information about the series.
  42494. */
  42495. description?: string;
  42496. /**
  42497. * (Highstock) The draggable-points module allows points to be moved around
  42498. * or modified in the chart. In addition to the options mentioned under the
  42499. * `dragDrop` API structure, the module fires three events, point.dragStart,
  42500. * point.drag and point.drop.
  42501. */
  42502. dragDrop?: SeriesDragDropOptionsObject;
  42503. /**
  42504. * (Highcharts) 3D columns only. The color of the edges. Similar to
  42505. * `borderColor`, except it defaults to the same color as the column.
  42506. */
  42507. edgeColor?: ColorString;
  42508. /**
  42509. * (Highcharts) 3D columns only. The width of the colored edges.
  42510. */
  42511. edgeWidth?: number;
  42512. /**
  42513. * (Highstock) Enable or disable the mouse tracking for a specific series.
  42514. * This includes point tooltips and click events on graphs and points. For
  42515. * large datasets it improves performance.
  42516. */
  42517. enableMouseTracking?: boolean;
  42518. /**
  42519. * (Highstock) General event handlers for the series items. These event
  42520. * hooks can also be attached to the series at run time using the
  42521. * `Highcharts.addEvent` function.
  42522. */
  42523. events?: SeriesEventsOptionsObject;
  42524. /**
  42525. * (Highstock) The fill color for the flags.
  42526. */
  42527. fillColor?: (ColorString|GradientColorObject|PatternObject);
  42528. /**
  42529. * (Highstock) Determines whether the series should look for the nearest
  42530. * point in both dimensions or just the x-dimension when hovering the
  42531. * series. Defaults to `'xy'` for scatter series and `'x'` for most other
  42532. * series. If the data has duplicate x-values, it is recommended to set this
  42533. * to `'xy'` to allow hovering over all points.
  42534. *
  42535. * Applies only to series types using nearest neighbor search (not direct
  42536. * hover) for tooltip.
  42537. */
  42538. findNearestPointBy?: OptionsFindNearestPointByValue;
  42539. /**
  42540. * (Highcharts, Highstock, Gantt) Whether to use the Y extremes of the total
  42541. * chart width or only the zoomed area when zooming in on parts of the X
  42542. * axis. By default, the Y axis adjusts to the min and max of the visible
  42543. * data. Cartesian series only.
  42544. */
  42545. getExtremesFromAll?: boolean;
  42546. /**
  42547. * (Highcharts, Highstock, Gantt) Whether to group non-stacked columns or to
  42548. * let them render independent of each other. Non-grouped columns will be
  42549. * laid out individually and overlap each other.
  42550. */
  42551. grouping?: boolean;
  42552. /**
  42553. * (Highcharts, Highstock, Gantt) Padding between each value groups, in x
  42554. * axis units.
  42555. */
  42556. groupPadding?: number;
  42557. /**
  42558. * (Highcharts) The spacing between columns on the Z Axis in a 3D chart.
  42559. */
  42560. groupZPadding?: number;
  42561. /**
  42562. * (Highstock) Fixed height of the flag's shape. By default, height is
  42563. * autocalculated according to the flag's title.
  42564. */
  42565. height?: number;
  42566. /**
  42567. * (Highstock) When set to `false` will prevent the series data from being
  42568. * included in any form of data export.
  42569. *
  42570. * Since version 6.0.0 until 7.1.0 the option was existing undocumented as
  42571. * `includeInCSVExport`.
  42572. */
  42573. includeInDataExport?: boolean;
  42574. /**
  42575. * (Highmaps) What property to join the `mapData` to the value data. For
  42576. * example, if joinBy is "code", the mapData items with a specific code is
  42577. * merged into the data with the same code. For maps loaded from GeoJSON,
  42578. * the keys may be held in each point's `properties` object.
  42579. *
  42580. * The joinBy option can also be an array of two values, where the first
  42581. * points to a key in the `mapData`, and the second points to another key in
  42582. * the `data`.
  42583. *
  42584. * When joinBy is `null`, the map items are joined by their position in the
  42585. * array, which performs much better in maps with many data points. This is
  42586. * the recommended option if you are printing more than a thousand data
  42587. * points and have a backend that can preprocess the data into a parallel
  42588. * array of the mapData.
  42589. */
  42590. joinBy?: (string|Array<string>);
  42591. /**
  42592. * (Highstock) An array specifying which option maps to which key in the
  42593. * data point array. This makes it convenient to work with unstructured data
  42594. * arrays from different sources.
  42595. */
  42596. keys?: Array<string>;
  42597. /**
  42598. * (Highcharts, Highstock, Gantt) Series labels are placed as close to the
  42599. * series as possible in a natural way, seeking to avoid other series. The
  42600. * goal of this feature is to make the chart more easily readable, like if a
  42601. * human designer placed the labels in the optimal position.
  42602. *
  42603. * The series labels currently work with series types having a `graph` or an
  42604. * `area`.
  42605. */
  42606. label?: SeriesLabelOptionsObject;
  42607. /**
  42608. * (Highstock) The line marks the last price from all points.
  42609. */
  42610. lastPrice?: SeriesLastPriceOptionsObject;
  42611. /**
  42612. * (Highstock) The line marks the last price from visible range of points.
  42613. */
  42614. lastVisiblePrice?: SeriesLastVisiblePriceOptionsObject;
  42615. /**
  42616. * (Highstock) The color of the line/border of the flag.
  42617. *
  42618. * In styled mode, the stroke is set in the
  42619. * `.highcharts-flag-series.highcharts-point` rule.
  42620. */
  42621. lineColor?: (ColorString|GradientColorObject|PatternObject);
  42622. /**
  42623. * (Highstock) The pixel width of the flag's line/border.
  42624. */
  42625. lineWidth?: number;
  42626. /**
  42627. * (Highcharts, Highstock, Gantt) The id of another series to link to.
  42628. * Additionally, the value can be ":previous" to link to the previous
  42629. * series. When two series are linked, only the first one appears in the
  42630. * legend. Toggling the visibility of this also toggles the linked series.
  42631. *
  42632. * If master series uses data sorting and linked series does not have its
  42633. * own sorting definition, the linked series will be sorted in the same
  42634. * order as the master one.
  42635. */
  42636. linkedTo?: string;
  42637. /**
  42638. * (Highcharts, Highstock, Gantt) The maximum allowed pixel width for a
  42639. * column, translated to the height of a bar in a bar chart. This prevents
  42640. * the columns from becoming too wide when there is a small number of points
  42641. * in the chart.
  42642. */
  42643. maxPointWidth?: number;
  42644. /**
  42645. * (Highcharts, Highstock, Gantt) The minimal height for a column or width
  42646. * for a bar. By default, 0 values are not shown. To visualize a 0 (or close
  42647. * to zero) point, set the minimal point length to a pixel value like 3\. In
  42648. * stacked column charts, minPointLength might not be respected for tightly
  42649. * packed values.
  42650. */
  42651. minPointLength?: number;
  42652. /**
  42653. * (Highstock) Options for the corresponding navigator series if
  42654. * `showInNavigator` is `true` for this series. Available options are the
  42655. * same as any series, documented at plotOptions and series.
  42656. *
  42657. * These options are merged with options in navigator.series, and will take
  42658. * precedence if the same option is defined both places.
  42659. */
  42660. navigatorOptions?: PlotSeriesOptions;
  42661. /**
  42662. * (Highstock) The color for the parts of the graph or points that are below
  42663. * the threshold. Note that `zones` takes precedence over the negative
  42664. * color. Using `negativeColor` is equivalent to applying a zone with value
  42665. * of 0.
  42666. */
  42667. negativeColor?: (ColorString|GradientColorObject|PatternObject);
  42668. /**
  42669. * (Highstock) In case the flag is placed on a series, on what point key to
  42670. * place it. Line and columns have one key, `y`. In range or OHLC-type
  42671. * series, however, the flag can optionally be placed on the `open`, `high`,
  42672. * `low` or `close` key.
  42673. */
  42674. onKey?: OptionsOnKeyValue;
  42675. /**
  42676. * (Highstock) The id of the series that the flags should be drawn on. If no
  42677. * id is given, the flags are drawn on the x axis.
  42678. */
  42679. onSeries?: string;
  42680. /**
  42681. * (Highstock) Opacity of a series parts: line, fill (e.g. area) and
  42682. * dataLabels.
  42683. */
  42684. opacity?: number;
  42685. /**
  42686. * (Highstock) Properties for each single point.
  42687. */
  42688. point?: PlotSeriesPointOptions;
  42689. /**
  42690. * (Highstock) Same as accessibility.pointDescriptionFormatter, but for an
  42691. * individual series. Overrides the chart wide configuration.
  42692. */
  42693. pointDescriptionFormatter?: Function;
  42694. /**
  42695. * (Highcharts, Highstock, Gantt) If no x values are given for the points in
  42696. * a series, `pointInterval` defines the interval of the x values. For
  42697. * example, if a series contains one value every decade starting from year
  42698. * 0, set `pointInterval` to `10`. In true `datetime` axes, the
  42699. * `pointInterval` is set in milliseconds.
  42700. *
  42701. * It can be also be combined with `pointIntervalUnit` to draw irregular
  42702. * time intervals.
  42703. *
  42704. * Please note that this options applies to the _series data_, not the
  42705. * interval of the axis ticks, which is independent.
  42706. */
  42707. pointInterval?: number;
  42708. /**
  42709. * (Highcharts, Highstock, Gantt) On datetime series, this allows for
  42710. * setting the pointInterval to irregular time units, `day`, `month` and
  42711. * `year`. A day is usually the same as 24 hours, but `pointIntervalUnit`
  42712. * also takes the DST crossover into consideration when dealing with local
  42713. * time. Combine this option with `pointInterval` to draw weeks, quarters, 6
  42714. * months, 10 years etc.
  42715. *
  42716. * Please note that this options applies to the _series data_, not the
  42717. * interval of the axis ticks, which is independent.
  42718. */
  42719. pointIntervalUnit?: OptionsPointIntervalUnitValue;
  42720. /**
  42721. * (Highcharts, Highstock, Gantt) Possible values: `"on"`, `"between"`,
  42722. * `number`.
  42723. *
  42724. * In a column chart, when pointPlacement is `"on"`, the point will not
  42725. * create any padding of the X axis. In a polar column chart this means that
  42726. * the first column points directly north. If the pointPlacement is
  42727. * `"between"`, the columns will be laid out between ticks. This is useful
  42728. * for example for visualising an amount between two points in time or in a
  42729. * certain sector of a polar chart.
  42730. *
  42731. * Since Highcharts 3.0.2, the point placement can also be numeric, where 0
  42732. * is on the axis value, -0.5 is between this value and the previous, and
  42733. * 0.5 is between this value and the next. Unlike the textual options,
  42734. * numeric point placement options won't affect axis padding.
  42735. *
  42736. * Note that pointPlacement needs a pointRange to work. For column series
  42737. * this is computed, but for line-type series it needs to be set.
  42738. *
  42739. * For the `xrange` series type and gantt charts, if the Y axis is a
  42740. * category axis, the `pointPlacement` applies to the Y axis rather than the
  42741. * (typically datetime) X axis.
  42742. *
  42743. * Defaults to `undefined` in cartesian charts, `"between"` in polar charts.
  42744. */
  42745. pointPlacement?: (number|string);
  42746. /**
  42747. * (Highcharts, Highstock, Gantt) The X axis range that each point is valid
  42748. * for. This determines the width of the column. On a categorized axis, the
  42749. * range will be 1 by default (one category unit). On linear and datetime
  42750. * axes, the range will be computed as the distance between the two closest
  42751. * data points.
  42752. *
  42753. * The default `null` means it is computed automatically, but this option
  42754. * can be used to override the automatic value.
  42755. *
  42756. * This option is set by default to 1 if data sorting is enabled.
  42757. */
  42758. pointRange?: (number|null);
  42759. /**
  42760. * (Highcharts, Highstock, Gantt) If no x values are given for the points in
  42761. * a series, pointStart defines on what value to start. For example, if a
  42762. * series contains one yearly value starting from 1945, set pointStart to
  42763. * 1945.
  42764. */
  42765. pointStart?: number;
  42766. /**
  42767. * (Highstock) Whether to select the series initially. If `showCheckbox` is
  42768. * true, the checkbox next to the series name in the legend will be checked
  42769. * for a selected series.
  42770. */
  42771. selected?: boolean;
  42772. /**
  42773. * (Highstock) Whether to apply a drop shadow to the graph line. Since 2.3
  42774. * the shadow can be an object configuration containing `color`, `offsetX`,
  42775. * `offsetY`, `opacity` and `width`.
  42776. */
  42777. shadow?: (boolean|ShadowOptionsObject);
  42778. /**
  42779. * (Highstock) The shape of the marker. Can be one of "flag", "circlepin",
  42780. * "squarepin", or an image of the format `url(/path-to-image.jpg)`.
  42781. * Individual shapes can also be set for each point.
  42782. */
  42783. shape?: FlagsShapeValue;
  42784. /**
  42785. * (Highstock) If true, a checkbox is displayed next to the legend item to
  42786. * allow selecting the series. The state of the checkbox is determined by
  42787. * the `selected` option.
  42788. */
  42789. showCheckbox?: boolean;
  42790. /**
  42791. * (Highstock) Whether to display this particular series or series type in
  42792. * the legend. Standalone series are shown in legend by default, and linked
  42793. * series are not. Since v7.2.0 it is possible to show series that use
  42794. * colorAxis by setting this option to `true`.
  42795. */
  42796. showInLegend?: boolean;
  42797. /**
  42798. * (Highstock) Whether or not to show the series in the navigator. Takes
  42799. * precedence over navigator.baseSeries if defined.
  42800. */
  42801. showInNavigator?: boolean;
  42802. /**
  42803. * (Highstock) If set to `true`, the accessibility module will skip past the
  42804. * points in this series for keyboard navigation.
  42805. */
  42806. skipKeyboardNavigation?: boolean;
  42807. /**
  42808. * (Highcharts, Highstock) When this is true, the series will not cause the
  42809. * Y axis to cross the zero plane (or threshold option) unless the data
  42810. * actually crosses the plane.
  42811. *
  42812. * For example, if `softThreshold` is `false`, a series of 0, 1, 2, 3 will
  42813. * make the Y axis show negative values according to the `minPadding`
  42814. * option. If `softThreshold` is `true`, the Y axis starts at 0.
  42815. */
  42816. softThreshold?: boolean;
  42817. /**
  42818. * (Highstock) When multiple flags in the same series fall on the same
  42819. * value, this number determines the vertical offset between them.
  42820. */
  42821. stackDistance?: number;
  42822. /**
  42823. * (Highcharts, Highstock) Whether to stack the values of each series on top
  42824. * of each other. Possible values are `undefined` to disable, `"normal"` to
  42825. * stack by value or `"percent"`.
  42826. *
  42827. * When stacking is enabled, data must be sorted in ascending X order.
  42828. *
  42829. * Some stacking options are related to specific series types. In the
  42830. * streamgraph series type, the stacking option is set to `"stream"`. The
  42831. * second one is `"overlap"`, which only applies to waterfall series.
  42832. */
  42833. stacking?: OptionsStackingValue;
  42834. states?: SeriesStatesOptionsObject;
  42835. /**
  42836. * (Highstock) Sticky tracking of mouse events. When true, the `mouseOut`
  42837. * event on a series isn't triggered until the mouse moves over another
  42838. * series, or out of the plot area. When false, the `mouseOut` event on a
  42839. * series is triggered when the mouse leaves the area around the series'
  42840. * graph or markers. This also implies the tooltip when not shared. When
  42841. * `stickyTracking` is false and `tooltip.shared` is false, the tooltip will
  42842. * be hidden when moving the mouse between series. Defaults to true for line
  42843. * and area type series, but to false for columns, pies etc.
  42844. *
  42845. * **Note:** The boost module will force this option because of technical
  42846. * limitations.
  42847. */
  42848. stickyTracking?: boolean;
  42849. /**
  42850. * (Highstock) The text styles of the flag.
  42851. *
  42852. * In styled mode, the styles are set in the `.highcharts-flag-series
  42853. * .highcharts-point` rule.
  42854. */
  42855. style?: CSSObject;
  42856. /**
  42857. * (Highstock) Text alignment for the text inside the flag.
  42858. */
  42859. textAlign?: OptionsTextAlignValue;
  42860. /**
  42861. * (Highcharts) The Y axis value to serve as the base for the columns, for
  42862. * distinguishing between values above and below a threshold. If `null`, the
  42863. * columns extend from the padding Y axis minimum.
  42864. */
  42865. threshold?: (number|null);
  42866. /**
  42867. * (Highstock) The text to display on each flag. This can be defined on
  42868. * series level, or individually for each point. Defaults to `"A"`.
  42869. */
  42870. title?: string;
  42871. /**
  42872. * (Highstock) Specific tooltip options for flag series. Flag series
  42873. * tooltips are different from most other types in that a flag doesn't have
  42874. * a data value, so the tooltip rather displays the `text` option for each
  42875. * point.
  42876. */
  42877. tooltip?: SeriesTooltipOptionsObject;
  42878. /**
  42879. * (Highstock) Whether to use HTML to render the flag texts. Using HTML
  42880. * allows for advanced formatting, images and reliable bi-directional text
  42881. * rendering. Note that exported images won't respect the HTML, and that
  42882. * HTML won't respect Z-index settings.
  42883. */
  42884. useHTML?: boolean;
  42885. /**
  42886. * (Highstock) Set the initial visibility of the series.
  42887. */
  42888. visible?: boolean;
  42889. /**
  42890. * (Highstock) Fixed width of the flag's shape. By default, width is
  42891. * autocalculated according to the flag's title.
  42892. */
  42893. width?: number;
  42894. /**
  42895. * (Highstock) The y position of the top left corner of the flag relative to
  42896. * either the series (if onSeries is defined), or the x axis. Defaults to
  42897. * `-30`.
  42898. */
  42899. y?: number;
  42900. /**
  42901. * (Highmaps) Define the z index of the series.
  42902. */
  42903. zIndex?: number;
  42904. /**
  42905. * (Highcharts, Highstock) Defines the Axis on which the zones are applied.
  42906. */
  42907. zoneAxis?: string;
  42908. /**
  42909. * (Highcharts, Highstock) An array defining zones within a series. Zones
  42910. * can be applied to the X axis, Y axis or Z axis for bubbles, according to
  42911. * the `zoneAxis` option. The zone definitions have to be in ascending order
  42912. * regarding to the value.
  42913. *
  42914. * In styled mode, the color zones are styled with the
  42915. * `.highcharts-zone-{n}` class, or custom classed from the `className`
  42916. * option (view live demo).
  42917. */
  42918. zones?: Array<SeriesZonesOptionsObject>;
  42919. }
  42920. /**
  42921. * (Highcharts) Enable or disable the initial animation when a series is
  42922. * displayed. The animation can also be set as a configuration object. Please
  42923. * note that this option only applies to the initial animation of the series
  42924. * itself. For other animations, see chart.animation and the animation parameter
  42925. * under the API methods. The following properties are supported:
  42926. *
  42927. * - `defer`: The animation delay time in milliseconds.
  42928. *
  42929. * - `duration`: The duration of the animation in milliseconds.
  42930. *
  42931. * - `easing`: Can be a string reference to an easing function set on the `Math`
  42932. * object or a function. See the _Custom easing function_ demo below.
  42933. *
  42934. * Due to poor performance, animation is disabled in old IE browsers for several
  42935. * chart types.
  42936. */
  42937. export interface PlotFunnel3dAnimationOptions {
  42938. defer?: number;
  42939. }
  42940. /**
  42941. * (Highcharts, Highstock, Highmaps, Gantt) Enable or disable the initial
  42942. * animation when a series is displayed for the `dataLabels`. The animation can
  42943. * also be set as a configuration object. Please note that this option only
  42944. * applies to the initial animation. For other animations, see chart.animation
  42945. * and the animation parameter under the API methods. The following properties
  42946. * are supported:
  42947. *
  42948. * - `defer`: The animation delay time in milliseconds.
  42949. */
  42950. export interface PlotFunnel3dDataLabelsAnimationOptions {
  42951. /**
  42952. * (Highcharts, Highstock, Highmaps, Gantt) The animation delay time in
  42953. * milliseconds. Set to `0` renders dataLabel immediately. As `undefined`
  42954. * inherits defer time from the series.animation.defer.
  42955. */
  42956. defer?: number;
  42957. }
  42958. /**
  42959. * (Highcharts, Highstock, Highmaps, Gantt) Options for the series data labels,
  42960. * appearing next to each data point.
  42961. *
  42962. * Since v6.2.0, multiple data labels can be applied to each single point by
  42963. * defining them as an array of configs.
  42964. *
  42965. * In styled mode, the data labels can be styled with the
  42966. * `.highcharts-data-label-box` and `.highcharts-data-label` class names (see
  42967. * example).
  42968. */
  42969. export interface PlotFunnel3dDataLabelsOptions {
  42970. /**
  42971. * (Highcharts, Highstock, Highmaps, Gantt) The alignment of the data label
  42972. * compared to the point. If `right`, the right side of the label should be
  42973. * touching the point. For points with an extent, like columns, the
  42974. * alignments also dictates how to align it inside the box, as given with
  42975. * the inside option. Can be one of `left`, `center` or `right`.
  42976. */
  42977. align?: string;
  42978. /**
  42979. * (Highcharts, Highstock, Highmaps, Gantt) Whether to allow data labels to
  42980. * overlap. To make the labels less sensitive for overlapping, the
  42981. * dataLabels.padding can be set to 0.
  42982. */
  42983. allowOverlap?: boolean;
  42984. /**
  42985. * (Highcharts, Highstock, Highmaps, Gantt) Enable or disable the initial
  42986. * animation when a series is displayed for the `dataLabels`. The animation
  42987. * can also be set as a configuration object. Please note that this option
  42988. * only applies to the initial animation. For other animations, see
  42989. * chart.animation and the animation parameter under the API methods. The
  42990. * following properties are supported:
  42991. *
  42992. * - `defer`: The animation delay time in milliseconds.
  42993. */
  42994. animation?: (boolean|PlotFunnel3dDataLabelsAnimationOptions|Partial<AnimationOptionsObject>);
  42995. /**
  42996. * (Highcharts, Highstock, Highmaps, Gantt) The background color or gradient
  42997. * for the data label.
  42998. */
  42999. backgroundColor?: (ColorString|GradientColorObject|PatternObject);
  43000. /**
  43001. * (Highcharts, Highstock, Highmaps, Gantt) The border color for the data
  43002. * label. Defaults to `undefined`.
  43003. */
  43004. borderColor?: (ColorString|GradientColorObject|PatternObject);
  43005. /**
  43006. * (Highcharts, Highstock, Highmaps, Gantt) The border radius in pixels for
  43007. * the data label.
  43008. */
  43009. borderRadius?: number;
  43010. /**
  43011. * (Highcharts, Highstock, Highmaps, Gantt) The border width in pixels for
  43012. * the data label.
  43013. */
  43014. borderWidth?: number;
  43015. /**
  43016. * (Highcharts, Highstock, Highmaps, Gantt) A class name for the data label.
  43017. * Particularly in styled mode, this can be used to give each series' or
  43018. * point's data label unique styling. In addition to this option, a default
  43019. * color class name is added so that we can give the labels a contrast text
  43020. * shadow.
  43021. */
  43022. className?: string;
  43023. /**
  43024. * (Highcharts, Highstock, Highmaps, Gantt) The text color for the data
  43025. * labels. Defaults to `undefined`. For certain series types, like column or
  43026. * map, the data labels can be drawn inside the points. In this case the
  43027. * data label will be drawn with maximum contrast by default. Additionally,
  43028. * it will be given a `text-outline` style with the opposite color, to
  43029. * further increase the contrast. This can be overridden by setting the
  43030. * `text-outline` style to `none` in the `dataLabels.style` option.
  43031. */
  43032. color?: (ColorString|GradientColorObject|PatternObject);
  43033. /**
  43034. * (Highcharts, Highstock, Highmaps, Gantt) Whether to hide data labels that
  43035. * are outside the plot area. By default, the data label is moved inside the
  43036. * plot area according to the overflow option.
  43037. */
  43038. crop?: boolean;
  43039. /**
  43040. * (Highcharts, Highstock, Gantt) Whether to defer displaying the data
  43041. * labels until the initial series animation has finished. Setting to
  43042. * `false` renders the data label immediately. If set to `true` inherits the
  43043. * defer time set in plotOptions.series.animation.
  43044. */
  43045. defer?: boolean;
  43046. /**
  43047. * (Highcharts, Highstock, Highmaps, Gantt) Enable or disable the data
  43048. * labels.
  43049. */
  43050. enabled?: boolean;
  43051. /**
  43052. * (Highcharts, Highstock, Highmaps, Gantt) A declarative filter to control
  43053. * of which data labels to display. The declarative filter is designed for
  43054. * use when callback functions are not available, like when the chart
  43055. * options require a pure JSON structure or for use with graphical editors.
  43056. * For programmatic control, use the `formatter` instead, and return
  43057. * `undefined` to disable a single data label.
  43058. */
  43059. filter?: DataLabelsFilterOptionsObject;
  43060. /**
  43061. * (Highcharts, Highstock, Highmaps, Gantt) A format string for the data
  43062. * label. Available variables are the same as for `formatter`.
  43063. */
  43064. format?: string;
  43065. /**
  43066. * (Highcharts, Highstock, Highmaps, Gantt) Callback JavaScript function to
  43067. * format the data label. Note that if a `format` is defined, the format
  43068. * takes precedence and the formatter is ignored.
  43069. */
  43070. formatter?: DataLabelsFormatterCallbackFunction;
  43071. /**
  43072. * (Highcharts, Highstock, Highmaps, Gantt) For points with an extent, like
  43073. * columns or map areas, whether to align the data label inside the box or
  43074. * to the actual value point. Defaults to `false` in most cases, `true` in
  43075. * stacked columns.
  43076. */
  43077. inside?: boolean;
  43078. /**
  43079. * (Highcharts, Highstock, Highmaps, Gantt) Format for points with the value
  43080. * of null. Works analogously to format. `nullFormat` can be applied only to
  43081. * series which support displaying null points.
  43082. */
  43083. nullFormat?: (boolean|string);
  43084. /**
  43085. * (Highcharts, Highstock, Highmaps, Gantt) Callback JavaScript function
  43086. * that defines formatting for points with the value of null. Works
  43087. * analogously to formatter. `nullPointFormatter` can be applied only to
  43088. * series which support displaying null points.
  43089. */
  43090. nullFormatter?: DataLabelsFormatterCallbackFunction;
  43091. /**
  43092. * (Highcharts, Highstock, Highmaps, Gantt) How to handle data labels that
  43093. * flow outside the plot area. The default is `"justify"`, which aligns them
  43094. * inside the plot area. For columns and bars, this means it will be moved
  43095. * inside the bar. To display data labels outside the plot area, set `crop`
  43096. * to `false` and `overflow` to `"allow"`.
  43097. */
  43098. overflow?: string;
  43099. /**
  43100. * (Highcharts, Highstock, Highmaps, Gantt) When either the `borderWidth` or
  43101. * the `backgroundColor` is set, this is the padding within the box.
  43102. */
  43103. padding?: number;
  43104. /**
  43105. * (Highcharts, Highstock, Highmaps, Gantt) Aligns data labels relative to
  43106. * points. If `center` alignment is not possible, it defaults to `right`.
  43107. */
  43108. position?: AlignValue;
  43109. /**
  43110. * (Highcharts, Highstock, Highmaps, Gantt) Text rotation in degrees. Note
  43111. * that due to a more complex structure, backgrounds, borders and padding
  43112. * will be lost on a rotated data label.
  43113. */
  43114. rotation?: number;
  43115. /**
  43116. * (Highcharts, Highstock, Highmaps, Gantt) The shadow of the box. Works
  43117. * best with `borderWidth` or `backgroundColor`. Since 2.3 the shadow can be
  43118. * an object configuration containing `color`, `offsetX`, `offsetY`,
  43119. * `opacity` and `width`.
  43120. */
  43121. shadow?: (boolean|ShadowOptionsObject);
  43122. /**
  43123. * (Highcharts, Highstock, Highmaps, Gantt) The name of a symbol to use for
  43124. * the border around the label. Symbols are predefined functions on the
  43125. * Renderer object.
  43126. */
  43127. shape?: string;
  43128. /**
  43129. * (Highcharts, Highstock, Highmaps, Gantt) Styles for the label. The
  43130. * default `color` setting is `"contrast"`, which is a pseudo color that
  43131. * Highcharts picks up and applies the maximum contrast to the underlying
  43132. * point item, for example the bar in a bar chart.
  43133. *
  43134. * The `textOutline` is a pseudo property that applies an outline of the
  43135. * given width with the given color, which by default is the maximum
  43136. * contrast to the text. So a bright text color will result in a black text
  43137. * outline for maximum readability on a mixed background. In some cases,
  43138. * especially with grayscale text, the text outline doesn't work well, in
  43139. * which cases it can be disabled by setting it to `"none"`. When `useHTML`
  43140. * is true, the `textOutline` will not be picked up. In this, case, the same
  43141. * effect can be acheived through the `text-shadow` CSS property.
  43142. *
  43143. * For some series types, where each point has an extent, like for example
  43144. * tree maps, the data label may overflow the point. There are two
  43145. * strategies for handling overflow. By default, the text will wrap to
  43146. * multiple lines. The other strategy is to set `style.textOverflow` to
  43147. * `ellipsis`, which will keep the text on one line plus it will break
  43148. * inside long words.
  43149. */
  43150. style?: CSSObject;
  43151. /**
  43152. * (Highcharts, Highstock, Highmaps, Gantt) Options for a label text which
  43153. * should follow marker's shape. Border and background are disabled for a
  43154. * label that follows a path.
  43155. *
  43156. * **Note:** Only SVG-based renderer supports this option. Setting `useHTML`
  43157. * to true will disable this option.
  43158. */
  43159. textPath?: DataLabelsTextPathOptionsObject;
  43160. /**
  43161. * (Highcharts, Highstock, Highmaps, Gantt) Whether to use HTML to render
  43162. * the labels.
  43163. */
  43164. useHTML?: boolean;
  43165. /**
  43166. * (Highcharts, Highstock, Highmaps, Gantt) The vertical alignment of a data
  43167. * label. Can be one of `top`, `middle` or `bottom`. The default value
  43168. * depends on the data, for instance in a column chart, the label is above
  43169. * positive values and below negative values.
  43170. */
  43171. verticalAlign?: string;
  43172. /**
  43173. * (Highcharts, Highstock, Highmaps, Gantt) The x position offset of the
  43174. * label relative to the point in pixels.
  43175. */
  43176. x?: number;
  43177. /**
  43178. * (Highcharts, Highstock, Highmaps, Gantt) The y position offset of the
  43179. * label relative to the point in pixels.
  43180. */
  43181. y?: number;
  43182. /**
  43183. * (Highcharts, Highstock, Highmaps, Gantt) The Z index of the data labels.
  43184. * The default Z index puts it above the series. Use a Z index of 2 to
  43185. * display it behind the series.
  43186. */
  43187. z?: number;
  43188. }
  43189. /**
  43190. * (Highcharts) Style options for the guide box. The guide box has one state by
  43191. * default, the `default` state.
  43192. */
  43193. export interface PlotFunnel3dDragDropGuideBoxOptions {
  43194. /**
  43195. * (Highcharts) Style options for the guide box default state.
  43196. */
  43197. default?: DragDropGuideBoxOptionsObject;
  43198. }
  43199. /**
  43200. * (Highcharts) A funnel3d is a 3d version of funnel series type. Funnel charts
  43201. * are a type of chart often used to visualize stages in a sales project, where
  43202. * the top are the initial stages with the most clients.
  43203. *
  43204. * It requires that the `highcharts-3d.js`, `cylinder.js` and `funnel3d.js`
  43205. * module are loaded.
  43206. *
  43207. * In TypeScript the type option must always be set.
  43208. *
  43209. * Configuration options for the series are given in three levels:
  43210. *
  43211. * 1. Options for all series in a chart are defined in the plotOptions.series
  43212. * object.
  43213. *
  43214. * 2. Options for all `funnel3d` series are defined in plotOptions.funnel3d.
  43215. *
  43216. * 3. Options for one single series are given in the series instance array. (see
  43217. * online documentation for example)
  43218. */
  43219. export interface PlotFunnel3dOptions {
  43220. /**
  43221. * (Highcharts) Accessibility options for a series.
  43222. */
  43223. accessibility?: SeriesAccessibilityOptionsObject;
  43224. /**
  43225. * (Highcharts) Allow this series' points to be selected by clicking on the
  43226. * graphic (columns, point markers, pie slices, map areas etc).
  43227. *
  43228. * The selected points can be handled by point select and unselect events,
  43229. * or collectively by the getSelectedPoints function.
  43230. *
  43231. * And alternative way of selecting points is through dragging.
  43232. */
  43233. allowPointSelect?: boolean;
  43234. /**
  43235. * (Highcharts) Enable or disable the initial animation when a series is
  43236. * displayed. The animation can also be set as a configuration object.
  43237. * Please note that this option only applies to the initial animation of the
  43238. * series itself. For other animations, see chart.animation and the
  43239. * animation parameter under the API methods. The following properties are
  43240. * supported:
  43241. *
  43242. * - `defer`: The animation delay time in milliseconds.
  43243. *
  43244. * - `duration`: The duration of the animation in milliseconds.
  43245. *
  43246. * - `easing`: Can be a string reference to an easing function set on the
  43247. * `Math` object or a function. See the _Custom easing function_ demo below.
  43248. *
  43249. * Due to poor performance, animation is disabled in old IE browsers for
  43250. * several chart types.
  43251. */
  43252. animation?: (boolean|PlotFunnel3dAnimationOptions);
  43253. /**
  43254. * (Highcharts) For some series, there is a limit that shuts down initial
  43255. * animation by default when the total number of points in the chart is too
  43256. * high. For example, for a column chart and its derivatives, animation does
  43257. * not run if there is more than 250 points totally. To disable this cap,
  43258. * set `animationLimit` to `Infinity`.
  43259. */
  43260. animationLimit?: number;
  43261. /**
  43262. * (Highcharts, Highstock, Gantt) The color of the border surrounding each
  43263. * column or bar.
  43264. *
  43265. * In styled mode, the border stroke can be set with the `.highcharts-point`
  43266. * rule.
  43267. */
  43268. borderColor?: (ColorString|GradientColorObject|PatternObject);
  43269. /**
  43270. * (Highcharts, Highstock, Gantt) The corner radius of the border
  43271. * surrounding each column or bar.
  43272. */
  43273. borderRadius?: number;
  43274. /**
  43275. * (Highcharts, Highstock, Gantt) The width of the border surrounding each
  43276. * column or bar. Defaults to `1` when there is room for a border, but to
  43277. * `0` when the columns are so dense that a border would cover the next
  43278. * column.
  43279. *
  43280. * In styled mode, the stroke width can be set with the `.highcharts-point`
  43281. * rule.
  43282. */
  43283. borderWidth?: number;
  43284. /**
  43285. * (Highcharts, Highstock, Gantt) When `true`, the columns will center in
  43286. * the category, ignoring null or missing points. When `false`, space will
  43287. * be reserved for null or missing points.
  43288. */
  43289. centerInCategory?: boolean;
  43290. /**
  43291. * (Highcharts) An additional class name to apply to the series' graphical
  43292. * elements. This option does not replace default class names of the
  43293. * graphical element.
  43294. */
  43295. className?: string;
  43296. /**
  43297. * (Highcharts) Disable this option to allow series rendering in the whole
  43298. * plotting area.
  43299. *
  43300. * **Note:** Clipping should be always enabled when chart.zoomType is set
  43301. */
  43302. clip?: boolean;
  43303. /**
  43304. * (Highcharts) The main color of the series. In line type series it applies
  43305. * to the line and the point markers unless otherwise specified. In bar type
  43306. * series it applies to the bars unless a color is specified per point. The
  43307. * default value is pulled from the `options.colors` array.
  43308. *
  43309. * In styled mode, the color can be defined by the colorIndex option. Also,
  43310. * the series color can be set with the `.highcharts-series`,
  43311. * `.highcharts-color-{n}`, `.highcharts-{type}-series` or
  43312. * `.highcharts-series-{n}` class, or individual classes given by the
  43313. * `className` option.
  43314. */
  43315. color?: (ColorString|GradientColorObject|PatternObject);
  43316. /**
  43317. * (Highcharts, Highstock, Gantt) When using automatic point colors pulled
  43318. * from the global colors or series-specific plotOptions.column.colors
  43319. * collections, this option determines whether the chart should receive one
  43320. * color per series or one color per point.
  43321. *
  43322. * In styled mode, the `colors` or `series.colors` arrays are not supported,
  43323. * and instead this option gives the points individual color class names on
  43324. * the form `highcharts-color-{n}`.
  43325. */
  43326. colorByPoint?: boolean;
  43327. /**
  43328. * (Highcharts) Styled mode only. A specific color index to use for the
  43329. * series, so its graphic representations are given the class name
  43330. * `highcharts-color-{n}`.
  43331. */
  43332. colorIndex?: number;
  43333. /**
  43334. * (Highcharts, Highstock, Highmaps) Determines what data value should be
  43335. * used to calculate point color if `colorAxis` is used. Requires to set
  43336. * `min` and `max` if some custom point property is used or if approximation
  43337. * for data grouping is set to `'sum'`.
  43338. */
  43339. colorKey?: string;
  43340. /**
  43341. * (Highcharts, Highstock, Gantt) A series specific or series type specific
  43342. * color set to apply instead of the global colors when colorByPoint is
  43343. * true.
  43344. */
  43345. colors?: Array<(ColorString|GradientColorObject|PatternObject)>;
  43346. /**
  43347. * (Highstock) Defines if comparison should start from the first point
  43348. * within the visible range or should start from the first point **before**
  43349. * the range.
  43350. *
  43351. * In other words, this flag determines if first point within the visible
  43352. * range will have 0% (`compareStart=true`) or should have been already
  43353. * calculated according to the previous point (`compareStart=false`).
  43354. */
  43355. compareStart?: boolean;
  43356. /**
  43357. * (Gantt) Override Pathfinder connector options for a series. Requires
  43358. * Highcharts Gantt to be loaded.
  43359. */
  43360. connectors?: SeriesConnectorsOptionsObject;
  43361. /**
  43362. * (Highcharts, Highstock, Gantt) When true, each point or column edge is
  43363. * rounded to its nearest pixel in order to render sharp on screen. In some
  43364. * cases, when there are a lot of densely packed columns, this leads to
  43365. * visible difference in column widths or distance between columns. In these
  43366. * cases, setting `crisp` to `false` may look better, even though each
  43367. * column is rendered blurry.
  43368. */
  43369. crisp?: boolean;
  43370. /**
  43371. * (Highcharts, Highstock, Gantt) When the series contains less points than
  43372. * the crop threshold, all points are drawn, event if the points fall
  43373. * outside the visible plot area at the current zoom. The advantage of
  43374. * drawing all points (including markers and columns), is that animation is
  43375. * performed on updates. On the other hand, when the series contains more
  43376. * points than the crop threshold, the series data is cropped to only
  43377. * contain points that fall within the plot area. The advantage of cropping
  43378. * away invisible points is to increase performance on large series.
  43379. */
  43380. cropThreshold?: number;
  43381. /**
  43382. * (Highcharts) You can set the cursor to "pointer" if you have click events
  43383. * attached to the series, to signal to the user that the points and lines
  43384. * can be clicked.
  43385. *
  43386. * In styled mode, the series cursor can be set with the same classes as
  43387. * listed under series.color.
  43388. */
  43389. cursor?: (string|CursorValue);
  43390. /**
  43391. * (Highcharts) A reserved subspace to store options and values for
  43392. * customized functionality. Here you can add additional data for your own
  43393. * event callbacks and formatter callbacks.
  43394. */
  43395. custom?: Dictionary<any>;
  43396. /**
  43397. * (Highcharts) Name of the dash style to use for the graph, or for some
  43398. * series types the outline of each shape.
  43399. *
  43400. * In styled mode, the stroke dash-array can be set with the same classes as
  43401. * listed under series.color.
  43402. */
  43403. dashStyle?: DashStyleValue;
  43404. /**
  43405. * (Highstock) Data grouping is the concept of sampling the data values into
  43406. * larger blocks in order to ease readability and increase performance of
  43407. * the JavaScript charts. Highstock by default applies data grouping when
  43408. * the points become closer than a certain pixel value, determined by the
  43409. * `groupPixelWidth` option.
  43410. *
  43411. * If data grouping is applied, the grouping information of grouped points
  43412. * can be read from the Point.dataGroup. If point options other than the
  43413. * data itself are set, for example `name` or `color` or custom properties,
  43414. * the grouping logic doesn't know how to group it. In this case the options
  43415. * of the first point instance are copied over to the group point. This can
  43416. * be altered through a custom `approximation` callback function.
  43417. */
  43418. dataGrouping?: DataGroupingOptionsObject;
  43419. /**
  43420. * (Highcharts, Highstock, Highmaps, Gantt) Options for the series data
  43421. * labels, appearing next to each data point.
  43422. *
  43423. * Since v6.2.0, multiple data labels can be applied to each single point by
  43424. * defining them as an array of configs.
  43425. *
  43426. * In styled mode, the data labels can be styled with the
  43427. * `.highcharts-data-label-box` and `.highcharts-data-label` class names
  43428. * (see example).
  43429. */
  43430. dataLabels?: (PlotFunnel3dDataLabelsOptions|Array<PlotFunnel3dDataLabelsOptions>);
  43431. /**
  43432. * (Highcharts) Depth of the columns in a 3D column chart.
  43433. */
  43434. depth?: number;
  43435. /**
  43436. * (Highcharts) A description of the series to add to the screen reader
  43437. * information about the series.
  43438. */
  43439. description?: string;
  43440. /**
  43441. * (Highcharts) The draggable-points module allows points to be moved around
  43442. * or modified in the chart. In addition to the options mentioned under the
  43443. * `dragDrop` API structure, the module fires three events, point.dragStart,
  43444. * point.drag and point.drop.
  43445. */
  43446. dragDrop?: SeriesDragDropOptionsObject;
  43447. /**
  43448. * (Highcharts) 3D columns only. The color of the edges. Similar to
  43449. * `borderColor`, except it defaults to the same color as the column.
  43450. */
  43451. edgeColor?: ColorString;
  43452. /**
  43453. * (Highcharts) 3D columns only. The width of the colored edges.
  43454. */
  43455. edgeWidth?: number;
  43456. /**
  43457. * (Highcharts) Enable or disable the mouse tracking for a specific series.
  43458. * This includes point tooltips and click events on graphs and points. For
  43459. * large datasets it improves performance.
  43460. */
  43461. enableMouseTracking?: boolean;
  43462. /**
  43463. * (Highcharts) General event handlers for the series items. These event
  43464. * hooks can also be attached to the series at run time using the
  43465. * `Highcharts.addEvent` function.
  43466. */
  43467. events?: SeriesEventsOptionsObject;
  43468. /**
  43469. * (Highcharts) Determines whether the series should look for the nearest
  43470. * point in both dimensions or just the x-dimension when hovering the
  43471. * series. Defaults to `'xy'` for scatter series and `'x'` for most other
  43472. * series. If the data has duplicate x-values, it is recommended to set this
  43473. * to `'xy'` to allow hovering over all points.
  43474. *
  43475. * Applies only to series types using nearest neighbor search (not direct
  43476. * hover) for tooltip.
  43477. */
  43478. findNearestPointBy?: OptionsFindNearestPointByValue;
  43479. /**
  43480. * (Highcharts, Highstock, Gantt) Whether to use the Y extremes of the total
  43481. * chart width or only the zoomed area when zooming in on parts of the X
  43482. * axis. By default, the Y axis adjusts to the min and max of the visible
  43483. * data. Cartesian series only.
  43484. */
  43485. getExtremesFromAll?: boolean;
  43486. /**
  43487. * (Highcharts) By deafult sides fill is set to a gradient through this
  43488. * option being set to `true`. Set to `false` to get solid color for the
  43489. * sides.
  43490. */
  43491. gradientForSides?: boolean;
  43492. /**
  43493. * (Highcharts, Highstock, Gantt) Whether to group non-stacked columns or to
  43494. * let them render independent of each other. Non-grouped columns will be
  43495. * laid out individually and overlap each other.
  43496. */
  43497. grouping?: boolean;
  43498. /**
  43499. * (Highcharts, Highstock, Gantt) Padding between each value groups, in x
  43500. * axis units.
  43501. */
  43502. groupPadding?: number;
  43503. /**
  43504. * (Highcharts) The spacing between columns on the Z Axis in a 3D chart.
  43505. */
  43506. groupZPadding?: number;
  43507. /**
  43508. * (Highcharts) The height of the series. If it is a number it defines the
  43509. * pixel height, if it is a percentage string it is the percentage of the
  43510. * plot area height.
  43511. */
  43512. height?: (number|string);
  43513. /**
  43514. * (Highcharts) When set to `false` will prevent the series data from being
  43515. * included in any form of data export.
  43516. *
  43517. * Since version 6.0.0 until 7.1.0 the option was existing undocumented as
  43518. * `includeInCSVExport`.
  43519. */
  43520. includeInDataExport?: boolean;
  43521. /**
  43522. * (Highmaps) What property to join the `mapData` to the value data. For
  43523. * example, if joinBy is "code", the mapData items with a specific code is
  43524. * merged into the data with the same code. For maps loaded from GeoJSON,
  43525. * the keys may be held in each point's `properties` object.
  43526. *
  43527. * The joinBy option can also be an array of two values, where the first
  43528. * points to a key in the `mapData`, and the second points to another key in
  43529. * the `data`.
  43530. *
  43531. * When joinBy is `null`, the map items are joined by their position in the
  43532. * array, which performs much better in maps with many data points. This is
  43533. * the recommended option if you are printing more than a thousand data
  43534. * points and have a backend that can preprocess the data into a parallel
  43535. * array of the mapData.
  43536. */
  43537. joinBy?: (string|Array<string>);
  43538. /**
  43539. * (Highcharts) An array specifying which option maps to which key in the
  43540. * data point array. This makes it convenient to work with unstructured data
  43541. * arrays from different sources.
  43542. */
  43543. keys?: Array<string>;
  43544. /**
  43545. * (Highcharts, Highstock, Gantt) Series labels are placed as close to the
  43546. * series as possible in a natural way, seeking to avoid other series. The
  43547. * goal of this feature is to make the chart more easily readable, like if a
  43548. * human designer placed the labels in the optimal position.
  43549. *
  43550. * The series labels currently work with series types having a `graph` or an
  43551. * `area`.
  43552. */
  43553. label?: SeriesLabelOptionsObject;
  43554. /**
  43555. * (Highstock) The line marks the last price from all points.
  43556. */
  43557. lastPrice?: SeriesLastPriceOptionsObject;
  43558. /**
  43559. * (Highstock) The line marks the last price from visible range of points.
  43560. */
  43561. lastVisiblePrice?: SeriesLastVisiblePriceOptionsObject;
  43562. /**
  43563. * (Highcharts, Highstock, Gantt) The id of another series to link to.
  43564. * Additionally, the value can be ":previous" to link to the previous
  43565. * series. When two series are linked, only the first one appears in the
  43566. * legend. Toggling the visibility of this also toggles the linked series.
  43567. *
  43568. * If master series uses data sorting and linked series does not have its
  43569. * own sorting definition, the linked series will be sorted in the same
  43570. * order as the master one.
  43571. */
  43572. linkedTo?: string;
  43573. /**
  43574. * (Highcharts, Highstock, Gantt) The maximum allowed pixel width for a
  43575. * column, translated to the height of a bar in a bar chart. This prevents
  43576. * the columns from becoming too wide when there is a small number of points
  43577. * in the chart.
  43578. */
  43579. maxPointWidth?: number;
  43580. /**
  43581. * (Highcharts, Highstock, Gantt) The minimal height for a column or width
  43582. * for a bar. By default, 0 values are not shown. To visualize a 0 (or close
  43583. * to zero) point, set the minimal point length to a pixel value like 3\. In
  43584. * stacked column charts, minPointLength might not be respected for tightly
  43585. * packed values.
  43586. */
  43587. minPointLength?: number;
  43588. /**
  43589. * (Highstock) Options for the corresponding navigator series if
  43590. * `showInNavigator` is `true` for this series. Available options are the
  43591. * same as any series, documented at plotOptions and series.
  43592. *
  43593. * These options are merged with options in navigator.series, and will take
  43594. * precedence if the same option is defined both places.
  43595. */
  43596. navigatorOptions?: PlotSeriesOptions;
  43597. /**
  43598. * (Highcharts) The height of the neck, the lower part of the funnel. A
  43599. * number defines pixel width, a percentage string defines a percentage of
  43600. * the plot area height.
  43601. */
  43602. neckHeight?: (number|string);
  43603. /**
  43604. * (Highcharts) The width of the neck, the lower part of the funnel. A
  43605. * number defines pixel width, a percentage string defines a percentage of
  43606. * the plot area width.
  43607. */
  43608. neckWidth?: (number|string);
  43609. /**
  43610. * (Highcharts) The color for the parts of the graph or points that are
  43611. * below the threshold. Note that `zones` takes precedence over the negative
  43612. * color. Using `negativeColor` is equivalent to applying a zone with value
  43613. * of 0.
  43614. */
  43615. negativeColor?: (ColorString|GradientColorObject|PatternObject);
  43616. /**
  43617. * (Highcharts) Opacity of a series parts: line, fill (e.g. area) and
  43618. * dataLabels.
  43619. */
  43620. opacity?: number;
  43621. /**
  43622. * (Highcharts) Properties for each single point.
  43623. */
  43624. point?: PlotSeriesPointOptions;
  43625. /**
  43626. * (Highcharts) Same as accessibility.pointDescriptionFormatter, but for an
  43627. * individual series. Overrides the chart wide configuration.
  43628. */
  43629. pointDescriptionFormatter?: Function;
  43630. /**
  43631. * (Highcharts, Highstock, Gantt) If no x values are given for the points in
  43632. * a series, `pointInterval` defines the interval of the x values. For
  43633. * example, if a series contains one value every decade starting from year
  43634. * 0, set `pointInterval` to `10`. In true `datetime` axes, the
  43635. * `pointInterval` is set in milliseconds.
  43636. *
  43637. * It can be also be combined with `pointIntervalUnit` to draw irregular
  43638. * time intervals.
  43639. *
  43640. * Please note that this options applies to the _series data_, not the
  43641. * interval of the axis ticks, which is independent.
  43642. */
  43643. pointInterval?: number;
  43644. /**
  43645. * (Highcharts, Highstock, Gantt) On datetime series, this allows for
  43646. * setting the pointInterval to irregular time units, `day`, `month` and
  43647. * `year`. A day is usually the same as 24 hours, but `pointIntervalUnit`
  43648. * also takes the DST crossover into consideration when dealing with local
  43649. * time. Combine this option with `pointInterval` to draw weeks, quarters, 6
  43650. * months, 10 years etc.
  43651. *
  43652. * Please note that this options applies to the _series data_, not the
  43653. * interval of the axis ticks, which is independent.
  43654. */
  43655. pointIntervalUnit?: OptionsPointIntervalUnitValue;
  43656. /**
  43657. * (Highcharts, Highstock, Gantt) Padding between each column or bar, in x
  43658. * axis units.
  43659. */
  43660. pointPadding?: number;
  43661. /**
  43662. * (Highcharts, Highstock, Gantt) Possible values: `"on"`, `"between"`,
  43663. * `number`.
  43664. *
  43665. * In a column chart, when pointPlacement is `"on"`, the point will not
  43666. * create any padding of the X axis. In a polar column chart this means that
  43667. * the first column points directly north. If the pointPlacement is
  43668. * `"between"`, the columns will be laid out between ticks. This is useful
  43669. * for example for visualising an amount between two points in time or in a
  43670. * certain sector of a polar chart.
  43671. *
  43672. * Since Highcharts 3.0.2, the point placement can also be numeric, where 0
  43673. * is on the axis value, -0.5 is between this value and the previous, and
  43674. * 0.5 is between this value and the next. Unlike the textual options,
  43675. * numeric point placement options won't affect axis padding.
  43676. *
  43677. * Note that pointPlacement needs a pointRange to work. For column series
  43678. * this is computed, but for line-type series it needs to be set.
  43679. *
  43680. * For the `xrange` series type and gantt charts, if the Y axis is a
  43681. * category axis, the `pointPlacement` applies to the Y axis rather than the
  43682. * (typically datetime) X axis.
  43683. *
  43684. * Defaults to `undefined` in cartesian charts, `"between"` in polar charts.
  43685. */
  43686. pointPlacement?: (number|string);
  43687. /**
  43688. * (Highcharts, Highstock, Gantt) The X axis range that each point is valid
  43689. * for. This determines the width of the column. On a categorized axis, the
  43690. * range will be 1 by default (one category unit). On linear and datetime
  43691. * axes, the range will be computed as the distance between the two closest
  43692. * data points.
  43693. *
  43694. * The default `null` means it is computed automatically, but this option
  43695. * can be used to override the automatic value.
  43696. *
  43697. * This option is set by default to 1 if data sorting is enabled.
  43698. */
  43699. pointRange?: (number|null);
  43700. /**
  43701. * (Highcharts, Highstock, Gantt) If no x values are given for the points in
  43702. * a series, pointStart defines on what value to start. For example, if a
  43703. * series contains one yearly value starting from 1945, set pointStart to
  43704. * 1945.
  43705. */
  43706. pointStart?: number;
  43707. /**
  43708. * (Highcharts, Highstock, Gantt) A pixel value specifying a fixed width for
  43709. * each column or bar point. When set to `undefined`, the width is
  43710. * calculated from the `pointPadding` and `groupPadding`. The width effects
  43711. * the dimension that is not based on the point value. For column series it
  43712. * is the hoizontal length and for bar series it is the vertical length.
  43713. */
  43714. pointWidth?: number;
  43715. /**
  43716. * (Highcharts) A reversed funnel has the widest area down. A reversed
  43717. * funnel with no neck width and neck height is a pyramid.
  43718. */
  43719. reversed?: boolean;
  43720. /**
  43721. * (Highcharts) Whether to select the series initially. If `showCheckbox` is
  43722. * true, the checkbox next to the series name in the legend will be checked
  43723. * for a selected series.
  43724. */
  43725. selected?: boolean;
  43726. /**
  43727. * (Highcharts) Whether to apply a drop shadow to the graph line. Since 2.3
  43728. * the shadow can be an object configuration containing `color`, `offsetX`,
  43729. * `offsetY`, `opacity` and `width`.
  43730. */
  43731. shadow?: (boolean|ShadowOptionsObject);
  43732. /**
  43733. * (Highcharts) If true, a checkbox is displayed next to the legend item to
  43734. * allow selecting the series. The state of the checkbox is determined by
  43735. * the `selected` option.
  43736. */
  43737. showCheckbox?: boolean;
  43738. /**
  43739. * (Highcharts) Whether to display this particular series or series type in
  43740. * the legend. Standalone series are shown in legend by default, and linked
  43741. * series are not. Since v7.2.0 it is possible to show series that use
  43742. * colorAxis by setting this option to `true`.
  43743. */
  43744. showInLegend?: boolean;
  43745. /**
  43746. * (Highstock) Whether or not to show the series in the navigator. Takes
  43747. * precedence over navigator.baseSeries if defined.
  43748. */
  43749. showInNavigator?: boolean;
  43750. /**
  43751. * (Highcharts) If set to `true`, the accessibility module will skip past
  43752. * the points in this series for keyboard navigation.
  43753. */
  43754. skipKeyboardNavigation?: boolean;
  43755. /**
  43756. * (Highcharts, Highstock) When this is true, the series will not cause the
  43757. * Y axis to cross the zero plane (or threshold option) unless the data
  43758. * actually crosses the plane.
  43759. *
  43760. * For example, if `softThreshold` is `false`, a series of 0, 1, 2, 3 will
  43761. * make the Y axis show negative values according to the `minPadding`
  43762. * option. If `softThreshold` is `true`, the Y axis starts at 0.
  43763. */
  43764. softThreshold?: boolean;
  43765. /**
  43766. * (Highcharts, Highstock) Whether to stack the values of each series on top
  43767. * of each other. Possible values are `undefined` to disable, `"normal"` to
  43768. * stack by value or `"percent"`.
  43769. *
  43770. * When stacking is enabled, data must be sorted in ascending X order.
  43771. *
  43772. * Some stacking options are related to specific series types. In the
  43773. * streamgraph series type, the stacking option is set to `"stream"`. The
  43774. * second one is `"overlap"`, which only applies to waterfall series.
  43775. */
  43776. stacking?: OptionsStackingValue;
  43777. states?: SeriesStatesOptionsObject;
  43778. /**
  43779. * (Highcharts) Sticky tracking of mouse events. When true, the `mouseOut`
  43780. * event on a series isn't triggered until the mouse moves over another
  43781. * series, or out of the plot area. When false, the `mouseOut` event on a
  43782. * series is triggered when the mouse leaves the area around the series'
  43783. * graph or markers. This also implies the tooltip when not shared. When
  43784. * `stickyTracking` is false and `tooltip.shared` is false, the tooltip will
  43785. * be hidden when moving the mouse between series. Defaults to true for line
  43786. * and area type series, but to false for columns, pies etc.
  43787. *
  43788. * **Note:** The boost module will force this option because of technical
  43789. * limitations.
  43790. */
  43791. stickyTracking?: boolean;
  43792. /**
  43793. * (Highcharts) The Y axis value to serve as the base for the columns, for
  43794. * distinguishing between values above and below a threshold. If `null`, the
  43795. * columns extend from the padding Y axis minimum.
  43796. */
  43797. threshold?: (number|null);
  43798. /**
  43799. * (Highcharts) A configuration object for the tooltip rendering of each
  43800. * single series. Properties are inherited from tooltip, but only the
  43801. * following properties can be defined on a series level.
  43802. */
  43803. tooltip?: SeriesTooltipOptionsObject;
  43804. /**
  43805. * (Highcharts, Highstock, Gantt) When a series contains a data array that
  43806. * is longer than this, only one dimensional arrays of numbers, or two
  43807. * dimensional arrays with x and y values are allowed. Also, only the first
  43808. * point is tested, and the rest are assumed to be the same format. This
  43809. * saves expensive data checking and indexing in long series. Set it to `0`
  43810. * disable.
  43811. *
  43812. * Note: In boost mode turbo threshold is forced. Only array of numbers or
  43813. * two dimensional arrays are allowed.
  43814. */
  43815. turboThreshold?: number;
  43816. /**
  43817. * (Highcharts) Set the initial visibility of the series.
  43818. */
  43819. visible?: boolean;
  43820. /**
  43821. * (Highcharts) The max width of the series compared to the width of the
  43822. * plot area, or the pixel width if it is a number.
  43823. */
  43824. width?: (number|string);
  43825. /**
  43826. * (Highmaps) Define the z index of the series.
  43827. */
  43828. zIndex?: number;
  43829. /**
  43830. * (Highcharts, Highstock) Defines the Axis on which the zones are applied.
  43831. */
  43832. zoneAxis?: string;
  43833. /**
  43834. * (Highcharts, Highstock) An array defining zones within a series. Zones
  43835. * can be applied to the X axis, Y axis or Z axis for bubbles, according to
  43836. * the `zoneAxis` option. The zone definitions have to be in ascending order
  43837. * regarding to the value.
  43838. *
  43839. * In styled mode, the color zones are styled with the
  43840. * `.highcharts-zone-{n}` class, or custom classed from the `className`
  43841. * option (view live demo).
  43842. */
  43843. zones?: Array<SeriesZonesOptionsObject>;
  43844. }
  43845. /**
  43846. * (Highcharts) Initial animation is by default disabled for the funnel chart.
  43847. */
  43848. export interface PlotFunnelAnimationOptions {
  43849. defer?: number;
  43850. }
  43851. /**
  43852. * (Highcharts, Highstock, Highmaps, Gantt) Enable or disable the initial
  43853. * animation when a series is displayed for the `dataLabels`. The animation can
  43854. * also be set as a configuration object. Please note that this option only
  43855. * applies to the initial animation. For other animations, see chart.animation
  43856. * and the animation parameter under the API methods. The following properties
  43857. * are supported:
  43858. *
  43859. * - `defer`: The animation delay time in milliseconds.
  43860. */
  43861. export interface PlotFunnelDataLabelsAnimationOptions {
  43862. /**
  43863. * (Highcharts, Highstock, Highmaps, Gantt) The animation delay time in
  43864. * milliseconds. Set to `0` renders dataLabel immediately. As `undefined`
  43865. * inherits defer time from the series.animation.defer.
  43866. */
  43867. defer?: number;
  43868. }
  43869. /**
  43870. * (Highcharts) Funnel charts are a type of chart often used to visualize stages
  43871. * in a sales project, where the top are the initial stages with the most
  43872. * clients. It requires that the modules/funnel.js file is loaded.
  43873. *
  43874. * In TypeScript the type option must always be set.
  43875. *
  43876. * Configuration options for the series are given in three levels:
  43877. *
  43878. * 1. Options for all series in a chart are defined in the plotOptions.series
  43879. * object.
  43880. *
  43881. * 2. Options for all `funnel` series are defined in plotOptions.funnel.
  43882. *
  43883. * 3. Options for one single series are given in the series instance array. (see
  43884. * online documentation for example)
  43885. */
  43886. export interface PlotFunnelOptions {
  43887. /**
  43888. * (Highcharts) Accessibility options for a series.
  43889. */
  43890. accessibility?: SeriesAccessibilityOptionsObject;
  43891. /**
  43892. * (Highmaps) Whether all areas of the map defined in `mapData` should be
  43893. * rendered. If `true`, areas which don't correspond to a data point, are
  43894. * rendered as `null` points. If `false`, those areas are skipped.
  43895. */
  43896. allAreas?: boolean;
  43897. /**
  43898. * (Highcharts) Allow this series' points to be selected by clicking on the
  43899. * graphic (columns, point markers, pie slices, map areas etc).
  43900. *
  43901. * The selected points can be handled by point select and unselect events,
  43902. * or collectively by the getSelectedPoints function.
  43903. *
  43904. * And alternative way of selecting points is through dragging.
  43905. */
  43906. allowPointSelect?: boolean;
  43907. /**
  43908. * (Highcharts) Initial animation is by default disabled for the funnel
  43909. * chart.
  43910. */
  43911. animation?: (boolean|PlotFunnelAnimationOptions);
  43912. /**
  43913. * (Highcharts) The color of the border surrounding each slice. When `null`,
  43914. * the border takes the same color as the slice fill. This can be used
  43915. * together with a `borderWidth` to fill drawing gaps created by
  43916. * antialiazing artefacts in borderless pies.
  43917. *
  43918. * In styled mode, the border stroke is given in the `.highcharts-point`
  43919. * class.
  43920. */
  43921. borderColor?: (ColorString|GradientColorObject|PatternObject);
  43922. /**
  43923. * (Highcharts) The width of the border surrounding each slice.
  43924. *
  43925. * When setting the border width to 0, there may be small gaps between the
  43926. * slices due to SVG antialiasing artefacts. To work around this, keep the
  43927. * border width at 0.5 or 1, but set the `borderColor` to `null` instead.
  43928. *
  43929. * In styled mode, the border stroke width is given in the
  43930. * `.highcharts-point` class.
  43931. */
  43932. borderWidth?: number;
  43933. /**
  43934. * (Highcharts) The center of the series. By default, it is centered in the
  43935. * middle of the plot area, so it fills the plot area height.
  43936. */
  43937. center?: Array<(number|string)>;
  43938. /**
  43939. * (Highcharts) An additional class name to apply to the series' graphical
  43940. * elements. This option does not replace default class names of the
  43941. * graphical element.
  43942. */
  43943. className?: string;
  43944. /**
  43945. * (Highcharts) Disable this option to allow series rendering in the whole
  43946. * plotting area.
  43947. *
  43948. * **Note:** Clipping should be always enabled when chart.zoomType is set
  43949. */
  43950. clip?: boolean;
  43951. /**
  43952. * (Highcharts) The color of the pie series. A pie series is represented as
  43953. * an empty circle if the total sum of its values is 0. Use this property to
  43954. * define the color of its border.
  43955. *
  43956. * In styled mode, the color can be defined by the colorIndex option. Also,
  43957. * the series color can be set with the `.highcharts-series`,
  43958. * `.highcharts-color-{n}`, `.highcharts-{type}-series` or
  43959. * `.highcharts-series-{n}` class, or individual classes given by the
  43960. * `className` option.
  43961. */
  43962. color?: (ColorString|GradientColorObject|PatternObject);
  43963. /**
  43964. * (Highcharts, Highstock, Highmaps) When using dual or multiple color axes,
  43965. * this number defines which colorAxis the particular series is connected
  43966. * to. It refers to either the axis id or the index of the axis in the
  43967. * colorAxis array, with 0 being the first. Set this option to false to
  43968. * prevent a series from connecting to the default color axis.
  43969. *
  43970. * Since v7.2.0 the option can also be an axis id or an axis index instead
  43971. * of a boolean flag.
  43972. */
  43973. colorAxis?: (boolean|number|string);
  43974. /**
  43975. * (Highcharts) Styled mode only. A specific color index to use for the
  43976. * series, so its graphic representations are given the class name
  43977. * `highcharts-color-{n}`.
  43978. */
  43979. colorIndex?: number;
  43980. /**
  43981. * (Highcharts, Highstock, Highmaps) Determines what data value should be
  43982. * used to calculate point color if `colorAxis` is used. Requires to set
  43983. * `min` and `max` if some custom point property is used or if approximation
  43984. * for data grouping is set to `'sum'`.
  43985. */
  43986. colorKey?: string;
  43987. /**
  43988. * (Highcharts) A series specific or series type specific color set to use
  43989. * instead of the global colors.
  43990. */
  43991. colors?: Array<(ColorString|GradientColorObject|PatternObject)>;
  43992. /**
  43993. * (Highstock) Compare the values of the series against the first non-null,
  43994. * non- zero value in the visible range. The y axis will show percentage or
  43995. * absolute change depending on whether `compare` is set to `"percent"` or
  43996. * `"value"`. When this is applied to multiple series, it allows comparing
  43997. * the development of the series against each other. Adds a `change` field
  43998. * to every point object.
  43999. */
  44000. compare?: string;
  44001. /**
  44002. * (Highstock) When compare is `percent`, this option dictates whether to
  44003. * use 0 or 100 as the base of comparison.
  44004. */
  44005. compareBase?: (0|100);
  44006. /**
  44007. * (Highstock) Defines if comparison should start from the first point
  44008. * within the visible range or should start from the first point **before**
  44009. * the range.
  44010. *
  44011. * In other words, this flag determines if first point within the visible
  44012. * range will have 0% (`compareStart=true`) or should have been already
  44013. * calculated according to the previous point (`compareStart=false`).
  44014. */
  44015. compareStart?: boolean;
  44016. /**
  44017. * (Gantt) Override Pathfinder connector options for a series. Requires
  44018. * Highcharts Gantt to be loaded.
  44019. */
  44020. connectors?: SeriesConnectorsOptionsObject;
  44021. /**
  44022. * (Highcharts, Highstock, Gantt) When true, each point or column edge is
  44023. * rounded to its nearest pixel in order to render sharp on screen. In some
  44024. * cases, when there are a lot of densely packed columns, this leads to
  44025. * visible difference in column widths or distance between columns. In these
  44026. * cases, setting `crisp` to `false` may look better, even though each
  44027. * column is rendered blurry.
  44028. */
  44029. crisp?: boolean;
  44030. /**
  44031. * (Highcharts) You can set the cursor to "pointer" if you have click events
  44032. * attached to the series, to signal to the user that the points and lines
  44033. * can be clicked.
  44034. *
  44035. * In styled mode, the series cursor can be set with the same classes as
  44036. * listed under series.color.
  44037. */
  44038. cursor?: (string|CursorValue);
  44039. /**
  44040. * (Highcharts) A reserved subspace to store options and values for
  44041. * customized functionality. Here you can add additional data for your own
  44042. * event callbacks and formatter callbacks.
  44043. */
  44044. custom?: Dictionary<any>;
  44045. /**
  44046. * (Highstock) Data grouping is the concept of sampling the data values into
  44047. * larger blocks in order to ease readability and increase performance of
  44048. * the JavaScript charts. Highstock by default applies data grouping when
  44049. * the points become closer than a certain pixel value, determined by the
  44050. * `groupPixelWidth` option.
  44051. *
  44052. * If data grouping is applied, the grouping information of grouped points
  44053. * can be read from the Point.dataGroup. If point options other than the
  44054. * data itself are set, for example `name` or `color` or custom properties,
  44055. * the grouping logic doesn't know how to group it. In this case the options
  44056. * of the first point instance are copied over to the group point. This can
  44057. * be altered through a custom `approximation` callback function.
  44058. */
  44059. dataGrouping?: DataGroupingOptionsObject;
  44060. /**
  44061. * (Highcharts, Highstock, Highmaps, Gantt) Options for the series data
  44062. * labels, appearing next to each data point.
  44063. *
  44064. * Since v6.2.0, multiple data labels can be applied to each single point by
  44065. * defining them as an array of configs.
  44066. *
  44067. * In styled mode, the data labels can be styled with the
  44068. * `.highcharts-data-label-box` and `.highcharts-data-label` class names
  44069. * (see example).
  44070. */
  44071. dataLabels?: (SeriesPieDataLabelsOptionsObject|Array<SeriesPieDataLabelsOptionsObject>);
  44072. /**
  44073. * (Highcharts) The thickness of a 3D pie.
  44074. */
  44075. depth?: number;
  44076. /**
  44077. * (Highcharts) A description of the series to add to the screen reader
  44078. * information about the series.
  44079. */
  44080. description?: string;
  44081. /**
  44082. * (Highcharts) Enable or disable the mouse tracking for a specific series.
  44083. * This includes point tooltips and click events on graphs and points. For
  44084. * large datasets it improves performance.
  44085. */
  44086. enableMouseTracking?: boolean;
  44087. /**
  44088. * (Highcharts) The end angle of the pie in degrees where 0 is top and 90 is
  44089. * right. Defaults to `startAngle` plus 360.
  44090. */
  44091. endAngle?: number;
  44092. /**
  44093. * (Highcharts) General event handlers for the series items. These event
  44094. * hooks can also be attached to the series at run time using the
  44095. * `Highcharts.addEvent` function.
  44096. */
  44097. events?: SeriesEventsOptionsObject;
  44098. /**
  44099. * (Highcharts) If the total sum of the pie's values is 0, the series is
  44100. * represented as an empty circle . The `fillColor` option defines the color
  44101. * of that circle. Use pie.borderWidth to set the border thickness.
  44102. */
  44103. fillColor?: (ColorString|GradientColorObject|PatternObject);
  44104. /**
  44105. * (Highstock) Defines when to display a gap in the graph, together with the
  44106. * gapUnit option.
  44107. *
  44108. * In case when `dataGrouping` is enabled, points can be grouped into a
  44109. * larger time span. This can make the grouped points to have a greater
  44110. * distance than the absolute value of `gapSize` property, which will result
  44111. * in disappearing graph completely. To prevent this situation the mentioned
  44112. * distance between grouped points is used instead of previously defined
  44113. * `gapSize`.
  44114. *
  44115. * In practice, this option is most often used to visualize gaps in time
  44116. * series. In a stock chart, intraday data is available for daytime hours,
  44117. * while gaps will appear in nights and weekends.
  44118. */
  44119. gapSize?: number;
  44120. /**
  44121. * (Highstock) Together with gapSize, this option defines where to draw gaps
  44122. * in the graph.
  44123. *
  44124. * When the `gapUnit` is `"relative"` (default), a gap size of 5 means that
  44125. * if the distance between two points is greater than 5 times that of the
  44126. * two closest points, the graph will be broken.
  44127. *
  44128. * When the `gapUnit` is `"value"`, the gap is based on absolute axis
  44129. * values, which on a datetime axis is milliseconds. This also applies to
  44130. * the navigator series that inherits gap options from the base series.
  44131. */
  44132. gapUnit?: OptionsGapUnitValue;
  44133. /**
  44134. * (Highcharts) The height of the funnel or pyramid. If it is a number it
  44135. * defines the pixel height, if it is a percentage string it is the
  44136. * percentage of the plot area height.
  44137. */
  44138. height?: (number|string);
  44139. /**
  44140. * (Highcharts) Equivalent to chart.ignoreHiddenSeries, this option tells
  44141. * whether the series shall be redrawn as if the hidden point were `null`.
  44142. *
  44143. * The default value changed from `false` to `true` with Highcharts 3.0.
  44144. */
  44145. ignoreHiddenPoint?: boolean;
  44146. /**
  44147. * (Highcharts) When set to `false` will prevent the series data from being
  44148. * included in any form of data export.
  44149. *
  44150. * Since version 6.0.0 until 7.1.0 the option was existing undocumented as
  44151. * `includeInCSVExport`.
  44152. */
  44153. includeInDataExport?: boolean;
  44154. /**
  44155. * (Highmaps) What property to join the `mapData` to the value data. For
  44156. * example, if joinBy is "code", the mapData items with a specific code is
  44157. * merged into the data with the same code. For maps loaded from GeoJSON,
  44158. * the keys may be held in each point's `properties` object.
  44159. *
  44160. * The joinBy option can also be an array of two values, where the first
  44161. * points to a key in the `mapData`, and the second points to another key in
  44162. * the `data`.
  44163. *
  44164. * When joinBy is `null`, the map items are joined by their position in the
  44165. * array, which performs much better in maps with many data points. This is
  44166. * the recommended option if you are printing more than a thousand data
  44167. * points and have a backend that can preprocess the data into a parallel
  44168. * array of the mapData.
  44169. */
  44170. joinBy?: (string|Array<string>);
  44171. /**
  44172. * (Highcharts) An array specifying which option maps to which key in the
  44173. * data point array. This makes it convenient to work with unstructured data
  44174. * arrays from different sources.
  44175. */
  44176. keys?: Array<string>;
  44177. /**
  44178. * (Highstock) The line marks the last price from all points.
  44179. */
  44180. lastPrice?: SeriesLastPriceOptionsObject;
  44181. /**
  44182. * (Highstock) The line marks the last price from visible range of points.
  44183. */
  44184. lastVisiblePrice?: SeriesLastVisiblePriceOptionsObject;
  44185. /**
  44186. * (Highcharts, Highstock) The SVG value used for the `stroke-linecap` and
  44187. * `stroke-linejoin` of a line graph. Round means that lines are rounded in
  44188. * the ends and bends.
  44189. */
  44190. linecap?: SeriesLinecapValue;
  44191. /**
  44192. * (Highcharts, Highstock, Gantt) The id of another series to link to.
  44193. * Additionally, the value can be ":previous" to link to the previous
  44194. * series. When two series are linked, only the first one appears in the
  44195. * legend. Toggling the visibility of this also toggles the linked series.
  44196. *
  44197. * If master series uses data sorting and linked series does not have its
  44198. * own sorting definition, the linked series will be sorted in the same
  44199. * order as the master one.
  44200. */
  44201. linkedTo?: string;
  44202. /**
  44203. * (Highcharts) The minimum size for a pie in response to auto margins. The
  44204. * pie will try to shrink to make room for data labels in side the plot
  44205. * area, but only to this size.
  44206. */
  44207. minSize?: (number|string);
  44208. /**
  44209. * (Highstock) Options for the corresponding navigator series if
  44210. * `showInNavigator` is `true` for this series. Available options are the
  44211. * same as any series, documented at plotOptions and series.
  44212. *
  44213. * These options are merged with options in navigator.series, and will take
  44214. * precedence if the same option is defined both places.
  44215. */
  44216. navigatorOptions?: PlotSeriesOptions;
  44217. /**
  44218. * (Highcharts) The height of the neck, the lower part of the funnel. A
  44219. * number defines pixel width, a percentage string defines a percentage of
  44220. * the plot area height.
  44221. */
  44222. neckHeight?: (number|string);
  44223. /**
  44224. * (Highcharts) The width of the neck, the lower part of the funnel. A
  44225. * number defines pixel width, a percentage string defines a percentage of
  44226. * the plot area width.
  44227. */
  44228. neckWidth?: (number|string);
  44229. /**
  44230. * (Highcharts) Opacity of a series parts: line, fill (e.g. area) and
  44231. * dataLabels.
  44232. */
  44233. opacity?: number;
  44234. /**
  44235. * (Highcharts) Properties for each single point.
  44236. */
  44237. point?: PlotSeriesPointOptions;
  44238. /**
  44239. * (Highcharts) Same as accessibility.pointDescriptionFormatter, but for an
  44240. * individual series. Overrides the chart wide configuration.
  44241. */
  44242. pointDescriptionFormatter?: Function;
  44243. /**
  44244. * (Highstock) The width of each point on the x axis. For example in a
  44245. * column chart with one value each day, the pointRange would be 1 day (= 24
  44246. * * 3600
  44247. *
  44248. * * 1000 milliseconds). This is normally computed automatically, but this
  44249. * option can be used to override the automatic value.
  44250. */
  44251. pointRange?: number;
  44252. /**
  44253. * (Highcharts) A reversed funnel has the widest area down. A reversed
  44254. * funnel with no neck width and neck height is a pyramid.
  44255. */
  44256. reversed?: boolean;
  44257. /**
  44258. * (Highcharts) Whether to select the series initially. If `showCheckbox` is
  44259. * true, the checkbox next to the series name in the legend will be checked
  44260. * for a selected series.
  44261. */
  44262. selected?: boolean;
  44263. /**
  44264. * (Highcharts) Whether to apply a drop shadow to the graph line. Since 2.3
  44265. * the shadow can be an object configuration containing `color`, `offsetX`,
  44266. * `offsetY`, `opacity` and `width`.
  44267. */
  44268. shadow?: (boolean|ShadowOptionsObject);
  44269. /**
  44270. * (Highcharts) If true, a checkbox is displayed next to the legend item to
  44271. * allow selecting the series. The state of the checkbox is determined by
  44272. * the `selected` option.
  44273. */
  44274. showCheckbox?: boolean;
  44275. /**
  44276. * (Highcharts) Whether to display this particular series or series type in
  44277. * the legend. Since 2.1, pies are not shown in the legend by default.
  44278. */
  44279. showInLegend?: boolean;
  44280. /**
  44281. * (Highstock) Whether or not to show the series in the navigator. Takes
  44282. * precedence over navigator.baseSeries if defined.
  44283. */
  44284. showInNavigator?: boolean;
  44285. /**
  44286. * (Highcharts) If set to `true`, the accessibility module will skip past
  44287. * the points in this series for keyboard navigation.
  44288. */
  44289. skipKeyboardNavigation?: boolean;
  44290. /**
  44291. * (Highcharts) If a point is sliced, moved out from the center, how many
  44292. * pixels should it be moved?.
  44293. */
  44294. slicedOffset?: number;
  44295. /**
  44296. * (Highcharts) The start angle of the pie slices in degrees where 0 is top
  44297. * and 90 right.
  44298. */
  44299. startAngle?: number;
  44300. /**
  44301. * (Highcharts) Options for the series states.
  44302. */
  44303. states?: SeriesStatesOptionsObject;
  44304. /**
  44305. * (Highcharts) Sticky tracking of mouse events. When true, the `mouseOut`
  44306. * event on a series isn't triggered until the mouse moves over another
  44307. * series, or out of the plot area. When false, the `mouseOut` event on a
  44308. * series is triggered when the mouse leaves the area around the series'
  44309. * graph or markers. This also implies the tooltip. When `stickyTracking` is
  44310. * false and `tooltip.shared` is false, the tooltip will be hidden when
  44311. * moving the mouse between series.
  44312. */
  44313. stickyTracking?: boolean;
  44314. /**
  44315. * (Highcharts) A configuration object for the tooltip rendering of each
  44316. * single series. Properties are inherited from tooltip, but only the
  44317. * following properties can be defined on a series level.
  44318. */
  44319. tooltip?: SeriesTooltipOptionsObject;
  44320. /**
  44321. * (Highstock) The parameter allows setting line series type and use OHLC
  44322. * indicators. Data in OHLC format is required.
  44323. */
  44324. useOhlcData?: boolean;
  44325. /**
  44326. * (Highcharts) Set the initial visibility of the series.
  44327. */
  44328. visible?: boolean;
  44329. /**
  44330. * (Highcharts) The width of the funnel compared to the width of the plot
  44331. * area, or the pixel width if it is a number.
  44332. */
  44333. width?: (number|string);
  44334. /**
  44335. * (Highmaps) Define the z index of the series.
  44336. */
  44337. zIndex?: number;
  44338. }
  44339. /**
  44340. * (Gantt) Enable or disable the initial animation when a series is displayed.
  44341. * The animation can also be set as a configuration object. Please note that
  44342. * this option only applies to the initial animation of the series itself. For
  44343. * other animations, see chart.animation and the animation parameter under the
  44344. * API methods. The following properties are supported:
  44345. *
  44346. * - `defer`: The animation delay time in milliseconds.
  44347. *
  44348. * - `duration`: The duration of the animation in milliseconds.
  44349. *
  44350. * - `easing`: Can be a string reference to an easing function set on the `Math`
  44351. * object or a function. See the _Custom easing function_ demo below.
  44352. *
  44353. * Due to poor performance, animation is disabled in old IE browsers for several
  44354. * chart types.
  44355. */
  44356. export interface PlotGanttAnimationOptions {
  44357. defer?: number;
  44358. }
  44359. /**
  44360. * (Highcharts, Highstock, Highmaps, Gantt) Enable or disable the initial
  44361. * animation when a series is displayed for the `dataLabels`. The animation can
  44362. * also be set as a configuration object. Please note that this option only
  44363. * applies to the initial animation. For other animations, see chart.animation
  44364. * and the animation parameter under the API methods. The following properties
  44365. * are supported:
  44366. *
  44367. * - `defer`: The animation delay time in milliseconds.
  44368. */
  44369. export interface PlotGanttDataLabelsAnimationOptions {
  44370. /**
  44371. * (Highcharts, Highstock, Highmaps, Gantt) The animation delay time in
  44372. * milliseconds. Set to `0` renders dataLabel immediately. As `undefined`
  44373. * inherits defer time from the series.animation.defer.
  44374. */
  44375. defer?: number;
  44376. }
  44377. /**
  44378. * (Highcharts, Highstock, Highmaps, Gantt) Options for the series data labels,
  44379. * appearing next to each data point.
  44380. *
  44381. * Since v6.2.0, multiple data labels can be applied to each single point by
  44382. * defining them as an array of configs.
  44383. *
  44384. * In styled mode, the data labels can be styled with the
  44385. * `.highcharts-data-label-box` and `.highcharts-data-label` class names (see
  44386. * example).
  44387. */
  44388. export interface PlotGanttDataLabelsOptions {
  44389. /**
  44390. * (Highcharts, Highstock, Highmaps, Gantt) The alignment of the data label
  44391. * compared to the point. If `right`, the right side of the label should be
  44392. * touching the point. For points with an extent, like columns, the
  44393. * alignments also dictates how to align it inside the box, as given with
  44394. * the inside option. Can be one of `left`, `center` or `right`.
  44395. */
  44396. align?: string;
  44397. /**
  44398. * (Highcharts, Highstock, Highmaps, Gantt) Whether to allow data labels to
  44399. * overlap. To make the labels less sensitive for overlapping, the
  44400. * dataLabels.padding can be set to 0.
  44401. */
  44402. allowOverlap?: boolean;
  44403. /**
  44404. * (Highcharts, Highstock, Highmaps, Gantt) Enable or disable the initial
  44405. * animation when a series is displayed for the `dataLabels`. The animation
  44406. * can also be set as a configuration object. Please note that this option
  44407. * only applies to the initial animation. For other animations, see
  44408. * chart.animation and the animation parameter under the API methods. The
  44409. * following properties are supported:
  44410. *
  44411. * - `defer`: The animation delay time in milliseconds.
  44412. */
  44413. animation?: (boolean|PlotGanttDataLabelsAnimationOptions|Partial<AnimationOptionsObject>);
  44414. /**
  44415. * (Highcharts, Highstock, Highmaps, Gantt) The background color or gradient
  44416. * for the data label.
  44417. */
  44418. backgroundColor?: (ColorString|GradientColorObject|PatternObject);
  44419. /**
  44420. * (Highcharts, Highstock, Highmaps, Gantt) The border color for the data
  44421. * label. Defaults to `undefined`.
  44422. */
  44423. borderColor?: (ColorString|GradientColorObject|PatternObject);
  44424. /**
  44425. * (Highcharts, Highstock, Highmaps, Gantt) The border radius in pixels for
  44426. * the data label.
  44427. */
  44428. borderRadius?: number;
  44429. /**
  44430. * (Highcharts, Highstock, Highmaps, Gantt) The border width in pixels for
  44431. * the data label.
  44432. */
  44433. borderWidth?: number;
  44434. /**
  44435. * (Highcharts, Highstock, Highmaps, Gantt) A class name for the data label.
  44436. * Particularly in styled mode, this can be used to give each series' or
  44437. * point's data label unique styling. In addition to this option, a default
  44438. * color class name is added so that we can give the labels a contrast text
  44439. * shadow.
  44440. */
  44441. className?: string;
  44442. /**
  44443. * (Highcharts, Highstock, Highmaps, Gantt) The text color for the data
  44444. * labels. Defaults to `undefined`. For certain series types, like column or
  44445. * map, the data labels can be drawn inside the points. In this case the
  44446. * data label will be drawn with maximum contrast by default. Additionally,
  44447. * it will be given a `text-outline` style with the opposite color, to
  44448. * further increase the contrast. This can be overridden by setting the
  44449. * `text-outline` style to `none` in the `dataLabels.style` option.
  44450. */
  44451. color?: (ColorString|GradientColorObject|PatternObject);
  44452. /**
  44453. * (Highcharts, Highstock, Highmaps, Gantt) Whether to hide data labels that
  44454. * are outside the plot area. By default, the data label is moved inside the
  44455. * plot area according to the overflow option.
  44456. */
  44457. crop?: boolean;
  44458. /**
  44459. * (Highcharts, Highstock, Gantt) Whether to defer displaying the data
  44460. * labels until the initial series animation has finished. Setting to
  44461. * `false` renders the data label immediately. If set to `true` inherits the
  44462. * defer time set in plotOptions.series.animation.
  44463. */
  44464. defer?: boolean;
  44465. /**
  44466. * (Highcharts, Highstock, Highmaps, Gantt) Enable or disable the data
  44467. * labels.
  44468. */
  44469. enabled?: boolean;
  44470. /**
  44471. * (Highcharts, Highstock, Highmaps, Gantt) A declarative filter to control
  44472. * of which data labels to display. The declarative filter is designed for
  44473. * use when callback functions are not available, like when the chart
  44474. * options require a pure JSON structure or for use with graphical editors.
  44475. * For programmatic control, use the `formatter` instead, and return
  44476. * `undefined` to disable a single data label.
  44477. */
  44478. filter?: DataLabelsFilterOptionsObject;
  44479. /**
  44480. * (Highcharts, Highstock, Highmaps, Gantt) A format string for the data
  44481. * label. Available variables are the same as for `formatter`.
  44482. */
  44483. format?: string;
  44484. /**
  44485. * (Highcharts, Highstock, Highmaps, Gantt) Callback JavaScript function to
  44486. * format the data label. Note that if a `format` is defined, the format
  44487. * takes precedence and the formatter is ignored.
  44488. */
  44489. formatter?: DataLabelsFormatterCallbackFunction;
  44490. /**
  44491. * (Highcharts, Highstock, Highmaps, Gantt) For points with an extent, like
  44492. * columns or map areas, whether to align the data label inside the box or
  44493. * to the actual value point. Defaults to `false` in most cases, `true` in
  44494. * stacked columns.
  44495. */
  44496. inside?: boolean;
  44497. /**
  44498. * (Highcharts, Highstock, Highmaps, Gantt) Format for points with the value
  44499. * of null. Works analogously to format. `nullFormat` can be applied only to
  44500. * series which support displaying null points.
  44501. */
  44502. nullFormat?: (boolean|string);
  44503. /**
  44504. * (Highcharts, Highstock, Highmaps, Gantt) Callback JavaScript function
  44505. * that defines formatting for points with the value of null. Works
  44506. * analogously to formatter. `nullPointFormatter` can be applied only to
  44507. * series which support displaying null points.
  44508. */
  44509. nullFormatter?: DataLabelsFormatterCallbackFunction;
  44510. /**
  44511. * (Highcharts, Highstock, Highmaps, Gantt) How to handle data labels that
  44512. * flow outside the plot area. The default is `"justify"`, which aligns them
  44513. * inside the plot area. For columns and bars, this means it will be moved
  44514. * inside the bar. To display data labels outside the plot area, set `crop`
  44515. * to `false` and `overflow` to `"allow"`.
  44516. */
  44517. overflow?: DataLabelsOverflowValue;
  44518. /**
  44519. * (Highcharts, Highstock, Highmaps, Gantt) When either the `borderWidth` or
  44520. * the `backgroundColor` is set, this is the padding within the box.
  44521. */
  44522. padding?: number;
  44523. /**
  44524. * (Highcharts, Highstock, Highmaps, Gantt) Aligns data labels relative to
  44525. * points. If `center` alignment is not possible, it defaults to `right`.
  44526. */
  44527. position?: AlignValue;
  44528. /**
  44529. * (Highcharts, Highstock, Highmaps, Gantt) Text rotation in degrees. Note
  44530. * that due to a more complex structure, backgrounds, borders and padding
  44531. * will be lost on a rotated data label.
  44532. */
  44533. rotation?: number;
  44534. /**
  44535. * (Highcharts, Highstock, Highmaps, Gantt) The shadow of the box. Works
  44536. * best with `borderWidth` or `backgroundColor`. Since 2.3 the shadow can be
  44537. * an object configuration containing `color`, `offsetX`, `offsetY`,
  44538. * `opacity` and `width`.
  44539. */
  44540. shadow?: (boolean|ShadowOptionsObject);
  44541. /**
  44542. * (Highcharts, Highstock, Highmaps, Gantt) The name of a symbol to use for
  44543. * the border around the label. Symbols are predefined functions on the
  44544. * Renderer object.
  44545. */
  44546. shape?: string;
  44547. /**
  44548. * (Highcharts, Highstock, Highmaps, Gantt) Styles for the label. The
  44549. * default `color` setting is `"contrast"`, which is a pseudo color that
  44550. * Highcharts picks up and applies the maximum contrast to the underlying
  44551. * point item, for example the bar in a bar chart.
  44552. *
  44553. * The `textOutline` is a pseudo property that applies an outline of the
  44554. * given width with the given color, which by default is the maximum
  44555. * contrast to the text. So a bright text color will result in a black text
  44556. * outline for maximum readability on a mixed background. In some cases,
  44557. * especially with grayscale text, the text outline doesn't work well, in
  44558. * which cases it can be disabled by setting it to `"none"`. When `useHTML`
  44559. * is true, the `textOutline` will not be picked up. In this, case, the same
  44560. * effect can be acheived through the `text-shadow` CSS property.
  44561. *
  44562. * For some series types, where each point has an extent, like for example
  44563. * tree maps, the data label may overflow the point. There are two
  44564. * strategies for handling overflow. By default, the text will wrap to
  44565. * multiple lines. The other strategy is to set `style.textOverflow` to
  44566. * `ellipsis`, which will keep the text on one line plus it will break
  44567. * inside long words.
  44568. */
  44569. style?: CSSObject;
  44570. /**
  44571. * (Highcharts, Highstock, Highmaps, Gantt) Options for a label text which
  44572. * should follow marker's shape. Border and background are disabled for a
  44573. * label that follows a path.
  44574. *
  44575. * **Note:** Only SVG-based renderer supports this option. Setting `useHTML`
  44576. * to true will disable this option.
  44577. */
  44578. textPath?: DataLabelsTextPathOptionsObject;
  44579. /**
  44580. * (Highcharts, Highstock, Highmaps, Gantt) Whether to use HTML to render
  44581. * the labels.
  44582. */
  44583. useHTML?: boolean;
  44584. /**
  44585. * (Highcharts, Highstock, Highmaps, Gantt) The vertical alignment of a data
  44586. * label. Can be one of `top`, `middle` or `bottom`. The default value
  44587. * depends on the data, for instance in a column chart, the label is above
  44588. * positive values and below negative values.
  44589. */
  44590. verticalAlign?: string;
  44591. /**
  44592. * (Highcharts, Highstock, Highmaps, Gantt) The x position offset of the
  44593. * label relative to the point in pixels.
  44594. */
  44595. x?: number;
  44596. /**
  44597. * (Highcharts, Highstock, Highmaps, Gantt) The y position offset of the
  44598. * label relative to the point in pixels.
  44599. */
  44600. y?: number;
  44601. /**
  44602. * (Highcharts, Highstock, Highmaps, Gantt) The Z index of the data labels.
  44603. * The default Z index puts it above the series. Use a Z index of 2 to
  44604. * display it behind the series.
  44605. */
  44606. z?: number;
  44607. }
  44608. /**
  44609. * (Gantt) Style options for the guide box. The guide box has one state by
  44610. * default, the `default` state.
  44611. */
  44612. export interface PlotGanttDragDropGuideBoxOptions {
  44613. /**
  44614. * (Gantt) Style options for the guide box default state.
  44615. */
  44616. default?: DragDropGuideBoxOptionsObject;
  44617. }
  44618. /**
  44619. * (Gantt) A `gantt` series. If the type option is not specified, it is
  44620. * inherited from chart.type.
  44621. *
  44622. * In TypeScript the type option must always be set.
  44623. *
  44624. * Configuration options for the series are given in three levels:
  44625. *
  44626. * 1. Options for all series in a chart are defined in the plotOptions.series
  44627. * object.
  44628. *
  44629. * 2. Options for all `gantt` series are defined in plotOptions.gantt.
  44630. *
  44631. * 3. Options for one single series are given in the series instance array. (see
  44632. * online documentation for example)
  44633. */
  44634. export interface PlotGanttOptions {
  44635. /**
  44636. * (Gantt) Accessibility options for a series.
  44637. */
  44638. accessibility?: SeriesAccessibilityOptionsObject;
  44639. /**
  44640. * (Highmaps) Whether all areas of the map defined in `mapData` should be
  44641. * rendered. If `true`, areas which don't correspond to a data point, are
  44642. * rendered as `null` points. If `false`, those areas are skipped.
  44643. */
  44644. allAreas?: boolean;
  44645. /**
  44646. * (Gantt) Allow this series' points to be selected by clicking on the
  44647. * graphic (columns, point markers, pie slices, map areas etc).
  44648. *
  44649. * The selected points can be handled by point select and unselect events,
  44650. * or collectively by the getSelectedPoints function.
  44651. *
  44652. * And alternative way of selecting points is through dragging.
  44653. */
  44654. allowPointSelect?: boolean;
  44655. /**
  44656. * (Gantt) Enable or disable the initial animation when a series is
  44657. * displayed. The animation can also be set as a configuration object.
  44658. * Please note that this option only applies to the initial animation of the
  44659. * series itself. For other animations, see chart.animation and the
  44660. * animation parameter under the API methods. The following properties are
  44661. * supported:
  44662. *
  44663. * - `defer`: The animation delay time in milliseconds.
  44664. *
  44665. * - `duration`: The duration of the animation in milliseconds.
  44666. *
  44667. * - `easing`: Can be a string reference to an easing function set on the
  44668. * `Math` object or a function. See the _Custom easing function_ demo below.
  44669. *
  44670. * Due to poor performance, animation is disabled in old IE browsers for
  44671. * several chart types.
  44672. */
  44673. animation?: (boolean|PlotGanttAnimationOptions|Partial<AnimationOptionsObject>);
  44674. /**
  44675. * (Gantt) For some series, there is a limit that shuts down initial
  44676. * animation by default when the total number of points in the chart is too
  44677. * high. For example, for a column chart and its derivatives, animation does
  44678. * not run if there is more than 250 points totally. To disable this cap,
  44679. * set `animationLimit` to `Infinity`.
  44680. */
  44681. animationLimit?: number;
  44682. /**
  44683. * (Highcharts, Highstock, Gantt) The color of the border surrounding each
  44684. * column or bar.
  44685. *
  44686. * In styled mode, the border stroke can be set with the `.highcharts-point`
  44687. * rule.
  44688. */
  44689. borderColor?: (ColorString|GradientColorObject|PatternObject);
  44690. /**
  44691. * (Highcharts, Highstock, Gantt) The corner radius of the border
  44692. * surrounding each column or bar.
  44693. */
  44694. borderRadius?: number;
  44695. /**
  44696. * (Highcharts, Highstock, Gantt) The width of the border surrounding each
  44697. * column or bar. Defaults to `1` when there is room for a border, but to
  44698. * `0` when the columns are so dense that a border would cover the next
  44699. * column.
  44700. *
  44701. * In styled mode, the stroke width can be set with the `.highcharts-point`
  44702. * rule.
  44703. */
  44704. borderWidth?: number;
  44705. /**
  44706. * (Highcharts, Highstock, Gantt) When `true`, the columns will center in
  44707. * the category, ignoring null or missing points. When `false`, space will
  44708. * be reserved for null or missing points.
  44709. */
  44710. centerInCategory?: boolean;
  44711. /**
  44712. * (Gantt) An additional class name to apply to the series' graphical
  44713. * elements. This option does not replace default class names of the
  44714. * graphical element.
  44715. */
  44716. className?: string;
  44717. /**
  44718. * (Gantt) Disable this option to allow series rendering in the whole
  44719. * plotting area.
  44720. *
  44721. * **Note:** Clipping should be always enabled when chart.zoomType is set
  44722. */
  44723. clip?: boolean;
  44724. /**
  44725. * (Gantt) The main color of the series. In line type series it applies to
  44726. * the line and the point markers unless otherwise specified. In bar type
  44727. * series it applies to the bars unless a color is specified per point. The
  44728. * default value is pulled from the `options.colors` array.
  44729. *
  44730. * In styled mode, the color can be defined by the colorIndex option. Also,
  44731. * the series color can be set with the `.highcharts-series`,
  44732. * `.highcharts-color-{n}`, `.highcharts-{type}-series` or
  44733. * `.highcharts-series-{n}` class, or individual classes given by the
  44734. * `className` option.
  44735. */
  44736. color?: (ColorString|GradientColorObject|PatternObject);
  44737. /**
  44738. * (Highcharts, Highstock, Highmaps) When using dual or multiple color axes,
  44739. * this number defines which colorAxis the particular series is connected
  44740. * to. It refers to either the axis id or the index of the axis in the
  44741. * colorAxis array, with 0 being the first. Set this option to false to
  44742. * prevent a series from connecting to the default color axis.
  44743. *
  44744. * Since v7.2.0 the option can also be an axis id or an axis index instead
  44745. * of a boolean flag.
  44746. */
  44747. colorAxis?: (boolean|number|string);
  44748. /**
  44749. * (Highcharts, Highstock, Gantt) In an X-range series, this option makes
  44750. * all points of the same Y-axis category the same color.
  44751. */
  44752. colorByPoint?: boolean;
  44753. /**
  44754. * (Gantt) Styled mode only. A specific color index to use for the series,
  44755. * so its graphic representations are given the class name
  44756. * `highcharts-color-{n}`.
  44757. */
  44758. colorIndex?: number;
  44759. /**
  44760. * (Highcharts, Highstock, Highmaps) Determines what data value should be
  44761. * used to calculate point color if `colorAxis` is used. Requires to set
  44762. * `min` and `max` if some custom point property is used or if approximation
  44763. * for data grouping is set to `'sum'`.
  44764. */
  44765. colorKey?: string;
  44766. /**
  44767. * (Highcharts, Highstock, Gantt) A series specific or series type specific
  44768. * color set to apply instead of the global colors when colorByPoint is
  44769. * true.
  44770. */
  44771. colors?: Array<(ColorString|GradientColorObject|PatternObject)>;
  44772. /**
  44773. * (Highstock) Compare the values of the series against the first non-null,
  44774. * non- zero value in the visible range. The y axis will show percentage or
  44775. * absolute change depending on whether `compare` is set to `"percent"` or
  44776. * `"value"`. When this is applied to multiple series, it allows comparing
  44777. * the development of the series against each other. Adds a `change` field
  44778. * to every point object.
  44779. */
  44780. compare?: string;
  44781. /**
  44782. * (Highstock) When compare is `percent`, this option dictates whether to
  44783. * use 0 or 100 as the base of comparison.
  44784. */
  44785. compareBase?: (0|100);
  44786. /**
  44787. * (Highstock) Defines if comparison should start from the first point
  44788. * within the visible range or should start from the first point **before**
  44789. * the range.
  44790. *
  44791. * In other words, this flag determines if first point within the visible
  44792. * range will have 0% (`compareStart=true`) or should have been already
  44793. * calculated according to the previous point (`compareStart=false`).
  44794. */
  44795. compareStart?: boolean;
  44796. /**
  44797. * (Gantt) Override Pathfinder connector options for a series. Requires
  44798. * Highcharts Gantt to be loaded.
  44799. */
  44800. connectors?: SeriesConnectorsOptionsObject;
  44801. /**
  44802. * (Gantt) You can set the cursor to "pointer" if you have click events
  44803. * attached to the series, to signal to the user that the points and lines
  44804. * can be clicked.
  44805. *
  44806. * In styled mode, the series cursor can be set with the same classes as
  44807. * listed under series.color.
  44808. */
  44809. cursor?: (string|CursorValue);
  44810. /**
  44811. * (Gantt) A reserved subspace to store options and values for customized
  44812. * functionality. Here you can add additional data for your own event
  44813. * callbacks and formatter callbacks.
  44814. */
  44815. custom?: Dictionary<any>;
  44816. /**
  44817. * (Gantt) Name of the dash style to use for the graph, or for some series
  44818. * types the outline of each shape.
  44819. *
  44820. * In styled mode, the stroke dash-array can be set with the same classes as
  44821. * listed under series.color.
  44822. */
  44823. dashStyle?: DashStyleValue;
  44824. /**
  44825. * (Highstock) Data grouping is the concept of sampling the data values into
  44826. * larger blocks in order to ease readability and increase performance of
  44827. * the JavaScript charts. Highstock by default applies data grouping when
  44828. * the points become closer than a certain pixel value, determined by the
  44829. * `groupPixelWidth` option.
  44830. *
  44831. * If data grouping is applied, the grouping information of grouped points
  44832. * can be read from the Point.dataGroup. If point options other than the
  44833. * data itself are set, for example `name` or `color` or custom properties,
  44834. * the grouping logic doesn't know how to group it. In this case the options
  44835. * of the first point instance are copied over to the group point. This can
  44836. * be altered through a custom `approximation` callback function.
  44837. */
  44838. dataGrouping?: DataGroupingOptionsObject;
  44839. /**
  44840. * (Highcharts, Highstock, Highmaps, Gantt) Options for the series data
  44841. * labels, appearing next to each data point.
  44842. *
  44843. * Since v6.2.0, multiple data labels can be applied to each single point by
  44844. * defining them as an array of configs.
  44845. *
  44846. * In styled mode, the data labels can be styled with the
  44847. * `.highcharts-data-label-box` and `.highcharts-data-label` class names
  44848. * (see example).
  44849. */
  44850. dataLabels?: (PlotGanttDataLabelsOptions|Array<PlotGanttDataLabelsOptions>);
  44851. /**
  44852. * (Gantt) A description of the series to add to the screen reader
  44853. * information about the series.
  44854. */
  44855. description?: string;
  44856. /**
  44857. * (Gantt) The draggable-points module allows points to be moved around or
  44858. * modified in the chart. In addition to the options mentioned under the
  44859. * `dragDrop` API structure, the module fires three events, point.dragStart,
  44860. * point.drag and point.drop.
  44861. */
  44862. dragDrop?: SeriesDragDropOptionsObject;
  44863. /**
  44864. * (Gantt) Enable or disable the mouse tracking for a specific series. This
  44865. * includes point tooltips and click events on graphs and points. For large
  44866. * datasets it improves performance.
  44867. */
  44868. enableMouseTracking?: boolean;
  44869. /**
  44870. * (Gantt) General event handlers for the series items. These event hooks
  44871. * can also be attached to the series at run time using the
  44872. * `Highcharts.addEvent` function.
  44873. */
  44874. events?: SeriesEventsOptionsObject;
  44875. /**
  44876. * (Highcharts, Highstock, Gantt) Whether to group non-stacked columns or to
  44877. * let them render independent of each other. Non-grouped columns will be
  44878. * laid out individually and overlap each other.
  44879. */
  44880. grouping?: boolean;
  44881. /**
  44882. * (Highcharts, Highstock, Gantt) Padding between each value groups, in x
  44883. * axis units.
  44884. */
  44885. groupPadding?: number;
  44886. /**
  44887. * (Highcharts) The spacing between columns on the Z Axis in a 3D chart.
  44888. */
  44889. groupZPadding?: number;
  44890. /**
  44891. * (Gantt) When set to `false` will prevent the series data from being
  44892. * included in any form of data export.
  44893. *
  44894. * Since version 6.0.0 until 7.1.0 the option was existing undocumented as
  44895. * `includeInCSVExport`.
  44896. */
  44897. includeInDataExport?: boolean;
  44898. /**
  44899. * (Highmaps) What property to join the `mapData` to the value data. For
  44900. * example, if joinBy is "code", the mapData items with a specific code is
  44901. * merged into the data with the same code. For maps loaded from GeoJSON,
  44902. * the keys may be held in each point's `properties` object.
  44903. *
  44904. * The joinBy option can also be an array of two values, where the first
  44905. * points to a key in the `mapData`, and the second points to another key in
  44906. * the `data`.
  44907. *
  44908. * When joinBy is `null`, the map items are joined by their position in the
  44909. * array, which performs much better in maps with many data points. This is
  44910. * the recommended option if you are printing more than a thousand data
  44911. * points and have a backend that can preprocess the data into a parallel
  44912. * array of the mapData.
  44913. */
  44914. joinBy?: (string|Array<string>);
  44915. /**
  44916. * (Gantt) An array specifying which option maps to which key in the data
  44917. * point array. This makes it convenient to work with unstructured data
  44918. * arrays from different sources.
  44919. */
  44920. keys?: Array<string>;
  44921. /**
  44922. * (Highcharts, Highstock, Gantt) Series labels are placed as close to the
  44923. * series as possible in a natural way, seeking to avoid other series. The
  44924. * goal of this feature is to make the chart more easily readable, like if a
  44925. * human designer placed the labels in the optimal position.
  44926. *
  44927. * The series labels currently work with series types having a `graph` or an
  44928. * `area`.
  44929. */
  44930. label?: SeriesLabelOptionsObject;
  44931. /**
  44932. * (Highstock) The line marks the last price from all points.
  44933. */
  44934. lastPrice?: SeriesLastPriceOptionsObject;
  44935. /**
  44936. * (Highstock) The line marks the last price from visible range of points.
  44937. */
  44938. lastVisiblePrice?: SeriesLastVisiblePriceOptionsObject;
  44939. /**
  44940. * (Highcharts, Highstock, Gantt) The id of another series to link to.
  44941. * Additionally, the value can be ":previous" to link to the previous
  44942. * series. When two series are linked, only the first one appears in the
  44943. * legend. Toggling the visibility of this also toggles the linked series.
  44944. *
  44945. * If master series uses data sorting and linked series does not have its
  44946. * own sorting definition, the linked series will be sorted in the same
  44947. * order as the master one.
  44948. */
  44949. linkedTo?: string;
  44950. /**
  44951. * (Highcharts, Highstock, Gantt) The maximum allowed pixel width for a
  44952. * column, translated to the height of a bar in a bar chart. This prevents
  44953. * the columns from becoming too wide when there is a small number of points
  44954. * in the chart.
  44955. */
  44956. maxPointWidth?: number;
  44957. /**
  44958. * (Highcharts, Highstock, Gantt) The minimal height for a column or width
  44959. * for a bar. By default, 0 values are not shown. To visualize a 0 (or close
  44960. * to zero) point, set the minimal point length to a pixel value like 3\. In
  44961. * stacked column charts, minPointLength might not be respected for tightly
  44962. * packed values.
  44963. */
  44964. minPointLength?: number;
  44965. /**
  44966. * (Highstock) Options for the corresponding navigator series if
  44967. * `showInNavigator` is `true` for this series. Available options are the
  44968. * same as any series, documented at plotOptions and series.
  44969. *
  44970. * These options are merged with options in navigator.series, and will take
  44971. * precedence if the same option is defined both places.
  44972. */
  44973. navigatorOptions?: PlotSeriesOptions;
  44974. /**
  44975. * (Gantt) Opacity of a series parts: line, fill (e.g. area) and dataLabels.
  44976. */
  44977. opacity?: number;
  44978. /**
  44979. * (Gantt) A partial fill for each point, typically used to visualize how
  44980. * much of a task is performed. See completed.
  44981. */
  44982. partialFill?: PlotGanttPartialFillOptions;
  44983. /**
  44984. * (Gantt) Properties for each single point.
  44985. */
  44986. point?: PlotSeriesPointOptions;
  44987. /**
  44988. * (Gantt) Same as accessibility.pointDescriptionFormatter, but for an
  44989. * individual series. Overrides the chart wide configuration.
  44990. */
  44991. pointDescriptionFormatter?: Function;
  44992. /**
  44993. * (Highcharts, Highstock, Gantt) Padding between each column or bar, in x
  44994. * axis units.
  44995. */
  44996. pointPadding?: number;
  44997. pointRange?: number;
  44998. /**
  44999. * (Highcharts, Highstock, Gantt) A pixel value specifying a fixed width for
  45000. * each column or bar point. When set to `undefined`, the width is
  45001. * calculated from the `pointPadding` and `groupPadding`. The width effects
  45002. * the dimension that is not based on the point value. For column series it
  45003. * is the hoizontal length and for bar series it is the vertical length.
  45004. */
  45005. pointWidth?: number;
  45006. /**
  45007. * (Gantt) Whether to select the series initially. If `showCheckbox` is
  45008. * true, the checkbox next to the series name in the legend will be checked
  45009. * for a selected series.
  45010. */
  45011. selected?: boolean;
  45012. /**
  45013. * (Gantt) Whether to apply a drop shadow to the graph line. Since 2.3 the
  45014. * shadow can be an object configuration containing `color`, `offsetX`,
  45015. * `offsetY`, `opacity` and `width`.
  45016. */
  45017. shadow?: (boolean|ShadowOptionsObject);
  45018. /**
  45019. * (Gantt) If true, a checkbox is displayed next to the legend item to allow
  45020. * selecting the series. The state of the checkbox is determined by the
  45021. * `selected` option.
  45022. */
  45023. showCheckbox?: boolean;
  45024. /**
  45025. * (Gantt) Whether to display this particular series or series type in the
  45026. * legend. Standalone series are shown in legend by default, and linked
  45027. * series are not. Since v7.2.0 it is possible to show series that use
  45028. * colorAxis by setting this option to `true`.
  45029. */
  45030. showInLegend?: boolean;
  45031. /**
  45032. * (Highstock) Whether or not to show the series in the navigator. Takes
  45033. * precedence over navigator.baseSeries if defined.
  45034. */
  45035. showInNavigator?: boolean;
  45036. /**
  45037. * (Gantt) If set to `true`, the accessibility module will skip past the
  45038. * points in this series for keyboard navigation.
  45039. */
  45040. skipKeyboardNavigation?: boolean;
  45041. states?: SeriesStatesOptionsObject;
  45042. /**
  45043. * (Gantt) Sticky tracking of mouse events. When true, the `mouseOut` event
  45044. * on a series isn't triggered until the mouse moves over another series, or
  45045. * out of the plot area. When false, the `mouseOut` event on a series is
  45046. * triggered when the mouse leaves the area around the series' graph or
  45047. * markers. This also implies the tooltip when not shared. When
  45048. * `stickyTracking` is false and `tooltip.shared` is false, the tooltip will
  45049. * be hidden when moving the mouse between series. Defaults to true for line
  45050. * and area type series, but to false for columns, pies etc.
  45051. *
  45052. * **Note:** The boost module will force this option because of technical
  45053. * limitations.
  45054. */
  45055. stickyTracking?: boolean;
  45056. /**
  45057. * (Gantt) A configuration object for the tooltip rendering of each single
  45058. * series. Properties are inherited from tooltip, but only the following
  45059. * properties can be defined on a series level.
  45060. */
  45061. tooltip?: SeriesTooltipOptionsObject;
  45062. /**
  45063. * (Highcharts, Highstock, Gantt) When a series contains a data array that
  45064. * is longer than this, only one dimensional arrays of numbers, or two
  45065. * dimensional arrays with x and y values are allowed. Also, only the first
  45066. * point is tested, and the rest are assumed to be the same format. This
  45067. * saves expensive data checking and indexing in long series. Set it to `0`
  45068. * disable.
  45069. *
  45070. * Note: In boost mode turbo threshold is forced. Only array of numbers or
  45071. * two dimensional arrays are allowed.
  45072. */
  45073. turboThreshold?: number;
  45074. /**
  45075. * (Gantt) Set the initial visibility of the series.
  45076. */
  45077. visible?: boolean;
  45078. /**
  45079. * (Highmaps) Define the z index of the series.
  45080. */
  45081. zIndex?: number;
  45082. /**
  45083. * (Highcharts, Highstock) Defines the Axis on which the zones are applied.
  45084. */
  45085. zoneAxis?: string;
  45086. /**
  45087. * (Highcharts, Highstock) An array defining zones within a series. Zones
  45088. * can be applied to the X axis, Y axis or Z axis for bubbles, according to
  45089. * the `zoneAxis` option. The zone definitions have to be in ascending order
  45090. * regarding to the value.
  45091. *
  45092. * In styled mode, the color zones are styled with the
  45093. * `.highcharts-zone-{n}` class, or custom classed from the `className`
  45094. * option (view live demo).
  45095. */
  45096. zones?: Array<SeriesZonesOptionsObject>;
  45097. }
  45098. /**
  45099. * (Gantt) A partial fill for each point, typically used to visualize how much
  45100. * of a task is performed. See completed.
  45101. */
  45102. export interface PlotGanttPartialFillOptions {
  45103. /**
  45104. * (Highcharts, Highstock, Gantt) The fill color to be used for partial
  45105. * fills. Defaults to a darker shade of the point color.
  45106. */
  45107. fill?: (ColorString|GradientColorObject|PatternObject);
  45108. }
  45109. /**
  45110. * (Highcharts) Enable or disable the initial animation when a series is
  45111. * displayed. The animation can also be set as a configuration object. Please
  45112. * note that this option only applies to the initial animation of the series
  45113. * itself. For other animations, see chart.animation and the animation parameter
  45114. * under the API methods. The following properties are supported:
  45115. *
  45116. * - `defer`: The animation delay time in milliseconds.
  45117. *
  45118. * - `duration`: The duration of the animation in milliseconds.
  45119. *
  45120. * - `easing`: Can be a string reference to an easing function set on the `Math`
  45121. * object or a function. See the _Custom easing function_ demo below.
  45122. *
  45123. * Due to poor performance, animation is disabled in old IE browsers for several
  45124. * chart types.
  45125. */
  45126. export interface PlotGaugeAnimationOptions {
  45127. defer?: number;
  45128. }
  45129. /**
  45130. * (Highcharts) Enable or disable the initial animation when a series is
  45131. * displayed for the `dataLabels`. The animation can also be set as a
  45132. * configuration object. Please note that this option only applies to the
  45133. * initial animation. For other animations, see chart.animation and the
  45134. * animation parameter under the API methods. The following properties are
  45135. * supported:
  45136. *
  45137. * - `defer`: The animation delay time in milliseconds.
  45138. */
  45139. export interface PlotGaugeDataLabelsAnimationOptions {
  45140. /**
  45141. * (Highcharts) The animation delay time in milliseconds. Set to `0` renders
  45142. * dataLabel immediately. As `undefined` inherits defer time from the
  45143. * series.animation.defer.
  45144. */
  45145. defer?: number;
  45146. }
  45147. /**
  45148. * (Highcharts) Data labels for the gauge. For gauges, the data labels are
  45149. * enabled by default and shown in a bordered box below the point.
  45150. */
  45151. export interface PlotGaugeDataLabelsOptions {
  45152. /**
  45153. * (Highcharts) The alignment of the data label compared to the point. If
  45154. * `right`, the right side of the label should be touching the point. For
  45155. * points with an extent, like columns, the alignments also dictates how to
  45156. * align it inside the box, as given with the inside option. Can be one of
  45157. * `left`, `center` or `right`.
  45158. */
  45159. align?: (AlignValue|null);
  45160. /**
  45161. * (Highcharts) Whether to allow data labels to overlap. To make the labels
  45162. * less sensitive for overlapping, the dataLabels.padding can be set to 0.
  45163. */
  45164. allowOverlap?: boolean;
  45165. /**
  45166. * (Highcharts) Enable or disable the initial animation when a series is
  45167. * displayed for the `dataLabels`. The animation can also be set as a
  45168. * configuration object. Please note that this option only applies to the
  45169. * initial animation. For other animations, see chart.animation and the
  45170. * animation parameter under the API methods. The following properties are
  45171. * supported:
  45172. *
  45173. * - `defer`: The animation delay time in milliseconds.
  45174. */
  45175. animation?: (boolean|PlotGaugeDataLabelsAnimationOptions|Partial<AnimationOptionsObject>);
  45176. /**
  45177. * (Highcharts) The background color or gradient for the data label.
  45178. */
  45179. backgroundColor?: (ColorString|GradientColorObject|PatternObject);
  45180. /**
  45181. * (Highcharts) The border color for the data label. Defaults to
  45182. * `undefined`.
  45183. */
  45184. borderColor?: string;
  45185. /**
  45186. * (Highcharts) The border radius in pixels for the data label.
  45187. */
  45188. borderRadius?: number;
  45189. /**
  45190. * (Highcharts) The border width in pixels for the data label.
  45191. */
  45192. borderWidth?: number;
  45193. /**
  45194. * (Highcharts) A class name for the data label. Particularly in styled
  45195. * mode, this can be used to give each series' or point's data label unique
  45196. * styling. In addition to this option, a default color class name is added
  45197. * so that we can give the labels a contrast text shadow.
  45198. */
  45199. className?: string;
  45200. /**
  45201. * (Highcharts) The text color for the data labels. Defaults to `undefined`.
  45202. * For certain series types, like column or map, the data labels can be
  45203. * drawn inside the points. In this case the data label will be drawn with
  45204. * maximum contrast by default. Additionally, it will be given a
  45205. * `text-outline` style with the opposite color, to further increase the
  45206. * contrast. This can be overridden by setting the `text-outline` style to
  45207. * `none` in the `dataLabels.style` option.
  45208. */
  45209. color?: (ColorString|GradientColorObject|PatternObject);
  45210. /**
  45211. * (Highcharts) Whether to hide data labels that are outside the plot area.
  45212. * By default, the data label is moved inside the plot area according to the
  45213. * overflow option.
  45214. */
  45215. crop?: boolean;
  45216. /**
  45217. * (Highcharts, Highstock, Gantt) Whether to defer displaying the data
  45218. * labels until the initial series animation has finished. Setting to
  45219. * `false` renders the data label immediately. If set to `true` inherits the
  45220. * defer time set in plotOptions.series.animation.
  45221. */
  45222. defer?: boolean;
  45223. /**
  45224. * (Highcharts) Enable or disable the data labels.
  45225. */
  45226. enabled?: boolean;
  45227. /**
  45228. * (Highcharts) A declarative filter to control of which data labels to
  45229. * display. The declarative filter is designed for use when callback
  45230. * functions are not available, like when the chart options require a pure
  45231. * JSON structure or for use with graphical editors. For programmatic
  45232. * control, use the `formatter` instead, and return `undefined` to disable a
  45233. * single data label.
  45234. */
  45235. filter?: DataLabelsFilterOptionsObject;
  45236. /**
  45237. * (Highcharts) A format string for the data label. Available variables are
  45238. * the same as for `formatter`.
  45239. */
  45240. format?: string;
  45241. /**
  45242. * (Highcharts) Callback JavaScript function to format the data label. Note
  45243. * that if a `format` is defined, the format takes precedence and the
  45244. * formatter is ignored.
  45245. */
  45246. formatter?: DataLabelsFormatterCallbackFunction;
  45247. /**
  45248. * (Highcharts) For points with an extent, like columns or map areas,
  45249. * whether to align the data label inside the box or to the actual value
  45250. * point. Defaults to `false` in most cases, `true` in stacked columns.
  45251. */
  45252. inside?: boolean;
  45253. /**
  45254. * (Highcharts) Format for points with the value of null. Works analogously
  45255. * to format. `nullFormat` can be applied only to series which support
  45256. * displaying null points.
  45257. */
  45258. nullFormat?: (boolean|string);
  45259. /**
  45260. * (Highcharts) Callback JavaScript function that defines formatting for
  45261. * points with the value of null. Works analogously to formatter.
  45262. * `nullPointFormatter` can be applied only to series which support
  45263. * displaying null points.
  45264. */
  45265. nullFormatter?: DataLabelsFormatterCallbackFunction;
  45266. /**
  45267. * (Highcharts) How to handle data labels that flow outside the plot area.
  45268. * The default is `"justify"`, which aligns them inside the plot area. For
  45269. * columns and bars, this means it will be moved inside the bar. To display
  45270. * data labels outside the plot area, set `crop` to `false` and `overflow`
  45271. * to `"allow"`.
  45272. */
  45273. overflow?: DataLabelsOverflowValue;
  45274. /**
  45275. * (Highcharts) When either the `borderWidth` or the `backgroundColor` is
  45276. * set, this is the padding within the box.
  45277. */
  45278. padding?: number;
  45279. /**
  45280. * (Highcharts) Aligns data labels relative to points. If `center` alignment
  45281. * is not possible, it defaults to `right`.
  45282. */
  45283. position?: AlignValue;
  45284. /**
  45285. * (Highcharts) Text rotation in degrees. Note that due to a more complex
  45286. * structure, backgrounds, borders and padding will be lost on a rotated
  45287. * data label.
  45288. */
  45289. rotation?: number;
  45290. /**
  45291. * (Highcharts) The shadow of the box. Works best with `borderWidth` or
  45292. * `backgroundColor`. Since 2.3 the shadow can be an object configuration
  45293. * containing `color`, `offsetX`, `offsetY`, `opacity` and `width`.
  45294. */
  45295. shadow?: (boolean|ShadowOptionsObject);
  45296. /**
  45297. * (Highcharts) The name of a symbol to use for the border around the label.
  45298. * Symbols are predefined functions on the Renderer object.
  45299. */
  45300. shape?: string;
  45301. /**
  45302. * (Highcharts) Styles for the label. The default `color` setting is
  45303. * `"contrast"`, which is a pseudo color that Highcharts picks up and
  45304. * applies the maximum contrast to the underlying point item, for example
  45305. * the bar in a bar chart.
  45306. *
  45307. * The `textOutline` is a pseudo property that applies an outline of the
  45308. * given width with the given color, which by default is the maximum
  45309. * contrast to the text. So a bright text color will result in a black text
  45310. * outline for maximum readability on a mixed background. In some cases,
  45311. * especially with grayscale text, the text outline doesn't work well, in
  45312. * which cases it can be disabled by setting it to `"none"`. When `useHTML`
  45313. * is true, the `textOutline` will not be picked up. In this, case, the same
  45314. * effect can be acheived through the `text-shadow` CSS property.
  45315. *
  45316. * For some series types, where each point has an extent, like for example
  45317. * tree maps, the data label may overflow the point. There are two
  45318. * strategies for handling overflow. By default, the text will wrap to
  45319. * multiple lines. The other strategy is to set `style.textOverflow` to
  45320. * `ellipsis`, which will keep the text on one line plus it will break
  45321. * inside long words.
  45322. */
  45323. style?: CSSObject;
  45324. /**
  45325. * (Highcharts) Options for a label text which should follow marker's shape.
  45326. * Border and background are disabled for a label that follows a path.
  45327. *
  45328. * **Note:** Only SVG-based renderer supports this option. Setting `useHTML`
  45329. * to true will disable this option.
  45330. */
  45331. textPath?: DataLabelsTextPathOptionsObject;
  45332. /**
  45333. * (Highcharts) Whether to use HTML to render the labels.
  45334. */
  45335. useHTML?: boolean;
  45336. /**
  45337. * (Highcharts) The vertical alignment of a data label. Can be one of `top`,
  45338. * `middle` or `bottom`. The default value depends on the data, for instance
  45339. * in a column chart, the label is above positive values and below negative
  45340. * values.
  45341. */
  45342. verticalAlign?: string;
  45343. /**
  45344. * (Highcharts) The x position offset of the label relative to the point in
  45345. * pixels.
  45346. */
  45347. x?: number;
  45348. /**
  45349. * (Highcharts) The y position offset of the label relative to the point in
  45350. * pixels.
  45351. */
  45352. y?: number;
  45353. /**
  45354. * (Highcharts) The Z index of the data labels. The default Z index puts it
  45355. * above the series. Use a Z index of 2 to display it behind the series.
  45356. */
  45357. z?: number;
  45358. zIndex?: number;
  45359. }
  45360. /**
  45361. * (Highcharts) Options for the dial or arrow pointer of the gauge.
  45362. *
  45363. * In styled mode, the dial is styled with the `.highcharts-gauge-series
  45364. * .highcharts-dial` rule.
  45365. */
  45366. export interface PlotGaugeDialOptions {
  45367. /**
  45368. * (Highcharts) The background or fill color of the gauge's dial.
  45369. */
  45370. backgroundColor?: (ColorString|GradientColorObject|PatternObject);
  45371. /**
  45372. * (Highcharts) The length of the dial's base part, relative to the total
  45373. * radius or length of the dial.
  45374. */
  45375. baseLength?: string;
  45376. /**
  45377. * (Highcharts) The pixel width of the base of the gauge dial. The base is
  45378. * the part closest to the pivot, defined by baseLength.
  45379. */
  45380. baseWidth?: number;
  45381. /**
  45382. * (Highcharts) The border color or stroke of the gauge's dial. By default,
  45383. * the borderWidth is 0, so this must be set in addition to a custom border
  45384. * color.
  45385. */
  45386. borderColor?: (ColorString|GradientColorObject|PatternObject);
  45387. /**
  45388. * (Highcharts) The width of the gauge dial border in pixels.
  45389. */
  45390. borderWidth?: number;
  45391. /**
  45392. * (Highcharts) The radius or length of the dial, in percentages relative to
  45393. * the radius of the gauge itself.
  45394. */
  45395. radius?: string;
  45396. /**
  45397. * (Highcharts) The length of the dial's rear end, the part that extends out
  45398. * on the other side of the pivot. Relative to the dial's length.
  45399. */
  45400. rearLength?: string;
  45401. /**
  45402. * (Highcharts) The width of the top of the dial, closest to the perimeter.
  45403. * The pivot narrows in from the base to the top.
  45404. */
  45405. topWidth?: number;
  45406. }
  45407. /**
  45408. * (Highcharts) Gauges are circular plots displaying one or more values with a
  45409. * dial pointing to values along the perimeter.
  45410. *
  45411. * In TypeScript the type option must always be set.
  45412. *
  45413. * Configuration options for the series are given in three levels:
  45414. *
  45415. * 1. Options for all series in a chart are defined in the plotOptions.series
  45416. * object.
  45417. *
  45418. * 2. Options for all `gauge` series are defined in plotOptions.gauge.
  45419. *
  45420. * 3. Options for one single series are given in the series instance array. (see
  45421. * online documentation for example)
  45422. */
  45423. export interface PlotGaugeOptions {
  45424. /**
  45425. * (Highcharts) Accessibility options for a series.
  45426. */
  45427. accessibility?: SeriesAccessibilityOptionsObject;
  45428. /**
  45429. * (Highmaps) Whether all areas of the map defined in `mapData` should be
  45430. * rendered. If `true`, areas which don't correspond to a data point, are
  45431. * rendered as `null` points. If `false`, those areas are skipped.
  45432. */
  45433. allAreas?: boolean;
  45434. /**
  45435. * (Highcharts) Allow this series' points to be selected by clicking on the
  45436. * graphic (columns, point markers, pie slices, map areas etc).
  45437. *
  45438. * The selected points can be handled by point select and unselect events,
  45439. * or collectively by the getSelectedPoints function.
  45440. *
  45441. * And alternative way of selecting points is through dragging.
  45442. */
  45443. allowPointSelect?: boolean;
  45444. /**
  45445. * (Highcharts) Enable or disable the initial animation when a series is
  45446. * displayed. The animation can also be set as a configuration object.
  45447. * Please note that this option only applies to the initial animation of the
  45448. * series itself. For other animations, see chart.animation and the
  45449. * animation parameter under the API methods. The following properties are
  45450. * supported:
  45451. *
  45452. * - `defer`: The animation delay time in milliseconds.
  45453. *
  45454. * - `duration`: The duration of the animation in milliseconds.
  45455. *
  45456. * - `easing`: Can be a string reference to an easing function set on the
  45457. * `Math` object or a function. See the _Custom easing function_ demo below.
  45458. *
  45459. * Due to poor performance, animation is disabled in old IE browsers for
  45460. * several chart types.
  45461. */
  45462. animation?: (boolean|PlotGaugeAnimationOptions|Partial<AnimationOptionsObject>);
  45463. /**
  45464. * (Highmaps) The border color of the map areas.
  45465. *
  45466. * In styled mode, the border stroke is given in the `.highcharts-point`
  45467. * class.
  45468. */
  45469. borderColor?: (ColorString|GradientColorObject|PatternObject);
  45470. /**
  45471. * (Highmaps) The border width of each map area.
  45472. *
  45473. * In styled mode, the border stroke width is given in the
  45474. * `.highcharts-point` class.
  45475. */
  45476. borderWidth?: number;
  45477. /**
  45478. * (Highcharts) An additional class name to apply to the series' graphical
  45479. * elements. This option does not replace default class names of the
  45480. * graphical element.
  45481. */
  45482. className?: string;
  45483. /**
  45484. * (Highcharts) Disable this option to allow series rendering in the whole
  45485. * plotting area.
  45486. *
  45487. * **Note:** Clipping should be always enabled when chart.zoomType is set
  45488. */
  45489. clip?: boolean;
  45490. /**
  45491. * (Highcharts) The main color of the series. In line type series it applies
  45492. * to the line and the point markers unless otherwise specified. In bar type
  45493. * series it applies to the bars unless a color is specified per point. The
  45494. * default value is pulled from the `options.colors` array.
  45495. *
  45496. * In styled mode, the color can be defined by the colorIndex option. Also,
  45497. * the series color can be set with the `.highcharts-series`,
  45498. * `.highcharts-color-{n}`, `.highcharts-{type}-series` or
  45499. * `.highcharts-series-{n}` class, or individual classes given by the
  45500. * `className` option.
  45501. */
  45502. color?: (ColorString|GradientColorObject|PatternObject);
  45503. /**
  45504. * (Highcharts) Styled mode only. A specific color index to use for the
  45505. * series, so its graphic representations are given the class name
  45506. * `highcharts-color-{n}`.
  45507. */
  45508. colorIndex?: number;
  45509. /**
  45510. * (Highstock) Compare the values of the series against the first non-null,
  45511. * non- zero value in the visible range. The y axis will show percentage or
  45512. * absolute change depending on whether `compare` is set to `"percent"` or
  45513. * `"value"`. When this is applied to multiple series, it allows comparing
  45514. * the development of the series against each other. Adds a `change` field
  45515. * to every point object.
  45516. */
  45517. compare?: string;
  45518. /**
  45519. * (Highstock) When compare is `percent`, this option dictates whether to
  45520. * use 0 or 100 as the base of comparison.
  45521. */
  45522. compareBase?: (0|100);
  45523. /**
  45524. * (Highstock) Defines if comparison should start from the first point
  45525. * within the visible range or should start from the first point **before**
  45526. * the range.
  45527. *
  45528. * In other words, this flag determines if first point within the visible
  45529. * range will have 0% (`compareStart=true`) or should have been already
  45530. * calculated according to the previous point (`compareStart=false`).
  45531. */
  45532. compareStart?: boolean;
  45533. /**
  45534. * (Gantt) Override Pathfinder connector options for a series. Requires
  45535. * Highcharts Gantt to be loaded.
  45536. */
  45537. connectors?: SeriesConnectorsOptionsObject;
  45538. /**
  45539. * (Highcharts, Highstock, Gantt) When true, each point or column edge is
  45540. * rounded to its nearest pixel in order to render sharp on screen. In some
  45541. * cases, when there are a lot of densely packed columns, this leads to
  45542. * visible difference in column widths or distance between columns. In these
  45543. * cases, setting `crisp` to `false` may look better, even though each
  45544. * column is rendered blurry.
  45545. */
  45546. crisp?: boolean;
  45547. /**
  45548. * (Highcharts) You can set the cursor to "pointer" if you have click events
  45549. * attached to the series, to signal to the user that the points and lines
  45550. * can be clicked.
  45551. *
  45552. * In styled mode, the series cursor can be set with the same classes as
  45553. * listed under series.color.
  45554. */
  45555. cursor?: (string|CursorValue);
  45556. /**
  45557. * (Highcharts) A reserved subspace to store options and values for
  45558. * customized functionality. Here you can add additional data for your own
  45559. * event callbacks and formatter callbacks.
  45560. */
  45561. custom?: Dictionary<any>;
  45562. /**
  45563. * (Highstock) Data grouping is the concept of sampling the data values into
  45564. * larger blocks in order to ease readability and increase performance of
  45565. * the JavaScript charts. Highstock by default applies data grouping when
  45566. * the points become closer than a certain pixel value, determined by the
  45567. * `groupPixelWidth` option.
  45568. *
  45569. * If data grouping is applied, the grouping information of grouped points
  45570. * can be read from the Point.dataGroup. If point options other than the
  45571. * data itself are set, for example `name` or `color` or custom properties,
  45572. * the grouping logic doesn't know how to group it. In this case the options
  45573. * of the first point instance are copied over to the group point. This can
  45574. * be altered through a custom `approximation` callback function.
  45575. */
  45576. dataGrouping?: DataGroupingOptionsObject;
  45577. /**
  45578. * (Highcharts) Data labels for the gauge. For gauges, the data labels are
  45579. * enabled by default and shown in a bordered box below the point.
  45580. */
  45581. dataLabels?: (PlotGaugeDataLabelsOptions|Array<PlotGaugeDataLabelsOptions>);
  45582. /**
  45583. * (Highcharts) A description of the series to add to the screen reader
  45584. * information about the series.
  45585. */
  45586. description?: string;
  45587. /**
  45588. * (Highcharts) Options for the dial or arrow pointer of the gauge.
  45589. *
  45590. * In styled mode, the dial is styled with the `.highcharts-gauge-series
  45591. * .highcharts-dial` rule.
  45592. */
  45593. dial?: PlotGaugeDialOptions;
  45594. /**
  45595. * (Highcharts) Enable or disable the mouse tracking for a specific series.
  45596. * This includes point tooltips and click events on graphs and points. For
  45597. * large datasets it improves performance.
  45598. */
  45599. enableMouseTracking?: boolean;
  45600. /**
  45601. * (Highcharts) General event handlers for the series items. These event
  45602. * hooks can also be attached to the series at run time using the
  45603. * `Highcharts.addEvent` function.
  45604. */
  45605. events?: SeriesEventsOptionsObject;
  45606. /**
  45607. * (Highstock) Defines when to display a gap in the graph, together with the
  45608. * gapUnit option.
  45609. *
  45610. * In case when `dataGrouping` is enabled, points can be grouped into a
  45611. * larger time span. This can make the grouped points to have a greater
  45612. * distance than the absolute value of `gapSize` property, which will result
  45613. * in disappearing graph completely. To prevent this situation the mentioned
  45614. * distance between grouped points is used instead of previously defined
  45615. * `gapSize`.
  45616. *
  45617. * In practice, this option is most often used to visualize gaps in time
  45618. * series. In a stock chart, intraday data is available for daytime hours,
  45619. * while gaps will appear in nights and weekends.
  45620. */
  45621. gapSize?: number;
  45622. /**
  45623. * (Highstock) Together with gapSize, this option defines where to draw gaps
  45624. * in the graph.
  45625. *
  45626. * When the `gapUnit` is `"relative"` (default), a gap size of 5 means that
  45627. * if the distance between two points is greater than 5 times that of the
  45628. * two closest points, the graph will be broken.
  45629. *
  45630. * When the `gapUnit` is `"value"`, the gap is based on absolute axis
  45631. * values, which on a datetime axis is milliseconds. This also applies to
  45632. * the navigator series that inherits gap options from the base series.
  45633. */
  45634. gapUnit?: OptionsGapUnitValue;
  45635. /**
  45636. * (Highcharts) When set to `false` will prevent the series data from being
  45637. * included in any form of data export.
  45638. *
  45639. * Since version 6.0.0 until 7.1.0 the option was existing undocumented as
  45640. * `includeInCSVExport`.
  45641. */
  45642. includeInDataExport?: boolean;
  45643. /**
  45644. * (Highmaps) What property to join the `mapData` to the value data. For
  45645. * example, if joinBy is "code", the mapData items with a specific code is
  45646. * merged into the data with the same code. For maps loaded from GeoJSON,
  45647. * the keys may be held in each point's `properties` object.
  45648. *
  45649. * The joinBy option can also be an array of two values, where the first
  45650. * points to a key in the `mapData`, and the second points to another key in
  45651. * the `data`.
  45652. *
  45653. * When joinBy is `null`, the map items are joined by their position in the
  45654. * array, which performs much better in maps with many data points. This is
  45655. * the recommended option if you are printing more than a thousand data
  45656. * points and have a backend that can preprocess the data into a parallel
  45657. * array of the mapData.
  45658. */
  45659. joinBy?: (string|Array<string>);
  45660. /**
  45661. * (Highcharts) An array specifying which option maps to which key in the
  45662. * data point array. This makes it convenient to work with unstructured data
  45663. * arrays from different sources.
  45664. */
  45665. keys?: Array<string>;
  45666. /**
  45667. * (Highcharts, Highstock, Gantt) Series labels are placed as close to the
  45668. * series as possible in a natural way, seeking to avoid other series. The
  45669. * goal of this feature is to make the chart more easily readable, like if a
  45670. * human designer placed the labels in the optimal position.
  45671. *
  45672. * The series labels currently work with series types having a `graph` or an
  45673. * `area`.
  45674. */
  45675. label?: SeriesLabelOptionsObject;
  45676. /**
  45677. * (Highstock) The line marks the last price from all points.
  45678. */
  45679. lastPrice?: SeriesLastPriceOptionsObject;
  45680. /**
  45681. * (Highstock) The line marks the last price from visible range of points.
  45682. */
  45683. lastVisiblePrice?: SeriesLastVisiblePriceOptionsObject;
  45684. /**
  45685. * (Highcharts, Highstock) The SVG value used for the `stroke-linecap` and
  45686. * `stroke-linejoin` of a line graph. Round means that lines are rounded in
  45687. * the ends and bends.
  45688. */
  45689. linecap?: SeriesLinecapValue;
  45690. /**
  45691. * (Highcharts, Highstock) Pixel width of the graph line.
  45692. */
  45693. lineWidth?: number;
  45694. /**
  45695. * (Highcharts, Highstock, Gantt) The id of another series to link to.
  45696. * Additionally, the value can be ":previous" to link to the previous
  45697. * series. When two series are linked, only the first one appears in the
  45698. * legend. Toggling the visibility of this also toggles the linked series.
  45699. *
  45700. * If master series uses data sorting and linked series does not have its
  45701. * own sorting definition, the linked series will be sorted in the same
  45702. * order as the master one.
  45703. */
  45704. linkedTo?: string;
  45705. /**
  45706. * (Highstock) Options for the corresponding navigator series if
  45707. * `showInNavigator` is `true` for this series. Available options are the
  45708. * same as any series, documented at plotOptions and series.
  45709. *
  45710. * These options are merged with options in navigator.series, and will take
  45711. * precedence if the same option is defined both places.
  45712. */
  45713. navigatorOptions?: PlotSeriesOptions;
  45714. /**
  45715. * (Highcharts) Opacity of a series parts: line, fill (e.g. area) and
  45716. * dataLabels.
  45717. */
  45718. opacity?: number;
  45719. /**
  45720. * (Highcharts) Allow the dial to overshoot the end of the perimeter axis by
  45721. * this many degrees. Say if the gauge axis goes from 0 to 60, a value of
  45722. * 100, or 1000, will show 5 degrees beyond the end of the axis when this
  45723. * option is set to 5.
  45724. */
  45725. overshoot?: number;
  45726. /**
  45727. * (Highcharts) Options for the pivot or the center point of the gauge.
  45728. *
  45729. * In styled mode, the pivot is styled with the `.highcharts-gauge-series
  45730. * .highcharts-pivot` rule.
  45731. */
  45732. pivot?: PlotGaugePivotOptions;
  45733. /**
  45734. * (Highcharts) Properties for each single point.
  45735. */
  45736. point?: PlotSeriesPointOptions;
  45737. /**
  45738. * (Highcharts) Same as accessibility.pointDescriptionFormatter, but for an
  45739. * individual series. Overrides the chart wide configuration.
  45740. */
  45741. pointDescriptionFormatter?: Function;
  45742. /**
  45743. * (Highcharts, Highstock, Gantt) If no x values are given for the points in
  45744. * a series, `pointInterval` defines the interval of the x values. For
  45745. * example, if a series contains one value every decade starting from year
  45746. * 0, set `pointInterval` to `10`. In true `datetime` axes, the
  45747. * `pointInterval` is set in milliseconds.
  45748. *
  45749. * It can be also be combined with `pointIntervalUnit` to draw irregular
  45750. * time intervals.
  45751. *
  45752. * Please note that this options applies to the _series data_, not the
  45753. * interval of the axis ticks, which is independent.
  45754. */
  45755. pointInterval?: number;
  45756. /**
  45757. * (Highcharts, Highstock, Gantt) On datetime series, this allows for
  45758. * setting the pointInterval to irregular time units, `day`, `month` and
  45759. * `year`. A day is usually the same as 24 hours, but `pointIntervalUnit`
  45760. * also takes the DST crossover into consideration when dealing with local
  45761. * time. Combine this option with `pointInterval` to draw weeks, quarters, 6
  45762. * months, 10 years etc.
  45763. *
  45764. * Please note that this options applies to the _series data_, not the
  45765. * interval of the axis ticks, which is independent.
  45766. */
  45767. pointIntervalUnit?: OptionsPointIntervalUnitValue;
  45768. /**
  45769. * (Highstock) The width of each point on the x axis. For example in a
  45770. * column chart with one value each day, the pointRange would be 1 day (= 24
  45771. * * 3600
  45772. *
  45773. * * 1000 milliseconds). This is normally computed automatically, but this
  45774. * option can be used to override the automatic value.
  45775. */
  45776. pointRange?: number;
  45777. /**
  45778. * (Highcharts, Highstock, Gantt) If no x values are given for the points in
  45779. * a series, pointStart defines on what value to start. For example, if a
  45780. * series contains one yearly value starting from 1945, set pointStart to
  45781. * 1945.
  45782. */
  45783. pointStart?: number;
  45784. /**
  45785. * (Highcharts) Whether to select the series initially. If `showCheckbox` is
  45786. * true, the checkbox next to the series name in the legend will be checked
  45787. * for a selected series.
  45788. */
  45789. selected?: boolean;
  45790. /**
  45791. * (Highcharts) If true, a checkbox is displayed next to the legend item to
  45792. * allow selecting the series. The state of the checkbox is determined by
  45793. * the `selected` option.
  45794. */
  45795. showCheckbox?: boolean;
  45796. /**
  45797. * (Highcharts) Whether to display this particular series or series type in
  45798. * the legend. Defaults to false for gauge series.
  45799. */
  45800. showInLegend?: boolean;
  45801. /**
  45802. * (Highstock) Whether or not to show the series in the navigator. Takes
  45803. * precedence over navigator.baseSeries if defined.
  45804. */
  45805. showInNavigator?: boolean;
  45806. /**
  45807. * (Highcharts) If set to `true`, the accessibility module will skip past
  45808. * the points in this series for keyboard navigation.
  45809. */
  45810. skipKeyboardNavigation?: boolean;
  45811. /**
  45812. * (Highcharts) Sticky tracking of mouse events. When true, the `mouseOut`
  45813. * event on a series isn't triggered until the mouse moves over another
  45814. * series, or out of the plot area. When false, the `mouseOut` event on a
  45815. * series is triggered when the mouse leaves the area around the series'
  45816. * graph or markers. This also implies the tooltip when not shared. When
  45817. * `stickyTracking` is false and `tooltip.shared` is false, the tooltip will
  45818. * be hidden when moving the mouse between series. Defaults to true for line
  45819. * and area type series, but to false for columns, pies etc.
  45820. *
  45821. * **Note:** The boost module will force this option because of technical
  45822. * limitations.
  45823. */
  45824. stickyTracking?: boolean;
  45825. /**
  45826. * (Highcharts) A configuration object for the tooltip rendering of each
  45827. * single series. Properties are inherited from tooltip, but only the
  45828. * following properties can be defined on a series level.
  45829. */
  45830. tooltip?: SeriesTooltipOptionsObject;
  45831. /**
  45832. * (Highstock) The parameter allows setting line series type and use OHLC
  45833. * indicators. Data in OHLC format is required.
  45834. */
  45835. useOhlcData?: boolean;
  45836. /**
  45837. * (Highcharts) Set the initial visibility of the series.
  45838. */
  45839. visible?: boolean;
  45840. /**
  45841. * (Highcharts) When this option is `true`, the dial will wrap around the
  45842. * axes. For instance, in a full-range gauge going from 0 to 360, a value of
  45843. * 400 will point to 40\. When `wrap` is `false`, the dial stops at 360.
  45844. */
  45845. wrap?: boolean;
  45846. /**
  45847. * (Highmaps) Define the z index of the series.
  45848. */
  45849. zIndex?: number;
  45850. }
  45851. /**
  45852. * (Highcharts) Options for the pivot or the center point of the gauge.
  45853. *
  45854. * In styled mode, the pivot is styled with the `.highcharts-gauge-series
  45855. * .highcharts-pivot` rule.
  45856. */
  45857. export interface PlotGaugePivotOptions {
  45858. /**
  45859. * (Highcharts) The background color or fill of the pivot.
  45860. */
  45861. backgroundColor?: (ColorString|GradientColorObject|PatternObject);
  45862. /**
  45863. * (Highcharts) The border or stroke color of the pivot. In able to change
  45864. * this, the borderWidth must also be set to something other than the
  45865. * default 0.
  45866. */
  45867. borderColor?: (ColorString|GradientColorObject|PatternObject);
  45868. /**
  45869. * (Highcharts) The border or stroke width of the pivot.
  45870. */
  45871. borderWidth?: number;
  45872. /**
  45873. * (Highcharts) The pixel radius of the pivot.
  45874. */
  45875. radius?: number;
  45876. }
  45877. /**
  45878. * (Highcharts, Highmaps) Animation is disabled by default on the heatmap
  45879. * series.
  45880. */
  45881. export interface PlotHeatmapAnimationOptions {
  45882. defer?: number;
  45883. }
  45884. /**
  45885. * (Highcharts, Highstock, Highmaps, Gantt) Enable or disable the initial
  45886. * animation when a series is displayed for the `dataLabels`. The animation can
  45887. * also be set as a configuration object. Please note that this option only
  45888. * applies to the initial animation. For other animations, see chart.animation
  45889. * and the animation parameter under the API methods. The following properties
  45890. * are supported:
  45891. *
  45892. * - `defer`: The animation delay time in milliseconds.
  45893. */
  45894. export interface PlotHeatmapDataLabelsAnimationOptions {
  45895. /**
  45896. * (Highcharts, Highstock, Highmaps, Gantt) The animation delay time in
  45897. * milliseconds. Set to `0` renders dataLabel immediately. As `undefined`
  45898. * inherits defer time from the series.animation.defer.
  45899. */
  45900. defer?: number;
  45901. }
  45902. /**
  45903. * (Highcharts, Highstock, Highmaps, Gantt) Options for the series data labels,
  45904. * appearing next to each data point.
  45905. *
  45906. * Since v6.2.0, multiple data labels can be applied to each single point by
  45907. * defining them as an array of configs.
  45908. *
  45909. * In styled mode, the data labels can be styled with the
  45910. * `.highcharts-data-label-box` and `.highcharts-data-label` class names (see
  45911. * example).
  45912. */
  45913. export interface PlotHeatmapDataLabelsOptions {
  45914. /**
  45915. * (Highcharts, Highstock, Highmaps, Gantt) The alignment of the data label
  45916. * compared to the point. If `right`, the right side of the label should be
  45917. * touching the point. For points with an extent, like columns, the
  45918. * alignments also dictates how to align it inside the box, as given with
  45919. * the inside option. Can be one of `left`, `center` or `right`.
  45920. */
  45921. align?: (AlignValue|null);
  45922. /**
  45923. * (Highcharts, Highstock, Highmaps, Gantt) Whether to allow data labels to
  45924. * overlap. To make the labels less sensitive for overlapping, the
  45925. * dataLabels.padding can be set to 0.
  45926. */
  45927. allowOverlap?: boolean;
  45928. /**
  45929. * (Highcharts, Highstock, Highmaps, Gantt) Enable or disable the initial
  45930. * animation when a series is displayed for the `dataLabels`. The animation
  45931. * can also be set as a configuration object. Please note that this option
  45932. * only applies to the initial animation. For other animations, see
  45933. * chart.animation and the animation parameter under the API methods. The
  45934. * following properties are supported:
  45935. *
  45936. * - `defer`: The animation delay time in milliseconds.
  45937. */
  45938. animation?: (boolean|PlotHeatmapDataLabelsAnimationOptions|Partial<AnimationOptionsObject>);
  45939. /**
  45940. * (Highcharts, Highstock, Highmaps, Gantt) The background color or gradient
  45941. * for the data label.
  45942. */
  45943. backgroundColor?: (ColorString|GradientColorObject|PatternObject);
  45944. /**
  45945. * (Highcharts, Highstock, Highmaps, Gantt) The border color for the data
  45946. * label. Defaults to `undefined`.
  45947. */
  45948. borderColor?: (ColorString|GradientColorObject|PatternObject);
  45949. /**
  45950. * (Highcharts, Highstock, Highmaps, Gantt) The border radius in pixels for
  45951. * the data label.
  45952. */
  45953. borderRadius?: number;
  45954. /**
  45955. * (Highcharts, Highstock, Highmaps, Gantt) The border width in pixels for
  45956. * the data label.
  45957. */
  45958. borderWidth?: number;
  45959. /**
  45960. * (Highcharts, Highstock, Highmaps, Gantt) A class name for the data label.
  45961. * Particularly in styled mode, this can be used to give each series' or
  45962. * point's data label unique styling. In addition to this option, a default
  45963. * color class name is added so that we can give the labels a contrast text
  45964. * shadow.
  45965. */
  45966. className?: string;
  45967. /**
  45968. * (Highcharts, Highstock, Highmaps, Gantt) The text color for the data
  45969. * labels. Defaults to `undefined`. For certain series types, like column or
  45970. * map, the data labels can be drawn inside the points. In this case the
  45971. * data label will be drawn with maximum contrast by default. Additionally,
  45972. * it will be given a `text-outline` style with the opposite color, to
  45973. * further increase the contrast. This can be overridden by setting the
  45974. * `text-outline` style to `none` in the `dataLabels.style` option.
  45975. */
  45976. color?: (ColorString|GradientColorObject|PatternObject);
  45977. /**
  45978. * (Highcharts, Highstock, Highmaps, Gantt) Whether to hide data labels that
  45979. * are outside the plot area. By default, the data label is moved inside the
  45980. * plot area according to the overflow option.
  45981. */
  45982. crop?: boolean;
  45983. /**
  45984. * (Highcharts, Highstock, Gantt) Whether to defer displaying the data
  45985. * labels until the initial series animation has finished. Setting to
  45986. * `false` renders the data label immediately. If set to `true` inherits the
  45987. * defer time set in plotOptions.series.animation.
  45988. */
  45989. defer?: boolean;
  45990. /**
  45991. * (Highcharts, Highstock, Highmaps, Gantt) Enable or disable the data
  45992. * labels.
  45993. */
  45994. enabled?: boolean;
  45995. /**
  45996. * (Highcharts, Highstock, Highmaps, Gantt) A declarative filter to control
  45997. * of which data labels to display. The declarative filter is designed for
  45998. * use when callback functions are not available, like when the chart
  45999. * options require a pure JSON structure or for use with graphical editors.
  46000. * For programmatic control, use the `formatter` instead, and return
  46001. * `undefined` to disable a single data label.
  46002. */
  46003. filter?: DataLabelsFilterOptionsObject;
  46004. /**
  46005. * (Highcharts, Highstock, Highmaps, Gantt) A format string for the data
  46006. * label. Available variables are the same as for `formatter`.
  46007. */
  46008. format?: string;
  46009. /**
  46010. * (Highcharts, Highstock, Highmaps, Gantt) Callback JavaScript function to
  46011. * format the data label. Note that if a `format` is defined, the format
  46012. * takes precedence and the formatter is ignored.
  46013. */
  46014. formatter?: DataLabelsFormatterCallbackFunction;
  46015. /**
  46016. * (Highcharts, Highstock, Highmaps, Gantt) For points with an extent, like
  46017. * columns or map areas, whether to align the data label inside the box or
  46018. * to the actual value point. Defaults to `false` in most cases, `true` in
  46019. * stacked columns.
  46020. */
  46021. inside?: boolean;
  46022. /**
  46023. * (Highcharts, Highstock, Highmaps, Gantt) Format for points with the value
  46024. * of null. Works analogously to format. `nullFormat` can be applied only to
  46025. * series which support displaying null points.
  46026. */
  46027. nullFormat?: (boolean|string);
  46028. /**
  46029. * (Highcharts, Highstock, Highmaps, Gantt) Callback JavaScript function
  46030. * that defines formatting for points with the value of null. Works
  46031. * analogously to formatter. `nullPointFormatter` can be applied only to
  46032. * series which support displaying null points.
  46033. */
  46034. nullFormatter?: DataLabelsFormatterCallbackFunction;
  46035. /**
  46036. * (Highcharts, Highstock, Highmaps, Gantt) How to handle data labels that
  46037. * flow outside the plot area. The default is `"justify"`, which aligns them
  46038. * inside the plot area. For columns and bars, this means it will be moved
  46039. * inside the bar. To display data labels outside the plot area, set `crop`
  46040. * to `false` and `overflow` to `"allow"`.
  46041. */
  46042. overflow?: boolean;
  46043. /**
  46044. * (Highcharts, Highstock, Highmaps, Gantt) When either the `borderWidth` or
  46045. * the `backgroundColor` is set, this is the padding within the box.
  46046. */
  46047. padding?: number;
  46048. /**
  46049. * (Highcharts, Highstock, Highmaps, Gantt) Aligns data labels relative to
  46050. * points. If `center` alignment is not possible, it defaults to `right`.
  46051. */
  46052. position?: AlignValue;
  46053. /**
  46054. * (Highcharts, Highstock, Highmaps, Gantt) Text rotation in degrees. Note
  46055. * that due to a more complex structure, backgrounds, borders and padding
  46056. * will be lost on a rotated data label.
  46057. */
  46058. rotation?: number;
  46059. /**
  46060. * (Highcharts, Highstock, Highmaps, Gantt) The shadow of the box. Works
  46061. * best with `borderWidth` or `backgroundColor`. Since 2.3 the shadow can be
  46062. * an object configuration containing `color`, `offsetX`, `offsetY`,
  46063. * `opacity` and `width`.
  46064. */
  46065. shadow?: (boolean|ShadowOptionsObject);
  46066. /**
  46067. * (Highcharts, Highstock, Highmaps, Gantt) The name of a symbol to use for
  46068. * the border around the label. Symbols are predefined functions on the
  46069. * Renderer object.
  46070. */
  46071. shape?: string;
  46072. /**
  46073. * (Highcharts, Highstock, Highmaps, Gantt) Styles for the label. The
  46074. * default `color` setting is `"contrast"`, which is a pseudo color that
  46075. * Highcharts picks up and applies the maximum contrast to the underlying
  46076. * point item, for example the bar in a bar chart.
  46077. *
  46078. * The `textOutline` is a pseudo property that applies an outline of the
  46079. * given width with the given color, which by default is the maximum
  46080. * contrast to the text. So a bright text color will result in a black text
  46081. * outline for maximum readability on a mixed background. In some cases,
  46082. * especially with grayscale text, the text outline doesn't work well, in
  46083. * which cases it can be disabled by setting it to `"none"`. When `useHTML`
  46084. * is true, the `textOutline` will not be picked up. In this, case, the same
  46085. * effect can be acheived through the `text-shadow` CSS property.
  46086. *
  46087. * For some series types, where each point has an extent, like for example
  46088. * tree maps, the data label may overflow the point. There are two
  46089. * strategies for handling overflow. By default, the text will wrap to
  46090. * multiple lines. The other strategy is to set `style.textOverflow` to
  46091. * `ellipsis`, which will keep the text on one line plus it will break
  46092. * inside long words.
  46093. */
  46094. style?: CSSObject;
  46095. /**
  46096. * (Highcharts, Highstock, Highmaps, Gantt) Options for a label text which
  46097. * should follow marker's shape. Border and background are disabled for a
  46098. * label that follows a path.
  46099. *
  46100. * **Note:** Only SVG-based renderer supports this option. Setting `useHTML`
  46101. * to true will disable this option.
  46102. */
  46103. textPath?: DataLabelsTextPathOptionsObject;
  46104. /**
  46105. * (Highcharts, Highstock, Highmaps, Gantt) Whether to use HTML to render
  46106. * the labels.
  46107. */
  46108. useHTML?: boolean;
  46109. /**
  46110. * (Highcharts, Highstock, Highmaps, Gantt) The vertical alignment of a data
  46111. * label. Can be one of `top`, `middle` or `bottom`. The default value
  46112. * depends on the data, for instance in a column chart, the label is above
  46113. * positive values and below negative values.
  46114. */
  46115. verticalAlign?: string;
  46116. /**
  46117. * (Highcharts, Highstock, Highmaps, Gantt) The x position offset of the
  46118. * label relative to the point in pixels.
  46119. */
  46120. x?: number;
  46121. /**
  46122. * (Highcharts, Highstock, Highmaps, Gantt) The y position offset of the
  46123. * label relative to the point in pixels.
  46124. */
  46125. y?: number;
  46126. /**
  46127. * (Highcharts, Highstock, Highmaps, Gantt) The Z index of the data labels.
  46128. * The default Z index puts it above the series. Use a Z index of 2 to
  46129. * display it behind the series.
  46130. */
  46131. z?: number;
  46132. }
  46133. /**
  46134. * (Highcharts, Highstock) Options for the series data sorting.
  46135. */
  46136. export interface PlotHeatmapDataSortingOptions {
  46137. /**
  46138. * (Highcharts, Highstock) Enable or disable data sorting for the series.
  46139. * Use xAxis.reversed to change the sorting order.
  46140. */
  46141. enabled?: boolean;
  46142. /**
  46143. * (Highcharts, Highstock) Whether to allow matching points by name in an
  46144. * update. If this option is disabled, points will be matched by order.
  46145. */
  46146. matchByName?: boolean;
  46147. /**
  46148. * (Highcharts, Highstock) Determines what data value should be used to sort
  46149. * by.
  46150. */
  46151. sortKey?: string;
  46152. }
  46153. /**
  46154. * (Highcharts, Highmaps) Style options for the guide box. The guide box has one
  46155. * state by default, the `default` state.
  46156. */
  46157. export interface PlotHeatmapDragDropGuideBoxOptions {
  46158. /**
  46159. * (Highcharts, Highmaps) Style options for the guide box default state.
  46160. */
  46161. default?: DragDropGuideBoxOptionsObject;
  46162. }
  46163. /**
  46164. * (Highcharts, Highmaps) A heatmap is a graphical representation of data where
  46165. * the individual values contained in a matrix are represented as colors.
  46166. *
  46167. * In TypeScript the type option must always be set.
  46168. *
  46169. * Configuration options for the series are given in three levels:
  46170. *
  46171. * 1. Options for all series in a chart are defined in the plotOptions.series
  46172. * object.
  46173. *
  46174. * 2. Options for all `heatmap` series are defined in plotOptions.heatmap.
  46175. *
  46176. * 3. Options for one single series are given in the series instance array. (see
  46177. * online documentation for example)
  46178. */
  46179. export interface PlotHeatmapOptions {
  46180. /**
  46181. * (Highcharts, Highmaps) Accessibility options for a series.
  46182. */
  46183. accessibility?: SeriesAccessibilityOptionsObject;
  46184. /**
  46185. * (Highmaps) Whether all areas of the map defined in `mapData` should be
  46186. * rendered. If `true`, areas which don't correspond to a data point, are
  46187. * rendered as `null` points. If `false`, those areas are skipped.
  46188. */
  46189. allAreas?: boolean;
  46190. /**
  46191. * (Highcharts, Highmaps) Allow this series' points to be selected by
  46192. * clicking on the graphic (columns, point markers, pie slices, map areas
  46193. * etc).
  46194. *
  46195. * The selected points can be handled by point select and unselect events,
  46196. * or collectively by the getSelectedPoints function.
  46197. *
  46198. * And alternative way of selecting points is through dragging.
  46199. */
  46200. allowPointSelect?: boolean;
  46201. /**
  46202. * (Highcharts, Highmaps) Animation is disabled by default on the heatmap
  46203. * series.
  46204. */
  46205. animation?: (boolean|PlotHeatmapAnimationOptions);
  46206. /**
  46207. * (Highcharts, Highmaps) Sets the color blending in the boost module.
  46208. */
  46209. boostBlending?: OptionsBoostBlendingValue;
  46210. /**
  46211. * (Highcharts, Highmaps) Set the point threshold for when a series should
  46212. * enter boost mode.
  46213. *
  46214. * Setting it to e.g. 2000 will cause the series to enter boost mode when
  46215. * there are 2000 or more points in the series.
  46216. *
  46217. * To disable boosting on the series, set the `boostThreshold` to 0. Setting
  46218. * it to 1 will force boosting.
  46219. *
  46220. * Note that the cropThreshold also affects this setting. When zooming in on
  46221. * a series that has fewer points than the `cropThreshold`, all points are
  46222. * rendered although outside the visible plot area, and the `boostThreshold`
  46223. * won't take effect.
  46224. */
  46225. boostThreshold?: number;
  46226. /**
  46227. * (Highmaps) The border color of the map areas.
  46228. *
  46229. * In styled mode, the border stroke is given in the `.highcharts-point`
  46230. * class.
  46231. */
  46232. borderColor?: (ColorString|GradientColorObject|PatternObject);
  46233. /**
  46234. * (Highmaps) The border width for each heat map item.
  46235. */
  46236. borderWidth?: number;
  46237. /**
  46238. * (Highcharts, Highmaps) An additional class name to apply to the series'
  46239. * graphical elements. This option does not replace default class names of
  46240. * the graphical element.
  46241. */
  46242. className?: string;
  46243. /**
  46244. * (Highcharts, Highmaps) Disable this option to allow series rendering in
  46245. * the whole plotting area.
  46246. *
  46247. * **Note:** Clipping should be always enabled when chart.zoomType is set
  46248. */
  46249. clip?: boolean;
  46250. /**
  46251. * (Highcharts) The main color of the series. In heat maps this color is
  46252. * rarely used, as we mostly use the color to denote the value of each
  46253. * point. Unless options are set in the colorAxis, the default value is
  46254. * pulled from the options.colors array.
  46255. */
  46256. color?: (ColorString|GradientColorObject|PatternObject);
  46257. /**
  46258. * (Highcharts, Highstock, Highmaps) When using dual or multiple color axes,
  46259. * this number defines which colorAxis the particular series is connected
  46260. * to. It refers to either the axis id or the index of the axis in the
  46261. * colorAxis array, with 0 being the first. Set this option to false to
  46262. * prevent a series from connecting to the default color axis.
  46263. *
  46264. * Since v7.2.0 the option can also be an axis id or an axis index instead
  46265. * of a boolean flag.
  46266. */
  46267. colorAxis?: (boolean|number|string);
  46268. /**
  46269. * (Highcharts, Highmaps) Styled mode only. A specific color index to use
  46270. * for the series, so its graphic representations are given the class name
  46271. * `highcharts-color-{n}`.
  46272. */
  46273. colorIndex?: number;
  46274. /**
  46275. * (Highcharts, Highstock, Highmaps) Determines what data value should be
  46276. * used to calculate point color if `colorAxis` is used. Requires to set
  46277. * `min` and `max` if some custom point property is used or if approximation
  46278. * for data grouping is set to `'sum'`.
  46279. */
  46280. colorKey?: string;
  46281. /**
  46282. * (Highcharts, Highmaps) The column size - how many X axis units each
  46283. * column in the heatmap should span.
  46284. */
  46285. colsize?: number;
  46286. /**
  46287. * (Highstock) Compare the values of the series against the first non-null,
  46288. * non- zero value in the visible range. The y axis will show percentage or
  46289. * absolute change depending on whether `compare` is set to `"percent"` or
  46290. * `"value"`. When this is applied to multiple series, it allows comparing
  46291. * the development of the series against each other. Adds a `change` field
  46292. * to every point object.
  46293. */
  46294. compare?: string;
  46295. /**
  46296. * (Highstock) When compare is `percent`, this option dictates whether to
  46297. * use 0 or 100 as the base of comparison.
  46298. */
  46299. compareBase?: (0|100);
  46300. /**
  46301. * (Highstock) Defines if comparison should start from the first point
  46302. * within the visible range or should start from the first point **before**
  46303. * the range.
  46304. *
  46305. * In other words, this flag determines if first point within the visible
  46306. * range will have 0% (`compareStart=true`) or should have been already
  46307. * calculated according to the previous point (`compareStart=false`).
  46308. */
  46309. compareStart?: boolean;
  46310. /**
  46311. * (Gantt) Override Pathfinder connector options for a series. Requires
  46312. * Highcharts Gantt to be loaded.
  46313. */
  46314. connectors?: SeriesConnectorsOptionsObject;
  46315. /**
  46316. * (Highcharts, Highstock, Gantt) When true, each point or column edge is
  46317. * rounded to its nearest pixel in order to render sharp on screen. In some
  46318. * cases, when there are a lot of densely packed columns, this leads to
  46319. * visible difference in column widths or distance between columns. In these
  46320. * cases, setting `crisp` to `false` may look better, even though each
  46321. * column is rendered blurry.
  46322. */
  46323. crisp?: boolean;
  46324. /**
  46325. * (Highcharts, Highmaps) You can set the cursor to "pointer" if you have
  46326. * click events attached to the series, to signal to the user that the
  46327. * points and lines can be clicked.
  46328. *
  46329. * In styled mode, the series cursor can be set with the same classes as
  46330. * listed under series.color.
  46331. */
  46332. cursor?: (string|CursorValue);
  46333. /**
  46334. * (Highcharts, Highmaps) A reserved subspace to store options and values
  46335. * for customized functionality. Here you can add additional data for your
  46336. * own event callbacks and formatter callbacks.
  46337. */
  46338. custom?: Dictionary<any>;
  46339. /**
  46340. * (Highstock) Data grouping is the concept of sampling the data values into
  46341. * larger blocks in order to ease readability and increase performance of
  46342. * the JavaScript charts. Highstock by default applies data grouping when
  46343. * the points become closer than a certain pixel value, determined by the
  46344. * `groupPixelWidth` option.
  46345. *
  46346. * If data grouping is applied, the grouping information of grouped points
  46347. * can be read from the Point.dataGroup. If point options other than the
  46348. * data itself are set, for example `name` or `color` or custom properties,
  46349. * the grouping logic doesn't know how to group it. In this case the options
  46350. * of the first point instance are copied over to the group point. This can
  46351. * be altered through a custom `approximation` callback function.
  46352. */
  46353. dataGrouping?: DataGroupingOptionsObject;
  46354. /**
  46355. * (Highcharts, Highstock, Highmaps, Gantt) Options for the series data
  46356. * labels, appearing next to each data point.
  46357. *
  46358. * Since v6.2.0, multiple data labels can be applied to each single point by
  46359. * defining them as an array of configs.
  46360. *
  46361. * In styled mode, the data labels can be styled with the
  46362. * `.highcharts-data-label-box` and `.highcharts-data-label` class names
  46363. * (see example).
  46364. */
  46365. dataLabels?: (PlotHeatmapDataLabelsOptions|Array<PlotHeatmapDataLabelsOptions>);
  46366. /**
  46367. * (Highcharts, Highstock) Options for the series data sorting.
  46368. */
  46369. dataSorting?: (DataSortingOptionsObject|PlotHeatmapDataSortingOptions);
  46370. /**
  46371. * (Highcharts, Highmaps) A description of the series to add to the screen
  46372. * reader information about the series.
  46373. */
  46374. description?: string;
  46375. /**
  46376. * (Highcharts, Highmaps) The draggable-points module allows points to be
  46377. * moved around or modified in the chart. In addition to the options
  46378. * mentioned under the `dragDrop` API structure, the module fires three
  46379. * events, point.dragStart, point.drag and point.drop.
  46380. */
  46381. dragDrop?: SeriesDragDropOptionsObject;
  46382. /**
  46383. * (Highcharts, Highmaps) Enable or disable the mouse tracking for a
  46384. * specific series. This includes point tooltips and click events on graphs
  46385. * and points. For large datasets it improves performance.
  46386. */
  46387. enableMouseTracking?: boolean;
  46388. /**
  46389. * (Highcharts, Highmaps) General event handlers for the series items. These
  46390. * event hooks can also be attached to the series at run time using the
  46391. * `Highcharts.addEvent` function.
  46392. */
  46393. events?: SeriesEventsOptionsObject;
  46394. /**
  46395. * (Highstock) Defines when to display a gap in the graph, together with the
  46396. * gapUnit option.
  46397. *
  46398. * In case when `dataGrouping` is enabled, points can be grouped into a
  46399. * larger time span. This can make the grouped points to have a greater
  46400. * distance than the absolute value of `gapSize` property, which will result
  46401. * in disappearing graph completely. To prevent this situation the mentioned
  46402. * distance between grouped points is used instead of previously defined
  46403. * `gapSize`.
  46404. *
  46405. * In practice, this option is most often used to visualize gaps in time
  46406. * series. In a stock chart, intraday data is available for daytime hours,
  46407. * while gaps will appear in nights and weekends.
  46408. */
  46409. gapSize?: number;
  46410. /**
  46411. * (Highstock) Together with gapSize, this option defines where to draw gaps
  46412. * in the graph.
  46413. *
  46414. * When the `gapUnit` is `"relative"` (default), a gap size of 5 means that
  46415. * if the distance between two points is greater than 5 times that of the
  46416. * two closest points, the graph will be broken.
  46417. *
  46418. * When the `gapUnit` is `"value"`, the gap is based on absolute axis
  46419. * values, which on a datetime axis is milliseconds. This also applies to
  46420. * the navigator series that inherits gap options from the base series.
  46421. */
  46422. gapUnit?: OptionsGapUnitValue;
  46423. /**
  46424. * (Highcharts, Highmaps) When set to `false` will prevent the series data
  46425. * from being included in any form of data export.
  46426. *
  46427. * Since version 6.0.0 until 7.1.0 the option was existing undocumented as
  46428. * `includeInCSVExport`.
  46429. */
  46430. includeInDataExport?: boolean;
  46431. /**
  46432. * (Highmaps) What property to join the `mapData` to the value data. For
  46433. * example, if joinBy is "code", the mapData items with a specific code is
  46434. * merged into the data with the same code. For maps loaded from GeoJSON,
  46435. * the keys may be held in each point's `properties` object.
  46436. *
  46437. * The joinBy option can also be an array of two values, where the first
  46438. * points to a key in the `mapData`, and the second points to another key in
  46439. * the `data`.
  46440. *
  46441. * When joinBy is `null`, the map items are joined by their position in the
  46442. * array, which performs much better in maps with many data points. This is
  46443. * the recommended option if you are printing more than a thousand data
  46444. * points and have a backend that can preprocess the data into a parallel
  46445. * array of the mapData.
  46446. */
  46447. joinBy?: (string|Array<string>);
  46448. /**
  46449. * (Highcharts, Highmaps) An array specifying which option maps to which key
  46450. * in the data point array. This makes it convenient to work with
  46451. * unstructured data arrays from different sources.
  46452. */
  46453. keys?: Array<string>;
  46454. /**
  46455. * (Highcharts, Highstock, Gantt) Series labels are placed as close to the
  46456. * series as possible in a natural way, seeking to avoid other series. The
  46457. * goal of this feature is to make the chart more easily readable, like if a
  46458. * human designer placed the labels in the optimal position.
  46459. *
  46460. * The series labels currently work with series types having a `graph` or an
  46461. * `area`.
  46462. */
  46463. label?: SeriesLabelOptionsObject;
  46464. /**
  46465. * (Highstock) The line marks the last price from all points.
  46466. */
  46467. lastPrice?: SeriesLastPriceOptionsObject;
  46468. /**
  46469. * (Highstock) The line marks the last price from visible range of points.
  46470. */
  46471. lastVisiblePrice?: SeriesLastVisiblePriceOptionsObject;
  46472. /**
  46473. * (Highcharts, Highstock, Gantt) The id of another series to link to.
  46474. * Additionally, the value can be ":previous" to link to the previous
  46475. * series. When two series are linked, only the first one appears in the
  46476. * legend. Toggling the visibility of this also toggles the linked series.
  46477. *
  46478. * If master series uses data sorting and linked series does not have its
  46479. * own sorting definition, the linked series will be sorted in the same
  46480. * order as the master one.
  46481. */
  46482. linkedTo?: string;
  46483. /**
  46484. * (Highcharts, Highmaps) Options for the point markers of line-like series.
  46485. * Properties like `fillColor`, `lineColor` and `lineWidth` define the
  46486. * visual appearance of the markers. Other series types, like column series,
  46487. * don't have markers, but have visual options on the series level instead.
  46488. *
  46489. * In styled mode, the markers can be styled with the `.highcharts-point`,
  46490. * `.highcharts-point-hover` and `.highcharts-point-select` class names.
  46491. */
  46492. marker?: PointMarkerOptionsObject;
  46493. /**
  46494. * (Highstock) Options for the corresponding navigator series if
  46495. * `showInNavigator` is `true` for this series. Available options are the
  46496. * same as any series, documented at plotOptions and series.
  46497. *
  46498. * These options are merged with options in navigator.series, and will take
  46499. * precedence if the same option is defined both places.
  46500. */
  46501. navigatorOptions?: PlotSeriesOptions;
  46502. /**
  46503. * (Highcharts, Highmaps) The color for the parts of the graph or points
  46504. * that are below the threshold. Note that `zones` takes precedence over the
  46505. * negative color. Using `negativeColor` is equivalent to applying a zone
  46506. * with value of 0.
  46507. */
  46508. negativeColor?: (ColorString|GradientColorObject|PatternObject);
  46509. /**
  46510. * (Highcharts, Highmaps) The color applied to null points. In styled mode,
  46511. * a general CSS class is applied instead.
  46512. */
  46513. nullColor?: (ColorString|GradientColorObject|PatternObject);
  46514. /**
  46515. * (Highcharts, Highmaps) Opacity of a series parts: line, fill (e.g. area)
  46516. * and dataLabels.
  46517. */
  46518. opacity?: number;
  46519. /**
  46520. * (Highcharts, Highmaps) Properties for each single point.
  46521. */
  46522. point?: PlotSeriesPointOptions;
  46523. /**
  46524. * (Highcharts, Highmaps) Same as accessibility.pointDescriptionFormatter,
  46525. * but for an individual series. Overrides the chart wide configuration.
  46526. */
  46527. pointDescriptionFormatter?: Function;
  46528. /**
  46529. * (Highcharts, Highmaps) Padding between the points in the heatmap.
  46530. */
  46531. pointPadding?: number;
  46532. /**
  46533. * (Highcharts, Highmaps) The row size - how many Y axis units each heatmap
  46534. * row should span.
  46535. */
  46536. rowsize?: number;
  46537. /**
  46538. * (Highcharts, Highmaps) Whether to select the series initially. If
  46539. * `showCheckbox` is true, the checkbox next to the series name in the
  46540. * legend will be checked for a selected series.
  46541. */
  46542. selected?: boolean;
  46543. /**
  46544. * (Highcharts, Highmaps) If true, a checkbox is displayed next to the
  46545. * legend item to allow selecting the series. The state of the checkbox is
  46546. * determined by the `selected` option.
  46547. */
  46548. showCheckbox?: boolean;
  46549. /**
  46550. * (Highcharts, Highmaps) Whether to display this particular series or
  46551. * series type in the legend. Standalone series are shown in legend by
  46552. * default, and linked series are not. Since v7.2.0 it is possible to show
  46553. * series that use colorAxis by setting this option to `true`.
  46554. */
  46555. showInLegend?: boolean;
  46556. /**
  46557. * (Highstock) Whether or not to show the series in the navigator. Takes
  46558. * precedence over navigator.baseSeries if defined.
  46559. */
  46560. showInNavigator?: boolean;
  46561. /**
  46562. * (Highcharts, Highmaps) If set to `true`, the accessibility module will
  46563. * skip past the points in this series for keyboard navigation.
  46564. */
  46565. skipKeyboardNavigation?: boolean;
  46566. states?: SeriesStatesOptionsObject;
  46567. /**
  46568. * (Highcharts, Highstock) Sticky tracking of mouse events. When true, the
  46569. * `mouseOut` event on a series isn't triggered until the mouse moves over
  46570. * another series, or out of the plot area. When false, the `mouseOut` event
  46571. * on a series is triggered when the mouse leaves the area around the
  46572. * series' graph or markers. This also implies the tooltip. When
  46573. * `stickyTracking` is false and `tooltip.shared` is false, the tooltip will
  46574. * be hidden when moving the mouse between series.
  46575. */
  46576. stickyTracking?: boolean;
  46577. /**
  46578. * (Highcharts, Highstock) A configuration object for the tooltip rendering
  46579. * of each single series. Properties are inherited from tooltip. Overridable
  46580. * properties are `headerFormat`, `pointFormat`, `yDecimals`, `xDateFormat`,
  46581. * `yPrefix` and `ySuffix`. Unlike other series, in a scatter plot the
  46582. * series.name by default shows in the headerFormat and point.x and point.y
  46583. * in the pointFormat.
  46584. */
  46585. tooltip?: SeriesTooltipOptionsObject;
  46586. /**
  46587. * (Highcharts, Highstock, Gantt) When a series contains a data array that
  46588. * is longer than this, only one dimensional arrays of numbers, or two
  46589. * dimensional arrays with x and y values are allowed. Also, only the first
  46590. * point is tested, and the rest are assumed to be the same format. This
  46591. * saves expensive data checking and indexing in long series. Set it to `0`
  46592. * disable.
  46593. *
  46594. * Note: In boost mode turbo threshold is forced. Only array of numbers or
  46595. * two dimensional arrays are allowed.
  46596. */
  46597. turboThreshold?: number;
  46598. /**
  46599. * (Highcharts, Highmaps) Set the initial visibility of the series.
  46600. */
  46601. visible?: boolean;
  46602. /**
  46603. * (Highmaps) Define the z index of the series.
  46604. */
  46605. zIndex?: number;
  46606. /**
  46607. * (Highcharts, Highstock) Defines the Axis on which the zones are applied.
  46608. */
  46609. zoneAxis?: string;
  46610. /**
  46611. * (Highcharts, Highstock) An array defining zones within a series. Zones
  46612. * can be applied to the X axis, Y axis or Z axis for bubbles, according to
  46613. * the `zoneAxis` option. The zone definitions have to be in ascending order
  46614. * regarding to the value.
  46615. *
  46616. * In styled mode, the color zones are styled with the
  46617. * `.highcharts-zone-{n}` class, or custom classed from the `className`
  46618. * option (view live demo).
  46619. */
  46620. zones?: Array<SeriesZonesOptionsObject>;
  46621. }
  46622. /**
  46623. * (Highcharts) Enable or disable the initial animation when a series is
  46624. * displayed. The animation can also be set as a configuration object. Please
  46625. * note that this option only applies to the initial animation of the series
  46626. * itself. For other animations, see chart.animation and the animation parameter
  46627. * under the API methods. The following properties are supported:
  46628. *
  46629. * - `defer`: The animation delay time in milliseconds.
  46630. *
  46631. * - `duration`: The duration of the animation in milliseconds.
  46632. *
  46633. * - `easing`: Can be a string reference to an easing function set on the `Math`
  46634. * object or a function. See the _Custom easing function_ demo below.
  46635. *
  46636. * Due to poor performance, animation is disabled in old IE browsers for several
  46637. * chart types.
  46638. */
  46639. export interface PlotHistogramAnimationOptions {
  46640. defer?: number;
  46641. }
  46642. /**
  46643. * (Highcharts, Highstock, Highmaps, Gantt) Enable or disable the initial
  46644. * animation when a series is displayed for the `dataLabels`. The animation can
  46645. * also be set as a configuration object. Please note that this option only
  46646. * applies to the initial animation. For other animations, see chart.animation
  46647. * and the animation parameter under the API methods. The following properties
  46648. * are supported:
  46649. *
  46650. * - `defer`: The animation delay time in milliseconds.
  46651. */
  46652. export interface PlotHistogramDataLabelsAnimationOptions {
  46653. /**
  46654. * (Highcharts, Highstock, Highmaps, Gantt) The animation delay time in
  46655. * milliseconds. Set to `0` renders dataLabel immediately. As `undefined`
  46656. * inherits defer time from the series.animation.defer.
  46657. */
  46658. defer?: number;
  46659. }
  46660. /**
  46661. * (Highcharts, Highstock, Highmaps, Gantt) Options for the series data labels,
  46662. * appearing next to each data point.
  46663. *
  46664. * Since v6.2.0, multiple data labels can be applied to each single point by
  46665. * defining them as an array of configs.
  46666. *
  46667. * In styled mode, the data labels can be styled with the
  46668. * `.highcharts-data-label-box` and `.highcharts-data-label` class names (see
  46669. * example).
  46670. */
  46671. export interface PlotHistogramDataLabelsOptions {
  46672. /**
  46673. * (Highcharts, Highstock, Highmaps, Gantt) The alignment of the data label
  46674. * compared to the point. If `right`, the right side of the label should be
  46675. * touching the point. For points with an extent, like columns, the
  46676. * alignments also dictates how to align it inside the box, as given with
  46677. * the inside option. Can be one of `left`, `center` or `right`.
  46678. */
  46679. align?: string;
  46680. /**
  46681. * (Highcharts, Highstock, Highmaps, Gantt) Whether to allow data labels to
  46682. * overlap. To make the labels less sensitive for overlapping, the
  46683. * dataLabels.padding can be set to 0.
  46684. */
  46685. allowOverlap?: boolean;
  46686. /**
  46687. * (Highcharts, Highstock, Highmaps, Gantt) Enable or disable the initial
  46688. * animation when a series is displayed for the `dataLabels`. The animation
  46689. * can also be set as a configuration object. Please note that this option
  46690. * only applies to the initial animation. For other animations, see
  46691. * chart.animation and the animation parameter under the API methods. The
  46692. * following properties are supported:
  46693. *
  46694. * - `defer`: The animation delay time in milliseconds.
  46695. */
  46696. animation?: (boolean|PlotHistogramDataLabelsAnimationOptions|Partial<AnimationOptionsObject>);
  46697. /**
  46698. * (Highcharts, Highstock, Highmaps, Gantt) The background color or gradient
  46699. * for the data label.
  46700. */
  46701. backgroundColor?: (ColorString|GradientColorObject|PatternObject);
  46702. /**
  46703. * (Highcharts, Highstock, Highmaps, Gantt) The border color for the data
  46704. * label. Defaults to `undefined`.
  46705. */
  46706. borderColor?: (ColorString|GradientColorObject|PatternObject);
  46707. /**
  46708. * (Highcharts, Highstock, Highmaps, Gantt) The border radius in pixels for
  46709. * the data label.
  46710. */
  46711. borderRadius?: number;
  46712. /**
  46713. * (Highcharts, Highstock, Highmaps, Gantt) The border width in pixels for
  46714. * the data label.
  46715. */
  46716. borderWidth?: number;
  46717. /**
  46718. * (Highcharts, Highstock, Highmaps, Gantt) A class name for the data label.
  46719. * Particularly in styled mode, this can be used to give each series' or
  46720. * point's data label unique styling. In addition to this option, a default
  46721. * color class name is added so that we can give the labels a contrast text
  46722. * shadow.
  46723. */
  46724. className?: string;
  46725. /**
  46726. * (Highcharts, Highstock, Highmaps, Gantt) The text color for the data
  46727. * labels. Defaults to `undefined`. For certain series types, like column or
  46728. * map, the data labels can be drawn inside the points. In this case the
  46729. * data label will be drawn with maximum contrast by default. Additionally,
  46730. * it will be given a `text-outline` style with the opposite color, to
  46731. * further increase the contrast. This can be overridden by setting the
  46732. * `text-outline` style to `none` in the `dataLabels.style` option.
  46733. */
  46734. color?: (ColorString|GradientColorObject|PatternObject);
  46735. /**
  46736. * (Highcharts, Highstock, Highmaps, Gantt) Whether to hide data labels that
  46737. * are outside the plot area. By default, the data label is moved inside the
  46738. * plot area according to the overflow option.
  46739. */
  46740. crop?: boolean;
  46741. /**
  46742. * (Highcharts, Highstock, Gantt) Whether to defer displaying the data
  46743. * labels until the initial series animation has finished. Setting to
  46744. * `false` renders the data label immediately. If set to `true` inherits the
  46745. * defer time set in plotOptions.series.animation.
  46746. */
  46747. defer?: boolean;
  46748. /**
  46749. * (Highcharts, Highstock, Highmaps, Gantt) Enable or disable the data
  46750. * labels.
  46751. */
  46752. enabled?: boolean;
  46753. /**
  46754. * (Highcharts, Highstock, Highmaps, Gantt) A declarative filter to control
  46755. * of which data labels to display. The declarative filter is designed for
  46756. * use when callback functions are not available, like when the chart
  46757. * options require a pure JSON structure or for use with graphical editors.
  46758. * For programmatic control, use the `formatter` instead, and return
  46759. * `undefined` to disable a single data label.
  46760. */
  46761. filter?: DataLabelsFilterOptionsObject;
  46762. /**
  46763. * (Highcharts, Highstock, Highmaps, Gantt) A format string for the data
  46764. * label. Available variables are the same as for `formatter`.
  46765. */
  46766. format?: string;
  46767. /**
  46768. * (Highcharts, Highstock, Highmaps, Gantt) Callback JavaScript function to
  46769. * format the data label. Note that if a `format` is defined, the format
  46770. * takes precedence and the formatter is ignored.
  46771. */
  46772. formatter?: DataLabelsFormatterCallbackFunction;
  46773. /**
  46774. * (Highcharts, Highstock, Highmaps, Gantt) For points with an extent, like
  46775. * columns or map areas, whether to align the data label inside the box or
  46776. * to the actual value point. Defaults to `false` in most cases, `true` in
  46777. * stacked columns.
  46778. */
  46779. inside?: boolean;
  46780. /**
  46781. * (Highcharts, Highstock, Highmaps, Gantt) Format for points with the value
  46782. * of null. Works analogously to format. `nullFormat` can be applied only to
  46783. * series which support displaying null points.
  46784. */
  46785. nullFormat?: (boolean|string);
  46786. /**
  46787. * (Highcharts, Highstock, Highmaps, Gantt) Callback JavaScript function
  46788. * that defines formatting for points with the value of null. Works
  46789. * analogously to formatter. `nullPointFormatter` can be applied only to
  46790. * series which support displaying null points.
  46791. */
  46792. nullFormatter?: DataLabelsFormatterCallbackFunction;
  46793. /**
  46794. * (Highcharts, Highstock, Highmaps, Gantt) How to handle data labels that
  46795. * flow outside the plot area. The default is `"justify"`, which aligns them
  46796. * inside the plot area. For columns and bars, this means it will be moved
  46797. * inside the bar. To display data labels outside the plot area, set `crop`
  46798. * to `false` and `overflow` to `"allow"`.
  46799. */
  46800. overflow?: DataLabelsOverflowValue;
  46801. /**
  46802. * (Highcharts, Highstock, Highmaps, Gantt) When either the `borderWidth` or
  46803. * the `backgroundColor` is set, this is the padding within the box.
  46804. */
  46805. padding?: number;
  46806. /**
  46807. * (Highcharts, Highstock, Highmaps, Gantt) Aligns data labels relative to
  46808. * points. If `center` alignment is not possible, it defaults to `right`.
  46809. */
  46810. position?: AlignValue;
  46811. /**
  46812. * (Highcharts, Highstock, Highmaps, Gantt) Text rotation in degrees. Note
  46813. * that due to a more complex structure, backgrounds, borders and padding
  46814. * will be lost on a rotated data label.
  46815. */
  46816. rotation?: number;
  46817. /**
  46818. * (Highcharts, Highstock, Highmaps, Gantt) The shadow of the box. Works
  46819. * best with `borderWidth` or `backgroundColor`. Since 2.3 the shadow can be
  46820. * an object configuration containing `color`, `offsetX`, `offsetY`,
  46821. * `opacity` and `width`.
  46822. */
  46823. shadow?: (boolean|ShadowOptionsObject);
  46824. /**
  46825. * (Highcharts, Highstock, Highmaps, Gantt) The name of a symbol to use for
  46826. * the border around the label. Symbols are predefined functions on the
  46827. * Renderer object.
  46828. */
  46829. shape?: string;
  46830. /**
  46831. * (Highcharts, Highstock, Highmaps, Gantt) Styles for the label. The
  46832. * default `color` setting is `"contrast"`, which is a pseudo color that
  46833. * Highcharts picks up and applies the maximum contrast to the underlying
  46834. * point item, for example the bar in a bar chart.
  46835. *
  46836. * The `textOutline` is a pseudo property that applies an outline of the
  46837. * given width with the given color, which by default is the maximum
  46838. * contrast to the text. So a bright text color will result in a black text
  46839. * outline for maximum readability on a mixed background. In some cases,
  46840. * especially with grayscale text, the text outline doesn't work well, in
  46841. * which cases it can be disabled by setting it to `"none"`. When `useHTML`
  46842. * is true, the `textOutline` will not be picked up. In this, case, the same
  46843. * effect can be acheived through the `text-shadow` CSS property.
  46844. *
  46845. * For some series types, where each point has an extent, like for example
  46846. * tree maps, the data label may overflow the point. There are two
  46847. * strategies for handling overflow. By default, the text will wrap to
  46848. * multiple lines. The other strategy is to set `style.textOverflow` to
  46849. * `ellipsis`, which will keep the text on one line plus it will break
  46850. * inside long words.
  46851. */
  46852. style?: CSSObject;
  46853. /**
  46854. * (Highcharts, Highstock, Highmaps, Gantt) Options for a label text which
  46855. * should follow marker's shape. Border and background are disabled for a
  46856. * label that follows a path.
  46857. *
  46858. * **Note:** Only SVG-based renderer supports this option. Setting `useHTML`
  46859. * to true will disable this option.
  46860. */
  46861. textPath?: DataLabelsTextPathOptionsObject;
  46862. /**
  46863. * (Highcharts, Highstock, Highmaps, Gantt) Whether to use HTML to render
  46864. * the labels.
  46865. */
  46866. useHTML?: boolean;
  46867. /**
  46868. * (Highcharts, Highstock, Highmaps, Gantt) The vertical alignment of a data
  46869. * label. Can be one of `top`, `middle` or `bottom`. The default value
  46870. * depends on the data, for instance in a column chart, the label is above
  46871. * positive values and below negative values.
  46872. */
  46873. verticalAlign?: string;
  46874. /**
  46875. * (Highcharts, Highstock, Highmaps, Gantt) The x position offset of the
  46876. * label relative to the point in pixels.
  46877. */
  46878. x?: number;
  46879. /**
  46880. * (Highcharts, Highstock, Highmaps, Gantt) The y position offset of the
  46881. * label relative to the point in pixels.
  46882. */
  46883. y?: number;
  46884. /**
  46885. * (Highcharts, Highstock, Highmaps, Gantt) The Z index of the data labels.
  46886. * The default Z index puts it above the series. Use a Z index of 2 to
  46887. * display it behind the series.
  46888. */
  46889. z?: number;
  46890. }
  46891. /**
  46892. * (Highcharts, Highstock) Options for the series data sorting.
  46893. */
  46894. export interface PlotHistogramDataSortingOptions {
  46895. /**
  46896. * (Highcharts, Highstock) Enable or disable data sorting for the series.
  46897. * Use xAxis.reversed to change the sorting order.
  46898. */
  46899. enabled?: boolean;
  46900. /**
  46901. * (Highcharts, Highstock) Whether to allow matching points by name in an
  46902. * update. If this option is disabled, points will be matched by order.
  46903. */
  46904. matchByName?: boolean;
  46905. /**
  46906. * (Highcharts, Highstock) Determines what data value should be used to sort
  46907. * by.
  46908. */
  46909. sortKey?: string;
  46910. }
  46911. /**
  46912. * (Highcharts) A histogram is a column series which represents the distribution
  46913. * of the data set in the base series. Histogram splits data into bins and shows
  46914. * their frequencies.
  46915. *
  46916. * In TypeScript the type option must always be set.
  46917. *
  46918. * Configuration options for the series are given in three levels:
  46919. *
  46920. * 1. Options for all series in a chart are defined in the plotOptions.series
  46921. * object.
  46922. *
  46923. * 2. Options for all `histogram` series are defined in plotOptions.histogram.
  46924. *
  46925. * 3. Options for one single series are given in the series instance array. (see
  46926. * online documentation for example)
  46927. */
  46928. export interface PlotHistogramOptions {
  46929. /**
  46930. * (Highcharts) Accessibility options for a series.
  46931. */
  46932. accessibility?: SeriesAccessibilityOptionsObject;
  46933. /**
  46934. * (Highmaps) Whether all areas of the map defined in `mapData` should be
  46935. * rendered. If `true`, areas which don't correspond to a data point, are
  46936. * rendered as `null` points. If `false`, those areas are skipped.
  46937. */
  46938. allAreas?: boolean;
  46939. /**
  46940. * (Highcharts) Allow this series' points to be selected by clicking on the
  46941. * graphic (columns, point markers, pie slices, map areas etc).
  46942. *
  46943. * The selected points can be handled by point select and unselect events,
  46944. * or collectively by the getSelectedPoints function.
  46945. *
  46946. * And alternative way of selecting points is through dragging.
  46947. */
  46948. allowPointSelect?: boolean;
  46949. /**
  46950. * (Highcharts) Enable or disable the initial animation when a series is
  46951. * displayed. The animation can also be set as a configuration object.
  46952. * Please note that this option only applies to the initial animation of the
  46953. * series itself. For other animations, see chart.animation and the
  46954. * animation parameter under the API methods. The following properties are
  46955. * supported:
  46956. *
  46957. * - `defer`: The animation delay time in milliseconds.
  46958. *
  46959. * - `duration`: The duration of the animation in milliseconds.
  46960. *
  46961. * - `easing`: Can be a string reference to an easing function set on the
  46962. * `Math` object or a function. See the _Custom easing function_ demo below.
  46963. *
  46964. * Due to poor performance, animation is disabled in old IE browsers for
  46965. * several chart types.
  46966. */
  46967. animation?: (boolean|PlotHistogramAnimationOptions|Partial<AnimationOptionsObject>);
  46968. /**
  46969. * (Highcharts) For some series, there is a limit that shuts down initial
  46970. * animation by default when the total number of points in the chart is too
  46971. * high. For example, for a column chart and its derivatives, animation does
  46972. * not run if there is more than 250 points totally. To disable this cap,
  46973. * set `animationLimit` to `Infinity`.
  46974. */
  46975. animationLimit?: number;
  46976. /**
  46977. * (Highcharts) A preferable number of bins. It is a suggestion, so a
  46978. * histogram may have a different number of bins. By default it is set to
  46979. * the square root of the base series' data length. Available options are:
  46980. * `square-root`, `sturges`, `rice`. You can also define a function which
  46981. * takes a `baseSeries` as a parameter and should return a positive integer.
  46982. */
  46983. binsNumber?: ("rice"|"square-root"|"sturges"|number|Function);
  46984. /**
  46985. * (Highcharts) Width of each bin. By default the bin's width is calculated
  46986. * as `(max - min) / number of bins`. This option takes precedence over
  46987. * binsNumber.
  46988. */
  46989. binWidth?: number;
  46990. /**
  46991. * (Highcharts, Highstock, Gantt) The color of the border surrounding each
  46992. * column or bar.
  46993. *
  46994. * In styled mode, the border stroke can be set with the `.highcharts-point`
  46995. * rule.
  46996. */
  46997. borderColor?: (ColorString|GradientColorObject|PatternObject);
  46998. /**
  46999. * (Highcharts, Highstock, Gantt) The corner radius of the border
  47000. * surrounding each column or bar.
  47001. */
  47002. borderRadius?: number;
  47003. /**
  47004. * (Highcharts, Highstock, Gantt) The width of the border surrounding each
  47005. * column or bar. Defaults to `1` when there is room for a border, but to
  47006. * `0` when the columns are so dense that a border would cover the next
  47007. * column.
  47008. *
  47009. * In styled mode, the stroke width can be set with the `.highcharts-point`
  47010. * rule.
  47011. */
  47012. borderWidth?: number;
  47013. /**
  47014. * (Highcharts, Highstock, Gantt) When `true`, the columns will center in
  47015. * the category, ignoring null or missing points. When `false`, space will
  47016. * be reserved for null or missing points.
  47017. */
  47018. centerInCategory?: boolean;
  47019. /**
  47020. * (Highcharts) An additional class name to apply to the series' graphical
  47021. * elements. This option does not replace default class names of the
  47022. * graphical element.
  47023. */
  47024. className?: string;
  47025. /**
  47026. * (Highcharts) Disable this option to allow series rendering in the whole
  47027. * plotting area.
  47028. *
  47029. * **Note:** Clipping should be always enabled when chart.zoomType is set
  47030. */
  47031. clip?: boolean;
  47032. /**
  47033. * (Highcharts) The main color of the series. In line type series it applies
  47034. * to the line and the point markers unless otherwise specified. In bar type
  47035. * series it applies to the bars unless a color is specified per point. The
  47036. * default value is pulled from the `options.colors` array.
  47037. *
  47038. * In styled mode, the color can be defined by the colorIndex option. Also,
  47039. * the series color can be set with the `.highcharts-series`,
  47040. * `.highcharts-color-{n}`, `.highcharts-{type}-series` or
  47041. * `.highcharts-series-{n}` class, or individual classes given by the
  47042. * `className` option.
  47043. */
  47044. color?: (ColorString|GradientColorObject|PatternObject);
  47045. /**
  47046. * (Highcharts, Highstock, Highmaps) When using dual or multiple color axes,
  47047. * this number defines which colorAxis the particular series is connected
  47048. * to. It refers to either the axis id or the index of the axis in the
  47049. * colorAxis array, with 0 being the first. Set this option to false to
  47050. * prevent a series from connecting to the default color axis.
  47051. *
  47052. * Since v7.2.0 the option can also be an axis id or an axis index instead
  47053. * of a boolean flag.
  47054. */
  47055. colorAxis?: (boolean|number|string);
  47056. /**
  47057. * (Highcharts, Highstock, Gantt) When using automatic point colors pulled
  47058. * from the global colors or series-specific plotOptions.column.colors
  47059. * collections, this option determines whether the chart should receive one
  47060. * color per series or one color per point.
  47061. *
  47062. * In styled mode, the `colors` or `series.colors` arrays are not supported,
  47063. * and instead this option gives the points individual color class names on
  47064. * the form `highcharts-color-{n}`.
  47065. */
  47066. colorByPoint?: boolean;
  47067. /**
  47068. * (Highcharts) Styled mode only. A specific color index to use for the
  47069. * series, so its graphic representations are given the class name
  47070. * `highcharts-color-{n}`.
  47071. */
  47072. colorIndex?: number;
  47073. /**
  47074. * (Highcharts, Highstock, Highmaps) Determines what data value should be
  47075. * used to calculate point color if `colorAxis` is used. Requires to set
  47076. * `min` and `max` if some custom point property is used or if approximation
  47077. * for data grouping is set to `'sum'`.
  47078. */
  47079. colorKey?: string;
  47080. /**
  47081. * (Highcharts, Highstock, Gantt) A series specific or series type specific
  47082. * color set to apply instead of the global colors when colorByPoint is
  47083. * true.
  47084. */
  47085. colors?: Array<(ColorString|GradientColorObject|PatternObject)>;
  47086. /**
  47087. * (Highstock) Compare the values of the series against the first non-null,
  47088. * non- zero value in the visible range. The y axis will show percentage or
  47089. * absolute change depending on whether `compare` is set to `"percent"` or
  47090. * `"value"`. When this is applied to multiple series, it allows comparing
  47091. * the development of the series against each other. Adds a `change` field
  47092. * to every point object.
  47093. */
  47094. compare?: string;
  47095. /**
  47096. * (Highstock) When compare is `percent`, this option dictates whether to
  47097. * use 0 or 100 as the base of comparison.
  47098. */
  47099. compareBase?: (0|100);
  47100. /**
  47101. * (Highstock) Defines if comparison should start from the first point
  47102. * within the visible range or should start from the first point **before**
  47103. * the range.
  47104. *
  47105. * In other words, this flag determines if first point within the visible
  47106. * range will have 0% (`compareStart=true`) or should have been already
  47107. * calculated according to the previous point (`compareStart=false`).
  47108. */
  47109. compareStart?: boolean;
  47110. /**
  47111. * (Gantt) Override Pathfinder connector options for a series. Requires
  47112. * Highcharts Gantt to be loaded.
  47113. */
  47114. connectors?: SeriesConnectorsOptionsObject;
  47115. /**
  47116. * (Highcharts, Highstock, Gantt) When true, each point or column edge is
  47117. * rounded to its nearest pixel in order to render sharp on screen. In some
  47118. * cases, when there are a lot of densely packed columns, this leads to
  47119. * visible difference in column widths or distance between columns. In these
  47120. * cases, setting `crisp` to `false` may look better, even though each
  47121. * column is rendered blurry.
  47122. */
  47123. crisp?: boolean;
  47124. /**
  47125. * (Highcharts, Highstock, Gantt) When the series contains less points than
  47126. * the crop threshold, all points are drawn, event if the points fall
  47127. * outside the visible plot area at the current zoom. The advantage of
  47128. * drawing all points (including markers and columns), is that animation is
  47129. * performed on updates. On the other hand, when the series contains more
  47130. * points than the crop threshold, the series data is cropped to only
  47131. * contain points that fall within the plot area. The advantage of cropping
  47132. * away invisible points is to increase performance on large series.
  47133. */
  47134. cropThreshold?: number;
  47135. /**
  47136. * (Highcharts) You can set the cursor to "pointer" if you have click events
  47137. * attached to the series, to signal to the user that the points and lines
  47138. * can be clicked.
  47139. *
  47140. * In styled mode, the series cursor can be set with the same classes as
  47141. * listed under series.color.
  47142. */
  47143. cursor?: (string|CursorValue);
  47144. /**
  47145. * (Highcharts) A reserved subspace to store options and values for
  47146. * customized functionality. Here you can add additional data for your own
  47147. * event callbacks and formatter callbacks.
  47148. */
  47149. custom?: Dictionary<any>;
  47150. /**
  47151. * (Highcharts) Name of the dash style to use for the graph, or for some
  47152. * series types the outline of each shape.
  47153. *
  47154. * In styled mode, the stroke dash-array can be set with the same classes as
  47155. * listed under series.color.
  47156. */
  47157. dashStyle?: DashStyleValue;
  47158. /**
  47159. * (Highstock) Data grouping is the concept of sampling the data values into
  47160. * larger blocks in order to ease readability and increase performance of
  47161. * the JavaScript charts. Highstock by default applies data grouping when
  47162. * the points become closer than a certain pixel value, determined by the
  47163. * `groupPixelWidth` option.
  47164. *
  47165. * If data grouping is applied, the grouping information of grouped points
  47166. * can be read from the Point.dataGroup. If point options other than the
  47167. * data itself are set, for example `name` or `color` or custom properties,
  47168. * the grouping logic doesn't know how to group it. In this case the options
  47169. * of the first point instance are copied over to the group point. This can
  47170. * be altered through a custom `approximation` callback function.
  47171. */
  47172. dataGrouping?: DataGroupingOptionsObject;
  47173. /**
  47174. * (Highcharts, Highstock, Highmaps, Gantt) Options for the series data
  47175. * labels, appearing next to each data point.
  47176. *
  47177. * Since v6.2.0, multiple data labels can be applied to each single point by
  47178. * defining them as an array of configs.
  47179. *
  47180. * In styled mode, the data labels can be styled with the
  47181. * `.highcharts-data-label-box` and `.highcharts-data-label` class names
  47182. * (see example).
  47183. */
  47184. dataLabels?: (PlotHistogramDataLabelsOptions|Array<PlotHistogramDataLabelsOptions>);
  47185. /**
  47186. * (Highcharts, Highstock) Options for the series data sorting.
  47187. */
  47188. dataSorting?: (DataSortingOptionsObject|PlotHistogramDataSortingOptions);
  47189. /**
  47190. * (Highcharts) Depth of the columns in a 3D column chart.
  47191. */
  47192. depth?: number;
  47193. /**
  47194. * (Highcharts) A description of the series to add to the screen reader
  47195. * information about the series.
  47196. */
  47197. description?: string;
  47198. /**
  47199. * (Highcharts) 3D columns only. The color of the edges. Similar to
  47200. * `borderColor`, except it defaults to the same color as the column.
  47201. */
  47202. edgeColor?: ColorString;
  47203. /**
  47204. * (Highcharts) 3D columns only. The width of the colored edges.
  47205. */
  47206. edgeWidth?: number;
  47207. /**
  47208. * (Highcharts) Enable or disable the mouse tracking for a specific series.
  47209. * This includes point tooltips and click events on graphs and points. For
  47210. * large datasets it improves performance.
  47211. */
  47212. enableMouseTracking?: boolean;
  47213. /**
  47214. * (Highcharts) General event handlers for the series items. These event
  47215. * hooks can also be attached to the series at run time using the
  47216. * `Highcharts.addEvent` function.
  47217. */
  47218. events?: SeriesEventsOptionsObject;
  47219. /**
  47220. * (Highcharts) Determines whether the series should look for the nearest
  47221. * point in both dimensions or just the x-dimension when hovering the
  47222. * series. Defaults to `'xy'` for scatter series and `'x'` for most other
  47223. * series. If the data has duplicate x-values, it is recommended to set this
  47224. * to `'xy'` to allow hovering over all points.
  47225. *
  47226. * Applies only to series types using nearest neighbor search (not direct
  47227. * hover) for tooltip.
  47228. */
  47229. findNearestPointBy?: OptionsFindNearestPointByValue;
  47230. /**
  47231. * (Highcharts, Highstock, Gantt) Whether to use the Y extremes of the total
  47232. * chart width or only the zoomed area when zooming in on parts of the X
  47233. * axis. By default, the Y axis adjusts to the min and max of the visible
  47234. * data. Cartesian series only.
  47235. */
  47236. getExtremesFromAll?: boolean;
  47237. /**
  47238. * (Highcharts, Highstock, Gantt) Whether to group non-stacked columns or to
  47239. * let them render independent of each other. Non-grouped columns will be
  47240. * laid out individually and overlap each other.
  47241. */
  47242. grouping?: boolean;
  47243. /**
  47244. * (Highcharts, Highstock, Gantt) Padding between each value groups, in x
  47245. * axis units.
  47246. */
  47247. groupPadding?: number;
  47248. /**
  47249. * (Highcharts) The spacing between columns on the Z Axis in a 3D chart.
  47250. */
  47251. groupZPadding?: number;
  47252. /**
  47253. * (Highcharts) When set to `false` will prevent the series data from being
  47254. * included in any form of data export.
  47255. *
  47256. * Since version 6.0.0 until 7.1.0 the option was existing undocumented as
  47257. * `includeInCSVExport`.
  47258. */
  47259. includeInDataExport?: boolean;
  47260. /**
  47261. * (Highmaps) What property to join the `mapData` to the value data. For
  47262. * example, if joinBy is "code", the mapData items with a specific code is
  47263. * merged into the data with the same code. For maps loaded from GeoJSON,
  47264. * the keys may be held in each point's `properties` object.
  47265. *
  47266. * The joinBy option can also be an array of two values, where the first
  47267. * points to a key in the `mapData`, and the second points to another key in
  47268. * the `data`.
  47269. *
  47270. * When joinBy is `null`, the map items are joined by their position in the
  47271. * array, which performs much better in maps with many data points. This is
  47272. * the recommended option if you are printing more than a thousand data
  47273. * points and have a backend that can preprocess the data into a parallel
  47274. * array of the mapData.
  47275. */
  47276. joinBy?: (string|Array<string>);
  47277. /**
  47278. * (Highcharts) An array specifying which option maps to which key in the
  47279. * data point array. This makes it convenient to work with unstructured data
  47280. * arrays from different sources.
  47281. */
  47282. keys?: Array<string>;
  47283. /**
  47284. * (Highcharts, Highstock, Gantt) Series labels are placed as close to the
  47285. * series as possible in a natural way, seeking to avoid other series. The
  47286. * goal of this feature is to make the chart more easily readable, like if a
  47287. * human designer placed the labels in the optimal position.
  47288. *
  47289. * The series labels currently work with series types having a `graph` or an
  47290. * `area`.
  47291. */
  47292. label?: SeriesLabelOptionsObject;
  47293. /**
  47294. * (Highstock) The line marks the last price from all points.
  47295. */
  47296. lastPrice?: SeriesLastPriceOptionsObject;
  47297. /**
  47298. * (Highstock) The line marks the last price from visible range of points.
  47299. */
  47300. lastVisiblePrice?: SeriesLastVisiblePriceOptionsObject;
  47301. /**
  47302. * (Highcharts, Highstock, Gantt) The id of another series to link to.
  47303. * Additionally, the value can be ":previous" to link to the previous
  47304. * series. When two series are linked, only the first one appears in the
  47305. * legend. Toggling the visibility of this also toggles the linked series.
  47306. *
  47307. * If master series uses data sorting and linked series does not have its
  47308. * own sorting definition, the linked series will be sorted in the same
  47309. * order as the master one.
  47310. */
  47311. linkedTo?: string;
  47312. /**
  47313. * (Highcharts, Highstock, Gantt) The maximum allowed pixel width for a
  47314. * column, translated to the height of a bar in a bar chart. This prevents
  47315. * the columns from becoming too wide when there is a small number of points
  47316. * in the chart.
  47317. */
  47318. maxPointWidth?: number;
  47319. /**
  47320. * (Highcharts, Highstock, Gantt) The minimal height for a column or width
  47321. * for a bar. By default, 0 values are not shown. To visualize a 0 (or close
  47322. * to zero) point, set the minimal point length to a pixel value like 3\. In
  47323. * stacked column charts, minPointLength might not be respected for tightly
  47324. * packed values.
  47325. */
  47326. minPointLength?: number;
  47327. /**
  47328. * (Highstock) Options for the corresponding navigator series if
  47329. * `showInNavigator` is `true` for this series. Available options are the
  47330. * same as any series, documented at plotOptions and series.
  47331. *
  47332. * These options are merged with options in navigator.series, and will take
  47333. * precedence if the same option is defined both places.
  47334. */
  47335. navigatorOptions?: PlotSeriesOptions;
  47336. /**
  47337. * (Highcharts) The color for the parts of the graph or points that are
  47338. * below the threshold. Note that `zones` takes precedence over the negative
  47339. * color. Using `negativeColor` is equivalent to applying a zone with value
  47340. * of 0.
  47341. */
  47342. negativeColor?: (ColorString|GradientColorObject|PatternObject);
  47343. /**
  47344. * (Highcharts) Opacity of a series parts: line, fill (e.g. area) and
  47345. * dataLabels.
  47346. */
  47347. opacity?: number;
  47348. /**
  47349. * (Highcharts) Properties for each single point.
  47350. */
  47351. point?: PlotSeriesPointOptions;
  47352. /**
  47353. * (Highcharts) Same as accessibility.pointDescriptionFormatter, but for an
  47354. * individual series. Overrides the chart wide configuration.
  47355. */
  47356. pointDescriptionFormatter?: Function;
  47357. /**
  47358. * (Highcharts, Highstock, Gantt) Padding between each column or bar, in x
  47359. * axis units.
  47360. */
  47361. pointPadding?: number;
  47362. /**
  47363. * (Highcharts, Highstock, Gantt) Possible values: `"on"`, `"between"`,
  47364. * `number`.
  47365. *
  47366. * In a column chart, when pointPlacement is `"on"`, the point will not
  47367. * create any padding of the X axis. In a polar column chart this means that
  47368. * the first column points directly north. If the pointPlacement is
  47369. * `"between"`, the columns will be laid out between ticks. This is useful
  47370. * for example for visualising an amount between two points in time or in a
  47371. * certain sector of a polar chart.
  47372. *
  47373. * Since Highcharts 3.0.2, the point placement can also be numeric, where 0
  47374. * is on the axis value, -0.5 is between this value and the previous, and
  47375. * 0.5 is between this value and the next. Unlike the textual options,
  47376. * numeric point placement options won't affect axis padding.
  47377. *
  47378. * Note that pointPlacement needs a pointRange to work. For column series
  47379. * this is computed, but for line-type series it needs to be set.
  47380. *
  47381. * For the `xrange` series type and gantt charts, if the Y axis is a
  47382. * category axis, the `pointPlacement` applies to the Y axis rather than the
  47383. * (typically datetime) X axis.
  47384. *
  47385. * Defaults to `undefined` in cartesian charts, `"between"` in polar charts.
  47386. */
  47387. pointPlacement?: string;
  47388. /**
  47389. * (Highcharts, Highstock, Gantt) The X axis range that each point is valid
  47390. * for. This determines the width of the column. On a categorized axis, the
  47391. * range will be 1 by default (one category unit). On linear and datetime
  47392. * axes, the range will be computed as the distance between the two closest
  47393. * data points.
  47394. *
  47395. * The default `null` means it is computed automatically, but this option
  47396. * can be used to override the automatic value.
  47397. *
  47398. * This option is set by default to 1 if data sorting is enabled.
  47399. */
  47400. pointRange?: (number|null);
  47401. /**
  47402. * (Highcharts, Highstock, Gantt) If no x values are given for the points in
  47403. * a series, pointStart defines on what value to start. For example, if a
  47404. * series contains one yearly value starting from 1945, set pointStart to
  47405. * 1945.
  47406. */
  47407. pointStart?: number;
  47408. /**
  47409. * (Highcharts, Highstock, Gantt) A pixel value specifying a fixed width for
  47410. * each column or bar point. When set to `undefined`, the width is
  47411. * calculated from the `pointPadding` and `groupPadding`. The width effects
  47412. * the dimension that is not based on the point value. For column series it
  47413. * is the hoizontal length and for bar series it is the vertical length.
  47414. */
  47415. pointWidth?: number;
  47416. /**
  47417. * (Highcharts) Whether to select the series initially. If `showCheckbox` is
  47418. * true, the checkbox next to the series name in the legend will be checked
  47419. * for a selected series.
  47420. */
  47421. selected?: boolean;
  47422. /**
  47423. * (Highcharts) Whether to apply a drop shadow to the graph line. Since 2.3
  47424. * the shadow can be an object configuration containing `color`, `offsetX`,
  47425. * `offsetY`, `opacity` and `width`.
  47426. */
  47427. shadow?: (boolean|ShadowOptionsObject);
  47428. /**
  47429. * (Highcharts) If true, a checkbox is displayed next to the legend item to
  47430. * allow selecting the series. The state of the checkbox is determined by
  47431. * the `selected` option.
  47432. */
  47433. showCheckbox?: boolean;
  47434. /**
  47435. * (Highcharts) Whether to display this particular series or series type in
  47436. * the legend. Standalone series are shown in legend by default, and linked
  47437. * series are not. Since v7.2.0 it is possible to show series that use
  47438. * colorAxis by setting this option to `true`.
  47439. */
  47440. showInLegend?: boolean;
  47441. /**
  47442. * (Highstock) Whether or not to show the series in the navigator. Takes
  47443. * precedence over navigator.baseSeries if defined.
  47444. */
  47445. showInNavigator?: boolean;
  47446. /**
  47447. * (Highcharts) If set to `true`, the accessibility module will skip past
  47448. * the points in this series for keyboard navigation.
  47449. */
  47450. skipKeyboardNavigation?: boolean;
  47451. /**
  47452. * (Highcharts, Highstock) When this is true, the series will not cause the
  47453. * Y axis to cross the zero plane (or threshold option) unless the data
  47454. * actually crosses the plane.
  47455. *
  47456. * For example, if `softThreshold` is `false`, a series of 0, 1, 2, 3 will
  47457. * make the Y axis show negative values according to the `minPadding`
  47458. * option. If `softThreshold` is `true`, the Y axis starts at 0.
  47459. */
  47460. softThreshold?: boolean;
  47461. states?: SeriesStatesOptionsObject;
  47462. /**
  47463. * (Highcharts) Sticky tracking of mouse events. When true, the `mouseOut`
  47464. * event on a series isn't triggered until the mouse moves over another
  47465. * series, or out of the plot area. When false, the `mouseOut` event on a
  47466. * series is triggered when the mouse leaves the area around the series'
  47467. * graph or markers. This also implies the tooltip when not shared. When
  47468. * `stickyTracking` is false and `tooltip.shared` is false, the tooltip will
  47469. * be hidden when moving the mouse between series. Defaults to true for line
  47470. * and area type series, but to false for columns, pies etc.
  47471. *
  47472. * **Note:** The boost module will force this option because of technical
  47473. * limitations.
  47474. */
  47475. stickyTracking?: boolean;
  47476. /**
  47477. * (Highcharts) The Y axis value to serve as the base for the columns, for
  47478. * distinguishing between values above and below a threshold. If `null`, the
  47479. * columns extend from the padding Y axis minimum.
  47480. */
  47481. threshold?: (number|null);
  47482. /**
  47483. * (Highcharts) A configuration object for the tooltip rendering of each
  47484. * single series. Properties are inherited from tooltip, but only the
  47485. * following properties can be defined on a series level.
  47486. */
  47487. tooltip?: SeriesTooltipOptionsObject;
  47488. /**
  47489. * (Highcharts, Highstock, Gantt) When a series contains a data array that
  47490. * is longer than this, only one dimensional arrays of numbers, or two
  47491. * dimensional arrays with x and y values are allowed. Also, only the first
  47492. * point is tested, and the rest are assumed to be the same format. This
  47493. * saves expensive data checking and indexing in long series. Set it to `0`
  47494. * disable.
  47495. *
  47496. * Note: In boost mode turbo threshold is forced. Only array of numbers or
  47497. * two dimensional arrays are allowed.
  47498. */
  47499. turboThreshold?: number;
  47500. /**
  47501. * (Highcharts) Set the initial visibility of the series.
  47502. */
  47503. visible?: boolean;
  47504. /**
  47505. * (Highmaps) Define the z index of the series.
  47506. */
  47507. zIndex?: number;
  47508. /**
  47509. * (Highcharts, Highstock) Defines the Axis on which the zones are applied.
  47510. */
  47511. zoneAxis?: string;
  47512. /**
  47513. * (Highcharts, Highstock) An array defining zones within a series. Zones
  47514. * can be applied to the X axis, Y axis or Z axis for bubbles, according to
  47515. * the `zoneAxis` option. The zone definitions have to be in ascending order
  47516. * regarding to the value.
  47517. *
  47518. * In styled mode, the color zones are styled with the
  47519. * `.highcharts-zone-{n}` class, or custom classed from the `className`
  47520. * option (view live demo).
  47521. */
  47522. zones?: Array<SeriesZonesOptionsObject>;
  47523. }
  47524. /**
  47525. * (Highstock) Enable or disable the initial animation when a series is
  47526. * displayed. The animation can also be set as a configuration object. Please
  47527. * note that this option only applies to the initial animation of the series
  47528. * itself. For other animations, see chart.animation and the animation parameter
  47529. * under the API methods. The following properties are supported:
  47530. *
  47531. * - `defer`: The animation delay time in milliseconds.
  47532. *
  47533. * - `duration`: The duration of the animation in milliseconds.
  47534. *
  47535. * - `easing`: Can be a string reference to an easing function set on the `Math`
  47536. * object or a function. See the _Custom easing function_ demo below.
  47537. *
  47538. * Due to poor performance, animation is disabled in old IE browsers for several
  47539. * chart types.
  47540. */
  47541. export interface PlotIkhAnimationOptions {
  47542. defer?: number;
  47543. }
  47544. /**
  47545. * (Highstock) The styles for Chikou line
  47546. */
  47547. export interface PlotIkhChikouLineOptions {
  47548. styles?: PlotIkhChikouLineStylesOptions;
  47549. }
  47550. export interface PlotIkhChikouLineStylesOptions {
  47551. /**
  47552. * (Highstock) Color of the line.
  47553. */
  47554. lineColor?: ColorString;
  47555. /**
  47556. * (Highstock) Pixel width of the line.
  47557. */
  47558. lineWidth?: number;
  47559. }
  47560. /**
  47561. * (Highcharts, Highstock, Highmaps, Gantt) Enable or disable the initial
  47562. * animation when a series is displayed for the `dataLabels`. The animation can
  47563. * also be set as a configuration object. Please note that this option only
  47564. * applies to the initial animation. For other animations, see chart.animation
  47565. * and the animation parameter under the API methods. The following properties
  47566. * are supported:
  47567. *
  47568. * - `defer`: The animation delay time in milliseconds.
  47569. */
  47570. export interface PlotIkhDataLabelsAnimationOptions {
  47571. /**
  47572. * (Highcharts, Highstock, Highmaps, Gantt) The animation delay time in
  47573. * milliseconds. Set to `0` renders dataLabel immediately. As `undefined`
  47574. * inherits defer time from the series.animation.defer.
  47575. */
  47576. defer?: number;
  47577. }
  47578. /**
  47579. * (Highcharts, Highstock, Highmaps, Gantt) Options for the series data labels,
  47580. * appearing next to each data point.
  47581. *
  47582. * Since v6.2.0, multiple data labels can be applied to each single point by
  47583. * defining them as an array of configs.
  47584. *
  47585. * In styled mode, the data labels can be styled with the
  47586. * `.highcharts-data-label-box` and `.highcharts-data-label` class names (see
  47587. * example).
  47588. */
  47589. export interface PlotIkhDataLabelsOptions {
  47590. /**
  47591. * (Highcharts, Highstock, Highmaps, Gantt) The alignment of the data label
  47592. * compared to the point. If `right`, the right side of the label should be
  47593. * touching the point. For points with an extent, like columns, the
  47594. * alignments also dictates how to align it inside the box, as given with
  47595. * the inside option. Can be one of `left`, `center` or `right`.
  47596. */
  47597. align?: (AlignValue|null);
  47598. /**
  47599. * (Highcharts, Highstock, Highmaps, Gantt) Whether to allow data labels to
  47600. * overlap. To make the labels less sensitive for overlapping, the
  47601. * dataLabels.padding can be set to 0.
  47602. */
  47603. allowOverlap?: boolean;
  47604. /**
  47605. * (Highcharts, Highstock, Highmaps, Gantt) Enable or disable the initial
  47606. * animation when a series is displayed for the `dataLabels`. The animation
  47607. * can also be set as a configuration object. Please note that this option
  47608. * only applies to the initial animation. For other animations, see
  47609. * chart.animation and the animation parameter under the API methods. The
  47610. * following properties are supported:
  47611. *
  47612. * - `defer`: The animation delay time in milliseconds.
  47613. */
  47614. animation?: (boolean|PlotIkhDataLabelsAnimationOptions|Partial<AnimationOptionsObject>);
  47615. /**
  47616. * (Highcharts, Highstock, Highmaps, Gantt) The background color or gradient
  47617. * for the data label.
  47618. */
  47619. backgroundColor?: (ColorString|GradientColorObject|PatternObject);
  47620. /**
  47621. * (Highcharts, Highstock, Highmaps, Gantt) The border color for the data
  47622. * label. Defaults to `undefined`.
  47623. */
  47624. borderColor?: (ColorString|GradientColorObject|PatternObject);
  47625. /**
  47626. * (Highcharts, Highstock, Highmaps, Gantt) The border radius in pixels for
  47627. * the data label.
  47628. */
  47629. borderRadius?: number;
  47630. /**
  47631. * (Highcharts, Highstock, Highmaps, Gantt) The border width in pixels for
  47632. * the data label.
  47633. */
  47634. borderWidth?: number;
  47635. /**
  47636. * (Highcharts, Highstock, Highmaps, Gantt) A class name for the data label.
  47637. * Particularly in styled mode, this can be used to give each series' or
  47638. * point's data label unique styling. In addition to this option, a default
  47639. * color class name is added so that we can give the labels a contrast text
  47640. * shadow.
  47641. */
  47642. className?: string;
  47643. /**
  47644. * (Highcharts, Highstock, Highmaps, Gantt) The text color for the data
  47645. * labels. Defaults to `undefined`. For certain series types, like column or
  47646. * map, the data labels can be drawn inside the points. In this case the
  47647. * data label will be drawn with maximum contrast by default. Additionally,
  47648. * it will be given a `text-outline` style with the opposite color, to
  47649. * further increase the contrast. This can be overridden by setting the
  47650. * `text-outline` style to `none` in the `dataLabels.style` option.
  47651. */
  47652. color?: (ColorString|GradientColorObject|PatternObject);
  47653. /**
  47654. * (Highcharts, Highstock, Highmaps, Gantt) Whether to hide data labels that
  47655. * are outside the plot area. By default, the data label is moved inside the
  47656. * plot area according to the overflow option.
  47657. */
  47658. crop?: boolean;
  47659. /**
  47660. * (Highcharts, Highstock, Gantt) Whether to defer displaying the data
  47661. * labels until the initial series animation has finished. Setting to
  47662. * `false` renders the data label immediately. If set to `true` inherits the
  47663. * defer time set in plotOptions.series.animation.
  47664. */
  47665. defer?: boolean;
  47666. /**
  47667. * (Highcharts, Highstock, Highmaps, Gantt) Enable or disable the data
  47668. * labels.
  47669. */
  47670. enabled?: boolean;
  47671. /**
  47672. * (Highcharts, Highstock, Highmaps, Gantt) A declarative filter to control
  47673. * of which data labels to display. The declarative filter is designed for
  47674. * use when callback functions are not available, like when the chart
  47675. * options require a pure JSON structure or for use with graphical editors.
  47676. * For programmatic control, use the `formatter` instead, and return
  47677. * `undefined` to disable a single data label.
  47678. */
  47679. filter?: DataLabelsFilterOptionsObject;
  47680. /**
  47681. * (Highcharts, Highstock, Highmaps, Gantt) A format string for the data
  47682. * label. Available variables are the same as for `formatter`.
  47683. */
  47684. format?: string;
  47685. /**
  47686. * (Highcharts, Highstock, Highmaps, Gantt) Callback JavaScript function to
  47687. * format the data label. Note that if a `format` is defined, the format
  47688. * takes precedence and the formatter is ignored.
  47689. */
  47690. formatter?: DataLabelsFormatterCallbackFunction;
  47691. /**
  47692. * (Highcharts, Highstock, Highmaps, Gantt) For points with an extent, like
  47693. * columns or map areas, whether to align the data label inside the box or
  47694. * to the actual value point. Defaults to `false` in most cases, `true` in
  47695. * stacked columns.
  47696. */
  47697. inside?: boolean;
  47698. /**
  47699. * (Highcharts, Highstock, Highmaps, Gantt) Format for points with the value
  47700. * of null. Works analogously to format. `nullFormat` can be applied only to
  47701. * series which support displaying null points.
  47702. */
  47703. nullFormat?: (boolean|string);
  47704. /**
  47705. * (Highcharts, Highstock, Highmaps, Gantt) Callback JavaScript function
  47706. * that defines formatting for points with the value of null. Works
  47707. * analogously to formatter. `nullPointFormatter` can be applied only to
  47708. * series which support displaying null points.
  47709. */
  47710. nullFormatter?: DataLabelsFormatterCallbackFunction;
  47711. /**
  47712. * (Highcharts, Highstock, Highmaps, Gantt) How to handle data labels that
  47713. * flow outside the plot area. The default is `"justify"`, which aligns them
  47714. * inside the plot area. For columns and bars, this means it will be moved
  47715. * inside the bar. To display data labels outside the plot area, set `crop`
  47716. * to `false` and `overflow` to `"allow"`.
  47717. */
  47718. overflow?: DataLabelsOverflowValue;
  47719. /**
  47720. * (Highcharts, Highstock, Highmaps, Gantt) When either the `borderWidth` or
  47721. * the `backgroundColor` is set, this is the padding within the box.
  47722. */
  47723. padding?: number;
  47724. /**
  47725. * (Highcharts, Highstock, Highmaps, Gantt) Aligns data labels relative to
  47726. * points. If `center` alignment is not possible, it defaults to `right`.
  47727. */
  47728. position?: AlignValue;
  47729. /**
  47730. * (Highcharts, Highstock, Highmaps, Gantt) Text rotation in degrees. Note
  47731. * that due to a more complex structure, backgrounds, borders and padding
  47732. * will be lost on a rotated data label.
  47733. */
  47734. rotation?: number;
  47735. /**
  47736. * (Highcharts, Highstock, Highmaps, Gantt) The shadow of the box. Works
  47737. * best with `borderWidth` or `backgroundColor`. Since 2.3 the shadow can be
  47738. * an object configuration containing `color`, `offsetX`, `offsetY`,
  47739. * `opacity` and `width`.
  47740. */
  47741. shadow?: (boolean|ShadowOptionsObject);
  47742. /**
  47743. * (Highcharts, Highstock, Highmaps, Gantt) The name of a symbol to use for
  47744. * the border around the label. Symbols are predefined functions on the
  47745. * Renderer object.
  47746. */
  47747. shape?: string;
  47748. /**
  47749. * (Highcharts, Highstock, Highmaps, Gantt) Styles for the label. The
  47750. * default `color` setting is `"contrast"`, which is a pseudo color that
  47751. * Highcharts picks up and applies the maximum contrast to the underlying
  47752. * point item, for example the bar in a bar chart.
  47753. *
  47754. * The `textOutline` is a pseudo property that applies an outline of the
  47755. * given width with the given color, which by default is the maximum
  47756. * contrast to the text. So a bright text color will result in a black text
  47757. * outline for maximum readability on a mixed background. In some cases,
  47758. * especially with grayscale text, the text outline doesn't work well, in
  47759. * which cases it can be disabled by setting it to `"none"`. When `useHTML`
  47760. * is true, the `textOutline` will not be picked up. In this, case, the same
  47761. * effect can be acheived through the `text-shadow` CSS property.
  47762. *
  47763. * For some series types, where each point has an extent, like for example
  47764. * tree maps, the data label may overflow the point. There are two
  47765. * strategies for handling overflow. By default, the text will wrap to
  47766. * multiple lines. The other strategy is to set `style.textOverflow` to
  47767. * `ellipsis`, which will keep the text on one line plus it will break
  47768. * inside long words.
  47769. */
  47770. style?: CSSObject;
  47771. /**
  47772. * (Highcharts, Highstock, Highmaps, Gantt) Options for a label text which
  47773. * should follow marker's shape. Border and background are disabled for a
  47774. * label that follows a path.
  47775. *
  47776. * **Note:** Only SVG-based renderer supports this option. Setting `useHTML`
  47777. * to true will disable this option.
  47778. */
  47779. textPath?: DataLabelsTextPathOptionsObject;
  47780. /**
  47781. * (Highcharts, Highstock, Highmaps, Gantt) Whether to use HTML to render
  47782. * the labels.
  47783. */
  47784. useHTML?: boolean;
  47785. /**
  47786. * (Highcharts, Highstock, Highmaps, Gantt) The vertical alignment of a data
  47787. * label. Can be one of `top`, `middle` or `bottom`. The default value
  47788. * depends on the data, for instance in a column chart, the label is above
  47789. * positive values and below negative values.
  47790. */
  47791. verticalAlign?: (VerticalAlignValue|null);
  47792. /**
  47793. * (Highcharts, Highstock, Highmaps, Gantt) The x position offset of the
  47794. * label relative to the point in pixels.
  47795. */
  47796. x?: number;
  47797. /**
  47798. * (Highcharts, Highstock, Highmaps, Gantt) The y position offset of the
  47799. * label relative to the point in pixels.
  47800. */
  47801. y?: number;
  47802. /**
  47803. * (Highcharts, Highstock, Highmaps, Gantt) The Z index of the data labels.
  47804. * The default Z index puts it above the series. Use a Z index of 2 to
  47805. * display it behind the series.
  47806. */
  47807. z?: number;
  47808. }
  47809. /**
  47810. * (Highcharts, Highstock) Options for the series data sorting.
  47811. */
  47812. export interface PlotIkhDataSortingOptions {
  47813. /**
  47814. * (Highcharts, Highstock) Enable or disable data sorting for the series.
  47815. * Use xAxis.reversed to change the sorting order.
  47816. */
  47817. enabled?: boolean;
  47818. /**
  47819. * (Highcharts, Highstock) Whether to allow matching points by name in an
  47820. * update. If this option is disabled, points will be matched by order.
  47821. */
  47822. matchByName?: boolean;
  47823. /**
  47824. * (Highcharts, Highstock) Determines what data value should be used to sort
  47825. * by.
  47826. */
  47827. sortKey?: string;
  47828. }
  47829. /**
  47830. * (Highstock) The styles for Kijun line
  47831. */
  47832. export interface PlotIkhKijunLineOptions {
  47833. styles?: PlotIkhKijunLineStylesOptions;
  47834. }
  47835. export interface PlotIkhKijunLineStylesOptions {
  47836. /**
  47837. * (Highstock) Color of the line.
  47838. */
  47839. lineColor?: ColorString;
  47840. /**
  47841. * (Highstock) Pixel width of the line.
  47842. */
  47843. lineWidth?: number;
  47844. }
  47845. /**
  47846. * (Highstock) Ichimoku Kinko Hyo (IKH). This series requires `linkedTo` option
  47847. * to be set.
  47848. *
  47849. * In TypeScript the type option must always be set.
  47850. *
  47851. * Configuration options for the series are given in three levels:
  47852. *
  47853. * 1. Options for all series in a chart are defined in the plotOptions.series
  47854. * object.
  47855. *
  47856. * 2. Options for all `ikh` series are defined in plotOptions.ikh.
  47857. *
  47858. * 3. Options for one single series are given in the series instance array. (see
  47859. * online documentation for example)
  47860. */
  47861. export interface PlotIkhOptions {
  47862. /**
  47863. * (Highstock) Accessibility options for a series.
  47864. */
  47865. accessibility?: SeriesAccessibilityOptionsObject;
  47866. /**
  47867. * (Highstock) Allow this series' points to be selected by clicking on the
  47868. * graphic (columns, point markers, pie slices, map areas etc).
  47869. *
  47870. * The selected points can be handled by point select and unselect events,
  47871. * or collectively by the getSelectedPoints function.
  47872. *
  47873. * And alternative way of selecting points is through dragging.
  47874. */
  47875. allowPointSelect?: boolean;
  47876. /**
  47877. * (Highstock) Enable or disable the initial animation when a series is
  47878. * displayed. The animation can also be set as a configuration object.
  47879. * Please note that this option only applies to the initial animation of the
  47880. * series itself. For other animations, see chart.animation and the
  47881. * animation parameter under the API methods. The following properties are
  47882. * supported:
  47883. *
  47884. * - `defer`: The animation delay time in milliseconds.
  47885. *
  47886. * - `duration`: The duration of the animation in milliseconds.
  47887. *
  47888. * - `easing`: Can be a string reference to an easing function set on the
  47889. * `Math` object or a function. See the _Custom easing function_ demo below.
  47890. *
  47891. * Due to poor performance, animation is disabled in old IE browsers for
  47892. * several chart types.
  47893. */
  47894. animation?: (boolean|PlotIkhAnimationOptions|Partial<AnimationOptionsObject>);
  47895. /**
  47896. * (Highstock) For some series, there is a limit that shuts down initial
  47897. * animation by default when the total number of points in the chart is too
  47898. * high. For example, for a column chart and its derivatives, animation does
  47899. * not run if there is more than 250 points totally. To disable this cap,
  47900. * set `animationLimit` to `Infinity`.
  47901. */
  47902. animationLimit?: number;
  47903. /**
  47904. * (Highstock) Sets the color blending in the boost module.
  47905. */
  47906. boostBlending?: OptionsBoostBlendingValue;
  47907. /**
  47908. * (Highstock) Set the point threshold for when a series should enter boost
  47909. * mode.
  47910. *
  47911. * Setting it to e.g. 2000 will cause the series to enter boost mode when
  47912. * there are 2000 or more points in the series.
  47913. *
  47914. * To disable boosting on the series, set the `boostThreshold` to 0. Setting
  47915. * it to 1 will force boosting.
  47916. *
  47917. * Note that the cropThreshold also affects this setting. When zooming in on
  47918. * a series that has fewer points than the `cropThreshold`, all points are
  47919. * rendered although outside the visible plot area, and the `boostThreshold`
  47920. * won't take effect.
  47921. */
  47922. boostThreshold?: number;
  47923. /**
  47924. * (Highmaps) The border color of the map areas.
  47925. *
  47926. * In styled mode, the border stroke is given in the `.highcharts-point`
  47927. * class.
  47928. */
  47929. borderColor?: (ColorString|GradientColorObject|PatternObject);
  47930. /**
  47931. * (Highmaps) The border width of each map area.
  47932. *
  47933. * In styled mode, the border stroke width is given in the
  47934. * `.highcharts-point` class.
  47935. */
  47936. borderWidth?: number;
  47937. /**
  47938. * (Highstock) The styles for Chikou line
  47939. */
  47940. chikouLine?: PlotIkhChikouLineOptions;
  47941. /**
  47942. * (Highstock) An additional class name to apply to the series' graphical
  47943. * elements. This option does not replace default class names of the
  47944. * graphical element.
  47945. */
  47946. className?: string;
  47947. /**
  47948. * (Highstock) Disable this option to allow series rendering in the whole
  47949. * plotting area.
  47950. *
  47951. * **Note:** Clipping should be always enabled when chart.zoomType is set
  47952. */
  47953. clip?: boolean;
  47954. /**
  47955. * (Highstock) The main color of the series. In line type series it applies
  47956. * to the line and the point markers unless otherwise specified. In bar type
  47957. * series it applies to the bars unless a color is specified per point. The
  47958. * default value is pulled from the `options.colors` array.
  47959. *
  47960. * In styled mode, the color can be defined by the colorIndex option. Also,
  47961. * the series color can be set with the `.highcharts-series`,
  47962. * `.highcharts-color-{n}`, `.highcharts-{type}-series` or
  47963. * `.highcharts-series-{n}` class, or individual classes given by the
  47964. * `className` option.
  47965. */
  47966. color?: (ColorString|GradientColorObject|PatternObject);
  47967. /**
  47968. * (Highstock) Styled mode only. A specific color index to use for the
  47969. * series, so its graphic representations are given the class name
  47970. * `highcharts-color-{n}`.
  47971. */
  47972. colorIndex?: number;
  47973. /**
  47974. * (Highcharts, Highstock, Highmaps) Determines what data value should be
  47975. * used to calculate point color if `colorAxis` is used. Requires to set
  47976. * `min` and `max` if some custom point property is used or if approximation
  47977. * for data grouping is set to `'sum'`.
  47978. */
  47979. colorKey?: string;
  47980. /**
  47981. * (Highstock) Defines if comparison should start from the first point
  47982. * within the visible range or should start from the first point **before**
  47983. * the range.
  47984. *
  47985. * In other words, this flag determines if first point within the visible
  47986. * range will have 0% (`compareStart=true`) or should have been already
  47987. * calculated according to the previous point (`compareStart=false`).
  47988. */
  47989. compareStart?: boolean;
  47990. /**
  47991. * (Highstock) Whether to compare indicator to the main series values or
  47992. * indicator values.
  47993. */
  47994. compareToMain?: boolean;
  47995. /**
  47996. * (Highcharts) Polar charts only. Whether to connect the ends of a line
  47997. * series plot across the extremes.
  47998. */
  47999. connectEnds?: boolean;
  48000. /**
  48001. * (Highcharts, Highstock) Whether to connect a graph line across null
  48002. * points, or render a gap between the two points on either side of the
  48003. * null.
  48004. */
  48005. connectNulls?: boolean;
  48006. /**
  48007. * (Gantt) Override Pathfinder connector options for a series. Requires
  48008. * Highcharts Gantt to be loaded.
  48009. */
  48010. connectors?: SeriesConnectorsOptionsObject;
  48011. /**
  48012. * (Highcharts, Highstock, Gantt) When true, each point or column edge is
  48013. * rounded to its nearest pixel in order to render sharp on screen. In some
  48014. * cases, when there are a lot of densely packed columns, this leads to
  48015. * visible difference in column widths or distance between columns. In these
  48016. * cases, setting `crisp` to `false` may look better, even though each
  48017. * column is rendered blurry.
  48018. */
  48019. crisp?: boolean;
  48020. /**
  48021. * (Highcharts, Highstock) When the series contains less points than the
  48022. * crop threshold, all points are drawn, even if the points fall outside the
  48023. * visible plot area at the current zoom. The advantage of drawing all
  48024. * points (including markers and columns), is that animation is performed on
  48025. * updates. On the other hand, when the series contains more points than the
  48026. * crop threshold, the series data is cropped to only contain points that
  48027. * fall within the plot area. The advantage of cropping away invisible
  48028. * points is to increase performance on large series.
  48029. */
  48030. cropThreshold?: number;
  48031. /**
  48032. * (Highstock) You can set the cursor to "pointer" if you have click events
  48033. * attached to the series, to signal to the user that the points and lines
  48034. * can be clicked.
  48035. *
  48036. * In styled mode, the series cursor can be set with the same classes as
  48037. * listed under series.color.
  48038. */
  48039. cursor?: (string|CursorValue);
  48040. /**
  48041. * (Highstock) A reserved subspace to store options and values for
  48042. * customized functionality. Here you can add additional data for your own
  48043. * event callbacks and formatter callbacks.
  48044. */
  48045. custom?: Dictionary<any>;
  48046. /**
  48047. * (Highstock) Name of the dash style to use for the graph, or for some
  48048. * series types the outline of each shape.
  48049. *
  48050. * In styled mode, the stroke dash-array can be set with the same classes as
  48051. * listed under series.color.
  48052. */
  48053. dashStyle?: DashStyleValue;
  48054. /**
  48055. * (Highstock) Data grouping is the concept of sampling the data values into
  48056. * larger blocks in order to ease readability and increase performance of
  48057. * the JavaScript charts. Highstock by default applies data grouping when
  48058. * the points become closer than a certain pixel value, determined by the
  48059. * `groupPixelWidth` option.
  48060. *
  48061. * If data grouping is applied, the grouping information of grouped points
  48062. * can be read from the Point.dataGroup. If point options other than the
  48063. * data itself are set, for example `name` or `color` or custom properties,
  48064. * the grouping logic doesn't know how to group it. In this case the options
  48065. * of the first point instance are copied over to the group point. This can
  48066. * be altered through a custom `approximation` callback function.
  48067. */
  48068. dataGrouping?: DataGroupingOptionsObject;
  48069. /**
  48070. * (Highcharts, Highstock, Highmaps, Gantt) Options for the series data
  48071. * labels, appearing next to each data point.
  48072. *
  48073. * Since v6.2.0, multiple data labels can be applied to each single point by
  48074. * defining them as an array of configs.
  48075. *
  48076. * In styled mode, the data labels can be styled with the
  48077. * `.highcharts-data-label-box` and `.highcharts-data-label` class names
  48078. * (see example).
  48079. */
  48080. dataLabels?: (PlotIkhDataLabelsOptions|Array<PlotIkhDataLabelsOptions>);
  48081. /**
  48082. * (Highcharts, Highstock) Options for the series data sorting.
  48083. */
  48084. dataSorting?: (DataSortingOptionsObject|PlotIkhDataSortingOptions);
  48085. /**
  48086. * (Highstock) A description of the series to add to the screen reader
  48087. * information about the series.
  48088. */
  48089. description?: string;
  48090. /**
  48091. * (Highstock) Enable or disable the mouse tracking for a specific series.
  48092. * This includes point tooltips and click events on graphs and points. For
  48093. * large datasets it improves performance.
  48094. */
  48095. enableMouseTracking?: boolean;
  48096. /**
  48097. * (Highstock) General event handlers for the series items. These event
  48098. * hooks can also be attached to the series at run time using the
  48099. * `Highcharts.addEvent` function.
  48100. */
  48101. events?: SeriesEventsOptionsObject;
  48102. /**
  48103. * (Highstock) Determines whether the series should look for the nearest
  48104. * point in both dimensions or just the x-dimension when hovering the
  48105. * series. Defaults to `'xy'` for scatter series and `'x'` for most other
  48106. * series. If the data has duplicate x-values, it is recommended to set this
  48107. * to `'xy'` to allow hovering over all points.
  48108. *
  48109. * Applies only to series types using nearest neighbor search (not direct
  48110. * hover) for tooltip.
  48111. */
  48112. findNearestPointBy?: OptionsFindNearestPointByValue;
  48113. /**
  48114. * (Highstock) Defines when to display a gap in the graph, together with the
  48115. * gapUnit option.
  48116. *
  48117. * In case when `dataGrouping` is enabled, points can be grouped into a
  48118. * larger time span. This can make the grouped points to have a greater
  48119. * distance than the absolute value of `gapSize` property, which will result
  48120. * in disappearing graph completely. To prevent this situation the mentioned
  48121. * distance between grouped points is used instead of previously defined
  48122. * `gapSize`.
  48123. *
  48124. * In practice, this option is most often used to visualize gaps in time
  48125. * series. In a stock chart, intraday data is available for daytime hours,
  48126. * while gaps will appear in nights and weekends.
  48127. */
  48128. gapSize?: number;
  48129. /**
  48130. * (Highstock) Together with gapSize, this option defines where to draw gaps
  48131. * in the graph.
  48132. *
  48133. * When the `gapUnit` is `"relative"` (default), a gap size of 5 means that
  48134. * if the distance between two points is greater than 5 times that of the
  48135. * two closest points, the graph will be broken.
  48136. *
  48137. * When the `gapUnit` is `"value"`, the gap is based on absolute axis
  48138. * values, which on a datetime axis is milliseconds. This also applies to
  48139. * the navigator series that inherits gap options from the base series.
  48140. */
  48141. gapUnit?: OptionsGapUnitValue;
  48142. /**
  48143. * (Highcharts, Highstock, Gantt) Whether to use the Y extremes of the total
  48144. * chart width or only the zoomed area when zooming in on parts of the X
  48145. * axis. By default, the Y axis adjusts to the min and max of the visible
  48146. * data. Cartesian series only.
  48147. */
  48148. getExtremesFromAll?: boolean;
  48149. /**
  48150. * (Highstock) When set to `false` will prevent the series data from being
  48151. * included in any form of data export.
  48152. *
  48153. * Since version 6.0.0 until 7.1.0 the option was existing undocumented as
  48154. * `includeInCSVExport`.
  48155. */
  48156. includeInDataExport?: boolean;
  48157. /**
  48158. * (Highstock) The styles for Kijun line
  48159. */
  48160. kijunLine?: PlotIkhKijunLineOptions;
  48161. /**
  48162. * (Highcharts, Highstock, Gantt) Series labels are placed as close to the
  48163. * series as possible in a natural way, seeking to avoid other series. The
  48164. * goal of this feature is to make the chart more easily readable, like if a
  48165. * human designer placed the labels in the optimal position.
  48166. *
  48167. * The series labels currently work with series types having a `graph` or an
  48168. * `area`.
  48169. */
  48170. label?: SeriesLabelOptionsObject;
  48171. /**
  48172. * (Highstock) The line marks the last price from all points.
  48173. */
  48174. lastPrice?: SeriesLastPriceOptionsObject;
  48175. /**
  48176. * (Highstock) The line marks the last price from visible range of points.
  48177. */
  48178. lastVisiblePrice?: SeriesLastVisiblePriceOptionsObject;
  48179. /**
  48180. * (Highcharts, Highstock) The SVG value used for the `stroke-linecap` and
  48181. * `stroke-linejoin` of a line graph. Round means that lines are rounded in
  48182. * the ends and bends.
  48183. */
  48184. linecap?: SeriesLinecapValue;
  48185. /**
  48186. * (Highcharts, Highstock) Pixel width of the graph line.
  48187. */
  48188. lineWidth?: number;
  48189. /**
  48190. * (Highcharts, Highstock, Gantt) The main series ID that indicator will be
  48191. * based on. Required for this indicator.
  48192. */
  48193. linkedTo?: string;
  48194. /**
  48195. * (Highstock) Options for the point markers of line-like series. Properties
  48196. * like `fillColor`, `lineColor` and `lineWidth` define the visual
  48197. * appearance of the markers. Other series types, like column series, don't
  48198. * have markers, but have visual options on the series level instead.
  48199. *
  48200. * In styled mode, the markers can be styled with the `.highcharts-point`,
  48201. * `.highcharts-point-hover` and `.highcharts-point-select` class names.
  48202. */
  48203. marker?: PointMarkerOptionsObject;
  48204. /**
  48205. * (Highstock) The name of the series as shown in the legend, tooltip etc.
  48206. * If not set, it will be based on a technical indicator type and default
  48207. * params.
  48208. */
  48209. name?: string;
  48210. /**
  48211. * (Highstock) The color for the parts of the graph or points that are below
  48212. * the threshold. Note that `zones` takes precedence over the negative
  48213. * color. Using `negativeColor` is equivalent to applying a zone with value
  48214. * of 0.
  48215. */
  48216. negativeColor?: (ColorString|GradientColorObject|PatternObject);
  48217. /**
  48218. * (Highstock) Opacity of a series parts: line, fill (e.g. area) and
  48219. * dataLabels.
  48220. */
  48221. opacity?: number;
  48222. /**
  48223. * (Highstock) Paramters used in calculation of regression series' points.
  48224. */
  48225. params?: PlotIkhParamsOptions;
  48226. /**
  48227. * (Highstock) Properties for each single point.
  48228. */
  48229. point?: PlotSeriesPointOptions;
  48230. /**
  48231. * (Highstock) Same as accessibility.pointDescriptionFormatter, but for an
  48232. * individual series. Overrides the chart wide configuration.
  48233. */
  48234. pointDescriptionFormatter?: Function;
  48235. /**
  48236. * (Highstock) Whether to select the series initially. If `showCheckbox` is
  48237. * true, the checkbox next to the series name in the legend will be checked
  48238. * for a selected series.
  48239. */
  48240. selected?: boolean;
  48241. /**
  48242. * (Highstock) The styles for area between Senkou Span A and B.
  48243. */
  48244. senkouSpan?: PlotIkhSenkouSpanOptions;
  48245. /**
  48246. * (Highstock) The styles for Senkou Span A line
  48247. */
  48248. senkouSpanA?: PlotIkhSenkouSpanAOptions;
  48249. /**
  48250. * (Highstock) The styles for Senkou Span B line
  48251. */
  48252. senkouSpanB?: PlotIkhSenkouSpanBOptions;
  48253. /**
  48254. * (Highstock) Whether to apply a drop shadow to the graph line. Since 2.3
  48255. * the shadow can be an object configuration containing `color`, `offsetX`,
  48256. * `offsetY`, `opacity` and `width`.
  48257. */
  48258. shadow?: (boolean|ShadowOptionsObject);
  48259. /**
  48260. * (Highstock) If true, a checkbox is displayed next to the legend item to
  48261. * allow selecting the series. The state of the checkbox is determined by
  48262. * the `selected` option.
  48263. */
  48264. showCheckbox?: boolean;
  48265. /**
  48266. * (Highstock) Whether to display this particular series or series type in
  48267. * the legend. Standalone series are shown in legend by default, and linked
  48268. * series are not. Since v7.2.0 it is possible to show series that use
  48269. * colorAxis by setting this option to `true`.
  48270. */
  48271. showInLegend?: boolean;
  48272. /**
  48273. * (Highstock) If set to `true`, the accessibility module will skip past the
  48274. * points in this series for keyboard navigation.
  48275. */
  48276. skipKeyboardNavigation?: boolean;
  48277. /**
  48278. * (Highcharts, Highstock) When this is true, the series will not cause the
  48279. * Y axis to cross the zero plane (or threshold option) unless the data
  48280. * actually crosses the plane.
  48281. *
  48282. * For example, if `softThreshold` is `false`, a series of 0, 1, 2, 3 will
  48283. * make the Y axis show negative values according to the `minPadding`
  48284. * option. If `softThreshold` is `true`, the Y axis starts at 0.
  48285. */
  48286. softThreshold?: boolean;
  48287. states?: SeriesStatesOptionsObject;
  48288. /**
  48289. * (Highcharts, Highstock) Whether to apply steps to the line. Possible
  48290. * values are `left`, `center` and `right`.
  48291. */
  48292. step?: OptionsStepValue;
  48293. /**
  48294. * (Highstock) Sticky tracking of mouse events. When true, the `mouseOut`
  48295. * event on a series isn't triggered until the mouse moves over another
  48296. * series, or out of the plot area. When false, the `mouseOut` event on a
  48297. * series is triggered when the mouse leaves the area around the series'
  48298. * graph or markers. This also implies the tooltip when not shared. When
  48299. * `stickyTracking` is false and `tooltip.shared` is false, the tooltip will
  48300. * be hidden when moving the mouse between series. Defaults to true for line
  48301. * and area type series, but to false for columns, pies etc.
  48302. *
  48303. * **Note:** The boost module will force this option because of technical
  48304. * limitations.
  48305. */
  48306. stickyTracking?: boolean;
  48307. /**
  48308. * (Highstock) The styles for Tenkan line
  48309. */
  48310. tenkanLine?: PlotIkhTenkanLineOptions;
  48311. /**
  48312. * (Highcharts, Highstock) The threshold, also called zero level or base
  48313. * level. For line type series this is only used in conjunction with
  48314. * negativeColor.
  48315. */
  48316. threshold?: (number|null);
  48317. /**
  48318. * (Highstock) A configuration object for the tooltip rendering of each
  48319. * single series. Properties are inherited from tooltip, but only the
  48320. * following properties can be defined on a series level.
  48321. */
  48322. tooltip?: SeriesTooltipOptionsObject;
  48323. /**
  48324. * (Highcharts, Highstock, Gantt) When a series contains a data array that
  48325. * is longer than this, only one dimensional arrays of numbers, or two
  48326. * dimensional arrays with x and y values are allowed. Also, only the first
  48327. * point is tested, and the rest are assumed to be the same format. This
  48328. * saves expensive data checking and indexing in long series. Set it to `0`
  48329. * disable.
  48330. *
  48331. * Note: In boost mode turbo threshold is forced. Only array of numbers or
  48332. * two dimensional arrays are allowed.
  48333. */
  48334. turboThreshold?: number;
  48335. /**
  48336. * (Highstock) Set the initial visibility of the series.
  48337. */
  48338. visible?: boolean;
  48339. /**
  48340. * (Highmaps) Define the z index of the series.
  48341. */
  48342. zIndex?: number;
  48343. /**
  48344. * (Highcharts, Highstock) Defines the Axis on which the zones are applied.
  48345. */
  48346. zoneAxis?: string;
  48347. /**
  48348. * (Highcharts, Highstock) An array defining zones within a series. Zones
  48349. * can be applied to the X axis, Y axis or Z axis for bubbles, according to
  48350. * the `zoneAxis` option. The zone definitions have to be in ascending order
  48351. * regarding to the value.
  48352. *
  48353. * In styled mode, the color zones are styled with the
  48354. * `.highcharts-zone-{n}` class, or custom classed from the `className`
  48355. * option (view live demo).
  48356. */
  48357. zones?: Array<SeriesZonesOptionsObject>;
  48358. }
  48359. /**
  48360. * (Highstock) Paramters used in calculation of regression series' points.
  48361. */
  48362. export interface PlotIkhParamsOptions {
  48363. /**
  48364. * (Highstock) The point index which indicator calculations will base. For
  48365. * example using OHLC data, index=2 means the indicator will be calculated
  48366. * using Low values.
  48367. */
  48368. index?: number;
  48369. /**
  48370. * (Highstock) The base period for indicator calculations. This is the
  48371. * number of data points which are taken into account for the indicator
  48372. * calculations.
  48373. */
  48374. period?: number;
  48375. /**
  48376. * (Highstock) The base period for Senkou Span B calculations
  48377. */
  48378. periodSenkouSpanB?: number;
  48379. /**
  48380. * (Highstock) The base period for Tenkan calculations.
  48381. */
  48382. periodTenkan?: number;
  48383. }
  48384. /**
  48385. * (Highstock) The styles for Senkou Span A line
  48386. */
  48387. export interface PlotIkhSenkouSpanAOptions {
  48388. styles?: PlotIkhSenkouSpanAStylesOptions;
  48389. }
  48390. export interface PlotIkhSenkouSpanAStylesOptions {
  48391. /**
  48392. * (Highstock) Color of the line.
  48393. */
  48394. lineColor?: ColorString;
  48395. /**
  48396. * (Highstock) Pixel width of the line.
  48397. */
  48398. lineWidth?: number;
  48399. }
  48400. /**
  48401. * (Highstock) The styles for Senkou Span B line
  48402. */
  48403. export interface PlotIkhSenkouSpanBOptions {
  48404. styles?: PlotIkhSenkouSpanBStylesOptions;
  48405. }
  48406. export interface PlotIkhSenkouSpanBStylesOptions {
  48407. /**
  48408. * (Highstock) Color of the line.
  48409. */
  48410. lineColor?: ColorString;
  48411. /**
  48412. * (Highstock) Pixel width of the line.
  48413. */
  48414. lineWidth?: number;
  48415. }
  48416. /**
  48417. * (Highstock) The styles for area between Senkou Span A and B.
  48418. */
  48419. export interface PlotIkhSenkouSpanOptions {
  48420. /**
  48421. * (Highstock) Color of the area between Senkou Span A and B, when Senkou
  48422. * Span A is above Senkou Span B. Note that if a `style.fill` is defined,
  48423. * the `color` takes precedence and the `style.fill` is ignored.
  48424. */
  48425. color?: (ColorString|GradientColorObject|PatternObject);
  48426. /**
  48427. * (Highstock) Color of the area between Senkou Span A and B, when Senkou
  48428. * Span A is under Senkou Span B.
  48429. */
  48430. negativeColor?: (ColorString|GradientColorObject|PatternObject);
  48431. }
  48432. /**
  48433. * (Highstock) The styles for Tenkan line
  48434. */
  48435. export interface PlotIkhTenkanLineOptions {
  48436. styles?: PlotIkhTenkanLineStylesOptions;
  48437. }
  48438. export interface PlotIkhTenkanLineStylesOptions {
  48439. /**
  48440. * (Highstock) Color of the line.
  48441. */
  48442. lineColor?: ColorString;
  48443. /**
  48444. * (Highstock) Pixel width of the line.
  48445. */
  48446. lineWidth?: number;
  48447. }
  48448. /**
  48449. * (Highcharts) Enable or disable the initial animation when a series is
  48450. * displayed. The animation can also be set as a configuration object. Please
  48451. * note that this option only applies to the initial animation of the series
  48452. * itself. For other animations, see chart.animation and the animation parameter
  48453. * under the API methods. The following properties are supported:
  48454. *
  48455. * - `defer`: The animation delay time in milliseconds.
  48456. *
  48457. * - `duration`: The duration of the animation in milliseconds.
  48458. *
  48459. * - `easing`: Can be a string reference to an easing function set on the `Math`
  48460. * object or a function. See the _Custom easing function_ demo below.
  48461. *
  48462. * Due to poor performance, animation is disabled in old IE browsers for several
  48463. * chart types.
  48464. */
  48465. export interface PlotItemAnimationOptions {
  48466. defer?: number;
  48467. }
  48468. /**
  48469. * (Highcharts, Highstock, Highmaps, Gantt) Enable or disable the initial
  48470. * animation when a series is displayed for the `dataLabels`. The animation can
  48471. * also be set as a configuration object. Please note that this option only
  48472. * applies to the initial animation. For other animations, see chart.animation
  48473. * and the animation parameter under the API methods. The following properties
  48474. * are supported:
  48475. *
  48476. * - `defer`: The animation delay time in milliseconds.
  48477. */
  48478. export interface PlotItemDataLabelsAnimationOptions {
  48479. /**
  48480. * (Highcharts, Highstock, Highmaps, Gantt) The animation delay time in
  48481. * milliseconds. Set to `0` renders dataLabel immediately. As `undefined`
  48482. * inherits defer time from the series.animation.defer.
  48483. */
  48484. defer?: number;
  48485. }
  48486. /**
  48487. * (Highcharts) An item chart is an infographic chart where a number of items
  48488. * are laid out in either a rectangular or circular pattern. It can be used to
  48489. * visualize counts within a group, or for the circular pattern, typically a
  48490. * parliament.
  48491. *
  48492. * The circular layout has much in common with a pie chart. Many of the item
  48493. * series options, like `center`, `size` and data label positioning, are
  48494. * inherited from the pie series and don't apply for rectangular layouts.
  48495. *
  48496. * In TypeScript the type option must always be set.
  48497. *
  48498. * Configuration options for the series are given in three levels:
  48499. *
  48500. * 1. Options for all series in a chart are defined in the plotOptions.series
  48501. * object.
  48502. *
  48503. * 2. Options for all `item` series are defined in plotOptions.item.
  48504. *
  48505. * 3. Options for one single series are given in the series instance array. (see
  48506. * online documentation for example)
  48507. */
  48508. export interface PlotItemOptions {
  48509. /**
  48510. * (Highcharts) Accessibility options for a series.
  48511. */
  48512. accessibility?: SeriesAccessibilityOptionsObject;
  48513. /**
  48514. * (Highmaps) Whether all areas of the map defined in `mapData` should be
  48515. * rendered. If `true`, areas which don't correspond to a data point, are
  48516. * rendered as `null` points. If `false`, those areas are skipped.
  48517. */
  48518. allAreas?: boolean;
  48519. /**
  48520. * (Highcharts) Allow this series' points to be selected by clicking on the
  48521. * graphic (columns, point markers, pie slices, map areas etc).
  48522. *
  48523. * The selected points can be handled by point select and unselect events,
  48524. * or collectively by the getSelectedPoints function.
  48525. *
  48526. * And alternative way of selecting points is through dragging.
  48527. */
  48528. allowPointSelect?: boolean;
  48529. /**
  48530. * (Highcharts) Enable or disable the initial animation when a series is
  48531. * displayed. The animation can also be set as a configuration object.
  48532. * Please note that this option only applies to the initial animation of the
  48533. * series itself. For other animations, see chart.animation and the
  48534. * animation parameter under the API methods. The following properties are
  48535. * supported:
  48536. *
  48537. * - `defer`: The animation delay time in milliseconds.
  48538. *
  48539. * - `duration`: The duration of the animation in milliseconds.
  48540. *
  48541. * - `easing`: Can be a string reference to an easing function set on the
  48542. * `Math` object or a function. See the _Custom easing function_ demo below.
  48543. *
  48544. * Due to poor performance, animation is disabled in old IE browsers for
  48545. * several chart types.
  48546. */
  48547. animation?: (boolean|PlotItemAnimationOptions|Partial<AnimationOptionsObject>);
  48548. /**
  48549. * (Highcharts) The center of the pie chart relative to the plot area. Can
  48550. * be percentages or pixel values. The default behaviour (as of 3.0) is to
  48551. * center the pie so that all slices and data labels are within the plot
  48552. * area. As a consequence, the pie may actually jump around in a chart with
  48553. * dynamic values, as the data labels move. In that case, the center should
  48554. * be explicitly set, for example to `["50%", "50%"]`.
  48555. */
  48556. center?: [(number|string|null), (number|string|null)];
  48557. /**
  48558. * (Highcharts) An additional class name to apply to the series' graphical
  48559. * elements. This option does not replace default class names of the
  48560. * graphical element.
  48561. */
  48562. className?: string;
  48563. /**
  48564. * (Highcharts) Disable this option to allow series rendering in the whole
  48565. * plotting area.
  48566. *
  48567. * **Note:** Clipping should be always enabled when chart.zoomType is set
  48568. */
  48569. clip?: boolean;
  48570. /**
  48571. * (Highcharts) The color of the pie series. A pie series is represented as
  48572. * an empty circle if the total sum of its values is 0. Use this property to
  48573. * define the color of its border.
  48574. *
  48575. * In styled mode, the color can be defined by the colorIndex option. Also,
  48576. * the series color can be set with the `.highcharts-series`,
  48577. * `.highcharts-color-{n}`, `.highcharts-{type}-series` or
  48578. * `.highcharts-series-{n}` class, or individual classes given by the
  48579. * `className` option.
  48580. */
  48581. color?: (ColorString|GradientColorObject|PatternObject);
  48582. /**
  48583. * (Highcharts, Highstock, Highmaps) When using dual or multiple color axes,
  48584. * this number defines which colorAxis the particular series is connected
  48585. * to. It refers to either the axis id or the index of the axis in the
  48586. * colorAxis array, with 0 being the first. Set this option to false to
  48587. * prevent a series from connecting to the default color axis.
  48588. *
  48589. * Since v7.2.0 the option can also be an axis id or an axis index instead
  48590. * of a boolean flag.
  48591. */
  48592. colorAxis?: (boolean|number|string);
  48593. /**
  48594. * (Highcharts) Styled mode only. A specific color index to use for the
  48595. * series, so its graphic representations are given the class name
  48596. * `highcharts-color-{n}`.
  48597. */
  48598. colorIndex?: number;
  48599. /**
  48600. * (Highcharts, Highstock, Highmaps) Determines what data value should be
  48601. * used to calculate point color if `colorAxis` is used. Requires to set
  48602. * `min` and `max` if some custom point property is used or if approximation
  48603. * for data grouping is set to `'sum'`.
  48604. */
  48605. colorKey?: string;
  48606. /**
  48607. * (Highcharts) A series specific or series type specific color set to use
  48608. * instead of the global colors.
  48609. */
  48610. colors?: Array<(ColorString|GradientColorObject|PatternObject)>;
  48611. /**
  48612. * (Highstock) Compare the values of the series against the first non-null,
  48613. * non- zero value in the visible range. The y axis will show percentage or
  48614. * absolute change depending on whether `compare` is set to `"percent"` or
  48615. * `"value"`. When this is applied to multiple series, it allows comparing
  48616. * the development of the series against each other. Adds a `change` field
  48617. * to every point object.
  48618. */
  48619. compare?: string;
  48620. /**
  48621. * (Highstock) When compare is `percent`, this option dictates whether to
  48622. * use 0 or 100 as the base of comparison.
  48623. */
  48624. compareBase?: (0|100);
  48625. /**
  48626. * (Highstock) Defines if comparison should start from the first point
  48627. * within the visible range or should start from the first point **before**
  48628. * the range.
  48629. *
  48630. * In other words, this flag determines if first point within the visible
  48631. * range will have 0% (`compareStart=true`) or should have been already
  48632. * calculated according to the previous point (`compareStart=false`).
  48633. */
  48634. compareStart?: boolean;
  48635. /**
  48636. * (Gantt) Override Pathfinder connector options for a series. Requires
  48637. * Highcharts Gantt to be loaded.
  48638. */
  48639. connectors?: SeriesConnectorsOptionsObject;
  48640. /**
  48641. * (Highcharts, Highstock, Gantt) When true, each point or column edge is
  48642. * rounded to its nearest pixel in order to render sharp on screen. In some
  48643. * cases, when there are a lot of densely packed columns, this leads to
  48644. * visible difference in column widths or distance between columns. In these
  48645. * cases, setting `crisp` to `false` may look better, even though each
  48646. * column is rendered blurry.
  48647. */
  48648. crisp?: boolean;
  48649. /**
  48650. * (Highcharts) You can set the cursor to "pointer" if you have click events
  48651. * attached to the series, to signal to the user that the points and lines
  48652. * can be clicked.
  48653. *
  48654. * In styled mode, the series cursor can be set with the same classes as
  48655. * listed under series.color.
  48656. */
  48657. cursor?: (string|CursorValue);
  48658. /**
  48659. * (Highcharts) A reserved subspace to store options and values for
  48660. * customized functionality. Here you can add additional data for your own
  48661. * event callbacks and formatter callbacks.
  48662. */
  48663. custom?: Dictionary<any>;
  48664. /**
  48665. * (Highstock) Data grouping is the concept of sampling the data values into
  48666. * larger blocks in order to ease readability and increase performance of
  48667. * the JavaScript charts. Highstock by default applies data grouping when
  48668. * the points become closer than a certain pixel value, determined by the
  48669. * `groupPixelWidth` option.
  48670. *
  48671. * If data grouping is applied, the grouping information of grouped points
  48672. * can be read from the Point.dataGroup. If point options other than the
  48673. * data itself are set, for example `name` or `color` or custom properties,
  48674. * the grouping logic doesn't know how to group it. In this case the options
  48675. * of the first point instance are copied over to the group point. This can
  48676. * be altered through a custom `approximation` callback function.
  48677. */
  48678. dataGrouping?: DataGroupingOptionsObject;
  48679. /**
  48680. * (Highcharts, Highstock, Highmaps, Gantt) Options for the series data
  48681. * labels, appearing next to each data point.
  48682. *
  48683. * Since v6.2.0, multiple data labels can be applied to each single point by
  48684. * defining them as an array of configs.
  48685. *
  48686. * In styled mode, the data labels can be styled with the
  48687. * `.highcharts-data-label-box` and `.highcharts-data-label` class names
  48688. * (see example).
  48689. */
  48690. dataLabels?: (SeriesPieDataLabelsOptionsObject|Array<SeriesPieDataLabelsOptionsObject>);
  48691. /**
  48692. * (Highcharts) A description of the series to add to the screen reader
  48693. * information about the series.
  48694. */
  48695. description?: string;
  48696. /**
  48697. * (Highcharts) Enable or disable the mouse tracking for a specific series.
  48698. * This includes point tooltips and click events on graphs and points. For
  48699. * large datasets it improves performance.
  48700. */
  48701. enableMouseTracking?: boolean;
  48702. /**
  48703. * (Highcharts) In circular view, the end angle of the item layout, in
  48704. * degrees where 0 is up.
  48705. */
  48706. endAngle?: (number|undefined);
  48707. /**
  48708. * (Highcharts) General event handlers for the series items. These event
  48709. * hooks can also be attached to the series at run time using the
  48710. * `Highcharts.addEvent` function.
  48711. */
  48712. events?: SeriesEventsOptionsObject;
  48713. /**
  48714. * (Highcharts) If the total sum of the pie's values is 0, the series is
  48715. * represented as an empty circle . The `fillColor` option defines the color
  48716. * of that circle. Use pie.borderWidth to set the border thickness.
  48717. */
  48718. fillColor?: (ColorString|GradientColorObject|PatternObject);
  48719. /**
  48720. * (Highstock) Defines when to display a gap in the graph, together with the
  48721. * gapUnit option.
  48722. *
  48723. * In case when `dataGrouping` is enabled, points can be grouped into a
  48724. * larger time span. This can make the grouped points to have a greater
  48725. * distance than the absolute value of `gapSize` property, which will result
  48726. * in disappearing graph completely. To prevent this situation the mentioned
  48727. * distance between grouped points is used instead of previously defined
  48728. * `gapSize`.
  48729. *
  48730. * In practice, this option is most often used to visualize gaps in time
  48731. * series. In a stock chart, intraday data is available for daytime hours,
  48732. * while gaps will appear in nights and weekends.
  48733. */
  48734. gapSize?: number;
  48735. /**
  48736. * (Highstock) Together with gapSize, this option defines where to draw gaps
  48737. * in the graph.
  48738. *
  48739. * When the `gapUnit` is `"relative"` (default), a gap size of 5 means that
  48740. * if the distance between two points is greater than 5 times that of the
  48741. * two closest points, the graph will be broken.
  48742. *
  48743. * When the `gapUnit` is `"value"`, the gap is based on absolute axis
  48744. * values, which on a datetime axis is milliseconds. This also applies to
  48745. * the navigator series that inherits gap options from the base series.
  48746. */
  48747. gapUnit?: OptionsGapUnitValue;
  48748. /**
  48749. * (Highcharts) Equivalent to chart.ignoreHiddenSeries, this option tells
  48750. * whether the series shall be redrawn as if the hidden point were `null`.
  48751. *
  48752. * The default value changed from `false` to `true` with Highcharts 3.0.
  48753. */
  48754. ignoreHiddenPoint?: boolean;
  48755. /**
  48756. * (Highcharts) When set to `false` will prevent the series data from being
  48757. * included in any form of data export.
  48758. *
  48759. * Since version 6.0.0 until 7.1.0 the option was existing undocumented as
  48760. * `includeInCSVExport`.
  48761. */
  48762. includeInDataExport?: boolean;
  48763. /**
  48764. * (Highcharts) In circular view, the size of the inner diameter of the
  48765. * circle. Can be a percentage or pixel value. Percentages are relative to
  48766. * the outer perimeter. Pixel values are given as integers.
  48767. *
  48768. * If the `rows` option is set, it overrides the `innerSize` setting.
  48769. */
  48770. innerSize?: (number|string);
  48771. /**
  48772. * (Highcharts) The padding between the items, given in relative size where
  48773. * the size of the item is 1.
  48774. */
  48775. itemPadding?: number;
  48776. /**
  48777. * (Highmaps) What property to join the `mapData` to the value data. For
  48778. * example, if joinBy is "code", the mapData items with a specific code is
  48779. * merged into the data with the same code. For maps loaded from GeoJSON,
  48780. * the keys may be held in each point's `properties` object.
  48781. *
  48782. * The joinBy option can also be an array of two values, where the first
  48783. * points to a key in the `mapData`, and the second points to another key in
  48784. * the `data`.
  48785. *
  48786. * When joinBy is `null`, the map items are joined by their position in the
  48787. * array, which performs much better in maps with many data points. This is
  48788. * the recommended option if you are printing more than a thousand data
  48789. * points and have a backend that can preprocess the data into a parallel
  48790. * array of the mapData.
  48791. */
  48792. joinBy?: (string|Array<string>);
  48793. /**
  48794. * (Highcharts) An array specifying which option maps to which key in the
  48795. * data point array. This makes it convenient to work with unstructured data
  48796. * arrays from different sources.
  48797. */
  48798. keys?: Array<string>;
  48799. /**
  48800. * (Highstock) The line marks the last price from all points.
  48801. */
  48802. lastPrice?: SeriesLastPriceOptionsObject;
  48803. /**
  48804. * (Highstock) The line marks the last price from visible range of points.
  48805. */
  48806. lastVisiblePrice?: SeriesLastVisiblePriceOptionsObject;
  48807. /**
  48808. * (Highcharts) The layout of the items in rectangular view. Can be either
  48809. * `horizontal` or `vertical`.
  48810. */
  48811. layout?: string;
  48812. /**
  48813. * (Highcharts, Highstock, Gantt) The id of another series to link to.
  48814. * Additionally, the value can be ":previous" to link to the previous
  48815. * series. When two series are linked, only the first one appears in the
  48816. * legend. Toggling the visibility of this also toggles the linked series.
  48817. *
  48818. * If master series uses data sorting and linked series does not have its
  48819. * own sorting definition, the linked series will be sorted in the same
  48820. * order as the master one.
  48821. */
  48822. linkedTo?: string;
  48823. /**
  48824. * (Highcharts) Options for the point markers of line-like series.
  48825. * Properties like `fillColor`, `lineColor` and `lineWidth` define the
  48826. * visual appearance of the markers. Other series types, like column series,
  48827. * don't have markers, but have visual options on the series level instead.
  48828. *
  48829. * In styled mode, the markers can be styled with the `.highcharts-point`,
  48830. * `.highcharts-point-hover` and `.highcharts-point-select` class names.
  48831. */
  48832. marker?: PointMarkerOptionsObject;
  48833. /**
  48834. * (Highcharts) The minimum size for a pie in response to auto margins. The
  48835. * pie will try to shrink to make room for data labels in side the plot
  48836. * area, but only to this size.
  48837. */
  48838. minSize?: (number|string);
  48839. /**
  48840. * (Highstock) Options for the corresponding navigator series if
  48841. * `showInNavigator` is `true` for this series. Available options are the
  48842. * same as any series, documented at plotOptions and series.
  48843. *
  48844. * These options are merged with options in navigator.series, and will take
  48845. * precedence if the same option is defined both places.
  48846. */
  48847. navigatorOptions?: PlotSeriesOptions;
  48848. /**
  48849. * (Highcharts) Opacity of a series parts: line, fill (e.g. area) and
  48850. * dataLabels.
  48851. */
  48852. opacity?: number;
  48853. /**
  48854. * (Highcharts) Properties for each single point.
  48855. */
  48856. point?: PlotSeriesPointOptions;
  48857. /**
  48858. * (Highcharts) Same as accessibility.pointDescriptionFormatter, but for an
  48859. * individual series. Overrides the chart wide configuration.
  48860. */
  48861. pointDescriptionFormatter?: Function;
  48862. /**
  48863. * (Highstock) The width of each point on the x axis. For example in a
  48864. * column chart with one value each day, the pointRange would be 1 day (= 24
  48865. * * 3600
  48866. *
  48867. * * 1000 milliseconds). This is normally computed automatically, but this
  48868. * option can be used to override the automatic value.
  48869. */
  48870. pointRange?: number;
  48871. /**
  48872. * (Highcharts) The number of rows to display in the rectangular or circular
  48873. * view. If the `innerSize` is set, it will be overridden by the `rows`
  48874. * setting.
  48875. */
  48876. rows?: number;
  48877. /**
  48878. * (Highcharts) Whether to select the series initially. If `showCheckbox` is
  48879. * true, the checkbox next to the series name in the legend will be checked
  48880. * for a selected series.
  48881. */
  48882. selected?: boolean;
  48883. /**
  48884. * (Highcharts) If true, a checkbox is displayed next to the legend item to
  48885. * allow selecting the series. The state of the checkbox is determined by
  48886. * the `selected` option.
  48887. */
  48888. showCheckbox?: boolean;
  48889. /**
  48890. * (Highcharts) Whether to display this particular series or series type in
  48891. * the legend. Since 2.1, pies are not shown in the legend by default.
  48892. */
  48893. showInLegend?: boolean;
  48894. /**
  48895. * (Highstock) Whether or not to show the series in the navigator. Takes
  48896. * precedence over navigator.baseSeries if defined.
  48897. */
  48898. showInNavigator?: boolean;
  48899. /**
  48900. * (Highcharts) The diameter of the pie relative to the plot area. Can be a
  48901. * percentage or pixel value. Pixel values are given as integers. The
  48902. * default behaviour (as of 3.0) is to scale to the plot area and give room
  48903. * for data labels within the plot area. slicedOffset is also included in
  48904. * the default size calculation. As a consequence, the size of the pie may
  48905. * vary when points are updated and data labels more around. In that case it
  48906. * is best to set a fixed value, for example `"75%"`.
  48907. */
  48908. size?: (number|string|null);
  48909. /**
  48910. * (Highcharts) If set to `true`, the accessibility module will skip past
  48911. * the points in this series for keyboard navigation.
  48912. */
  48913. skipKeyboardNavigation?: boolean;
  48914. /**
  48915. * (Highcharts) In circular view, the start angle of the item layout, in
  48916. * degrees where 0 is up.
  48917. */
  48918. startAngle?: (number|undefined);
  48919. states?: SeriesStatesOptionsObject;
  48920. /**
  48921. * (Highcharts) Sticky tracking of mouse events. When true, the `mouseOut`
  48922. * event on a series isn't triggered until the mouse moves over another
  48923. * series, or out of the plot area. When false, the `mouseOut` event on a
  48924. * series is triggered when the mouse leaves the area around the series'
  48925. * graph or markers. This also implies the tooltip. When `stickyTracking` is
  48926. * false and `tooltip.shared` is false, the tooltip will be hidden when
  48927. * moving the mouse between series.
  48928. */
  48929. stickyTracking?: boolean;
  48930. /**
  48931. * (Highcharts) A configuration object for the tooltip rendering of each
  48932. * single series. Properties are inherited from tooltip, but only the
  48933. * following properties can be defined on a series level.
  48934. */
  48935. tooltip?: SeriesTooltipOptionsObject;
  48936. /**
  48937. * (Highstock) The parameter allows setting line series type and use OHLC
  48938. * indicators. Data in OHLC format is required.
  48939. */
  48940. useOhlcData?: boolean;
  48941. /**
  48942. * (Highcharts) Set the initial visibility of the series.
  48943. */
  48944. visible?: boolean;
  48945. /**
  48946. * (Highmaps) Define the z index of the series.
  48947. */
  48948. zIndex?: number;
  48949. }
  48950. /**
  48951. * (Highstock) Enable or disable the initial animation when a series is
  48952. * displayed. The animation can also be set as a configuration object. Please
  48953. * note that this option only applies to the initial animation of the series
  48954. * itself. For other animations, see chart.animation and the animation parameter
  48955. * under the API methods. The following properties are supported:
  48956. *
  48957. * - `defer`: The animation delay time in milliseconds.
  48958. *
  48959. * - `duration`: The duration of the animation in milliseconds.
  48960. *
  48961. * - `easing`: Can be a string reference to an easing function set on the `Math`
  48962. * object or a function. See the _Custom easing function_ demo below.
  48963. *
  48964. * Due to poor performance, animation is disabled in old IE browsers for several
  48965. * chart types.
  48966. */
  48967. export interface PlotKeltnerchannelsAnimationOptions {
  48968. defer?: number;
  48969. }
  48970. /**
  48971. * (Highstock) Bottom line options.
  48972. */
  48973. export interface PlotKeltnerchannelsBottomLineOptions {
  48974. /**
  48975. * (Highstock) Styles for a bottom line.
  48976. */
  48977. styles?: PlotKeltnerchannelsBottomLineStylesOptions;
  48978. }
  48979. /**
  48980. * (Highstock) Styles for a bottom line.
  48981. */
  48982. export interface PlotKeltnerchannelsBottomLineStylesOptions {
  48983. /**
  48984. * (Highstock) Color of the line. If not set, it's inherited from
  48985. * `plotOptions.keltnerchannels.color`
  48986. */
  48987. lineColor?: string;
  48988. /**
  48989. * (Highstock) Pixel width of the line.
  48990. */
  48991. lineWidth?: number;
  48992. }
  48993. /**
  48994. * (Highcharts, Highstock, Highmaps, Gantt) Enable or disable the initial
  48995. * animation when a series is displayed for the `dataLabels`. The animation can
  48996. * also be set as a configuration object. Please note that this option only
  48997. * applies to the initial animation. For other animations, see chart.animation
  48998. * and the animation parameter under the API methods. The following properties
  48999. * are supported:
  49000. *
  49001. * - `defer`: The animation delay time in milliseconds.
  49002. */
  49003. export interface PlotKeltnerchannelsDataLabelsAnimationOptions {
  49004. /**
  49005. * (Highcharts, Highstock, Highmaps, Gantt) The animation delay time in
  49006. * milliseconds. Set to `0` renders dataLabel immediately. As `undefined`
  49007. * inherits defer time from the series.animation.defer.
  49008. */
  49009. defer?: number;
  49010. }
  49011. /**
  49012. * (Highcharts, Highstock, Highmaps, Gantt) Options for the series data labels,
  49013. * appearing next to each data point.
  49014. *
  49015. * Since v6.2.0, multiple data labels can be applied to each single point by
  49016. * defining them as an array of configs.
  49017. *
  49018. * In styled mode, the data labels can be styled with the
  49019. * `.highcharts-data-label-box` and `.highcharts-data-label` class names (see
  49020. * example).
  49021. */
  49022. export interface PlotKeltnerchannelsDataLabelsOptions {
  49023. /**
  49024. * (Highcharts, Highstock, Highmaps, Gantt) The alignment of the data label
  49025. * compared to the point. If `right`, the right side of the label should be
  49026. * touching the point. For points with an extent, like columns, the
  49027. * alignments also dictates how to align it inside the box, as given with
  49028. * the inside option. Can be one of `left`, `center` or `right`.
  49029. */
  49030. align?: (AlignValue|null);
  49031. /**
  49032. * (Highcharts, Highstock, Highmaps, Gantt) Whether to allow data labels to
  49033. * overlap. To make the labels less sensitive for overlapping, the
  49034. * dataLabels.padding can be set to 0.
  49035. */
  49036. allowOverlap?: boolean;
  49037. /**
  49038. * (Highcharts, Highstock, Highmaps, Gantt) Enable or disable the initial
  49039. * animation when a series is displayed for the `dataLabels`. The animation
  49040. * can also be set as a configuration object. Please note that this option
  49041. * only applies to the initial animation. For other animations, see
  49042. * chart.animation and the animation parameter under the API methods. The
  49043. * following properties are supported:
  49044. *
  49045. * - `defer`: The animation delay time in milliseconds.
  49046. */
  49047. animation?: (boolean|PlotKeltnerchannelsDataLabelsAnimationOptions|Partial<AnimationOptionsObject>);
  49048. /**
  49049. * (Highcharts, Highstock, Highmaps, Gantt) The background color or gradient
  49050. * for the data label.
  49051. */
  49052. backgroundColor?: (ColorString|GradientColorObject|PatternObject);
  49053. /**
  49054. * (Highcharts, Highstock, Highmaps, Gantt) The border color for the data
  49055. * label. Defaults to `undefined`.
  49056. */
  49057. borderColor?: (ColorString|GradientColorObject|PatternObject);
  49058. /**
  49059. * (Highcharts, Highstock, Highmaps, Gantt) The border radius in pixels for
  49060. * the data label.
  49061. */
  49062. borderRadius?: number;
  49063. /**
  49064. * (Highcharts, Highstock, Highmaps, Gantt) The border width in pixels for
  49065. * the data label.
  49066. */
  49067. borderWidth?: number;
  49068. /**
  49069. * (Highcharts, Highstock, Highmaps, Gantt) A class name for the data label.
  49070. * Particularly in styled mode, this can be used to give each series' or
  49071. * point's data label unique styling. In addition to this option, a default
  49072. * color class name is added so that we can give the labels a contrast text
  49073. * shadow.
  49074. */
  49075. className?: string;
  49076. /**
  49077. * (Highcharts, Highstock, Highmaps, Gantt) The text color for the data
  49078. * labels. Defaults to `undefined`. For certain series types, like column or
  49079. * map, the data labels can be drawn inside the points. In this case the
  49080. * data label will be drawn with maximum contrast by default. Additionally,
  49081. * it will be given a `text-outline` style with the opposite color, to
  49082. * further increase the contrast. This can be overridden by setting the
  49083. * `text-outline` style to `none` in the `dataLabels.style` option.
  49084. */
  49085. color?: (ColorString|GradientColorObject|PatternObject);
  49086. /**
  49087. * (Highcharts, Highstock, Highmaps, Gantt) Whether to hide data labels that
  49088. * are outside the plot area. By default, the data label is moved inside the
  49089. * plot area according to the overflow option.
  49090. */
  49091. crop?: boolean;
  49092. /**
  49093. * (Highcharts, Highstock, Gantt) Whether to defer displaying the data
  49094. * labels until the initial series animation has finished. Setting to
  49095. * `false` renders the data label immediately. If set to `true` inherits the
  49096. * defer time set in plotOptions.series.animation.
  49097. */
  49098. defer?: boolean;
  49099. /**
  49100. * (Highcharts, Highstock, Highmaps, Gantt) Enable or disable the data
  49101. * labels.
  49102. */
  49103. enabled?: boolean;
  49104. /**
  49105. * (Highcharts, Highstock, Highmaps, Gantt) A declarative filter to control
  49106. * of which data labels to display. The declarative filter is designed for
  49107. * use when callback functions are not available, like when the chart
  49108. * options require a pure JSON structure or for use with graphical editors.
  49109. * For programmatic control, use the `formatter` instead, and return
  49110. * `undefined` to disable a single data label.
  49111. */
  49112. filter?: DataLabelsFilterOptionsObject;
  49113. /**
  49114. * (Highcharts, Highstock, Highmaps, Gantt) A format string for the data
  49115. * label. Available variables are the same as for `formatter`.
  49116. */
  49117. format?: string;
  49118. /**
  49119. * (Highcharts, Highstock, Highmaps, Gantt) Callback JavaScript function to
  49120. * format the data label. Note that if a `format` is defined, the format
  49121. * takes precedence and the formatter is ignored.
  49122. */
  49123. formatter?: DataLabelsFormatterCallbackFunction;
  49124. /**
  49125. * (Highcharts, Highstock, Highmaps, Gantt) For points with an extent, like
  49126. * columns or map areas, whether to align the data label inside the box or
  49127. * to the actual value point. Defaults to `false` in most cases, `true` in
  49128. * stacked columns.
  49129. */
  49130. inside?: boolean;
  49131. /**
  49132. * (Highcharts, Highstock, Highmaps, Gantt) Format for points with the value
  49133. * of null. Works analogously to format. `nullFormat` can be applied only to
  49134. * series which support displaying null points.
  49135. */
  49136. nullFormat?: (boolean|string);
  49137. /**
  49138. * (Highcharts, Highstock, Highmaps, Gantt) Callback JavaScript function
  49139. * that defines formatting for points with the value of null. Works
  49140. * analogously to formatter. `nullPointFormatter` can be applied only to
  49141. * series which support displaying null points.
  49142. */
  49143. nullFormatter?: DataLabelsFormatterCallbackFunction;
  49144. /**
  49145. * (Highcharts, Highstock, Highmaps, Gantt) How to handle data labels that
  49146. * flow outside the plot area. The default is `"justify"`, which aligns them
  49147. * inside the plot area. For columns and bars, this means it will be moved
  49148. * inside the bar. To display data labels outside the plot area, set `crop`
  49149. * to `false` and `overflow` to `"allow"`.
  49150. */
  49151. overflow?: DataLabelsOverflowValue;
  49152. /**
  49153. * (Highcharts, Highstock, Highmaps, Gantt) When either the `borderWidth` or
  49154. * the `backgroundColor` is set, this is the padding within the box.
  49155. */
  49156. padding?: number;
  49157. /**
  49158. * (Highcharts, Highstock, Highmaps, Gantt) Aligns data labels relative to
  49159. * points. If `center` alignment is not possible, it defaults to `right`.
  49160. */
  49161. position?: AlignValue;
  49162. /**
  49163. * (Highcharts, Highstock, Highmaps, Gantt) Text rotation in degrees. Note
  49164. * that due to a more complex structure, backgrounds, borders and padding
  49165. * will be lost on a rotated data label.
  49166. */
  49167. rotation?: number;
  49168. /**
  49169. * (Highcharts, Highstock, Highmaps, Gantt) The shadow of the box. Works
  49170. * best with `borderWidth` or `backgroundColor`. Since 2.3 the shadow can be
  49171. * an object configuration containing `color`, `offsetX`, `offsetY`,
  49172. * `opacity` and `width`.
  49173. */
  49174. shadow?: (boolean|ShadowOptionsObject);
  49175. /**
  49176. * (Highcharts, Highstock, Highmaps, Gantt) The name of a symbol to use for
  49177. * the border around the label. Symbols are predefined functions on the
  49178. * Renderer object.
  49179. */
  49180. shape?: string;
  49181. /**
  49182. * (Highcharts, Highstock, Highmaps, Gantt) Styles for the label. The
  49183. * default `color` setting is `"contrast"`, which is a pseudo color that
  49184. * Highcharts picks up and applies the maximum contrast to the underlying
  49185. * point item, for example the bar in a bar chart.
  49186. *
  49187. * The `textOutline` is a pseudo property that applies an outline of the
  49188. * given width with the given color, which by default is the maximum
  49189. * contrast to the text. So a bright text color will result in a black text
  49190. * outline for maximum readability on a mixed background. In some cases,
  49191. * especially with grayscale text, the text outline doesn't work well, in
  49192. * which cases it can be disabled by setting it to `"none"`. When `useHTML`
  49193. * is true, the `textOutline` will not be picked up. In this, case, the same
  49194. * effect can be acheived through the `text-shadow` CSS property.
  49195. *
  49196. * For some series types, where each point has an extent, like for example
  49197. * tree maps, the data label may overflow the point. There are two
  49198. * strategies for handling overflow. By default, the text will wrap to
  49199. * multiple lines. The other strategy is to set `style.textOverflow` to
  49200. * `ellipsis`, which will keep the text on one line plus it will break
  49201. * inside long words.
  49202. */
  49203. style?: CSSObject;
  49204. /**
  49205. * (Highcharts, Highstock, Highmaps, Gantt) Options for a label text which
  49206. * should follow marker's shape. Border and background are disabled for a
  49207. * label that follows a path.
  49208. *
  49209. * **Note:** Only SVG-based renderer supports this option. Setting `useHTML`
  49210. * to true will disable this option.
  49211. */
  49212. textPath?: DataLabelsTextPathOptionsObject;
  49213. /**
  49214. * (Highcharts, Highstock, Highmaps, Gantt) Whether to use HTML to render
  49215. * the labels.
  49216. */
  49217. useHTML?: boolean;
  49218. /**
  49219. * (Highcharts, Highstock, Highmaps, Gantt) The vertical alignment of a data
  49220. * label. Can be one of `top`, `middle` or `bottom`. The default value
  49221. * depends on the data, for instance in a column chart, the label is above
  49222. * positive values and below negative values.
  49223. */
  49224. verticalAlign?: (VerticalAlignValue|null);
  49225. /**
  49226. * (Highcharts, Highstock, Highmaps, Gantt) The x position offset of the
  49227. * label relative to the point in pixels.
  49228. */
  49229. x?: number;
  49230. /**
  49231. * (Highcharts, Highstock, Highmaps, Gantt) The y position offset of the
  49232. * label relative to the point in pixels.
  49233. */
  49234. y?: number;
  49235. /**
  49236. * (Highcharts, Highstock, Highmaps, Gantt) The Z index of the data labels.
  49237. * The default Z index puts it above the series. Use a Z index of 2 to
  49238. * display it behind the series.
  49239. */
  49240. z?: number;
  49241. }
  49242. /**
  49243. * (Highcharts, Highstock) Options for the series data sorting.
  49244. */
  49245. export interface PlotKeltnerchannelsDataSortingOptions {
  49246. /**
  49247. * (Highcharts, Highstock) Enable or disable data sorting for the series.
  49248. * Use xAxis.reversed to change the sorting order.
  49249. */
  49250. enabled?: boolean;
  49251. /**
  49252. * (Highcharts, Highstock) Whether to allow matching points by name in an
  49253. * update. If this option is disabled, points will be matched by order.
  49254. */
  49255. matchByName?: boolean;
  49256. /**
  49257. * (Highcharts, Highstock) Determines what data value should be used to sort
  49258. * by.
  49259. */
  49260. sortKey?: string;
  49261. }
  49262. /**
  49263. * (Highstock) Keltner Channels. This series requires the `linkedTo` option to
  49264. * be set and should be loaded after the `stock/indicators/indicators.js`,
  49265. * `stock/indicators/atr.js`, and `stock/ema/.js`.
  49266. *
  49267. * In TypeScript the type option must always be set.
  49268. *
  49269. * Configuration options for the series are given in three levels:
  49270. *
  49271. * 1. Options for all series in a chart are defined in the plotOptions.series
  49272. * object.
  49273. *
  49274. * 2. Options for all `keltnerchannels` series are defined in
  49275. * plotOptions.keltnerchannels.
  49276. *
  49277. * 3. Options for one single series are given in the series instance array. (see
  49278. * online documentation for example)
  49279. */
  49280. export interface PlotKeltnerchannelsOptions {
  49281. /**
  49282. * (Highstock) Accessibility options for a series.
  49283. */
  49284. accessibility?: SeriesAccessibilityOptionsObject;
  49285. /**
  49286. * (Highstock) Allow this series' points to be selected by clicking on the
  49287. * graphic (columns, point markers, pie slices, map areas etc).
  49288. *
  49289. * The selected points can be handled by point select and unselect events,
  49290. * or collectively by the getSelectedPoints function.
  49291. *
  49292. * And alternative way of selecting points is through dragging.
  49293. */
  49294. allowPointSelect?: boolean;
  49295. /**
  49296. * (Highstock) Enable or disable the initial animation when a series is
  49297. * displayed. The animation can also be set as a configuration object.
  49298. * Please note that this option only applies to the initial animation of the
  49299. * series itself. For other animations, see chart.animation and the
  49300. * animation parameter under the API methods. The following properties are
  49301. * supported:
  49302. *
  49303. * - `defer`: The animation delay time in milliseconds.
  49304. *
  49305. * - `duration`: The duration of the animation in milliseconds.
  49306. *
  49307. * - `easing`: Can be a string reference to an easing function set on the
  49308. * `Math` object or a function. See the _Custom easing function_ demo below.
  49309. *
  49310. * Due to poor performance, animation is disabled in old IE browsers for
  49311. * several chart types.
  49312. */
  49313. animation?: (boolean|PlotKeltnerchannelsAnimationOptions|Partial<AnimationOptionsObject>);
  49314. /**
  49315. * (Highstock) For some series, there is a limit that shuts down initial
  49316. * animation by default when the total number of points in the chart is too
  49317. * high. For example, for a column chart and its derivatives, animation does
  49318. * not run if there is more than 250 points totally. To disable this cap,
  49319. * set `animationLimit` to `Infinity`.
  49320. */
  49321. animationLimit?: number;
  49322. /**
  49323. * (Highstock) Sets the color blending in the boost module.
  49324. */
  49325. boostBlending?: OptionsBoostBlendingValue;
  49326. /**
  49327. * (Highstock) Set the point threshold for when a series should enter boost
  49328. * mode.
  49329. *
  49330. * Setting it to e.g. 2000 will cause the series to enter boost mode when
  49331. * there are 2000 or more points in the series.
  49332. *
  49333. * To disable boosting on the series, set the `boostThreshold` to 0. Setting
  49334. * it to 1 will force boosting.
  49335. *
  49336. * Note that the cropThreshold also affects this setting. When zooming in on
  49337. * a series that has fewer points than the `cropThreshold`, all points are
  49338. * rendered although outside the visible plot area, and the `boostThreshold`
  49339. * won't take effect.
  49340. */
  49341. boostThreshold?: number;
  49342. /**
  49343. * (Highmaps) The border color of the map areas.
  49344. *
  49345. * In styled mode, the border stroke is given in the `.highcharts-point`
  49346. * class.
  49347. */
  49348. borderColor?: (ColorString|GradientColorObject|PatternObject);
  49349. /**
  49350. * (Highmaps) The border width of each map area.
  49351. *
  49352. * In styled mode, the border stroke width is given in the
  49353. * `.highcharts-point` class.
  49354. */
  49355. borderWidth?: number;
  49356. /**
  49357. * (Highstock) Bottom line options.
  49358. */
  49359. bottomLine?: PlotKeltnerchannelsBottomLineOptions;
  49360. /**
  49361. * (Highstock) An additional class name to apply to the series' graphical
  49362. * elements. This option does not replace default class names of the
  49363. * graphical element.
  49364. */
  49365. className?: string;
  49366. /**
  49367. * (Highstock) Disable this option to allow series rendering in the whole
  49368. * plotting area.
  49369. *
  49370. * **Note:** Clipping should be always enabled when chart.zoomType is set
  49371. */
  49372. clip?: boolean;
  49373. /**
  49374. * (Highstock) The main color of the series. In line type series it applies
  49375. * to the line and the point markers unless otherwise specified. In bar type
  49376. * series it applies to the bars unless a color is specified per point. The
  49377. * default value is pulled from the `options.colors` array.
  49378. *
  49379. * In styled mode, the color can be defined by the colorIndex option. Also,
  49380. * the series color can be set with the `.highcharts-series`,
  49381. * `.highcharts-color-{n}`, `.highcharts-{type}-series` or
  49382. * `.highcharts-series-{n}` class, or individual classes given by the
  49383. * `className` option.
  49384. */
  49385. color?: (ColorString|GradientColorObject|PatternObject);
  49386. /**
  49387. * (Highstock) Styled mode only. A specific color index to use for the
  49388. * series, so its graphic representations are given the class name
  49389. * `highcharts-color-{n}`.
  49390. */
  49391. colorIndex?: number;
  49392. /**
  49393. * (Highcharts, Highstock, Highmaps) Determines what data value should be
  49394. * used to calculate point color if `colorAxis` is used. Requires to set
  49395. * `min` and `max` if some custom point property is used or if approximation
  49396. * for data grouping is set to `'sum'`.
  49397. */
  49398. colorKey?: string;
  49399. /**
  49400. * (Highstock) Defines if comparison should start from the first point
  49401. * within the visible range or should start from the first point **before**
  49402. * the range.
  49403. *
  49404. * In other words, this flag determines if first point within the visible
  49405. * range will have 0% (`compareStart=true`) or should have been already
  49406. * calculated according to the previous point (`compareStart=false`).
  49407. */
  49408. compareStart?: boolean;
  49409. /**
  49410. * (Highstock) Whether to compare indicator to the main series values or
  49411. * indicator values.
  49412. */
  49413. compareToMain?: boolean;
  49414. /**
  49415. * (Highcharts) Polar charts only. Whether to connect the ends of a line
  49416. * series plot across the extremes.
  49417. */
  49418. connectEnds?: boolean;
  49419. /**
  49420. * (Highcharts, Highstock) Whether to connect a graph line across null
  49421. * points, or render a gap between the two points on either side of the
  49422. * null.
  49423. */
  49424. connectNulls?: boolean;
  49425. /**
  49426. * (Gantt) Override Pathfinder connector options for a series. Requires
  49427. * Highcharts Gantt to be loaded.
  49428. */
  49429. connectors?: SeriesConnectorsOptionsObject;
  49430. /**
  49431. * (Highcharts, Highstock, Gantt) When true, each point or column edge is
  49432. * rounded to its nearest pixel in order to render sharp on screen. In some
  49433. * cases, when there are a lot of densely packed columns, this leads to
  49434. * visible difference in column widths or distance between columns. In these
  49435. * cases, setting `crisp` to `false` may look better, even though each
  49436. * column is rendered blurry.
  49437. */
  49438. crisp?: boolean;
  49439. /**
  49440. * (Highcharts, Highstock) When the series contains less points than the
  49441. * crop threshold, all points are drawn, even if the points fall outside the
  49442. * visible plot area at the current zoom. The advantage of drawing all
  49443. * points (including markers and columns), is that animation is performed on
  49444. * updates. On the other hand, when the series contains more points than the
  49445. * crop threshold, the series data is cropped to only contain points that
  49446. * fall within the plot area. The advantage of cropping away invisible
  49447. * points is to increase performance on large series.
  49448. */
  49449. cropThreshold?: number;
  49450. /**
  49451. * (Highstock) You can set the cursor to "pointer" if you have click events
  49452. * attached to the series, to signal to the user that the points and lines
  49453. * can be clicked.
  49454. *
  49455. * In styled mode, the series cursor can be set with the same classes as
  49456. * listed under series.color.
  49457. */
  49458. cursor?: (string|CursorValue);
  49459. /**
  49460. * (Highstock) A reserved subspace to store options and values for
  49461. * customized functionality. Here you can add additional data for your own
  49462. * event callbacks and formatter callbacks.
  49463. */
  49464. custom?: Dictionary<any>;
  49465. /**
  49466. * (Highstock) Name of the dash style to use for the graph, or for some
  49467. * series types the outline of each shape.
  49468. *
  49469. * In styled mode, the stroke dash-array can be set with the same classes as
  49470. * listed under series.color.
  49471. */
  49472. dashStyle?: DashStyleValue;
  49473. /**
  49474. * (Highstock) Data grouping is the concept of sampling the data values into
  49475. * larger blocks in order to ease readability and increase performance of
  49476. * the JavaScript charts. Highstock by default applies data grouping when
  49477. * the points become closer than a certain pixel value, determined by the
  49478. * `groupPixelWidth` option.
  49479. *
  49480. * If data grouping is applied, the grouping information of grouped points
  49481. * can be read from the Point.dataGroup. If point options other than the
  49482. * data itself are set, for example `name` or `color` or custom properties,
  49483. * the grouping logic doesn't know how to group it. In this case the options
  49484. * of the first point instance are copied over to the group point. This can
  49485. * be altered through a custom `approximation` callback function.
  49486. */
  49487. dataGrouping?: DataGroupingOptionsObject;
  49488. /**
  49489. * (Highcharts, Highstock, Highmaps, Gantt) Options for the series data
  49490. * labels, appearing next to each data point.
  49491. *
  49492. * Since v6.2.0, multiple data labels can be applied to each single point by
  49493. * defining them as an array of configs.
  49494. *
  49495. * In styled mode, the data labels can be styled with the
  49496. * `.highcharts-data-label-box` and `.highcharts-data-label` class names
  49497. * (see example).
  49498. */
  49499. dataLabels?: (PlotKeltnerchannelsDataLabelsOptions|Array<PlotKeltnerchannelsDataLabelsOptions>);
  49500. /**
  49501. * (Highcharts, Highstock) Options for the series data sorting.
  49502. */
  49503. dataSorting?: (DataSortingOptionsObject|PlotKeltnerchannelsDataSortingOptions);
  49504. /**
  49505. * (Highstock) A description of the series to add to the screen reader
  49506. * information about the series.
  49507. */
  49508. description?: string;
  49509. /**
  49510. * (Highstock) Enable or disable the mouse tracking for a specific series.
  49511. * This includes point tooltips and click events on graphs and points. For
  49512. * large datasets it improves performance.
  49513. */
  49514. enableMouseTracking?: boolean;
  49515. /**
  49516. * (Highstock) General event handlers for the series items. These event
  49517. * hooks can also be attached to the series at run time using the
  49518. * `Highcharts.addEvent` function.
  49519. */
  49520. events?: SeriesEventsOptionsObject;
  49521. /**
  49522. * (Highstock) Determines whether the series should look for the nearest
  49523. * point in both dimensions or just the x-dimension when hovering the
  49524. * series. Defaults to `'xy'` for scatter series and `'x'` for most other
  49525. * series. If the data has duplicate x-values, it is recommended to set this
  49526. * to `'xy'` to allow hovering over all points.
  49527. *
  49528. * Applies only to series types using nearest neighbor search (not direct
  49529. * hover) for tooltip.
  49530. */
  49531. findNearestPointBy?: OptionsFindNearestPointByValue;
  49532. /**
  49533. * (Highstock) Defines when to display a gap in the graph, together with the
  49534. * gapUnit option.
  49535. *
  49536. * In case when `dataGrouping` is enabled, points can be grouped into a
  49537. * larger time span. This can make the grouped points to have a greater
  49538. * distance than the absolute value of `gapSize` property, which will result
  49539. * in disappearing graph completely. To prevent this situation the mentioned
  49540. * distance between grouped points is used instead of previously defined
  49541. * `gapSize`.
  49542. *
  49543. * In practice, this option is most often used to visualize gaps in time
  49544. * series. In a stock chart, intraday data is available for daytime hours,
  49545. * while gaps will appear in nights and weekends.
  49546. */
  49547. gapSize?: number;
  49548. /**
  49549. * (Highstock) Together with gapSize, this option defines where to draw gaps
  49550. * in the graph.
  49551. *
  49552. * When the `gapUnit` is `"relative"` (default), a gap size of 5 means that
  49553. * if the distance between two points is greater than 5 times that of the
  49554. * two closest points, the graph will be broken.
  49555. *
  49556. * When the `gapUnit` is `"value"`, the gap is based on absolute axis
  49557. * values, which on a datetime axis is milliseconds. This also applies to
  49558. * the navigator series that inherits gap options from the base series.
  49559. */
  49560. gapUnit?: OptionsGapUnitValue;
  49561. /**
  49562. * (Highcharts, Highstock, Gantt) Whether to use the Y extremes of the total
  49563. * chart width or only the zoomed area when zooming in on parts of the X
  49564. * axis. By default, the Y axis adjusts to the min and max of the visible
  49565. * data. Cartesian series only.
  49566. */
  49567. getExtremesFromAll?: boolean;
  49568. /**
  49569. * (Highstock) When set to `false` will prevent the series data from being
  49570. * included in any form of data export.
  49571. *
  49572. * Since version 6.0.0 until 7.1.0 the option was existing undocumented as
  49573. * `includeInCSVExport`.
  49574. */
  49575. includeInDataExport?: boolean;
  49576. /**
  49577. * (Highcharts, Highstock, Gantt) Series labels are placed as close to the
  49578. * series as possible in a natural way, seeking to avoid other series. The
  49579. * goal of this feature is to make the chart more easily readable, like if a
  49580. * human designer placed the labels in the optimal position.
  49581. *
  49582. * The series labels currently work with series types having a `graph` or an
  49583. * `area`.
  49584. */
  49585. label?: SeriesLabelOptionsObject;
  49586. /**
  49587. * (Highstock) The line marks the last price from all points.
  49588. */
  49589. lastPrice?: SeriesLastPriceOptionsObject;
  49590. /**
  49591. * (Highstock) The line marks the last price from visible range of points.
  49592. */
  49593. lastVisiblePrice?: SeriesLastVisiblePriceOptionsObject;
  49594. /**
  49595. * (Highcharts, Highstock) The SVG value used for the `stroke-linecap` and
  49596. * `stroke-linejoin` of a line graph. Round means that lines are rounded in
  49597. * the ends and bends.
  49598. */
  49599. linecap?: SeriesLinecapValue;
  49600. /**
  49601. * (Highcharts, Highstock) Pixel width of the graph line.
  49602. */
  49603. lineWidth?: number;
  49604. /**
  49605. * (Highcharts, Highstock, Gantt) The main series ID that indicator will be
  49606. * based on. Required for this indicator.
  49607. */
  49608. linkedTo?: string;
  49609. /**
  49610. * (Highstock) Options for the point markers of line-like series. Properties
  49611. * like `fillColor`, `lineColor` and `lineWidth` define the visual
  49612. * appearance of the markers. Other series types, like column series, don't
  49613. * have markers, but have visual options on the series level instead.
  49614. *
  49615. * In styled mode, the markers can be styled with the `.highcharts-point`,
  49616. * `.highcharts-point-hover` and `.highcharts-point-select` class names.
  49617. */
  49618. marker?: PointMarkerOptionsObject;
  49619. /**
  49620. * (Highstock) The name of the series as shown in the legend, tooltip etc.
  49621. * If not set, it will be based on a technical indicator type and default
  49622. * params.
  49623. */
  49624. name?: string;
  49625. /**
  49626. * (Highstock) The color for the parts of the graph or points that are below
  49627. * the threshold. Note that `zones` takes precedence over the negative
  49628. * color. Using `negativeColor` is equivalent to applying a zone with value
  49629. * of 0.
  49630. */
  49631. negativeColor?: (ColorString|GradientColorObject|PatternObject);
  49632. /**
  49633. * (Highstock) Opacity of a series parts: line, fill (e.g. area) and
  49634. * dataLabels.
  49635. */
  49636. opacity?: number;
  49637. /**
  49638. * (Highstock) Paramters used in calculation of regression series' points.
  49639. */
  49640. params?: PlotKeltnerchannelsParamsOptions;
  49641. /**
  49642. * (Highstock) Properties for each single point.
  49643. */
  49644. point?: PlotSeriesPointOptions;
  49645. /**
  49646. * (Highstock) Same as accessibility.pointDescriptionFormatter, but for an
  49647. * individual series. Overrides the chart wide configuration.
  49648. */
  49649. pointDescriptionFormatter?: Function;
  49650. /**
  49651. * (Highstock) Whether to select the series initially. If `showCheckbox` is
  49652. * true, the checkbox next to the series name in the legend will be checked
  49653. * for a selected series.
  49654. */
  49655. selected?: boolean;
  49656. /**
  49657. * (Highstock) Whether to apply a drop shadow to the graph line. Since 2.3
  49658. * the shadow can be an object configuration containing `color`, `offsetX`,
  49659. * `offsetY`, `opacity` and `width`.
  49660. */
  49661. shadow?: (boolean|ShadowOptionsObject);
  49662. /**
  49663. * (Highstock) If true, a checkbox is displayed next to the legend item to
  49664. * allow selecting the series. The state of the checkbox is determined by
  49665. * the `selected` option.
  49666. */
  49667. showCheckbox?: boolean;
  49668. /**
  49669. * (Highstock) Whether to display this particular series or series type in
  49670. * the legend. Standalone series are shown in legend by default, and linked
  49671. * series are not. Since v7.2.0 it is possible to show series that use
  49672. * colorAxis by setting this option to `true`.
  49673. */
  49674. showInLegend?: boolean;
  49675. /**
  49676. * (Highstock) If set to `true`, the accessibility module will skip past the
  49677. * points in this series for keyboard navigation.
  49678. */
  49679. skipKeyboardNavigation?: boolean;
  49680. /**
  49681. * (Highcharts, Highstock) When this is true, the series will not cause the
  49682. * Y axis to cross the zero plane (or threshold option) unless the data
  49683. * actually crosses the plane.
  49684. *
  49685. * For example, if `softThreshold` is `false`, a series of 0, 1, 2, 3 will
  49686. * make the Y axis show negative values according to the `minPadding`
  49687. * option. If `softThreshold` is `true`, the Y axis starts at 0.
  49688. */
  49689. softThreshold?: boolean;
  49690. states?: SeriesStatesOptionsObject;
  49691. /**
  49692. * (Highcharts, Highstock) Whether to apply steps to the line. Possible
  49693. * values are `left`, `center` and `right`.
  49694. */
  49695. step?: OptionsStepValue;
  49696. /**
  49697. * (Highstock) Sticky tracking of mouse events. When true, the `mouseOut`
  49698. * event on a series isn't triggered until the mouse moves over another
  49699. * series, or out of the plot area. When false, the `mouseOut` event on a
  49700. * series is triggered when the mouse leaves the area around the series'
  49701. * graph or markers. This also implies the tooltip when not shared. When
  49702. * `stickyTracking` is false and `tooltip.shared` is false, the tooltip will
  49703. * be hidden when moving the mouse between series. Defaults to true for line
  49704. * and area type series, but to false for columns, pies etc.
  49705. *
  49706. * **Note:** The boost module will force this option because of technical
  49707. * limitations.
  49708. */
  49709. stickyTracking?: boolean;
  49710. /**
  49711. * (Highcharts, Highstock) The threshold, also called zero level or base
  49712. * level. For line type series this is only used in conjunction with
  49713. * negativeColor.
  49714. */
  49715. threshold?: (number|null);
  49716. /**
  49717. * (Highstock) A configuration object for the tooltip rendering of each
  49718. * single series. Properties are inherited from tooltip, but only the
  49719. * following properties can be defined on a series level.
  49720. */
  49721. tooltip?: SeriesTooltipOptionsObject;
  49722. /**
  49723. * (Highstock) Top line options.
  49724. */
  49725. topLine?: PlotKeltnerchannelsTopLineOptions;
  49726. /**
  49727. * (Highcharts, Highstock, Gantt) When a series contains a data array that
  49728. * is longer than this, only one dimensional arrays of numbers, or two
  49729. * dimensional arrays with x and y values are allowed. Also, only the first
  49730. * point is tested, and the rest are assumed to be the same format. This
  49731. * saves expensive data checking and indexing in long series. Set it to `0`
  49732. * disable.
  49733. *
  49734. * Note: In boost mode turbo threshold is forced. Only array of numbers or
  49735. * two dimensional arrays are allowed.
  49736. */
  49737. turboThreshold?: number;
  49738. /**
  49739. * (Highstock) Set the initial visibility of the series.
  49740. */
  49741. visible?: boolean;
  49742. /**
  49743. * (Highmaps) Define the z index of the series.
  49744. */
  49745. zIndex?: number;
  49746. /**
  49747. * (Highcharts, Highstock) Defines the Axis on which the zones are applied.
  49748. */
  49749. zoneAxis?: string;
  49750. /**
  49751. * (Highcharts, Highstock) An array defining zones within a series. Zones
  49752. * can be applied to the X axis, Y axis or Z axis for bubbles, according to
  49753. * the `zoneAxis` option. The zone definitions have to be in ascending order
  49754. * regarding to the value.
  49755. *
  49756. * In styled mode, the color zones are styled with the
  49757. * `.highcharts-zone-{n}` class, or custom classed from the `className`
  49758. * option (view live demo).
  49759. */
  49760. zones?: Array<SeriesZonesOptionsObject>;
  49761. }
  49762. /**
  49763. * (Highstock) Paramters used in calculation of regression series' points.
  49764. */
  49765. export interface PlotKeltnerchannelsParamsOptions {
  49766. /**
  49767. * (Highstock) The point index which indicator calculations will base. For
  49768. * example using OHLC data, index=2 means the indicator will be calculated
  49769. * using Low values.
  49770. */
  49771. index?: number;
  49772. /**
  49773. * (Highstock) The ATR multiplier.
  49774. */
  49775. multiplierATR?: number;
  49776. /**
  49777. * (Highstock) The base period for indicator calculations. This is the
  49778. * number of data points which are taken into account for the indicator
  49779. * calculations.
  49780. */
  49781. period?: number;
  49782. /**
  49783. * (Highstock) The ATR period.
  49784. */
  49785. periodATR?: number;
  49786. }
  49787. /**
  49788. * (Highstock) Top line options.
  49789. */
  49790. export interface PlotKeltnerchannelsTopLineOptions {
  49791. /**
  49792. * (Highstock) Styles for a bottom line.
  49793. */
  49794. styles?: PlotKeltnerchannelsTopLineStylesOptions;
  49795. }
  49796. /**
  49797. * (Highstock) Styles for a bottom line.
  49798. */
  49799. export interface PlotKeltnerchannelsTopLineStylesOptions {
  49800. /**
  49801. * (Highstock) Color of the line. If not set, it's inherited from
  49802. * `plotOptions.keltnerchannels.color`
  49803. */
  49804. lineColor?: string;
  49805. /**
  49806. * (Highstock) Pixel width of the line.
  49807. */
  49808. lineWidth?: number;
  49809. }
  49810. /**
  49811. * (Highcharts, Highstock) Enable or disable the initial animation when a series
  49812. * is displayed. The animation can also be set as a configuration object. Please
  49813. * note that this option only applies to the initial animation of the series
  49814. * itself. For other animations, see chart.animation and the animation parameter
  49815. * under the API methods. The following properties are supported:
  49816. *
  49817. * - `defer`: The animation delay time in milliseconds.
  49818. *
  49819. * - `duration`: The duration of the animation in milliseconds.
  49820. *
  49821. * - `easing`: Can be a string reference to an easing function set on the `Math`
  49822. * object or a function. See the _Custom easing function_ demo below.
  49823. *
  49824. * Due to poor performance, animation is disabled in old IE browsers for several
  49825. * chart types.
  49826. */
  49827. export interface PlotLineAnimationOptions {
  49828. defer?: number;
  49829. }
  49830. /**
  49831. * (Highstock) Enable or disable the initial animation when a series is
  49832. * displayed. The animation can also be set as a configuration object. Please
  49833. * note that this option only applies to the initial animation of the series
  49834. * itself. For other animations, see chart.animation and the animation parameter
  49835. * under the API methods. The following properties are supported:
  49836. *
  49837. * - `defer`: The animation delay time in milliseconds.
  49838. *
  49839. * - `duration`: The duration of the animation in milliseconds.
  49840. *
  49841. * - `easing`: Can be a string reference to an easing function set on the `Math`
  49842. * object or a function. See the _Custom easing function_ demo below.
  49843. *
  49844. * Due to poor performance, animation is disabled in old IE browsers for several
  49845. * chart types.
  49846. */
  49847. export interface PlotLinearregressionangleAnimationOptions {
  49848. defer?: number;
  49849. }
  49850. /**
  49851. * (Highcharts, Highstock, Highmaps, Gantt) Enable or disable the initial
  49852. * animation when a series is displayed for the `dataLabels`. The animation can
  49853. * also be set as a configuration object. Please note that this option only
  49854. * applies to the initial animation. For other animations, see chart.animation
  49855. * and the animation parameter under the API methods. The following properties
  49856. * are supported:
  49857. *
  49858. * - `defer`: The animation delay time in milliseconds.
  49859. */
  49860. export interface PlotLinearregressionangleDataLabelsAnimationOptions {
  49861. /**
  49862. * (Highcharts, Highstock, Highmaps, Gantt) The animation delay time in
  49863. * milliseconds. Set to `0` renders dataLabel immediately. As `undefined`
  49864. * inherits defer time from the series.animation.defer.
  49865. */
  49866. defer?: number;
  49867. }
  49868. /**
  49869. * (Highcharts, Highstock, Highmaps, Gantt) Options for the series data labels,
  49870. * appearing next to each data point.
  49871. *
  49872. * Since v6.2.0, multiple data labels can be applied to each single point by
  49873. * defining them as an array of configs.
  49874. *
  49875. * In styled mode, the data labels can be styled with the
  49876. * `.highcharts-data-label-box` and `.highcharts-data-label` class names (see
  49877. * example).
  49878. */
  49879. export interface PlotLinearregressionangleDataLabelsOptions {
  49880. /**
  49881. * (Highcharts, Highstock, Highmaps, Gantt) The alignment of the data label
  49882. * compared to the point. If `right`, the right side of the label should be
  49883. * touching the point. For points with an extent, like columns, the
  49884. * alignments also dictates how to align it inside the box, as given with
  49885. * the inside option. Can be one of `left`, `center` or `right`.
  49886. */
  49887. align?: (AlignValue|null);
  49888. /**
  49889. * (Highcharts, Highstock, Highmaps, Gantt) Whether to allow data labels to
  49890. * overlap. To make the labels less sensitive for overlapping, the
  49891. * dataLabels.padding can be set to 0.
  49892. */
  49893. allowOverlap?: boolean;
  49894. /**
  49895. * (Highcharts, Highstock, Highmaps, Gantt) Enable or disable the initial
  49896. * animation when a series is displayed for the `dataLabels`. The animation
  49897. * can also be set as a configuration object. Please note that this option
  49898. * only applies to the initial animation. For other animations, see
  49899. * chart.animation and the animation parameter under the API methods. The
  49900. * following properties are supported:
  49901. *
  49902. * - `defer`: The animation delay time in milliseconds.
  49903. */
  49904. animation?: (boolean|PlotLinearregressionangleDataLabelsAnimationOptions|Partial<AnimationOptionsObject>);
  49905. /**
  49906. * (Highcharts, Highstock, Highmaps, Gantt) The background color or gradient
  49907. * for the data label.
  49908. */
  49909. backgroundColor?: (ColorString|GradientColorObject|PatternObject);
  49910. /**
  49911. * (Highcharts, Highstock, Highmaps, Gantt) The border color for the data
  49912. * label. Defaults to `undefined`.
  49913. */
  49914. borderColor?: (ColorString|GradientColorObject|PatternObject);
  49915. /**
  49916. * (Highcharts, Highstock, Highmaps, Gantt) The border radius in pixels for
  49917. * the data label.
  49918. */
  49919. borderRadius?: number;
  49920. /**
  49921. * (Highcharts, Highstock, Highmaps, Gantt) The border width in pixels for
  49922. * the data label.
  49923. */
  49924. borderWidth?: number;
  49925. /**
  49926. * (Highcharts, Highstock, Highmaps, Gantt) A class name for the data label.
  49927. * Particularly in styled mode, this can be used to give each series' or
  49928. * point's data label unique styling. In addition to this option, a default
  49929. * color class name is added so that we can give the labels a contrast text
  49930. * shadow.
  49931. */
  49932. className?: string;
  49933. /**
  49934. * (Highcharts, Highstock, Highmaps, Gantt) The text color for the data
  49935. * labels. Defaults to `undefined`. For certain series types, like column or
  49936. * map, the data labels can be drawn inside the points. In this case the
  49937. * data label will be drawn with maximum contrast by default. Additionally,
  49938. * it will be given a `text-outline` style with the opposite color, to
  49939. * further increase the contrast. This can be overridden by setting the
  49940. * `text-outline` style to `none` in the `dataLabels.style` option.
  49941. */
  49942. color?: (ColorString|GradientColorObject|PatternObject);
  49943. /**
  49944. * (Highcharts, Highstock, Highmaps, Gantt) Whether to hide data labels that
  49945. * are outside the plot area. By default, the data label is moved inside the
  49946. * plot area according to the overflow option.
  49947. */
  49948. crop?: boolean;
  49949. /**
  49950. * (Highcharts, Highstock, Gantt) Whether to defer displaying the data
  49951. * labels until the initial series animation has finished. Setting to
  49952. * `false` renders the data label immediately. If set to `true` inherits the
  49953. * defer time set in plotOptions.series.animation.
  49954. */
  49955. defer?: boolean;
  49956. /**
  49957. * (Highcharts, Highstock, Highmaps, Gantt) Enable or disable the data
  49958. * labels.
  49959. */
  49960. enabled?: boolean;
  49961. /**
  49962. * (Highcharts, Highstock, Highmaps, Gantt) A declarative filter to control
  49963. * of which data labels to display. The declarative filter is designed for
  49964. * use when callback functions are not available, like when the chart
  49965. * options require a pure JSON structure or for use with graphical editors.
  49966. * For programmatic control, use the `formatter` instead, and return
  49967. * `undefined` to disable a single data label.
  49968. */
  49969. filter?: DataLabelsFilterOptionsObject;
  49970. /**
  49971. * (Highcharts, Highstock, Highmaps, Gantt) A format string for the data
  49972. * label. Available variables are the same as for `formatter`.
  49973. */
  49974. format?: string;
  49975. /**
  49976. * (Highcharts, Highstock, Highmaps, Gantt) Callback JavaScript function to
  49977. * format the data label. Note that if a `format` is defined, the format
  49978. * takes precedence and the formatter is ignored.
  49979. */
  49980. formatter?: DataLabelsFormatterCallbackFunction;
  49981. /**
  49982. * (Highcharts, Highstock, Highmaps, Gantt) For points with an extent, like
  49983. * columns or map areas, whether to align the data label inside the box or
  49984. * to the actual value point. Defaults to `false` in most cases, `true` in
  49985. * stacked columns.
  49986. */
  49987. inside?: boolean;
  49988. /**
  49989. * (Highcharts, Highstock, Highmaps, Gantt) Format for points with the value
  49990. * of null. Works analogously to format. `nullFormat` can be applied only to
  49991. * series which support displaying null points.
  49992. */
  49993. nullFormat?: (boolean|string);
  49994. /**
  49995. * (Highcharts, Highstock, Highmaps, Gantt) Callback JavaScript function
  49996. * that defines formatting for points with the value of null. Works
  49997. * analogously to formatter. `nullPointFormatter` can be applied only to
  49998. * series which support displaying null points.
  49999. */
  50000. nullFormatter?: DataLabelsFormatterCallbackFunction;
  50001. /**
  50002. * (Highcharts, Highstock, Highmaps, Gantt) How to handle data labels that
  50003. * flow outside the plot area. The default is `"justify"`, which aligns them
  50004. * inside the plot area. For columns and bars, this means it will be moved
  50005. * inside the bar. To display data labels outside the plot area, set `crop`
  50006. * to `false` and `overflow` to `"allow"`.
  50007. */
  50008. overflow?: DataLabelsOverflowValue;
  50009. /**
  50010. * (Highcharts, Highstock, Highmaps, Gantt) When either the `borderWidth` or
  50011. * the `backgroundColor` is set, this is the padding within the box.
  50012. */
  50013. padding?: number;
  50014. /**
  50015. * (Highcharts, Highstock, Highmaps, Gantt) Aligns data labels relative to
  50016. * points. If `center` alignment is not possible, it defaults to `right`.
  50017. */
  50018. position?: AlignValue;
  50019. /**
  50020. * (Highcharts, Highstock, Highmaps, Gantt) Text rotation in degrees. Note
  50021. * that due to a more complex structure, backgrounds, borders and padding
  50022. * will be lost on a rotated data label.
  50023. */
  50024. rotation?: number;
  50025. /**
  50026. * (Highcharts, Highstock, Highmaps, Gantt) The shadow of the box. Works
  50027. * best with `borderWidth` or `backgroundColor`. Since 2.3 the shadow can be
  50028. * an object configuration containing `color`, `offsetX`, `offsetY`,
  50029. * `opacity` and `width`.
  50030. */
  50031. shadow?: (boolean|ShadowOptionsObject);
  50032. /**
  50033. * (Highcharts, Highstock, Highmaps, Gantt) The name of a symbol to use for
  50034. * the border around the label. Symbols are predefined functions on the
  50035. * Renderer object.
  50036. */
  50037. shape?: string;
  50038. /**
  50039. * (Highcharts, Highstock, Highmaps, Gantt) Styles for the label. The
  50040. * default `color` setting is `"contrast"`, which is a pseudo color that
  50041. * Highcharts picks up and applies the maximum contrast to the underlying
  50042. * point item, for example the bar in a bar chart.
  50043. *
  50044. * The `textOutline` is a pseudo property that applies an outline of the
  50045. * given width with the given color, which by default is the maximum
  50046. * contrast to the text. So a bright text color will result in a black text
  50047. * outline for maximum readability on a mixed background. In some cases,
  50048. * especially with grayscale text, the text outline doesn't work well, in
  50049. * which cases it can be disabled by setting it to `"none"`. When `useHTML`
  50050. * is true, the `textOutline` will not be picked up. In this, case, the same
  50051. * effect can be acheived through the `text-shadow` CSS property.
  50052. *
  50053. * For some series types, where each point has an extent, like for example
  50054. * tree maps, the data label may overflow the point. There are two
  50055. * strategies for handling overflow. By default, the text will wrap to
  50056. * multiple lines. The other strategy is to set `style.textOverflow` to
  50057. * `ellipsis`, which will keep the text on one line plus it will break
  50058. * inside long words.
  50059. */
  50060. style?: CSSObject;
  50061. /**
  50062. * (Highcharts, Highstock, Highmaps, Gantt) Options for a label text which
  50063. * should follow marker's shape. Border and background are disabled for a
  50064. * label that follows a path.
  50065. *
  50066. * **Note:** Only SVG-based renderer supports this option. Setting `useHTML`
  50067. * to true will disable this option.
  50068. */
  50069. textPath?: DataLabelsTextPathOptionsObject;
  50070. /**
  50071. * (Highcharts, Highstock, Highmaps, Gantt) Whether to use HTML to render
  50072. * the labels.
  50073. */
  50074. useHTML?: boolean;
  50075. /**
  50076. * (Highcharts, Highstock, Highmaps, Gantt) The vertical alignment of a data
  50077. * label. Can be one of `top`, `middle` or `bottom`. The default value
  50078. * depends on the data, for instance in a column chart, the label is above
  50079. * positive values and below negative values.
  50080. */
  50081. verticalAlign?: (VerticalAlignValue|null);
  50082. /**
  50083. * (Highcharts, Highstock, Highmaps, Gantt) The x position offset of the
  50084. * label relative to the point in pixels.
  50085. */
  50086. x?: number;
  50087. /**
  50088. * (Highcharts, Highstock, Highmaps, Gantt) The y position offset of the
  50089. * label relative to the point in pixels.
  50090. */
  50091. y?: number;
  50092. /**
  50093. * (Highcharts, Highstock, Highmaps, Gantt) The Z index of the data labels.
  50094. * The default Z index puts it above the series. Use a Z index of 2 to
  50095. * display it behind the series.
  50096. */
  50097. z?: number;
  50098. }
  50099. /**
  50100. * (Highcharts, Highstock) Options for the series data sorting.
  50101. */
  50102. export interface PlotLinearregressionangleDataSortingOptions {
  50103. /**
  50104. * (Highcharts, Highstock) Enable or disable data sorting for the series.
  50105. * Use xAxis.reversed to change the sorting order.
  50106. */
  50107. enabled?: boolean;
  50108. /**
  50109. * (Highcharts, Highstock) Whether to allow matching points by name in an
  50110. * update. If this option is disabled, points will be matched by order.
  50111. */
  50112. matchByName?: boolean;
  50113. /**
  50114. * (Highcharts, Highstock) Determines what data value should be used to sort
  50115. * by.
  50116. */
  50117. sortKey?: string;
  50118. }
  50119. /**
  50120. * (Highstock) Linear regression angle indicator. This series requires
  50121. * `linkedTo` option to be set.
  50122. *
  50123. * In TypeScript the type option must always be set.
  50124. *
  50125. * Configuration options for the series are given in three levels:
  50126. *
  50127. * 1. Options for all series in a chart are defined in the plotOptions.series
  50128. * object.
  50129. *
  50130. * 2. Options for all `linearregressionangle` series are defined in
  50131. * plotOptions.linearregressionangle.
  50132. *
  50133. * 3. Options for one single series are given in the series instance array. (see
  50134. * online documentation for example)
  50135. */
  50136. export interface PlotLinearregressionangleOptions {
  50137. /**
  50138. * (Highstock) Accessibility options for a series.
  50139. */
  50140. accessibility?: SeriesAccessibilityOptionsObject;
  50141. /**
  50142. * (Highstock) Allow this series' points to be selected by clicking on the
  50143. * graphic (columns, point markers, pie slices, map areas etc).
  50144. *
  50145. * The selected points can be handled by point select and unselect events,
  50146. * or collectively by the getSelectedPoints function.
  50147. *
  50148. * And alternative way of selecting points is through dragging.
  50149. */
  50150. allowPointSelect?: boolean;
  50151. /**
  50152. * (Highstock) Enable or disable the initial animation when a series is
  50153. * displayed. The animation can also be set as a configuration object.
  50154. * Please note that this option only applies to the initial animation of the
  50155. * series itself. For other animations, see chart.animation and the
  50156. * animation parameter under the API methods. The following properties are
  50157. * supported:
  50158. *
  50159. * - `defer`: The animation delay time in milliseconds.
  50160. *
  50161. * - `duration`: The duration of the animation in milliseconds.
  50162. *
  50163. * - `easing`: Can be a string reference to an easing function set on the
  50164. * `Math` object or a function. See the _Custom easing function_ demo below.
  50165. *
  50166. * Due to poor performance, animation is disabled in old IE browsers for
  50167. * several chart types.
  50168. */
  50169. animation?: (boolean|PlotLinearregressionangleAnimationOptions|Partial<AnimationOptionsObject>);
  50170. /**
  50171. * (Highstock) For some series, there is a limit that shuts down initial
  50172. * animation by default when the total number of points in the chart is too
  50173. * high. For example, for a column chart and its derivatives, animation does
  50174. * not run if there is more than 250 points totally. To disable this cap,
  50175. * set `animationLimit` to `Infinity`.
  50176. */
  50177. animationLimit?: number;
  50178. /**
  50179. * (Highstock) Sets the color blending in the boost module.
  50180. */
  50181. boostBlending?: OptionsBoostBlendingValue;
  50182. /**
  50183. * (Highstock) Set the point threshold for when a series should enter boost
  50184. * mode.
  50185. *
  50186. * Setting it to e.g. 2000 will cause the series to enter boost mode when
  50187. * there are 2000 or more points in the series.
  50188. *
  50189. * To disable boosting on the series, set the `boostThreshold` to 0. Setting
  50190. * it to 1 will force boosting.
  50191. *
  50192. * Note that the cropThreshold also affects this setting. When zooming in on
  50193. * a series that has fewer points than the `cropThreshold`, all points are
  50194. * rendered although outside the visible plot area, and the `boostThreshold`
  50195. * won't take effect.
  50196. */
  50197. boostThreshold?: number;
  50198. /**
  50199. * (Highmaps) The border color of the map areas.
  50200. *
  50201. * In styled mode, the border stroke is given in the `.highcharts-point`
  50202. * class.
  50203. */
  50204. borderColor?: (ColorString|GradientColorObject|PatternObject);
  50205. /**
  50206. * (Highmaps) The border width of each map area.
  50207. *
  50208. * In styled mode, the border stroke width is given in the
  50209. * `.highcharts-point` class.
  50210. */
  50211. borderWidth?: number;
  50212. /**
  50213. * (Highstock) An additional class name to apply to the series' graphical
  50214. * elements. This option does not replace default class names of the
  50215. * graphical element.
  50216. */
  50217. className?: string;
  50218. /**
  50219. * (Highstock) Disable this option to allow series rendering in the whole
  50220. * plotting area.
  50221. *
  50222. * **Note:** Clipping should be always enabled when chart.zoomType is set
  50223. */
  50224. clip?: boolean;
  50225. /**
  50226. * (Highstock) The main color of the series. In line type series it applies
  50227. * to the line and the point markers unless otherwise specified. In bar type
  50228. * series it applies to the bars unless a color is specified per point. The
  50229. * default value is pulled from the `options.colors` array.
  50230. *
  50231. * In styled mode, the color can be defined by the colorIndex option. Also,
  50232. * the series color can be set with the `.highcharts-series`,
  50233. * `.highcharts-color-{n}`, `.highcharts-{type}-series` or
  50234. * `.highcharts-series-{n}` class, or individual classes given by the
  50235. * `className` option.
  50236. */
  50237. color?: (ColorString|GradientColorObject|PatternObject);
  50238. /**
  50239. * (Highstock) Styled mode only. A specific color index to use for the
  50240. * series, so its graphic representations are given the class name
  50241. * `highcharts-color-{n}`.
  50242. */
  50243. colorIndex?: number;
  50244. /**
  50245. * (Highcharts, Highstock, Highmaps) Determines what data value should be
  50246. * used to calculate point color if `colorAxis` is used. Requires to set
  50247. * `min` and `max` if some custom point property is used or if approximation
  50248. * for data grouping is set to `'sum'`.
  50249. */
  50250. colorKey?: string;
  50251. /**
  50252. * (Highstock) Compare the values of the series against the first non-null,
  50253. * non- zero value in the visible range. The y axis will show percentage or
  50254. * absolute change depending on whether `compare` is set to `"percent"` or
  50255. * `"value"`. When this is applied to multiple series, it allows comparing
  50256. * the development of the series against each other. Adds a `change` field
  50257. * to every point object.
  50258. */
  50259. compare?: string;
  50260. /**
  50261. * (Highstock) When compare is `percent`, this option dictates whether to
  50262. * use 0 or 100 as the base of comparison.
  50263. */
  50264. compareBase?: (0|100);
  50265. /**
  50266. * (Highstock) Defines if comparison should start from the first point
  50267. * within the visible range or should start from the first point **before**
  50268. * the range.
  50269. *
  50270. * In other words, this flag determines if first point within the visible
  50271. * range will have 0% (`compareStart=true`) or should have been already
  50272. * calculated according to the previous point (`compareStart=false`).
  50273. */
  50274. compareStart?: boolean;
  50275. /**
  50276. * (Highstock) Whether to compare indicator to the main series values or
  50277. * indicator values.
  50278. */
  50279. compareToMain?: boolean;
  50280. /**
  50281. * (Highcharts) Polar charts only. Whether to connect the ends of a line
  50282. * series plot across the extremes.
  50283. */
  50284. connectEnds?: boolean;
  50285. /**
  50286. * (Highcharts, Highstock) Whether to connect a graph line across null
  50287. * points, or render a gap between the two points on either side of the
  50288. * null.
  50289. */
  50290. connectNulls?: boolean;
  50291. /**
  50292. * (Gantt) Override Pathfinder connector options for a series. Requires
  50293. * Highcharts Gantt to be loaded.
  50294. */
  50295. connectors?: SeriesConnectorsOptionsObject;
  50296. /**
  50297. * (Highcharts, Highstock, Gantt) When true, each point or column edge is
  50298. * rounded to its nearest pixel in order to render sharp on screen. In some
  50299. * cases, when there are a lot of densely packed columns, this leads to
  50300. * visible difference in column widths or distance between columns. In these
  50301. * cases, setting `crisp` to `false` may look better, even though each
  50302. * column is rendered blurry.
  50303. */
  50304. crisp?: boolean;
  50305. /**
  50306. * (Highcharts, Highstock) When the series contains less points than the
  50307. * crop threshold, all points are drawn, even if the points fall outside the
  50308. * visible plot area at the current zoom. The advantage of drawing all
  50309. * points (including markers and columns), is that animation is performed on
  50310. * updates. On the other hand, when the series contains more points than the
  50311. * crop threshold, the series data is cropped to only contain points that
  50312. * fall within the plot area. The advantage of cropping away invisible
  50313. * points is to increase performance on large series.
  50314. */
  50315. cropThreshold?: number;
  50316. /**
  50317. * (Highstock) You can set the cursor to "pointer" if you have click events
  50318. * attached to the series, to signal to the user that the points and lines
  50319. * can be clicked.
  50320. *
  50321. * In styled mode, the series cursor can be set with the same classes as
  50322. * listed under series.color.
  50323. */
  50324. cursor?: (string|CursorValue);
  50325. /**
  50326. * (Highstock) A reserved subspace to store options and values for
  50327. * customized functionality. Here you can add additional data for your own
  50328. * event callbacks and formatter callbacks.
  50329. */
  50330. custom?: Dictionary<any>;
  50331. /**
  50332. * (Highstock) Name of the dash style to use for the graph, or for some
  50333. * series types the outline of each shape.
  50334. *
  50335. * In styled mode, the stroke dash-array can be set with the same classes as
  50336. * listed under series.color.
  50337. */
  50338. dashStyle?: DashStyleValue;
  50339. /**
  50340. * (Highstock) Data grouping is the concept of sampling the data values into
  50341. * larger blocks in order to ease readability and increase performance of
  50342. * the JavaScript charts. Highstock by default applies data grouping when
  50343. * the points become closer than a certain pixel value, determined by the
  50344. * `groupPixelWidth` option.
  50345. *
  50346. * If data grouping is applied, the grouping information of grouped points
  50347. * can be read from the Point.dataGroup. If point options other than the
  50348. * data itself are set, for example `name` or `color` or custom properties,
  50349. * the grouping logic doesn't know how to group it. In this case the options
  50350. * of the first point instance are copied over to the group point. This can
  50351. * be altered through a custom `approximation` callback function.
  50352. */
  50353. dataGrouping?: DataGroupingOptionsObject;
  50354. /**
  50355. * (Highcharts, Highstock, Highmaps, Gantt) Options for the series data
  50356. * labels, appearing next to each data point.
  50357. *
  50358. * Since v6.2.0, multiple data labels can be applied to each single point by
  50359. * defining them as an array of configs.
  50360. *
  50361. * In styled mode, the data labels can be styled with the
  50362. * `.highcharts-data-label-box` and `.highcharts-data-label` class names
  50363. * (see example).
  50364. */
  50365. dataLabels?: (PlotLinearregressionangleDataLabelsOptions|Array<PlotLinearregressionangleDataLabelsOptions>);
  50366. /**
  50367. * (Highcharts, Highstock) Options for the series data sorting.
  50368. */
  50369. dataSorting?: (DataSortingOptionsObject|PlotLinearregressionangleDataSortingOptions);
  50370. /**
  50371. * (Highstock) A description of the series to add to the screen reader
  50372. * information about the series.
  50373. */
  50374. description?: string;
  50375. /**
  50376. * (Highstock) Enable or disable the mouse tracking for a specific series.
  50377. * This includes point tooltips and click events on graphs and points. For
  50378. * large datasets it improves performance.
  50379. */
  50380. enableMouseTracking?: boolean;
  50381. /**
  50382. * (Highstock) General event handlers for the series items. These event
  50383. * hooks can also be attached to the series at run time using the
  50384. * `Highcharts.addEvent` function.
  50385. */
  50386. events?: SeriesEventsOptionsObject;
  50387. /**
  50388. * (Highstock) Determines whether the series should look for the nearest
  50389. * point in both dimensions or just the x-dimension when hovering the
  50390. * series. Defaults to `'xy'` for scatter series and `'x'` for most other
  50391. * series. If the data has duplicate x-values, it is recommended to set this
  50392. * to `'xy'` to allow hovering over all points.
  50393. *
  50394. * Applies only to series types using nearest neighbor search (not direct
  50395. * hover) for tooltip.
  50396. */
  50397. findNearestPointBy?: OptionsFindNearestPointByValue;
  50398. /**
  50399. * (Highstock) Defines when to display a gap in the graph, together with the
  50400. * gapUnit option.
  50401. *
  50402. * In case when `dataGrouping` is enabled, points can be grouped into a
  50403. * larger time span. This can make the grouped points to have a greater
  50404. * distance than the absolute value of `gapSize` property, which will result
  50405. * in disappearing graph completely. To prevent this situation the mentioned
  50406. * distance between grouped points is used instead of previously defined
  50407. * `gapSize`.
  50408. *
  50409. * In practice, this option is most often used to visualize gaps in time
  50410. * series. In a stock chart, intraday data is available for daytime hours,
  50411. * while gaps will appear in nights and weekends.
  50412. */
  50413. gapSize?: number;
  50414. /**
  50415. * (Highstock) Together with gapSize, this option defines where to draw gaps
  50416. * in the graph.
  50417. *
  50418. * When the `gapUnit` is `"relative"` (default), a gap size of 5 means that
  50419. * if the distance between two points is greater than 5 times that of the
  50420. * two closest points, the graph will be broken.
  50421. *
  50422. * When the `gapUnit` is `"value"`, the gap is based on absolute axis
  50423. * values, which on a datetime axis is milliseconds. This also applies to
  50424. * the navigator series that inherits gap options from the base series.
  50425. */
  50426. gapUnit?: OptionsGapUnitValue;
  50427. /**
  50428. * (Highcharts, Highstock, Gantt) Whether to use the Y extremes of the total
  50429. * chart width or only the zoomed area when zooming in on parts of the X
  50430. * axis. By default, the Y axis adjusts to the min and max of the visible
  50431. * data. Cartesian series only.
  50432. */
  50433. getExtremesFromAll?: boolean;
  50434. /**
  50435. * (Highstock) When set to `false` will prevent the series data from being
  50436. * included in any form of data export.
  50437. *
  50438. * Since version 6.0.0 until 7.1.0 the option was existing undocumented as
  50439. * `includeInCSVExport`.
  50440. */
  50441. includeInDataExport?: boolean;
  50442. /**
  50443. * (Highcharts, Highstock, Gantt) Series labels are placed as close to the
  50444. * series as possible in a natural way, seeking to avoid other series. The
  50445. * goal of this feature is to make the chart more easily readable, like if a
  50446. * human designer placed the labels in the optimal position.
  50447. *
  50448. * The series labels currently work with series types having a `graph` or an
  50449. * `area`.
  50450. */
  50451. label?: SeriesLabelOptionsObject;
  50452. /**
  50453. * (Highstock) The line marks the last price from all points.
  50454. */
  50455. lastPrice?: SeriesLastPriceOptionsObject;
  50456. /**
  50457. * (Highstock) The line marks the last price from visible range of points.
  50458. */
  50459. lastVisiblePrice?: SeriesLastVisiblePriceOptionsObject;
  50460. /**
  50461. * (Highcharts, Highstock) The SVG value used for the `stroke-linecap` and
  50462. * `stroke-linejoin` of a line graph. Round means that lines are rounded in
  50463. * the ends and bends.
  50464. */
  50465. linecap?: SeriesLinecapValue;
  50466. /**
  50467. * (Highcharts, Highstock) Pixel width of the graph line.
  50468. */
  50469. lineWidth?: number;
  50470. /**
  50471. * (Highcharts, Highstock, Gantt) The main series ID that indicator will be
  50472. * based on. Required for this indicator.
  50473. */
  50474. linkedTo?: string;
  50475. /**
  50476. * (Highstock) Options for the point markers of line-like series. Properties
  50477. * like `fillColor`, `lineColor` and `lineWidth` define the visual
  50478. * appearance of the markers. Other series types, like column series, don't
  50479. * have markers, but have visual options on the series level instead.
  50480. *
  50481. * In styled mode, the markers can be styled with the `.highcharts-point`,
  50482. * `.highcharts-point-hover` and `.highcharts-point-select` class names.
  50483. */
  50484. marker?: PointMarkerOptionsObject;
  50485. /**
  50486. * (Highstock) The name of the series as shown in the legend, tooltip etc.
  50487. * If not set, it will be based on a technical indicator type and default
  50488. * params.
  50489. */
  50490. name?: string;
  50491. /**
  50492. * (Highstock) The color for the parts of the graph or points that are below
  50493. * the threshold. Note that `zones` takes precedence over the negative
  50494. * color. Using `negativeColor` is equivalent to applying a zone with value
  50495. * of 0.
  50496. */
  50497. negativeColor?: (ColorString|GradientColorObject|PatternObject);
  50498. /**
  50499. * (Highstock) Opacity of a series parts: line, fill (e.g. area) and
  50500. * dataLabels.
  50501. */
  50502. opacity?: number;
  50503. /**
  50504. * (Highstock) Paramters used in calculation of regression series' points.
  50505. */
  50506. params?: PlotLinearregressionangleParamsOptions;
  50507. /**
  50508. * (Highstock) Properties for each single point.
  50509. */
  50510. point?: PlotSeriesPointOptions;
  50511. /**
  50512. * (Highstock) Same as accessibility.pointDescriptionFormatter, but for an
  50513. * individual series. Overrides the chart wide configuration.
  50514. */
  50515. pointDescriptionFormatter?: Function;
  50516. /**
  50517. * (Highstock) Whether to select the series initially. If `showCheckbox` is
  50518. * true, the checkbox next to the series name in the legend will be checked
  50519. * for a selected series.
  50520. */
  50521. selected?: boolean;
  50522. /**
  50523. * (Highstock) Whether to apply a drop shadow to the graph line. Since 2.3
  50524. * the shadow can be an object configuration containing `color`, `offsetX`,
  50525. * `offsetY`, `opacity` and `width`.
  50526. */
  50527. shadow?: (boolean|ShadowOptionsObject);
  50528. /**
  50529. * (Highstock) If true, a checkbox is displayed next to the legend item to
  50530. * allow selecting the series. The state of the checkbox is determined by
  50531. * the `selected` option.
  50532. */
  50533. showCheckbox?: boolean;
  50534. /**
  50535. * (Highstock) Whether to display this particular series or series type in
  50536. * the legend. Standalone series are shown in legend by default, and linked
  50537. * series are not. Since v7.2.0 it is possible to show series that use
  50538. * colorAxis by setting this option to `true`.
  50539. */
  50540. showInLegend?: boolean;
  50541. /**
  50542. * (Highstock) If set to `true`, the accessibility module will skip past the
  50543. * points in this series for keyboard navigation.
  50544. */
  50545. skipKeyboardNavigation?: boolean;
  50546. /**
  50547. * (Highcharts, Highstock) When this is true, the series will not cause the
  50548. * Y axis to cross the zero plane (or threshold option) unless the data
  50549. * actually crosses the plane.
  50550. *
  50551. * For example, if `softThreshold` is `false`, a series of 0, 1, 2, 3 will
  50552. * make the Y axis show negative values according to the `minPadding`
  50553. * option. If `softThreshold` is `true`, the Y axis starts at 0.
  50554. */
  50555. softThreshold?: boolean;
  50556. states?: SeriesStatesOptionsObject;
  50557. /**
  50558. * (Highcharts, Highstock) Whether to apply steps to the line. Possible
  50559. * values are `left`, `center` and `right`.
  50560. */
  50561. step?: OptionsStepValue;
  50562. /**
  50563. * (Highstock) Sticky tracking of mouse events. When true, the `mouseOut`
  50564. * event on a series isn't triggered until the mouse moves over another
  50565. * series, or out of the plot area. When false, the `mouseOut` event on a
  50566. * series is triggered when the mouse leaves the area around the series'
  50567. * graph or markers. This also implies the tooltip when not shared. When
  50568. * `stickyTracking` is false and `tooltip.shared` is false, the tooltip will
  50569. * be hidden when moving the mouse between series. Defaults to true for line
  50570. * and area type series, but to false for columns, pies etc.
  50571. *
  50572. * **Note:** The boost module will force this option because of technical
  50573. * limitations.
  50574. */
  50575. stickyTracking?: boolean;
  50576. /**
  50577. * (Highcharts, Highstock) The threshold, also called zero level or base
  50578. * level. For line type series this is only used in conjunction with
  50579. * negativeColor.
  50580. */
  50581. threshold?: (number|null);
  50582. /**
  50583. * (Highstock) A configuration object for the tooltip rendering of each
  50584. * single series. Properties are inherited from tooltip, but only the
  50585. * following properties can be defined on a series level.
  50586. */
  50587. tooltip?: SeriesTooltipOptionsObject;
  50588. /**
  50589. * (Highcharts, Highstock, Gantt) When a series contains a data array that
  50590. * is longer than this, only one dimensional arrays of numbers, or two
  50591. * dimensional arrays with x and y values are allowed. Also, only the first
  50592. * point is tested, and the rest are assumed to be the same format. This
  50593. * saves expensive data checking and indexing in long series. Set it to `0`
  50594. * disable.
  50595. *
  50596. * Note: In boost mode turbo threshold is forced. Only array of numbers or
  50597. * two dimensional arrays are allowed.
  50598. */
  50599. turboThreshold?: number;
  50600. /**
  50601. * (Highstock) Set the initial visibility of the series.
  50602. */
  50603. visible?: boolean;
  50604. /**
  50605. * (Highmaps) Define the z index of the series.
  50606. */
  50607. zIndex?: number;
  50608. /**
  50609. * (Highcharts, Highstock) Defines the Axis on which the zones are applied.
  50610. */
  50611. zoneAxis?: string;
  50612. /**
  50613. * (Highcharts, Highstock) An array defining zones within a series. Zones
  50614. * can be applied to the X axis, Y axis or Z axis for bubbles, according to
  50615. * the `zoneAxis` option. The zone definitions have to be in ascending order
  50616. * regarding to the value.
  50617. *
  50618. * In styled mode, the color zones are styled with the
  50619. * `.highcharts-zone-{n}` class, or custom classed from the `className`
  50620. * option (view live demo).
  50621. */
  50622. zones?: Array<SeriesZonesOptionsObject>;
  50623. }
  50624. /**
  50625. * (Highstock) Paramters used in calculation of regression series' points.
  50626. */
  50627. export interface PlotLinearregressionangleParamsOptions {
  50628. /**
  50629. * (Highstock) The point index which indicator calculations will base. For
  50630. * example using OHLC data, index=2 means the indicator will be calculated
  50631. * using Low values.
  50632. */
  50633. index?: number;
  50634. /**
  50635. * (Highstock) The base period for indicator calculations. This is the
  50636. * number of data points which are taken into account for the indicator
  50637. * calculations.
  50638. */
  50639. period?: number;
  50640. /**
  50641. * (Highstock) Unit (in milliseconds) for the x axis distances used to
  50642. * compute the regression line paramters (slope & intercept) for every
  50643. * range. In Highstock the x axis values are always represented in
  50644. * milliseconds which may cause that distances between points are "big"
  50645. * integer numbers.
  50646. *
  50647. * Highstock's linear regression algorithm (least squares method) will
  50648. * utilize these "big" integers for finding the slope and the intercept of
  50649. * the regression line for each period. In consequence, this value may be a
  50650. * very "small" decimal number that's hard to interpret by a human.
  50651. *
  50652. * For instance: `xAxisUnit` equealed to `86400000` ms (1 day) forces the
  50653. * algorithm to treat `86400000` as `1` while computing the slope and the
  50654. * intercept. This may enchance the legiblitity of the indicator's values.
  50655. *
  50656. * Default value is the closest distance between two data points.
  50657. */
  50658. xAxisUnit?: number;
  50659. }
  50660. /**
  50661. * (Highstock) Enable or disable the initial animation when a series is
  50662. * displayed. The animation can also be set as a configuration object. Please
  50663. * note that this option only applies to the initial animation of the series
  50664. * itself. For other animations, see chart.animation and the animation parameter
  50665. * under the API methods. The following properties are supported:
  50666. *
  50667. * - `defer`: The animation delay time in milliseconds.
  50668. *
  50669. * - `duration`: The duration of the animation in milliseconds.
  50670. *
  50671. * - `easing`: Can be a string reference to an easing function set on the `Math`
  50672. * object or a function. See the _Custom easing function_ demo below.
  50673. *
  50674. * Due to poor performance, animation is disabled in old IE browsers for several
  50675. * chart types.
  50676. */
  50677. export interface PlotLinearregressionAnimationOptions {
  50678. defer?: number;
  50679. }
  50680. /**
  50681. * (Highcharts, Highstock, Highmaps, Gantt) Enable or disable the initial
  50682. * animation when a series is displayed for the `dataLabels`. The animation can
  50683. * also be set as a configuration object. Please note that this option only
  50684. * applies to the initial animation. For other animations, see chart.animation
  50685. * and the animation parameter under the API methods. The following properties
  50686. * are supported:
  50687. *
  50688. * - `defer`: The animation delay time in milliseconds.
  50689. */
  50690. export interface PlotLinearregressionDataLabelsAnimationOptions {
  50691. /**
  50692. * (Highcharts, Highstock, Highmaps, Gantt) The animation delay time in
  50693. * milliseconds. Set to `0` renders dataLabel immediately. As `undefined`
  50694. * inherits defer time from the series.animation.defer.
  50695. */
  50696. defer?: number;
  50697. }
  50698. /**
  50699. * (Highcharts, Highstock, Highmaps, Gantt) Options for the series data labels,
  50700. * appearing next to each data point.
  50701. *
  50702. * Since v6.2.0, multiple data labels can be applied to each single point by
  50703. * defining them as an array of configs.
  50704. *
  50705. * In styled mode, the data labels can be styled with the
  50706. * `.highcharts-data-label-box` and `.highcharts-data-label` class names (see
  50707. * example).
  50708. */
  50709. export interface PlotLinearregressionDataLabelsOptions {
  50710. /**
  50711. * (Highcharts, Highstock, Highmaps, Gantt) The alignment of the data label
  50712. * compared to the point. If `right`, the right side of the label should be
  50713. * touching the point. For points with an extent, like columns, the
  50714. * alignments also dictates how to align it inside the box, as given with
  50715. * the inside option. Can be one of `left`, `center` or `right`.
  50716. */
  50717. align?: (AlignValue|null);
  50718. /**
  50719. * (Highcharts, Highstock, Highmaps, Gantt) Whether to allow data labels to
  50720. * overlap. To make the labels less sensitive for overlapping, the
  50721. * dataLabels.padding can be set to 0.
  50722. */
  50723. allowOverlap?: boolean;
  50724. /**
  50725. * (Highcharts, Highstock, Highmaps, Gantt) Enable or disable the initial
  50726. * animation when a series is displayed for the `dataLabels`. The animation
  50727. * can also be set as a configuration object. Please note that this option
  50728. * only applies to the initial animation. For other animations, see
  50729. * chart.animation and the animation parameter under the API methods. The
  50730. * following properties are supported:
  50731. *
  50732. * - `defer`: The animation delay time in milliseconds.
  50733. */
  50734. animation?: (boolean|PlotLinearregressionDataLabelsAnimationOptions|Partial<AnimationOptionsObject>);
  50735. /**
  50736. * (Highcharts, Highstock, Highmaps, Gantt) The background color or gradient
  50737. * for the data label.
  50738. */
  50739. backgroundColor?: (ColorString|GradientColorObject|PatternObject);
  50740. /**
  50741. * (Highcharts, Highstock, Highmaps, Gantt) The border color for the data
  50742. * label. Defaults to `undefined`.
  50743. */
  50744. borderColor?: (ColorString|GradientColorObject|PatternObject);
  50745. /**
  50746. * (Highcharts, Highstock, Highmaps, Gantt) The border radius in pixels for
  50747. * the data label.
  50748. */
  50749. borderRadius?: number;
  50750. /**
  50751. * (Highcharts, Highstock, Highmaps, Gantt) The border width in pixels for
  50752. * the data label.
  50753. */
  50754. borderWidth?: number;
  50755. /**
  50756. * (Highcharts, Highstock, Highmaps, Gantt) A class name for the data label.
  50757. * Particularly in styled mode, this can be used to give each series' or
  50758. * point's data label unique styling. In addition to this option, a default
  50759. * color class name is added so that we can give the labels a contrast text
  50760. * shadow.
  50761. */
  50762. className?: string;
  50763. /**
  50764. * (Highcharts, Highstock, Highmaps, Gantt) The text color for the data
  50765. * labels. Defaults to `undefined`. For certain series types, like column or
  50766. * map, the data labels can be drawn inside the points. In this case the
  50767. * data label will be drawn with maximum contrast by default. Additionally,
  50768. * it will be given a `text-outline` style with the opposite color, to
  50769. * further increase the contrast. This can be overridden by setting the
  50770. * `text-outline` style to `none` in the `dataLabels.style` option.
  50771. */
  50772. color?: (ColorString|GradientColorObject|PatternObject);
  50773. /**
  50774. * (Highcharts, Highstock, Highmaps, Gantt) Whether to hide data labels that
  50775. * are outside the plot area. By default, the data label is moved inside the
  50776. * plot area according to the overflow option.
  50777. */
  50778. crop?: boolean;
  50779. /**
  50780. * (Highcharts, Highstock, Gantt) Whether to defer displaying the data
  50781. * labels until the initial series animation has finished. Setting to
  50782. * `false` renders the data label immediately. If set to `true` inherits the
  50783. * defer time set in plotOptions.series.animation.
  50784. */
  50785. defer?: boolean;
  50786. /**
  50787. * (Highcharts, Highstock, Highmaps, Gantt) Enable or disable the data
  50788. * labels.
  50789. */
  50790. enabled?: boolean;
  50791. /**
  50792. * (Highcharts, Highstock, Highmaps, Gantt) A declarative filter to control
  50793. * of which data labels to display. The declarative filter is designed for
  50794. * use when callback functions are not available, like when the chart
  50795. * options require a pure JSON structure or for use with graphical editors.
  50796. * For programmatic control, use the `formatter` instead, and return
  50797. * `undefined` to disable a single data label.
  50798. */
  50799. filter?: DataLabelsFilterOptionsObject;
  50800. /**
  50801. * (Highcharts, Highstock, Highmaps, Gantt) A format string for the data
  50802. * label. Available variables are the same as for `formatter`.
  50803. */
  50804. format?: string;
  50805. /**
  50806. * (Highcharts, Highstock, Highmaps, Gantt) Callback JavaScript function to
  50807. * format the data label. Note that if a `format` is defined, the format
  50808. * takes precedence and the formatter is ignored.
  50809. */
  50810. formatter?: DataLabelsFormatterCallbackFunction;
  50811. /**
  50812. * (Highcharts, Highstock, Highmaps, Gantt) For points with an extent, like
  50813. * columns or map areas, whether to align the data label inside the box or
  50814. * to the actual value point. Defaults to `false` in most cases, `true` in
  50815. * stacked columns.
  50816. */
  50817. inside?: boolean;
  50818. /**
  50819. * (Highcharts, Highstock, Highmaps, Gantt) Format for points with the value
  50820. * of null. Works analogously to format. `nullFormat` can be applied only to
  50821. * series which support displaying null points.
  50822. */
  50823. nullFormat?: (boolean|string);
  50824. /**
  50825. * (Highcharts, Highstock, Highmaps, Gantt) Callback JavaScript function
  50826. * that defines formatting for points with the value of null. Works
  50827. * analogously to formatter. `nullPointFormatter` can be applied only to
  50828. * series which support displaying null points.
  50829. */
  50830. nullFormatter?: DataLabelsFormatterCallbackFunction;
  50831. /**
  50832. * (Highcharts, Highstock, Highmaps, Gantt) How to handle data labels that
  50833. * flow outside the plot area. The default is `"justify"`, which aligns them
  50834. * inside the plot area. For columns and bars, this means it will be moved
  50835. * inside the bar. To display data labels outside the plot area, set `crop`
  50836. * to `false` and `overflow` to `"allow"`.
  50837. */
  50838. overflow?: DataLabelsOverflowValue;
  50839. /**
  50840. * (Highcharts, Highstock, Highmaps, Gantt) When either the `borderWidth` or
  50841. * the `backgroundColor` is set, this is the padding within the box.
  50842. */
  50843. padding?: number;
  50844. /**
  50845. * (Highcharts, Highstock, Highmaps, Gantt) Aligns data labels relative to
  50846. * points. If `center` alignment is not possible, it defaults to `right`.
  50847. */
  50848. position?: AlignValue;
  50849. /**
  50850. * (Highcharts, Highstock, Highmaps, Gantt) Text rotation in degrees. Note
  50851. * that due to a more complex structure, backgrounds, borders and padding
  50852. * will be lost on a rotated data label.
  50853. */
  50854. rotation?: number;
  50855. /**
  50856. * (Highcharts, Highstock, Highmaps, Gantt) The shadow of the box. Works
  50857. * best with `borderWidth` or `backgroundColor`. Since 2.3 the shadow can be
  50858. * an object configuration containing `color`, `offsetX`, `offsetY`,
  50859. * `opacity` and `width`.
  50860. */
  50861. shadow?: (boolean|ShadowOptionsObject);
  50862. /**
  50863. * (Highcharts, Highstock, Highmaps, Gantt) The name of a symbol to use for
  50864. * the border around the label. Symbols are predefined functions on the
  50865. * Renderer object.
  50866. */
  50867. shape?: string;
  50868. /**
  50869. * (Highcharts, Highstock, Highmaps, Gantt) Styles for the label. The
  50870. * default `color` setting is `"contrast"`, which is a pseudo color that
  50871. * Highcharts picks up and applies the maximum contrast to the underlying
  50872. * point item, for example the bar in a bar chart.
  50873. *
  50874. * The `textOutline` is a pseudo property that applies an outline of the
  50875. * given width with the given color, which by default is the maximum
  50876. * contrast to the text. So a bright text color will result in a black text
  50877. * outline for maximum readability on a mixed background. In some cases,
  50878. * especially with grayscale text, the text outline doesn't work well, in
  50879. * which cases it can be disabled by setting it to `"none"`. When `useHTML`
  50880. * is true, the `textOutline` will not be picked up. In this, case, the same
  50881. * effect can be acheived through the `text-shadow` CSS property.
  50882. *
  50883. * For some series types, where each point has an extent, like for example
  50884. * tree maps, the data label may overflow the point. There are two
  50885. * strategies for handling overflow. By default, the text will wrap to
  50886. * multiple lines. The other strategy is to set `style.textOverflow` to
  50887. * `ellipsis`, which will keep the text on one line plus it will break
  50888. * inside long words.
  50889. */
  50890. style?: CSSObject;
  50891. /**
  50892. * (Highcharts, Highstock, Highmaps, Gantt) Options for a label text which
  50893. * should follow marker's shape. Border and background are disabled for a
  50894. * label that follows a path.
  50895. *
  50896. * **Note:** Only SVG-based renderer supports this option. Setting `useHTML`
  50897. * to true will disable this option.
  50898. */
  50899. textPath?: DataLabelsTextPathOptionsObject;
  50900. /**
  50901. * (Highcharts, Highstock, Highmaps, Gantt) Whether to use HTML to render
  50902. * the labels.
  50903. */
  50904. useHTML?: boolean;
  50905. /**
  50906. * (Highcharts, Highstock, Highmaps, Gantt) The vertical alignment of a data
  50907. * label. Can be one of `top`, `middle` or `bottom`. The default value
  50908. * depends on the data, for instance in a column chart, the label is above
  50909. * positive values and below negative values.
  50910. */
  50911. verticalAlign?: (VerticalAlignValue|null);
  50912. /**
  50913. * (Highcharts, Highstock, Highmaps, Gantt) The x position offset of the
  50914. * label relative to the point in pixels.
  50915. */
  50916. x?: number;
  50917. /**
  50918. * (Highcharts, Highstock, Highmaps, Gantt) The y position offset of the
  50919. * label relative to the point in pixels.
  50920. */
  50921. y?: number;
  50922. /**
  50923. * (Highcharts, Highstock, Highmaps, Gantt) The Z index of the data labels.
  50924. * The default Z index puts it above the series. Use a Z index of 2 to
  50925. * display it behind the series.
  50926. */
  50927. z?: number;
  50928. }
  50929. /**
  50930. * (Highcharts, Highstock) Options for the series data sorting.
  50931. */
  50932. export interface PlotLinearregressionDataSortingOptions {
  50933. /**
  50934. * (Highcharts, Highstock) Enable or disable data sorting for the series.
  50935. * Use xAxis.reversed to change the sorting order.
  50936. */
  50937. enabled?: boolean;
  50938. /**
  50939. * (Highcharts, Highstock) Whether to allow matching points by name in an
  50940. * update. If this option is disabled, points will be matched by order.
  50941. */
  50942. matchByName?: boolean;
  50943. /**
  50944. * (Highcharts, Highstock) Determines what data value should be used to sort
  50945. * by.
  50946. */
  50947. sortKey?: string;
  50948. }
  50949. /**
  50950. * (Highstock) Enable or disable the initial animation when a series is
  50951. * displayed. The animation can also be set as a configuration object. Please
  50952. * note that this option only applies to the initial animation of the series
  50953. * itself. For other animations, see chart.animation and the animation parameter
  50954. * under the API methods. The following properties are supported:
  50955. *
  50956. * - `defer`: The animation delay time in milliseconds.
  50957. *
  50958. * - `duration`: The duration of the animation in milliseconds.
  50959. *
  50960. * - `easing`: Can be a string reference to an easing function set on the `Math`
  50961. * object or a function. See the _Custom easing function_ demo below.
  50962. *
  50963. * Due to poor performance, animation is disabled in old IE browsers for several
  50964. * chart types.
  50965. */
  50966. export interface PlotLinearregressioninterceptAnimationOptions {
  50967. defer?: number;
  50968. }
  50969. /**
  50970. * (Highcharts, Highstock, Highmaps, Gantt) Enable or disable the initial
  50971. * animation when a series is displayed for the `dataLabels`. The animation can
  50972. * also be set as a configuration object. Please note that this option only
  50973. * applies to the initial animation. For other animations, see chart.animation
  50974. * and the animation parameter under the API methods. The following properties
  50975. * are supported:
  50976. *
  50977. * - `defer`: The animation delay time in milliseconds.
  50978. */
  50979. export interface PlotLinearregressioninterceptDataLabelsAnimationOptions {
  50980. /**
  50981. * (Highcharts, Highstock, Highmaps, Gantt) The animation delay time in
  50982. * milliseconds. Set to `0` renders dataLabel immediately. As `undefined`
  50983. * inherits defer time from the series.animation.defer.
  50984. */
  50985. defer?: number;
  50986. }
  50987. /**
  50988. * (Highcharts, Highstock, Highmaps, Gantt) Options for the series data labels,
  50989. * appearing next to each data point.
  50990. *
  50991. * Since v6.2.0, multiple data labels can be applied to each single point by
  50992. * defining them as an array of configs.
  50993. *
  50994. * In styled mode, the data labels can be styled with the
  50995. * `.highcharts-data-label-box` and `.highcharts-data-label` class names (see
  50996. * example).
  50997. */
  50998. export interface PlotLinearregressioninterceptDataLabelsOptions {
  50999. /**
  51000. * (Highcharts, Highstock, Highmaps, Gantt) The alignment of the data label
  51001. * compared to the point. If `right`, the right side of the label should be
  51002. * touching the point. For points with an extent, like columns, the
  51003. * alignments also dictates how to align it inside the box, as given with
  51004. * the inside option. Can be one of `left`, `center` or `right`.
  51005. */
  51006. align?: (AlignValue|null);
  51007. /**
  51008. * (Highcharts, Highstock, Highmaps, Gantt) Whether to allow data labels to
  51009. * overlap. To make the labels less sensitive for overlapping, the
  51010. * dataLabels.padding can be set to 0.
  51011. */
  51012. allowOverlap?: boolean;
  51013. /**
  51014. * (Highcharts, Highstock, Highmaps, Gantt) Enable or disable the initial
  51015. * animation when a series is displayed for the `dataLabels`. The animation
  51016. * can also be set as a configuration object. Please note that this option
  51017. * only applies to the initial animation. For other animations, see
  51018. * chart.animation and the animation parameter under the API methods. The
  51019. * following properties are supported:
  51020. *
  51021. * - `defer`: The animation delay time in milliseconds.
  51022. */
  51023. animation?: (boolean|PlotLinearregressioninterceptDataLabelsAnimationOptions|Partial<AnimationOptionsObject>);
  51024. /**
  51025. * (Highcharts, Highstock, Highmaps, Gantt) The background color or gradient
  51026. * for the data label.
  51027. */
  51028. backgroundColor?: (ColorString|GradientColorObject|PatternObject);
  51029. /**
  51030. * (Highcharts, Highstock, Highmaps, Gantt) The border color for the data
  51031. * label. Defaults to `undefined`.
  51032. */
  51033. borderColor?: (ColorString|GradientColorObject|PatternObject);
  51034. /**
  51035. * (Highcharts, Highstock, Highmaps, Gantt) The border radius in pixels for
  51036. * the data label.
  51037. */
  51038. borderRadius?: number;
  51039. /**
  51040. * (Highcharts, Highstock, Highmaps, Gantt) The border width in pixels for
  51041. * the data label.
  51042. */
  51043. borderWidth?: number;
  51044. /**
  51045. * (Highcharts, Highstock, Highmaps, Gantt) A class name for the data label.
  51046. * Particularly in styled mode, this can be used to give each series' or
  51047. * point's data label unique styling. In addition to this option, a default
  51048. * color class name is added so that we can give the labels a contrast text
  51049. * shadow.
  51050. */
  51051. className?: string;
  51052. /**
  51053. * (Highcharts, Highstock, Highmaps, Gantt) The text color for the data
  51054. * labels. Defaults to `undefined`. For certain series types, like column or
  51055. * map, the data labels can be drawn inside the points. In this case the
  51056. * data label will be drawn with maximum contrast by default. Additionally,
  51057. * it will be given a `text-outline` style with the opposite color, to
  51058. * further increase the contrast. This can be overridden by setting the
  51059. * `text-outline` style to `none` in the `dataLabels.style` option.
  51060. */
  51061. color?: (ColorString|GradientColorObject|PatternObject);
  51062. /**
  51063. * (Highcharts, Highstock, Highmaps, Gantt) Whether to hide data labels that
  51064. * are outside the plot area. By default, the data label is moved inside the
  51065. * plot area according to the overflow option.
  51066. */
  51067. crop?: boolean;
  51068. /**
  51069. * (Highcharts, Highstock, Gantt) Whether to defer displaying the data
  51070. * labels until the initial series animation has finished. Setting to
  51071. * `false` renders the data label immediately. If set to `true` inherits the
  51072. * defer time set in plotOptions.series.animation.
  51073. */
  51074. defer?: boolean;
  51075. /**
  51076. * (Highcharts, Highstock, Highmaps, Gantt) Enable or disable the data
  51077. * labels.
  51078. */
  51079. enabled?: boolean;
  51080. /**
  51081. * (Highcharts, Highstock, Highmaps, Gantt) A declarative filter to control
  51082. * of which data labels to display. The declarative filter is designed for
  51083. * use when callback functions are not available, like when the chart
  51084. * options require a pure JSON structure or for use with graphical editors.
  51085. * For programmatic control, use the `formatter` instead, and return
  51086. * `undefined` to disable a single data label.
  51087. */
  51088. filter?: DataLabelsFilterOptionsObject;
  51089. /**
  51090. * (Highcharts, Highstock, Highmaps, Gantt) A format string for the data
  51091. * label. Available variables are the same as for `formatter`.
  51092. */
  51093. format?: string;
  51094. /**
  51095. * (Highcharts, Highstock, Highmaps, Gantt) Callback JavaScript function to
  51096. * format the data label. Note that if a `format` is defined, the format
  51097. * takes precedence and the formatter is ignored.
  51098. */
  51099. formatter?: DataLabelsFormatterCallbackFunction;
  51100. /**
  51101. * (Highcharts, Highstock, Highmaps, Gantt) For points with an extent, like
  51102. * columns or map areas, whether to align the data label inside the box or
  51103. * to the actual value point. Defaults to `false` in most cases, `true` in
  51104. * stacked columns.
  51105. */
  51106. inside?: boolean;
  51107. /**
  51108. * (Highcharts, Highstock, Highmaps, Gantt) Format for points with the value
  51109. * of null. Works analogously to format. `nullFormat` can be applied only to
  51110. * series which support displaying null points.
  51111. */
  51112. nullFormat?: (boolean|string);
  51113. /**
  51114. * (Highcharts, Highstock, Highmaps, Gantt) Callback JavaScript function
  51115. * that defines formatting for points with the value of null. Works
  51116. * analogously to formatter. `nullPointFormatter` can be applied only to
  51117. * series which support displaying null points.
  51118. */
  51119. nullFormatter?: DataLabelsFormatterCallbackFunction;
  51120. /**
  51121. * (Highcharts, Highstock, Highmaps, Gantt) How to handle data labels that
  51122. * flow outside the plot area. The default is `"justify"`, which aligns them
  51123. * inside the plot area. For columns and bars, this means it will be moved
  51124. * inside the bar. To display data labels outside the plot area, set `crop`
  51125. * to `false` and `overflow` to `"allow"`.
  51126. */
  51127. overflow?: DataLabelsOverflowValue;
  51128. /**
  51129. * (Highcharts, Highstock, Highmaps, Gantt) When either the `borderWidth` or
  51130. * the `backgroundColor` is set, this is the padding within the box.
  51131. */
  51132. padding?: number;
  51133. /**
  51134. * (Highcharts, Highstock, Highmaps, Gantt) Aligns data labels relative to
  51135. * points. If `center` alignment is not possible, it defaults to `right`.
  51136. */
  51137. position?: AlignValue;
  51138. /**
  51139. * (Highcharts, Highstock, Highmaps, Gantt) Text rotation in degrees. Note
  51140. * that due to a more complex structure, backgrounds, borders and padding
  51141. * will be lost on a rotated data label.
  51142. */
  51143. rotation?: number;
  51144. /**
  51145. * (Highcharts, Highstock, Highmaps, Gantt) The shadow of the box. Works
  51146. * best with `borderWidth` or `backgroundColor`. Since 2.3 the shadow can be
  51147. * an object configuration containing `color`, `offsetX`, `offsetY`,
  51148. * `opacity` and `width`.
  51149. */
  51150. shadow?: (boolean|ShadowOptionsObject);
  51151. /**
  51152. * (Highcharts, Highstock, Highmaps, Gantt) The name of a symbol to use for
  51153. * the border around the label. Symbols are predefined functions on the
  51154. * Renderer object.
  51155. */
  51156. shape?: string;
  51157. /**
  51158. * (Highcharts, Highstock, Highmaps, Gantt) Styles for the label. The
  51159. * default `color` setting is `"contrast"`, which is a pseudo color that
  51160. * Highcharts picks up and applies the maximum contrast to the underlying
  51161. * point item, for example the bar in a bar chart.
  51162. *
  51163. * The `textOutline` is a pseudo property that applies an outline of the
  51164. * given width with the given color, which by default is the maximum
  51165. * contrast to the text. So a bright text color will result in a black text
  51166. * outline for maximum readability on a mixed background. In some cases,
  51167. * especially with grayscale text, the text outline doesn't work well, in
  51168. * which cases it can be disabled by setting it to `"none"`. When `useHTML`
  51169. * is true, the `textOutline` will not be picked up. In this, case, the same
  51170. * effect can be acheived through the `text-shadow` CSS property.
  51171. *
  51172. * For some series types, where each point has an extent, like for example
  51173. * tree maps, the data label may overflow the point. There are two
  51174. * strategies for handling overflow. By default, the text will wrap to
  51175. * multiple lines. The other strategy is to set `style.textOverflow` to
  51176. * `ellipsis`, which will keep the text on one line plus it will break
  51177. * inside long words.
  51178. */
  51179. style?: CSSObject;
  51180. /**
  51181. * (Highcharts, Highstock, Highmaps, Gantt) Options for a label text which
  51182. * should follow marker's shape. Border and background are disabled for a
  51183. * label that follows a path.
  51184. *
  51185. * **Note:** Only SVG-based renderer supports this option. Setting `useHTML`
  51186. * to true will disable this option.
  51187. */
  51188. textPath?: DataLabelsTextPathOptionsObject;
  51189. /**
  51190. * (Highcharts, Highstock, Highmaps, Gantt) Whether to use HTML to render
  51191. * the labels.
  51192. */
  51193. useHTML?: boolean;
  51194. /**
  51195. * (Highcharts, Highstock, Highmaps, Gantt) The vertical alignment of a data
  51196. * label. Can be one of `top`, `middle` or `bottom`. The default value
  51197. * depends on the data, for instance in a column chart, the label is above
  51198. * positive values and below negative values.
  51199. */
  51200. verticalAlign?: (VerticalAlignValue|null);
  51201. /**
  51202. * (Highcharts, Highstock, Highmaps, Gantt) The x position offset of the
  51203. * label relative to the point in pixels.
  51204. */
  51205. x?: number;
  51206. /**
  51207. * (Highcharts, Highstock, Highmaps, Gantt) The y position offset of the
  51208. * label relative to the point in pixels.
  51209. */
  51210. y?: number;
  51211. /**
  51212. * (Highcharts, Highstock, Highmaps, Gantt) The Z index of the data labels.
  51213. * The default Z index puts it above the series. Use a Z index of 2 to
  51214. * display it behind the series.
  51215. */
  51216. z?: number;
  51217. }
  51218. /**
  51219. * (Highcharts, Highstock) Options for the series data sorting.
  51220. */
  51221. export interface PlotLinearregressioninterceptDataSortingOptions {
  51222. /**
  51223. * (Highcharts, Highstock) Enable or disable data sorting for the series.
  51224. * Use xAxis.reversed to change the sorting order.
  51225. */
  51226. enabled?: boolean;
  51227. /**
  51228. * (Highcharts, Highstock) Whether to allow matching points by name in an
  51229. * update. If this option is disabled, points will be matched by order.
  51230. */
  51231. matchByName?: boolean;
  51232. /**
  51233. * (Highcharts, Highstock) Determines what data value should be used to sort
  51234. * by.
  51235. */
  51236. sortKey?: string;
  51237. }
  51238. /**
  51239. * (Highstock) Linear regression intercept indicator. This series requires
  51240. * `linkedTo` option to be set.
  51241. *
  51242. * In TypeScript the type option must always be set.
  51243. *
  51244. * Configuration options for the series are given in three levels:
  51245. *
  51246. * 1. Options for all series in a chart are defined in the plotOptions.series
  51247. * object.
  51248. *
  51249. * 2. Options for all `linearregressionintercept` series are defined in
  51250. * plotOptions.linearregressionintercept.
  51251. *
  51252. * 3. Options for one single series are given in the series instance array. (see
  51253. * online documentation for example)
  51254. */
  51255. export interface PlotLinearregressioninterceptOptions {
  51256. /**
  51257. * (Highstock) Accessibility options for a series.
  51258. */
  51259. accessibility?: SeriesAccessibilityOptionsObject;
  51260. /**
  51261. * (Highstock) Allow this series' points to be selected by clicking on the
  51262. * graphic (columns, point markers, pie slices, map areas etc).
  51263. *
  51264. * The selected points can be handled by point select and unselect events,
  51265. * or collectively by the getSelectedPoints function.
  51266. *
  51267. * And alternative way of selecting points is through dragging.
  51268. */
  51269. allowPointSelect?: boolean;
  51270. /**
  51271. * (Highstock) Enable or disable the initial animation when a series is
  51272. * displayed. The animation can also be set as a configuration object.
  51273. * Please note that this option only applies to the initial animation of the
  51274. * series itself. For other animations, see chart.animation and the
  51275. * animation parameter under the API methods. The following properties are
  51276. * supported:
  51277. *
  51278. * - `defer`: The animation delay time in milliseconds.
  51279. *
  51280. * - `duration`: The duration of the animation in milliseconds.
  51281. *
  51282. * - `easing`: Can be a string reference to an easing function set on the
  51283. * `Math` object or a function. See the _Custom easing function_ demo below.
  51284. *
  51285. * Due to poor performance, animation is disabled in old IE browsers for
  51286. * several chart types.
  51287. */
  51288. animation?: (boolean|PlotLinearregressioninterceptAnimationOptions|Partial<AnimationOptionsObject>);
  51289. /**
  51290. * (Highstock) For some series, there is a limit that shuts down initial
  51291. * animation by default when the total number of points in the chart is too
  51292. * high. For example, for a column chart and its derivatives, animation does
  51293. * not run if there is more than 250 points totally. To disable this cap,
  51294. * set `animationLimit` to `Infinity`.
  51295. */
  51296. animationLimit?: number;
  51297. /**
  51298. * (Highstock) Sets the color blending in the boost module.
  51299. */
  51300. boostBlending?: OptionsBoostBlendingValue;
  51301. /**
  51302. * (Highstock) Set the point threshold for when a series should enter boost
  51303. * mode.
  51304. *
  51305. * Setting it to e.g. 2000 will cause the series to enter boost mode when
  51306. * there are 2000 or more points in the series.
  51307. *
  51308. * To disable boosting on the series, set the `boostThreshold` to 0. Setting
  51309. * it to 1 will force boosting.
  51310. *
  51311. * Note that the cropThreshold also affects this setting. When zooming in on
  51312. * a series that has fewer points than the `cropThreshold`, all points are
  51313. * rendered although outside the visible plot area, and the `boostThreshold`
  51314. * won't take effect.
  51315. */
  51316. boostThreshold?: number;
  51317. /**
  51318. * (Highmaps) The border color of the map areas.
  51319. *
  51320. * In styled mode, the border stroke is given in the `.highcharts-point`
  51321. * class.
  51322. */
  51323. borderColor?: (ColorString|GradientColorObject|PatternObject);
  51324. /**
  51325. * (Highmaps) The border width of each map area.
  51326. *
  51327. * In styled mode, the border stroke width is given in the
  51328. * `.highcharts-point` class.
  51329. */
  51330. borderWidth?: number;
  51331. /**
  51332. * (Highstock) An additional class name to apply to the series' graphical
  51333. * elements. This option does not replace default class names of the
  51334. * graphical element.
  51335. */
  51336. className?: string;
  51337. /**
  51338. * (Highstock) Disable this option to allow series rendering in the whole
  51339. * plotting area.
  51340. *
  51341. * **Note:** Clipping should be always enabled when chart.zoomType is set
  51342. */
  51343. clip?: boolean;
  51344. /**
  51345. * (Highstock) The main color of the series. In line type series it applies
  51346. * to the line and the point markers unless otherwise specified. In bar type
  51347. * series it applies to the bars unless a color is specified per point. The
  51348. * default value is pulled from the `options.colors` array.
  51349. *
  51350. * In styled mode, the color can be defined by the colorIndex option. Also,
  51351. * the series color can be set with the `.highcharts-series`,
  51352. * `.highcharts-color-{n}`, `.highcharts-{type}-series` or
  51353. * `.highcharts-series-{n}` class, or individual classes given by the
  51354. * `className` option.
  51355. */
  51356. color?: (ColorString|GradientColorObject|PatternObject);
  51357. /**
  51358. * (Highstock) Styled mode only. A specific color index to use for the
  51359. * series, so its graphic representations are given the class name
  51360. * `highcharts-color-{n}`.
  51361. */
  51362. colorIndex?: number;
  51363. /**
  51364. * (Highcharts, Highstock, Highmaps) Determines what data value should be
  51365. * used to calculate point color if `colorAxis` is used. Requires to set
  51366. * `min` and `max` if some custom point property is used or if approximation
  51367. * for data grouping is set to `'sum'`.
  51368. */
  51369. colorKey?: string;
  51370. /**
  51371. * (Highstock) Compare the values of the series against the first non-null,
  51372. * non- zero value in the visible range. The y axis will show percentage or
  51373. * absolute change depending on whether `compare` is set to `"percent"` or
  51374. * `"value"`. When this is applied to multiple series, it allows comparing
  51375. * the development of the series against each other. Adds a `change` field
  51376. * to every point object.
  51377. */
  51378. compare?: string;
  51379. /**
  51380. * (Highstock) When compare is `percent`, this option dictates whether to
  51381. * use 0 or 100 as the base of comparison.
  51382. */
  51383. compareBase?: (0|100);
  51384. /**
  51385. * (Highstock) Defines if comparison should start from the first point
  51386. * within the visible range or should start from the first point **before**
  51387. * the range.
  51388. *
  51389. * In other words, this flag determines if first point within the visible
  51390. * range will have 0% (`compareStart=true`) or should have been already
  51391. * calculated according to the previous point (`compareStart=false`).
  51392. */
  51393. compareStart?: boolean;
  51394. /**
  51395. * (Highstock) Whether to compare indicator to the main series values or
  51396. * indicator values.
  51397. */
  51398. compareToMain?: boolean;
  51399. /**
  51400. * (Highcharts) Polar charts only. Whether to connect the ends of a line
  51401. * series plot across the extremes.
  51402. */
  51403. connectEnds?: boolean;
  51404. /**
  51405. * (Highcharts, Highstock) Whether to connect a graph line across null
  51406. * points, or render a gap between the two points on either side of the
  51407. * null.
  51408. */
  51409. connectNulls?: boolean;
  51410. /**
  51411. * (Gantt) Override Pathfinder connector options for a series. Requires
  51412. * Highcharts Gantt to be loaded.
  51413. */
  51414. connectors?: SeriesConnectorsOptionsObject;
  51415. /**
  51416. * (Highcharts, Highstock, Gantt) When true, each point or column edge is
  51417. * rounded to its nearest pixel in order to render sharp on screen. In some
  51418. * cases, when there are a lot of densely packed columns, this leads to
  51419. * visible difference in column widths or distance between columns. In these
  51420. * cases, setting `crisp` to `false` may look better, even though each
  51421. * column is rendered blurry.
  51422. */
  51423. crisp?: boolean;
  51424. /**
  51425. * (Highcharts, Highstock) When the series contains less points than the
  51426. * crop threshold, all points are drawn, even if the points fall outside the
  51427. * visible plot area at the current zoom. The advantage of drawing all
  51428. * points (including markers and columns), is that animation is performed on
  51429. * updates. On the other hand, when the series contains more points than the
  51430. * crop threshold, the series data is cropped to only contain points that
  51431. * fall within the plot area. The advantage of cropping away invisible
  51432. * points is to increase performance on large series.
  51433. */
  51434. cropThreshold?: number;
  51435. /**
  51436. * (Highstock) You can set the cursor to "pointer" if you have click events
  51437. * attached to the series, to signal to the user that the points and lines
  51438. * can be clicked.
  51439. *
  51440. * In styled mode, the series cursor can be set with the same classes as
  51441. * listed under series.color.
  51442. */
  51443. cursor?: (string|CursorValue);
  51444. /**
  51445. * (Highstock) A reserved subspace to store options and values for
  51446. * customized functionality. Here you can add additional data for your own
  51447. * event callbacks and formatter callbacks.
  51448. */
  51449. custom?: Dictionary<any>;
  51450. /**
  51451. * (Highstock) Name of the dash style to use for the graph, or for some
  51452. * series types the outline of each shape.
  51453. *
  51454. * In styled mode, the stroke dash-array can be set with the same classes as
  51455. * listed under series.color.
  51456. */
  51457. dashStyle?: DashStyleValue;
  51458. /**
  51459. * (Highstock) Data grouping is the concept of sampling the data values into
  51460. * larger blocks in order to ease readability and increase performance of
  51461. * the JavaScript charts. Highstock by default applies data grouping when
  51462. * the points become closer than a certain pixel value, determined by the
  51463. * `groupPixelWidth` option.
  51464. *
  51465. * If data grouping is applied, the grouping information of grouped points
  51466. * can be read from the Point.dataGroup. If point options other than the
  51467. * data itself are set, for example `name` or `color` or custom properties,
  51468. * the grouping logic doesn't know how to group it. In this case the options
  51469. * of the first point instance are copied over to the group point. This can
  51470. * be altered through a custom `approximation` callback function.
  51471. */
  51472. dataGrouping?: DataGroupingOptionsObject;
  51473. /**
  51474. * (Highcharts, Highstock, Highmaps, Gantt) Options for the series data
  51475. * labels, appearing next to each data point.
  51476. *
  51477. * Since v6.2.0, multiple data labels can be applied to each single point by
  51478. * defining them as an array of configs.
  51479. *
  51480. * In styled mode, the data labels can be styled with the
  51481. * `.highcharts-data-label-box` and `.highcharts-data-label` class names
  51482. * (see example).
  51483. */
  51484. dataLabels?: (PlotLinearregressioninterceptDataLabelsOptions|Array<PlotLinearregressioninterceptDataLabelsOptions>);
  51485. /**
  51486. * (Highcharts, Highstock) Options for the series data sorting.
  51487. */
  51488. dataSorting?: (DataSortingOptionsObject|PlotLinearregressioninterceptDataSortingOptions);
  51489. /**
  51490. * (Highstock) A description of the series to add to the screen reader
  51491. * information about the series.
  51492. */
  51493. description?: string;
  51494. /**
  51495. * (Highstock) Enable or disable the mouse tracking for a specific series.
  51496. * This includes point tooltips and click events on graphs and points. For
  51497. * large datasets it improves performance.
  51498. */
  51499. enableMouseTracking?: boolean;
  51500. /**
  51501. * (Highstock) General event handlers for the series items. These event
  51502. * hooks can also be attached to the series at run time using the
  51503. * `Highcharts.addEvent` function.
  51504. */
  51505. events?: SeriesEventsOptionsObject;
  51506. /**
  51507. * (Highstock) Determines whether the series should look for the nearest
  51508. * point in both dimensions or just the x-dimension when hovering the
  51509. * series. Defaults to `'xy'` for scatter series and `'x'` for most other
  51510. * series. If the data has duplicate x-values, it is recommended to set this
  51511. * to `'xy'` to allow hovering over all points.
  51512. *
  51513. * Applies only to series types using nearest neighbor search (not direct
  51514. * hover) for tooltip.
  51515. */
  51516. findNearestPointBy?: OptionsFindNearestPointByValue;
  51517. /**
  51518. * (Highstock) Defines when to display a gap in the graph, together with the
  51519. * gapUnit option.
  51520. *
  51521. * In case when `dataGrouping` is enabled, points can be grouped into a
  51522. * larger time span. This can make the grouped points to have a greater
  51523. * distance than the absolute value of `gapSize` property, which will result
  51524. * in disappearing graph completely. To prevent this situation the mentioned
  51525. * distance between grouped points is used instead of previously defined
  51526. * `gapSize`.
  51527. *
  51528. * In practice, this option is most often used to visualize gaps in time
  51529. * series. In a stock chart, intraday data is available for daytime hours,
  51530. * while gaps will appear in nights and weekends.
  51531. */
  51532. gapSize?: number;
  51533. /**
  51534. * (Highstock) Together with gapSize, this option defines where to draw gaps
  51535. * in the graph.
  51536. *
  51537. * When the `gapUnit` is `"relative"` (default), a gap size of 5 means that
  51538. * if the distance between two points is greater than 5 times that of the
  51539. * two closest points, the graph will be broken.
  51540. *
  51541. * When the `gapUnit` is `"value"`, the gap is based on absolute axis
  51542. * values, which on a datetime axis is milliseconds. This also applies to
  51543. * the navigator series that inherits gap options from the base series.
  51544. */
  51545. gapUnit?: OptionsGapUnitValue;
  51546. /**
  51547. * (Highcharts, Highstock, Gantt) Whether to use the Y extremes of the total
  51548. * chart width or only the zoomed area when zooming in on parts of the X
  51549. * axis. By default, the Y axis adjusts to the min and max of the visible
  51550. * data. Cartesian series only.
  51551. */
  51552. getExtremesFromAll?: boolean;
  51553. /**
  51554. * (Highstock) When set to `false` will prevent the series data from being
  51555. * included in any form of data export.
  51556. *
  51557. * Since version 6.0.0 until 7.1.0 the option was existing undocumented as
  51558. * `includeInCSVExport`.
  51559. */
  51560. includeInDataExport?: boolean;
  51561. /**
  51562. * (Highcharts, Highstock, Gantt) Series labels are placed as close to the
  51563. * series as possible in a natural way, seeking to avoid other series. The
  51564. * goal of this feature is to make the chart more easily readable, like if a
  51565. * human designer placed the labels in the optimal position.
  51566. *
  51567. * The series labels currently work with series types having a `graph` or an
  51568. * `area`.
  51569. */
  51570. label?: SeriesLabelOptionsObject;
  51571. /**
  51572. * (Highstock) The line marks the last price from all points.
  51573. */
  51574. lastPrice?: SeriesLastPriceOptionsObject;
  51575. /**
  51576. * (Highstock) The line marks the last price from visible range of points.
  51577. */
  51578. lastVisiblePrice?: SeriesLastVisiblePriceOptionsObject;
  51579. /**
  51580. * (Highcharts, Highstock) The SVG value used for the `stroke-linecap` and
  51581. * `stroke-linejoin` of a line graph. Round means that lines are rounded in
  51582. * the ends and bends.
  51583. */
  51584. linecap?: SeriesLinecapValue;
  51585. /**
  51586. * (Highcharts, Highstock) Pixel width of the graph line.
  51587. */
  51588. lineWidth?: number;
  51589. /**
  51590. * (Highcharts, Highstock, Gantt) The main series ID that indicator will be
  51591. * based on. Required for this indicator.
  51592. */
  51593. linkedTo?: string;
  51594. /**
  51595. * (Highstock) Options for the point markers of line-like series. Properties
  51596. * like `fillColor`, `lineColor` and `lineWidth` define the visual
  51597. * appearance of the markers. Other series types, like column series, don't
  51598. * have markers, but have visual options on the series level instead.
  51599. *
  51600. * In styled mode, the markers can be styled with the `.highcharts-point`,
  51601. * `.highcharts-point-hover` and `.highcharts-point-select` class names.
  51602. */
  51603. marker?: PointMarkerOptionsObject;
  51604. /**
  51605. * (Highstock) The name of the series as shown in the legend, tooltip etc.
  51606. * If not set, it will be based on a technical indicator type and default
  51607. * params.
  51608. */
  51609. name?: string;
  51610. /**
  51611. * (Highstock) The color for the parts of the graph or points that are below
  51612. * the threshold. Note that `zones` takes precedence over the negative
  51613. * color. Using `negativeColor` is equivalent to applying a zone with value
  51614. * of 0.
  51615. */
  51616. negativeColor?: (ColorString|GradientColorObject|PatternObject);
  51617. /**
  51618. * (Highstock) Opacity of a series parts: line, fill (e.g. area) and
  51619. * dataLabels.
  51620. */
  51621. opacity?: number;
  51622. /**
  51623. * (Highstock) Paramters used in calculation of regression series' points.
  51624. */
  51625. params?: PlotLinearregressioninterceptParamsOptions;
  51626. /**
  51627. * (Highstock) Properties for each single point.
  51628. */
  51629. point?: PlotSeriesPointOptions;
  51630. /**
  51631. * (Highstock) Same as accessibility.pointDescriptionFormatter, but for an
  51632. * individual series. Overrides the chart wide configuration.
  51633. */
  51634. pointDescriptionFormatter?: Function;
  51635. /**
  51636. * (Highstock) Whether to select the series initially. If `showCheckbox` is
  51637. * true, the checkbox next to the series name in the legend will be checked
  51638. * for a selected series.
  51639. */
  51640. selected?: boolean;
  51641. /**
  51642. * (Highstock) Whether to apply a drop shadow to the graph line. Since 2.3
  51643. * the shadow can be an object configuration containing `color`, `offsetX`,
  51644. * `offsetY`, `opacity` and `width`.
  51645. */
  51646. shadow?: (boolean|ShadowOptionsObject);
  51647. /**
  51648. * (Highstock) If true, a checkbox is displayed next to the legend item to
  51649. * allow selecting the series. The state of the checkbox is determined by
  51650. * the `selected` option.
  51651. */
  51652. showCheckbox?: boolean;
  51653. /**
  51654. * (Highstock) Whether to display this particular series or series type in
  51655. * the legend. Standalone series are shown in legend by default, and linked
  51656. * series are not. Since v7.2.0 it is possible to show series that use
  51657. * colorAxis by setting this option to `true`.
  51658. */
  51659. showInLegend?: boolean;
  51660. /**
  51661. * (Highstock) If set to `true`, the accessibility module will skip past the
  51662. * points in this series for keyboard navigation.
  51663. */
  51664. skipKeyboardNavigation?: boolean;
  51665. /**
  51666. * (Highcharts, Highstock) When this is true, the series will not cause the
  51667. * Y axis to cross the zero plane (or threshold option) unless the data
  51668. * actually crosses the plane.
  51669. *
  51670. * For example, if `softThreshold` is `false`, a series of 0, 1, 2, 3 will
  51671. * make the Y axis show negative values according to the `minPadding`
  51672. * option. If `softThreshold` is `true`, the Y axis starts at 0.
  51673. */
  51674. softThreshold?: boolean;
  51675. states?: SeriesStatesOptionsObject;
  51676. /**
  51677. * (Highcharts, Highstock) Whether to apply steps to the line. Possible
  51678. * values are `left`, `center` and `right`.
  51679. */
  51680. step?: OptionsStepValue;
  51681. /**
  51682. * (Highstock) Sticky tracking of mouse events. When true, the `mouseOut`
  51683. * event on a series isn't triggered until the mouse moves over another
  51684. * series, or out of the plot area. When false, the `mouseOut` event on a
  51685. * series is triggered when the mouse leaves the area around the series'
  51686. * graph or markers. This also implies the tooltip when not shared. When
  51687. * `stickyTracking` is false and `tooltip.shared` is false, the tooltip will
  51688. * be hidden when moving the mouse between series. Defaults to true for line
  51689. * and area type series, but to false for columns, pies etc.
  51690. *
  51691. * **Note:** The boost module will force this option because of technical
  51692. * limitations.
  51693. */
  51694. stickyTracking?: boolean;
  51695. /**
  51696. * (Highcharts, Highstock) The threshold, also called zero level or base
  51697. * level. For line type series this is only used in conjunction with
  51698. * negativeColor.
  51699. */
  51700. threshold?: (number|null);
  51701. /**
  51702. * (Highstock) A configuration object for the tooltip rendering of each
  51703. * single series. Properties are inherited from tooltip, but only the
  51704. * following properties can be defined on a series level.
  51705. */
  51706. tooltip?: SeriesTooltipOptionsObject;
  51707. /**
  51708. * (Highcharts, Highstock, Gantt) When a series contains a data array that
  51709. * is longer than this, only one dimensional arrays of numbers, or two
  51710. * dimensional arrays with x and y values are allowed. Also, only the first
  51711. * point is tested, and the rest are assumed to be the same format. This
  51712. * saves expensive data checking and indexing in long series. Set it to `0`
  51713. * disable.
  51714. *
  51715. * Note: In boost mode turbo threshold is forced. Only array of numbers or
  51716. * two dimensional arrays are allowed.
  51717. */
  51718. turboThreshold?: number;
  51719. /**
  51720. * (Highstock) Set the initial visibility of the series.
  51721. */
  51722. visible?: boolean;
  51723. /**
  51724. * (Highmaps) Define the z index of the series.
  51725. */
  51726. zIndex?: number;
  51727. /**
  51728. * (Highcharts, Highstock) Defines the Axis on which the zones are applied.
  51729. */
  51730. zoneAxis?: string;
  51731. /**
  51732. * (Highcharts, Highstock) An array defining zones within a series. Zones
  51733. * can be applied to the X axis, Y axis or Z axis for bubbles, according to
  51734. * the `zoneAxis` option. The zone definitions have to be in ascending order
  51735. * regarding to the value.
  51736. *
  51737. * In styled mode, the color zones are styled with the
  51738. * `.highcharts-zone-{n}` class, or custom classed from the `className`
  51739. * option (view live demo).
  51740. */
  51741. zones?: Array<SeriesZonesOptionsObject>;
  51742. }
  51743. /**
  51744. * (Highstock) Paramters used in calculation of regression series' points.
  51745. */
  51746. export interface PlotLinearregressioninterceptParamsOptions {
  51747. /**
  51748. * (Highstock) The point index which indicator calculations will base. For
  51749. * example using OHLC data, index=2 means the indicator will be calculated
  51750. * using Low values.
  51751. */
  51752. index?: number;
  51753. /**
  51754. * (Highstock) The base period for indicator calculations. This is the
  51755. * number of data points which are taken into account for the indicator
  51756. * calculations.
  51757. */
  51758. period?: number;
  51759. /**
  51760. * (Highstock) Unit (in milliseconds) for the x axis distances used to
  51761. * compute the regression line paramters (slope & intercept) for every
  51762. * range. In Highstock the x axis values are always represented in
  51763. * milliseconds which may cause that distances between points are "big"
  51764. * integer numbers.
  51765. *
  51766. * Highstock's linear regression algorithm (least squares method) will
  51767. * utilize these "big" integers for finding the slope and the intercept of
  51768. * the regression line for each period. In consequence, this value may be a
  51769. * very "small" decimal number that's hard to interpret by a human.
  51770. *
  51771. * For instance: `xAxisUnit` equealed to `86400000` ms (1 day) forces the
  51772. * algorithm to treat `86400000` as `1` while computing the slope and the
  51773. * intercept. This may enchance the legiblitity of the indicator's values.
  51774. *
  51775. * Default value is the closest distance between two data points.
  51776. */
  51777. xAxisUnit?: number;
  51778. }
  51779. /**
  51780. * (Highstock) Linear regression indicator. This series requires `linkedTo`
  51781. * option to be set.
  51782. *
  51783. * In TypeScript the type option must always be set.
  51784. *
  51785. * Configuration options for the series are given in three levels:
  51786. *
  51787. * 1. Options for all series in a chart are defined in the plotOptions.series
  51788. * object.
  51789. *
  51790. * 2. Options for all `linearregression` series are defined in
  51791. * plotOptions.linearregression.
  51792. *
  51793. * 3. Options for one single series are given in the series instance array. (see
  51794. * online documentation for example)
  51795. */
  51796. export interface PlotLinearregressionOptions {
  51797. /**
  51798. * (Highstock) Accessibility options for a series.
  51799. */
  51800. accessibility?: SeriesAccessibilityOptionsObject;
  51801. /**
  51802. * (Highstock) Allow this series' points to be selected by clicking on the
  51803. * graphic (columns, point markers, pie slices, map areas etc).
  51804. *
  51805. * The selected points can be handled by point select and unselect events,
  51806. * or collectively by the getSelectedPoints function.
  51807. *
  51808. * And alternative way of selecting points is through dragging.
  51809. */
  51810. allowPointSelect?: boolean;
  51811. /**
  51812. * (Highstock) Enable or disable the initial animation when a series is
  51813. * displayed. The animation can also be set as a configuration object.
  51814. * Please note that this option only applies to the initial animation of the
  51815. * series itself. For other animations, see chart.animation and the
  51816. * animation parameter under the API methods. The following properties are
  51817. * supported:
  51818. *
  51819. * - `defer`: The animation delay time in milliseconds.
  51820. *
  51821. * - `duration`: The duration of the animation in milliseconds.
  51822. *
  51823. * - `easing`: Can be a string reference to an easing function set on the
  51824. * `Math` object or a function. See the _Custom easing function_ demo below.
  51825. *
  51826. * Due to poor performance, animation is disabled in old IE browsers for
  51827. * several chart types.
  51828. */
  51829. animation?: (boolean|PlotLinearregressionAnimationOptions|Partial<AnimationOptionsObject>);
  51830. /**
  51831. * (Highstock) For some series, there is a limit that shuts down initial
  51832. * animation by default when the total number of points in the chart is too
  51833. * high. For example, for a column chart and its derivatives, animation does
  51834. * not run if there is more than 250 points totally. To disable this cap,
  51835. * set `animationLimit` to `Infinity`.
  51836. */
  51837. animationLimit?: number;
  51838. /**
  51839. * (Highstock) Sets the color blending in the boost module.
  51840. */
  51841. boostBlending?: OptionsBoostBlendingValue;
  51842. /**
  51843. * (Highstock) Set the point threshold for when a series should enter boost
  51844. * mode.
  51845. *
  51846. * Setting it to e.g. 2000 will cause the series to enter boost mode when
  51847. * there are 2000 or more points in the series.
  51848. *
  51849. * To disable boosting on the series, set the `boostThreshold` to 0. Setting
  51850. * it to 1 will force boosting.
  51851. *
  51852. * Note that the cropThreshold also affects this setting. When zooming in on
  51853. * a series that has fewer points than the `cropThreshold`, all points are
  51854. * rendered although outside the visible plot area, and the `boostThreshold`
  51855. * won't take effect.
  51856. */
  51857. boostThreshold?: number;
  51858. /**
  51859. * (Highmaps) The border color of the map areas.
  51860. *
  51861. * In styled mode, the border stroke is given in the `.highcharts-point`
  51862. * class.
  51863. */
  51864. borderColor?: (ColorString|GradientColorObject|PatternObject);
  51865. /**
  51866. * (Highmaps) The border width of each map area.
  51867. *
  51868. * In styled mode, the border stroke width is given in the
  51869. * `.highcharts-point` class.
  51870. */
  51871. borderWidth?: number;
  51872. /**
  51873. * (Highstock) An additional class name to apply to the series' graphical
  51874. * elements. This option does not replace default class names of the
  51875. * graphical element.
  51876. */
  51877. className?: string;
  51878. /**
  51879. * (Highstock) Disable this option to allow series rendering in the whole
  51880. * plotting area.
  51881. *
  51882. * **Note:** Clipping should be always enabled when chart.zoomType is set
  51883. */
  51884. clip?: boolean;
  51885. /**
  51886. * (Highstock) The main color of the series. In line type series it applies
  51887. * to the line and the point markers unless otherwise specified. In bar type
  51888. * series it applies to the bars unless a color is specified per point. The
  51889. * default value is pulled from the `options.colors` array.
  51890. *
  51891. * In styled mode, the color can be defined by the colorIndex option. Also,
  51892. * the series color can be set with the `.highcharts-series`,
  51893. * `.highcharts-color-{n}`, `.highcharts-{type}-series` or
  51894. * `.highcharts-series-{n}` class, or individual classes given by the
  51895. * `className` option.
  51896. */
  51897. color?: (ColorString|GradientColorObject|PatternObject);
  51898. /**
  51899. * (Highstock) Styled mode only. A specific color index to use for the
  51900. * series, so its graphic representations are given the class name
  51901. * `highcharts-color-{n}`.
  51902. */
  51903. colorIndex?: number;
  51904. /**
  51905. * (Highcharts, Highstock, Highmaps) Determines what data value should be
  51906. * used to calculate point color if `colorAxis` is used. Requires to set
  51907. * `min` and `max` if some custom point property is used or if approximation
  51908. * for data grouping is set to `'sum'`.
  51909. */
  51910. colorKey?: string;
  51911. /**
  51912. * (Highstock) Compare the values of the series against the first non-null,
  51913. * non- zero value in the visible range. The y axis will show percentage or
  51914. * absolute change depending on whether `compare` is set to `"percent"` or
  51915. * `"value"`. When this is applied to multiple series, it allows comparing
  51916. * the development of the series against each other. Adds a `change` field
  51917. * to every point object.
  51918. */
  51919. compare?: string;
  51920. /**
  51921. * (Highstock) When compare is `percent`, this option dictates whether to
  51922. * use 0 or 100 as the base of comparison.
  51923. */
  51924. compareBase?: (0|100);
  51925. /**
  51926. * (Highstock) Defines if comparison should start from the first point
  51927. * within the visible range or should start from the first point **before**
  51928. * the range.
  51929. *
  51930. * In other words, this flag determines if first point within the visible
  51931. * range will have 0% (`compareStart=true`) or should have been already
  51932. * calculated according to the previous point (`compareStart=false`).
  51933. */
  51934. compareStart?: boolean;
  51935. /**
  51936. * (Highstock) Whether to compare indicator to the main series values or
  51937. * indicator values.
  51938. */
  51939. compareToMain?: boolean;
  51940. /**
  51941. * (Highcharts) Polar charts only. Whether to connect the ends of a line
  51942. * series plot across the extremes.
  51943. */
  51944. connectEnds?: boolean;
  51945. /**
  51946. * (Highcharts, Highstock) Whether to connect a graph line across null
  51947. * points, or render a gap between the two points on either side of the
  51948. * null.
  51949. */
  51950. connectNulls?: boolean;
  51951. /**
  51952. * (Gantt) Override Pathfinder connector options for a series. Requires
  51953. * Highcharts Gantt to be loaded.
  51954. */
  51955. connectors?: SeriesConnectorsOptionsObject;
  51956. /**
  51957. * (Highcharts, Highstock, Gantt) When true, each point or column edge is
  51958. * rounded to its nearest pixel in order to render sharp on screen. In some
  51959. * cases, when there are a lot of densely packed columns, this leads to
  51960. * visible difference in column widths or distance between columns. In these
  51961. * cases, setting `crisp` to `false` may look better, even though each
  51962. * column is rendered blurry.
  51963. */
  51964. crisp?: boolean;
  51965. /**
  51966. * (Highcharts, Highstock) When the series contains less points than the
  51967. * crop threshold, all points are drawn, even if the points fall outside the
  51968. * visible plot area at the current zoom. The advantage of drawing all
  51969. * points (including markers and columns), is that animation is performed on
  51970. * updates. On the other hand, when the series contains more points than the
  51971. * crop threshold, the series data is cropped to only contain points that
  51972. * fall within the plot area. The advantage of cropping away invisible
  51973. * points is to increase performance on large series.
  51974. */
  51975. cropThreshold?: number;
  51976. /**
  51977. * (Highstock) You can set the cursor to "pointer" if you have click events
  51978. * attached to the series, to signal to the user that the points and lines
  51979. * can be clicked.
  51980. *
  51981. * In styled mode, the series cursor can be set with the same classes as
  51982. * listed under series.color.
  51983. */
  51984. cursor?: (string|CursorValue);
  51985. /**
  51986. * (Highstock) A reserved subspace to store options and values for
  51987. * customized functionality. Here you can add additional data for your own
  51988. * event callbacks and formatter callbacks.
  51989. */
  51990. custom?: Dictionary<any>;
  51991. /**
  51992. * (Highstock) Name of the dash style to use for the graph, or for some
  51993. * series types the outline of each shape.
  51994. *
  51995. * In styled mode, the stroke dash-array can be set with the same classes as
  51996. * listed under series.color.
  51997. */
  51998. dashStyle?: DashStyleValue;
  51999. /**
  52000. * (Highstock) Data grouping is the concept of sampling the data values into
  52001. * larger blocks in order to ease readability and increase performance of
  52002. * the JavaScript charts. Highstock by default applies data grouping when
  52003. * the points become closer than a certain pixel value, determined by the
  52004. * `groupPixelWidth` option.
  52005. *
  52006. * If data grouping is applied, the grouping information of grouped points
  52007. * can be read from the Point.dataGroup. If point options other than the
  52008. * data itself are set, for example `name` or `color` or custom properties,
  52009. * the grouping logic doesn't know how to group it. In this case the options
  52010. * of the first point instance are copied over to the group point. This can
  52011. * be altered through a custom `approximation` callback function.
  52012. */
  52013. dataGrouping?: DataGroupingOptionsObject;
  52014. /**
  52015. * (Highcharts, Highstock, Highmaps, Gantt) Options for the series data
  52016. * labels, appearing next to each data point.
  52017. *
  52018. * Since v6.2.0, multiple data labels can be applied to each single point by
  52019. * defining them as an array of configs.
  52020. *
  52021. * In styled mode, the data labels can be styled with the
  52022. * `.highcharts-data-label-box` and `.highcharts-data-label` class names
  52023. * (see example).
  52024. */
  52025. dataLabels?: (PlotLinearregressionDataLabelsOptions|Array<PlotLinearregressionDataLabelsOptions>);
  52026. /**
  52027. * (Highcharts, Highstock) Options for the series data sorting.
  52028. */
  52029. dataSorting?: (DataSortingOptionsObject|PlotLinearregressionDataSortingOptions);
  52030. /**
  52031. * (Highstock) A description of the series to add to the screen reader
  52032. * information about the series.
  52033. */
  52034. description?: string;
  52035. /**
  52036. * (Highstock) Enable or disable the mouse tracking for a specific series.
  52037. * This includes point tooltips and click events on graphs and points. For
  52038. * large datasets it improves performance.
  52039. */
  52040. enableMouseTracking?: boolean;
  52041. /**
  52042. * (Highstock) General event handlers for the series items. These event
  52043. * hooks can also be attached to the series at run time using the
  52044. * `Highcharts.addEvent` function.
  52045. */
  52046. events?: SeriesEventsOptionsObject;
  52047. /**
  52048. * (Highstock) Determines whether the series should look for the nearest
  52049. * point in both dimensions or just the x-dimension when hovering the
  52050. * series. Defaults to `'xy'` for scatter series and `'x'` for most other
  52051. * series. If the data has duplicate x-values, it is recommended to set this
  52052. * to `'xy'` to allow hovering over all points.
  52053. *
  52054. * Applies only to series types using nearest neighbor search (not direct
  52055. * hover) for tooltip.
  52056. */
  52057. findNearestPointBy?: OptionsFindNearestPointByValue;
  52058. /**
  52059. * (Highstock) Defines when to display a gap in the graph, together with the
  52060. * gapUnit option.
  52061. *
  52062. * In case when `dataGrouping` is enabled, points can be grouped into a
  52063. * larger time span. This can make the grouped points to have a greater
  52064. * distance than the absolute value of `gapSize` property, which will result
  52065. * in disappearing graph completely. To prevent this situation the mentioned
  52066. * distance between grouped points is used instead of previously defined
  52067. * `gapSize`.
  52068. *
  52069. * In practice, this option is most often used to visualize gaps in time
  52070. * series. In a stock chart, intraday data is available for daytime hours,
  52071. * while gaps will appear in nights and weekends.
  52072. */
  52073. gapSize?: number;
  52074. /**
  52075. * (Highstock) Together with gapSize, this option defines where to draw gaps
  52076. * in the graph.
  52077. *
  52078. * When the `gapUnit` is `"relative"` (default), a gap size of 5 means that
  52079. * if the distance between two points is greater than 5 times that of the
  52080. * two closest points, the graph will be broken.
  52081. *
  52082. * When the `gapUnit` is `"value"`, the gap is based on absolute axis
  52083. * values, which on a datetime axis is milliseconds. This also applies to
  52084. * the navigator series that inherits gap options from the base series.
  52085. */
  52086. gapUnit?: OptionsGapUnitValue;
  52087. /**
  52088. * (Highcharts, Highstock, Gantt) Whether to use the Y extremes of the total
  52089. * chart width or only the zoomed area when zooming in on parts of the X
  52090. * axis. By default, the Y axis adjusts to the min and max of the visible
  52091. * data. Cartesian series only.
  52092. */
  52093. getExtremesFromAll?: boolean;
  52094. /**
  52095. * (Highstock) When set to `false` will prevent the series data from being
  52096. * included in any form of data export.
  52097. *
  52098. * Since version 6.0.0 until 7.1.0 the option was existing undocumented as
  52099. * `includeInCSVExport`.
  52100. */
  52101. includeInDataExport?: boolean;
  52102. /**
  52103. * (Highcharts, Highstock, Gantt) Series labels are placed as close to the
  52104. * series as possible in a natural way, seeking to avoid other series. The
  52105. * goal of this feature is to make the chart more easily readable, like if a
  52106. * human designer placed the labels in the optimal position.
  52107. *
  52108. * The series labels currently work with series types having a `graph` or an
  52109. * `area`.
  52110. */
  52111. label?: SeriesLabelOptionsObject;
  52112. /**
  52113. * (Highstock) The line marks the last price from all points.
  52114. */
  52115. lastPrice?: SeriesLastPriceOptionsObject;
  52116. /**
  52117. * (Highstock) The line marks the last price from visible range of points.
  52118. */
  52119. lastVisiblePrice?: SeriesLastVisiblePriceOptionsObject;
  52120. /**
  52121. * (Highcharts, Highstock) The SVG value used for the `stroke-linecap` and
  52122. * `stroke-linejoin` of a line graph. Round means that lines are rounded in
  52123. * the ends and bends.
  52124. */
  52125. linecap?: SeriesLinecapValue;
  52126. /**
  52127. * (Highcharts, Highstock) Pixel width of the graph line.
  52128. */
  52129. lineWidth?: number;
  52130. /**
  52131. * (Highcharts, Highstock, Gantt) The main series ID that indicator will be
  52132. * based on. Required for this indicator.
  52133. */
  52134. linkedTo?: string;
  52135. /**
  52136. * (Highstock) Options for the point markers of line-like series. Properties
  52137. * like `fillColor`, `lineColor` and `lineWidth` define the visual
  52138. * appearance of the markers. Other series types, like column series, don't
  52139. * have markers, but have visual options on the series level instead.
  52140. *
  52141. * In styled mode, the markers can be styled with the `.highcharts-point`,
  52142. * `.highcharts-point-hover` and `.highcharts-point-select` class names.
  52143. */
  52144. marker?: PointMarkerOptionsObject;
  52145. /**
  52146. * (Highstock) The name of the series as shown in the legend, tooltip etc.
  52147. * If not set, it will be based on a technical indicator type and default
  52148. * params.
  52149. */
  52150. name?: string;
  52151. /**
  52152. * (Highstock) The color for the parts of the graph or points that are below
  52153. * the threshold. Note that `zones` takes precedence over the negative
  52154. * color. Using `negativeColor` is equivalent to applying a zone with value
  52155. * of 0.
  52156. */
  52157. negativeColor?: (ColorString|GradientColorObject|PatternObject);
  52158. /**
  52159. * (Highstock) Opacity of a series parts: line, fill (e.g. area) and
  52160. * dataLabels.
  52161. */
  52162. opacity?: number;
  52163. /**
  52164. * (Highstock) Paramters used in calculation of regression series' points.
  52165. */
  52166. params?: PlotLinearregressionParamsOptions;
  52167. /**
  52168. * (Highstock) Properties for each single point.
  52169. */
  52170. point?: PlotSeriesPointOptions;
  52171. /**
  52172. * (Highstock) Same as accessibility.pointDescriptionFormatter, but for an
  52173. * individual series. Overrides the chart wide configuration.
  52174. */
  52175. pointDescriptionFormatter?: Function;
  52176. /**
  52177. * (Highstock) Whether to select the series initially. If `showCheckbox` is
  52178. * true, the checkbox next to the series name in the legend will be checked
  52179. * for a selected series.
  52180. */
  52181. selected?: boolean;
  52182. /**
  52183. * (Highstock) Whether to apply a drop shadow to the graph line. Since 2.3
  52184. * the shadow can be an object configuration containing `color`, `offsetX`,
  52185. * `offsetY`, `opacity` and `width`.
  52186. */
  52187. shadow?: (boolean|ShadowOptionsObject);
  52188. /**
  52189. * (Highstock) If true, a checkbox is displayed next to the legend item to
  52190. * allow selecting the series. The state of the checkbox is determined by
  52191. * the `selected` option.
  52192. */
  52193. showCheckbox?: boolean;
  52194. /**
  52195. * (Highstock) Whether to display this particular series or series type in
  52196. * the legend. Standalone series are shown in legend by default, and linked
  52197. * series are not. Since v7.2.0 it is possible to show series that use
  52198. * colorAxis by setting this option to `true`.
  52199. */
  52200. showInLegend?: boolean;
  52201. /**
  52202. * (Highstock) If set to `true`, the accessibility module will skip past the
  52203. * points in this series for keyboard navigation.
  52204. */
  52205. skipKeyboardNavigation?: boolean;
  52206. /**
  52207. * (Highcharts, Highstock) When this is true, the series will not cause the
  52208. * Y axis to cross the zero plane (or threshold option) unless the data
  52209. * actually crosses the plane.
  52210. *
  52211. * For example, if `softThreshold` is `false`, a series of 0, 1, 2, 3 will
  52212. * make the Y axis show negative values according to the `minPadding`
  52213. * option. If `softThreshold` is `true`, the Y axis starts at 0.
  52214. */
  52215. softThreshold?: boolean;
  52216. states?: SeriesStatesOptionsObject;
  52217. /**
  52218. * (Highcharts, Highstock) Whether to apply steps to the line. Possible
  52219. * values are `left`, `center` and `right`.
  52220. */
  52221. step?: OptionsStepValue;
  52222. /**
  52223. * (Highstock) Sticky tracking of mouse events. When true, the `mouseOut`
  52224. * event on a series isn't triggered until the mouse moves over another
  52225. * series, or out of the plot area. When false, the `mouseOut` event on a
  52226. * series is triggered when the mouse leaves the area around the series'
  52227. * graph or markers. This also implies the tooltip when not shared. When
  52228. * `stickyTracking` is false and `tooltip.shared` is false, the tooltip will
  52229. * be hidden when moving the mouse between series. Defaults to true for line
  52230. * and area type series, but to false for columns, pies etc.
  52231. *
  52232. * **Note:** The boost module will force this option because of technical
  52233. * limitations.
  52234. */
  52235. stickyTracking?: boolean;
  52236. /**
  52237. * (Highcharts, Highstock) The threshold, also called zero level or base
  52238. * level. For line type series this is only used in conjunction with
  52239. * negativeColor.
  52240. */
  52241. threshold?: (number|null);
  52242. /**
  52243. * (Highstock) A configuration object for the tooltip rendering of each
  52244. * single series. Properties are inherited from tooltip, but only the
  52245. * following properties can be defined on a series level.
  52246. */
  52247. tooltip?: SeriesTooltipOptionsObject;
  52248. /**
  52249. * (Highcharts, Highstock, Gantt) When a series contains a data array that
  52250. * is longer than this, only one dimensional arrays of numbers, or two
  52251. * dimensional arrays with x and y values are allowed. Also, only the first
  52252. * point is tested, and the rest are assumed to be the same format. This
  52253. * saves expensive data checking and indexing in long series. Set it to `0`
  52254. * disable.
  52255. *
  52256. * Note: In boost mode turbo threshold is forced. Only array of numbers or
  52257. * two dimensional arrays are allowed.
  52258. */
  52259. turboThreshold?: number;
  52260. /**
  52261. * (Highstock) Set the initial visibility of the series.
  52262. */
  52263. visible?: boolean;
  52264. /**
  52265. * (Highmaps) Define the z index of the series.
  52266. */
  52267. zIndex?: number;
  52268. /**
  52269. * (Highcharts, Highstock) Defines the Axis on which the zones are applied.
  52270. */
  52271. zoneAxis?: string;
  52272. /**
  52273. * (Highcharts, Highstock) An array defining zones within a series. Zones
  52274. * can be applied to the X axis, Y axis or Z axis for bubbles, according to
  52275. * the `zoneAxis` option. The zone definitions have to be in ascending order
  52276. * regarding to the value.
  52277. *
  52278. * In styled mode, the color zones are styled with the
  52279. * `.highcharts-zone-{n}` class, or custom classed from the `className`
  52280. * option (view live demo).
  52281. */
  52282. zones?: Array<SeriesZonesOptionsObject>;
  52283. }
  52284. /**
  52285. * (Highstock) Paramters used in calculation of regression series' points.
  52286. */
  52287. export interface PlotLinearregressionParamsOptions {
  52288. /**
  52289. * (Highstock) The point index which indicator calculations will base. For
  52290. * example using OHLC data, index=2 means the indicator will be calculated
  52291. * using Low values.
  52292. */
  52293. index?: number;
  52294. /**
  52295. * (Highstock) The base period for indicator calculations. This is the
  52296. * number of data points which are taken into account for the indicator
  52297. * calculations.
  52298. */
  52299. period?: number;
  52300. /**
  52301. * (Highstock) Unit (in milliseconds) for the x axis distances used to
  52302. * compute the regression line paramters (slope & intercept) for every
  52303. * range. In Highstock the x axis values are always represented in
  52304. * milliseconds which may cause that distances between points are "big"
  52305. * integer numbers.
  52306. *
  52307. * Highstock's linear regression algorithm (least squares method) will
  52308. * utilize these "big" integers for finding the slope and the intercept of
  52309. * the regression line for each period. In consequence, this value may be a
  52310. * very "small" decimal number that's hard to interpret by a human.
  52311. *
  52312. * For instance: `xAxisUnit` equealed to `86400000` ms (1 day) forces the
  52313. * algorithm to treat `86400000` as `1` while computing the slope and the
  52314. * intercept. This may enchance the legiblitity of the indicator's values.
  52315. *
  52316. * Default value is the closest distance between two data points.
  52317. */
  52318. xAxisUnit?: number;
  52319. }
  52320. /**
  52321. * (Highstock) Enable or disable the initial animation when a series is
  52322. * displayed. The animation can also be set as a configuration object. Please
  52323. * note that this option only applies to the initial animation of the series
  52324. * itself. For other animations, see chart.animation and the animation parameter
  52325. * under the API methods. The following properties are supported:
  52326. *
  52327. * - `defer`: The animation delay time in milliseconds.
  52328. *
  52329. * - `duration`: The duration of the animation in milliseconds.
  52330. *
  52331. * - `easing`: Can be a string reference to an easing function set on the `Math`
  52332. * object or a function. See the _Custom easing function_ demo below.
  52333. *
  52334. * Due to poor performance, animation is disabled in old IE browsers for several
  52335. * chart types.
  52336. */
  52337. export interface PlotLinearregressionslopeAnimationOptions {
  52338. defer?: number;
  52339. }
  52340. /**
  52341. * (Highcharts, Highstock, Highmaps, Gantt) Enable or disable the initial
  52342. * animation when a series is displayed for the `dataLabels`. The animation can
  52343. * also be set as a configuration object. Please note that this option only
  52344. * applies to the initial animation. For other animations, see chart.animation
  52345. * and the animation parameter under the API methods. The following properties
  52346. * are supported:
  52347. *
  52348. * - `defer`: The animation delay time in milliseconds.
  52349. */
  52350. export interface PlotLinearregressionslopeDataLabelsAnimationOptions {
  52351. /**
  52352. * (Highcharts, Highstock, Highmaps, Gantt) The animation delay time in
  52353. * milliseconds. Set to `0` renders dataLabel immediately. As `undefined`
  52354. * inherits defer time from the series.animation.defer.
  52355. */
  52356. defer?: number;
  52357. }
  52358. /**
  52359. * (Highcharts, Highstock, Highmaps, Gantt) Options for the series data labels,
  52360. * appearing next to each data point.
  52361. *
  52362. * Since v6.2.0, multiple data labels can be applied to each single point by
  52363. * defining them as an array of configs.
  52364. *
  52365. * In styled mode, the data labels can be styled with the
  52366. * `.highcharts-data-label-box` and `.highcharts-data-label` class names (see
  52367. * example).
  52368. */
  52369. export interface PlotLinearregressionslopeDataLabelsOptions {
  52370. /**
  52371. * (Highcharts, Highstock, Highmaps, Gantt) The alignment of the data label
  52372. * compared to the point. If `right`, the right side of the label should be
  52373. * touching the point. For points with an extent, like columns, the
  52374. * alignments also dictates how to align it inside the box, as given with
  52375. * the inside option. Can be one of `left`, `center` or `right`.
  52376. */
  52377. align?: (AlignValue|null);
  52378. /**
  52379. * (Highcharts, Highstock, Highmaps, Gantt) Whether to allow data labels to
  52380. * overlap. To make the labels less sensitive for overlapping, the
  52381. * dataLabels.padding can be set to 0.
  52382. */
  52383. allowOverlap?: boolean;
  52384. /**
  52385. * (Highcharts, Highstock, Highmaps, Gantt) Enable or disable the initial
  52386. * animation when a series is displayed for the `dataLabels`. The animation
  52387. * can also be set as a configuration object. Please note that this option
  52388. * only applies to the initial animation. For other animations, see
  52389. * chart.animation and the animation parameter under the API methods. The
  52390. * following properties are supported:
  52391. *
  52392. * - `defer`: The animation delay time in milliseconds.
  52393. */
  52394. animation?: (boolean|PlotLinearregressionslopeDataLabelsAnimationOptions|Partial<AnimationOptionsObject>);
  52395. /**
  52396. * (Highcharts, Highstock, Highmaps, Gantt) The background color or gradient
  52397. * for the data label.
  52398. */
  52399. backgroundColor?: (ColorString|GradientColorObject|PatternObject);
  52400. /**
  52401. * (Highcharts, Highstock, Highmaps, Gantt) The border color for the data
  52402. * label. Defaults to `undefined`.
  52403. */
  52404. borderColor?: (ColorString|GradientColorObject|PatternObject);
  52405. /**
  52406. * (Highcharts, Highstock, Highmaps, Gantt) The border radius in pixels for
  52407. * the data label.
  52408. */
  52409. borderRadius?: number;
  52410. /**
  52411. * (Highcharts, Highstock, Highmaps, Gantt) The border width in pixels for
  52412. * the data label.
  52413. */
  52414. borderWidth?: number;
  52415. /**
  52416. * (Highcharts, Highstock, Highmaps, Gantt) A class name for the data label.
  52417. * Particularly in styled mode, this can be used to give each series' or
  52418. * point's data label unique styling. In addition to this option, a default
  52419. * color class name is added so that we can give the labels a contrast text
  52420. * shadow.
  52421. */
  52422. className?: string;
  52423. /**
  52424. * (Highcharts, Highstock, Highmaps, Gantt) The text color for the data
  52425. * labels. Defaults to `undefined`. For certain series types, like column or
  52426. * map, the data labels can be drawn inside the points. In this case the
  52427. * data label will be drawn with maximum contrast by default. Additionally,
  52428. * it will be given a `text-outline` style with the opposite color, to
  52429. * further increase the contrast. This can be overridden by setting the
  52430. * `text-outline` style to `none` in the `dataLabels.style` option.
  52431. */
  52432. color?: (ColorString|GradientColorObject|PatternObject);
  52433. /**
  52434. * (Highcharts, Highstock, Highmaps, Gantt) Whether to hide data labels that
  52435. * are outside the plot area. By default, the data label is moved inside the
  52436. * plot area according to the overflow option.
  52437. */
  52438. crop?: boolean;
  52439. /**
  52440. * (Highcharts, Highstock, Gantt) Whether to defer displaying the data
  52441. * labels until the initial series animation has finished. Setting to
  52442. * `false` renders the data label immediately. If set to `true` inherits the
  52443. * defer time set in plotOptions.series.animation.
  52444. */
  52445. defer?: boolean;
  52446. /**
  52447. * (Highcharts, Highstock, Highmaps, Gantt) Enable or disable the data
  52448. * labels.
  52449. */
  52450. enabled?: boolean;
  52451. /**
  52452. * (Highcharts, Highstock, Highmaps, Gantt) A declarative filter to control
  52453. * of which data labels to display. The declarative filter is designed for
  52454. * use when callback functions are not available, like when the chart
  52455. * options require a pure JSON structure or for use with graphical editors.
  52456. * For programmatic control, use the `formatter` instead, and return
  52457. * `undefined` to disable a single data label.
  52458. */
  52459. filter?: DataLabelsFilterOptionsObject;
  52460. /**
  52461. * (Highcharts, Highstock, Highmaps, Gantt) A format string for the data
  52462. * label. Available variables are the same as for `formatter`.
  52463. */
  52464. format?: string;
  52465. /**
  52466. * (Highcharts, Highstock, Highmaps, Gantt) Callback JavaScript function to
  52467. * format the data label. Note that if a `format` is defined, the format
  52468. * takes precedence and the formatter is ignored.
  52469. */
  52470. formatter?: DataLabelsFormatterCallbackFunction;
  52471. /**
  52472. * (Highcharts, Highstock, Highmaps, Gantt) For points with an extent, like
  52473. * columns or map areas, whether to align the data label inside the box or
  52474. * to the actual value point. Defaults to `false` in most cases, `true` in
  52475. * stacked columns.
  52476. */
  52477. inside?: boolean;
  52478. /**
  52479. * (Highcharts, Highstock, Highmaps, Gantt) Format for points with the value
  52480. * of null. Works analogously to format. `nullFormat` can be applied only to
  52481. * series which support displaying null points.
  52482. */
  52483. nullFormat?: (boolean|string);
  52484. /**
  52485. * (Highcharts, Highstock, Highmaps, Gantt) Callback JavaScript function
  52486. * that defines formatting for points with the value of null. Works
  52487. * analogously to formatter. `nullPointFormatter` can be applied only to
  52488. * series which support displaying null points.
  52489. */
  52490. nullFormatter?: DataLabelsFormatterCallbackFunction;
  52491. /**
  52492. * (Highcharts, Highstock, Highmaps, Gantt) How to handle data labels that
  52493. * flow outside the plot area. The default is `"justify"`, which aligns them
  52494. * inside the plot area. For columns and bars, this means it will be moved
  52495. * inside the bar. To display data labels outside the plot area, set `crop`
  52496. * to `false` and `overflow` to `"allow"`.
  52497. */
  52498. overflow?: DataLabelsOverflowValue;
  52499. /**
  52500. * (Highcharts, Highstock, Highmaps, Gantt) When either the `borderWidth` or
  52501. * the `backgroundColor` is set, this is the padding within the box.
  52502. */
  52503. padding?: number;
  52504. /**
  52505. * (Highcharts, Highstock, Highmaps, Gantt) Aligns data labels relative to
  52506. * points. If `center` alignment is not possible, it defaults to `right`.
  52507. */
  52508. position?: AlignValue;
  52509. /**
  52510. * (Highcharts, Highstock, Highmaps, Gantt) Text rotation in degrees. Note
  52511. * that due to a more complex structure, backgrounds, borders and padding
  52512. * will be lost on a rotated data label.
  52513. */
  52514. rotation?: number;
  52515. /**
  52516. * (Highcharts, Highstock, Highmaps, Gantt) The shadow of the box. Works
  52517. * best with `borderWidth` or `backgroundColor`. Since 2.3 the shadow can be
  52518. * an object configuration containing `color`, `offsetX`, `offsetY`,
  52519. * `opacity` and `width`.
  52520. */
  52521. shadow?: (boolean|ShadowOptionsObject);
  52522. /**
  52523. * (Highcharts, Highstock, Highmaps, Gantt) The name of a symbol to use for
  52524. * the border around the label. Symbols are predefined functions on the
  52525. * Renderer object.
  52526. */
  52527. shape?: string;
  52528. /**
  52529. * (Highcharts, Highstock, Highmaps, Gantt) Styles for the label. The
  52530. * default `color` setting is `"contrast"`, which is a pseudo color that
  52531. * Highcharts picks up and applies the maximum contrast to the underlying
  52532. * point item, for example the bar in a bar chart.
  52533. *
  52534. * The `textOutline` is a pseudo property that applies an outline of the
  52535. * given width with the given color, which by default is the maximum
  52536. * contrast to the text. So a bright text color will result in a black text
  52537. * outline for maximum readability on a mixed background. In some cases,
  52538. * especially with grayscale text, the text outline doesn't work well, in
  52539. * which cases it can be disabled by setting it to `"none"`. When `useHTML`
  52540. * is true, the `textOutline` will not be picked up. In this, case, the same
  52541. * effect can be acheived through the `text-shadow` CSS property.
  52542. *
  52543. * For some series types, where each point has an extent, like for example
  52544. * tree maps, the data label may overflow the point. There are two
  52545. * strategies for handling overflow. By default, the text will wrap to
  52546. * multiple lines. The other strategy is to set `style.textOverflow` to
  52547. * `ellipsis`, which will keep the text on one line plus it will break
  52548. * inside long words.
  52549. */
  52550. style?: CSSObject;
  52551. /**
  52552. * (Highcharts, Highstock, Highmaps, Gantt) Options for a label text which
  52553. * should follow marker's shape. Border and background are disabled for a
  52554. * label that follows a path.
  52555. *
  52556. * **Note:** Only SVG-based renderer supports this option. Setting `useHTML`
  52557. * to true will disable this option.
  52558. */
  52559. textPath?: DataLabelsTextPathOptionsObject;
  52560. /**
  52561. * (Highcharts, Highstock, Highmaps, Gantt) Whether to use HTML to render
  52562. * the labels.
  52563. */
  52564. useHTML?: boolean;
  52565. /**
  52566. * (Highcharts, Highstock, Highmaps, Gantt) The vertical alignment of a data
  52567. * label. Can be one of `top`, `middle` or `bottom`. The default value
  52568. * depends on the data, for instance in a column chart, the label is above
  52569. * positive values and below negative values.
  52570. */
  52571. verticalAlign?: (VerticalAlignValue|null);
  52572. /**
  52573. * (Highcharts, Highstock, Highmaps, Gantt) The x position offset of the
  52574. * label relative to the point in pixels.
  52575. */
  52576. x?: number;
  52577. /**
  52578. * (Highcharts, Highstock, Highmaps, Gantt) The y position offset of the
  52579. * label relative to the point in pixels.
  52580. */
  52581. y?: number;
  52582. /**
  52583. * (Highcharts, Highstock, Highmaps, Gantt) The Z index of the data labels.
  52584. * The default Z index puts it above the series. Use a Z index of 2 to
  52585. * display it behind the series.
  52586. */
  52587. z?: number;
  52588. }
  52589. /**
  52590. * (Highcharts, Highstock) Options for the series data sorting.
  52591. */
  52592. export interface PlotLinearregressionslopeDataSortingOptions {
  52593. /**
  52594. * (Highcharts, Highstock) Enable or disable data sorting for the series.
  52595. * Use xAxis.reversed to change the sorting order.
  52596. */
  52597. enabled?: boolean;
  52598. /**
  52599. * (Highcharts, Highstock) Whether to allow matching points by name in an
  52600. * update. If this option is disabled, points will be matched by order.
  52601. */
  52602. matchByName?: boolean;
  52603. /**
  52604. * (Highcharts, Highstock) Determines what data value should be used to sort
  52605. * by.
  52606. */
  52607. sortKey?: string;
  52608. }
  52609. /**
  52610. * (Highstock) Linear regression slope indicator. This series requires
  52611. * `linkedTo` option to be set.
  52612. *
  52613. * In TypeScript the type option must always be set.
  52614. *
  52615. * Configuration options for the series are given in three levels:
  52616. *
  52617. * 1. Options for all series in a chart are defined in the plotOptions.series
  52618. * object.
  52619. *
  52620. * 2. Options for all `linearregressionslope` series are defined in
  52621. * plotOptions.linearregressionslope.
  52622. *
  52623. * 3. Options for one single series are given in the series instance array. (see
  52624. * online documentation for example)
  52625. */
  52626. export interface PlotLinearregressionslopeOptions {
  52627. /**
  52628. * (Highstock) Accessibility options for a series.
  52629. */
  52630. accessibility?: SeriesAccessibilityOptionsObject;
  52631. /**
  52632. * (Highstock) Allow this series' points to be selected by clicking on the
  52633. * graphic (columns, point markers, pie slices, map areas etc).
  52634. *
  52635. * The selected points can be handled by point select and unselect events,
  52636. * or collectively by the getSelectedPoints function.
  52637. *
  52638. * And alternative way of selecting points is through dragging.
  52639. */
  52640. allowPointSelect?: boolean;
  52641. /**
  52642. * (Highstock) Enable or disable the initial animation when a series is
  52643. * displayed. The animation can also be set as a configuration object.
  52644. * Please note that this option only applies to the initial animation of the
  52645. * series itself. For other animations, see chart.animation and the
  52646. * animation parameter under the API methods. The following properties are
  52647. * supported:
  52648. *
  52649. * - `defer`: The animation delay time in milliseconds.
  52650. *
  52651. * - `duration`: The duration of the animation in milliseconds.
  52652. *
  52653. * - `easing`: Can be a string reference to an easing function set on the
  52654. * `Math` object or a function. See the _Custom easing function_ demo below.
  52655. *
  52656. * Due to poor performance, animation is disabled in old IE browsers for
  52657. * several chart types.
  52658. */
  52659. animation?: (boolean|PlotLinearregressionslopeAnimationOptions|Partial<AnimationOptionsObject>);
  52660. /**
  52661. * (Highstock) For some series, there is a limit that shuts down initial
  52662. * animation by default when the total number of points in the chart is too
  52663. * high. For example, for a column chart and its derivatives, animation does
  52664. * not run if there is more than 250 points totally. To disable this cap,
  52665. * set `animationLimit` to `Infinity`.
  52666. */
  52667. animationLimit?: number;
  52668. /**
  52669. * (Highstock) Sets the color blending in the boost module.
  52670. */
  52671. boostBlending?: OptionsBoostBlendingValue;
  52672. /**
  52673. * (Highstock) Set the point threshold for when a series should enter boost
  52674. * mode.
  52675. *
  52676. * Setting it to e.g. 2000 will cause the series to enter boost mode when
  52677. * there are 2000 or more points in the series.
  52678. *
  52679. * To disable boosting on the series, set the `boostThreshold` to 0. Setting
  52680. * it to 1 will force boosting.
  52681. *
  52682. * Note that the cropThreshold also affects this setting. When zooming in on
  52683. * a series that has fewer points than the `cropThreshold`, all points are
  52684. * rendered although outside the visible plot area, and the `boostThreshold`
  52685. * won't take effect.
  52686. */
  52687. boostThreshold?: number;
  52688. /**
  52689. * (Highmaps) The border color of the map areas.
  52690. *
  52691. * In styled mode, the border stroke is given in the `.highcharts-point`
  52692. * class.
  52693. */
  52694. borderColor?: (ColorString|GradientColorObject|PatternObject);
  52695. /**
  52696. * (Highmaps) The border width of each map area.
  52697. *
  52698. * In styled mode, the border stroke width is given in the
  52699. * `.highcharts-point` class.
  52700. */
  52701. borderWidth?: number;
  52702. /**
  52703. * (Highstock) An additional class name to apply to the series' graphical
  52704. * elements. This option does not replace default class names of the
  52705. * graphical element.
  52706. */
  52707. className?: string;
  52708. /**
  52709. * (Highstock) Disable this option to allow series rendering in the whole
  52710. * plotting area.
  52711. *
  52712. * **Note:** Clipping should be always enabled when chart.zoomType is set
  52713. */
  52714. clip?: boolean;
  52715. /**
  52716. * (Highstock) The main color of the series. In line type series it applies
  52717. * to the line and the point markers unless otherwise specified. In bar type
  52718. * series it applies to the bars unless a color is specified per point. The
  52719. * default value is pulled from the `options.colors` array.
  52720. *
  52721. * In styled mode, the color can be defined by the colorIndex option. Also,
  52722. * the series color can be set with the `.highcharts-series`,
  52723. * `.highcharts-color-{n}`, `.highcharts-{type}-series` or
  52724. * `.highcharts-series-{n}` class, or individual classes given by the
  52725. * `className` option.
  52726. */
  52727. color?: (ColorString|GradientColorObject|PatternObject);
  52728. /**
  52729. * (Highstock) Styled mode only. A specific color index to use for the
  52730. * series, so its graphic representations are given the class name
  52731. * `highcharts-color-{n}`.
  52732. */
  52733. colorIndex?: number;
  52734. /**
  52735. * (Highcharts, Highstock, Highmaps) Determines what data value should be
  52736. * used to calculate point color if `colorAxis` is used. Requires to set
  52737. * `min` and `max` if some custom point property is used or if approximation
  52738. * for data grouping is set to `'sum'`.
  52739. */
  52740. colorKey?: string;
  52741. /**
  52742. * (Highstock) Compare the values of the series against the first non-null,
  52743. * non- zero value in the visible range. The y axis will show percentage or
  52744. * absolute change depending on whether `compare` is set to `"percent"` or
  52745. * `"value"`. When this is applied to multiple series, it allows comparing
  52746. * the development of the series against each other. Adds a `change` field
  52747. * to every point object.
  52748. */
  52749. compare?: string;
  52750. /**
  52751. * (Highstock) When compare is `percent`, this option dictates whether to
  52752. * use 0 or 100 as the base of comparison.
  52753. */
  52754. compareBase?: (0|100);
  52755. /**
  52756. * (Highstock) Defines if comparison should start from the first point
  52757. * within the visible range or should start from the first point **before**
  52758. * the range.
  52759. *
  52760. * In other words, this flag determines if first point within the visible
  52761. * range will have 0% (`compareStart=true`) or should have been already
  52762. * calculated according to the previous point (`compareStart=false`).
  52763. */
  52764. compareStart?: boolean;
  52765. /**
  52766. * (Highstock) Whether to compare indicator to the main series values or
  52767. * indicator values.
  52768. */
  52769. compareToMain?: boolean;
  52770. /**
  52771. * (Highcharts) Polar charts only. Whether to connect the ends of a line
  52772. * series plot across the extremes.
  52773. */
  52774. connectEnds?: boolean;
  52775. /**
  52776. * (Highcharts, Highstock) Whether to connect a graph line across null
  52777. * points, or render a gap between the two points on either side of the
  52778. * null.
  52779. */
  52780. connectNulls?: boolean;
  52781. /**
  52782. * (Gantt) Override Pathfinder connector options for a series. Requires
  52783. * Highcharts Gantt to be loaded.
  52784. */
  52785. connectors?: SeriesConnectorsOptionsObject;
  52786. /**
  52787. * (Highcharts, Highstock, Gantt) When true, each point or column edge is
  52788. * rounded to its nearest pixel in order to render sharp on screen. In some
  52789. * cases, when there are a lot of densely packed columns, this leads to
  52790. * visible difference in column widths or distance between columns. In these
  52791. * cases, setting `crisp` to `false` may look better, even though each
  52792. * column is rendered blurry.
  52793. */
  52794. crisp?: boolean;
  52795. /**
  52796. * (Highcharts, Highstock) When the series contains less points than the
  52797. * crop threshold, all points are drawn, even if the points fall outside the
  52798. * visible plot area at the current zoom. The advantage of drawing all
  52799. * points (including markers and columns), is that animation is performed on
  52800. * updates. On the other hand, when the series contains more points than the
  52801. * crop threshold, the series data is cropped to only contain points that
  52802. * fall within the plot area. The advantage of cropping away invisible
  52803. * points is to increase performance on large series.
  52804. */
  52805. cropThreshold?: number;
  52806. /**
  52807. * (Highstock) You can set the cursor to "pointer" if you have click events
  52808. * attached to the series, to signal to the user that the points and lines
  52809. * can be clicked.
  52810. *
  52811. * In styled mode, the series cursor can be set with the same classes as
  52812. * listed under series.color.
  52813. */
  52814. cursor?: (string|CursorValue);
  52815. /**
  52816. * (Highstock) A reserved subspace to store options and values for
  52817. * customized functionality. Here you can add additional data for your own
  52818. * event callbacks and formatter callbacks.
  52819. */
  52820. custom?: Dictionary<any>;
  52821. /**
  52822. * (Highstock) Name of the dash style to use for the graph, or for some
  52823. * series types the outline of each shape.
  52824. *
  52825. * In styled mode, the stroke dash-array can be set with the same classes as
  52826. * listed under series.color.
  52827. */
  52828. dashStyle?: DashStyleValue;
  52829. /**
  52830. * (Highstock) Data grouping is the concept of sampling the data values into
  52831. * larger blocks in order to ease readability and increase performance of
  52832. * the JavaScript charts. Highstock by default applies data grouping when
  52833. * the points become closer than a certain pixel value, determined by the
  52834. * `groupPixelWidth` option.
  52835. *
  52836. * If data grouping is applied, the grouping information of grouped points
  52837. * can be read from the Point.dataGroup. If point options other than the
  52838. * data itself are set, for example `name` or `color` or custom properties,
  52839. * the grouping logic doesn't know how to group it. In this case the options
  52840. * of the first point instance are copied over to the group point. This can
  52841. * be altered through a custom `approximation` callback function.
  52842. */
  52843. dataGrouping?: DataGroupingOptionsObject;
  52844. /**
  52845. * (Highcharts, Highstock, Highmaps, Gantt) Options for the series data
  52846. * labels, appearing next to each data point.
  52847. *
  52848. * Since v6.2.0, multiple data labels can be applied to each single point by
  52849. * defining them as an array of configs.
  52850. *
  52851. * In styled mode, the data labels can be styled with the
  52852. * `.highcharts-data-label-box` and `.highcharts-data-label` class names
  52853. * (see example).
  52854. */
  52855. dataLabels?: (PlotLinearregressionslopeDataLabelsOptions|Array<PlotLinearregressionslopeDataLabelsOptions>);
  52856. /**
  52857. * (Highcharts, Highstock) Options for the series data sorting.
  52858. */
  52859. dataSorting?: (DataSortingOptionsObject|PlotLinearregressionslopeDataSortingOptions);
  52860. /**
  52861. * (Highstock) A description of the series to add to the screen reader
  52862. * information about the series.
  52863. */
  52864. description?: string;
  52865. /**
  52866. * (Highstock) Enable or disable the mouse tracking for a specific series.
  52867. * This includes point tooltips and click events on graphs and points. For
  52868. * large datasets it improves performance.
  52869. */
  52870. enableMouseTracking?: boolean;
  52871. /**
  52872. * (Highstock) General event handlers for the series items. These event
  52873. * hooks can also be attached to the series at run time using the
  52874. * `Highcharts.addEvent` function.
  52875. */
  52876. events?: SeriesEventsOptionsObject;
  52877. /**
  52878. * (Highstock) Determines whether the series should look for the nearest
  52879. * point in both dimensions or just the x-dimension when hovering the
  52880. * series. Defaults to `'xy'` for scatter series and `'x'` for most other
  52881. * series. If the data has duplicate x-values, it is recommended to set this
  52882. * to `'xy'` to allow hovering over all points.
  52883. *
  52884. * Applies only to series types using nearest neighbor search (not direct
  52885. * hover) for tooltip.
  52886. */
  52887. findNearestPointBy?: OptionsFindNearestPointByValue;
  52888. /**
  52889. * (Highstock) Defines when to display a gap in the graph, together with the
  52890. * gapUnit option.
  52891. *
  52892. * In case when `dataGrouping` is enabled, points can be grouped into a
  52893. * larger time span. This can make the grouped points to have a greater
  52894. * distance than the absolute value of `gapSize` property, which will result
  52895. * in disappearing graph completely. To prevent this situation the mentioned
  52896. * distance between grouped points is used instead of previously defined
  52897. * `gapSize`.
  52898. *
  52899. * In practice, this option is most often used to visualize gaps in time
  52900. * series. In a stock chart, intraday data is available for daytime hours,
  52901. * while gaps will appear in nights and weekends.
  52902. */
  52903. gapSize?: number;
  52904. /**
  52905. * (Highstock) Together with gapSize, this option defines where to draw gaps
  52906. * in the graph.
  52907. *
  52908. * When the `gapUnit` is `"relative"` (default), a gap size of 5 means that
  52909. * if the distance between two points is greater than 5 times that of the
  52910. * two closest points, the graph will be broken.
  52911. *
  52912. * When the `gapUnit` is `"value"`, the gap is based on absolute axis
  52913. * values, which on a datetime axis is milliseconds. This also applies to
  52914. * the navigator series that inherits gap options from the base series.
  52915. */
  52916. gapUnit?: OptionsGapUnitValue;
  52917. /**
  52918. * (Highcharts, Highstock, Gantt) Whether to use the Y extremes of the total
  52919. * chart width or only the zoomed area when zooming in on parts of the X
  52920. * axis. By default, the Y axis adjusts to the min and max of the visible
  52921. * data. Cartesian series only.
  52922. */
  52923. getExtremesFromAll?: boolean;
  52924. /**
  52925. * (Highstock) When set to `false` will prevent the series data from being
  52926. * included in any form of data export.
  52927. *
  52928. * Since version 6.0.0 until 7.1.0 the option was existing undocumented as
  52929. * `includeInCSVExport`.
  52930. */
  52931. includeInDataExport?: boolean;
  52932. /**
  52933. * (Highcharts, Highstock, Gantt) Series labels are placed as close to the
  52934. * series as possible in a natural way, seeking to avoid other series. The
  52935. * goal of this feature is to make the chart more easily readable, like if a
  52936. * human designer placed the labels in the optimal position.
  52937. *
  52938. * The series labels currently work with series types having a `graph` or an
  52939. * `area`.
  52940. */
  52941. label?: SeriesLabelOptionsObject;
  52942. /**
  52943. * (Highstock) The line marks the last price from all points.
  52944. */
  52945. lastPrice?: SeriesLastPriceOptionsObject;
  52946. /**
  52947. * (Highstock) The line marks the last price from visible range of points.
  52948. */
  52949. lastVisiblePrice?: SeriesLastVisiblePriceOptionsObject;
  52950. /**
  52951. * (Highcharts, Highstock) The SVG value used for the `stroke-linecap` and
  52952. * `stroke-linejoin` of a line graph. Round means that lines are rounded in
  52953. * the ends and bends.
  52954. */
  52955. linecap?: SeriesLinecapValue;
  52956. /**
  52957. * (Highcharts, Highstock) Pixel width of the graph line.
  52958. */
  52959. lineWidth?: number;
  52960. /**
  52961. * (Highcharts, Highstock, Gantt) The main series ID that indicator will be
  52962. * based on. Required for this indicator.
  52963. */
  52964. linkedTo?: string;
  52965. /**
  52966. * (Highstock) Options for the point markers of line-like series. Properties
  52967. * like `fillColor`, `lineColor` and `lineWidth` define the visual
  52968. * appearance of the markers. Other series types, like column series, don't
  52969. * have markers, but have visual options on the series level instead.
  52970. *
  52971. * In styled mode, the markers can be styled with the `.highcharts-point`,
  52972. * `.highcharts-point-hover` and `.highcharts-point-select` class names.
  52973. */
  52974. marker?: PointMarkerOptionsObject;
  52975. /**
  52976. * (Highstock) The name of the series as shown in the legend, tooltip etc.
  52977. * If not set, it will be based on a technical indicator type and default
  52978. * params.
  52979. */
  52980. name?: string;
  52981. /**
  52982. * (Highstock) The color for the parts of the graph or points that are below
  52983. * the threshold. Note that `zones` takes precedence over the negative
  52984. * color. Using `negativeColor` is equivalent to applying a zone with value
  52985. * of 0.
  52986. */
  52987. negativeColor?: (ColorString|GradientColorObject|PatternObject);
  52988. /**
  52989. * (Highstock) Opacity of a series parts: line, fill (e.g. area) and
  52990. * dataLabels.
  52991. */
  52992. opacity?: number;
  52993. /**
  52994. * (Highstock) Paramters used in calculation of regression series' points.
  52995. */
  52996. params?: PlotLinearregressionslopeParamsOptions;
  52997. /**
  52998. * (Highstock) Properties for each single point.
  52999. */
  53000. point?: PlotSeriesPointOptions;
  53001. /**
  53002. * (Highstock) Same as accessibility.pointDescriptionFormatter, but for an
  53003. * individual series. Overrides the chart wide configuration.
  53004. */
  53005. pointDescriptionFormatter?: Function;
  53006. /**
  53007. * (Highstock) Whether to select the series initially. If `showCheckbox` is
  53008. * true, the checkbox next to the series name in the legend will be checked
  53009. * for a selected series.
  53010. */
  53011. selected?: boolean;
  53012. /**
  53013. * (Highstock) Whether to apply a drop shadow to the graph line. Since 2.3
  53014. * the shadow can be an object configuration containing `color`, `offsetX`,
  53015. * `offsetY`, `opacity` and `width`.
  53016. */
  53017. shadow?: (boolean|ShadowOptionsObject);
  53018. /**
  53019. * (Highstock) If true, a checkbox is displayed next to the legend item to
  53020. * allow selecting the series. The state of the checkbox is determined by
  53021. * the `selected` option.
  53022. */
  53023. showCheckbox?: boolean;
  53024. /**
  53025. * (Highstock) Whether to display this particular series or series type in
  53026. * the legend. Standalone series are shown in legend by default, and linked
  53027. * series are not. Since v7.2.0 it is possible to show series that use
  53028. * colorAxis by setting this option to `true`.
  53029. */
  53030. showInLegend?: boolean;
  53031. /**
  53032. * (Highstock) If set to `true`, the accessibility module will skip past the
  53033. * points in this series for keyboard navigation.
  53034. */
  53035. skipKeyboardNavigation?: boolean;
  53036. /**
  53037. * (Highcharts, Highstock) When this is true, the series will not cause the
  53038. * Y axis to cross the zero plane (or threshold option) unless the data
  53039. * actually crosses the plane.
  53040. *
  53041. * For example, if `softThreshold` is `false`, a series of 0, 1, 2, 3 will
  53042. * make the Y axis show negative values according to the `minPadding`
  53043. * option. If `softThreshold` is `true`, the Y axis starts at 0.
  53044. */
  53045. softThreshold?: boolean;
  53046. states?: SeriesStatesOptionsObject;
  53047. /**
  53048. * (Highcharts, Highstock) Whether to apply steps to the line. Possible
  53049. * values are `left`, `center` and `right`.
  53050. */
  53051. step?: OptionsStepValue;
  53052. /**
  53053. * (Highstock) Sticky tracking of mouse events. When true, the `mouseOut`
  53054. * event on a series isn't triggered until the mouse moves over another
  53055. * series, or out of the plot area. When false, the `mouseOut` event on a
  53056. * series is triggered when the mouse leaves the area around the series'
  53057. * graph or markers. This also implies the tooltip when not shared. When
  53058. * `stickyTracking` is false and `tooltip.shared` is false, the tooltip will
  53059. * be hidden when moving the mouse between series. Defaults to true for line
  53060. * and area type series, but to false for columns, pies etc.
  53061. *
  53062. * **Note:** The boost module will force this option because of technical
  53063. * limitations.
  53064. */
  53065. stickyTracking?: boolean;
  53066. /**
  53067. * (Highcharts, Highstock) The threshold, also called zero level or base
  53068. * level. For line type series this is only used in conjunction with
  53069. * negativeColor.
  53070. */
  53071. threshold?: (number|null);
  53072. /**
  53073. * (Highstock) A configuration object for the tooltip rendering of each
  53074. * single series. Properties are inherited from tooltip, but only the
  53075. * following properties can be defined on a series level.
  53076. */
  53077. tooltip?: SeriesTooltipOptionsObject;
  53078. /**
  53079. * (Highcharts, Highstock, Gantt) When a series contains a data array that
  53080. * is longer than this, only one dimensional arrays of numbers, or two
  53081. * dimensional arrays with x and y values are allowed. Also, only the first
  53082. * point is tested, and the rest are assumed to be the same format. This
  53083. * saves expensive data checking and indexing in long series. Set it to `0`
  53084. * disable.
  53085. *
  53086. * Note: In boost mode turbo threshold is forced. Only array of numbers or
  53087. * two dimensional arrays are allowed.
  53088. */
  53089. turboThreshold?: number;
  53090. /**
  53091. * (Highstock) Set the initial visibility of the series.
  53092. */
  53093. visible?: boolean;
  53094. /**
  53095. * (Highmaps) Define the z index of the series.
  53096. */
  53097. zIndex?: number;
  53098. /**
  53099. * (Highcharts, Highstock) Defines the Axis on which the zones are applied.
  53100. */
  53101. zoneAxis?: string;
  53102. /**
  53103. * (Highcharts, Highstock) An array defining zones within a series. Zones
  53104. * can be applied to the X axis, Y axis or Z axis for bubbles, according to
  53105. * the `zoneAxis` option. The zone definitions have to be in ascending order
  53106. * regarding to the value.
  53107. *
  53108. * In styled mode, the color zones are styled with the
  53109. * `.highcharts-zone-{n}` class, or custom classed from the `className`
  53110. * option (view live demo).
  53111. */
  53112. zones?: Array<SeriesZonesOptionsObject>;
  53113. }
  53114. /**
  53115. * (Highstock) Paramters used in calculation of regression series' points.
  53116. */
  53117. export interface PlotLinearregressionslopeParamsOptions {
  53118. /**
  53119. * (Highstock) The point index which indicator calculations will base. For
  53120. * example using OHLC data, index=2 means the indicator will be calculated
  53121. * using Low values.
  53122. */
  53123. index?: number;
  53124. /**
  53125. * (Highstock) The base period for indicator calculations. This is the
  53126. * number of data points which are taken into account for the indicator
  53127. * calculations.
  53128. */
  53129. period?: number;
  53130. /**
  53131. * (Highstock) Unit (in milliseconds) for the x axis distances used to
  53132. * compute the regression line paramters (slope & intercept) for every
  53133. * range. In Highstock the x axis values are always represented in
  53134. * milliseconds which may cause that distances between points are "big"
  53135. * integer numbers.
  53136. *
  53137. * Highstock's linear regression algorithm (least squares method) will
  53138. * utilize these "big" integers for finding the slope and the intercept of
  53139. * the regression line for each period. In consequence, this value may be a
  53140. * very "small" decimal number that's hard to interpret by a human.
  53141. *
  53142. * For instance: `xAxisUnit` equealed to `86400000` ms (1 day) forces the
  53143. * algorithm to treat `86400000` as `1` while computing the slope and the
  53144. * intercept. This may enchance the legiblitity of the indicator's values.
  53145. *
  53146. * Default value is the closest distance between two data points.
  53147. */
  53148. xAxisUnit?: number;
  53149. }
  53150. /**
  53151. * (Highcharts, Highstock, Highmaps, Gantt) Enable or disable the initial
  53152. * animation when a series is displayed for the `dataLabels`. The animation can
  53153. * also be set as a configuration object. Please note that this option only
  53154. * applies to the initial animation. For other animations, see chart.animation
  53155. * and the animation parameter under the API methods. The following properties
  53156. * are supported:
  53157. *
  53158. * - `defer`: The animation delay time in milliseconds.
  53159. */
  53160. export interface PlotLineDataLabelsAnimationOptions {
  53161. /**
  53162. * (Highcharts, Highstock, Highmaps, Gantt) The animation delay time in
  53163. * milliseconds. Set to `0` renders dataLabel immediately. As `undefined`
  53164. * inherits defer time from the series.animation.defer.
  53165. */
  53166. defer?: number;
  53167. }
  53168. /**
  53169. * (Highcharts, Highstock, Highmaps, Gantt) Options for the series data labels,
  53170. * appearing next to each data point.
  53171. *
  53172. * Since v6.2.0, multiple data labels can be applied to each single point by
  53173. * defining them as an array of configs.
  53174. *
  53175. * In styled mode, the data labels can be styled with the
  53176. * `.highcharts-data-label-box` and `.highcharts-data-label` class names (see
  53177. * example).
  53178. */
  53179. export interface PlotLineDataLabelsOptions {
  53180. /**
  53181. * (Highcharts, Highstock, Highmaps, Gantt) The alignment of the data label
  53182. * compared to the point. If `right`, the right side of the label should be
  53183. * touching the point. For points with an extent, like columns, the
  53184. * alignments also dictates how to align it inside the box, as given with
  53185. * the inside option. Can be one of `left`, `center` or `right`.
  53186. */
  53187. align?: (AlignValue|null);
  53188. /**
  53189. * (Highcharts, Highstock, Highmaps, Gantt) Whether to allow data labels to
  53190. * overlap. To make the labels less sensitive for overlapping, the
  53191. * dataLabels.padding can be set to 0.
  53192. */
  53193. allowOverlap?: boolean;
  53194. /**
  53195. * (Highcharts, Highstock, Highmaps, Gantt) Enable or disable the initial
  53196. * animation when a series is displayed for the `dataLabels`. The animation
  53197. * can also be set as a configuration object. Please note that this option
  53198. * only applies to the initial animation. For other animations, see
  53199. * chart.animation and the animation parameter under the API methods. The
  53200. * following properties are supported:
  53201. *
  53202. * - `defer`: The animation delay time in milliseconds.
  53203. */
  53204. animation?: (boolean|PlotLineDataLabelsAnimationOptions|Partial<AnimationOptionsObject>);
  53205. /**
  53206. * (Highcharts, Highstock, Highmaps, Gantt) The background color or gradient
  53207. * for the data label.
  53208. */
  53209. backgroundColor?: (ColorString|GradientColorObject|PatternObject);
  53210. /**
  53211. * (Highcharts, Highstock, Highmaps, Gantt) The border color for the data
  53212. * label. Defaults to `undefined`.
  53213. */
  53214. borderColor?: (ColorString|GradientColorObject|PatternObject);
  53215. /**
  53216. * (Highcharts, Highstock, Highmaps, Gantt) The border radius in pixels for
  53217. * the data label.
  53218. */
  53219. borderRadius?: number;
  53220. /**
  53221. * (Highcharts, Highstock, Highmaps, Gantt) The border width in pixels for
  53222. * the data label.
  53223. */
  53224. borderWidth?: number;
  53225. /**
  53226. * (Highcharts, Highstock, Highmaps, Gantt) A class name for the data label.
  53227. * Particularly in styled mode, this can be used to give each series' or
  53228. * point's data label unique styling. In addition to this option, a default
  53229. * color class name is added so that we can give the labels a contrast text
  53230. * shadow.
  53231. */
  53232. className?: string;
  53233. /**
  53234. * (Highcharts, Highstock, Highmaps, Gantt) The text color for the data
  53235. * labels. Defaults to `undefined`. For certain series types, like column or
  53236. * map, the data labels can be drawn inside the points. In this case the
  53237. * data label will be drawn with maximum contrast by default. Additionally,
  53238. * it will be given a `text-outline` style with the opposite color, to
  53239. * further increase the contrast. This can be overridden by setting the
  53240. * `text-outline` style to `none` in the `dataLabels.style` option.
  53241. */
  53242. color?: (ColorString|GradientColorObject|PatternObject);
  53243. /**
  53244. * (Highcharts, Highstock, Highmaps, Gantt) Whether to hide data labels that
  53245. * are outside the plot area. By default, the data label is moved inside the
  53246. * plot area according to the overflow option.
  53247. */
  53248. crop?: boolean;
  53249. /**
  53250. * (Highcharts, Highstock, Gantt) Whether to defer displaying the data
  53251. * labels until the initial series animation has finished. Setting to
  53252. * `false` renders the data label immediately. If set to `true` inherits the
  53253. * defer time set in plotOptions.series.animation.
  53254. */
  53255. defer?: boolean;
  53256. /**
  53257. * (Highcharts, Highstock, Highmaps, Gantt) Enable or disable the data
  53258. * labels.
  53259. */
  53260. enabled?: boolean;
  53261. /**
  53262. * (Highcharts, Highstock, Highmaps, Gantt) A declarative filter to control
  53263. * of which data labels to display. The declarative filter is designed for
  53264. * use when callback functions are not available, like when the chart
  53265. * options require a pure JSON structure or for use with graphical editors.
  53266. * For programmatic control, use the `formatter` instead, and return
  53267. * `undefined` to disable a single data label.
  53268. */
  53269. filter?: DataLabelsFilterOptionsObject;
  53270. /**
  53271. * (Highcharts, Highstock, Highmaps, Gantt) A format string for the data
  53272. * label. Available variables are the same as for `formatter`.
  53273. */
  53274. format?: string;
  53275. /**
  53276. * (Highcharts, Highstock, Highmaps, Gantt) Callback JavaScript function to
  53277. * format the data label. Note that if a `format` is defined, the format
  53278. * takes precedence and the formatter is ignored.
  53279. */
  53280. formatter?: DataLabelsFormatterCallbackFunction;
  53281. /**
  53282. * (Highcharts, Highstock, Highmaps, Gantt) For points with an extent, like
  53283. * columns or map areas, whether to align the data label inside the box or
  53284. * to the actual value point. Defaults to `false` in most cases, `true` in
  53285. * stacked columns.
  53286. */
  53287. inside?: boolean;
  53288. /**
  53289. * (Highcharts, Highstock, Highmaps, Gantt) Format for points with the value
  53290. * of null. Works analogously to format. `nullFormat` can be applied only to
  53291. * series which support displaying null points.
  53292. */
  53293. nullFormat?: (boolean|string);
  53294. /**
  53295. * (Highcharts, Highstock, Highmaps, Gantt) Callback JavaScript function
  53296. * that defines formatting for points with the value of null. Works
  53297. * analogously to formatter. `nullPointFormatter` can be applied only to
  53298. * series which support displaying null points.
  53299. */
  53300. nullFormatter?: DataLabelsFormatterCallbackFunction;
  53301. /**
  53302. * (Highcharts, Highstock, Highmaps, Gantt) How to handle data labels that
  53303. * flow outside the plot area. The default is `"justify"`, which aligns them
  53304. * inside the plot area. For columns and bars, this means it will be moved
  53305. * inside the bar. To display data labels outside the plot area, set `crop`
  53306. * to `false` and `overflow` to `"allow"`.
  53307. */
  53308. overflow?: DataLabelsOverflowValue;
  53309. /**
  53310. * (Highcharts, Highstock, Highmaps, Gantt) When either the `borderWidth` or
  53311. * the `backgroundColor` is set, this is the padding within the box.
  53312. */
  53313. padding?: number;
  53314. /**
  53315. * (Highcharts, Highstock, Highmaps, Gantt) Aligns data labels relative to
  53316. * points. If `center` alignment is not possible, it defaults to `right`.
  53317. */
  53318. position?: AlignValue;
  53319. /**
  53320. * (Highcharts, Highstock, Highmaps, Gantt) Text rotation in degrees. Note
  53321. * that due to a more complex structure, backgrounds, borders and padding
  53322. * will be lost on a rotated data label.
  53323. */
  53324. rotation?: number;
  53325. /**
  53326. * (Highcharts, Highstock, Highmaps, Gantt) The shadow of the box. Works
  53327. * best with `borderWidth` or `backgroundColor`. Since 2.3 the shadow can be
  53328. * an object configuration containing `color`, `offsetX`, `offsetY`,
  53329. * `opacity` and `width`.
  53330. */
  53331. shadow?: (boolean|ShadowOptionsObject);
  53332. /**
  53333. * (Highcharts, Highstock, Highmaps, Gantt) The name of a symbol to use for
  53334. * the border around the label. Symbols are predefined functions on the
  53335. * Renderer object.
  53336. */
  53337. shape?: string;
  53338. /**
  53339. * (Highcharts, Highstock, Highmaps, Gantt) Styles for the label. The
  53340. * default `color` setting is `"contrast"`, which is a pseudo color that
  53341. * Highcharts picks up and applies the maximum contrast to the underlying
  53342. * point item, for example the bar in a bar chart.
  53343. *
  53344. * The `textOutline` is a pseudo property that applies an outline of the
  53345. * given width with the given color, which by default is the maximum
  53346. * contrast to the text. So a bright text color will result in a black text
  53347. * outline for maximum readability on a mixed background. In some cases,
  53348. * especially with grayscale text, the text outline doesn't work well, in
  53349. * which cases it can be disabled by setting it to `"none"`. When `useHTML`
  53350. * is true, the `textOutline` will not be picked up. In this, case, the same
  53351. * effect can be acheived through the `text-shadow` CSS property.
  53352. *
  53353. * For some series types, where each point has an extent, like for example
  53354. * tree maps, the data label may overflow the point. There are two
  53355. * strategies for handling overflow. By default, the text will wrap to
  53356. * multiple lines. The other strategy is to set `style.textOverflow` to
  53357. * `ellipsis`, which will keep the text on one line plus it will break
  53358. * inside long words.
  53359. */
  53360. style?: CSSObject;
  53361. /**
  53362. * (Highcharts, Highstock, Highmaps, Gantt) Options for a label text which
  53363. * should follow marker's shape. Border and background are disabled for a
  53364. * label that follows a path.
  53365. *
  53366. * **Note:** Only SVG-based renderer supports this option. Setting `useHTML`
  53367. * to true will disable this option.
  53368. */
  53369. textPath?: DataLabelsTextPathOptionsObject;
  53370. /**
  53371. * (Highcharts, Highstock, Highmaps, Gantt) Whether to use HTML to render
  53372. * the labels.
  53373. */
  53374. useHTML?: boolean;
  53375. /**
  53376. * (Highcharts, Highstock, Highmaps, Gantt) The vertical alignment of a data
  53377. * label. Can be one of `top`, `middle` or `bottom`. The default value
  53378. * depends on the data, for instance in a column chart, the label is above
  53379. * positive values and below negative values.
  53380. */
  53381. verticalAlign?: (VerticalAlignValue|null);
  53382. /**
  53383. * (Highcharts, Highstock, Highmaps, Gantt) The x position offset of the
  53384. * label relative to the point in pixels.
  53385. */
  53386. x?: number;
  53387. /**
  53388. * (Highcharts, Highstock, Highmaps, Gantt) The y position offset of the
  53389. * label relative to the point in pixels.
  53390. */
  53391. y?: number;
  53392. /**
  53393. * (Highcharts, Highstock, Highmaps, Gantt) The Z index of the data labels.
  53394. * The default Z index puts it above the series. Use a Z index of 2 to
  53395. * display it behind the series.
  53396. */
  53397. z?: number;
  53398. }
  53399. /**
  53400. * (Highcharts, Highstock) Options for the series data sorting.
  53401. */
  53402. export interface PlotLineDataSortingOptions {
  53403. /**
  53404. * (Highcharts, Highstock) Enable or disable data sorting for the series.
  53405. * Use xAxis.reversed to change the sorting order.
  53406. */
  53407. enabled?: boolean;
  53408. /**
  53409. * (Highcharts, Highstock) Whether to allow matching points by name in an
  53410. * update. If this option is disabled, points will be matched by order.
  53411. */
  53412. matchByName?: boolean;
  53413. /**
  53414. * (Highcharts, Highstock) Determines what data value should be used to sort
  53415. * by.
  53416. */
  53417. sortKey?: string;
  53418. }
  53419. /**
  53420. * (Highcharts, Highstock) Style options for the guide box. The guide box has
  53421. * one state by default, the `default` state.
  53422. */
  53423. export interface PlotLineDragDropGuideBoxOptions {
  53424. /**
  53425. * (Highcharts, Highstock) Style options for the guide box default state.
  53426. */
  53427. default?: DragDropGuideBoxOptionsObject;
  53428. }
  53429. /**
  53430. * (Highcharts, Highstock) A line series displays information as a series of
  53431. * data points connected by straight line segments.
  53432. *
  53433. * In TypeScript the type option must always be set.
  53434. *
  53435. * Configuration options for the series are given in three levels:
  53436. *
  53437. * 1. Options for all series in a chart are defined in the plotOptions.series
  53438. * object.
  53439. *
  53440. * 2. Options for all `line` series are defined in plotOptions.line.
  53441. *
  53442. * 3. Options for one single series are given in the series instance array. (see
  53443. * online documentation for example)
  53444. */
  53445. export interface PlotLineOptions {
  53446. /**
  53447. * (Highcharts, Highstock) Accessibility options for a series.
  53448. */
  53449. accessibility?: SeriesAccessibilityOptionsObject;
  53450. /**
  53451. * (Highmaps) Whether all areas of the map defined in `mapData` should be
  53452. * rendered. If `true`, areas which don't correspond to a data point, are
  53453. * rendered as `null` points. If `false`, those areas are skipped.
  53454. */
  53455. allAreas?: boolean;
  53456. /**
  53457. * (Highcharts, Highstock) Allow this series' points to be selected by
  53458. * clicking on the graphic (columns, point markers, pie slices, map areas
  53459. * etc).
  53460. *
  53461. * The selected points can be handled by point select and unselect events,
  53462. * or collectively by the getSelectedPoints function.
  53463. *
  53464. * And alternative way of selecting points is through dragging.
  53465. */
  53466. allowPointSelect?: boolean;
  53467. /**
  53468. * (Highcharts, Highstock) Enable or disable the initial animation when a
  53469. * series is displayed. The animation can also be set as a configuration
  53470. * object. Please note that this option only applies to the initial
  53471. * animation of the series itself. For other animations, see chart.animation
  53472. * and the animation parameter under the API methods. The following
  53473. * properties are supported:
  53474. *
  53475. * - `defer`: The animation delay time in milliseconds.
  53476. *
  53477. * - `duration`: The duration of the animation in milliseconds.
  53478. *
  53479. * - `easing`: Can be a string reference to an easing function set on the
  53480. * `Math` object or a function. See the _Custom easing function_ demo below.
  53481. *
  53482. * Due to poor performance, animation is disabled in old IE browsers for
  53483. * several chart types.
  53484. */
  53485. animation?: (boolean|PlotLineAnimationOptions|Partial<AnimationOptionsObject>);
  53486. /**
  53487. * (Highcharts, Highstock) For some series, there is a limit that shuts down
  53488. * initial animation by default when the total number of points in the chart
  53489. * is too high. For example, for a column chart and its derivatives,
  53490. * animation does not run if there is more than 250 points totally. To
  53491. * disable this cap, set `animationLimit` to `Infinity`.
  53492. */
  53493. animationLimit?: number;
  53494. /**
  53495. * (Highcharts, Highstock) Sets the color blending in the boost module.
  53496. */
  53497. boostBlending?: OptionsBoostBlendingValue;
  53498. /**
  53499. * (Highcharts, Highstock) Set the point threshold for when a series should
  53500. * enter boost mode.
  53501. *
  53502. * Setting it to e.g. 2000 will cause the series to enter boost mode when
  53503. * there are 2000 or more points in the series.
  53504. *
  53505. * To disable boosting on the series, set the `boostThreshold` to 0. Setting
  53506. * it to 1 will force boosting.
  53507. *
  53508. * Note that the cropThreshold also affects this setting. When zooming in on
  53509. * a series that has fewer points than the `cropThreshold`, all points are
  53510. * rendered although outside the visible plot area, and the `boostThreshold`
  53511. * won't take effect.
  53512. */
  53513. boostThreshold?: number;
  53514. /**
  53515. * (Highmaps) The border color of the map areas.
  53516. *
  53517. * In styled mode, the border stroke is given in the `.highcharts-point`
  53518. * class.
  53519. */
  53520. borderColor?: (ColorString|GradientColorObject|PatternObject);
  53521. /**
  53522. * (Highmaps) The border width of each map area.
  53523. *
  53524. * In styled mode, the border stroke width is given in the
  53525. * `.highcharts-point` class.
  53526. */
  53527. borderWidth?: number;
  53528. /**
  53529. * (Highcharts, Highstock) An additional class name to apply to the series'
  53530. * graphical elements. This option does not replace default class names of
  53531. * the graphical element.
  53532. */
  53533. className?: string;
  53534. /**
  53535. * (Highcharts, Highstock) Disable this option to allow series rendering in
  53536. * the whole plotting area.
  53537. *
  53538. * **Note:** Clipping should be always enabled when chart.zoomType is set
  53539. */
  53540. clip?: boolean;
  53541. /**
  53542. * (Highcharts, Highstock) The main color of the series. In line type series
  53543. * it applies to the line and the point markers unless otherwise specified.
  53544. * In bar type series it applies to the bars unless a color is specified per
  53545. * point. The default value is pulled from the `options.colors` array.
  53546. *
  53547. * In styled mode, the color can be defined by the colorIndex option. Also,
  53548. * the series color can be set with the `.highcharts-series`,
  53549. * `.highcharts-color-{n}`, `.highcharts-{type}-series` or
  53550. * `.highcharts-series-{n}` class, or individual classes given by the
  53551. * `className` option.
  53552. */
  53553. color?: (ColorString|GradientColorObject|PatternObject);
  53554. /**
  53555. * (Highcharts, Highstock, Highmaps) When using dual or multiple color axes,
  53556. * this number defines which colorAxis the particular series is connected
  53557. * to. It refers to either the axis id or the index of the axis in the
  53558. * colorAxis array, with 0 being the first. Set this option to false to
  53559. * prevent a series from connecting to the default color axis.
  53560. *
  53561. * Since v7.2.0 the option can also be an axis id or an axis index instead
  53562. * of a boolean flag.
  53563. */
  53564. colorAxis?: (boolean|number|string);
  53565. /**
  53566. * (Highcharts, Highstock) Styled mode only. A specific color index to use
  53567. * for the series, so its graphic representations are given the class name
  53568. * `highcharts-color-{n}`.
  53569. */
  53570. colorIndex?: number;
  53571. /**
  53572. * (Highcharts, Highstock, Highmaps) Determines what data value should be
  53573. * used to calculate point color if `colorAxis` is used. Requires to set
  53574. * `min` and `max` if some custom point property is used or if approximation
  53575. * for data grouping is set to `'sum'`.
  53576. */
  53577. colorKey?: string;
  53578. /**
  53579. * (Highstock) Compare the values of the series against the first non-null,
  53580. * non- zero value in the visible range. The y axis will show percentage or
  53581. * absolute change depending on whether `compare` is set to `"percent"` or
  53582. * `"value"`. When this is applied to multiple series, it allows comparing
  53583. * the development of the series against each other. Adds a `change` field
  53584. * to every point object.
  53585. */
  53586. compare?: string;
  53587. /**
  53588. * (Highstock) When compare is `percent`, this option dictates whether to
  53589. * use 0 or 100 as the base of comparison.
  53590. */
  53591. compareBase?: (0|100);
  53592. /**
  53593. * (Highstock) Defines if comparison should start from the first point
  53594. * within the visible range or should start from the first point **before**
  53595. * the range.
  53596. *
  53597. * In other words, this flag determines if first point within the visible
  53598. * range will have 0% (`compareStart=true`) or should have been already
  53599. * calculated according to the previous point (`compareStart=false`).
  53600. */
  53601. compareStart?: boolean;
  53602. /**
  53603. * (Highcharts) Polar charts only. Whether to connect the ends of a line
  53604. * series plot across the extremes.
  53605. */
  53606. connectEnds?: boolean;
  53607. /**
  53608. * (Highcharts, Highstock) Whether to connect a graph line across null
  53609. * points, or render a gap between the two points on either side of the
  53610. * null.
  53611. */
  53612. connectNulls?: boolean;
  53613. /**
  53614. * (Gantt) Override Pathfinder connector options for a series. Requires
  53615. * Highcharts Gantt to be loaded.
  53616. */
  53617. connectors?: SeriesConnectorsOptionsObject;
  53618. /**
  53619. * (Highcharts, Highstock, Gantt) When true, each point or column edge is
  53620. * rounded to its nearest pixel in order to render sharp on screen. In some
  53621. * cases, when there are a lot of densely packed columns, this leads to
  53622. * visible difference in column widths or distance between columns. In these
  53623. * cases, setting `crisp` to `false` may look better, even though each
  53624. * column is rendered blurry.
  53625. */
  53626. crisp?: boolean;
  53627. /**
  53628. * (Highcharts, Highstock) When the series contains less points than the
  53629. * crop threshold, all points are drawn, even if the points fall outside the
  53630. * visible plot area at the current zoom. The advantage of drawing all
  53631. * points (including markers and columns), is that animation is performed on
  53632. * updates. On the other hand, when the series contains more points than the
  53633. * crop threshold, the series data is cropped to only contain points that
  53634. * fall within the plot area. The advantage of cropping away invisible
  53635. * points is to increase performance on large series.
  53636. */
  53637. cropThreshold?: number;
  53638. /**
  53639. * (Highcharts, Highstock) You can set the cursor to "pointer" if you have
  53640. * click events attached to the series, to signal to the user that the
  53641. * points and lines can be clicked.
  53642. *
  53643. * In styled mode, the series cursor can be set with the same classes as
  53644. * listed under series.color.
  53645. */
  53646. cursor?: (string|CursorValue);
  53647. /**
  53648. * (Highcharts, Highstock) A reserved subspace to store options and values
  53649. * for customized functionality. Here you can add additional data for your
  53650. * own event callbacks and formatter callbacks.
  53651. */
  53652. custom?: Dictionary<any>;
  53653. /**
  53654. * (Highcharts, Highstock) Name of the dash style to use for the graph, or
  53655. * for some series types the outline of each shape.
  53656. *
  53657. * In styled mode, the stroke dash-array can be set with the same classes as
  53658. * listed under series.color.
  53659. */
  53660. dashStyle?: DashStyleValue;
  53661. /**
  53662. * (Highstock) Data grouping is the concept of sampling the data values into
  53663. * larger blocks in order to ease readability and increase performance of
  53664. * the JavaScript charts. Highstock by default applies data grouping when
  53665. * the points become closer than a certain pixel value, determined by the
  53666. * `groupPixelWidth` option.
  53667. *
  53668. * If data grouping is applied, the grouping information of grouped points
  53669. * can be read from the Point.dataGroup. If point options other than the
  53670. * data itself are set, for example `name` or `color` or custom properties,
  53671. * the grouping logic doesn't know how to group it. In this case the options
  53672. * of the first point instance are copied over to the group point. This can
  53673. * be altered through a custom `approximation` callback function.
  53674. */
  53675. dataGrouping?: DataGroupingOptionsObject;
  53676. /**
  53677. * (Highcharts, Highstock, Highmaps, Gantt) Options for the series data
  53678. * labels, appearing next to each data point.
  53679. *
  53680. * Since v6.2.0, multiple data labels can be applied to each single point by
  53681. * defining them as an array of configs.
  53682. *
  53683. * In styled mode, the data labels can be styled with the
  53684. * `.highcharts-data-label-box` and `.highcharts-data-label` class names
  53685. * (see example).
  53686. */
  53687. dataLabels?: (PlotLineDataLabelsOptions|Array<PlotLineDataLabelsOptions>);
  53688. /**
  53689. * (Highcharts, Highstock) Options for the series data sorting.
  53690. */
  53691. dataSorting?: (DataSortingOptionsObject|PlotLineDataSortingOptions);
  53692. /**
  53693. * (Highcharts, Highstock) A description of the series to add to the screen
  53694. * reader information about the series.
  53695. */
  53696. description?: string;
  53697. /**
  53698. * (Highcharts, Highstock) The draggable-points module allows points to be
  53699. * moved around or modified in the chart. In addition to the options
  53700. * mentioned under the `dragDrop` API structure, the module fires three
  53701. * events, point.dragStart, point.drag and point.drop.
  53702. */
  53703. dragDrop?: SeriesDragDropOptionsObject;
  53704. /**
  53705. * (Highcharts, Highstock) Enable or disable the mouse tracking for a
  53706. * specific series. This includes point tooltips and click events on graphs
  53707. * and points. For large datasets it improves performance.
  53708. */
  53709. enableMouseTracking?: boolean;
  53710. /**
  53711. * (Highcharts, Highstock) General event handlers for the series items.
  53712. * These event hooks can also be attached to the series at run time using
  53713. * the `Highcharts.addEvent` function.
  53714. */
  53715. events?: SeriesEventsOptionsObject;
  53716. /**
  53717. * (Highcharts, Highstock) Determines whether the series should look for the
  53718. * nearest point in both dimensions or just the x-dimension when hovering
  53719. * the series. Defaults to `'xy'` for scatter series and `'x'` for most
  53720. * other series. If the data has duplicate x-values, it is recommended to
  53721. * set this to `'xy'` to allow hovering over all points.
  53722. *
  53723. * Applies only to series types using nearest neighbor search (not direct
  53724. * hover) for tooltip.
  53725. */
  53726. findNearestPointBy?: OptionsFindNearestPointByValue;
  53727. /**
  53728. * (Highstock) Defines when to display a gap in the graph, together with the
  53729. * gapUnit option.
  53730. *
  53731. * In case when `dataGrouping` is enabled, points can be grouped into a
  53732. * larger time span. This can make the grouped points to have a greater
  53733. * distance than the absolute value of `gapSize` property, which will result
  53734. * in disappearing graph completely. To prevent this situation the mentioned
  53735. * distance between grouped points is used instead of previously defined
  53736. * `gapSize`.
  53737. *
  53738. * In practice, this option is most often used to visualize gaps in time
  53739. * series. In a stock chart, intraday data is available for daytime hours,
  53740. * while gaps will appear in nights and weekends.
  53741. */
  53742. gapSize?: number;
  53743. /**
  53744. * (Highstock) Together with gapSize, this option defines where to draw gaps
  53745. * in the graph.
  53746. *
  53747. * When the `gapUnit` is `"relative"` (default), a gap size of 5 means that
  53748. * if the distance between two points is greater than 5 times that of the
  53749. * two closest points, the graph will be broken.
  53750. *
  53751. * When the `gapUnit` is `"value"`, the gap is based on absolute axis
  53752. * values, which on a datetime axis is milliseconds. This also applies to
  53753. * the navigator series that inherits gap options from the base series.
  53754. */
  53755. gapUnit?: OptionsGapUnitValue;
  53756. /**
  53757. * (Highcharts, Highstock, Gantt) Whether to use the Y extremes of the total
  53758. * chart width or only the zoomed area when zooming in on parts of the X
  53759. * axis. By default, the Y axis adjusts to the min and max of the visible
  53760. * data. Cartesian series only.
  53761. */
  53762. getExtremesFromAll?: boolean;
  53763. /**
  53764. * (Highcharts, Highstock) When set to `false` will prevent the series data
  53765. * from being included in any form of data export.
  53766. *
  53767. * Since version 6.0.0 until 7.1.0 the option was existing undocumented as
  53768. * `includeInCSVExport`.
  53769. */
  53770. includeInDataExport?: boolean;
  53771. /**
  53772. * (Highmaps) What property to join the `mapData` to the value data. For
  53773. * example, if joinBy is "code", the mapData items with a specific code is
  53774. * merged into the data with the same code. For maps loaded from GeoJSON,
  53775. * the keys may be held in each point's `properties` object.
  53776. *
  53777. * The joinBy option can also be an array of two values, where the first
  53778. * points to a key in the `mapData`, and the second points to another key in
  53779. * the `data`.
  53780. *
  53781. * When joinBy is `null`, the map items are joined by their position in the
  53782. * array, which performs much better in maps with many data points. This is
  53783. * the recommended option if you are printing more than a thousand data
  53784. * points and have a backend that can preprocess the data into a parallel
  53785. * array of the mapData.
  53786. */
  53787. joinBy?: (string|Array<string>);
  53788. /**
  53789. * (Highcharts, Highstock) An array specifying which option maps to which
  53790. * key in the data point array. This makes it convenient to work with
  53791. * unstructured data arrays from different sources.
  53792. */
  53793. keys?: Array<string>;
  53794. /**
  53795. * (Highcharts, Highstock, Gantt) Series labels are placed as close to the
  53796. * series as possible in a natural way, seeking to avoid other series. The
  53797. * goal of this feature is to make the chart more easily readable, like if a
  53798. * human designer placed the labels in the optimal position.
  53799. *
  53800. * The series labels currently work with series types having a `graph` or an
  53801. * `area`.
  53802. */
  53803. label?: SeriesLabelOptionsObject;
  53804. /**
  53805. * (Highstock) The line marks the last price from all points.
  53806. */
  53807. lastPrice?: SeriesLastPriceOptionsObject;
  53808. /**
  53809. * (Highstock) The line marks the last price from visible range of points.
  53810. */
  53811. lastVisiblePrice?: SeriesLastVisiblePriceOptionsObject;
  53812. /**
  53813. * (Highcharts, Highstock) The SVG value used for the `stroke-linecap` and
  53814. * `stroke-linejoin` of a line graph. Round means that lines are rounded in
  53815. * the ends and bends.
  53816. */
  53817. linecap?: SeriesLinecapValue;
  53818. /**
  53819. * (Highcharts, Highstock) Pixel width of the graph line.
  53820. */
  53821. lineWidth?: number;
  53822. /**
  53823. * (Highcharts, Highstock, Gantt) The id of another series to link to.
  53824. * Additionally, the value can be ":previous" to link to the previous
  53825. * series. When two series are linked, only the first one appears in the
  53826. * legend. Toggling the visibility of this also toggles the linked series.
  53827. *
  53828. * If master series uses data sorting and linked series does not have its
  53829. * own sorting definition, the linked series will be sorted in the same
  53830. * order as the master one.
  53831. */
  53832. linkedTo?: string;
  53833. /**
  53834. * (Highcharts, Highstock) Options for the point markers of line-like
  53835. * series. Properties like `fillColor`, `lineColor` and `lineWidth` define
  53836. * the visual appearance of the markers. Other series types, like column
  53837. * series, don't have markers, but have visual options on the series level
  53838. * instead.
  53839. *
  53840. * In styled mode, the markers can be styled with the `.highcharts-point`,
  53841. * `.highcharts-point-hover` and `.highcharts-point-select` class names.
  53842. */
  53843. marker?: PointMarkerOptionsObject;
  53844. /**
  53845. * (Highstock) Options for the corresponding navigator series if
  53846. * `showInNavigator` is `true` for this series. Available options are the
  53847. * same as any series, documented at plotOptions and series.
  53848. *
  53849. * These options are merged with options in navigator.series, and will take
  53850. * precedence if the same option is defined both places.
  53851. */
  53852. navigatorOptions?: PlotSeriesOptions;
  53853. /**
  53854. * (Highcharts, Highstock) The color for the parts of the graph or points
  53855. * that are below the threshold. Note that `zones` takes precedence over the
  53856. * negative color. Using `negativeColor` is equivalent to applying a zone
  53857. * with value of 0.
  53858. */
  53859. negativeColor?: (ColorString|GradientColorObject|PatternObject);
  53860. /**
  53861. * (Highcharts, Highstock) Opacity of a series parts: line, fill (e.g. area)
  53862. * and dataLabels.
  53863. */
  53864. opacity?: number;
  53865. /**
  53866. * (Highcharts, Highstock) Properties for each single point.
  53867. */
  53868. point?: PlotSeriesPointOptions;
  53869. /**
  53870. * (Highcharts, Highstock) Same as accessibility.pointDescriptionFormatter,
  53871. * but for an individual series. Overrides the chart wide configuration.
  53872. */
  53873. pointDescriptionFormatter?: Function;
  53874. /**
  53875. * (Highcharts, Highstock, Gantt) If no x values are given for the points in
  53876. * a series, `pointInterval` defines the interval of the x values. For
  53877. * example, if a series contains one value every decade starting from year
  53878. * 0, set `pointInterval` to `10`. In true `datetime` axes, the
  53879. * `pointInterval` is set in milliseconds.
  53880. *
  53881. * It can be also be combined with `pointIntervalUnit` to draw irregular
  53882. * time intervals.
  53883. *
  53884. * Please note that this options applies to the _series data_, not the
  53885. * interval of the axis ticks, which is independent.
  53886. */
  53887. pointInterval?: number;
  53888. /**
  53889. * (Highcharts, Highstock, Gantt) On datetime series, this allows for
  53890. * setting the pointInterval to irregular time units, `day`, `month` and
  53891. * `year`. A day is usually the same as 24 hours, but `pointIntervalUnit`
  53892. * also takes the DST crossover into consideration when dealing with local
  53893. * time. Combine this option with `pointInterval` to draw weeks, quarters, 6
  53894. * months, 10 years etc.
  53895. *
  53896. * Please note that this options applies to the _series data_, not the
  53897. * interval of the axis ticks, which is independent.
  53898. */
  53899. pointIntervalUnit?: OptionsPointIntervalUnitValue;
  53900. /**
  53901. * (Highcharts, Highstock, Gantt) Possible values: `"on"`, `"between"`,
  53902. * `number`.
  53903. *
  53904. * In a column chart, when pointPlacement is `"on"`, the point will not
  53905. * create any padding of the X axis. In a polar column chart this means that
  53906. * the first column points directly north. If the pointPlacement is
  53907. * `"between"`, the columns will be laid out between ticks. This is useful
  53908. * for example for visualising an amount between two points in time or in a
  53909. * certain sector of a polar chart.
  53910. *
  53911. * Since Highcharts 3.0.2, the point placement can also be numeric, where 0
  53912. * is on the axis value, -0.5 is between this value and the previous, and
  53913. * 0.5 is between this value and the next. Unlike the textual options,
  53914. * numeric point placement options won't affect axis padding.
  53915. *
  53916. * Note that pointPlacement needs a pointRange to work. For column series
  53917. * this is computed, but for line-type series it needs to be set.
  53918. *
  53919. * For the `xrange` series type and gantt charts, if the Y axis is a
  53920. * category axis, the `pointPlacement` applies to the Y axis rather than the
  53921. * (typically datetime) X axis.
  53922. *
  53923. * Defaults to `undefined` in cartesian charts, `"between"` in polar charts.
  53924. */
  53925. pointPlacement?: (number|string);
  53926. /**
  53927. * (Highstock) The width of each point on the x axis. For example in a
  53928. * column chart with one value each day, the pointRange would be 1 day (= 24
  53929. * * 3600
  53930. *
  53931. * * 1000 milliseconds). This is normally computed automatically, but this
  53932. * option can be used to override the automatic value.
  53933. */
  53934. pointRange?: number;
  53935. /**
  53936. * (Highcharts, Highstock, Gantt) If no x values are given for the points in
  53937. * a series, pointStart defines on what value to start. For example, if a
  53938. * series contains one yearly value starting from 1945, set pointStart to
  53939. * 1945.
  53940. */
  53941. pointStart?: number;
  53942. /**
  53943. * (Highcharts, Highstock) Whether to select the series initially. If
  53944. * `showCheckbox` is true, the checkbox next to the series name in the
  53945. * legend will be checked for a selected series.
  53946. */
  53947. selected?: boolean;
  53948. /**
  53949. * (Highcharts, Highstock) Whether to apply a drop shadow to the graph line.
  53950. * Since 2.3 the shadow can be an object configuration containing `color`,
  53951. * `offsetX`, `offsetY`, `opacity` and `width`.
  53952. */
  53953. shadow?: (boolean|ShadowOptionsObject);
  53954. /**
  53955. * (Highcharts, Highstock) If true, a checkbox is displayed next to the
  53956. * legend item to allow selecting the series. The state of the checkbox is
  53957. * determined by the `selected` option.
  53958. */
  53959. showCheckbox?: boolean;
  53960. /**
  53961. * (Highcharts, Highstock) Whether to display this particular series or
  53962. * series type in the legend. Standalone series are shown in legend by
  53963. * default, and linked series are not. Since v7.2.0 it is possible to show
  53964. * series that use colorAxis by setting this option to `true`.
  53965. */
  53966. showInLegend?: boolean;
  53967. /**
  53968. * (Highstock) Whether or not to show the series in the navigator. Takes
  53969. * precedence over navigator.baseSeries if defined.
  53970. */
  53971. showInNavigator?: boolean;
  53972. /**
  53973. * (Highcharts, Highstock) If set to `true`, the accessibility module will
  53974. * skip past the points in this series for keyboard navigation.
  53975. */
  53976. skipKeyboardNavigation?: boolean;
  53977. /**
  53978. * (Highcharts, Highstock) When this is true, the series will not cause the
  53979. * Y axis to cross the zero plane (or threshold option) unless the data
  53980. * actually crosses the plane.
  53981. *
  53982. * For example, if `softThreshold` is `false`, a series of 0, 1, 2, 3 will
  53983. * make the Y axis show negative values according to the `minPadding`
  53984. * option. If `softThreshold` is `true`, the Y axis starts at 0.
  53985. */
  53986. softThreshold?: boolean;
  53987. /**
  53988. * (Highcharts, Highstock) Whether to stack the values of each series on top
  53989. * of each other. Possible values are `undefined` to disable, `"normal"` to
  53990. * stack by value or `"percent"`.
  53991. *
  53992. * When stacking is enabled, data must be sorted in ascending X order.
  53993. *
  53994. * Some stacking options are related to specific series types. In the
  53995. * streamgraph series type, the stacking option is set to `"stream"`. The
  53996. * second one is `"overlap"`, which only applies to waterfall series.
  53997. */
  53998. stacking?: OptionsStackingValue;
  53999. states?: SeriesStatesOptionsObject;
  54000. /**
  54001. * (Highcharts, Highstock) Whether to apply steps to the line. Possible
  54002. * values are `left`, `center` and `right`.
  54003. */
  54004. step?: OptionsStepValue;
  54005. /**
  54006. * (Highcharts, Highstock) Sticky tracking of mouse events. When true, the
  54007. * `mouseOut` event on a series isn't triggered until the mouse moves over
  54008. * another series, or out of the plot area. When false, the `mouseOut` event
  54009. * on a series is triggered when the mouse leaves the area around the
  54010. * series' graph or markers. This also implies the tooltip when not shared.
  54011. * When `stickyTracking` is false and `tooltip.shared` is false, the tooltip
  54012. * will be hidden when moving the mouse between series. Defaults to true for
  54013. * line and area type series, but to false for columns, pies etc.
  54014. *
  54015. * **Note:** The boost module will force this option because of technical
  54016. * limitations.
  54017. */
  54018. stickyTracking?: boolean;
  54019. /**
  54020. * (Highcharts, Highstock) The threshold, also called zero level or base
  54021. * level. For line type series this is only used in conjunction with
  54022. * negativeColor.
  54023. */
  54024. threshold?: (number|null);
  54025. /**
  54026. * (Highcharts, Highstock) A configuration object for the tooltip rendering
  54027. * of each single series. Properties are inherited from tooltip, but only
  54028. * the following properties can be defined on a series level.
  54029. */
  54030. tooltip?: SeriesTooltipOptionsObject;
  54031. /**
  54032. * (Highcharts, Highstock, Gantt) When a series contains a data array that
  54033. * is longer than this, only one dimensional arrays of numbers, or two
  54034. * dimensional arrays with x and y values are allowed. Also, only the first
  54035. * point is tested, and the rest are assumed to be the same format. This
  54036. * saves expensive data checking and indexing in long series. Set it to `0`
  54037. * disable.
  54038. *
  54039. * Note: In boost mode turbo threshold is forced. Only array of numbers or
  54040. * two dimensional arrays are allowed.
  54041. */
  54042. turboThreshold?: number;
  54043. /**
  54044. * (Highstock) The parameter allows setting line series type and use OHLC
  54045. * indicators. Data in OHLC format is required.
  54046. */
  54047. useOhlcData?: boolean;
  54048. /**
  54049. * (Highcharts, Highstock) Set the initial visibility of the series.
  54050. */
  54051. visible?: boolean;
  54052. /**
  54053. * (Highmaps) Define the z index of the series.
  54054. */
  54055. zIndex?: number;
  54056. /**
  54057. * (Highcharts, Highstock) Defines the Axis on which the zones are applied.
  54058. */
  54059. zoneAxis?: string;
  54060. /**
  54061. * (Highcharts, Highstock) An array defining zones within a series. Zones
  54062. * can be applied to the X axis, Y axis or Z axis for bubbles, according to
  54063. * the `zoneAxis` option. The zone definitions have to be in ascending order
  54064. * regarding to the value.
  54065. *
  54066. * In styled mode, the color zones are styled with the
  54067. * `.highcharts-zone-{n}` class, or custom classed from the `className`
  54068. * option (view live demo).
  54069. */
  54070. zones?: Array<SeriesZonesOptionsObject>;
  54071. }
  54072. /**
  54073. * (Highcharts, Highstock) Enable or disable the initial animation when a series
  54074. * is displayed. The animation can also be set as a configuration object. Please
  54075. * note that this option only applies to the initial animation of the series
  54076. * itself. For other animations, see chart.animation and the animation parameter
  54077. * under the API methods. The following properties are supported:
  54078. *
  54079. * - `defer`: The animation delay time in milliseconds.
  54080. *
  54081. * - `duration`: The duration of the animation in milliseconds.
  54082. *
  54083. * - `easing`: Can be a string reference to an easing function set on the `Math`
  54084. * object or a function. See the _Custom easing function_ demo below.
  54085. *
  54086. * Due to poor performance, animation is disabled in old IE browsers for several
  54087. * chart types.
  54088. */
  54089. export interface PlotLollipopAnimationOptions {
  54090. defer?: number;
  54091. }
  54092. /**
  54093. * (Highcharts, Highstock) Enable or disable the initial animation when a series
  54094. * is displayed for the `dataLabels`. The animation can also be set as a
  54095. * configuration object. Please note that this option only applies to the
  54096. * initial animation. For other animations, see chart.animation and the
  54097. * animation parameter under the API methods. The following properties are
  54098. * supported:
  54099. *
  54100. * - `defer`: The animation delay time in milliseconds.
  54101. */
  54102. export interface PlotLollipopDataLabelsAnimationOptions {
  54103. /**
  54104. * (Highcharts, Highstock) The animation delay time in milliseconds. Set to
  54105. * `0` renders dataLabel immediately. As `undefined` inherits defer time
  54106. * from the series.animation.defer.
  54107. */
  54108. defer?: number;
  54109. }
  54110. /**
  54111. * (Highcharts, Highstock) Options for the series data sorting.
  54112. */
  54113. export interface PlotLollipopDataSortingOptions {
  54114. /**
  54115. * (Highcharts, Highstock) Enable or disable data sorting for the series.
  54116. * Use xAxis.reversed to change the sorting order.
  54117. */
  54118. enabled?: boolean;
  54119. /**
  54120. * (Highcharts, Highstock) Whether to allow matching points by name in an
  54121. * update. If this option is disabled, points will be matched by order.
  54122. */
  54123. matchByName?: boolean;
  54124. /**
  54125. * (Highcharts, Highstock) Determines what data value should be used to sort
  54126. * by.
  54127. */
  54128. sortKey?: string;
  54129. }
  54130. /**
  54131. * (Highcharts, Highstock) Style options for the guide box. The guide box has
  54132. * one state by default, the `default` state.
  54133. */
  54134. export interface PlotLollipopDragDropGuideBoxOptions {
  54135. /**
  54136. * (Highcharts, Highstock) Style options for the guide box default state.
  54137. */
  54138. default?: DragDropGuideBoxOptionsObject;
  54139. }
  54140. /**
  54141. * (Highcharts, Highstock) The lollipop series is a carteseian series with a
  54142. * line anchored from the x axis and a dot at the end to mark the value.
  54143. * Requires `highcharts-more.js`, `modules/dumbbell.js` and
  54144. * `modules/lollipop.js`.
  54145. *
  54146. * In TypeScript the type option must always be set.
  54147. *
  54148. * Configuration options for the series are given in three levels:
  54149. *
  54150. * 1. Options for all series in a chart are defined in the plotOptions.series
  54151. * object.
  54152. *
  54153. * 2. Options for all `lollipop` series are defined in plotOptions.lollipop.
  54154. *
  54155. * 3. Options for one single series are given in the series instance array. (see
  54156. * online documentation for example)
  54157. */
  54158. export interface PlotLollipopOptions {
  54159. /**
  54160. * (Highcharts, Highstock) Accessibility options for a series.
  54161. */
  54162. accessibility?: SeriesAccessibilityOptionsObject;
  54163. /**
  54164. * (Highmaps) Whether all areas of the map defined in `mapData` should be
  54165. * rendered. If `true`, areas which don't correspond to a data point, are
  54166. * rendered as `null` points. If `false`, those areas are skipped.
  54167. */
  54168. allAreas?: boolean;
  54169. /**
  54170. * (Highcharts, Highstock) Allow this series' points to be selected by
  54171. * clicking on the graphic (columns, point markers, pie slices, map areas
  54172. * etc).
  54173. *
  54174. * The selected points can be handled by point select and unselect events,
  54175. * or collectively by the getSelectedPoints function.
  54176. *
  54177. * And alternative way of selecting points is through dragging.
  54178. */
  54179. allowPointSelect?: boolean;
  54180. /**
  54181. * (Highcharts, Highstock) Enable or disable the initial animation when a
  54182. * series is displayed. The animation can also be set as a configuration
  54183. * object. Please note that this option only applies to the initial
  54184. * animation of the series itself. For other animations, see chart.animation
  54185. * and the animation parameter under the API methods. The following
  54186. * properties are supported:
  54187. *
  54188. * - `defer`: The animation delay time in milliseconds.
  54189. *
  54190. * - `duration`: The duration of the animation in milliseconds.
  54191. *
  54192. * - `easing`: Can be a string reference to an easing function set on the
  54193. * `Math` object or a function. See the _Custom easing function_ demo below.
  54194. *
  54195. * Due to poor performance, animation is disabled in old IE browsers for
  54196. * several chart types.
  54197. */
  54198. animation?: (boolean|PlotLollipopAnimationOptions|Partial<AnimationOptionsObject>);
  54199. /**
  54200. * (Highcharts, Highstock) For some series, there is a limit that shuts down
  54201. * initial animation by default when the total number of points in the chart
  54202. * is too high. For example, for a column chart and its derivatives,
  54203. * animation does not run if there is more than 250 points totally. To
  54204. * disable this cap, set `animationLimit` to `Infinity`.
  54205. */
  54206. animationLimit?: number;
  54207. /**
  54208. * (Highmaps) The border color of the map areas.
  54209. *
  54210. * In styled mode, the border stroke is given in the `.highcharts-point`
  54211. * class.
  54212. */
  54213. borderColor?: (ColorString|GradientColorObject|PatternObject);
  54214. /**
  54215. * (Highmaps) The border width of each map area.
  54216. *
  54217. * In styled mode, the border stroke width is given in the
  54218. * `.highcharts-point` class.
  54219. */
  54220. borderWidth?: number;
  54221. /**
  54222. * (Highcharts, Highstock) An additional class name to apply to the series'
  54223. * graphical elements. This option does not replace default class names of
  54224. * the graphical element.
  54225. */
  54226. className?: string;
  54227. /**
  54228. * (Highcharts, Highstock) Disable this option to allow series rendering in
  54229. * the whole plotting area.
  54230. *
  54231. * **Note:** Clipping should be always enabled when chart.zoomType is set
  54232. */
  54233. clip?: boolean;
  54234. /**
  54235. * (Highcharts, Highstock) The main color of the series. In line type series
  54236. * it applies to the line and the point markers unless otherwise specified.
  54237. * In bar type series it applies to the bars unless a color is specified per
  54238. * point. The default value is pulled from the `options.colors` array.
  54239. *
  54240. * In styled mode, the color can be defined by the colorIndex option. Also,
  54241. * the series color can be set with the `.highcharts-series`,
  54242. * `.highcharts-color-{n}`, `.highcharts-{type}-series` or
  54243. * `.highcharts-series-{n}` class, or individual classes given by the
  54244. * `className` option.
  54245. */
  54246. color?: (ColorString|GradientColorObject|PatternObject);
  54247. /**
  54248. * (Highcharts, Highstock, Highmaps) When using dual or multiple color axes,
  54249. * this number defines which colorAxis the particular series is connected
  54250. * to. It refers to either the axis id or the index of the axis in the
  54251. * colorAxis array, with 0 being the first. Set this option to false to
  54252. * prevent a series from connecting to the default color axis.
  54253. *
  54254. * Since v7.2.0 the option can also be an axis id or an axis index instead
  54255. * of a boolean flag.
  54256. */
  54257. colorAxis?: (boolean|number|string);
  54258. /**
  54259. * (Highcharts, Highstock) Styled mode only. A specific color index to use
  54260. * for the series, so its graphic representations are given the class name
  54261. * `highcharts-color-{n}`.
  54262. */
  54263. colorIndex?: number;
  54264. /**
  54265. * (Highcharts, Highstock, Highmaps) Determines what data value should be
  54266. * used to calculate point color if `colorAxis` is used. Requires to set
  54267. * `min` and `max` if some custom point property is used or if approximation
  54268. * for data grouping is set to `'sum'`.
  54269. */
  54270. colorKey?: string;
  54271. /**
  54272. * (Highstock) Compare the values of the series against the first non-null,
  54273. * non- zero value in the visible range. The y axis will show percentage or
  54274. * absolute change depending on whether `compare` is set to `"percent"` or
  54275. * `"value"`. When this is applied to multiple series, it allows comparing
  54276. * the development of the series against each other. Adds a `change` field
  54277. * to every point object.
  54278. */
  54279. compare?: string;
  54280. /**
  54281. * (Highstock) When compare is `percent`, this option dictates whether to
  54282. * use 0 or 100 as the base of comparison.
  54283. */
  54284. compareBase?: (0|100);
  54285. /**
  54286. * (Highstock) Defines if comparison should start from the first point
  54287. * within the visible range or should start from the first point **before**
  54288. * the range.
  54289. *
  54290. * In other words, this flag determines if first point within the visible
  54291. * range will have 0% (`compareStart=true`) or should have been already
  54292. * calculated according to the previous point (`compareStart=false`).
  54293. */
  54294. compareStart?: boolean;
  54295. /**
  54296. * (Highcharts) Polar charts only. Whether to connect the ends of a line
  54297. * series plot across the extremes.
  54298. */
  54299. connectEnds?: boolean;
  54300. /**
  54301. * (Highcharts, Highstock) Whether to connect a graph line across null
  54302. * points, or render a gap between the two points on either side of the
  54303. * null.
  54304. */
  54305. connectNulls?: boolean;
  54306. /**
  54307. * (Highcharts, Highstock) Color of the line that connects the dumbbell
  54308. * point's values. By default it is the series' color.
  54309. */
  54310. connectorColor?: string;
  54311. /**
  54312. * (Gantt) Override Pathfinder connector options for a series. Requires
  54313. * Highcharts Gantt to be loaded.
  54314. */
  54315. connectors?: SeriesConnectorsOptionsObject;
  54316. /**
  54317. * (Highcharts, Highstock) Pixel width of the line that connects the
  54318. * dumbbell point's values.
  54319. */
  54320. connectorWidth?: number;
  54321. /**
  54322. * (Highcharts, Highstock, Gantt) When true, each point or column edge is
  54323. * rounded to its nearest pixel in order to render sharp on screen. In some
  54324. * cases, when there are a lot of densely packed columns, this leads to
  54325. * visible difference in column widths or distance between columns. In these
  54326. * cases, setting `crisp` to `false` may look better, even though each
  54327. * column is rendered blurry.
  54328. */
  54329. crisp?: boolean;
  54330. /**
  54331. * (Highcharts, Highstock) When the series contains less points than the
  54332. * crop threshold, all points are drawn, even if the points fall outside the
  54333. * visible plot area at the current zoom. The advantage of drawing all
  54334. * points (including markers and columns), is that animation is performed on
  54335. * updates. On the other hand, when the series contains more points than the
  54336. * crop threshold, the series data is cropped to only contain points that
  54337. * fall within the plot area. The advantage of cropping away invisible
  54338. * points is to increase performance on large series.
  54339. */
  54340. cropThreshold?: number;
  54341. /**
  54342. * (Highcharts, Highstock) You can set the cursor to "pointer" if you have
  54343. * click events attached to the series, to signal to the user that the
  54344. * points and lines can be clicked.
  54345. *
  54346. * In styled mode, the series cursor can be set with the same classes as
  54347. * listed under series.color.
  54348. */
  54349. cursor?: (string|CursorValue);
  54350. /**
  54351. * (Highcharts, Highstock) A reserved subspace to store options and values
  54352. * for customized functionality. Here you can add additional data for your
  54353. * own event callbacks and formatter callbacks.
  54354. */
  54355. custom?: Dictionary<any>;
  54356. /**
  54357. * (Highcharts, Highstock) Name of the dash style to use for the graph, or
  54358. * for some series types the outline of each shape.
  54359. *
  54360. * In styled mode, the stroke dash-array can be set with the same classes as
  54361. * listed under series.color.
  54362. */
  54363. dashStyle?: DashStyleValue;
  54364. /**
  54365. * (Highstock) Data grouping is the concept of sampling the data values into
  54366. * larger blocks in order to ease readability and increase performance of
  54367. * the JavaScript charts. Highstock by default applies data grouping when
  54368. * the points become closer than a certain pixel value, determined by the
  54369. * `groupPixelWidth` option.
  54370. *
  54371. * If data grouping is applied, the grouping information of grouped points
  54372. * can be read from the Point.dataGroup. If point options other than the
  54373. * data itself are set, for example `name` or `color` or custom properties,
  54374. * the grouping logic doesn't know how to group it. In this case the options
  54375. * of the first point instance are copied over to the group point. This can
  54376. * be altered through a custom `approximation` callback function.
  54377. */
  54378. dataGrouping?: DataGroupingOptionsObject;
  54379. /**
  54380. * (Highcharts, Highstock) Extended data labels for range series types.
  54381. * Range series data labels use no `x` and `y` options. Instead, they have
  54382. * `xLow`, `xHigh`, `yLow` and `yHigh` options to allow the higher and lower
  54383. * data label sets individually.
  54384. */
  54385. dataLabels?: (SeriesAreaRangeDataLabelsOptionsObject|Array<SeriesAreaRangeDataLabelsOptionsObject>);
  54386. /**
  54387. * (Highcharts, Highstock) Options for the series data sorting.
  54388. */
  54389. dataSorting?: (DataSortingOptionsObject|PlotLollipopDataSortingOptions);
  54390. /**
  54391. * (Highcharts, Highstock) A description of the series to add to the screen
  54392. * reader information about the series.
  54393. */
  54394. description?: string;
  54395. /**
  54396. * (Highcharts, Highstock) The draggable-points module allows points to be
  54397. * moved around or modified in the chart. In addition to the options
  54398. * mentioned under the `dragDrop` API structure, the module fires three
  54399. * events, point.dragStart, point.drag and point.drop.
  54400. */
  54401. dragDrop?: SeriesDragDropOptionsObject;
  54402. /**
  54403. * (Highcharts, Highstock) Enable or disable the mouse tracking for a
  54404. * specific series. This includes point tooltips and click events on graphs
  54405. * and points. For large datasets it improves performance.
  54406. */
  54407. enableMouseTracking?: boolean;
  54408. /**
  54409. * (Highcharts, Highstock) General event handlers for the series items.
  54410. * These event hooks can also be attached to the series at run time using
  54411. * the `Highcharts.addEvent` function.
  54412. */
  54413. events?: SeriesEventsOptionsObject;
  54414. /**
  54415. * (Highcharts, Highstock) Determines whether the series should look for the
  54416. * nearest point in both dimensions or just the x-dimension when hovering
  54417. * the series. Defaults to `'xy'` for scatter series and `'x'` for most
  54418. * other series. If the data has duplicate x-values, it is recommended to
  54419. * set this to `'xy'` to allow hovering over all points.
  54420. *
  54421. * Applies only to series types using nearest neighbor search (not direct
  54422. * hover) for tooltip.
  54423. */
  54424. findNearestPointBy?: OptionsFindNearestPointByValue;
  54425. /**
  54426. * (Highstock) Defines when to display a gap in the graph, together with the
  54427. * gapUnit option.
  54428. *
  54429. * In case when `dataGrouping` is enabled, points can be grouped into a
  54430. * larger time span. This can make the grouped points to have a greater
  54431. * distance than the absolute value of `gapSize` property, which will result
  54432. * in disappearing graph completely. To prevent this situation the mentioned
  54433. * distance between grouped points is used instead of previously defined
  54434. * `gapSize`.
  54435. *
  54436. * In practice, this option is most often used to visualize gaps in time
  54437. * series. In a stock chart, intraday data is available for daytime hours,
  54438. * while gaps will appear in nights and weekends.
  54439. */
  54440. gapSize?: number;
  54441. /**
  54442. * (Highstock) Together with gapSize, this option defines where to draw gaps
  54443. * in the graph.
  54444. *
  54445. * When the `gapUnit` is `"relative"` (default), a gap size of 5 means that
  54446. * if the distance between two points is greater than 5 times that of the
  54447. * two closest points, the graph will be broken.
  54448. *
  54449. * When the `gapUnit` is `"value"`, the gap is based on absolute axis
  54450. * values, which on a datetime axis is milliseconds. This also applies to
  54451. * the navigator series that inherits gap options from the base series.
  54452. */
  54453. gapUnit?: OptionsGapUnitValue;
  54454. /**
  54455. * (Highcharts, Highstock, Gantt) Whether to use the Y extremes of the total
  54456. * chart width or only the zoomed area when zooming in on parts of the X
  54457. * axis. By default, the Y axis adjusts to the min and max of the visible
  54458. * data. Cartesian series only.
  54459. */
  54460. getExtremesFromAll?: boolean;
  54461. groupPadding?: number;
  54462. /**
  54463. * (Highcharts, Highstock) When set to `false` will prevent the series data
  54464. * from being included in any form of data export.
  54465. *
  54466. * Since version 6.0.0 until 7.1.0 the option was existing undocumented as
  54467. * `includeInCSVExport`.
  54468. */
  54469. includeInDataExport?: boolean;
  54470. /**
  54471. * (Highmaps) What property to join the `mapData` to the value data. For
  54472. * example, if joinBy is "code", the mapData items with a specific code is
  54473. * merged into the data with the same code. For maps loaded from GeoJSON,
  54474. * the keys may be held in each point's `properties` object.
  54475. *
  54476. * The joinBy option can also be an array of two values, where the first
  54477. * points to a key in the `mapData`, and the second points to another key in
  54478. * the `data`.
  54479. *
  54480. * When joinBy is `null`, the map items are joined by their position in the
  54481. * array, which performs much better in maps with many data points. This is
  54482. * the recommended option if you are printing more than a thousand data
  54483. * points and have a backend that can preprocess the data into a parallel
  54484. * array of the mapData.
  54485. */
  54486. joinBy?: (string|Array<string>);
  54487. /**
  54488. * (Highcharts, Highstock) An array specifying which option maps to which
  54489. * key in the data point array. This makes it convenient to work with
  54490. * unstructured data arrays from different sources.
  54491. */
  54492. keys?: Array<string>;
  54493. /**
  54494. * (Highcharts, Highstock, Gantt) Series labels are placed as close to the
  54495. * series as possible in a natural way, seeking to avoid other series. The
  54496. * goal of this feature is to make the chart more easily readable, like if a
  54497. * human designer placed the labels in the optimal position.
  54498. *
  54499. * The series labels currently work with series types having a `graph` or an
  54500. * `area`.
  54501. */
  54502. label?: SeriesLabelOptionsObject;
  54503. /**
  54504. * (Highstock) The line marks the last price from all points.
  54505. */
  54506. lastPrice?: SeriesLastPriceOptionsObject;
  54507. /**
  54508. * (Highstock) The line marks the last price from visible range of points.
  54509. */
  54510. lastVisiblePrice?: SeriesLastVisiblePriceOptionsObject;
  54511. /**
  54512. * (Highcharts, Highstock) The SVG value used for the `stroke-linecap` and
  54513. * `stroke-linejoin` of a line graph. Round means that lines are rounded in
  54514. * the ends and bends.
  54515. */
  54516. linecap?: SeriesLinecapValue;
  54517. /**
  54518. * (Highcharts, Highstock) A separate color for the graph line. By default
  54519. * the line takes the `color` of the series, but the lineColor setting
  54520. * allows setting a separate color for the line without altering the
  54521. * `fillColor`.
  54522. *
  54523. * In styled mode, the line stroke can be set with the `.highcharts-graph`
  54524. * class name.
  54525. */
  54526. lineColor?: (ColorString|GradientColorObject|PatternObject);
  54527. /**
  54528. * (Highcharts, Highstock, Gantt) The id of another series to link to.
  54529. * Additionally, the value can be ":previous" to link to the previous
  54530. * series. When two series are linked, only the first one appears in the
  54531. * legend. Toggling the visibility of this also toggles the linked series.
  54532. *
  54533. * If master series uses data sorting and linked series does not have its
  54534. * own sorting definition, the linked series will be sorted in the same
  54535. * order as the master one.
  54536. */
  54537. linkedTo?: string;
  54538. /**
  54539. * (Highcharts, Highstock) Options for the point markers of line-like
  54540. * series. Properties like `fillColor`, `lineColor` and `lineWidth` define
  54541. * the visual appearance of the markers. Other series types, like column
  54542. * series, don't have markers, but have visual options on the series level
  54543. * instead.
  54544. *
  54545. * In styled mode, the markers can be styled with the `.highcharts-point`,
  54546. * `.highcharts-point-hover` and `.highcharts-point-select` class names.
  54547. */
  54548. marker?: PointMarkerOptionsObject;
  54549. /**
  54550. * (Highstock) Options for the corresponding navigator series if
  54551. * `showInNavigator` is `true` for this series. Available options are the
  54552. * same as any series, documented at plotOptions and series.
  54553. *
  54554. * These options are merged with options in navigator.series, and will take
  54555. * precedence if the same option is defined both places.
  54556. */
  54557. navigatorOptions?: PlotSeriesOptions;
  54558. /**
  54559. * (Highcharts, Highstock) The color for the parts of the graph or points
  54560. * that are below the threshold. Note that `zones` takes precedence over the
  54561. * negative color. Using `negativeColor` is equivalent to applying a zone
  54562. * with value of 0.
  54563. */
  54564. negativeColor?: (ColorString|GradientColorObject|PatternObject);
  54565. /**
  54566. * (Highcharts) A separate color for the negative part of the area.
  54567. *
  54568. * In styled mode, a negative color is set with the `.highcharts-negative`
  54569. * class name.
  54570. */
  54571. negativeFillColor?: (ColorString|GradientColorObject|PatternObject);
  54572. /**
  54573. * (Highcharts, Highstock) Opacity of a series parts: line, fill (e.g. area)
  54574. * and dataLabels.
  54575. */
  54576. opacity?: number;
  54577. /**
  54578. * (Highcharts, Highstock) Properties for each single point.
  54579. */
  54580. point?: PlotSeriesPointOptions;
  54581. /**
  54582. * (Highcharts, Highstock) Same as accessibility.pointDescriptionFormatter,
  54583. * but for an individual series. Overrides the chart wide configuration.
  54584. */
  54585. pointDescriptionFormatter?: Function;
  54586. /**
  54587. * (Highcharts, Highstock, Gantt) If no x values are given for the points in
  54588. * a series, `pointInterval` defines the interval of the x values. For
  54589. * example, if a series contains one value every decade starting from year
  54590. * 0, set `pointInterval` to `10`. In true `datetime` axes, the
  54591. * `pointInterval` is set in milliseconds.
  54592. *
  54593. * It can be also be combined with `pointIntervalUnit` to draw irregular
  54594. * time intervals.
  54595. *
  54596. * Please note that this options applies to the _series data_, not the
  54597. * interval of the axis ticks, which is independent.
  54598. */
  54599. pointInterval?: number;
  54600. /**
  54601. * (Highcharts, Highstock, Gantt) On datetime series, this allows for
  54602. * setting the pointInterval to irregular time units, `day`, `month` and
  54603. * `year`. A day is usually the same as 24 hours, but `pointIntervalUnit`
  54604. * also takes the DST crossover into consideration when dealing with local
  54605. * time. Combine this option with `pointInterval` to draw weeks, quarters, 6
  54606. * months, 10 years etc.
  54607. *
  54608. * Please note that this options applies to the _series data_, not the
  54609. * interval of the axis ticks, which is independent.
  54610. */
  54611. pointIntervalUnit?: OptionsPointIntervalUnitValue;
  54612. pointPadding?: number;
  54613. /**
  54614. * (Highcharts, Highstock, Gantt) Possible values: `"on"`, `"between"`,
  54615. * `number`.
  54616. *
  54617. * In a column chart, when pointPlacement is `"on"`, the point will not
  54618. * create any padding of the X axis. In a polar column chart this means that
  54619. * the first column points directly north. If the pointPlacement is
  54620. * `"between"`, the columns will be laid out between ticks. This is useful
  54621. * for example for visualising an amount between two points in time or in a
  54622. * certain sector of a polar chart.
  54623. *
  54624. * Since Highcharts 3.0.2, the point placement can also be numeric, where 0
  54625. * is on the axis value, -0.5 is between this value and the previous, and
  54626. * 0.5 is between this value and the next. Unlike the textual options,
  54627. * numeric point placement options won't affect axis padding.
  54628. *
  54629. * Note that pointPlacement needs a pointRange to work. For column series
  54630. * this is computed, but for line-type series it needs to be set.
  54631. *
  54632. * For the `xrange` series type and gantt charts, if the Y axis is a
  54633. * category axis, the `pointPlacement` applies to the Y axis rather than the
  54634. * (typically datetime) X axis.
  54635. *
  54636. * Defaults to `undefined` in cartesian charts, `"between"` in polar charts.
  54637. */
  54638. pointPlacement?: (number|string);
  54639. /**
  54640. * (Highstock) The width of each point on the x axis. For example in a
  54641. * column chart with one value each day, the pointRange would be 1 day (= 24
  54642. * * 3600
  54643. *
  54644. * * 1000 milliseconds). This is normally computed automatically, but this
  54645. * option can be used to override the automatic value.
  54646. */
  54647. pointRange?: number;
  54648. /**
  54649. * (Highcharts, Highstock, Gantt) If no x values are given for the points in
  54650. * a series, pointStart defines on what value to start. For example, if a
  54651. * series contains one yearly value starting from 1945, set pointStart to
  54652. * 1945.
  54653. */
  54654. pointStart?: number;
  54655. /**
  54656. * (Highcharts, Highstock) Whether to select the series initially. If
  54657. * `showCheckbox` is true, the checkbox next to the series name in the
  54658. * legend will be checked for a selected series.
  54659. */
  54660. selected?: boolean;
  54661. /**
  54662. * (Highcharts) Whether to apply a drop shadow to the graph line. Since 2.3
  54663. * the shadow can be an object configuration containing `color`, `offsetX`,
  54664. * `offsetY`, `opacity` and `width`.
  54665. */
  54666. shadow?: (boolean|ShadowOptionsObject);
  54667. /**
  54668. * (Highcharts, Highstock) If true, a checkbox is displayed next to the
  54669. * legend item to allow selecting the series. The state of the checkbox is
  54670. * determined by the `selected` option.
  54671. */
  54672. showCheckbox?: boolean;
  54673. /**
  54674. * (Highcharts, Highstock) Whether to display this particular series or
  54675. * series type in the legend. Standalone series are shown in legend by
  54676. * default, and linked series are not. Since v7.2.0 it is possible to show
  54677. * series that use colorAxis by setting this option to `true`.
  54678. */
  54679. showInLegend?: boolean;
  54680. /**
  54681. * (Highstock) Whether or not to show the series in the navigator. Takes
  54682. * precedence over navigator.baseSeries if defined.
  54683. */
  54684. showInNavigator?: boolean;
  54685. /**
  54686. * (Highcharts, Highstock) If set to `true`, the accessibility module will
  54687. * skip past the points in this series for keyboard navigation.
  54688. */
  54689. skipKeyboardNavigation?: boolean;
  54690. /**
  54691. * (Highcharts, Highstock) When this is true, the series will not cause the
  54692. * Y axis to cross the zero plane (or threshold option) unless the data
  54693. * actually crosses the plane.
  54694. *
  54695. * For example, if `softThreshold` is `false`, a series of 0, 1, 2, 3 will
  54696. * make the Y axis show negative values according to the `minPadding`
  54697. * option. If `softThreshold` is `true`, the Y axis starts at 0.
  54698. */
  54699. softThreshold?: boolean;
  54700. states?: SeriesStatesOptionsObject;
  54701. /**
  54702. * (Highcharts, Highstock) Whether to apply steps to the line. Possible
  54703. * values are `left`, `center` and `right`.
  54704. */
  54705. step?: OptionsStepValue;
  54706. /**
  54707. * (Highcharts, Highstock) The Y axis value to serve as the base for the
  54708. * area, for distinguishing between values above and below a threshold. The
  54709. * area between the graph and the threshold is filled.
  54710. *
  54711. * * If a number is given, the Y axis will scale to the threshold.
  54712. *
  54713. * * If `null`, the scaling behaves like a line series with fill between the
  54714. * graph and the Y axis minimum.
  54715. *
  54716. * * If `Infinity` or `-Infinity`, the area between the graph and the
  54717. * corresponding Y axis extreme is filled (since v6.1.0).
  54718. */
  54719. threshold?: (number|null);
  54720. /**
  54721. * (Highcharts, Highstock) A configuration object for the tooltip rendering
  54722. * of each single series. Properties are inherited from tooltip, but only
  54723. * the following properties can be defined on a series level.
  54724. */
  54725. tooltip?: SeriesTooltipOptionsObject;
  54726. /**
  54727. * (Highcharts, Highstock, Gantt) When a series contains a data array that
  54728. * is longer than this, only one dimensional arrays of numbers, or two
  54729. * dimensional arrays with x and y values are allowed. Also, only the first
  54730. * point is tested, and the rest are assumed to be the same format. This
  54731. * saves expensive data checking and indexing in long series. Set it to `0`
  54732. * disable.
  54733. *
  54734. * Note: In boost mode turbo threshold is forced. Only array of numbers or
  54735. * two dimensional arrays are allowed.
  54736. */
  54737. turboThreshold?: number;
  54738. /**
  54739. * (Highcharts, Highstock) Set the initial visibility of the series.
  54740. */
  54741. visible?: boolean;
  54742. /**
  54743. * (Highmaps) Define the z index of the series.
  54744. */
  54745. zIndex?: number;
  54746. /**
  54747. * (Highcharts, Highstock) Defines the Axis on which the zones are applied.
  54748. */
  54749. zoneAxis?: string;
  54750. /**
  54751. * (Highcharts, Highstock) An array defining zones within a series. Zones
  54752. * can be applied to the X axis, Y axis or Z axis for bubbles, according to
  54753. * the `zoneAxis` option. The zone definitions have to be in ascending order
  54754. * regarding to the value.
  54755. *
  54756. * In styled mode, the color zones are styled with the
  54757. * `.highcharts-zone-{n}` class, or custom classed from the `className`
  54758. * option (view live demo).
  54759. */
  54760. zones?: Array<SeriesZonesOptionsObject>;
  54761. }
  54762. /**
  54763. * (Highstock) Enable or disable the initial animation when a series is
  54764. * displayed. The animation can also be set as a configuration object. Please
  54765. * note that this option only applies to the initial animation of the series
  54766. * itself. For other animations, see chart.animation and the animation parameter
  54767. * under the API methods. The following properties are supported:
  54768. *
  54769. * - `defer`: The animation delay time in milliseconds.
  54770. *
  54771. * - `duration`: The duration of the animation in milliseconds.
  54772. *
  54773. * - `easing`: Can be a string reference to an easing function set on the `Math`
  54774. * object or a function. See the _Custom easing function_ demo below.
  54775. *
  54776. * Due to poor performance, animation is disabled in old IE browsers for several
  54777. * chart types.
  54778. */
  54779. export interface PlotMacdAnimationOptions {
  54780. defer?: number;
  54781. }
  54782. /**
  54783. * (Highcharts, Highstock, Highmaps, Gantt) Enable or disable the initial
  54784. * animation when a series is displayed for the `dataLabels`. The animation can
  54785. * also be set as a configuration object. Please note that this option only
  54786. * applies to the initial animation. For other animations, see chart.animation
  54787. * and the animation parameter under the API methods. The following properties
  54788. * are supported:
  54789. *
  54790. * - `defer`: The animation delay time in milliseconds.
  54791. */
  54792. export interface PlotMacdDataLabelsAnimationOptions {
  54793. /**
  54794. * (Highcharts, Highstock, Highmaps, Gantt) The animation delay time in
  54795. * milliseconds. Set to `0` renders dataLabel immediately. As `undefined`
  54796. * inherits defer time from the series.animation.defer.
  54797. */
  54798. defer?: number;
  54799. }
  54800. /**
  54801. * (Highcharts, Highstock, Highmaps, Gantt) Options for the series data labels,
  54802. * appearing next to each data point.
  54803. *
  54804. * Since v6.2.0, multiple data labels can be applied to each single point by
  54805. * defining them as an array of configs.
  54806. *
  54807. * In styled mode, the data labels can be styled with the
  54808. * `.highcharts-data-label-box` and `.highcharts-data-label` class names (see
  54809. * example).
  54810. */
  54811. export interface PlotMacdDataLabelsOptions {
  54812. /**
  54813. * (Highcharts, Highstock, Highmaps, Gantt) The alignment of the data label
  54814. * compared to the point. If `right`, the right side of the label should be
  54815. * touching the point. For points with an extent, like columns, the
  54816. * alignments also dictates how to align it inside the box, as given with
  54817. * the inside option. Can be one of `left`, `center` or `right`.
  54818. */
  54819. align?: (AlignValue|null);
  54820. /**
  54821. * (Highcharts, Highstock, Highmaps, Gantt) Whether to allow data labels to
  54822. * overlap. To make the labels less sensitive for overlapping, the
  54823. * dataLabels.padding can be set to 0.
  54824. */
  54825. allowOverlap?: boolean;
  54826. /**
  54827. * (Highcharts, Highstock, Highmaps, Gantt) Enable or disable the initial
  54828. * animation when a series is displayed for the `dataLabels`. The animation
  54829. * can also be set as a configuration object. Please note that this option
  54830. * only applies to the initial animation. For other animations, see
  54831. * chart.animation and the animation parameter under the API methods. The
  54832. * following properties are supported:
  54833. *
  54834. * - `defer`: The animation delay time in milliseconds.
  54835. */
  54836. animation?: (boolean|PlotMacdDataLabelsAnimationOptions|Partial<AnimationOptionsObject>);
  54837. /**
  54838. * (Highcharts, Highstock, Highmaps, Gantt) The background color or gradient
  54839. * for the data label.
  54840. */
  54841. backgroundColor?: (ColorString|GradientColorObject|PatternObject);
  54842. /**
  54843. * (Highcharts, Highstock, Highmaps, Gantt) The border color for the data
  54844. * label. Defaults to `undefined`.
  54845. */
  54846. borderColor?: (ColorString|GradientColorObject|PatternObject);
  54847. /**
  54848. * (Highcharts, Highstock, Highmaps, Gantt) The border radius in pixels for
  54849. * the data label.
  54850. */
  54851. borderRadius?: number;
  54852. /**
  54853. * (Highcharts, Highstock, Highmaps, Gantt) The border width in pixels for
  54854. * the data label.
  54855. */
  54856. borderWidth?: number;
  54857. /**
  54858. * (Highcharts, Highstock, Highmaps, Gantt) A class name for the data label.
  54859. * Particularly in styled mode, this can be used to give each series' or
  54860. * point's data label unique styling. In addition to this option, a default
  54861. * color class name is added so that we can give the labels a contrast text
  54862. * shadow.
  54863. */
  54864. className?: string;
  54865. /**
  54866. * (Highcharts, Highstock, Highmaps, Gantt) The text color for the data
  54867. * labels. Defaults to `undefined`. For certain series types, like column or
  54868. * map, the data labels can be drawn inside the points. In this case the
  54869. * data label will be drawn with maximum contrast by default. Additionally,
  54870. * it will be given a `text-outline` style with the opposite color, to
  54871. * further increase the contrast. This can be overridden by setting the
  54872. * `text-outline` style to `none` in the `dataLabels.style` option.
  54873. */
  54874. color?: (ColorString|GradientColorObject|PatternObject);
  54875. /**
  54876. * (Highcharts, Highstock, Highmaps, Gantt) Whether to hide data labels that
  54877. * are outside the plot area. By default, the data label is moved inside the
  54878. * plot area according to the overflow option.
  54879. */
  54880. crop?: boolean;
  54881. /**
  54882. * (Highcharts, Highstock, Gantt) Whether to defer displaying the data
  54883. * labels until the initial series animation has finished. Setting to
  54884. * `false` renders the data label immediately. If set to `true` inherits the
  54885. * defer time set in plotOptions.series.animation.
  54886. */
  54887. defer?: boolean;
  54888. /**
  54889. * (Highcharts, Highstock, Highmaps, Gantt) Enable or disable the data
  54890. * labels.
  54891. */
  54892. enabled?: boolean;
  54893. /**
  54894. * (Highcharts, Highstock, Highmaps, Gantt) A declarative filter to control
  54895. * of which data labels to display. The declarative filter is designed for
  54896. * use when callback functions are not available, like when the chart
  54897. * options require a pure JSON structure or for use with graphical editors.
  54898. * For programmatic control, use the `formatter` instead, and return
  54899. * `undefined` to disable a single data label.
  54900. */
  54901. filter?: DataLabelsFilterOptionsObject;
  54902. /**
  54903. * (Highcharts, Highstock, Highmaps, Gantt) A format string for the data
  54904. * label. Available variables are the same as for `formatter`.
  54905. */
  54906. format?: string;
  54907. /**
  54908. * (Highcharts, Highstock, Highmaps, Gantt) Callback JavaScript function to
  54909. * format the data label. Note that if a `format` is defined, the format
  54910. * takes precedence and the formatter is ignored.
  54911. */
  54912. formatter?: DataLabelsFormatterCallbackFunction;
  54913. /**
  54914. * (Highcharts, Highstock, Highmaps, Gantt) For points with an extent, like
  54915. * columns or map areas, whether to align the data label inside the box or
  54916. * to the actual value point. Defaults to `false` in most cases, `true` in
  54917. * stacked columns.
  54918. */
  54919. inside?: boolean;
  54920. /**
  54921. * (Highcharts, Highstock, Highmaps, Gantt) Format for points with the value
  54922. * of null. Works analogously to format. `nullFormat` can be applied only to
  54923. * series which support displaying null points.
  54924. */
  54925. nullFormat?: (boolean|string);
  54926. /**
  54927. * (Highcharts, Highstock, Highmaps, Gantt) Callback JavaScript function
  54928. * that defines formatting for points with the value of null. Works
  54929. * analogously to formatter. `nullPointFormatter` can be applied only to
  54930. * series which support displaying null points.
  54931. */
  54932. nullFormatter?: DataLabelsFormatterCallbackFunction;
  54933. /**
  54934. * (Highcharts, Highstock, Highmaps, Gantt) How to handle data labels that
  54935. * flow outside the plot area. The default is `"justify"`, which aligns them
  54936. * inside the plot area. For columns and bars, this means it will be moved
  54937. * inside the bar. To display data labels outside the plot area, set `crop`
  54938. * to `false` and `overflow` to `"allow"`.
  54939. */
  54940. overflow?: DataLabelsOverflowValue;
  54941. /**
  54942. * (Highcharts, Highstock, Highmaps, Gantt) When either the `borderWidth` or
  54943. * the `backgroundColor` is set, this is the padding within the box.
  54944. */
  54945. padding?: number;
  54946. /**
  54947. * (Highcharts, Highstock, Highmaps, Gantt) Aligns data labels relative to
  54948. * points. If `center` alignment is not possible, it defaults to `right`.
  54949. */
  54950. position?: AlignValue;
  54951. /**
  54952. * (Highcharts, Highstock, Highmaps, Gantt) Text rotation in degrees. Note
  54953. * that due to a more complex structure, backgrounds, borders and padding
  54954. * will be lost on a rotated data label.
  54955. */
  54956. rotation?: number;
  54957. /**
  54958. * (Highcharts, Highstock, Highmaps, Gantt) The shadow of the box. Works
  54959. * best with `borderWidth` or `backgroundColor`. Since 2.3 the shadow can be
  54960. * an object configuration containing `color`, `offsetX`, `offsetY`,
  54961. * `opacity` and `width`.
  54962. */
  54963. shadow?: (boolean|ShadowOptionsObject);
  54964. /**
  54965. * (Highcharts, Highstock, Highmaps, Gantt) The name of a symbol to use for
  54966. * the border around the label. Symbols are predefined functions on the
  54967. * Renderer object.
  54968. */
  54969. shape?: string;
  54970. /**
  54971. * (Highcharts, Highstock, Highmaps, Gantt) Styles for the label. The
  54972. * default `color` setting is `"contrast"`, which is a pseudo color that
  54973. * Highcharts picks up and applies the maximum contrast to the underlying
  54974. * point item, for example the bar in a bar chart.
  54975. *
  54976. * The `textOutline` is a pseudo property that applies an outline of the
  54977. * given width with the given color, which by default is the maximum
  54978. * contrast to the text. So a bright text color will result in a black text
  54979. * outline for maximum readability on a mixed background. In some cases,
  54980. * especially with grayscale text, the text outline doesn't work well, in
  54981. * which cases it can be disabled by setting it to `"none"`. When `useHTML`
  54982. * is true, the `textOutline` will not be picked up. In this, case, the same
  54983. * effect can be acheived through the `text-shadow` CSS property.
  54984. *
  54985. * For some series types, where each point has an extent, like for example
  54986. * tree maps, the data label may overflow the point. There are two
  54987. * strategies for handling overflow. By default, the text will wrap to
  54988. * multiple lines. The other strategy is to set `style.textOverflow` to
  54989. * `ellipsis`, which will keep the text on one line plus it will break
  54990. * inside long words.
  54991. */
  54992. style?: CSSObject;
  54993. /**
  54994. * (Highcharts, Highstock, Highmaps, Gantt) Options for a label text which
  54995. * should follow marker's shape. Border and background are disabled for a
  54996. * label that follows a path.
  54997. *
  54998. * **Note:** Only SVG-based renderer supports this option. Setting `useHTML`
  54999. * to true will disable this option.
  55000. */
  55001. textPath?: DataLabelsTextPathOptionsObject;
  55002. /**
  55003. * (Highcharts, Highstock, Highmaps, Gantt) Whether to use HTML to render
  55004. * the labels.
  55005. */
  55006. useHTML?: boolean;
  55007. /**
  55008. * (Highcharts, Highstock, Highmaps, Gantt) The vertical alignment of a data
  55009. * label. Can be one of `top`, `middle` or `bottom`. The default value
  55010. * depends on the data, for instance in a column chart, the label is above
  55011. * positive values and below negative values.
  55012. */
  55013. verticalAlign?: (VerticalAlignValue|null);
  55014. /**
  55015. * (Highcharts, Highstock, Highmaps, Gantt) The x position offset of the
  55016. * label relative to the point in pixels.
  55017. */
  55018. x?: number;
  55019. /**
  55020. * (Highcharts, Highstock, Highmaps, Gantt) The y position offset of the
  55021. * label relative to the point in pixels.
  55022. */
  55023. y?: number;
  55024. /**
  55025. * (Highcharts, Highstock, Highmaps, Gantt) The Z index of the data labels.
  55026. * The default Z index puts it above the series. Use a Z index of 2 to
  55027. * display it behind the series.
  55028. */
  55029. z?: number;
  55030. }
  55031. /**
  55032. * (Highcharts, Highstock) Options for the series data sorting.
  55033. */
  55034. export interface PlotMacdDataSortingOptions {
  55035. /**
  55036. * (Highcharts, Highstock) Enable or disable data sorting for the series.
  55037. * Use xAxis.reversed to change the sorting order.
  55038. */
  55039. enabled?: boolean;
  55040. /**
  55041. * (Highcharts, Highstock) Whether to allow matching points by name in an
  55042. * update. If this option is disabled, points will be matched by order.
  55043. */
  55044. matchByName?: boolean;
  55045. /**
  55046. * (Highcharts, Highstock) Determines what data value should be used to sort
  55047. * by.
  55048. */
  55049. sortKey?: string;
  55050. }
  55051. /**
  55052. * (Highstock) The styles for macd line
  55053. */
  55054. export interface PlotMacdMacdLineOptions {
  55055. styles?: PlotMacdMacdLineStylesOptions;
  55056. /**
  55057. * (Highcharts, Highstock) An array defining zones within a series. Zones
  55058. * can be applied to the X axis, Y axis or Z axis for bubbles, according to
  55059. * the `zoneAxis` option. The zone definitions have to be in ascending order
  55060. * regarding to the value.
  55061. *
  55062. * In styled mode, the color zones are styled with the
  55063. * `.highcharts-zone-{n}` class, or custom classed from the `className`
  55064. * option (view live demo).
  55065. */
  55066. zones?: Array<SeriesZonesOptionsObject>;
  55067. }
  55068. export interface PlotMacdMacdLineStylesOptions {
  55069. /**
  55070. * (Highstock) Color of the line.
  55071. */
  55072. lineColor?: ColorString;
  55073. /**
  55074. * (Highstock) Pixel width of the line.
  55075. */
  55076. lineWidth?: number;
  55077. }
  55078. /**
  55079. * (Highstock) Moving Average Convergence Divergence (MACD). This series
  55080. * requires `linkedTo` option to be set and should be loaded after the
  55081. * `stock/indicators/indicators.js` and `stock/indicators/ema.js`.
  55082. *
  55083. * In TypeScript the type option must always be set.
  55084. *
  55085. * Configuration options for the series are given in three levels:
  55086. *
  55087. * 1. Options for all series in a chart are defined in the plotOptions.series
  55088. * object.
  55089. *
  55090. * 2. Options for all `macd` series are defined in plotOptions.macd.
  55091. *
  55092. * 3. Options for one single series are given in the series instance array. (see
  55093. * online documentation for example)
  55094. */
  55095. export interface PlotMacdOptions {
  55096. /**
  55097. * (Highstock) Accessibility options for a series.
  55098. */
  55099. accessibility?: SeriesAccessibilityOptionsObject;
  55100. /**
  55101. * (Highstock) Allow this series' points to be selected by clicking on the
  55102. * graphic (columns, point markers, pie slices, map areas etc).
  55103. *
  55104. * The selected points can be handled by point select and unselect events,
  55105. * or collectively by the getSelectedPoints function.
  55106. *
  55107. * And alternative way of selecting points is through dragging.
  55108. */
  55109. allowPointSelect?: boolean;
  55110. /**
  55111. * (Highstock) Enable or disable the initial animation when a series is
  55112. * displayed. The animation can also be set as a configuration object.
  55113. * Please note that this option only applies to the initial animation of the
  55114. * series itself. For other animations, see chart.animation and the
  55115. * animation parameter under the API methods. The following properties are
  55116. * supported:
  55117. *
  55118. * - `defer`: The animation delay time in milliseconds.
  55119. *
  55120. * - `duration`: The duration of the animation in milliseconds.
  55121. *
  55122. * - `easing`: Can be a string reference to an easing function set on the
  55123. * `Math` object or a function. See the _Custom easing function_ demo below.
  55124. *
  55125. * Due to poor performance, animation is disabled in old IE browsers for
  55126. * several chart types.
  55127. */
  55128. animation?: (boolean|PlotMacdAnimationOptions|Partial<AnimationOptionsObject>);
  55129. /**
  55130. * (Highstock) For some series, there is a limit that shuts down initial
  55131. * animation by default when the total number of points in the chart is too
  55132. * high. For example, for a column chart and its derivatives, animation does
  55133. * not run if there is more than 250 points totally. To disable this cap,
  55134. * set `animationLimit` to `Infinity`.
  55135. */
  55136. animationLimit?: number;
  55137. /**
  55138. * (Highstock) Sets the color blending in the boost module.
  55139. */
  55140. boostBlending?: OptionsBoostBlendingValue;
  55141. /**
  55142. * (Highstock) Set the point threshold for when a series should enter boost
  55143. * mode.
  55144. *
  55145. * Setting it to e.g. 2000 will cause the series to enter boost mode when
  55146. * there are 2000 or more points in the series.
  55147. *
  55148. * To disable boosting on the series, set the `boostThreshold` to 0. Setting
  55149. * it to 1 will force boosting.
  55150. *
  55151. * Note that the cropThreshold also affects this setting. When zooming in on
  55152. * a series that has fewer points than the `cropThreshold`, all points are
  55153. * rendered although outside the visible plot area, and the `boostThreshold`
  55154. * won't take effect.
  55155. */
  55156. boostThreshold?: number;
  55157. /**
  55158. * (Highmaps) The border color of the map areas.
  55159. *
  55160. * In styled mode, the border stroke is given in the `.highcharts-point`
  55161. * class.
  55162. */
  55163. borderColor?: (ColorString|GradientColorObject|PatternObject);
  55164. /**
  55165. * (Highmaps) The border width of each map area.
  55166. *
  55167. * In styled mode, the border stroke width is given in the
  55168. * `.highcharts-point` class.
  55169. */
  55170. borderWidth?: number;
  55171. /**
  55172. * (Highstock) An additional class name to apply to the series' graphical
  55173. * elements. This option does not replace default class names of the
  55174. * graphical element.
  55175. */
  55176. className?: string;
  55177. /**
  55178. * (Highstock) Disable this option to allow series rendering in the whole
  55179. * plotting area.
  55180. *
  55181. * **Note:** Clipping should be always enabled when chart.zoomType is set
  55182. */
  55183. clip?: boolean;
  55184. /**
  55185. * (Highstock) The main color of the series. In line type series it applies
  55186. * to the line and the point markers unless otherwise specified. In bar type
  55187. * series it applies to the bars unless a color is specified per point. The
  55188. * default value is pulled from the `options.colors` array.
  55189. *
  55190. * In styled mode, the color can be defined by the colorIndex option. Also,
  55191. * the series color can be set with the `.highcharts-series`,
  55192. * `.highcharts-color-{n}`, `.highcharts-{type}-series` or
  55193. * `.highcharts-series-{n}` class, or individual classes given by the
  55194. * `className` option.
  55195. */
  55196. color?: (ColorString|GradientColorObject|PatternObject);
  55197. /**
  55198. * (Highstock) Styled mode only. A specific color index to use for the
  55199. * series, so its graphic representations are given the class name
  55200. * `highcharts-color-{n}`.
  55201. */
  55202. colorIndex?: number;
  55203. /**
  55204. * (Highcharts, Highstock, Highmaps) Determines what data value should be
  55205. * used to calculate point color if `colorAxis` is used. Requires to set
  55206. * `min` and `max` if some custom point property is used or if approximation
  55207. * for data grouping is set to `'sum'`.
  55208. */
  55209. colorKey?: string;
  55210. /**
  55211. * (Highstock) Compare the values of the series against the first non-null,
  55212. * non- zero value in the visible range. The y axis will show percentage or
  55213. * absolute change depending on whether `compare` is set to `"percent"` or
  55214. * `"value"`. When this is applied to multiple series, it allows comparing
  55215. * the development of the series against each other. Adds a `change` field
  55216. * to every point object.
  55217. */
  55218. compare?: string;
  55219. /**
  55220. * (Highstock) When compare is `percent`, this option dictates whether to
  55221. * use 0 or 100 as the base of comparison.
  55222. */
  55223. compareBase?: (0|100);
  55224. /**
  55225. * (Highstock) Defines if comparison should start from the first point
  55226. * within the visible range or should start from the first point **before**
  55227. * the range.
  55228. *
  55229. * In other words, this flag determines if first point within the visible
  55230. * range will have 0% (`compareStart=true`) or should have been already
  55231. * calculated according to the previous point (`compareStart=false`).
  55232. */
  55233. compareStart?: boolean;
  55234. /**
  55235. * (Highstock) Whether to compare indicator to the main series values or
  55236. * indicator values.
  55237. */
  55238. compareToMain?: boolean;
  55239. /**
  55240. * (Highcharts) Polar charts only. Whether to connect the ends of a line
  55241. * series plot across the extremes.
  55242. */
  55243. connectEnds?: boolean;
  55244. /**
  55245. * (Highcharts, Highstock) Whether to connect a graph line across null
  55246. * points, or render a gap between the two points on either side of the
  55247. * null.
  55248. */
  55249. connectNulls?: boolean;
  55250. /**
  55251. * (Gantt) Override Pathfinder connector options for a series. Requires
  55252. * Highcharts Gantt to be loaded.
  55253. */
  55254. connectors?: SeriesConnectorsOptionsObject;
  55255. /**
  55256. * (Highcharts, Highstock, Gantt) When true, each point or column edge is
  55257. * rounded to its nearest pixel in order to render sharp on screen. In some
  55258. * cases, when there are a lot of densely packed columns, this leads to
  55259. * visible difference in column widths or distance between columns. In these
  55260. * cases, setting `crisp` to `false` may look better, even though each
  55261. * column is rendered blurry.
  55262. */
  55263. crisp?: boolean;
  55264. /**
  55265. * (Highcharts, Highstock) When the series contains less points than the
  55266. * crop threshold, all points are drawn, even if the points fall outside the
  55267. * visible plot area at the current zoom. The advantage of drawing all
  55268. * points (including markers and columns), is that animation is performed on
  55269. * updates. On the other hand, when the series contains more points than the
  55270. * crop threshold, the series data is cropped to only contain points that
  55271. * fall within the plot area. The advantage of cropping away invisible
  55272. * points is to increase performance on large series.
  55273. */
  55274. cropThreshold?: number;
  55275. /**
  55276. * (Highstock) You can set the cursor to "pointer" if you have click events
  55277. * attached to the series, to signal to the user that the points and lines
  55278. * can be clicked.
  55279. *
  55280. * In styled mode, the series cursor can be set with the same classes as
  55281. * listed under series.color.
  55282. */
  55283. cursor?: (string|CursorValue);
  55284. /**
  55285. * (Highstock) A reserved subspace to store options and values for
  55286. * customized functionality. Here you can add additional data for your own
  55287. * event callbacks and formatter callbacks.
  55288. */
  55289. custom?: Dictionary<any>;
  55290. /**
  55291. * (Highstock) Name of the dash style to use for the graph, or for some
  55292. * series types the outline of each shape.
  55293. *
  55294. * In styled mode, the stroke dash-array can be set with the same classes as
  55295. * listed under series.color.
  55296. */
  55297. dashStyle?: DashStyleValue;
  55298. /**
  55299. * (Highstock) Data grouping is the concept of sampling the data values into
  55300. * larger blocks in order to ease readability and increase performance of
  55301. * the JavaScript charts. Highstock by default applies data grouping when
  55302. * the points become closer than a certain pixel value, determined by the
  55303. * `groupPixelWidth` option.
  55304. *
  55305. * If data grouping is applied, the grouping information of grouped points
  55306. * can be read from the Point.dataGroup. If point options other than the
  55307. * data itself are set, for example `name` or `color` or custom properties,
  55308. * the grouping logic doesn't know how to group it. In this case the options
  55309. * of the first point instance are copied over to the group point. This can
  55310. * be altered through a custom `approximation` callback function.
  55311. */
  55312. dataGrouping?: DataGroupingOptionsObject;
  55313. /**
  55314. * (Highcharts, Highstock, Highmaps, Gantt) Options for the series data
  55315. * labels, appearing next to each data point.
  55316. *
  55317. * Since v6.2.0, multiple data labels can be applied to each single point by
  55318. * defining them as an array of configs.
  55319. *
  55320. * In styled mode, the data labels can be styled with the
  55321. * `.highcharts-data-label-box` and `.highcharts-data-label` class names
  55322. * (see example).
  55323. */
  55324. dataLabels?: (PlotMacdDataLabelsOptions|Array<PlotMacdDataLabelsOptions>);
  55325. /**
  55326. * (Highcharts, Highstock) Options for the series data sorting.
  55327. */
  55328. dataSorting?: (DataSortingOptionsObject|PlotMacdDataSortingOptions);
  55329. /**
  55330. * (Highstock) A description of the series to add to the screen reader
  55331. * information about the series.
  55332. */
  55333. description?: string;
  55334. /**
  55335. * (Highstock) Enable or disable the mouse tracking for a specific series.
  55336. * This includes point tooltips and click events on graphs and points. For
  55337. * large datasets it improves performance.
  55338. */
  55339. enableMouseTracking?: boolean;
  55340. /**
  55341. * (Highstock) General event handlers for the series items. These event
  55342. * hooks can also be attached to the series at run time using the
  55343. * `Highcharts.addEvent` function.
  55344. */
  55345. events?: SeriesEventsOptionsObject;
  55346. /**
  55347. * (Highstock) Determines whether the series should look for the nearest
  55348. * point in both dimensions or just the x-dimension when hovering the
  55349. * series. Defaults to `'xy'` for scatter series and `'x'` for most other
  55350. * series. If the data has duplicate x-values, it is recommended to set this
  55351. * to `'xy'` to allow hovering over all points.
  55352. *
  55353. * Applies only to series types using nearest neighbor search (not direct
  55354. * hover) for tooltip.
  55355. */
  55356. findNearestPointBy?: OptionsFindNearestPointByValue;
  55357. /**
  55358. * (Highstock) Defines when to display a gap in the graph, together with the
  55359. * gapUnit option.
  55360. *
  55361. * In case when `dataGrouping` is enabled, points can be grouped into a
  55362. * larger time span. This can make the grouped points to have a greater
  55363. * distance than the absolute value of `gapSize` property, which will result
  55364. * in disappearing graph completely. To prevent this situation the mentioned
  55365. * distance between grouped points is used instead of previously defined
  55366. * `gapSize`.
  55367. *
  55368. * In practice, this option is most often used to visualize gaps in time
  55369. * series. In a stock chart, intraday data is available for daytime hours,
  55370. * while gaps will appear in nights and weekends.
  55371. */
  55372. gapSize?: number;
  55373. /**
  55374. * (Highstock) Together with gapSize, this option defines where to draw gaps
  55375. * in the graph.
  55376. *
  55377. * When the `gapUnit` is `"relative"` (default), a gap size of 5 means that
  55378. * if the distance between two points is greater than 5 times that of the
  55379. * two closest points, the graph will be broken.
  55380. *
  55381. * When the `gapUnit` is `"value"`, the gap is based on absolute axis
  55382. * values, which on a datetime axis is milliseconds. This also applies to
  55383. * the navigator series that inherits gap options from the base series.
  55384. */
  55385. gapUnit?: OptionsGapUnitValue;
  55386. /**
  55387. * (Highcharts, Highstock, Gantt) Whether to use the Y extremes of the total
  55388. * chart width or only the zoomed area when zooming in on parts of the X
  55389. * axis. By default, the Y axis adjusts to the min and max of the visible
  55390. * data. Cartesian series only.
  55391. */
  55392. getExtremesFromAll?: boolean;
  55393. groupPadding?: number;
  55394. /**
  55395. * (Highstock) When set to `false` will prevent the series data from being
  55396. * included in any form of data export.
  55397. *
  55398. * Since version 6.0.0 until 7.1.0 the option was existing undocumented as
  55399. * `includeInCSVExport`.
  55400. */
  55401. includeInDataExport?: boolean;
  55402. /**
  55403. * (Highcharts, Highstock, Gantt) Series labels are placed as close to the
  55404. * series as possible in a natural way, seeking to avoid other series. The
  55405. * goal of this feature is to make the chart more easily readable, like if a
  55406. * human designer placed the labels in the optimal position.
  55407. *
  55408. * The series labels currently work with series types having a `graph` or an
  55409. * `area`.
  55410. */
  55411. label?: SeriesLabelOptionsObject;
  55412. /**
  55413. * (Highstock) The line marks the last price from all points.
  55414. */
  55415. lastPrice?: SeriesLastPriceOptionsObject;
  55416. /**
  55417. * (Highstock) The line marks the last price from visible range of points.
  55418. */
  55419. lastVisiblePrice?: SeriesLastVisiblePriceOptionsObject;
  55420. /**
  55421. * (Highcharts, Highstock) The SVG value used for the `stroke-linecap` and
  55422. * `stroke-linejoin` of a line graph. Round means that lines are rounded in
  55423. * the ends and bends.
  55424. */
  55425. linecap?: SeriesLinecapValue;
  55426. /**
  55427. * (Highcharts, Highstock) Pixel width of the graph line.
  55428. */
  55429. lineWidth?: number;
  55430. /**
  55431. * (Highcharts, Highstock, Gantt) The main series ID that indicator will be
  55432. * based on. Required for this indicator.
  55433. */
  55434. linkedTo?: string;
  55435. /**
  55436. * (Highstock) The styles for macd line
  55437. */
  55438. macdLine?: PlotMacdMacdLineOptions;
  55439. /**
  55440. * (Highstock) Options for the point markers of line-like series. Properties
  55441. * like `fillColor`, `lineColor` and `lineWidth` define the visual
  55442. * appearance of the markers. Other series types, like column series, don't
  55443. * have markers, but have visual options on the series level instead.
  55444. *
  55445. * In styled mode, the markers can be styled with the `.highcharts-point`,
  55446. * `.highcharts-point-hover` and `.highcharts-point-select` class names.
  55447. */
  55448. marker?: PointMarkerOptionsObject;
  55449. minPointLength?: number;
  55450. /**
  55451. * (Highstock) The name of the series as shown in the legend, tooltip etc.
  55452. * If not set, it will be based on a technical indicator type and default
  55453. * params.
  55454. */
  55455. name?: string;
  55456. /**
  55457. * (Highstock) The color for the parts of the graph or points that are below
  55458. * the threshold. Note that `zones` takes precedence over the negative
  55459. * color. Using `negativeColor` is equivalent to applying a zone with value
  55460. * of 0.
  55461. */
  55462. negativeColor?: (ColorString|GradientColorObject|PatternObject);
  55463. /**
  55464. * (Highstock) Opacity of a series parts: line, fill (e.g. area) and
  55465. * dataLabels.
  55466. */
  55467. opacity?: number;
  55468. /**
  55469. * (Highstock) Paramters used in calculation of regression series' points.
  55470. */
  55471. params?: PlotMacdParamsOptions;
  55472. /**
  55473. * (Highstock) Properties for each single point.
  55474. */
  55475. point?: PlotSeriesPointOptions;
  55476. /**
  55477. * (Highstock) Same as accessibility.pointDescriptionFormatter, but for an
  55478. * individual series. Overrides the chart wide configuration.
  55479. */
  55480. pointDescriptionFormatter?: Function;
  55481. pointPadding?: number;
  55482. /**
  55483. * (Highstock) Whether to select the series initially. If `showCheckbox` is
  55484. * true, the checkbox next to the series name in the legend will be checked
  55485. * for a selected series.
  55486. */
  55487. selected?: boolean;
  55488. /**
  55489. * (Highstock) Whether to apply a drop shadow to the graph line. Since 2.3
  55490. * the shadow can be an object configuration containing `color`, `offsetX`,
  55491. * `offsetY`, `opacity` and `width`.
  55492. */
  55493. shadow?: (boolean|ShadowOptionsObject);
  55494. /**
  55495. * (Highstock) If true, a checkbox is displayed next to the legend item to
  55496. * allow selecting the series. The state of the checkbox is determined by
  55497. * the `selected` option.
  55498. */
  55499. showCheckbox?: boolean;
  55500. /**
  55501. * (Highstock) Whether to display this particular series or series type in
  55502. * the legend. Standalone series are shown in legend by default, and linked
  55503. * series are not. Since v7.2.0 it is possible to show series that use
  55504. * colorAxis by setting this option to `true`.
  55505. */
  55506. showInLegend?: boolean;
  55507. /**
  55508. * (Highstock) The styles for signal line
  55509. */
  55510. signalLine?: PlotMacdSignalLineOptions;
  55511. /**
  55512. * (Highstock) If set to `true`, the accessibility module will skip past the
  55513. * points in this series for keyboard navigation.
  55514. */
  55515. skipKeyboardNavigation?: boolean;
  55516. /**
  55517. * (Highcharts, Highstock) When this is true, the series will not cause the
  55518. * Y axis to cross the zero plane (or threshold option) unless the data
  55519. * actually crosses the plane.
  55520. *
  55521. * For example, if `softThreshold` is `false`, a series of 0, 1, 2, 3 will
  55522. * make the Y axis show negative values according to the `minPadding`
  55523. * option. If `softThreshold` is `true`, the Y axis starts at 0.
  55524. */
  55525. softThreshold?: boolean;
  55526. states?: SeriesStatesOptionsObject;
  55527. /**
  55528. * (Highcharts, Highstock) Whether to apply steps to the line. Possible
  55529. * values are `left`, `center` and `right`.
  55530. */
  55531. step?: OptionsStepValue;
  55532. /**
  55533. * (Highstock) Sticky tracking of mouse events. When true, the `mouseOut`
  55534. * event on a series isn't triggered until the mouse moves over another
  55535. * series, or out of the plot area. When false, the `mouseOut` event on a
  55536. * series is triggered when the mouse leaves the area around the series'
  55537. * graph or markers. This also implies the tooltip when not shared. When
  55538. * `stickyTracking` is false and `tooltip.shared` is false, the tooltip will
  55539. * be hidden when moving the mouse between series. Defaults to true for line
  55540. * and area type series, but to false for columns, pies etc.
  55541. *
  55542. * **Note:** The boost module will force this option because of technical
  55543. * limitations.
  55544. */
  55545. stickyTracking?: boolean;
  55546. /**
  55547. * (Highcharts, Highstock) The threshold, also called zero level or base
  55548. * level. For line type series this is only used in conjunction with
  55549. * negativeColor.
  55550. */
  55551. threshold?: (number|null);
  55552. /**
  55553. * (Highstock) A configuration object for the tooltip rendering of each
  55554. * single series. Properties are inherited from tooltip, but only the
  55555. * following properties can be defined on a series level.
  55556. */
  55557. tooltip?: SeriesTooltipOptionsObject;
  55558. /**
  55559. * (Highcharts, Highstock, Gantt) When a series contains a data array that
  55560. * is longer than this, only one dimensional arrays of numbers, or two
  55561. * dimensional arrays with x and y values are allowed. Also, only the first
  55562. * point is tested, and the rest are assumed to be the same format. This
  55563. * saves expensive data checking and indexing in long series. Set it to `0`
  55564. * disable.
  55565. *
  55566. * Note: In boost mode turbo threshold is forced. Only array of numbers or
  55567. * two dimensional arrays are allowed.
  55568. */
  55569. turboThreshold?: number;
  55570. /**
  55571. * (Highstock) Set the initial visibility of the series.
  55572. */
  55573. visible?: boolean;
  55574. /**
  55575. * (Highmaps) Define the z index of the series.
  55576. */
  55577. zIndex?: number;
  55578. /**
  55579. * (Highcharts, Highstock) Defines the Axis on which the zones are applied.
  55580. */
  55581. zoneAxis?: string;
  55582. /**
  55583. * (Highcharts, Highstock) An array defining zones within a series. Zones
  55584. * can be applied to the X axis, Y axis or Z axis for bubbles, according to
  55585. * the `zoneAxis` option. The zone definitions have to be in ascending order
  55586. * regarding to the value.
  55587. *
  55588. * In styled mode, the color zones are styled with the
  55589. * `.highcharts-zone-{n}` class, or custom classed from the `className`
  55590. * option (view live demo).
  55591. */
  55592. zones?: Array<SeriesZonesOptionsObject>;
  55593. }
  55594. /**
  55595. * (Highstock) Paramters used in calculation of regression series' points.
  55596. */
  55597. export interface PlotMacdParamsOptions {
  55598. /**
  55599. * (Highstock) The point index which indicator calculations will base. For
  55600. * example using OHLC data, index=2 means the indicator will be calculated
  55601. * using Low values.
  55602. */
  55603. index?: number;
  55604. /**
  55605. * (Highstock) The long period for indicator calculations.
  55606. */
  55607. longPeriod?: number;
  55608. /**
  55609. * (Highstock) The base period for indicator calculations. This is the
  55610. * number of data points which are taken into account for the indicator
  55611. * calculations.
  55612. */
  55613. period?: number;
  55614. /**
  55615. * (Highstock) The short period for indicator calculations.
  55616. */
  55617. shortPeriod?: number;
  55618. /**
  55619. * (Highstock) The base period for signal calculations.
  55620. */
  55621. signalPeriod?: number;
  55622. }
  55623. /**
  55624. * (Highstock) The styles for signal line
  55625. */
  55626. export interface PlotMacdSignalLineOptions {
  55627. styles?: PlotMacdSignalLineStylesOptions;
  55628. /**
  55629. * (Highcharts, Highstock) An array defining zones within a series. Zones
  55630. * can be applied to the X axis, Y axis or Z axis for bubbles, according to
  55631. * the `zoneAxis` option. The zone definitions have to be in ascending order
  55632. * regarding to the value.
  55633. *
  55634. * In styled mode, the color zones are styled with the
  55635. * `.highcharts-zone-{n}` class, or custom classed from the `className`
  55636. * option (view live demo).
  55637. */
  55638. zones?: Array<SeriesZonesOptionsObject>;
  55639. }
  55640. export interface PlotMacdSignalLineStylesOptions {
  55641. /**
  55642. * (Highstock) Color of the line.
  55643. */
  55644. lineColor?: ColorString;
  55645. /**
  55646. * (Highstock) Pixel width of the line.
  55647. */
  55648. lineWidth?: number;
  55649. }
  55650. /**
  55651. * (Highmaps) Enable or disable the initial animation when a series is
  55652. * displayed. The animation can also be set as a configuration object. Please
  55653. * note that this option only applies to the initial animation of the series
  55654. * itself. For other animations, see chart.animation and the animation parameter
  55655. * under the API methods. The following properties are supported:
  55656. *
  55657. * - `defer`: The animation delay time in milliseconds.
  55658. *
  55659. * - `duration`: The duration of the animation in milliseconds.
  55660. *
  55661. * - `easing`: Can be a string reference to an easing function set on the `Math`
  55662. * object or a function. See the _Custom easing function_ demo below.
  55663. *
  55664. * Due to poor performance, animation is disabled in old IE browsers for several
  55665. * chart types.
  55666. */
  55667. export interface PlotMapAnimationOptions {
  55668. defer?: number;
  55669. }
  55670. /**
  55671. * (Highmaps) Enable or disable the initial animation when a series is
  55672. * displayed. The animation can also be set as a configuration object. Please
  55673. * note that this option only applies to the initial animation of the series
  55674. * itself. For other animations, see chart.animation and the animation parameter
  55675. * under the API methods. The following properties are supported:
  55676. *
  55677. * - `defer`: The animation delay time in milliseconds.
  55678. *
  55679. * - `duration`: The duration of the animation in milliseconds.
  55680. *
  55681. * - `easing`: Can be a string reference to an easing function set on the `Math`
  55682. * object or a function. See the _Custom easing function_ demo below.
  55683. *
  55684. * Due to poor performance, animation is disabled in old IE browsers for several
  55685. * chart types.
  55686. */
  55687. export interface PlotMapbubbleAnimationOptions {
  55688. defer?: number;
  55689. }
  55690. /**
  55691. * (Highcharts, Highstock, Highmaps, Gantt) Enable or disable the initial
  55692. * animation when a series is displayed for the `dataLabels`. The animation can
  55693. * also be set as a configuration object. Please note that this option only
  55694. * applies to the initial animation. For other animations, see chart.animation
  55695. * and the animation parameter under the API methods. The following properties
  55696. * are supported:
  55697. *
  55698. * - `defer`: The animation delay time in milliseconds.
  55699. */
  55700. export interface PlotMapbubbleDataLabelsAnimationOptions {
  55701. /**
  55702. * (Highcharts, Highstock, Highmaps, Gantt) The animation delay time in
  55703. * milliseconds. Set to `0` renders dataLabel immediately. As `undefined`
  55704. * inherits defer time from the series.animation.defer.
  55705. */
  55706. defer?: number;
  55707. }
  55708. /**
  55709. * (Highcharts, Highstock, Highmaps, Gantt) Options for the series data labels,
  55710. * appearing next to each data point.
  55711. *
  55712. * Since v6.2.0, multiple data labels can be applied to each single point by
  55713. * defining them as an array of configs.
  55714. *
  55715. * In styled mode, the data labels can be styled with the
  55716. * `.highcharts-data-label-box` and `.highcharts-data-label` class names (see
  55717. * example).
  55718. */
  55719. export interface PlotMapbubbleDataLabelsOptions {
  55720. /**
  55721. * (Highcharts, Highstock, Highmaps, Gantt) The alignment of the data label
  55722. * compared to the point. If `right`, the right side of the label should be
  55723. * touching the point. For points with an extent, like columns, the
  55724. * alignments also dictates how to align it inside the box, as given with
  55725. * the inside option. Can be one of `left`, `center` or `right`.
  55726. */
  55727. align?: (AlignValue|null);
  55728. /**
  55729. * (Highcharts, Highstock, Highmaps, Gantt) Whether to allow data labels to
  55730. * overlap. To make the labels less sensitive for overlapping, the
  55731. * dataLabels.padding can be set to 0.
  55732. */
  55733. allowOverlap?: boolean;
  55734. /**
  55735. * (Highcharts, Highstock, Highmaps, Gantt) Enable or disable the initial
  55736. * animation when a series is displayed for the `dataLabels`. The animation
  55737. * can also be set as a configuration object. Please note that this option
  55738. * only applies to the initial animation. For other animations, see
  55739. * chart.animation and the animation parameter under the API methods. The
  55740. * following properties are supported:
  55741. *
  55742. * - `defer`: The animation delay time in milliseconds.
  55743. */
  55744. animation?: (boolean|PlotMapbubbleDataLabelsAnimationOptions|Partial<AnimationOptionsObject>);
  55745. /**
  55746. * (Highcharts, Highstock, Highmaps, Gantt) The background color or gradient
  55747. * for the data label.
  55748. */
  55749. backgroundColor?: (ColorString|GradientColorObject|PatternObject);
  55750. /**
  55751. * (Highcharts, Highstock, Highmaps, Gantt) The border color for the data
  55752. * label. Defaults to `undefined`.
  55753. */
  55754. borderColor?: (ColorString|GradientColorObject|PatternObject);
  55755. /**
  55756. * (Highcharts, Highstock, Highmaps, Gantt) The border radius in pixels for
  55757. * the data label.
  55758. */
  55759. borderRadius?: number;
  55760. /**
  55761. * (Highcharts, Highstock, Highmaps, Gantt) The border width in pixels for
  55762. * the data label.
  55763. */
  55764. borderWidth?: number;
  55765. /**
  55766. * (Highcharts, Highstock, Highmaps, Gantt) A class name for the data label.
  55767. * Particularly in styled mode, this can be used to give each series' or
  55768. * point's data label unique styling. In addition to this option, a default
  55769. * color class name is added so that we can give the labels a contrast text
  55770. * shadow.
  55771. */
  55772. className?: string;
  55773. /**
  55774. * (Highcharts, Highstock, Highmaps, Gantt) The text color for the data
  55775. * labels. Defaults to `undefined`. For certain series types, like column or
  55776. * map, the data labels can be drawn inside the points. In this case the
  55777. * data label will be drawn with maximum contrast by default. Additionally,
  55778. * it will be given a `text-outline` style with the opposite color, to
  55779. * further increase the contrast. This can be overridden by setting the
  55780. * `text-outline` style to `none` in the `dataLabels.style` option.
  55781. */
  55782. color?: (ColorString|GradientColorObject|PatternObject);
  55783. /**
  55784. * (Highcharts, Highstock, Highmaps, Gantt) Whether to hide data labels that
  55785. * are outside the plot area. By default, the data label is moved inside the
  55786. * plot area according to the overflow option.
  55787. */
  55788. crop?: boolean;
  55789. /**
  55790. * (Highcharts, Highstock, Gantt) Whether to defer displaying the data
  55791. * labels until the initial series animation has finished. Setting to
  55792. * `false` renders the data label immediately. If set to `true` inherits the
  55793. * defer time set in plotOptions.series.animation.
  55794. */
  55795. defer?: boolean;
  55796. /**
  55797. * (Highcharts, Highstock, Highmaps, Gantt) Enable or disable the data
  55798. * labels.
  55799. */
  55800. enabled?: boolean;
  55801. /**
  55802. * (Highcharts, Highstock, Highmaps, Gantt) A declarative filter to control
  55803. * of which data labels to display. The declarative filter is designed for
  55804. * use when callback functions are not available, like when the chart
  55805. * options require a pure JSON structure or for use with graphical editors.
  55806. * For programmatic control, use the `formatter` instead, and return
  55807. * `undefined` to disable a single data label.
  55808. */
  55809. filter?: DataLabelsFilterOptionsObject;
  55810. /**
  55811. * (Highcharts, Highstock, Highmaps, Gantt) A format string for the data
  55812. * label. Available variables are the same as for `formatter`.
  55813. */
  55814. format?: string;
  55815. /**
  55816. * (Highcharts, Highstock, Highmaps, Gantt) Callback JavaScript function to
  55817. * format the data label. Note that if a `format` is defined, the format
  55818. * takes precedence and the formatter is ignored.
  55819. */
  55820. formatter?: DataLabelsFormatterCallbackFunction;
  55821. /**
  55822. * (Highcharts, Highstock, Highmaps, Gantt) For points with an extent, like
  55823. * columns or map areas, whether to align the data label inside the box or
  55824. * to the actual value point. Defaults to `false` in most cases, `true` in
  55825. * stacked columns.
  55826. */
  55827. inside?: boolean;
  55828. /**
  55829. * (Highcharts, Highstock, Highmaps, Gantt) Format for points with the value
  55830. * of null. Works analogously to format. `nullFormat` can be applied only to
  55831. * series which support displaying null points.
  55832. */
  55833. nullFormat?: (boolean|string);
  55834. /**
  55835. * (Highcharts, Highstock, Highmaps, Gantt) Callback JavaScript function
  55836. * that defines formatting for points with the value of null. Works
  55837. * analogously to formatter. `nullPointFormatter` can be applied only to
  55838. * series which support displaying null points.
  55839. */
  55840. nullFormatter?: DataLabelsFormatterCallbackFunction;
  55841. /**
  55842. * (Highcharts, Highstock, Highmaps, Gantt) How to handle data labels that
  55843. * flow outside the plot area. The default is `"justify"`, which aligns them
  55844. * inside the plot area. For columns and bars, this means it will be moved
  55845. * inside the bar. To display data labels outside the plot area, set `crop`
  55846. * to `false` and `overflow` to `"allow"`.
  55847. */
  55848. overflow?: DataLabelsOverflowValue;
  55849. /**
  55850. * (Highcharts, Highstock, Highmaps, Gantt) When either the `borderWidth` or
  55851. * the `backgroundColor` is set, this is the padding within the box.
  55852. */
  55853. padding?: number;
  55854. /**
  55855. * (Highcharts, Highstock, Highmaps, Gantt) Aligns data labels relative to
  55856. * points. If `center` alignment is not possible, it defaults to `right`.
  55857. */
  55858. position?: AlignValue;
  55859. /**
  55860. * (Highcharts, Highstock, Highmaps, Gantt) Text rotation in degrees. Note
  55861. * that due to a more complex structure, backgrounds, borders and padding
  55862. * will be lost on a rotated data label.
  55863. */
  55864. rotation?: number;
  55865. /**
  55866. * (Highcharts, Highstock, Highmaps, Gantt) The shadow of the box. Works
  55867. * best with `borderWidth` or `backgroundColor`. Since 2.3 the shadow can be
  55868. * an object configuration containing `color`, `offsetX`, `offsetY`,
  55869. * `opacity` and `width`.
  55870. */
  55871. shadow?: (boolean|ShadowOptionsObject);
  55872. /**
  55873. * (Highcharts, Highstock, Highmaps, Gantt) The name of a symbol to use for
  55874. * the border around the label. Symbols are predefined functions on the
  55875. * Renderer object.
  55876. */
  55877. shape?: string;
  55878. /**
  55879. * (Highcharts, Highstock, Highmaps, Gantt) Styles for the label. The
  55880. * default `color` setting is `"contrast"`, which is a pseudo color that
  55881. * Highcharts picks up and applies the maximum contrast to the underlying
  55882. * point item, for example the bar in a bar chart.
  55883. *
  55884. * The `textOutline` is a pseudo property that applies an outline of the
  55885. * given width with the given color, which by default is the maximum
  55886. * contrast to the text. So a bright text color will result in a black text
  55887. * outline for maximum readability on a mixed background. In some cases,
  55888. * especially with grayscale text, the text outline doesn't work well, in
  55889. * which cases it can be disabled by setting it to `"none"`. When `useHTML`
  55890. * is true, the `textOutline` will not be picked up. In this, case, the same
  55891. * effect can be acheived through the `text-shadow` CSS property.
  55892. *
  55893. * For some series types, where each point has an extent, like for example
  55894. * tree maps, the data label may overflow the point. There are two
  55895. * strategies for handling overflow. By default, the text will wrap to
  55896. * multiple lines. The other strategy is to set `style.textOverflow` to
  55897. * `ellipsis`, which will keep the text on one line plus it will break
  55898. * inside long words.
  55899. */
  55900. style?: CSSObject;
  55901. /**
  55902. * (Highcharts, Highstock, Highmaps, Gantt) Options for a label text which
  55903. * should follow marker's shape. Border and background are disabled for a
  55904. * label that follows a path.
  55905. *
  55906. * **Note:** Only SVG-based renderer supports this option. Setting `useHTML`
  55907. * to true will disable this option.
  55908. */
  55909. textPath?: DataLabelsTextPathOptionsObject;
  55910. /**
  55911. * (Highcharts, Highstock, Highmaps, Gantt) Whether to use HTML to render
  55912. * the labels.
  55913. */
  55914. useHTML?: boolean;
  55915. /**
  55916. * (Highcharts, Highstock, Highmaps, Gantt) The vertical alignment of a data
  55917. * label. Can be one of `top`, `middle` or `bottom`. The default value
  55918. * depends on the data, for instance in a column chart, the label is above
  55919. * positive values and below negative values.
  55920. */
  55921. verticalAlign?: string;
  55922. /**
  55923. * (Highcharts, Highstock, Highmaps, Gantt) The x position offset of the
  55924. * label relative to the point in pixels.
  55925. */
  55926. x?: number;
  55927. /**
  55928. * (Highcharts, Highstock, Highmaps, Gantt) The y position offset of the
  55929. * label relative to the point in pixels.
  55930. */
  55931. y?: number;
  55932. /**
  55933. * (Highcharts, Highstock, Highmaps, Gantt) The Z index of the data labels.
  55934. * The default Z index puts it above the series. Use a Z index of 2 to
  55935. * display it behind the series.
  55936. */
  55937. z?: number;
  55938. }
  55939. /**
  55940. * (Highcharts, Highstock) Options for the series data sorting.
  55941. */
  55942. export interface PlotMapbubbleDataSortingOptions {
  55943. /**
  55944. * (Highcharts, Highstock) Enable or disable data sorting for the series.
  55945. * Use xAxis.reversed to change the sorting order.
  55946. */
  55947. enabled?: boolean;
  55948. /**
  55949. * (Highcharts, Highstock) Whether to allow matching points by name in an
  55950. * update. If this option is disabled, points will be matched by order.
  55951. */
  55952. matchByName?: boolean;
  55953. /**
  55954. * (Highcharts, Highstock) Determines what data value should be used to sort
  55955. * by.
  55956. */
  55957. sortKey?: string;
  55958. }
  55959. /**
  55960. * (Highmaps) Style options for the guide box. The guide box has one state by
  55961. * default, the `default` state.
  55962. */
  55963. export interface PlotMapbubbleDragDropGuideBoxOptions {
  55964. /**
  55965. * (Highmaps) Style options for the guide box default state.
  55966. */
  55967. default?: DragDropGuideBoxOptionsObject;
  55968. }
  55969. /**
  55970. * (Highcharts, Highstock) Apply a jitter effect for the rendered markers. When
  55971. * plotting discrete values, a little random noise may help telling the points
  55972. * apart. The jitter setting applies a random displacement of up to `n` axis
  55973. * units in either direction. So for example on a horizontal X axis, setting the
  55974. * `jitter.x` to 0.24 will render the point in a random position between 0.24
  55975. * units to the left and 0.24 units to the right of the true axis position. On a
  55976. * category axis, setting it to 0.5 will fill up the bin and make the data
  55977. * appear continuous.
  55978. *
  55979. * When rendered on top of a box plot or a column series, a jitter value of 0.24
  55980. * will correspond to the underlying series' default groupPadding and
  55981. * pointPadding settings.
  55982. */
  55983. export interface PlotMapbubbleJitterOptions {
  55984. /**
  55985. * (Highcharts, Highstock) The maximal X offset for the random jitter
  55986. * effect.
  55987. */
  55988. x?: number;
  55989. /**
  55990. * (Highcharts, Highstock) The maximal Y offset for the random jitter
  55991. * effect.
  55992. */
  55993. y?: number;
  55994. }
  55995. /**
  55996. * (Highmaps) A map bubble series is a bubble series laid out on top of a map
  55997. * series, where each bubble is tied to a specific map area.
  55998. *
  55999. * In TypeScript the type option must always be set.
  56000. *
  56001. * Configuration options for the series are given in three levels:
  56002. *
  56003. * 1. Options for all series in a chart are defined in the plotOptions.series
  56004. * object.
  56005. *
  56006. * 2. Options for all `mapbubble` series are defined in plotOptions.mapbubble.
  56007. *
  56008. * 3. Options for one single series are given in the series instance array. (see
  56009. * online documentation for example)
  56010. */
  56011. export interface PlotMapbubbleOptions {
  56012. /**
  56013. * (Highmaps) Accessibility options for a series.
  56014. */
  56015. accessibility?: SeriesAccessibilityOptionsObject;
  56016. /**
  56017. * (Highmaps) Whether all areas of the map defined in `mapData` should be
  56018. * rendered. If `true`, areas which don't correspond to a data point, are
  56019. * rendered as `null` points. If `false`, those areas are skipped.
  56020. */
  56021. allAreas?: boolean;
  56022. /**
  56023. * (Highmaps) Allow this series' points to be selected by clicking on the
  56024. * graphic (columns, point markers, pie slices, map areas etc).
  56025. *
  56026. * The selected points can be handled by point select and unselect events,
  56027. * or collectively by the getSelectedPoints function.
  56028. *
  56029. * And alternative way of selecting points is through dragging.
  56030. */
  56031. allowPointSelect?: boolean;
  56032. /**
  56033. * (Highmaps) Enable or disable the initial animation when a series is
  56034. * displayed. The animation can also be set as a configuration object.
  56035. * Please note that this option only applies to the initial animation of the
  56036. * series itself. For other animations, see chart.animation and the
  56037. * animation parameter under the API methods. The following properties are
  56038. * supported:
  56039. *
  56040. * - `defer`: The animation delay time in milliseconds.
  56041. *
  56042. * - `duration`: The duration of the animation in milliseconds.
  56043. *
  56044. * - `easing`: Can be a string reference to an easing function set on the
  56045. * `Math` object or a function. See the _Custom easing function_ demo below.
  56046. *
  56047. * Due to poor performance, animation is disabled in old IE browsers for
  56048. * several chart types.
  56049. */
  56050. animation?: (boolean|PlotMapbubbleAnimationOptions|Partial<AnimationOptionsObject>);
  56051. /**
  56052. * (Highmaps) If there are more points in the series than the
  56053. * `animationLimit`, the animation won't run. Animation affects overall
  56054. * performance and doesn't work well with heavy data series.
  56055. */
  56056. animationLimit?: number;
  56057. /**
  56058. * (Highmaps) Sets the color blending in the boost module.
  56059. */
  56060. boostBlending?: OptionsBoostBlendingValue;
  56061. /**
  56062. * (Highmaps) Set the point threshold for when a series should enter boost
  56063. * mode.
  56064. *
  56065. * Setting it to e.g. 2000 will cause the series to enter boost mode when
  56066. * there are 2000 or more points in the series.
  56067. *
  56068. * To disable boosting on the series, set the `boostThreshold` to 0. Setting
  56069. * it to 1 will force boosting.
  56070. *
  56071. * Note that the cropThreshold also affects this setting. When zooming in on
  56072. * a series that has fewer points than the `cropThreshold`, all points are
  56073. * rendered although outside the visible plot area, and the `boostThreshold`
  56074. * won't take effect.
  56075. */
  56076. boostThreshold?: number;
  56077. /**
  56078. * (Highmaps) The border color of the map areas.
  56079. *
  56080. * In styled mode, the border stroke is given in the `.highcharts-point`
  56081. * class.
  56082. */
  56083. borderColor?: (ColorString|GradientColorObject|PatternObject);
  56084. /**
  56085. * (Highmaps) The border width of each map area.
  56086. *
  56087. * In styled mode, the border stroke width is given in the
  56088. * `.highcharts-point` class.
  56089. */
  56090. borderWidth?: number;
  56091. /**
  56092. * (Highmaps) An additional class name to apply to the series' graphical
  56093. * elements. This option does not replace default class names of the
  56094. * graphical element.
  56095. */
  56096. className?: string;
  56097. /**
  56098. * (Highmaps) Disable this option to allow series rendering in the whole
  56099. * plotting area.
  56100. *
  56101. * **Note:** Clipping should be always enabled when chart.zoomType is set
  56102. */
  56103. clip?: boolean;
  56104. /**
  56105. * (Highmaps) The main color of the series. This color affects both the fill
  56106. * and the stroke of the bubble. For enhanced control, use `marker` options.
  56107. */
  56108. color?: (ColorString|GradientColorObject|PatternObject);
  56109. /**
  56110. * (Highcharts, Highstock, Highmaps) When using dual or multiple color axes,
  56111. * this number defines which colorAxis the particular series is connected
  56112. * to. It refers to either the axis id or the index of the axis in the
  56113. * colorAxis array, with 0 being the first. Set this option to false to
  56114. * prevent a series from connecting to the default color axis.
  56115. *
  56116. * Since v7.2.0 the option can also be an axis id or an axis index instead
  56117. * of a boolean flag.
  56118. */
  56119. colorAxis?: (boolean|number|string);
  56120. /**
  56121. * (Highmaps) Styled mode only. A specific color index to use for the
  56122. * series, so its graphic representations are given the class name
  56123. * `highcharts-color-{n}`.
  56124. */
  56125. colorIndex?: number;
  56126. /**
  56127. * (Highcharts, Highstock, Highmaps) Determines what data value should be
  56128. * used to calculate point color if `colorAxis` is used. Requires to set
  56129. * `min` and `max` if some custom point property is used or if approximation
  56130. * for data grouping is set to `'sum'`.
  56131. */
  56132. colorKey?: string;
  56133. /**
  56134. * (Highstock) Compare the values of the series against the first non-null,
  56135. * non- zero value in the visible range. The y axis will show percentage or
  56136. * absolute change depending on whether `compare` is set to `"percent"` or
  56137. * `"value"`. When this is applied to multiple series, it allows comparing
  56138. * the development of the series against each other. Adds a `change` field
  56139. * to every point object.
  56140. */
  56141. compare?: string;
  56142. /**
  56143. * (Highstock) When compare is `percent`, this option dictates whether to
  56144. * use 0 or 100 as the base of comparison.
  56145. */
  56146. compareBase?: (0|100);
  56147. /**
  56148. * (Highstock) Defines if comparison should start from the first point
  56149. * within the visible range or should start from the first point **before**
  56150. * the range.
  56151. *
  56152. * In other words, this flag determines if first point within the visible
  56153. * range will have 0% (`compareStart=true`) or should have been already
  56154. * calculated according to the previous point (`compareStart=false`).
  56155. */
  56156. compareStart?: boolean;
  56157. /**
  56158. * (Highcharts) Polar charts only. Whether to connect the ends of a line
  56159. * series plot across the extremes.
  56160. */
  56161. connectEnds?: boolean;
  56162. /**
  56163. * (Highcharts, Highstock) Whether to connect a graph line across null
  56164. * points, or render a gap between the two points on either side of the
  56165. * null.
  56166. */
  56167. connectNulls?: boolean;
  56168. /**
  56169. * (Gantt) Override Pathfinder connector options for a series. Requires
  56170. * Highcharts Gantt to be loaded.
  56171. */
  56172. connectors?: SeriesConnectorsOptionsObject;
  56173. /**
  56174. * (Highcharts, Highstock, Gantt) When true, each point or column edge is
  56175. * rounded to its nearest pixel in order to render sharp on screen. In some
  56176. * cases, when there are a lot of densely packed columns, this leads to
  56177. * visible difference in column widths or distance between columns. In these
  56178. * cases, setting `crisp` to `false` may look better, even though each
  56179. * column is rendered blurry.
  56180. */
  56181. crisp?: boolean;
  56182. /**
  56183. * (Highmaps) You can set the cursor to "pointer" if you have click events
  56184. * attached to the series, to signal to the user that the points and lines
  56185. * can be clicked.
  56186. *
  56187. * In styled mode, the series cursor can be set with the same classes as
  56188. * listed under series.color.
  56189. */
  56190. cursor?: (string|CursorValue);
  56191. /**
  56192. * (Highmaps) A reserved subspace to store options and values for customized
  56193. * functionality. Here you can add additional data for your own event
  56194. * callbacks and formatter callbacks.
  56195. */
  56196. custom?: Dictionary<any>;
  56197. /**
  56198. * (Highmaps) Name of the dash style to use for the graph, or for some
  56199. * series types the outline of each shape.
  56200. *
  56201. * In styled mode, the stroke dash-array can be set with the same classes as
  56202. * listed under series.color.
  56203. */
  56204. dashStyle?: DashStyleValue;
  56205. /**
  56206. * (Highstock) Data grouping is the concept of sampling the data values into
  56207. * larger blocks in order to ease readability and increase performance of
  56208. * the JavaScript charts. Highstock by default applies data grouping when
  56209. * the points become closer than a certain pixel value, determined by the
  56210. * `groupPixelWidth` option.
  56211. *
  56212. * If data grouping is applied, the grouping information of grouped points
  56213. * can be read from the Point.dataGroup. If point options other than the
  56214. * data itself are set, for example `name` or `color` or custom properties,
  56215. * the grouping logic doesn't know how to group it. In this case the options
  56216. * of the first point instance are copied over to the group point. This can
  56217. * be altered through a custom `approximation` callback function.
  56218. */
  56219. dataGrouping?: DataGroupingOptionsObject;
  56220. /**
  56221. * (Highcharts, Highstock, Highmaps, Gantt) Options for the series data
  56222. * labels, appearing next to each data point.
  56223. *
  56224. * Since v6.2.0, multiple data labels can be applied to each single point by
  56225. * defining them as an array of configs.
  56226. *
  56227. * In styled mode, the data labels can be styled with the
  56228. * `.highcharts-data-label-box` and `.highcharts-data-label` class names
  56229. * (see example).
  56230. */
  56231. dataLabels?: (PlotMapbubbleDataLabelsOptions|Array<PlotMapbubbleDataLabelsOptions>);
  56232. /**
  56233. * (Highcharts, Highstock) Options for the series data sorting.
  56234. */
  56235. dataSorting?: (DataSortingOptionsObject|PlotMapbubbleDataSortingOptions);
  56236. /**
  56237. * (Highmaps) A description of the series to add to the screen reader
  56238. * information about the series.
  56239. */
  56240. description?: string;
  56241. /**
  56242. * (Highmaps) Whether to display negative sized bubbles. The threshold is
  56243. * given by the zThreshold option, and negative bubbles can be visualized by
  56244. * setting negativeColor.
  56245. */
  56246. displayNegative?: boolean;
  56247. /**
  56248. * (Highmaps) The draggable-points module allows points to be moved around
  56249. * or modified in the chart. In addition to the options mentioned under the
  56250. * `dragDrop` API structure, the module fires three events, point.dragStart,
  56251. * point.drag and point.drop.
  56252. */
  56253. dragDrop?: SeriesDragDropOptionsObject;
  56254. /**
  56255. * (Highmaps) Enable or disable the mouse tracking for a specific series.
  56256. * This includes point tooltips and click events on graphs and points. For
  56257. * large datasets it improves performance.
  56258. */
  56259. enableMouseTracking?: boolean;
  56260. /**
  56261. * (Highmaps) General event handlers for the series items. These event hooks
  56262. * can also be attached to the series at run time using the
  56263. * `Highcharts.addEvent` function.
  56264. */
  56265. events?: SeriesEventsOptionsObject;
  56266. /**
  56267. * (Highmaps) Determines whether the series should look for the nearest
  56268. * point in both dimensions or just the x-dimension when hovering the
  56269. * series. Defaults to `'xy'` for scatter series and `'x'` for most other
  56270. * series. If the data has duplicate x-values, it is recommended to set this
  56271. * to `'xy'` to allow hovering over all points.
  56272. *
  56273. * Applies only to series types using nearest neighbor search (not direct
  56274. * hover) for tooltip.
  56275. */
  56276. findNearestPointBy?: OptionsFindNearestPointByValue;
  56277. /**
  56278. * (Highstock) Defines when to display a gap in the graph, together with the
  56279. * gapUnit option.
  56280. *
  56281. * In case when `dataGrouping` is enabled, points can be grouped into a
  56282. * larger time span. This can make the grouped points to have a greater
  56283. * distance than the absolute value of `gapSize` property, which will result
  56284. * in disappearing graph completely. To prevent this situation the mentioned
  56285. * distance between grouped points is used instead of previously defined
  56286. * `gapSize`.
  56287. *
  56288. * In practice, this option is most often used to visualize gaps in time
  56289. * series. In a stock chart, intraday data is available for daytime hours,
  56290. * while gaps will appear in nights and weekends.
  56291. */
  56292. gapSize?: number;
  56293. /**
  56294. * (Highstock) Together with gapSize, this option defines where to draw gaps
  56295. * in the graph.
  56296. *
  56297. * When the `gapUnit` is `"relative"` (default), a gap size of 5 means that
  56298. * if the distance between two points is greater than 5 times that of the
  56299. * two closest points, the graph will be broken.
  56300. *
  56301. * When the `gapUnit` is `"value"`, the gap is based on absolute axis
  56302. * values, which on a datetime axis is milliseconds. This also applies to
  56303. * the navigator series that inherits gap options from the base series.
  56304. */
  56305. gapUnit?: OptionsGapUnitValue;
  56306. /**
  56307. * (Highcharts, Highstock, Gantt) Whether to use the Y extremes of the total
  56308. * chart width or only the zoomed area when zooming in on parts of the X
  56309. * axis. By default, the Y axis adjusts to the min and max of the visible
  56310. * data. Cartesian series only.
  56311. */
  56312. getExtremesFromAll?: boolean;
  56313. /**
  56314. * (Highmaps) When set to `false` will prevent the series data from being
  56315. * included in any form of data export.
  56316. *
  56317. * Since version 6.0.0 until 7.1.0 the option was existing undocumented as
  56318. * `includeInCSVExport`.
  56319. */
  56320. includeInDataExport?: boolean;
  56321. /**
  56322. * (Highcharts, Highstock) Apply a jitter effect for the rendered markers.
  56323. * When plotting discrete values, a little random noise may help telling the
  56324. * points apart. The jitter setting applies a random displacement of up to
  56325. * `n` axis units in either direction. So for example on a horizontal X
  56326. * axis, setting the `jitter.x` to 0.24 will render the point in a random
  56327. * position between 0.24 units to the left and 0.24 units to the right of
  56328. * the true axis position. On a category axis, setting it to 0.5 will fill
  56329. * up the bin and make the data appear continuous.
  56330. *
  56331. * When rendered on top of a box plot or a column series, a jitter value of
  56332. * 0.24 will correspond to the underlying series' default groupPadding and
  56333. * pointPadding settings.
  56334. */
  56335. jitter?: PlotMapbubbleJitterOptions;
  56336. /**
  56337. * (Highmaps) What property to join the `mapData` to the value data. For
  56338. * example, if joinBy is "code", the mapData items with a specific code is
  56339. * merged into the data with the same code. For maps loaded from GeoJSON,
  56340. * the keys may be held in each point's `properties` object.
  56341. *
  56342. * The joinBy option can also be an array of two values, where the first
  56343. * points to a key in the `mapData`, and the second points to another key in
  56344. * the `data`.
  56345. *
  56346. * When joinBy is `null`, the map items are joined by their position in the
  56347. * array, which performs much better in maps with many data points. This is
  56348. * the recommended option if you are printing more than a thousand data
  56349. * points and have a backend that can preprocess the data into a parallel
  56350. * array of the mapData.
  56351. */
  56352. joinBy?: (string|Array<string>);
  56353. /**
  56354. * (Highmaps) An array specifying which option maps to which key in the data
  56355. * point array. This makes it convenient to work with unstructured data
  56356. * arrays from different sources.
  56357. */
  56358. keys?: Array<string>;
  56359. /**
  56360. * (Highcharts, Highstock, Gantt) Series labels are placed as close to the
  56361. * series as possible in a natural way, seeking to avoid other series. The
  56362. * goal of this feature is to make the chart more easily readable, like if a
  56363. * human designer placed the labels in the optimal position.
  56364. *
  56365. * The series labels currently work with series types having a `graph` or an
  56366. * `area`.
  56367. */
  56368. label?: SeriesLabelOptionsObject;
  56369. /**
  56370. * (Highstock) The line marks the last price from all points.
  56371. */
  56372. lastPrice?: SeriesLastPriceOptionsObject;
  56373. /**
  56374. * (Highstock) The line marks the last price from visible range of points.
  56375. */
  56376. lastVisiblePrice?: SeriesLastVisiblePriceOptionsObject;
  56377. /**
  56378. * (Highcharts, Highstock) The SVG value used for the `stroke-linecap` and
  56379. * `stroke-linejoin` of a line graph. Round means that lines are rounded in
  56380. * the ends and bends.
  56381. */
  56382. linecap?: SeriesLinecapValue;
  56383. /**
  56384. * (Highcharts, Highstock) The width of the line connecting the data points.
  56385. */
  56386. lineWidth?: number;
  56387. /**
  56388. * (Highcharts, Highstock, Gantt) The id of another series to link to.
  56389. * Additionally, the value can be ":previous" to link to the previous
  56390. * series. When two series are linked, only the first one appears in the
  56391. * legend. Toggling the visibility of this also toggles the linked series.
  56392. *
  56393. * If master series uses data sorting and linked series does not have its
  56394. * own sorting definition, the linked series will be sorted in the same
  56395. * order as the master one.
  56396. */
  56397. linkedTo?: string;
  56398. /**
  56399. * (Highmaps) Options for the point markers of line-like series. Properties
  56400. * like `fillColor`, `lineColor` and `lineWidth` define the visual
  56401. * appearance of the markers. Other series types, like column series, don't
  56402. * have markers, but have visual options on the series level instead.
  56403. *
  56404. * In styled mode, the markers can be styled with the `.highcharts-point`,
  56405. * `.highcharts-point-hover` and `.highcharts-point-select` class names.
  56406. */
  56407. marker?: PointMarkerOptionsObject;
  56408. /**
  56409. * (Highcharts, Highstock) Maximum bubble size. Bubbles will automatically
  56410. * size between the `minSize` and `maxSize` to reflect the `z` value of each
  56411. * bubble. Can be either pixels (when no unit is given), or a percentage of
  56412. * the smallest one of the plot width and height.
  56413. */
  56414. maxSize?: (number|string);
  56415. /**
  56416. * (Highcharts, Highstock) Minimum bubble size. Bubbles will automatically
  56417. * size between the `minSize` and `maxSize` to reflect the `z` value of each
  56418. * bubble. Can be either pixels (when no unit is given), or a percentage of
  56419. * the smallest one of the plot width and height.
  56420. */
  56421. minSize?: (number|string);
  56422. /**
  56423. * (Highstock) Options for the corresponding navigator series if
  56424. * `showInNavigator` is `true` for this series. Available options are the
  56425. * same as any series, documented at plotOptions and series.
  56426. *
  56427. * These options are merged with options in navigator.series, and will take
  56428. * precedence if the same option is defined both places.
  56429. */
  56430. navigatorOptions?: PlotSeriesOptions;
  56431. /**
  56432. * (Highcharts) When a point's Z value is below the zThreshold setting, this
  56433. * color is used.
  56434. */
  56435. negativeColor?: (ColorString|GradientColorObject|PatternObject);
  56436. /**
  56437. * (Highmaps) Opacity of a series parts: line, fill (e.g. area) and
  56438. * dataLabels.
  56439. */
  56440. opacity?: number;
  56441. /**
  56442. * (Highmaps) Properties for each single point.
  56443. */
  56444. point?: PlotSeriesPointOptions;
  56445. /**
  56446. * (Highmaps) Same as accessibility.pointDescriptionFormatter, but for an
  56447. * individual series. Overrides the chart wide configuration.
  56448. */
  56449. pointDescriptionFormatter?: Function;
  56450. /**
  56451. * (Highcharts, Highstock, Gantt) If no x values are given for the points in
  56452. * a series, `pointInterval` defines the interval of the x values. For
  56453. * example, if a series contains one value every decade starting from year
  56454. * 0, set `pointInterval` to `10`. In true `datetime` axes, the
  56455. * `pointInterval` is set in milliseconds.
  56456. *
  56457. * It can be also be combined with `pointIntervalUnit` to draw irregular
  56458. * time intervals.
  56459. *
  56460. * Please note that this options applies to the _series data_, not the
  56461. * interval of the axis ticks, which is independent.
  56462. */
  56463. pointInterval?: number;
  56464. /**
  56465. * (Highcharts, Highstock, Gantt) On datetime series, this allows for
  56466. * setting the pointInterval to irregular time units, `day`, `month` and
  56467. * `year`. A day is usually the same as 24 hours, but `pointIntervalUnit`
  56468. * also takes the DST crossover into consideration when dealing with local
  56469. * time. Combine this option with `pointInterval` to draw weeks, quarters, 6
  56470. * months, 10 years etc.
  56471. *
  56472. * Please note that this options applies to the _series data_, not the
  56473. * interval of the axis ticks, which is independent.
  56474. */
  56475. pointIntervalUnit?: OptionsPointIntervalUnitValue;
  56476. /**
  56477. * (Highstock) The width of each point on the x axis. For example in a
  56478. * column chart with one value each day, the pointRange would be 1 day (= 24
  56479. * * 3600
  56480. *
  56481. * * 1000 milliseconds). This is normally computed automatically, but this
  56482. * option can be used to override the automatic value.
  56483. */
  56484. pointRange?: number;
  56485. /**
  56486. * (Highcharts, Highstock, Gantt) If no x values are given for the points in
  56487. * a series, pointStart defines on what value to start. For example, if a
  56488. * series contains one yearly value starting from 1945, set pointStart to
  56489. * 1945.
  56490. */
  56491. pointStart?: number;
  56492. /**
  56493. * (Highmaps) Whether to select the series initially. If `showCheckbox` is
  56494. * true, the checkbox next to the series name in the legend will be checked
  56495. * for a selected series.
  56496. */
  56497. selected?: boolean;
  56498. /**
  56499. * (Highmaps) If true, a checkbox is displayed next to the legend item to
  56500. * allow selecting the series. The state of the checkbox is determined by
  56501. * the `selected` option.
  56502. */
  56503. showCheckbox?: boolean;
  56504. /**
  56505. * (Highmaps) Whether to display this particular series or series type in
  56506. * the legend. Standalone series are shown in legend by default, and linked
  56507. * series are not. Since v7.2.0 it is possible to show series that use
  56508. * colorAxis by setting this option to `true`.
  56509. */
  56510. showInLegend?: boolean;
  56511. /**
  56512. * (Highstock) Whether or not to show the series in the navigator. Takes
  56513. * precedence over navigator.baseSeries if defined.
  56514. */
  56515. showInNavigator?: boolean;
  56516. /**
  56517. * (Highmaps) Whether the bubble's value should be represented by the area
  56518. * or the width of the bubble. The default, `area`, corresponds best to the
  56519. * human perception of the size of each bubble.
  56520. */
  56521. sizeBy?: BubbleSizeByValue;
  56522. /**
  56523. * (Highcharts) When this is true, the absolute value of z determines the
  56524. * size of the bubble. This means that with the default `zThreshold` of 0, a
  56525. * bubble of value -1 will have the same size as a bubble of value 1, while
  56526. * a bubble of value 0 will have a smaller size according to `minSize`.
  56527. */
  56528. sizeByAbsoluteValue?: boolean;
  56529. /**
  56530. * (Highmaps) If set to `true`, the accessibility module will skip past the
  56531. * points in this series for keyboard navigation.
  56532. */
  56533. skipKeyboardNavigation?: boolean;
  56534. /**
  56535. * (Highcharts) When this is true, the series will not cause the Y axis to
  56536. * cross the zero plane (or threshold option) unless the data actually
  56537. * crosses the plane.
  56538. *
  56539. * For example, if `softThreshold` is `false`, a series of 0, 1, 2, 3 will
  56540. * make the Y axis show negative values according to the `minPadding`
  56541. * option. If `softThreshold` is `true`, the Y axis starts at 0.
  56542. */
  56543. softThreshold?: boolean;
  56544. /**
  56545. * (Highcharts, Highstock) Whether to stack the values of each series on top
  56546. * of each other. Possible values are `undefined` to disable, `"normal"` to
  56547. * stack by value or `"percent"`.
  56548. *
  56549. * When stacking is enabled, data must be sorted in ascending X order.
  56550. *
  56551. * Some stacking options are related to specific series types. In the
  56552. * streamgraph series type, the stacking option is set to `"stream"`. The
  56553. * second one is `"overlap"`, which only applies to waterfall series.
  56554. */
  56555. stacking?: OptionsStackingValue;
  56556. states?: SeriesStatesOptionsObject;
  56557. /**
  56558. * (Highcharts, Highstock) Whether to apply steps to the line. Possible
  56559. * values are `left`, `center` and `right`.
  56560. */
  56561. step?: OptionsStepValue;
  56562. /**
  56563. * (Highcharts, Highstock) Sticky tracking of mouse events. When true, the
  56564. * `mouseOut` event on a series isn't triggered until the mouse moves over
  56565. * another series, or out of the plot area. When false, the `mouseOut` event
  56566. * on a series is triggered when the mouse leaves the area around the
  56567. * series' graph or markers. This also implies the tooltip. When
  56568. * `stickyTracking` is false and `tooltip.shared` is false, the tooltip will
  56569. * be hidden when moving the mouse between series.
  56570. */
  56571. stickyTracking?: boolean;
  56572. /**
  56573. * (Highcharts, Highstock) The threshold, also called zero level or base
  56574. * level. For line type series this is only used in conjunction with
  56575. * negativeColor.
  56576. */
  56577. threshold?: (number|null);
  56578. /**
  56579. * (Highcharts, Highstock) A configuration object for the tooltip rendering
  56580. * of each single series. Properties are inherited from tooltip. Overridable
  56581. * properties are `headerFormat`, `pointFormat`, `yDecimals`, `xDateFormat`,
  56582. * `yPrefix` and `ySuffix`. Unlike other series, in a scatter plot the
  56583. * series.name by default shows in the headerFormat and point.x and point.y
  56584. * in the pointFormat.
  56585. */
  56586. tooltip?: SeriesTooltipOptionsObject;
  56587. /**
  56588. * (Highcharts, Highstock, Gantt) When a series contains a data array that
  56589. * is longer than this, only one dimensional arrays of numbers, or two
  56590. * dimensional arrays with x and y values are allowed. Also, only the first
  56591. * point is tested, and the rest are assumed to be the same format. This
  56592. * saves expensive data checking and indexing in long series. Set it to `0`
  56593. * disable.
  56594. *
  56595. * Note: In boost mode turbo threshold is forced. Only array of numbers or
  56596. * two dimensional arrays are allowed.
  56597. */
  56598. turboThreshold?: number;
  56599. /**
  56600. * (Highmaps) Set the initial visibility of the series.
  56601. */
  56602. visible?: boolean;
  56603. /**
  56604. * (Highmaps) Define the z index of the series.
  56605. */
  56606. zIndex?: number;
  56607. /**
  56608. * (Highcharts) The minimum for the Z value range. Defaults to the highest Z
  56609. * value in the data.
  56610. */
  56611. zMax?: number;
  56612. /**
  56613. * (Highcharts) The minimum for the Z value range. Defaults to the lowest Z
  56614. * value in the data.
  56615. */
  56616. zMin?: number;
  56617. /**
  56618. * (Highcharts, Highstock) Defines the Axis on which the zones are applied.
  56619. */
  56620. zoneAxis?: string;
  56621. /**
  56622. * (Highcharts, Highstock) An array defining zones within a series. Zones
  56623. * can be applied to the X axis, Y axis or Z axis for bubbles, according to
  56624. * the `zoneAxis` option. The zone definitions have to be in ascending order
  56625. * regarding to the value.
  56626. *
  56627. * In styled mode, the color zones are styled with the
  56628. * `.highcharts-zone-{n}` class, or custom classed from the `className`
  56629. * option (view live demo).
  56630. */
  56631. zones?: Array<SeriesZonesOptionsObject>;
  56632. /**
  56633. * (Highcharts) When displayNegative is `false`, bubbles with lower Z values
  56634. * are skipped. When `displayNegative` is `true` and a negativeColor is
  56635. * given, points with lower Z is colored.
  56636. */
  56637. zThreshold?: number;
  56638. }
  56639. /**
  56640. * (Highcharts, Highstock, Highmaps, Gantt) Enable or disable the initial
  56641. * animation when a series is displayed for the `dataLabels`. The animation can
  56642. * also be set as a configuration object. Please note that this option only
  56643. * applies to the initial animation. For other animations, see chart.animation
  56644. * and the animation parameter under the API methods. The following properties
  56645. * are supported:
  56646. *
  56647. * - `defer`: The animation delay time in milliseconds.
  56648. */
  56649. export interface PlotMapDataLabelsAnimationOptions {
  56650. /**
  56651. * (Highcharts, Highstock, Highmaps, Gantt) The animation delay time in
  56652. * milliseconds. Set to `0` renders dataLabel immediately. As `undefined`
  56653. * inherits defer time from the series.animation.defer.
  56654. */
  56655. defer?: number;
  56656. }
  56657. /**
  56658. * (Highcharts, Highstock, Highmaps, Gantt) Options for the series data labels,
  56659. * appearing next to each data point.
  56660. *
  56661. * Since v6.2.0, multiple data labels can be applied to each single point by
  56662. * defining them as an array of configs.
  56663. *
  56664. * In styled mode, the data labels can be styled with the
  56665. * `.highcharts-data-label-box` and `.highcharts-data-label` class names (see
  56666. * example).
  56667. */
  56668. export interface PlotMapDataLabelsOptions {
  56669. /**
  56670. * (Highcharts, Highstock, Highmaps, Gantt) The alignment of the data label
  56671. * compared to the point. If `right`, the right side of the label should be
  56672. * touching the point. For points with an extent, like columns, the
  56673. * alignments also dictates how to align it inside the box, as given with
  56674. * the inside option. Can be one of `left`, `center` or `right`.
  56675. */
  56676. align?: (AlignValue|null);
  56677. /**
  56678. * (Highcharts, Highstock, Highmaps, Gantt) Whether to allow data labels to
  56679. * overlap. To make the labels less sensitive for overlapping, the
  56680. * dataLabels.padding can be set to 0.
  56681. */
  56682. allowOverlap?: boolean;
  56683. /**
  56684. * (Highcharts, Highstock, Highmaps, Gantt) Enable or disable the initial
  56685. * animation when a series is displayed for the `dataLabels`. The animation
  56686. * can also be set as a configuration object. Please note that this option
  56687. * only applies to the initial animation. For other animations, see
  56688. * chart.animation and the animation parameter under the API methods. The
  56689. * following properties are supported:
  56690. *
  56691. * - `defer`: The animation delay time in milliseconds.
  56692. */
  56693. animation?: (boolean|PlotMapDataLabelsAnimationOptions|Partial<AnimationOptionsObject>);
  56694. /**
  56695. * (Highcharts, Highstock, Highmaps, Gantt) The background color or gradient
  56696. * for the data label.
  56697. */
  56698. backgroundColor?: (ColorString|GradientColorObject|PatternObject);
  56699. /**
  56700. * (Highcharts, Highstock, Highmaps, Gantt) The border color for the data
  56701. * label. Defaults to `undefined`.
  56702. */
  56703. borderColor?: (ColorString|GradientColorObject|PatternObject);
  56704. /**
  56705. * (Highcharts, Highstock, Highmaps, Gantt) The border radius in pixels for
  56706. * the data label.
  56707. */
  56708. borderRadius?: number;
  56709. /**
  56710. * (Highcharts, Highstock, Highmaps, Gantt) The border width in pixels for
  56711. * the data label.
  56712. */
  56713. borderWidth?: number;
  56714. /**
  56715. * (Highcharts, Highstock, Highmaps, Gantt) A class name for the data label.
  56716. * Particularly in styled mode, this can be used to give each series' or
  56717. * point's data label unique styling. In addition to this option, a default
  56718. * color class name is added so that we can give the labels a contrast text
  56719. * shadow.
  56720. */
  56721. className?: string;
  56722. /**
  56723. * (Highcharts, Highstock, Highmaps, Gantt) The text color for the data
  56724. * labels. Defaults to `undefined`. For certain series types, like column or
  56725. * map, the data labels can be drawn inside the points. In this case the
  56726. * data label will be drawn with maximum contrast by default. Additionally,
  56727. * it will be given a `text-outline` style with the opposite color, to
  56728. * further increase the contrast. This can be overridden by setting the
  56729. * `text-outline` style to `none` in the `dataLabels.style` option.
  56730. */
  56731. color?: (ColorString|GradientColorObject|PatternObject);
  56732. /**
  56733. * (Highcharts, Highstock, Highmaps, Gantt) Whether to hide data labels that
  56734. * are outside the plot area. By default, the data label is moved inside the
  56735. * plot area according to the overflow option.
  56736. */
  56737. crop?: boolean;
  56738. /**
  56739. * (Highcharts, Highstock, Gantt) Whether to defer displaying the data
  56740. * labels until the initial series animation has finished. Setting to
  56741. * `false` renders the data label immediately. If set to `true` inherits the
  56742. * defer time set in plotOptions.series.animation.
  56743. */
  56744. defer?: boolean;
  56745. /**
  56746. * (Highcharts, Highstock, Highmaps, Gantt) Enable or disable the data
  56747. * labels.
  56748. */
  56749. enabled?: boolean;
  56750. /**
  56751. * (Highcharts, Highstock, Highmaps, Gantt) A declarative filter to control
  56752. * of which data labels to display. The declarative filter is designed for
  56753. * use when callback functions are not available, like when the chart
  56754. * options require a pure JSON structure or for use with graphical editors.
  56755. * For programmatic control, use the `formatter` instead, and return
  56756. * `undefined` to disable a single data label.
  56757. */
  56758. filter?: DataLabelsFilterOptionsObject;
  56759. /**
  56760. * (Highcharts, Highstock, Highmaps, Gantt) A format string for the data
  56761. * label. Available variables are the same as for `formatter`.
  56762. */
  56763. format?: string;
  56764. /**
  56765. * (Highcharts, Highstock, Highmaps, Gantt) Callback JavaScript function to
  56766. * format the data label. Note that if a `format` is defined, the format
  56767. * takes precedence and the formatter is ignored.
  56768. */
  56769. formatter?: DataLabelsFormatterCallbackFunction;
  56770. /**
  56771. * (Highcharts, Highstock, Highmaps, Gantt) For points with an extent, like
  56772. * columns or map areas, whether to align the data label inside the box or
  56773. * to the actual value point. Defaults to `false` in most cases, `true` in
  56774. * stacked columns.
  56775. */
  56776. inside?: boolean;
  56777. /**
  56778. * (Highcharts, Highstock, Highmaps, Gantt) Format for points with the value
  56779. * of null. Works analogously to format. `nullFormat` can be applied only to
  56780. * series which support displaying null points.
  56781. */
  56782. nullFormat?: (boolean|string);
  56783. /**
  56784. * (Highcharts, Highstock, Highmaps, Gantt) Callback JavaScript function
  56785. * that defines formatting for points with the value of null. Works
  56786. * analogously to formatter. `nullPointFormatter` can be applied only to
  56787. * series which support displaying null points.
  56788. */
  56789. nullFormatter?: DataLabelsFormatterCallbackFunction;
  56790. /**
  56791. * (Highcharts, Highstock, Highmaps, Gantt) How to handle data labels that
  56792. * flow outside the plot area. The default is `"justify"`, which aligns them
  56793. * inside the plot area. For columns and bars, this means it will be moved
  56794. * inside the bar. To display data labels outside the plot area, set `crop`
  56795. * to `false` and `overflow` to `"allow"`.
  56796. */
  56797. overflow?: boolean;
  56798. /**
  56799. * (Highcharts, Highstock, Highmaps, Gantt) When either the `borderWidth` or
  56800. * the `backgroundColor` is set, this is the padding within the box.
  56801. */
  56802. padding?: number;
  56803. /**
  56804. * (Highcharts, Highstock, Highmaps, Gantt) Aligns data labels relative to
  56805. * points. If `center` alignment is not possible, it defaults to `right`.
  56806. */
  56807. position?: AlignValue;
  56808. /**
  56809. * (Highcharts, Highstock, Highmaps, Gantt) Text rotation in degrees. Note
  56810. * that due to a more complex structure, backgrounds, borders and padding
  56811. * will be lost on a rotated data label.
  56812. */
  56813. rotation?: number;
  56814. /**
  56815. * (Highcharts, Highstock, Highmaps, Gantt) The shadow of the box. Works
  56816. * best with `borderWidth` or `backgroundColor`. Since 2.3 the shadow can be
  56817. * an object configuration containing `color`, `offsetX`, `offsetY`,
  56818. * `opacity` and `width`.
  56819. */
  56820. shadow?: (boolean|ShadowOptionsObject);
  56821. /**
  56822. * (Highcharts, Highstock, Highmaps, Gantt) The name of a symbol to use for
  56823. * the border around the label. Symbols are predefined functions on the
  56824. * Renderer object.
  56825. */
  56826. shape?: string;
  56827. /**
  56828. * (Highcharts, Highstock, Highmaps, Gantt) Styles for the label. The
  56829. * default `color` setting is `"contrast"`, which is a pseudo color that
  56830. * Highcharts picks up and applies the maximum contrast to the underlying
  56831. * point item, for example the bar in a bar chart.
  56832. *
  56833. * The `textOutline` is a pseudo property that applies an outline of the
  56834. * given width with the given color, which by default is the maximum
  56835. * contrast to the text. So a bright text color will result in a black text
  56836. * outline for maximum readability on a mixed background. In some cases,
  56837. * especially with grayscale text, the text outline doesn't work well, in
  56838. * which cases it can be disabled by setting it to `"none"`. When `useHTML`
  56839. * is true, the `textOutline` will not be picked up. In this, case, the same
  56840. * effect can be acheived through the `text-shadow` CSS property.
  56841. *
  56842. * For some series types, where each point has an extent, like for example
  56843. * tree maps, the data label may overflow the point. There are two
  56844. * strategies for handling overflow. By default, the text will wrap to
  56845. * multiple lines. The other strategy is to set `style.textOverflow` to
  56846. * `ellipsis`, which will keep the text on one line plus it will break
  56847. * inside long words.
  56848. */
  56849. style?: CSSObject;
  56850. /**
  56851. * (Highcharts, Highstock, Highmaps, Gantt) Options for a label text which
  56852. * should follow marker's shape. Border and background are disabled for a
  56853. * label that follows a path.
  56854. *
  56855. * **Note:** Only SVG-based renderer supports this option. Setting `useHTML`
  56856. * to true will disable this option.
  56857. */
  56858. textPath?: DataLabelsTextPathOptionsObject;
  56859. /**
  56860. * (Highcharts, Highstock, Highmaps, Gantt) Whether to use HTML to render
  56861. * the labels.
  56862. */
  56863. useHTML?: boolean;
  56864. /**
  56865. * (Highcharts, Highstock, Highmaps, Gantt) The vertical alignment of a data
  56866. * label. Can be one of `top`, `middle` or `bottom`. The default value
  56867. * depends on the data, for instance in a column chart, the label is above
  56868. * positive values and below negative values.
  56869. */
  56870. verticalAlign?: string;
  56871. /**
  56872. * (Highcharts, Highstock, Highmaps, Gantt) The x position offset of the
  56873. * label relative to the point in pixels.
  56874. */
  56875. x?: number;
  56876. /**
  56877. * (Highcharts, Highstock, Highmaps, Gantt) The y position offset of the
  56878. * label relative to the point in pixels.
  56879. */
  56880. y?: number;
  56881. /**
  56882. * (Highcharts, Highstock, Highmaps, Gantt) The Z index of the data labels.
  56883. * The default Z index puts it above the series. Use a Z index of 2 to
  56884. * display it behind the series.
  56885. */
  56886. z?: number;
  56887. }
  56888. /**
  56889. * (Highcharts, Highstock) Options for the series data sorting.
  56890. */
  56891. export interface PlotMapDataSortingOptions {
  56892. /**
  56893. * (Highcharts, Highstock) Enable or disable data sorting for the series.
  56894. * Use xAxis.reversed to change the sorting order.
  56895. */
  56896. enabled?: boolean;
  56897. /**
  56898. * (Highcharts, Highstock) Whether to allow matching points by name in an
  56899. * update. If this option is disabled, points will be matched by order.
  56900. */
  56901. matchByName?: boolean;
  56902. /**
  56903. * (Highcharts, Highstock) Determines what data value should be used to sort
  56904. * by.
  56905. */
  56906. sortKey?: string;
  56907. }
  56908. /**
  56909. * (Highmaps) Style options for the guide box. The guide box has one state by
  56910. * default, the `default` state.
  56911. */
  56912. export interface PlotMapDragDropGuideBoxOptions {
  56913. /**
  56914. * (Highmaps) Style options for the guide box default state.
  56915. */
  56916. default?: DragDropGuideBoxOptionsObject;
  56917. }
  56918. /**
  56919. * (Highcharts, Highstock) Apply a jitter effect for the rendered markers. When
  56920. * plotting discrete values, a little random noise may help telling the points
  56921. * apart. The jitter setting applies a random displacement of up to `n` axis
  56922. * units in either direction. So for example on a horizontal X axis, setting the
  56923. * `jitter.x` to 0.24 will render the point in a random position between 0.24
  56924. * units to the left and 0.24 units to the right of the true axis position. On a
  56925. * category axis, setting it to 0.5 will fill up the bin and make the data
  56926. * appear continuous.
  56927. *
  56928. * When rendered on top of a box plot or a column series, a jitter value of 0.24
  56929. * will correspond to the underlying series' default groupPadding and
  56930. * pointPadding settings.
  56931. */
  56932. export interface PlotMapJitterOptions {
  56933. /**
  56934. * (Highcharts, Highstock) The maximal X offset for the random jitter
  56935. * effect.
  56936. */
  56937. x?: number;
  56938. /**
  56939. * (Highcharts, Highstock) The maximal Y offset for the random jitter
  56940. * effect.
  56941. */
  56942. y?: number;
  56943. }
  56944. /**
  56945. * (Highmaps) Enable or disable the initial animation when a series is
  56946. * displayed. The animation can also be set as a configuration object. Please
  56947. * note that this option only applies to the initial animation of the series
  56948. * itself. For other animations, see chart.animation and the animation parameter
  56949. * under the API methods. The following properties are supported:
  56950. *
  56951. * - `defer`: The animation delay time in milliseconds.
  56952. *
  56953. * - `duration`: The duration of the animation in milliseconds.
  56954. *
  56955. * - `easing`: Can be a string reference to an easing function set on the `Math`
  56956. * object or a function. See the _Custom easing function_ demo below.
  56957. *
  56958. * Due to poor performance, animation is disabled in old IE browsers for several
  56959. * chart types.
  56960. */
  56961. export interface PlotMaplineAnimationOptions {
  56962. defer?: number;
  56963. }
  56964. /**
  56965. * (Highcharts, Highstock, Highmaps, Gantt) Enable or disable the initial
  56966. * animation when a series is displayed for the `dataLabels`. The animation can
  56967. * also be set as a configuration object. Please note that this option only
  56968. * applies to the initial animation. For other animations, see chart.animation
  56969. * and the animation parameter under the API methods. The following properties
  56970. * are supported:
  56971. *
  56972. * - `defer`: The animation delay time in milliseconds.
  56973. */
  56974. export interface PlotMaplineDataLabelsAnimationOptions {
  56975. /**
  56976. * (Highcharts, Highstock, Highmaps, Gantt) The animation delay time in
  56977. * milliseconds. Set to `0` renders dataLabel immediately. As `undefined`
  56978. * inherits defer time from the series.animation.defer.
  56979. */
  56980. defer?: number;
  56981. }
  56982. /**
  56983. * (Highcharts, Highstock, Highmaps, Gantt) Options for the series data labels,
  56984. * appearing next to each data point.
  56985. *
  56986. * Since v6.2.0, multiple data labels can be applied to each single point by
  56987. * defining them as an array of configs.
  56988. *
  56989. * In styled mode, the data labels can be styled with the
  56990. * `.highcharts-data-label-box` and `.highcharts-data-label` class names (see
  56991. * example).
  56992. */
  56993. export interface PlotMaplineDataLabelsOptions {
  56994. /**
  56995. * (Highcharts, Highstock, Highmaps, Gantt) The alignment of the data label
  56996. * compared to the point. If `right`, the right side of the label should be
  56997. * touching the point. For points with an extent, like columns, the
  56998. * alignments also dictates how to align it inside the box, as given with
  56999. * the inside option. Can be one of `left`, `center` or `right`.
  57000. */
  57001. align?: (AlignValue|null);
  57002. /**
  57003. * (Highcharts, Highstock, Highmaps, Gantt) Whether to allow data labels to
  57004. * overlap. To make the labels less sensitive for overlapping, the
  57005. * dataLabels.padding can be set to 0.
  57006. */
  57007. allowOverlap?: boolean;
  57008. /**
  57009. * (Highcharts, Highstock, Highmaps, Gantt) Enable or disable the initial
  57010. * animation when a series is displayed for the `dataLabels`. The animation
  57011. * can also be set as a configuration object. Please note that this option
  57012. * only applies to the initial animation. For other animations, see
  57013. * chart.animation and the animation parameter under the API methods. The
  57014. * following properties are supported:
  57015. *
  57016. * - `defer`: The animation delay time in milliseconds.
  57017. */
  57018. animation?: (boolean|PlotMaplineDataLabelsAnimationOptions|Partial<AnimationOptionsObject>);
  57019. /**
  57020. * (Highcharts, Highstock, Highmaps, Gantt) The background color or gradient
  57021. * for the data label.
  57022. */
  57023. backgroundColor?: (ColorString|GradientColorObject|PatternObject);
  57024. /**
  57025. * (Highcharts, Highstock, Highmaps, Gantt) The border color for the data
  57026. * label. Defaults to `undefined`.
  57027. */
  57028. borderColor?: (ColorString|GradientColorObject|PatternObject);
  57029. /**
  57030. * (Highcharts, Highstock, Highmaps, Gantt) The border radius in pixels for
  57031. * the data label.
  57032. */
  57033. borderRadius?: number;
  57034. /**
  57035. * (Highcharts, Highstock, Highmaps, Gantt) The border width in pixels for
  57036. * the data label.
  57037. */
  57038. borderWidth?: number;
  57039. /**
  57040. * (Highcharts, Highstock, Highmaps, Gantt) A class name for the data label.
  57041. * Particularly in styled mode, this can be used to give each series' or
  57042. * point's data label unique styling. In addition to this option, a default
  57043. * color class name is added so that we can give the labels a contrast text
  57044. * shadow.
  57045. */
  57046. className?: string;
  57047. /**
  57048. * (Highcharts, Highstock, Highmaps, Gantt) The text color for the data
  57049. * labels. Defaults to `undefined`. For certain series types, like column or
  57050. * map, the data labels can be drawn inside the points. In this case the
  57051. * data label will be drawn with maximum contrast by default. Additionally,
  57052. * it will be given a `text-outline` style with the opposite color, to
  57053. * further increase the contrast. This can be overridden by setting the
  57054. * `text-outline` style to `none` in the `dataLabels.style` option.
  57055. */
  57056. color?: (ColorString|GradientColorObject|PatternObject);
  57057. /**
  57058. * (Highcharts, Highstock, Highmaps, Gantt) Whether to hide data labels that
  57059. * are outside the plot area. By default, the data label is moved inside the
  57060. * plot area according to the overflow option.
  57061. */
  57062. crop?: boolean;
  57063. /**
  57064. * (Highcharts, Highstock, Gantt) Whether to defer displaying the data
  57065. * labels until the initial series animation has finished. Setting to
  57066. * `false` renders the data label immediately. If set to `true` inherits the
  57067. * defer time set in plotOptions.series.animation.
  57068. */
  57069. defer?: boolean;
  57070. /**
  57071. * (Highcharts, Highstock, Highmaps, Gantt) Enable or disable the data
  57072. * labels.
  57073. */
  57074. enabled?: boolean;
  57075. /**
  57076. * (Highcharts, Highstock, Highmaps, Gantt) A declarative filter to control
  57077. * of which data labels to display. The declarative filter is designed for
  57078. * use when callback functions are not available, like when the chart
  57079. * options require a pure JSON structure or for use with graphical editors.
  57080. * For programmatic control, use the `formatter` instead, and return
  57081. * `undefined` to disable a single data label.
  57082. */
  57083. filter?: DataLabelsFilterOptionsObject;
  57084. /**
  57085. * (Highcharts, Highstock, Highmaps, Gantt) A format string for the data
  57086. * label. Available variables are the same as for `formatter`.
  57087. */
  57088. format?: string;
  57089. /**
  57090. * (Highcharts, Highstock, Highmaps, Gantt) Callback JavaScript function to
  57091. * format the data label. Note that if a `format` is defined, the format
  57092. * takes precedence and the formatter is ignored.
  57093. */
  57094. formatter?: DataLabelsFormatterCallbackFunction;
  57095. /**
  57096. * (Highcharts, Highstock, Highmaps, Gantt) For points with an extent, like
  57097. * columns or map areas, whether to align the data label inside the box or
  57098. * to the actual value point. Defaults to `false` in most cases, `true` in
  57099. * stacked columns.
  57100. */
  57101. inside?: boolean;
  57102. /**
  57103. * (Highcharts, Highstock, Highmaps, Gantt) Format for points with the value
  57104. * of null. Works analogously to format. `nullFormat` can be applied only to
  57105. * series which support displaying null points.
  57106. */
  57107. nullFormat?: (boolean|string);
  57108. /**
  57109. * (Highcharts, Highstock, Highmaps, Gantt) Callback JavaScript function
  57110. * that defines formatting for points with the value of null. Works
  57111. * analogously to formatter. `nullPointFormatter` can be applied only to
  57112. * series which support displaying null points.
  57113. */
  57114. nullFormatter?: DataLabelsFormatterCallbackFunction;
  57115. /**
  57116. * (Highcharts, Highstock, Highmaps, Gantt) How to handle data labels that
  57117. * flow outside the plot area. The default is `"justify"`, which aligns them
  57118. * inside the plot area. For columns and bars, this means it will be moved
  57119. * inside the bar. To display data labels outside the plot area, set `crop`
  57120. * to `false` and `overflow` to `"allow"`.
  57121. */
  57122. overflow?: boolean;
  57123. /**
  57124. * (Highcharts, Highstock, Highmaps, Gantt) When either the `borderWidth` or
  57125. * the `backgroundColor` is set, this is the padding within the box.
  57126. */
  57127. padding?: number;
  57128. /**
  57129. * (Highcharts, Highstock, Highmaps, Gantt) Aligns data labels relative to
  57130. * points. If `center` alignment is not possible, it defaults to `right`.
  57131. */
  57132. position?: AlignValue;
  57133. /**
  57134. * (Highcharts, Highstock, Highmaps, Gantt) Text rotation in degrees. Note
  57135. * that due to a more complex structure, backgrounds, borders and padding
  57136. * will be lost on a rotated data label.
  57137. */
  57138. rotation?: number;
  57139. /**
  57140. * (Highcharts, Highstock, Highmaps, Gantt) The shadow of the box. Works
  57141. * best with `borderWidth` or `backgroundColor`. Since 2.3 the shadow can be
  57142. * an object configuration containing `color`, `offsetX`, `offsetY`,
  57143. * `opacity` and `width`.
  57144. */
  57145. shadow?: (boolean|ShadowOptionsObject);
  57146. /**
  57147. * (Highcharts, Highstock, Highmaps, Gantt) The name of a symbol to use for
  57148. * the border around the label. Symbols are predefined functions on the
  57149. * Renderer object.
  57150. */
  57151. shape?: string;
  57152. /**
  57153. * (Highcharts, Highstock, Highmaps, Gantt) Styles for the label. The
  57154. * default `color` setting is `"contrast"`, which is a pseudo color that
  57155. * Highcharts picks up and applies the maximum contrast to the underlying
  57156. * point item, for example the bar in a bar chart.
  57157. *
  57158. * The `textOutline` is a pseudo property that applies an outline of the
  57159. * given width with the given color, which by default is the maximum
  57160. * contrast to the text. So a bright text color will result in a black text
  57161. * outline for maximum readability on a mixed background. In some cases,
  57162. * especially with grayscale text, the text outline doesn't work well, in
  57163. * which cases it can be disabled by setting it to `"none"`. When `useHTML`
  57164. * is true, the `textOutline` will not be picked up. In this, case, the same
  57165. * effect can be acheived through the `text-shadow` CSS property.
  57166. *
  57167. * For some series types, where each point has an extent, like for example
  57168. * tree maps, the data label may overflow the point. There are two
  57169. * strategies for handling overflow. By default, the text will wrap to
  57170. * multiple lines. The other strategy is to set `style.textOverflow` to
  57171. * `ellipsis`, which will keep the text on one line plus it will break
  57172. * inside long words.
  57173. */
  57174. style?: CSSObject;
  57175. /**
  57176. * (Highcharts, Highstock, Highmaps, Gantt) Options for a label text which
  57177. * should follow marker's shape. Border and background are disabled for a
  57178. * label that follows a path.
  57179. *
  57180. * **Note:** Only SVG-based renderer supports this option. Setting `useHTML`
  57181. * to true will disable this option.
  57182. */
  57183. textPath?: DataLabelsTextPathOptionsObject;
  57184. /**
  57185. * (Highcharts, Highstock, Highmaps, Gantt) Whether to use HTML to render
  57186. * the labels.
  57187. */
  57188. useHTML?: boolean;
  57189. /**
  57190. * (Highcharts, Highstock, Highmaps, Gantt) The vertical alignment of a data
  57191. * label. Can be one of `top`, `middle` or `bottom`. The default value
  57192. * depends on the data, for instance in a column chart, the label is above
  57193. * positive values and below negative values.
  57194. */
  57195. verticalAlign?: string;
  57196. /**
  57197. * (Highcharts, Highstock, Highmaps, Gantt) The x position offset of the
  57198. * label relative to the point in pixels.
  57199. */
  57200. x?: number;
  57201. /**
  57202. * (Highcharts, Highstock, Highmaps, Gantt) The y position offset of the
  57203. * label relative to the point in pixels.
  57204. */
  57205. y?: number;
  57206. /**
  57207. * (Highcharts, Highstock, Highmaps, Gantt) The Z index of the data labels.
  57208. * The default Z index puts it above the series. Use a Z index of 2 to
  57209. * display it behind the series.
  57210. */
  57211. z?: number;
  57212. }
  57213. /**
  57214. * (Highcharts, Highstock) Options for the series data sorting.
  57215. */
  57216. export interface PlotMaplineDataSortingOptions {
  57217. /**
  57218. * (Highcharts, Highstock) Enable or disable data sorting for the series.
  57219. * Use xAxis.reversed to change the sorting order.
  57220. */
  57221. enabled?: boolean;
  57222. /**
  57223. * (Highcharts, Highstock) Whether to allow matching points by name in an
  57224. * update. If this option is disabled, points will be matched by order.
  57225. */
  57226. matchByName?: boolean;
  57227. /**
  57228. * (Highcharts, Highstock) Determines what data value should be used to sort
  57229. * by.
  57230. */
  57231. sortKey?: string;
  57232. }
  57233. /**
  57234. * (Highmaps) Style options for the guide box. The guide box has one state by
  57235. * default, the `default` state.
  57236. */
  57237. export interface PlotMaplineDragDropGuideBoxOptions {
  57238. /**
  57239. * (Highmaps) Style options for the guide box default state.
  57240. */
  57241. default?: DragDropGuideBoxOptionsObject;
  57242. }
  57243. /**
  57244. * (Highcharts, Highstock) Apply a jitter effect for the rendered markers. When
  57245. * plotting discrete values, a little random noise may help telling the points
  57246. * apart. The jitter setting applies a random displacement of up to `n` axis
  57247. * units in either direction. So for example on a horizontal X axis, setting the
  57248. * `jitter.x` to 0.24 will render the point in a random position between 0.24
  57249. * units to the left and 0.24 units to the right of the true axis position. On a
  57250. * category axis, setting it to 0.5 will fill up the bin and make the data
  57251. * appear continuous.
  57252. *
  57253. * When rendered on top of a box plot or a column series, a jitter value of 0.24
  57254. * will correspond to the underlying series' default groupPadding and
  57255. * pointPadding settings.
  57256. */
  57257. export interface PlotMaplineJitterOptions {
  57258. /**
  57259. * (Highcharts, Highstock) The maximal X offset for the random jitter
  57260. * effect.
  57261. */
  57262. x?: number;
  57263. /**
  57264. * (Highcharts, Highstock) The maximal Y offset for the random jitter
  57265. * effect.
  57266. */
  57267. y?: number;
  57268. }
  57269. /**
  57270. * (Highmaps) A mapline series is a special case of the map series where the
  57271. * value colors are applied to the strokes rather than the fills. It can also be
  57272. * used for freeform drawing, like dividers, in the map.
  57273. *
  57274. * In TypeScript the type option must always be set.
  57275. *
  57276. * Configuration options for the series are given in three levels:
  57277. *
  57278. * 1. Options for all series in a chart are defined in the plotOptions.series
  57279. * object.
  57280. *
  57281. * 2. Options for all `mapline` series are defined in plotOptions.mapline.
  57282. *
  57283. * 3. Options for one single series are given in the series instance array. (see
  57284. * online documentation for example)
  57285. */
  57286. export interface PlotMaplineOptions {
  57287. /**
  57288. * (Highmaps) Accessibility options for a series.
  57289. */
  57290. accessibility?: SeriesAccessibilityOptionsObject;
  57291. /**
  57292. * (Highmaps) Whether all areas of the map defined in `mapData` should be
  57293. * rendered. If `true`, areas which don't correspond to a data point, are
  57294. * rendered as `null` points. If `false`, those areas are skipped.
  57295. */
  57296. allAreas?: boolean;
  57297. /**
  57298. * (Highmaps) Allow this series' points to be selected by clicking on the
  57299. * graphic (columns, point markers, pie slices, map areas etc).
  57300. *
  57301. * The selected points can be handled by point select and unselect events,
  57302. * or collectively by the getSelectedPoints function.
  57303. *
  57304. * And alternative way of selecting points is through dragging.
  57305. */
  57306. allowPointSelect?: boolean;
  57307. /**
  57308. * (Highmaps) Enable or disable the initial animation when a series is
  57309. * displayed. The animation can also be set as a configuration object.
  57310. * Please note that this option only applies to the initial animation of the
  57311. * series itself. For other animations, see chart.animation and the
  57312. * animation parameter under the API methods. The following properties are
  57313. * supported:
  57314. *
  57315. * - `defer`: The animation delay time in milliseconds.
  57316. *
  57317. * - `duration`: The duration of the animation in milliseconds.
  57318. *
  57319. * - `easing`: Can be a string reference to an easing function set on the
  57320. * `Math` object or a function. See the _Custom easing function_ demo below.
  57321. *
  57322. * Due to poor performance, animation is disabled in old IE browsers for
  57323. * several chart types.
  57324. */
  57325. animation?: (boolean|PlotMaplineAnimationOptions);
  57326. /**
  57327. * (Highmaps) For some series, there is a limit that shuts down initial
  57328. * animation by default when the total number of points in the chart is too
  57329. * high. For example, for a column chart and its derivatives, animation does
  57330. * not run if there is more than 250 points totally. To disable this cap,
  57331. * set `animationLimit` to `Infinity`.
  57332. */
  57333. animationLimit?: number;
  57334. /**
  57335. * (Highmaps) Sets the color blending in the boost module.
  57336. */
  57337. boostBlending?: OptionsBoostBlendingValue;
  57338. /**
  57339. * (Highmaps) Set the point threshold for when a series should enter boost
  57340. * mode.
  57341. *
  57342. * Setting it to e.g. 2000 will cause the series to enter boost mode when
  57343. * there are 2000 or more points in the series.
  57344. *
  57345. * To disable boosting on the series, set the `boostThreshold` to 0. Setting
  57346. * it to 1 will force boosting.
  57347. *
  57348. * Note that the cropThreshold also affects this setting. When zooming in on
  57349. * a series that has fewer points than the `cropThreshold`, all points are
  57350. * rendered although outside the visible plot area, and the `boostThreshold`
  57351. * won't take effect.
  57352. */
  57353. boostThreshold?: number;
  57354. /**
  57355. * (Highmaps) The border color of the map areas.
  57356. *
  57357. * In styled mode, the border stroke is given in the `.highcharts-point`
  57358. * class.
  57359. */
  57360. borderColor?: (ColorString|GradientColorObject|PatternObject);
  57361. /**
  57362. * (Highmaps) The border width of each map area.
  57363. *
  57364. * In styled mode, the border stroke width is given in the
  57365. * `.highcharts-point` class.
  57366. */
  57367. borderWidth?: number;
  57368. /**
  57369. * (Highmaps) An additional class name to apply to the series' graphical
  57370. * elements. This option does not replace default class names of the
  57371. * graphical element.
  57372. */
  57373. className?: string;
  57374. /**
  57375. * (Highmaps) Disable this option to allow series rendering in the whole
  57376. * plotting area.
  57377. *
  57378. * **Note:** Clipping should be always enabled when chart.zoomType is set
  57379. */
  57380. clip?: boolean;
  57381. /**
  57382. * (Highmaps) The main color of the series. In line type series it applies
  57383. * to the line and the point markers unless otherwise specified. In bar type
  57384. * series it applies to the bars unless a color is specified per point. The
  57385. * default value is pulled from the `options.colors` array.
  57386. *
  57387. * In styled mode, the color can be defined by the colorIndex option. Also,
  57388. * the series color can be set with the `.highcharts-series`,
  57389. * `.highcharts-color-{n}`, `.highcharts-{type}-series` or
  57390. * `.highcharts-series-{n}` class, or individual classes given by the
  57391. * `className` option.
  57392. */
  57393. color?: (ColorString|GradientColorObject|PatternObject);
  57394. /**
  57395. * (Highcharts, Highstock, Highmaps) When using dual or multiple color axes,
  57396. * this number defines which colorAxis the particular series is connected
  57397. * to. It refers to either the axis id or the index of the axis in the
  57398. * colorAxis array, with 0 being the first. Set this option to false to
  57399. * prevent a series from connecting to the default color axis.
  57400. *
  57401. * Since v7.2.0 the option can also be an axis id or an axis index instead
  57402. * of a boolean flag.
  57403. */
  57404. colorAxis?: (boolean|number|string);
  57405. /**
  57406. * (Highmaps) Styled mode only. A specific color index to use for the
  57407. * series, so its graphic representations are given the class name
  57408. * `highcharts-color-{n}`.
  57409. */
  57410. colorIndex?: number;
  57411. /**
  57412. * (Highcharts, Highstock, Highmaps) Determines what data value should be
  57413. * used to calculate point color if `colorAxis` is used. Requires to set
  57414. * `min` and `max` if some custom point property is used or if approximation
  57415. * for data grouping is set to `'sum'`.
  57416. */
  57417. colorKey?: string;
  57418. /**
  57419. * (Highstock) Compare the values of the series against the first non-null,
  57420. * non- zero value in the visible range. The y axis will show percentage or
  57421. * absolute change depending on whether `compare` is set to `"percent"` or
  57422. * `"value"`. When this is applied to multiple series, it allows comparing
  57423. * the development of the series against each other. Adds a `change` field
  57424. * to every point object.
  57425. */
  57426. compare?: string;
  57427. /**
  57428. * (Highstock) When compare is `percent`, this option dictates whether to
  57429. * use 0 or 100 as the base of comparison.
  57430. */
  57431. compareBase?: (0|100);
  57432. /**
  57433. * (Highstock) Defines if comparison should start from the first point
  57434. * within the visible range or should start from the first point **before**
  57435. * the range.
  57436. *
  57437. * In other words, this flag determines if first point within the visible
  57438. * range will have 0% (`compareStart=true`) or should have been already
  57439. * calculated according to the previous point (`compareStart=false`).
  57440. */
  57441. compareStart?: boolean;
  57442. /**
  57443. * (Highcharts) Polar charts only. Whether to connect the ends of a line
  57444. * series plot across the extremes.
  57445. */
  57446. connectEnds?: boolean;
  57447. /**
  57448. * (Highcharts, Highstock) Whether to connect a graph line across null
  57449. * points, or render a gap between the two points on either side of the
  57450. * null.
  57451. */
  57452. connectNulls?: boolean;
  57453. /**
  57454. * (Gantt) Override Pathfinder connector options for a series. Requires
  57455. * Highcharts Gantt to be loaded.
  57456. */
  57457. connectors?: SeriesConnectorsOptionsObject;
  57458. /**
  57459. * (Highcharts, Highstock, Gantt) When true, each point or column edge is
  57460. * rounded to its nearest pixel in order to render sharp on screen. In some
  57461. * cases, when there are a lot of densely packed columns, this leads to
  57462. * visible difference in column widths or distance between columns. In these
  57463. * cases, setting `crisp` to `false` may look better, even though each
  57464. * column is rendered blurry.
  57465. */
  57466. crisp?: boolean;
  57467. /**
  57468. * (Highmaps) You can set the cursor to "pointer" if you have click events
  57469. * attached to the series, to signal to the user that the points and lines
  57470. * can be clicked.
  57471. *
  57472. * In styled mode, the series cursor can be set with the same classes as
  57473. * listed under series.color.
  57474. */
  57475. cursor?: (string|CursorValue);
  57476. /**
  57477. * (Highmaps) A reserved subspace to store options and values for customized
  57478. * functionality. Here you can add additional data for your own event
  57479. * callbacks and formatter callbacks.
  57480. */
  57481. custom?: Dictionary<any>;
  57482. /**
  57483. * (Highmaps) Name of the dash style to use for the graph, or for some
  57484. * series types the outline of each shape.
  57485. *
  57486. * In styled mode, the stroke dash-array can be set with the same classes as
  57487. * listed under series.color.
  57488. */
  57489. dashStyle?: DashStyleValue;
  57490. /**
  57491. * (Highstock) Data grouping is the concept of sampling the data values into
  57492. * larger blocks in order to ease readability and increase performance of
  57493. * the JavaScript charts. Highstock by default applies data grouping when
  57494. * the points become closer than a certain pixel value, determined by the
  57495. * `groupPixelWidth` option.
  57496. *
  57497. * If data grouping is applied, the grouping information of grouped points
  57498. * can be read from the Point.dataGroup. If point options other than the
  57499. * data itself are set, for example `name` or `color` or custom properties,
  57500. * the grouping logic doesn't know how to group it. In this case the options
  57501. * of the first point instance are copied over to the group point. This can
  57502. * be altered through a custom `approximation` callback function.
  57503. */
  57504. dataGrouping?: DataGroupingOptionsObject;
  57505. /**
  57506. * (Highcharts, Highstock, Highmaps, Gantt) Options for the series data
  57507. * labels, appearing next to each data point.
  57508. *
  57509. * Since v6.2.0, multiple data labels can be applied to each single point by
  57510. * defining them as an array of configs.
  57511. *
  57512. * In styled mode, the data labels can be styled with the
  57513. * `.highcharts-data-label-box` and `.highcharts-data-label` class names
  57514. * (see example).
  57515. */
  57516. dataLabels?: (PlotMaplineDataLabelsOptions|Array<PlotMaplineDataLabelsOptions>);
  57517. /**
  57518. * (Highcharts, Highstock) Options for the series data sorting.
  57519. */
  57520. dataSorting?: (DataSortingOptionsObject|PlotMaplineDataSortingOptions);
  57521. /**
  57522. * (Highmaps) A description of the series to add to the screen reader
  57523. * information about the series.
  57524. */
  57525. description?: string;
  57526. /**
  57527. * (Highmaps) The draggable-points module allows points to be moved around
  57528. * or modified in the chart. In addition to the options mentioned under the
  57529. * `dragDrop` API structure, the module fires three events, point.dragStart,
  57530. * point.drag and point.drop.
  57531. */
  57532. dragDrop?: SeriesDragDropOptionsObject;
  57533. /**
  57534. * (Highmaps) Enable or disable the mouse tracking for a specific series.
  57535. * This includes point tooltips and click events on graphs and points. For
  57536. * large datasets it improves performance.
  57537. */
  57538. enableMouseTracking?: boolean;
  57539. /**
  57540. * (Highmaps) General event handlers for the series items. These event hooks
  57541. * can also be attached to the series at run time using the
  57542. * `Highcharts.addEvent` function.
  57543. */
  57544. events?: SeriesEventsOptionsObject;
  57545. /**
  57546. * (Highmaps) Fill color for the map line shapes
  57547. */
  57548. fillColor?: (ColorString|GradientColorObject|PatternObject);
  57549. /**
  57550. * (Highmaps) Determines whether the series should look for the nearest
  57551. * point in both dimensions or just the x-dimension when hovering the
  57552. * series. Defaults to `'xy'` for scatter series and `'x'` for most other
  57553. * series. If the data has duplicate x-values, it is recommended to set this
  57554. * to `'xy'` to allow hovering over all points.
  57555. *
  57556. * Applies only to series types using nearest neighbor search (not direct
  57557. * hover) for tooltip.
  57558. */
  57559. findNearestPointBy?: OptionsFindNearestPointByValue;
  57560. /**
  57561. * (Highstock) Defines when to display a gap in the graph, together with the
  57562. * gapUnit option.
  57563. *
  57564. * In case when `dataGrouping` is enabled, points can be grouped into a
  57565. * larger time span. This can make the grouped points to have a greater
  57566. * distance than the absolute value of `gapSize` property, which will result
  57567. * in disappearing graph completely. To prevent this situation the mentioned
  57568. * distance between grouped points is used instead of previously defined
  57569. * `gapSize`.
  57570. *
  57571. * In practice, this option is most often used to visualize gaps in time
  57572. * series. In a stock chart, intraday data is available for daytime hours,
  57573. * while gaps will appear in nights and weekends.
  57574. */
  57575. gapSize?: number;
  57576. /**
  57577. * (Highstock) Together with gapSize, this option defines where to draw gaps
  57578. * in the graph.
  57579. *
  57580. * When the `gapUnit` is `"relative"` (default), a gap size of 5 means that
  57581. * if the distance between two points is greater than 5 times that of the
  57582. * two closest points, the graph will be broken.
  57583. *
  57584. * When the `gapUnit` is `"value"`, the gap is based on absolute axis
  57585. * values, which on a datetime axis is milliseconds. This also applies to
  57586. * the navigator series that inherits gap options from the base series.
  57587. */
  57588. gapUnit?: OptionsGapUnitValue;
  57589. /**
  57590. * (Highcharts, Highstock, Gantt) Whether to use the Y extremes of the total
  57591. * chart width or only the zoomed area when zooming in on parts of the X
  57592. * axis. By default, the Y axis adjusts to the min and max of the visible
  57593. * data. Cartesian series only.
  57594. */
  57595. getExtremesFromAll?: boolean;
  57596. /**
  57597. * (Highmaps) When set to `false` will prevent the series data from being
  57598. * included in any form of data export.
  57599. *
  57600. * Since version 6.0.0 until 7.1.0 the option was existing undocumented as
  57601. * `includeInCSVExport`.
  57602. */
  57603. includeInDataExport?: boolean;
  57604. /**
  57605. * (Highcharts, Highstock) Apply a jitter effect for the rendered markers.
  57606. * When plotting discrete values, a little random noise may help telling the
  57607. * points apart. The jitter setting applies a random displacement of up to
  57608. * `n` axis units in either direction. So for example on a horizontal X
  57609. * axis, setting the `jitter.x` to 0.24 will render the point in a random
  57610. * position between 0.24 units to the left and 0.24 units to the right of
  57611. * the true axis position. On a category axis, setting it to 0.5 will fill
  57612. * up the bin and make the data appear continuous.
  57613. *
  57614. * When rendered on top of a box plot or a column series, a jitter value of
  57615. * 0.24 will correspond to the underlying series' default groupPadding and
  57616. * pointPadding settings.
  57617. */
  57618. jitter?: PlotMaplineJitterOptions;
  57619. /**
  57620. * (Highmaps) What property to join the `mapData` to the value data. For
  57621. * example, if joinBy is "code", the mapData items with a specific code is
  57622. * merged into the data with the same code. For maps loaded from GeoJSON,
  57623. * the keys may be held in each point's `properties` object.
  57624. *
  57625. * The joinBy option can also be an array of two values, where the first
  57626. * points to a key in the `mapData`, and the second points to another key in
  57627. * the `data`.
  57628. *
  57629. * When joinBy is `null`, the map items are joined by their position in the
  57630. * array, which performs much better in maps with many data points. This is
  57631. * the recommended option if you are printing more than a thousand data
  57632. * points and have a backend that can preprocess the data into a parallel
  57633. * array of the mapData.
  57634. */
  57635. joinBy?: (string|Array<string>);
  57636. /**
  57637. * (Highmaps) An array specifying which option maps to which key in the data
  57638. * point array. This makes it convenient to work with unstructured data
  57639. * arrays from different sources.
  57640. */
  57641. keys?: Array<string>;
  57642. /**
  57643. * (Highcharts, Highstock, Gantt) Series labels are placed as close to the
  57644. * series as possible in a natural way, seeking to avoid other series. The
  57645. * goal of this feature is to make the chart more easily readable, like if a
  57646. * human designer placed the labels in the optimal position.
  57647. *
  57648. * The series labels currently work with series types having a `graph` or an
  57649. * `area`.
  57650. */
  57651. label?: SeriesLabelOptionsObject;
  57652. /**
  57653. * (Highstock) The line marks the last price from all points.
  57654. */
  57655. lastPrice?: SeriesLastPriceOptionsObject;
  57656. /**
  57657. * (Highstock) The line marks the last price from visible range of points.
  57658. */
  57659. lastVisiblePrice?: SeriesLastVisiblePriceOptionsObject;
  57660. /**
  57661. * (Highcharts, Highstock) The SVG value used for the `stroke-linecap` and
  57662. * `stroke-linejoin` of a line graph. Round means that lines are rounded in
  57663. * the ends and bends.
  57664. */
  57665. linecap?: SeriesLinecapValue;
  57666. /**
  57667. * (Highcharts, Highstock) The width of the map line.
  57668. */
  57669. lineWidth?: number;
  57670. /**
  57671. * (Highcharts, Highstock, Gantt) The id of another series to link to.
  57672. * Additionally, the value can be ":previous" to link to the previous
  57673. * series. When two series are linked, only the first one appears in the
  57674. * legend. Toggling the visibility of this also toggles the linked series.
  57675. *
  57676. * If master series uses data sorting and linked series does not have its
  57677. * own sorting definition, the linked series will be sorted in the same
  57678. * order as the master one.
  57679. */
  57680. linkedTo?: string;
  57681. /**
  57682. * (Highstock) Options for the corresponding navigator series if
  57683. * `showInNavigator` is `true` for this series. Available options are the
  57684. * same as any series, documented at plotOptions and series.
  57685. *
  57686. * These options are merged with options in navigator.series, and will take
  57687. * precedence if the same option is defined both places.
  57688. */
  57689. navigatorOptions?: PlotSeriesOptions;
  57690. /**
  57691. * (Highmaps) The color for the parts of the graph or points that are below
  57692. * the threshold. Note that `zones` takes precedence over the negative
  57693. * color. Using `negativeColor` is equivalent to applying a zone with value
  57694. * of 0.
  57695. */
  57696. negativeColor?: (ColorString|GradientColorObject|PatternObject);
  57697. /**
  57698. * (Highmaps) The color to apply to null points.
  57699. *
  57700. * In styled mode, the null point fill is set in the
  57701. * `.highcharts-null-point` class.
  57702. */
  57703. nullColor?: (ColorString|GradientColorObject|PatternObject);
  57704. /**
  57705. * (Highmaps) Whether to allow pointer interaction like tooltips and mouse
  57706. * events on null points.
  57707. */
  57708. nullInteraction?: boolean;
  57709. /**
  57710. * (Highmaps) Opacity of a series parts: line, fill (e.g. area) and
  57711. * dataLabels.
  57712. */
  57713. opacity?: number;
  57714. /**
  57715. * (Highmaps) Properties for each single point.
  57716. */
  57717. point?: PlotSeriesPointOptions;
  57718. /**
  57719. * (Highmaps) Same as accessibility.pointDescriptionFormatter, but for an
  57720. * individual series. Overrides the chart wide configuration.
  57721. */
  57722. pointDescriptionFormatter?: Function;
  57723. /**
  57724. * (Highcharts, Highstock, Gantt) If no x values are given for the points in
  57725. * a series, `pointInterval` defines the interval of the x values. For
  57726. * example, if a series contains one value every decade starting from year
  57727. * 0, set `pointInterval` to `10`. In true `datetime` axes, the
  57728. * `pointInterval` is set in milliseconds.
  57729. *
  57730. * It can be also be combined with `pointIntervalUnit` to draw irregular
  57731. * time intervals.
  57732. *
  57733. * Please note that this options applies to the _series data_, not the
  57734. * interval of the axis ticks, which is independent.
  57735. */
  57736. pointInterval?: number;
  57737. /**
  57738. * (Highcharts, Highstock, Gantt) On datetime series, this allows for
  57739. * setting the pointInterval to irregular time units, `day`, `month` and
  57740. * `year`. A day is usually the same as 24 hours, but `pointIntervalUnit`
  57741. * also takes the DST crossover into consideration when dealing with local
  57742. * time. Combine this option with `pointInterval` to draw weeks, quarters, 6
  57743. * months, 10 years etc.
  57744. *
  57745. * Please note that this options applies to the _series data_, not the
  57746. * interval of the axis ticks, which is independent.
  57747. */
  57748. pointIntervalUnit?: OptionsPointIntervalUnitValue;
  57749. /**
  57750. * (Highstock) The width of each point on the x axis. For example in a
  57751. * column chart with one value each day, the pointRange would be 1 day (= 24
  57752. * * 3600
  57753. *
  57754. * * 1000 milliseconds). This is normally computed automatically, but this
  57755. * option can be used to override the automatic value.
  57756. */
  57757. pointRange?: number;
  57758. /**
  57759. * (Highcharts, Highstock, Gantt) If no x values are given for the points in
  57760. * a series, pointStart defines on what value to start. For example, if a
  57761. * series contains one yearly value starting from 1945, set pointStart to
  57762. * 1945.
  57763. */
  57764. pointStart?: number;
  57765. /**
  57766. * (Highmaps) Whether to select the series initially. If `showCheckbox` is
  57767. * true, the checkbox next to the series name in the legend will be checked
  57768. * for a selected series.
  57769. */
  57770. selected?: boolean;
  57771. /**
  57772. * (Highmaps) If true, a checkbox is displayed next to the legend item to
  57773. * allow selecting the series. The state of the checkbox is determined by
  57774. * the `selected` option.
  57775. */
  57776. showCheckbox?: boolean;
  57777. /**
  57778. * (Highmaps) Whether to display this particular series or series type in
  57779. * the legend. Standalone series are shown in legend by default, and linked
  57780. * series are not. Since v7.2.0 it is possible to show series that use
  57781. * colorAxis by setting this option to `true`.
  57782. */
  57783. showInLegend?: boolean;
  57784. /**
  57785. * (Highstock) Whether or not to show the series in the navigator. Takes
  57786. * precedence over navigator.baseSeries if defined.
  57787. */
  57788. showInNavigator?: boolean;
  57789. /**
  57790. * (Highmaps) If set to `true`, the accessibility module will skip past the
  57791. * points in this series for keyboard navigation.
  57792. */
  57793. skipKeyboardNavigation?: boolean;
  57794. /**
  57795. * (Highcharts, Highstock) When this is true, the series will not cause the
  57796. * Y axis to cross the zero plane (or threshold option) unless the data
  57797. * actually crosses the plane.
  57798. *
  57799. * For example, if `softThreshold` is `false`, a series of 0, 1, 2, 3 will
  57800. * make the Y axis show negative values according to the `minPadding`
  57801. * option. If `softThreshold` is `true`, the Y axis starts at 0.
  57802. */
  57803. softThreshold?: boolean;
  57804. /**
  57805. * (Highcharts, Highstock) Whether to stack the values of each series on top
  57806. * of each other. Possible values are `undefined` to disable, `"normal"` to
  57807. * stack by value or `"percent"`.
  57808. *
  57809. * When stacking is enabled, data must be sorted in ascending X order.
  57810. *
  57811. * Some stacking options are related to specific series types. In the
  57812. * streamgraph series type, the stacking option is set to `"stream"`. The
  57813. * second one is `"overlap"`, which only applies to waterfall series.
  57814. */
  57815. stacking?: OptionsStackingValue;
  57816. states?: SeriesStatesOptionsObject;
  57817. /**
  57818. * (Highcharts, Highstock) Whether to apply steps to the line. Possible
  57819. * values are `left`, `center` and `right`.
  57820. */
  57821. step?: OptionsStepValue;
  57822. /**
  57823. * (Highcharts, Highstock) Sticky tracking of mouse events. When true, the
  57824. * `mouseOut` event on a series isn't triggered until the mouse moves over
  57825. * another series, or out of the plot area. When false, the `mouseOut` event
  57826. * on a series is triggered when the mouse leaves the area around the
  57827. * series' graph or markers. This also implies the tooltip. When
  57828. * `stickyTracking` is false and `tooltip.shared` is false, the tooltip will
  57829. * be hidden when moving the mouse between series.
  57830. */
  57831. stickyTracking?: boolean;
  57832. /**
  57833. * (Highcharts, Highstock) The threshold, also called zero level or base
  57834. * level. For line type series this is only used in conjunction with
  57835. * negativeColor.
  57836. */
  57837. threshold?: (number|null);
  57838. /**
  57839. * (Highcharts, Highstock) A configuration object for the tooltip rendering
  57840. * of each single series. Properties are inherited from tooltip. Overridable
  57841. * properties are `headerFormat`, `pointFormat`, `yDecimals`, `xDateFormat`,
  57842. * `yPrefix` and `ySuffix`. Unlike other series, in a scatter plot the
  57843. * series.name by default shows in the headerFormat and point.x and point.y
  57844. * in the pointFormat.
  57845. */
  57846. tooltip?: SeriesTooltipOptionsObject;
  57847. /**
  57848. * (Highcharts, Highstock, Gantt) When a series contains a data array that
  57849. * is longer than this, only one dimensional arrays of numbers, or two
  57850. * dimensional arrays with x and y values are allowed. Also, only the first
  57851. * point is tested, and the rest are assumed to be the same format. This
  57852. * saves expensive data checking and indexing in long series. Set it to `0`
  57853. * disable.
  57854. *
  57855. * Note: In boost mode turbo threshold is forced. Only array of numbers or
  57856. * two dimensional arrays are allowed.
  57857. */
  57858. turboThreshold?: number;
  57859. /**
  57860. * (Highmaps) Set the initial visibility of the series.
  57861. */
  57862. visible?: boolean;
  57863. /**
  57864. * (Highmaps) Define the z index of the series.
  57865. */
  57866. zIndex?: number;
  57867. /**
  57868. * (Highcharts, Highstock) Defines the Axis on which the zones are applied.
  57869. */
  57870. zoneAxis?: string;
  57871. /**
  57872. * (Highcharts, Highstock) An array defining zones within a series. Zones
  57873. * can be applied to the X axis, Y axis or Z axis for bubbles, according to
  57874. * the `zoneAxis` option. The zone definitions have to be in ascending order
  57875. * regarding to the value.
  57876. *
  57877. * In styled mode, the color zones are styled with the
  57878. * `.highcharts-zone-{n}` class, or custom classed from the `className`
  57879. * option (view live demo).
  57880. */
  57881. zones?: Array<SeriesZonesOptionsObject>;
  57882. }
  57883. /**
  57884. * (Highmaps) The map series is used for basic choropleth maps, where each map
  57885. * area has a color based on its value.
  57886. *
  57887. * In TypeScript the type option must always be set.
  57888. *
  57889. * Configuration options for the series are given in three levels:
  57890. *
  57891. * 1. Options for all series in a chart are defined in the plotOptions.series
  57892. * object.
  57893. *
  57894. * 2. Options for all `map` series are defined in plotOptions.map.
  57895. *
  57896. * 3. Options for one single series are given in the series instance array. (see
  57897. * online documentation for example)
  57898. */
  57899. export interface PlotMapOptions {
  57900. /**
  57901. * (Highmaps) Accessibility options for a series.
  57902. */
  57903. accessibility?: SeriesAccessibilityOptionsObject;
  57904. /**
  57905. * (Highmaps) Whether all areas of the map defined in `mapData` should be
  57906. * rendered. If `true`, areas which don't correspond to a data point, are
  57907. * rendered as `null` points. If `false`, those areas are skipped.
  57908. */
  57909. allAreas?: boolean;
  57910. /**
  57911. * (Highmaps) Allow this series' points to be selected by clicking on the
  57912. * graphic (columns, point markers, pie slices, map areas etc).
  57913. *
  57914. * The selected points can be handled by point select and unselect events,
  57915. * or collectively by the getSelectedPoints function.
  57916. *
  57917. * And alternative way of selecting points is through dragging.
  57918. */
  57919. allowPointSelect?: boolean;
  57920. /**
  57921. * (Highmaps) Enable or disable the initial animation when a series is
  57922. * displayed. The animation can also be set as a configuration object.
  57923. * Please note that this option only applies to the initial animation of the
  57924. * series itself. For other animations, see chart.animation and the
  57925. * animation parameter under the API methods. The following properties are
  57926. * supported:
  57927. *
  57928. * - `defer`: The animation delay time in milliseconds.
  57929. *
  57930. * - `duration`: The duration of the animation in milliseconds.
  57931. *
  57932. * - `easing`: Can be a string reference to an easing function set on the
  57933. * `Math` object or a function. See the _Custom easing function_ demo below.
  57934. *
  57935. * Due to poor performance, animation is disabled in old IE browsers for
  57936. * several chart types.
  57937. */
  57938. animation?: (boolean|PlotMapAnimationOptions);
  57939. /**
  57940. * (Highmaps) For some series, there is a limit that shuts down initial
  57941. * animation by default when the total number of points in the chart is too
  57942. * high. For example, for a column chart and its derivatives, animation does
  57943. * not run if there is more than 250 points totally. To disable this cap,
  57944. * set `animationLimit` to `Infinity`.
  57945. */
  57946. animationLimit?: number;
  57947. /**
  57948. * (Highmaps) Sets the color blending in the boost module.
  57949. */
  57950. boostBlending?: OptionsBoostBlendingValue;
  57951. /**
  57952. * (Highmaps) Set the point threshold for when a series should enter boost
  57953. * mode.
  57954. *
  57955. * Setting it to e.g. 2000 will cause the series to enter boost mode when
  57956. * there are 2000 or more points in the series.
  57957. *
  57958. * To disable boosting on the series, set the `boostThreshold` to 0. Setting
  57959. * it to 1 will force boosting.
  57960. *
  57961. * Note that the cropThreshold also affects this setting. When zooming in on
  57962. * a series that has fewer points than the `cropThreshold`, all points are
  57963. * rendered although outside the visible plot area, and the `boostThreshold`
  57964. * won't take effect.
  57965. */
  57966. boostThreshold?: number;
  57967. /**
  57968. * (Highmaps) The border color of the map areas.
  57969. *
  57970. * In styled mode, the border stroke is given in the `.highcharts-point`
  57971. * class.
  57972. */
  57973. borderColor?: (ColorString|GradientColorObject|PatternObject);
  57974. /**
  57975. * (Highmaps) The border width of each map area.
  57976. *
  57977. * In styled mode, the border stroke width is given in the
  57978. * `.highcharts-point` class.
  57979. */
  57980. borderWidth?: number;
  57981. /**
  57982. * (Highmaps) An additional class name to apply to the series' graphical
  57983. * elements. This option does not replace default class names of the
  57984. * graphical element.
  57985. */
  57986. className?: string;
  57987. /**
  57988. * (Highmaps) Disable this option to allow series rendering in the whole
  57989. * plotting area.
  57990. *
  57991. * **Note:** Clipping should be always enabled when chart.zoomType is set
  57992. */
  57993. clip?: boolean;
  57994. /**
  57995. * (Highmaps) The main color of the series. In line type series it applies
  57996. * to the line and the point markers unless otherwise specified. In bar type
  57997. * series it applies to the bars unless a color is specified per point. The
  57998. * default value is pulled from the `options.colors` array.
  57999. *
  58000. * In styled mode, the color can be defined by the colorIndex option. Also,
  58001. * the series color can be set with the `.highcharts-series`,
  58002. * `.highcharts-color-{n}`, `.highcharts-{type}-series` or
  58003. * `.highcharts-series-{n}` class, or individual classes given by the
  58004. * `className` option.
  58005. */
  58006. color?: (ColorString|GradientColorObject|PatternObject);
  58007. /**
  58008. * (Highcharts, Highstock, Highmaps) When using dual or multiple color axes,
  58009. * this number defines which colorAxis the particular series is connected
  58010. * to. It refers to either the axis id or the index of the axis in the
  58011. * colorAxis array, with 0 being the first. Set this option to false to
  58012. * prevent a series from connecting to the default color axis.
  58013. *
  58014. * Since v7.2.0 the option can also be an axis id or an axis index instead
  58015. * of a boolean flag.
  58016. */
  58017. colorAxis?: (boolean|number|string);
  58018. /**
  58019. * (Highmaps) Styled mode only. A specific color index to use for the
  58020. * series, so its graphic representations are given the class name
  58021. * `highcharts-color-{n}`.
  58022. */
  58023. colorIndex?: number;
  58024. /**
  58025. * (Highcharts, Highstock, Highmaps) Determines what data value should be
  58026. * used to calculate point color if `colorAxis` is used. Requires to set
  58027. * `min` and `max` if some custom point property is used or if approximation
  58028. * for data grouping is set to `'sum'`.
  58029. */
  58030. colorKey?: string;
  58031. /**
  58032. * (Highstock) Compare the values of the series against the first non-null,
  58033. * non- zero value in the visible range. The y axis will show percentage or
  58034. * absolute change depending on whether `compare` is set to `"percent"` or
  58035. * `"value"`. When this is applied to multiple series, it allows comparing
  58036. * the development of the series against each other. Adds a `change` field
  58037. * to every point object.
  58038. */
  58039. compare?: string;
  58040. /**
  58041. * (Highstock) When compare is `percent`, this option dictates whether to
  58042. * use 0 or 100 as the base of comparison.
  58043. */
  58044. compareBase?: (0|100);
  58045. /**
  58046. * (Highstock) Defines if comparison should start from the first point
  58047. * within the visible range or should start from the first point **before**
  58048. * the range.
  58049. *
  58050. * In other words, this flag determines if first point within the visible
  58051. * range will have 0% (`compareStart=true`) or should have been already
  58052. * calculated according to the previous point (`compareStart=false`).
  58053. */
  58054. compareStart?: boolean;
  58055. /**
  58056. * (Highcharts) Polar charts only. Whether to connect the ends of a line
  58057. * series plot across the extremes.
  58058. */
  58059. connectEnds?: boolean;
  58060. /**
  58061. * (Highcharts, Highstock) Whether to connect a graph line across null
  58062. * points, or render a gap between the two points on either side of the
  58063. * null.
  58064. */
  58065. connectNulls?: boolean;
  58066. /**
  58067. * (Gantt) Override Pathfinder connector options for a series. Requires
  58068. * Highcharts Gantt to be loaded.
  58069. */
  58070. connectors?: SeriesConnectorsOptionsObject;
  58071. /**
  58072. * (Highcharts, Highstock, Gantt) When true, each point or column edge is
  58073. * rounded to its nearest pixel in order to render sharp on screen. In some
  58074. * cases, when there are a lot of densely packed columns, this leads to
  58075. * visible difference in column widths or distance between columns. In these
  58076. * cases, setting `crisp` to `false` may look better, even though each
  58077. * column is rendered blurry.
  58078. */
  58079. crisp?: boolean;
  58080. /**
  58081. * (Highmaps) You can set the cursor to "pointer" if you have click events
  58082. * attached to the series, to signal to the user that the points and lines
  58083. * can be clicked.
  58084. *
  58085. * In styled mode, the series cursor can be set with the same classes as
  58086. * listed under series.color.
  58087. */
  58088. cursor?: (string|CursorValue);
  58089. /**
  58090. * (Highmaps) A reserved subspace to store options and values for customized
  58091. * functionality. Here you can add additional data for your own event
  58092. * callbacks and formatter callbacks.
  58093. */
  58094. custom?: Dictionary<any>;
  58095. /**
  58096. * (Highmaps) Name of the dash style to use for the graph, or for some
  58097. * series types the outline of each shape.
  58098. *
  58099. * In styled mode, the stroke dash-array can be set with the same classes as
  58100. * listed under series.color.
  58101. */
  58102. dashStyle?: DashStyleValue;
  58103. /**
  58104. * (Highstock) Data grouping is the concept of sampling the data values into
  58105. * larger blocks in order to ease readability and increase performance of
  58106. * the JavaScript charts. Highstock by default applies data grouping when
  58107. * the points become closer than a certain pixel value, determined by the
  58108. * `groupPixelWidth` option.
  58109. *
  58110. * If data grouping is applied, the grouping information of grouped points
  58111. * can be read from the Point.dataGroup. If point options other than the
  58112. * data itself are set, for example `name` or `color` or custom properties,
  58113. * the grouping logic doesn't know how to group it. In this case the options
  58114. * of the first point instance are copied over to the group point. This can
  58115. * be altered through a custom `approximation` callback function.
  58116. */
  58117. dataGrouping?: DataGroupingOptionsObject;
  58118. /**
  58119. * (Highcharts, Highstock, Highmaps, Gantt) Options for the series data
  58120. * labels, appearing next to each data point.
  58121. *
  58122. * Since v6.2.0, multiple data labels can be applied to each single point by
  58123. * defining them as an array of configs.
  58124. *
  58125. * In styled mode, the data labels can be styled with the
  58126. * `.highcharts-data-label-box` and `.highcharts-data-label` class names
  58127. * (see example).
  58128. */
  58129. dataLabels?: (PlotMapDataLabelsOptions|Array<PlotMapDataLabelsOptions>);
  58130. /**
  58131. * (Highcharts, Highstock) Options for the series data sorting.
  58132. */
  58133. dataSorting?: (DataSortingOptionsObject|PlotMapDataSortingOptions);
  58134. /**
  58135. * (Highmaps) A description of the series to add to the screen reader
  58136. * information about the series.
  58137. */
  58138. description?: string;
  58139. /**
  58140. * (Highmaps) The draggable-points module allows points to be moved around
  58141. * or modified in the chart. In addition to the options mentioned under the
  58142. * `dragDrop` API structure, the module fires three events, point.dragStart,
  58143. * point.drag and point.drop.
  58144. */
  58145. dragDrop?: SeriesDragDropOptionsObject;
  58146. /**
  58147. * (Highmaps) Enable or disable the mouse tracking for a specific series.
  58148. * This includes point tooltips and click events on graphs and points. For
  58149. * large datasets it improves performance.
  58150. */
  58151. enableMouseTracking?: boolean;
  58152. /**
  58153. * (Highmaps) General event handlers for the series items. These event hooks
  58154. * can also be attached to the series at run time using the
  58155. * `Highcharts.addEvent` function.
  58156. */
  58157. events?: SeriesEventsOptionsObject;
  58158. /**
  58159. * (Highmaps) Determines whether the series should look for the nearest
  58160. * point in both dimensions or just the x-dimension when hovering the
  58161. * series. Defaults to `'xy'` for scatter series and `'x'` for most other
  58162. * series. If the data has duplicate x-values, it is recommended to set this
  58163. * to `'xy'` to allow hovering over all points.
  58164. *
  58165. * Applies only to series types using nearest neighbor search (not direct
  58166. * hover) for tooltip.
  58167. */
  58168. findNearestPointBy?: OptionsFindNearestPointByValue;
  58169. /**
  58170. * (Highstock) Defines when to display a gap in the graph, together with the
  58171. * gapUnit option.
  58172. *
  58173. * In case when `dataGrouping` is enabled, points can be grouped into a
  58174. * larger time span. This can make the grouped points to have a greater
  58175. * distance than the absolute value of `gapSize` property, which will result
  58176. * in disappearing graph completely. To prevent this situation the mentioned
  58177. * distance between grouped points is used instead of previously defined
  58178. * `gapSize`.
  58179. *
  58180. * In practice, this option is most often used to visualize gaps in time
  58181. * series. In a stock chart, intraday data is available for daytime hours,
  58182. * while gaps will appear in nights and weekends.
  58183. */
  58184. gapSize?: number;
  58185. /**
  58186. * (Highstock) Together with gapSize, this option defines where to draw gaps
  58187. * in the graph.
  58188. *
  58189. * When the `gapUnit` is `"relative"` (default), a gap size of 5 means that
  58190. * if the distance between two points is greater than 5 times that of the
  58191. * two closest points, the graph will be broken.
  58192. *
  58193. * When the `gapUnit` is `"value"`, the gap is based on absolute axis
  58194. * values, which on a datetime axis is milliseconds. This also applies to
  58195. * the navigator series that inherits gap options from the base series.
  58196. */
  58197. gapUnit?: OptionsGapUnitValue;
  58198. /**
  58199. * (Highcharts, Highstock, Gantt) Whether to use the Y extremes of the total
  58200. * chart width or only the zoomed area when zooming in on parts of the X
  58201. * axis. By default, the Y axis adjusts to the min and max of the visible
  58202. * data. Cartesian series only.
  58203. */
  58204. getExtremesFromAll?: boolean;
  58205. /**
  58206. * (Highmaps) When set to `false` will prevent the series data from being
  58207. * included in any form of data export.
  58208. *
  58209. * Since version 6.0.0 until 7.1.0 the option was existing undocumented as
  58210. * `includeInCSVExport`.
  58211. */
  58212. includeInDataExport?: boolean;
  58213. /**
  58214. * (Highcharts, Highstock) Apply a jitter effect for the rendered markers.
  58215. * When plotting discrete values, a little random noise may help telling the
  58216. * points apart. The jitter setting applies a random displacement of up to
  58217. * `n` axis units in either direction. So for example on a horizontal X
  58218. * axis, setting the `jitter.x` to 0.24 will render the point in a random
  58219. * position between 0.24 units to the left and 0.24 units to the right of
  58220. * the true axis position. On a category axis, setting it to 0.5 will fill
  58221. * up the bin and make the data appear continuous.
  58222. *
  58223. * When rendered on top of a box plot or a column series, a jitter value of
  58224. * 0.24 will correspond to the underlying series' default groupPadding and
  58225. * pointPadding settings.
  58226. */
  58227. jitter?: PlotMapJitterOptions;
  58228. /**
  58229. * (Highmaps) What property to join the `mapData` to the value data. For
  58230. * example, if joinBy is "code", the mapData items with a specific code is
  58231. * merged into the data with the same code. For maps loaded from GeoJSON,
  58232. * the keys may be held in each point's `properties` object.
  58233. *
  58234. * The joinBy option can also be an array of two values, where the first
  58235. * points to a key in the `mapData`, and the second points to another key in
  58236. * the `data`.
  58237. *
  58238. * When joinBy is `null`, the map items are joined by their position in the
  58239. * array, which performs much better in maps with many data points. This is
  58240. * the recommended option if you are printing more than a thousand data
  58241. * points and have a backend that can preprocess the data into a parallel
  58242. * array of the mapData.
  58243. */
  58244. joinBy?: (string|Array<string>);
  58245. /**
  58246. * (Highmaps) An array specifying which option maps to which key in the data
  58247. * point array. This makes it convenient to work with unstructured data
  58248. * arrays from different sources.
  58249. */
  58250. keys?: Array<string>;
  58251. /**
  58252. * (Highcharts, Highstock, Gantt) Series labels are placed as close to the
  58253. * series as possible in a natural way, seeking to avoid other series. The
  58254. * goal of this feature is to make the chart more easily readable, like if a
  58255. * human designer placed the labels in the optimal position.
  58256. *
  58257. * The series labels currently work with series types having a `graph` or an
  58258. * `area`.
  58259. */
  58260. label?: SeriesLabelOptionsObject;
  58261. /**
  58262. * (Highstock) The line marks the last price from all points.
  58263. */
  58264. lastPrice?: SeriesLastPriceOptionsObject;
  58265. /**
  58266. * (Highstock) The line marks the last price from visible range of points.
  58267. */
  58268. lastVisiblePrice?: SeriesLastVisiblePriceOptionsObject;
  58269. /**
  58270. * (Highcharts, Highstock) The SVG value used for the `stroke-linecap` and
  58271. * `stroke-linejoin` of a line graph. Round means that lines are rounded in
  58272. * the ends and bends.
  58273. */
  58274. linecap?: SeriesLinecapValue;
  58275. /**
  58276. * (Highcharts, Highstock) The width of the line connecting the data points.
  58277. */
  58278. lineWidth?: number;
  58279. /**
  58280. * (Highcharts, Highstock, Gantt) The id of another series to link to.
  58281. * Additionally, the value can be ":previous" to link to the previous
  58282. * series. When two series are linked, only the first one appears in the
  58283. * legend. Toggling the visibility of this also toggles the linked series.
  58284. *
  58285. * If master series uses data sorting and linked series does not have its
  58286. * own sorting definition, the linked series will be sorted in the same
  58287. * order as the master one.
  58288. */
  58289. linkedTo?: string;
  58290. /**
  58291. * (Highstock) Options for the corresponding navigator series if
  58292. * `showInNavigator` is `true` for this series. Available options are the
  58293. * same as any series, documented at plotOptions and series.
  58294. *
  58295. * These options are merged with options in navigator.series, and will take
  58296. * precedence if the same option is defined both places.
  58297. */
  58298. navigatorOptions?: PlotSeriesOptions;
  58299. /**
  58300. * (Highmaps) The color for the parts of the graph or points that are below
  58301. * the threshold. Note that `zones` takes precedence over the negative
  58302. * color. Using `negativeColor` is equivalent to applying a zone with value
  58303. * of 0.
  58304. */
  58305. negativeColor?: (ColorString|GradientColorObject|PatternObject);
  58306. /**
  58307. * (Highmaps) The color to apply to null points.
  58308. *
  58309. * In styled mode, the null point fill is set in the
  58310. * `.highcharts-null-point` class.
  58311. */
  58312. nullColor?: (ColorString|GradientColorObject|PatternObject);
  58313. /**
  58314. * (Highmaps) Whether to allow pointer interaction like tooltips and mouse
  58315. * events on null points.
  58316. */
  58317. nullInteraction?: boolean;
  58318. /**
  58319. * (Highmaps) Opacity of a series parts: line, fill (e.g. area) and
  58320. * dataLabels.
  58321. */
  58322. opacity?: number;
  58323. /**
  58324. * (Highmaps) Properties for each single point.
  58325. */
  58326. point?: PlotSeriesPointOptions;
  58327. /**
  58328. * (Highmaps) Same as accessibility.pointDescriptionFormatter, but for an
  58329. * individual series. Overrides the chart wide configuration.
  58330. */
  58331. pointDescriptionFormatter?: Function;
  58332. /**
  58333. * (Highcharts, Highstock, Gantt) If no x values are given for the points in
  58334. * a series, `pointInterval` defines the interval of the x values. For
  58335. * example, if a series contains one value every decade starting from year
  58336. * 0, set `pointInterval` to `10`. In true `datetime` axes, the
  58337. * `pointInterval` is set in milliseconds.
  58338. *
  58339. * It can be also be combined with `pointIntervalUnit` to draw irregular
  58340. * time intervals.
  58341. *
  58342. * Please note that this options applies to the _series data_, not the
  58343. * interval of the axis ticks, which is independent.
  58344. */
  58345. pointInterval?: number;
  58346. /**
  58347. * (Highcharts, Highstock, Gantt) On datetime series, this allows for
  58348. * setting the pointInterval to irregular time units, `day`, `month` and
  58349. * `year`. A day is usually the same as 24 hours, but `pointIntervalUnit`
  58350. * also takes the DST crossover into consideration when dealing with local
  58351. * time. Combine this option with `pointInterval` to draw weeks, quarters, 6
  58352. * months, 10 years etc.
  58353. *
  58354. * Please note that this options applies to the _series data_, not the
  58355. * interval of the axis ticks, which is independent.
  58356. */
  58357. pointIntervalUnit?: OptionsPointIntervalUnitValue;
  58358. /**
  58359. * (Highstock) The width of each point on the x axis. For example in a
  58360. * column chart with one value each day, the pointRange would be 1 day (= 24
  58361. * * 3600
  58362. *
  58363. * * 1000 milliseconds). This is normally computed automatically, but this
  58364. * option can be used to override the automatic value.
  58365. */
  58366. pointRange?: number;
  58367. /**
  58368. * (Highcharts, Highstock, Gantt) If no x values are given for the points in
  58369. * a series, pointStart defines on what value to start. For example, if a
  58370. * series contains one yearly value starting from 1945, set pointStart to
  58371. * 1945.
  58372. */
  58373. pointStart?: number;
  58374. /**
  58375. * (Highmaps) Whether to select the series initially. If `showCheckbox` is
  58376. * true, the checkbox next to the series name in the legend will be checked
  58377. * for a selected series.
  58378. */
  58379. selected?: boolean;
  58380. /**
  58381. * (Highmaps) If true, a checkbox is displayed next to the legend item to
  58382. * allow selecting the series. The state of the checkbox is determined by
  58383. * the `selected` option.
  58384. */
  58385. showCheckbox?: boolean;
  58386. /**
  58387. * (Highmaps) Whether to display this particular series or series type in
  58388. * the legend. Standalone series are shown in legend by default, and linked
  58389. * series are not. Since v7.2.0 it is possible to show series that use
  58390. * colorAxis by setting this option to `true`.
  58391. */
  58392. showInLegend?: boolean;
  58393. /**
  58394. * (Highstock) Whether or not to show the series in the navigator. Takes
  58395. * precedence over navigator.baseSeries if defined.
  58396. */
  58397. showInNavigator?: boolean;
  58398. /**
  58399. * (Highmaps) If set to `true`, the accessibility module will skip past the
  58400. * points in this series for keyboard navigation.
  58401. */
  58402. skipKeyboardNavigation?: boolean;
  58403. /**
  58404. * (Highcharts, Highstock) When this is true, the series will not cause the
  58405. * Y axis to cross the zero plane (or threshold option) unless the data
  58406. * actually crosses the plane.
  58407. *
  58408. * For example, if `softThreshold` is `false`, a series of 0, 1, 2, 3 will
  58409. * make the Y axis show negative values according to the `minPadding`
  58410. * option. If `softThreshold` is `true`, the Y axis starts at 0.
  58411. */
  58412. softThreshold?: boolean;
  58413. /**
  58414. * (Highcharts, Highstock) Whether to stack the values of each series on top
  58415. * of each other. Possible values are `undefined` to disable, `"normal"` to
  58416. * stack by value or `"percent"`.
  58417. *
  58418. * When stacking is enabled, data must be sorted in ascending X order.
  58419. *
  58420. * Some stacking options are related to specific series types. In the
  58421. * streamgraph series type, the stacking option is set to `"stream"`. The
  58422. * second one is `"overlap"`, which only applies to waterfall series.
  58423. */
  58424. stacking?: OptionsStackingValue;
  58425. states?: SeriesStatesOptionsObject;
  58426. /**
  58427. * (Highcharts, Highstock) Whether to apply steps to the line. Possible
  58428. * values are `left`, `center` and `right`.
  58429. */
  58430. step?: OptionsStepValue;
  58431. /**
  58432. * (Highcharts, Highstock) Sticky tracking of mouse events. When true, the
  58433. * `mouseOut` event on a series isn't triggered until the mouse moves over
  58434. * another series, or out of the plot area. When false, the `mouseOut` event
  58435. * on a series is triggered when the mouse leaves the area around the
  58436. * series' graph or markers. This also implies the tooltip. When
  58437. * `stickyTracking` is false and `tooltip.shared` is false, the tooltip will
  58438. * be hidden when moving the mouse between series.
  58439. */
  58440. stickyTracking?: boolean;
  58441. /**
  58442. * (Highcharts, Highstock) The threshold, also called zero level or base
  58443. * level. For line type series this is only used in conjunction with
  58444. * negativeColor.
  58445. */
  58446. threshold?: (number|null);
  58447. /**
  58448. * (Highcharts, Highstock) A configuration object for the tooltip rendering
  58449. * of each single series. Properties are inherited from tooltip. Overridable
  58450. * properties are `headerFormat`, `pointFormat`, `yDecimals`, `xDateFormat`,
  58451. * `yPrefix` and `ySuffix`. Unlike other series, in a scatter plot the
  58452. * series.name by default shows in the headerFormat and point.x and point.y
  58453. * in the pointFormat.
  58454. */
  58455. tooltip?: SeriesTooltipOptionsObject;
  58456. /**
  58457. * (Highcharts, Highstock, Gantt) When a series contains a data array that
  58458. * is longer than this, only one dimensional arrays of numbers, or two
  58459. * dimensional arrays with x and y values are allowed. Also, only the first
  58460. * point is tested, and the rest are assumed to be the same format. This
  58461. * saves expensive data checking and indexing in long series. Set it to `0`
  58462. * disable.
  58463. *
  58464. * Note: In boost mode turbo threshold is forced. Only array of numbers or
  58465. * two dimensional arrays are allowed.
  58466. */
  58467. turboThreshold?: number;
  58468. /**
  58469. * (Highmaps) Set the initial visibility of the series.
  58470. */
  58471. visible?: boolean;
  58472. /**
  58473. * (Highmaps) Define the z index of the series.
  58474. */
  58475. zIndex?: number;
  58476. /**
  58477. * (Highcharts, Highstock) Defines the Axis on which the zones are applied.
  58478. */
  58479. zoneAxis?: string;
  58480. /**
  58481. * (Highcharts, Highstock) An array defining zones within a series. Zones
  58482. * can be applied to the X axis, Y axis or Z axis for bubbles, according to
  58483. * the `zoneAxis` option. The zone definitions have to be in ascending order
  58484. * regarding to the value.
  58485. *
  58486. * In styled mode, the color zones are styled with the
  58487. * `.highcharts-zone-{n}` class, or custom classed from the `className`
  58488. * option (view live demo).
  58489. */
  58490. zones?: Array<SeriesZonesOptionsObject>;
  58491. }
  58492. /**
  58493. * (Highmaps) Enable or disable the initial animation when a series is
  58494. * displayed. The animation can also be set as a configuration object. Please
  58495. * note that this option only applies to the initial animation of the series
  58496. * itself. For other animations, see chart.animation and the animation parameter
  58497. * under the API methods. The following properties are supported:
  58498. *
  58499. * - `defer`: The animation delay time in milliseconds.
  58500. *
  58501. * - `duration`: The duration of the animation in milliseconds.
  58502. *
  58503. * - `easing`: Can be a string reference to an easing function set on the `Math`
  58504. * object or a function. See the _Custom easing function_ demo below.
  58505. *
  58506. * Due to poor performance, animation is disabled in old IE browsers for several
  58507. * chart types.
  58508. */
  58509. export interface PlotMappointAnimationOptions {
  58510. defer?: number;
  58511. }
  58512. export interface PlotMappointClusterEventsOptions {
  58513. /**
  58514. * (Highcharts, Highmaps) Fires when the cluster point is clicked and
  58515. * `drillToCluster` is enabled. One parameter, `event`, is passed to the
  58516. * function. The default action is to zoom to the cluster points range. This
  58517. * can be prevented by calling `event.preventDefault()`.
  58518. */
  58519. drillToCluster?: MarkerClusterDrillCallbackFunction;
  58520. }
  58521. /**
  58522. * (Highcharts, Highmaps) Options for layout algorithm. Inside there are options
  58523. * to change the type of the algorithm, gridSize, distance or iterations.
  58524. */
  58525. export interface PlotMappointClusterLayoutAlgorithmOptions {
  58526. /**
  58527. * (Highcharts, Highmaps) When `type` is set to `kmeans`, `distance` is a
  58528. * maximum distance between point and cluster center so that this point will
  58529. * be inside the cluster. The distance is either a number defining pixels or
  58530. * a percentage defining a percentage of the plot area width.
  58531. */
  58532. distance?: (number|string);
  58533. /**
  58534. * (Highcharts, Highmaps) When `type` is set to the `grid`, `gridSize` is a
  58535. * size of a grid square element either as a number defining pixels, or a
  58536. * percentage defining a percentage of the plot area width.
  58537. */
  58538. gridSize?: (number|string);
  58539. /**
  58540. * (Highcharts, Highmaps) When `type` is set to `kmeans`, `iterations` are
  58541. * the number of iterations that this algorithm will be repeated to find
  58542. * clusters positions.
  58543. */
  58544. iterations?: number;
  58545. /**
  58546. * (Highcharts, Highmaps) When `type` is set to `undefined` and there are
  58547. * more visible points than the kmeansThreshold the `grid` algorithm is used
  58548. * to find clusters, otherwise `kmeans`. It ensures good performance on
  58549. * large datasets and better clusters arrangement after the zoom.
  58550. */
  58551. kmeansThreshold?: number;
  58552. /**
  58553. * (Highcharts, Highmaps) Type of the algorithm used to combine points into
  58554. * a cluster. There are three available algorithms:
  58555. *
  58556. * 1) `grid` - grid-based clustering technique. Points are assigned to
  58557. * squares of set size depending on their position on the plot area. Points
  58558. * inside the grid square are combined into a cluster. The grid size can be
  58559. * controlled by `gridSize` property (grid size changes at certain zoom
  58560. * levels).
  58561. *
  58562. * 2) `kmeans` - based on K-Means clustering technique. In the first step,
  58563. * points are divided using the grid method (distance property is a grid
  58564. * size) to find the initial amount of clusters. Next, each point is
  58565. * classified by computing the distance between each cluster center and that
  58566. * point. When the closest cluster distance is lower than distance property
  58567. * set by a user the point is added to this cluster otherwise is classified
  58568. * as `noise`. The algorithm is repeated until each cluster center not
  58569. * change its previous position more than one pixel. This technique is more
  58570. * accurate but also more time consuming than the `grid` algorithm,
  58571. * especially for big datasets.
  58572. *
  58573. * 3) `optimizedKmeans` - based on K-Means clustering technique. This
  58574. * algorithm uses k-means algorithm only on the chart initialization or when
  58575. * chart extremes have greater range than on initialization. When a chart is
  58576. * redrawn the algorithm checks only clustered points distance from the
  58577. * cluster center and rebuild it when the point is spaced enough to be
  58578. * outside the cluster. It provides performance improvement and more stable
  58579. * clusters position yet can be used rather on small and sparse datasets.
  58580. *
  58581. * By default, the algorithm depends on visible quantity of points and
  58582. * `kmeansThreshold`. When there are more visible points than the
  58583. * `kmeansThreshold` the `grid` algorithm is used, otherwise `kmeans`.
  58584. *
  58585. * The custom clustering algorithm can be added by assigning a callback
  58586. * function as the type property. This function takes an array of
  58587. * `processedXData`, `processedYData`, `processedXData` indexes and
  58588. * `layoutAlgorithm` options as arguments and should return an object with
  58589. * grouped data.
  58590. *
  58591. * The algorithm should return an object like that: (see online
  58592. * documentation for example)
  58593. *
  58594. * `clusterId` (example above - unique id of a cluster or noise) is an array
  58595. * of points belonging to a cluster. If the array has only one point or
  58596. * fewer points than set in `cluster.minimumClusterSize` it won't be
  58597. * combined into a cluster.
  58598. */
  58599. type?: (string|Function);
  58600. }
  58601. /**
  58602. * (Highcharts, Highmaps) Options for marker clusters, the concept of sampling
  58603. * the data values into larger blocks in order to ease readability and increase
  58604. * performance of the JavaScript charts.
  58605. *
  58606. * Note: marker clusters module is not working with `boost` and
  58607. * `draggable-points` modules.
  58608. *
  58609. * The marker clusters feature requires the marker-clusters.js file to be
  58610. * loaded, found in the modules directory of the download package, or online at
  58611. * code.highcharts.com/modules/marker-clusters.js.
  58612. */
  58613. export interface PlotMappointClusterOptions {
  58614. /**
  58615. * (Highcharts, Highmaps) When set to `false` prevent cluster overlapping -
  58616. * this option works only when `layoutAlgorithm.type = "grid"`.
  58617. */
  58618. allowOverlap?: boolean;
  58619. /**
  58620. * (Highcharts, Highmaps) Options for the cluster marker animation.
  58621. */
  58622. animation?: (boolean|Partial<AnimationOptionsObject>);
  58623. /**
  58624. * (Highcharts, Highmaps) Options for the cluster data labels.
  58625. */
  58626. dataLabels?: DataLabelsOptions;
  58627. /**
  58628. * (Highcharts, Highmaps) Zoom the plot area to the cluster points range
  58629. * when a cluster is clicked.
  58630. */
  58631. drillToCluster?: boolean;
  58632. /**
  58633. * (Highcharts, Highmaps) Whether to enable the marker-clusters module.
  58634. */
  58635. enabled?: boolean;
  58636. events?: PlotMappointClusterEventsOptions;
  58637. /**
  58638. * (Highcharts, Highmaps) Options for layout algorithm. Inside there are
  58639. * options to change the type of the algorithm, gridSize, distance or
  58640. * iterations.
  58641. */
  58642. layoutAlgorithm?: PlotMappointClusterLayoutAlgorithmOptions;
  58643. /**
  58644. * (Highcharts, Highmaps) Options for the cluster marker.
  58645. */
  58646. marker?: PointMarkerOptionsObject;
  58647. /**
  58648. * (Highcharts, Highmaps) The minimum amount of points to be combined into a
  58649. * cluster. This value has to be greater or equal to 2.
  58650. */
  58651. minimumClusterSize?: number;
  58652. states?: PlotMappointClusterStatesOptions;
  58653. /**
  58654. * (Highcharts, Highmaps) An array defining zones within marker clusters.
  58655. *
  58656. * In styled mode, the color zones are styled with the
  58657. * `.highcharts-cluster-zone-{n}` class, or custom classed from the
  58658. * `className` option.
  58659. */
  58660. zones?: Array<PlotMappointClusterZonesOptions>;
  58661. }
  58662. export interface PlotMappointClusterStatesHoverOptions {
  58663. /**
  58664. * (Highcharts, Highmaps) The fill color of the cluster marker in hover
  58665. * state. When `undefined`, the series' or point's fillColor for normal
  58666. * state is used.
  58667. */
  58668. fillColor?: ColorType;
  58669. }
  58670. export interface PlotMappointClusterStatesOptions {
  58671. hover?: PlotMappointClusterStatesHoverOptions;
  58672. }
  58673. /**
  58674. * (Highcharts, Highmaps) An array defining zones within marker clusters.
  58675. *
  58676. * In styled mode, the color zones are styled with the
  58677. * `.highcharts-cluster-zone-{n}` class, or custom classed from the `className`
  58678. * option.
  58679. */
  58680. export interface PlotMappointClusterZonesOptions {
  58681. /**
  58682. * (Highcharts, Highmaps) Styled mode only. A custom class name for the
  58683. * zone.
  58684. */
  58685. className?: string;
  58686. /**
  58687. * (Highcharts, Highmaps) The value where the zone starts.
  58688. */
  58689. from?: number;
  58690. /**
  58691. * (Highcharts, Highmaps) Settings for the cluster marker belonging to the
  58692. * zone.
  58693. */
  58694. marker?: PointMarkerOptionsObject;
  58695. /**
  58696. * (Highcharts, Highmaps) The value where the zone ends.
  58697. */
  58698. to?: number;
  58699. }
  58700. /**
  58701. * (Highcharts, Highstock, Highmaps, Gantt) Enable or disable the initial
  58702. * animation when a series is displayed for the `dataLabels`. The animation can
  58703. * also be set as a configuration object. Please note that this option only
  58704. * applies to the initial animation. For other animations, see chart.animation
  58705. * and the animation parameter under the API methods. The following properties
  58706. * are supported:
  58707. *
  58708. * - `defer`: The animation delay time in milliseconds.
  58709. */
  58710. export interface PlotMappointDataLabelsAnimationOptions {
  58711. /**
  58712. * (Highcharts, Highstock, Highmaps, Gantt) The animation delay time in
  58713. * milliseconds. Set to `0` renders dataLabel immediately. As `undefined`
  58714. * inherits defer time from the series.animation.defer.
  58715. */
  58716. defer?: number;
  58717. }
  58718. /**
  58719. * (Highcharts, Highstock, Highmaps, Gantt) Options for the series data labels,
  58720. * appearing next to each data point.
  58721. *
  58722. * Since v6.2.0, multiple data labels can be applied to each single point by
  58723. * defining them as an array of configs.
  58724. *
  58725. * In styled mode, the data labels can be styled with the
  58726. * `.highcharts-data-label-box` and `.highcharts-data-label` class names (see
  58727. * example).
  58728. */
  58729. export interface PlotMappointDataLabelsOptions {
  58730. /**
  58731. * (Highcharts, Highstock, Highmaps, Gantt) The alignment of the data label
  58732. * compared to the point. If `right`, the right side of the label should be
  58733. * touching the point. For points with an extent, like columns, the
  58734. * alignments also dictates how to align it inside the box, as given with
  58735. * the inside option. Can be one of `left`, `center` or `right`.
  58736. */
  58737. align?: (AlignValue|null);
  58738. /**
  58739. * (Highcharts, Highstock, Highmaps, Gantt) Whether to allow data labels to
  58740. * overlap. To make the labels less sensitive for overlapping, the
  58741. * dataLabels.padding can be set to 0.
  58742. */
  58743. allowOverlap?: boolean;
  58744. /**
  58745. * (Highcharts, Highstock, Highmaps, Gantt) Enable or disable the initial
  58746. * animation when a series is displayed for the `dataLabels`. The animation
  58747. * can also be set as a configuration object. Please note that this option
  58748. * only applies to the initial animation. For other animations, see
  58749. * chart.animation and the animation parameter under the API methods. The
  58750. * following properties are supported:
  58751. *
  58752. * - `defer`: The animation delay time in milliseconds.
  58753. */
  58754. animation?: (boolean|PlotMappointDataLabelsAnimationOptions|Partial<AnimationOptionsObject>);
  58755. /**
  58756. * (Highcharts, Highstock, Highmaps, Gantt) The background color or gradient
  58757. * for the data label.
  58758. */
  58759. backgroundColor?: (ColorString|GradientColorObject|PatternObject);
  58760. /**
  58761. * (Highcharts, Highstock, Highmaps, Gantt) The border color for the data
  58762. * label. Defaults to `undefined`.
  58763. */
  58764. borderColor?: (ColorString|GradientColorObject|PatternObject);
  58765. /**
  58766. * (Highcharts, Highstock, Highmaps, Gantt) The border radius in pixels for
  58767. * the data label.
  58768. */
  58769. borderRadius?: number;
  58770. /**
  58771. * (Highcharts, Highstock, Highmaps, Gantt) The border width in pixels for
  58772. * the data label.
  58773. */
  58774. borderWidth?: number;
  58775. /**
  58776. * (Highcharts, Highstock, Highmaps, Gantt) A class name for the data label.
  58777. * Particularly in styled mode, this can be used to give each series' or
  58778. * point's data label unique styling. In addition to this option, a default
  58779. * color class name is added so that we can give the labels a contrast text
  58780. * shadow.
  58781. */
  58782. className?: string;
  58783. /**
  58784. * (Highcharts, Highstock, Highmaps, Gantt) The text color for the data
  58785. * labels. Defaults to `undefined`. For certain series types, like column or
  58786. * map, the data labels can be drawn inside the points. In this case the
  58787. * data label will be drawn with maximum contrast by default. Additionally,
  58788. * it will be given a `text-outline` style with the opposite color, to
  58789. * further increase the contrast. This can be overridden by setting the
  58790. * `text-outline` style to `none` in the `dataLabels.style` option.
  58791. */
  58792. color?: (ColorString|GradientColorObject|PatternObject);
  58793. /**
  58794. * (Highcharts, Highstock, Highmaps, Gantt) Whether to hide data labels that
  58795. * are outside the plot area. By default, the data label is moved inside the
  58796. * plot area according to the overflow option.
  58797. */
  58798. crop?: boolean;
  58799. /**
  58800. * (Highcharts, Highstock, Gantt) Whether to defer displaying the data
  58801. * labels until the initial series animation has finished. Setting to
  58802. * `false` renders the data label immediately. If set to `true` inherits the
  58803. * defer time set in plotOptions.series.animation.
  58804. */
  58805. defer?: boolean;
  58806. /**
  58807. * (Highcharts, Highstock, Highmaps, Gantt) Enable or disable the data
  58808. * labels.
  58809. */
  58810. enabled?: boolean;
  58811. /**
  58812. * (Highcharts, Highstock, Highmaps, Gantt) A declarative filter to control
  58813. * of which data labels to display. The declarative filter is designed for
  58814. * use when callback functions are not available, like when the chart
  58815. * options require a pure JSON structure or for use with graphical editors.
  58816. * For programmatic control, use the `formatter` instead, and return
  58817. * `undefined` to disable a single data label.
  58818. */
  58819. filter?: DataLabelsFilterOptionsObject;
  58820. /**
  58821. * (Highcharts, Highstock, Highmaps, Gantt) A format string for the data
  58822. * label. Available variables are the same as for `formatter`.
  58823. */
  58824. format?: string;
  58825. /**
  58826. * (Highcharts, Highstock, Highmaps, Gantt) Callback JavaScript function to
  58827. * format the data label. Note that if a `format` is defined, the format
  58828. * takes precedence and the formatter is ignored.
  58829. */
  58830. formatter?: DataLabelsFormatterCallbackFunction;
  58831. /**
  58832. * (Highcharts, Highstock, Highmaps, Gantt) For points with an extent, like
  58833. * columns or map areas, whether to align the data label inside the box or
  58834. * to the actual value point. Defaults to `false` in most cases, `true` in
  58835. * stacked columns.
  58836. */
  58837. inside?: boolean;
  58838. /**
  58839. * (Highcharts, Highstock, Highmaps, Gantt) Format for points with the value
  58840. * of null. Works analogously to format. `nullFormat` can be applied only to
  58841. * series which support displaying null points.
  58842. */
  58843. nullFormat?: (boolean|string);
  58844. /**
  58845. * (Highcharts, Highstock, Highmaps, Gantt) Callback JavaScript function
  58846. * that defines formatting for points with the value of null. Works
  58847. * analogously to formatter. `nullPointFormatter` can be applied only to
  58848. * series which support displaying null points.
  58849. */
  58850. nullFormatter?: DataLabelsFormatterCallbackFunction;
  58851. /**
  58852. * (Highcharts, Highstock, Highmaps, Gantt) How to handle data labels that
  58853. * flow outside the plot area. The default is `"justify"`, which aligns them
  58854. * inside the plot area. For columns and bars, this means it will be moved
  58855. * inside the bar. To display data labels outside the plot area, set `crop`
  58856. * to `false` and `overflow` to `"allow"`.
  58857. */
  58858. overflow?: boolean;
  58859. /**
  58860. * (Highcharts, Highstock, Highmaps, Gantt) When either the `borderWidth` or
  58861. * the `backgroundColor` is set, this is the padding within the box.
  58862. */
  58863. padding?: number;
  58864. /**
  58865. * (Highcharts, Highstock, Highmaps, Gantt) Aligns data labels relative to
  58866. * points. If `center` alignment is not possible, it defaults to `right`.
  58867. */
  58868. position?: AlignValue;
  58869. /**
  58870. * (Highcharts, Highstock, Highmaps, Gantt) Text rotation in degrees. Note
  58871. * that due to a more complex structure, backgrounds, borders and padding
  58872. * will be lost on a rotated data label.
  58873. */
  58874. rotation?: number;
  58875. /**
  58876. * (Highcharts, Highstock, Highmaps, Gantt) The shadow of the box. Works
  58877. * best with `borderWidth` or `backgroundColor`. Since 2.3 the shadow can be
  58878. * an object configuration containing `color`, `offsetX`, `offsetY`,
  58879. * `opacity` and `width`.
  58880. */
  58881. shadow?: (boolean|ShadowOptionsObject);
  58882. /**
  58883. * (Highcharts, Highstock, Highmaps, Gantt) The name of a symbol to use for
  58884. * the border around the label. Symbols are predefined functions on the
  58885. * Renderer object.
  58886. */
  58887. shape?: string;
  58888. /**
  58889. * (Highcharts, Highstock, Highmaps, Gantt) Styles for the label. The
  58890. * default `color` setting is `"contrast"`, which is a pseudo color that
  58891. * Highcharts picks up and applies the maximum contrast to the underlying
  58892. * point item, for example the bar in a bar chart.
  58893. *
  58894. * The `textOutline` is a pseudo property that applies an outline of the
  58895. * given width with the given color, which by default is the maximum
  58896. * contrast to the text. So a bright text color will result in a black text
  58897. * outline for maximum readability on a mixed background. In some cases,
  58898. * especially with grayscale text, the text outline doesn't work well, in
  58899. * which cases it can be disabled by setting it to `"none"`. When `useHTML`
  58900. * is true, the `textOutline` will not be picked up. In this, case, the same
  58901. * effect can be acheived through the `text-shadow` CSS property.
  58902. *
  58903. * For some series types, where each point has an extent, like for example
  58904. * tree maps, the data label may overflow the point. There are two
  58905. * strategies for handling overflow. By default, the text will wrap to
  58906. * multiple lines. The other strategy is to set `style.textOverflow` to
  58907. * `ellipsis`, which will keep the text on one line plus it will break
  58908. * inside long words.
  58909. */
  58910. style?: CSSObject;
  58911. /**
  58912. * (Highcharts, Highstock, Highmaps, Gantt) Options for a label text which
  58913. * should follow marker's shape. Border and background are disabled for a
  58914. * label that follows a path.
  58915. *
  58916. * **Note:** Only SVG-based renderer supports this option. Setting `useHTML`
  58917. * to true will disable this option.
  58918. */
  58919. textPath?: DataLabelsTextPathOptionsObject;
  58920. /**
  58921. * (Highcharts, Highstock, Highmaps, Gantt) Whether to use HTML to render
  58922. * the labels.
  58923. */
  58924. useHTML?: boolean;
  58925. /**
  58926. * (Highcharts, Highstock, Highmaps, Gantt) The vertical alignment of a data
  58927. * label. Can be one of `top`, `middle` or `bottom`. The default value
  58928. * depends on the data, for instance in a column chart, the label is above
  58929. * positive values and below negative values.
  58930. */
  58931. verticalAlign?: (VerticalAlignValue|null);
  58932. /**
  58933. * (Highcharts, Highstock, Highmaps, Gantt) The x position offset of the
  58934. * label relative to the point in pixels.
  58935. */
  58936. x?: number;
  58937. /**
  58938. * (Highcharts, Highstock, Highmaps, Gantt) The y position offset of the
  58939. * label relative to the point in pixels.
  58940. */
  58941. y?: number;
  58942. /**
  58943. * (Highcharts, Highstock, Highmaps, Gantt) The Z index of the data labels.
  58944. * The default Z index puts it above the series. Use a Z index of 2 to
  58945. * display it behind the series.
  58946. */
  58947. z?: number;
  58948. }
  58949. /**
  58950. * (Highcharts, Highstock) Options for the series data sorting.
  58951. */
  58952. export interface PlotMappointDataSortingOptions {
  58953. /**
  58954. * (Highcharts, Highstock) Enable or disable data sorting for the series.
  58955. * Use xAxis.reversed to change the sorting order.
  58956. */
  58957. enabled?: boolean;
  58958. /**
  58959. * (Highcharts, Highstock) Whether to allow matching points by name in an
  58960. * update. If this option is disabled, points will be matched by order.
  58961. */
  58962. matchByName?: boolean;
  58963. /**
  58964. * (Highcharts, Highstock) Determines what data value should be used to sort
  58965. * by.
  58966. */
  58967. sortKey?: string;
  58968. }
  58969. /**
  58970. * (Highmaps) Style options for the guide box. The guide box has one state by
  58971. * default, the `default` state.
  58972. */
  58973. export interface PlotMappointDragDropGuideBoxOptions {
  58974. /**
  58975. * (Highmaps) Style options for the guide box default state.
  58976. */
  58977. default?: DragDropGuideBoxOptionsObject;
  58978. }
  58979. /**
  58980. * (Highcharts, Highstock) Apply a jitter effect for the rendered markers. When
  58981. * plotting discrete values, a little random noise may help telling the points
  58982. * apart. The jitter setting applies a random displacement of up to `n` axis
  58983. * units in either direction. So for example on a horizontal X axis, setting the
  58984. * `jitter.x` to 0.24 will render the point in a random position between 0.24
  58985. * units to the left and 0.24 units to the right of the true axis position. On a
  58986. * category axis, setting it to 0.5 will fill up the bin and make the data
  58987. * appear continuous.
  58988. *
  58989. * When rendered on top of a box plot or a column series, a jitter value of 0.24
  58990. * will correspond to the underlying series' default groupPadding and
  58991. * pointPadding settings.
  58992. */
  58993. export interface PlotMappointJitterOptions {
  58994. /**
  58995. * (Highcharts, Highstock) The maximal X offset for the random jitter
  58996. * effect.
  58997. */
  58998. x?: number;
  58999. /**
  59000. * (Highcharts, Highstock) The maximal Y offset for the random jitter
  59001. * effect.
  59002. */
  59003. y?: number;
  59004. }
  59005. /**
  59006. * (Highmaps) A mappoint series is a special form of scatter series where the
  59007. * points can be laid out in map coordinates on top of a map.
  59008. *
  59009. * In TypeScript the type option must always be set.
  59010. *
  59011. * Configuration options for the series are given in three levels:
  59012. *
  59013. * 1. Options for all series in a chart are defined in the plotOptions.series
  59014. * object.
  59015. *
  59016. * 2. Options for all `mappoint` series are defined in plotOptions.mappoint.
  59017. *
  59018. * 3. Options for one single series are given in the series instance array. (see
  59019. * online documentation for example)
  59020. */
  59021. export interface PlotMappointOptions {
  59022. /**
  59023. * (Highmaps) Accessibility options for a series.
  59024. */
  59025. accessibility?: SeriesAccessibilityOptionsObject;
  59026. /**
  59027. * (Highmaps) Whether all areas of the map defined in `mapData` should be
  59028. * rendered. If `true`, areas which don't correspond to a data point, are
  59029. * rendered as `null` points. If `false`, those areas are skipped.
  59030. */
  59031. allAreas?: boolean;
  59032. /**
  59033. * (Highmaps) Allow this series' points to be selected by clicking on the
  59034. * graphic (columns, point markers, pie slices, map areas etc).
  59035. *
  59036. * The selected points can be handled by point select and unselect events,
  59037. * or collectively by the getSelectedPoints function.
  59038. *
  59039. * And alternative way of selecting points is through dragging.
  59040. */
  59041. allowPointSelect?: boolean;
  59042. /**
  59043. * (Highmaps) Enable or disable the initial animation when a series is
  59044. * displayed. The animation can also be set as a configuration object.
  59045. * Please note that this option only applies to the initial animation of the
  59046. * series itself. For other animations, see chart.animation and the
  59047. * animation parameter under the API methods. The following properties are
  59048. * supported:
  59049. *
  59050. * - `defer`: The animation delay time in milliseconds.
  59051. *
  59052. * - `duration`: The duration of the animation in milliseconds.
  59053. *
  59054. * - `easing`: Can be a string reference to an easing function set on the
  59055. * `Math` object or a function. See the _Custom easing function_ demo below.
  59056. *
  59057. * Due to poor performance, animation is disabled in old IE browsers for
  59058. * several chart types.
  59059. */
  59060. animation?: (boolean|PlotMappointAnimationOptions|Partial<AnimationOptionsObject>);
  59061. /**
  59062. * (Highmaps) For some series, there is a limit that shuts down initial
  59063. * animation by default when the total number of points in the chart is too
  59064. * high. For example, for a column chart and its derivatives, animation does
  59065. * not run if there is more than 250 points totally. To disable this cap,
  59066. * set `animationLimit` to `Infinity`.
  59067. */
  59068. animationLimit?: number;
  59069. /**
  59070. * (Highmaps) Sets the color blending in the boost module.
  59071. */
  59072. boostBlending?: OptionsBoostBlendingValue;
  59073. /**
  59074. * (Highmaps) Set the point threshold for when a series should enter boost
  59075. * mode.
  59076. *
  59077. * Setting it to e.g. 2000 will cause the series to enter boost mode when
  59078. * there are 2000 or more points in the series.
  59079. *
  59080. * To disable boosting on the series, set the `boostThreshold` to 0. Setting
  59081. * it to 1 will force boosting.
  59082. *
  59083. * Note that the cropThreshold also affects this setting. When zooming in on
  59084. * a series that has fewer points than the `cropThreshold`, all points are
  59085. * rendered although outside the visible plot area, and the `boostThreshold`
  59086. * won't take effect.
  59087. */
  59088. boostThreshold?: number;
  59089. /**
  59090. * (Highmaps) The border color of the map areas.
  59091. *
  59092. * In styled mode, the border stroke is given in the `.highcharts-point`
  59093. * class.
  59094. */
  59095. borderColor?: (ColorString|GradientColorObject|PatternObject);
  59096. /**
  59097. * (Highmaps) The border width of each map area.
  59098. *
  59099. * In styled mode, the border stroke width is given in the
  59100. * `.highcharts-point` class.
  59101. */
  59102. borderWidth?: number;
  59103. /**
  59104. * (Highmaps) An additional class name to apply to the series' graphical
  59105. * elements. This option does not replace default class names of the
  59106. * graphical element.
  59107. */
  59108. className?: string;
  59109. /**
  59110. * (Highmaps) Disable this option to allow series rendering in the whole
  59111. * plotting area.
  59112. *
  59113. * **Note:** Clipping should be always enabled when chart.zoomType is set
  59114. */
  59115. clip?: boolean;
  59116. /**
  59117. * (Highcharts, Highmaps) Options for marker clusters, the concept of
  59118. * sampling the data values into larger blocks in order to ease readability
  59119. * and increase performance of the JavaScript charts.
  59120. *
  59121. * Note: marker clusters module is not working with `boost` and
  59122. * `draggable-points` modules.
  59123. *
  59124. * The marker clusters feature requires the marker-clusters.js file to be
  59125. * loaded, found in the modules directory of the download package, or online
  59126. * at code.highcharts.com/modules/marker-clusters.js.
  59127. */
  59128. cluster?: PlotMappointClusterOptions;
  59129. /**
  59130. * (Highmaps) The main color of the series. In line type series it applies
  59131. * to the line and the point markers unless otherwise specified. In bar type
  59132. * series it applies to the bars unless a color is specified per point. The
  59133. * default value is pulled from the `options.colors` array.
  59134. *
  59135. * In styled mode, the color can be defined by the colorIndex option. Also,
  59136. * the series color can be set with the `.highcharts-series`,
  59137. * `.highcharts-color-{n}`, `.highcharts-{type}-series` or
  59138. * `.highcharts-series-{n}` class, or individual classes given by the
  59139. * `className` option.
  59140. */
  59141. color?: (ColorString|GradientColorObject|PatternObject);
  59142. /**
  59143. * (Highcharts, Highstock, Highmaps) When using dual or multiple color axes,
  59144. * this number defines which colorAxis the particular series is connected
  59145. * to. It refers to either the axis id or the index of the axis in the
  59146. * colorAxis array, with 0 being the first. Set this option to false to
  59147. * prevent a series from connecting to the default color axis.
  59148. *
  59149. * Since v7.2.0 the option can also be an axis id or an axis index instead
  59150. * of a boolean flag.
  59151. */
  59152. colorAxis?: (boolean|number|string);
  59153. /**
  59154. * (Highmaps) Styled mode only. A specific color index to use for the
  59155. * series, so its graphic representations are given the class name
  59156. * `highcharts-color-{n}`.
  59157. */
  59158. colorIndex?: number;
  59159. /**
  59160. * (Highcharts, Highstock, Highmaps) Determines what data value should be
  59161. * used to calculate point color if `colorAxis` is used. Requires to set
  59162. * `min` and `max` if some custom point property is used or if approximation
  59163. * for data grouping is set to `'sum'`.
  59164. */
  59165. colorKey?: string;
  59166. /**
  59167. * (Highstock) Compare the values of the series against the first non-null,
  59168. * non- zero value in the visible range. The y axis will show percentage or
  59169. * absolute change depending on whether `compare` is set to `"percent"` or
  59170. * `"value"`. When this is applied to multiple series, it allows comparing
  59171. * the development of the series against each other. Adds a `change` field
  59172. * to every point object.
  59173. */
  59174. compare?: string;
  59175. /**
  59176. * (Highstock) When compare is `percent`, this option dictates whether to
  59177. * use 0 or 100 as the base of comparison.
  59178. */
  59179. compareBase?: (0|100);
  59180. /**
  59181. * (Highstock) Defines if comparison should start from the first point
  59182. * within the visible range or should start from the first point **before**
  59183. * the range.
  59184. *
  59185. * In other words, this flag determines if first point within the visible
  59186. * range will have 0% (`compareStart=true`) or should have been already
  59187. * calculated according to the previous point (`compareStart=false`).
  59188. */
  59189. compareStart?: boolean;
  59190. /**
  59191. * (Highcharts) Polar charts only. Whether to connect the ends of a line
  59192. * series plot across the extremes.
  59193. */
  59194. connectEnds?: boolean;
  59195. /**
  59196. * (Highcharts, Highstock) Whether to connect a graph line across null
  59197. * points, or render a gap between the two points on either side of the
  59198. * null.
  59199. */
  59200. connectNulls?: boolean;
  59201. /**
  59202. * (Gantt) Override Pathfinder connector options for a series. Requires
  59203. * Highcharts Gantt to be loaded.
  59204. */
  59205. connectors?: SeriesConnectorsOptionsObject;
  59206. /**
  59207. * (Highcharts, Highstock, Gantt) When true, each point or column edge is
  59208. * rounded to its nearest pixel in order to render sharp on screen. In some
  59209. * cases, when there are a lot of densely packed columns, this leads to
  59210. * visible difference in column widths or distance between columns. In these
  59211. * cases, setting `crisp` to `false` may look better, even though each
  59212. * column is rendered blurry.
  59213. */
  59214. crisp?: boolean;
  59215. /**
  59216. * (Highmaps) You can set the cursor to "pointer" if you have click events
  59217. * attached to the series, to signal to the user that the points and lines
  59218. * can be clicked.
  59219. *
  59220. * In styled mode, the series cursor can be set with the same classes as
  59221. * listed under series.color.
  59222. */
  59223. cursor?: (string|CursorValue);
  59224. /**
  59225. * (Highmaps) A reserved subspace to store options and values for customized
  59226. * functionality. Here you can add additional data for your own event
  59227. * callbacks and formatter callbacks.
  59228. */
  59229. custom?: Dictionary<any>;
  59230. /**
  59231. * (Highmaps) Name of the dash style to use for the graph, or for some
  59232. * series types the outline of each shape.
  59233. *
  59234. * In styled mode, the stroke dash-array can be set with the same classes as
  59235. * listed under series.color.
  59236. */
  59237. dashStyle?: DashStyleValue;
  59238. /**
  59239. * (Highstock) Data grouping is the concept of sampling the data values into
  59240. * larger blocks in order to ease readability and increase performance of
  59241. * the JavaScript charts. Highstock by default applies data grouping when
  59242. * the points become closer than a certain pixel value, determined by the
  59243. * `groupPixelWidth` option.
  59244. *
  59245. * If data grouping is applied, the grouping information of grouped points
  59246. * can be read from the Point.dataGroup. If point options other than the
  59247. * data itself are set, for example `name` or `color` or custom properties,
  59248. * the grouping logic doesn't know how to group it. In this case the options
  59249. * of the first point instance are copied over to the group point. This can
  59250. * be altered through a custom `approximation` callback function.
  59251. */
  59252. dataGrouping?: DataGroupingOptionsObject;
  59253. /**
  59254. * (Highcharts, Highstock, Highmaps, Gantt) Options for the series data
  59255. * labels, appearing next to each data point.
  59256. *
  59257. * Since v6.2.0, multiple data labels can be applied to each single point by
  59258. * defining them as an array of configs.
  59259. *
  59260. * In styled mode, the data labels can be styled with the
  59261. * `.highcharts-data-label-box` and `.highcharts-data-label` class names
  59262. * (see example).
  59263. */
  59264. dataLabels?: (PlotMappointDataLabelsOptions|Array<PlotMappointDataLabelsOptions>);
  59265. /**
  59266. * (Highcharts, Highstock) Options for the series data sorting.
  59267. */
  59268. dataSorting?: (DataSortingOptionsObject|PlotMappointDataSortingOptions);
  59269. /**
  59270. * (Highmaps) A description of the series to add to the screen reader
  59271. * information about the series.
  59272. */
  59273. description?: string;
  59274. /**
  59275. * (Highmaps) The draggable-points module allows points to be moved around
  59276. * or modified in the chart. In addition to the options mentioned under the
  59277. * `dragDrop` API structure, the module fires three events, point.dragStart,
  59278. * point.drag and point.drop.
  59279. */
  59280. dragDrop?: SeriesDragDropOptionsObject;
  59281. /**
  59282. * (Highmaps) Enable or disable the mouse tracking for a specific series.
  59283. * This includes point tooltips and click events on graphs and points. For
  59284. * large datasets it improves performance.
  59285. */
  59286. enableMouseTracking?: boolean;
  59287. /**
  59288. * (Highmaps) General event handlers for the series items. These event hooks
  59289. * can also be attached to the series at run time using the
  59290. * `Highcharts.addEvent` function.
  59291. */
  59292. events?: SeriesEventsOptionsObject;
  59293. /**
  59294. * (Highmaps) Determines whether the series should look for the nearest
  59295. * point in both dimensions or just the x-dimension when hovering the
  59296. * series. Defaults to `'xy'` for scatter series and `'x'` for most other
  59297. * series. If the data has duplicate x-values, it is recommended to set this
  59298. * to `'xy'` to allow hovering over all points.
  59299. *
  59300. * Applies only to series types using nearest neighbor search (not direct
  59301. * hover) for tooltip.
  59302. */
  59303. findNearestPointBy?: OptionsFindNearestPointByValue;
  59304. /**
  59305. * (Highstock) Defines when to display a gap in the graph, together with the
  59306. * gapUnit option.
  59307. *
  59308. * In case when `dataGrouping` is enabled, points can be grouped into a
  59309. * larger time span. This can make the grouped points to have a greater
  59310. * distance than the absolute value of `gapSize` property, which will result
  59311. * in disappearing graph completely. To prevent this situation the mentioned
  59312. * distance between grouped points is used instead of previously defined
  59313. * `gapSize`.
  59314. *
  59315. * In practice, this option is most often used to visualize gaps in time
  59316. * series. In a stock chart, intraday data is available for daytime hours,
  59317. * while gaps will appear in nights and weekends.
  59318. */
  59319. gapSize?: number;
  59320. /**
  59321. * (Highstock) Together with gapSize, this option defines where to draw gaps
  59322. * in the graph.
  59323. *
  59324. * When the `gapUnit` is `"relative"` (default), a gap size of 5 means that
  59325. * if the distance between two points is greater than 5 times that of the
  59326. * two closest points, the graph will be broken.
  59327. *
  59328. * When the `gapUnit` is `"value"`, the gap is based on absolute axis
  59329. * values, which on a datetime axis is milliseconds. This also applies to
  59330. * the navigator series that inherits gap options from the base series.
  59331. */
  59332. gapUnit?: OptionsGapUnitValue;
  59333. /**
  59334. * (Highcharts, Highstock, Gantt) Whether to use the Y extremes of the total
  59335. * chart width or only the zoomed area when zooming in on parts of the X
  59336. * axis. By default, the Y axis adjusts to the min and max of the visible
  59337. * data. Cartesian series only.
  59338. */
  59339. getExtremesFromAll?: boolean;
  59340. /**
  59341. * (Highmaps) When set to `false` will prevent the series data from being
  59342. * included in any form of data export.
  59343. *
  59344. * Since version 6.0.0 until 7.1.0 the option was existing undocumented as
  59345. * `includeInCSVExport`.
  59346. */
  59347. includeInDataExport?: boolean;
  59348. /**
  59349. * (Highcharts, Highstock) Apply a jitter effect for the rendered markers.
  59350. * When plotting discrete values, a little random noise may help telling the
  59351. * points apart. The jitter setting applies a random displacement of up to
  59352. * `n` axis units in either direction. So for example on a horizontal X
  59353. * axis, setting the `jitter.x` to 0.24 will render the point in a random
  59354. * position between 0.24 units to the left and 0.24 units to the right of
  59355. * the true axis position. On a category axis, setting it to 0.5 will fill
  59356. * up the bin and make the data appear continuous.
  59357. *
  59358. * When rendered on top of a box plot or a column series, a jitter value of
  59359. * 0.24 will correspond to the underlying series' default groupPadding and
  59360. * pointPadding settings.
  59361. */
  59362. jitter?: PlotMappointJitterOptions;
  59363. /**
  59364. * (Highmaps) What property to join the `mapData` to the value data. For
  59365. * example, if joinBy is "code", the mapData items with a specific code is
  59366. * merged into the data with the same code. For maps loaded from GeoJSON,
  59367. * the keys may be held in each point's `properties` object.
  59368. *
  59369. * The joinBy option can also be an array of two values, where the first
  59370. * points to a key in the `mapData`, and the second points to another key in
  59371. * the `data`.
  59372. *
  59373. * When joinBy is `null`, the map items are joined by their position in the
  59374. * array, which performs much better in maps with many data points. This is
  59375. * the recommended option if you are printing more than a thousand data
  59376. * points and have a backend that can preprocess the data into a parallel
  59377. * array of the mapData.
  59378. */
  59379. joinBy?: (string|Array<string>);
  59380. /**
  59381. * (Highmaps) An array specifying which option maps to which key in the data
  59382. * point array. This makes it convenient to work with unstructured data
  59383. * arrays from different sources.
  59384. */
  59385. keys?: Array<string>;
  59386. /**
  59387. * (Highcharts, Highstock, Gantt) Series labels are placed as close to the
  59388. * series as possible in a natural way, seeking to avoid other series. The
  59389. * goal of this feature is to make the chart more easily readable, like if a
  59390. * human designer placed the labels in the optimal position.
  59391. *
  59392. * The series labels currently work with series types having a `graph` or an
  59393. * `area`.
  59394. */
  59395. label?: SeriesLabelOptionsObject;
  59396. /**
  59397. * (Highstock) The line marks the last price from all points.
  59398. */
  59399. lastPrice?: SeriesLastPriceOptionsObject;
  59400. /**
  59401. * (Highstock) The line marks the last price from visible range of points.
  59402. */
  59403. lastVisiblePrice?: SeriesLastVisiblePriceOptionsObject;
  59404. /**
  59405. * (Highcharts, Highstock) The SVG value used for the `stroke-linecap` and
  59406. * `stroke-linejoin` of a line graph. Round means that lines are rounded in
  59407. * the ends and bends.
  59408. */
  59409. linecap?: SeriesLinecapValue;
  59410. /**
  59411. * (Highcharts, Highstock) The width of the line connecting the data points.
  59412. */
  59413. lineWidth?: number;
  59414. /**
  59415. * (Highcharts, Highstock, Gantt) The id of another series to link to.
  59416. * Additionally, the value can be ":previous" to link to the previous
  59417. * series. When two series are linked, only the first one appears in the
  59418. * legend. Toggling the visibility of this also toggles the linked series.
  59419. *
  59420. * If master series uses data sorting and linked series does not have its
  59421. * own sorting definition, the linked series will be sorted in the same
  59422. * order as the master one.
  59423. */
  59424. linkedTo?: string;
  59425. /**
  59426. * (Highmaps) Options for the point markers of line-like series. Properties
  59427. * like `fillColor`, `lineColor` and `lineWidth` define the visual
  59428. * appearance of the markers. Other series types, like column series, don't
  59429. * have markers, but have visual options on the series level instead.
  59430. *
  59431. * In styled mode, the markers can be styled with the `.highcharts-point`,
  59432. * `.highcharts-point-hover` and `.highcharts-point-select` class names.
  59433. */
  59434. marker?: PointMarkerOptionsObject;
  59435. /**
  59436. * (Highstock) Options for the corresponding navigator series if
  59437. * `showInNavigator` is `true` for this series. Available options are the
  59438. * same as any series, documented at plotOptions and series.
  59439. *
  59440. * These options are merged with options in navigator.series, and will take
  59441. * precedence if the same option is defined both places.
  59442. */
  59443. navigatorOptions?: PlotSeriesOptions;
  59444. /**
  59445. * (Highmaps) The color for the parts of the graph or points that are below
  59446. * the threshold. Note that `zones` takes precedence over the negative
  59447. * color. Using `negativeColor` is equivalent to applying a zone with value
  59448. * of 0.
  59449. */
  59450. negativeColor?: (ColorString|GradientColorObject|PatternObject);
  59451. /**
  59452. * (Highmaps) Opacity of a series parts: line, fill (e.g. area) and
  59453. * dataLabels.
  59454. */
  59455. opacity?: number;
  59456. /**
  59457. * (Highmaps) Properties for each single point.
  59458. */
  59459. point?: PlotSeriesPointOptions;
  59460. /**
  59461. * (Highmaps) Same as accessibility.pointDescriptionFormatter, but for an
  59462. * individual series. Overrides the chart wide configuration.
  59463. */
  59464. pointDescriptionFormatter?: Function;
  59465. /**
  59466. * (Highcharts, Highstock, Gantt) If no x values are given for the points in
  59467. * a series, `pointInterval` defines the interval of the x values. For
  59468. * example, if a series contains one value every decade starting from year
  59469. * 0, set `pointInterval` to `10`. In true `datetime` axes, the
  59470. * `pointInterval` is set in milliseconds.
  59471. *
  59472. * It can be also be combined with `pointIntervalUnit` to draw irregular
  59473. * time intervals.
  59474. *
  59475. * Please note that this options applies to the _series data_, not the
  59476. * interval of the axis ticks, which is independent.
  59477. */
  59478. pointInterval?: number;
  59479. /**
  59480. * (Highcharts, Highstock, Gantt) On datetime series, this allows for
  59481. * setting the pointInterval to irregular time units, `day`, `month` and
  59482. * `year`. A day is usually the same as 24 hours, but `pointIntervalUnit`
  59483. * also takes the DST crossover into consideration when dealing with local
  59484. * time. Combine this option with `pointInterval` to draw weeks, quarters, 6
  59485. * months, 10 years etc.
  59486. *
  59487. * Please note that this options applies to the _series data_, not the
  59488. * interval of the axis ticks, which is independent.
  59489. */
  59490. pointIntervalUnit?: OptionsPointIntervalUnitValue;
  59491. /**
  59492. * (Highstock) The width of each point on the x axis. For example in a
  59493. * column chart with one value each day, the pointRange would be 1 day (= 24
  59494. * * 3600
  59495. *
  59496. * * 1000 milliseconds). This is normally computed automatically, but this
  59497. * option can be used to override the automatic value.
  59498. */
  59499. pointRange?: number;
  59500. /**
  59501. * (Highcharts, Highstock, Gantt) If no x values are given for the points in
  59502. * a series, pointStart defines on what value to start. For example, if a
  59503. * series contains one yearly value starting from 1945, set pointStart to
  59504. * 1945.
  59505. */
  59506. pointStart?: number;
  59507. /**
  59508. * (Highmaps) Whether to select the series initially. If `showCheckbox` is
  59509. * true, the checkbox next to the series name in the legend will be checked
  59510. * for a selected series.
  59511. */
  59512. selected?: boolean;
  59513. /**
  59514. * (Highmaps) If true, a checkbox is displayed next to the legend item to
  59515. * allow selecting the series. The state of the checkbox is determined by
  59516. * the `selected` option.
  59517. */
  59518. showCheckbox?: boolean;
  59519. /**
  59520. * (Highmaps) Whether to display this particular series or series type in
  59521. * the legend. Standalone series are shown in legend by default, and linked
  59522. * series are not. Since v7.2.0 it is possible to show series that use
  59523. * colorAxis by setting this option to `true`.
  59524. */
  59525. showInLegend?: boolean;
  59526. /**
  59527. * (Highstock) Whether or not to show the series in the navigator. Takes
  59528. * precedence over navigator.baseSeries if defined.
  59529. */
  59530. showInNavigator?: boolean;
  59531. /**
  59532. * (Highmaps) If set to `true`, the accessibility module will skip past the
  59533. * points in this series for keyboard navigation.
  59534. */
  59535. skipKeyboardNavigation?: boolean;
  59536. /**
  59537. * (Highcharts, Highstock) When this is true, the series will not cause the
  59538. * Y axis to cross the zero plane (or threshold option) unless the data
  59539. * actually crosses the plane.
  59540. *
  59541. * For example, if `softThreshold` is `false`, a series of 0, 1, 2, 3 will
  59542. * make the Y axis show negative values according to the `minPadding`
  59543. * option. If `softThreshold` is `true`, the Y axis starts at 0.
  59544. */
  59545. softThreshold?: boolean;
  59546. /**
  59547. * (Highcharts, Highstock) Whether to stack the values of each series on top
  59548. * of each other. Possible values are `undefined` to disable, `"normal"` to
  59549. * stack by value or `"percent"`.
  59550. *
  59551. * When stacking is enabled, data must be sorted in ascending X order.
  59552. *
  59553. * Some stacking options are related to specific series types. In the
  59554. * streamgraph series type, the stacking option is set to `"stream"`. The
  59555. * second one is `"overlap"`, which only applies to waterfall series.
  59556. */
  59557. stacking?: OptionsStackingValue;
  59558. states?: SeriesStatesOptionsObject;
  59559. /**
  59560. * (Highcharts, Highstock) Whether to apply steps to the line. Possible
  59561. * values are `left`, `center` and `right`.
  59562. */
  59563. step?: OptionsStepValue;
  59564. /**
  59565. * (Highcharts, Highstock) Sticky tracking of mouse events. When true, the
  59566. * `mouseOut` event on a series isn't triggered until the mouse moves over
  59567. * another series, or out of the plot area. When false, the `mouseOut` event
  59568. * on a series is triggered when the mouse leaves the area around the
  59569. * series' graph or markers. This also implies the tooltip. When
  59570. * `stickyTracking` is false and `tooltip.shared` is false, the tooltip will
  59571. * be hidden when moving the mouse between series.
  59572. */
  59573. stickyTracking?: boolean;
  59574. /**
  59575. * (Highcharts, Highstock) The threshold, also called zero level or base
  59576. * level. For line type series this is only used in conjunction with
  59577. * negativeColor.
  59578. */
  59579. threshold?: (number|null);
  59580. /**
  59581. * (Highcharts, Highstock) A configuration object for the tooltip rendering
  59582. * of each single series. Properties are inherited from tooltip. Overridable
  59583. * properties are `headerFormat`, `pointFormat`, `yDecimals`, `xDateFormat`,
  59584. * `yPrefix` and `ySuffix`. Unlike other series, in a scatter plot the
  59585. * series.name by default shows in the headerFormat and point.x and point.y
  59586. * in the pointFormat.
  59587. */
  59588. tooltip?: SeriesTooltipOptionsObject;
  59589. /**
  59590. * (Highcharts, Highstock, Gantt) When a series contains a data array that
  59591. * is longer than this, only one dimensional arrays of numbers, or two
  59592. * dimensional arrays with x and y values are allowed. Also, only the first
  59593. * point is tested, and the rest are assumed to be the same format. This
  59594. * saves expensive data checking and indexing in long series. Set it to `0`
  59595. * disable.
  59596. *
  59597. * Note: In boost mode turbo threshold is forced. Only array of numbers or
  59598. * two dimensional arrays are allowed.
  59599. */
  59600. turboThreshold?: number;
  59601. /**
  59602. * (Highmaps) Set the initial visibility of the series.
  59603. */
  59604. visible?: boolean;
  59605. /**
  59606. * (Highmaps) Define the z index of the series.
  59607. */
  59608. zIndex?: number;
  59609. /**
  59610. * (Highcharts, Highstock) Defines the Axis on which the zones are applied.
  59611. */
  59612. zoneAxis?: string;
  59613. /**
  59614. * (Highcharts, Highstock) An array defining zones within a series. Zones
  59615. * can be applied to the X axis, Y axis or Z axis for bubbles, according to
  59616. * the `zoneAxis` option. The zone definitions have to be in ascending order
  59617. * regarding to the value.
  59618. *
  59619. * In styled mode, the color zones are styled with the
  59620. * `.highcharts-zone-{n}` class, or custom classed from the `className`
  59621. * option (view live demo).
  59622. */
  59623. zones?: Array<SeriesZonesOptionsObject>;
  59624. }
  59625. /**
  59626. * (Highstock) Enable or disable the initial animation when a series is
  59627. * displayed. The animation can also be set as a configuration object. Please
  59628. * note that this option only applies to the initial animation of the series
  59629. * itself. For other animations, see chart.animation and the animation parameter
  59630. * under the API methods. The following properties are supported:
  59631. *
  59632. * - `defer`: The animation delay time in milliseconds.
  59633. *
  59634. * - `duration`: The duration of the animation in milliseconds.
  59635. *
  59636. * - `easing`: Can be a string reference to an easing function set on the `Math`
  59637. * object or a function. See the _Custom easing function_ demo below.
  59638. *
  59639. * Due to poor performance, animation is disabled in old IE browsers for several
  59640. * chart types.
  59641. */
  59642. export interface PlotMfiAnimationOptions {
  59643. defer?: number;
  59644. }
  59645. /**
  59646. * (Highcharts, Highstock, Highmaps, Gantt) Enable or disable the initial
  59647. * animation when a series is displayed for the `dataLabels`. The animation can
  59648. * also be set as a configuration object. Please note that this option only
  59649. * applies to the initial animation. For other animations, see chart.animation
  59650. * and the animation parameter under the API methods. The following properties
  59651. * are supported:
  59652. *
  59653. * - `defer`: The animation delay time in milliseconds.
  59654. */
  59655. export interface PlotMfiDataLabelsAnimationOptions {
  59656. /**
  59657. * (Highcharts, Highstock, Highmaps, Gantt) The animation delay time in
  59658. * milliseconds. Set to `0` renders dataLabel immediately. As `undefined`
  59659. * inherits defer time from the series.animation.defer.
  59660. */
  59661. defer?: number;
  59662. }
  59663. /**
  59664. * (Highcharts, Highstock, Highmaps, Gantt) Options for the series data labels,
  59665. * appearing next to each data point.
  59666. *
  59667. * Since v6.2.0, multiple data labels can be applied to each single point by
  59668. * defining them as an array of configs.
  59669. *
  59670. * In styled mode, the data labels can be styled with the
  59671. * `.highcharts-data-label-box` and `.highcharts-data-label` class names (see
  59672. * example).
  59673. */
  59674. export interface PlotMfiDataLabelsOptions {
  59675. /**
  59676. * (Highcharts, Highstock, Highmaps, Gantt) The alignment of the data label
  59677. * compared to the point. If `right`, the right side of the label should be
  59678. * touching the point. For points with an extent, like columns, the
  59679. * alignments also dictates how to align it inside the box, as given with
  59680. * the inside option. Can be one of `left`, `center` or `right`.
  59681. */
  59682. align?: (AlignValue|null);
  59683. /**
  59684. * (Highcharts, Highstock, Highmaps, Gantt) Whether to allow data labels to
  59685. * overlap. To make the labels less sensitive for overlapping, the
  59686. * dataLabels.padding can be set to 0.
  59687. */
  59688. allowOverlap?: boolean;
  59689. /**
  59690. * (Highcharts, Highstock, Highmaps, Gantt) Enable or disable the initial
  59691. * animation when a series is displayed for the `dataLabels`. The animation
  59692. * can also be set as a configuration object. Please note that this option
  59693. * only applies to the initial animation. For other animations, see
  59694. * chart.animation and the animation parameter under the API methods. The
  59695. * following properties are supported:
  59696. *
  59697. * - `defer`: The animation delay time in milliseconds.
  59698. */
  59699. animation?: (boolean|PlotMfiDataLabelsAnimationOptions|Partial<AnimationOptionsObject>);
  59700. /**
  59701. * (Highcharts, Highstock, Highmaps, Gantt) The background color or gradient
  59702. * for the data label.
  59703. */
  59704. backgroundColor?: (ColorString|GradientColorObject|PatternObject);
  59705. /**
  59706. * (Highcharts, Highstock, Highmaps, Gantt) The border color for the data
  59707. * label. Defaults to `undefined`.
  59708. */
  59709. borderColor?: (ColorString|GradientColorObject|PatternObject);
  59710. /**
  59711. * (Highcharts, Highstock, Highmaps, Gantt) The border radius in pixels for
  59712. * the data label.
  59713. */
  59714. borderRadius?: number;
  59715. /**
  59716. * (Highcharts, Highstock, Highmaps, Gantt) The border width in pixels for
  59717. * the data label.
  59718. */
  59719. borderWidth?: number;
  59720. /**
  59721. * (Highcharts, Highstock, Highmaps, Gantt) A class name for the data label.
  59722. * Particularly in styled mode, this can be used to give each series' or
  59723. * point's data label unique styling. In addition to this option, a default
  59724. * color class name is added so that we can give the labels a contrast text
  59725. * shadow.
  59726. */
  59727. className?: string;
  59728. /**
  59729. * (Highcharts, Highstock, Highmaps, Gantt) The text color for the data
  59730. * labels. Defaults to `undefined`. For certain series types, like column or
  59731. * map, the data labels can be drawn inside the points. In this case the
  59732. * data label will be drawn with maximum contrast by default. Additionally,
  59733. * it will be given a `text-outline` style with the opposite color, to
  59734. * further increase the contrast. This can be overridden by setting the
  59735. * `text-outline` style to `none` in the `dataLabels.style` option.
  59736. */
  59737. color?: (ColorString|GradientColorObject|PatternObject);
  59738. /**
  59739. * (Highcharts, Highstock, Highmaps, Gantt) Whether to hide data labels that
  59740. * are outside the plot area. By default, the data label is moved inside the
  59741. * plot area according to the overflow option.
  59742. */
  59743. crop?: boolean;
  59744. /**
  59745. * (Highcharts, Highstock, Gantt) Whether to defer displaying the data
  59746. * labels until the initial series animation has finished. Setting to
  59747. * `false` renders the data label immediately. If set to `true` inherits the
  59748. * defer time set in plotOptions.series.animation.
  59749. */
  59750. defer?: boolean;
  59751. /**
  59752. * (Highcharts, Highstock, Highmaps, Gantt) Enable or disable the data
  59753. * labels.
  59754. */
  59755. enabled?: boolean;
  59756. /**
  59757. * (Highcharts, Highstock, Highmaps, Gantt) A declarative filter to control
  59758. * of which data labels to display. The declarative filter is designed for
  59759. * use when callback functions are not available, like when the chart
  59760. * options require a pure JSON structure or for use with graphical editors.
  59761. * For programmatic control, use the `formatter` instead, and return
  59762. * `undefined` to disable a single data label.
  59763. */
  59764. filter?: DataLabelsFilterOptionsObject;
  59765. /**
  59766. * (Highcharts, Highstock, Highmaps, Gantt) A format string for the data
  59767. * label. Available variables are the same as for `formatter`.
  59768. */
  59769. format?: string;
  59770. /**
  59771. * (Highcharts, Highstock, Highmaps, Gantt) Callback JavaScript function to
  59772. * format the data label. Note that if a `format` is defined, the format
  59773. * takes precedence and the formatter is ignored.
  59774. */
  59775. formatter?: DataLabelsFormatterCallbackFunction;
  59776. /**
  59777. * (Highcharts, Highstock, Highmaps, Gantt) For points with an extent, like
  59778. * columns or map areas, whether to align the data label inside the box or
  59779. * to the actual value point. Defaults to `false` in most cases, `true` in
  59780. * stacked columns.
  59781. */
  59782. inside?: boolean;
  59783. /**
  59784. * (Highcharts, Highstock, Highmaps, Gantt) Format for points with the value
  59785. * of null. Works analogously to format. `nullFormat` can be applied only to
  59786. * series which support displaying null points.
  59787. */
  59788. nullFormat?: (boolean|string);
  59789. /**
  59790. * (Highcharts, Highstock, Highmaps, Gantt) Callback JavaScript function
  59791. * that defines formatting for points with the value of null. Works
  59792. * analogously to formatter. `nullPointFormatter` can be applied only to
  59793. * series which support displaying null points.
  59794. */
  59795. nullFormatter?: DataLabelsFormatterCallbackFunction;
  59796. /**
  59797. * (Highcharts, Highstock, Highmaps, Gantt) How to handle data labels that
  59798. * flow outside the plot area. The default is `"justify"`, which aligns them
  59799. * inside the plot area. For columns and bars, this means it will be moved
  59800. * inside the bar. To display data labels outside the plot area, set `crop`
  59801. * to `false` and `overflow` to `"allow"`.
  59802. */
  59803. overflow?: DataLabelsOverflowValue;
  59804. /**
  59805. * (Highcharts, Highstock, Highmaps, Gantt) When either the `borderWidth` or
  59806. * the `backgroundColor` is set, this is the padding within the box.
  59807. */
  59808. padding?: number;
  59809. /**
  59810. * (Highcharts, Highstock, Highmaps, Gantt) Aligns data labels relative to
  59811. * points. If `center` alignment is not possible, it defaults to `right`.
  59812. */
  59813. position?: AlignValue;
  59814. /**
  59815. * (Highcharts, Highstock, Highmaps, Gantt) Text rotation in degrees. Note
  59816. * that due to a more complex structure, backgrounds, borders and padding
  59817. * will be lost on a rotated data label.
  59818. */
  59819. rotation?: number;
  59820. /**
  59821. * (Highcharts, Highstock, Highmaps, Gantt) The shadow of the box. Works
  59822. * best with `borderWidth` or `backgroundColor`. Since 2.3 the shadow can be
  59823. * an object configuration containing `color`, `offsetX`, `offsetY`,
  59824. * `opacity` and `width`.
  59825. */
  59826. shadow?: (boolean|ShadowOptionsObject);
  59827. /**
  59828. * (Highcharts, Highstock, Highmaps, Gantt) The name of a symbol to use for
  59829. * the border around the label. Symbols are predefined functions on the
  59830. * Renderer object.
  59831. */
  59832. shape?: string;
  59833. /**
  59834. * (Highcharts, Highstock, Highmaps, Gantt) Styles for the label. The
  59835. * default `color` setting is `"contrast"`, which is a pseudo color that
  59836. * Highcharts picks up and applies the maximum contrast to the underlying
  59837. * point item, for example the bar in a bar chart.
  59838. *
  59839. * The `textOutline` is a pseudo property that applies an outline of the
  59840. * given width with the given color, which by default is the maximum
  59841. * contrast to the text. So a bright text color will result in a black text
  59842. * outline for maximum readability on a mixed background. In some cases,
  59843. * especially with grayscale text, the text outline doesn't work well, in
  59844. * which cases it can be disabled by setting it to `"none"`. When `useHTML`
  59845. * is true, the `textOutline` will not be picked up. In this, case, the same
  59846. * effect can be acheived through the `text-shadow` CSS property.
  59847. *
  59848. * For some series types, where each point has an extent, like for example
  59849. * tree maps, the data label may overflow the point. There are two
  59850. * strategies for handling overflow. By default, the text will wrap to
  59851. * multiple lines. The other strategy is to set `style.textOverflow` to
  59852. * `ellipsis`, which will keep the text on one line plus it will break
  59853. * inside long words.
  59854. */
  59855. style?: CSSObject;
  59856. /**
  59857. * (Highcharts, Highstock, Highmaps, Gantt) Options for a label text which
  59858. * should follow marker's shape. Border and background are disabled for a
  59859. * label that follows a path.
  59860. *
  59861. * **Note:** Only SVG-based renderer supports this option. Setting `useHTML`
  59862. * to true will disable this option.
  59863. */
  59864. textPath?: DataLabelsTextPathOptionsObject;
  59865. /**
  59866. * (Highcharts, Highstock, Highmaps, Gantt) Whether to use HTML to render
  59867. * the labels.
  59868. */
  59869. useHTML?: boolean;
  59870. /**
  59871. * (Highcharts, Highstock, Highmaps, Gantt) The vertical alignment of a data
  59872. * label. Can be one of `top`, `middle` or `bottom`. The default value
  59873. * depends on the data, for instance in a column chart, the label is above
  59874. * positive values and below negative values.
  59875. */
  59876. verticalAlign?: (VerticalAlignValue|null);
  59877. /**
  59878. * (Highcharts, Highstock, Highmaps, Gantt) The x position offset of the
  59879. * label relative to the point in pixels.
  59880. */
  59881. x?: number;
  59882. /**
  59883. * (Highcharts, Highstock, Highmaps, Gantt) The y position offset of the
  59884. * label relative to the point in pixels.
  59885. */
  59886. y?: number;
  59887. /**
  59888. * (Highcharts, Highstock, Highmaps, Gantt) The Z index of the data labels.
  59889. * The default Z index puts it above the series. Use a Z index of 2 to
  59890. * display it behind the series.
  59891. */
  59892. z?: number;
  59893. }
  59894. /**
  59895. * (Highcharts, Highstock) Options for the series data sorting.
  59896. */
  59897. export interface PlotMfiDataSortingOptions {
  59898. /**
  59899. * (Highcharts, Highstock) Enable or disable data sorting for the series.
  59900. * Use xAxis.reversed to change the sorting order.
  59901. */
  59902. enabled?: boolean;
  59903. /**
  59904. * (Highcharts, Highstock) Whether to allow matching points by name in an
  59905. * update. If this option is disabled, points will be matched by order.
  59906. */
  59907. matchByName?: boolean;
  59908. /**
  59909. * (Highcharts, Highstock) Determines what data value should be used to sort
  59910. * by.
  59911. */
  59912. sortKey?: string;
  59913. }
  59914. /**
  59915. * (Highstock) Money Flow Index. This series requires `linkedTo` option to be
  59916. * set and should be loaded after the `stock/indicators/indicators.js` file.
  59917. *
  59918. * In TypeScript the type option must always be set.
  59919. *
  59920. * Configuration options for the series are given in three levels:
  59921. *
  59922. * 1. Options for all series in a chart are defined in the plotOptions.series
  59923. * object.
  59924. *
  59925. * 2. Options for all `mfi` series are defined in plotOptions.mfi.
  59926. *
  59927. * 3. Options for one single series are given in the series instance array. (see
  59928. * online documentation for example)
  59929. */
  59930. export interface PlotMfiOptions {
  59931. /**
  59932. * (Highstock) Accessibility options for a series.
  59933. */
  59934. accessibility?: SeriesAccessibilityOptionsObject;
  59935. /**
  59936. * (Highstock) Allow this series' points to be selected by clicking on the
  59937. * graphic (columns, point markers, pie slices, map areas etc).
  59938. *
  59939. * The selected points can be handled by point select and unselect events,
  59940. * or collectively by the getSelectedPoints function.
  59941. *
  59942. * And alternative way of selecting points is through dragging.
  59943. */
  59944. allowPointSelect?: boolean;
  59945. /**
  59946. * (Highstock) Enable or disable the initial animation when a series is
  59947. * displayed. The animation can also be set as a configuration object.
  59948. * Please note that this option only applies to the initial animation of the
  59949. * series itself. For other animations, see chart.animation and the
  59950. * animation parameter under the API methods. The following properties are
  59951. * supported:
  59952. *
  59953. * - `defer`: The animation delay time in milliseconds.
  59954. *
  59955. * - `duration`: The duration of the animation in milliseconds.
  59956. *
  59957. * - `easing`: Can be a string reference to an easing function set on the
  59958. * `Math` object or a function. See the _Custom easing function_ demo below.
  59959. *
  59960. * Due to poor performance, animation is disabled in old IE browsers for
  59961. * several chart types.
  59962. */
  59963. animation?: (boolean|PlotMfiAnimationOptions|Partial<AnimationOptionsObject>);
  59964. /**
  59965. * (Highstock) For some series, there is a limit that shuts down initial
  59966. * animation by default when the total number of points in the chart is too
  59967. * high. For example, for a column chart and its derivatives, animation does
  59968. * not run if there is more than 250 points totally. To disable this cap,
  59969. * set `animationLimit` to `Infinity`.
  59970. */
  59971. animationLimit?: number;
  59972. /**
  59973. * (Highstock) Sets the color blending in the boost module.
  59974. */
  59975. boostBlending?: OptionsBoostBlendingValue;
  59976. /**
  59977. * (Highstock) Set the point threshold for when a series should enter boost
  59978. * mode.
  59979. *
  59980. * Setting it to e.g. 2000 will cause the series to enter boost mode when
  59981. * there are 2000 or more points in the series.
  59982. *
  59983. * To disable boosting on the series, set the `boostThreshold` to 0. Setting
  59984. * it to 1 will force boosting.
  59985. *
  59986. * Note that the cropThreshold also affects this setting. When zooming in on
  59987. * a series that has fewer points than the `cropThreshold`, all points are
  59988. * rendered although outside the visible plot area, and the `boostThreshold`
  59989. * won't take effect.
  59990. */
  59991. boostThreshold?: number;
  59992. /**
  59993. * (Highmaps) The border color of the map areas.
  59994. *
  59995. * In styled mode, the border stroke is given in the `.highcharts-point`
  59996. * class.
  59997. */
  59998. borderColor?: (ColorString|GradientColorObject|PatternObject);
  59999. /**
  60000. * (Highmaps) The border width of each map area.
  60001. *
  60002. * In styled mode, the border stroke width is given in the
  60003. * `.highcharts-point` class.
  60004. */
  60005. borderWidth?: number;
  60006. /**
  60007. * (Highstock) An additional class name to apply to the series' graphical
  60008. * elements. This option does not replace default class names of the
  60009. * graphical element.
  60010. */
  60011. className?: string;
  60012. /**
  60013. * (Highstock) Disable this option to allow series rendering in the whole
  60014. * plotting area.
  60015. *
  60016. * **Note:** Clipping should be always enabled when chart.zoomType is set
  60017. */
  60018. clip?: boolean;
  60019. /**
  60020. * (Highstock) The main color of the series. In line type series it applies
  60021. * to the line and the point markers unless otherwise specified. In bar type
  60022. * series it applies to the bars unless a color is specified per point. The
  60023. * default value is pulled from the `options.colors` array.
  60024. *
  60025. * In styled mode, the color can be defined by the colorIndex option. Also,
  60026. * the series color can be set with the `.highcharts-series`,
  60027. * `.highcharts-color-{n}`, `.highcharts-{type}-series` or
  60028. * `.highcharts-series-{n}` class, or individual classes given by the
  60029. * `className` option.
  60030. */
  60031. color?: (ColorString|GradientColorObject|PatternObject);
  60032. /**
  60033. * (Highstock) Styled mode only. A specific color index to use for the
  60034. * series, so its graphic representations are given the class name
  60035. * `highcharts-color-{n}`.
  60036. */
  60037. colorIndex?: number;
  60038. /**
  60039. * (Highcharts, Highstock, Highmaps) Determines what data value should be
  60040. * used to calculate point color if `colorAxis` is used. Requires to set
  60041. * `min` and `max` if some custom point property is used or if approximation
  60042. * for data grouping is set to `'sum'`.
  60043. */
  60044. colorKey?: string;
  60045. /**
  60046. * (Highstock) Compare the values of the series against the first non-null,
  60047. * non- zero value in the visible range. The y axis will show percentage or
  60048. * absolute change depending on whether `compare` is set to `"percent"` or
  60049. * `"value"`. When this is applied to multiple series, it allows comparing
  60050. * the development of the series against each other. Adds a `change` field
  60051. * to every point object.
  60052. */
  60053. compare?: string;
  60054. /**
  60055. * (Highstock) When compare is `percent`, this option dictates whether to
  60056. * use 0 or 100 as the base of comparison.
  60057. */
  60058. compareBase?: (0|100);
  60059. /**
  60060. * (Highstock) Defines if comparison should start from the first point
  60061. * within the visible range or should start from the first point **before**
  60062. * the range.
  60063. *
  60064. * In other words, this flag determines if first point within the visible
  60065. * range will have 0% (`compareStart=true`) or should have been already
  60066. * calculated according to the previous point (`compareStart=false`).
  60067. */
  60068. compareStart?: boolean;
  60069. /**
  60070. * (Highstock) Whether to compare indicator to the main series values or
  60071. * indicator values.
  60072. */
  60073. compareToMain?: boolean;
  60074. /**
  60075. * (Highcharts) Polar charts only. Whether to connect the ends of a line
  60076. * series plot across the extremes.
  60077. */
  60078. connectEnds?: boolean;
  60079. /**
  60080. * (Highcharts, Highstock) Whether to connect a graph line across null
  60081. * points, or render a gap between the two points on either side of the
  60082. * null.
  60083. */
  60084. connectNulls?: boolean;
  60085. /**
  60086. * (Gantt) Override Pathfinder connector options for a series. Requires
  60087. * Highcharts Gantt to be loaded.
  60088. */
  60089. connectors?: SeriesConnectorsOptionsObject;
  60090. /**
  60091. * (Highcharts, Highstock, Gantt) When true, each point or column edge is
  60092. * rounded to its nearest pixel in order to render sharp on screen. In some
  60093. * cases, when there are a lot of densely packed columns, this leads to
  60094. * visible difference in column widths or distance between columns. In these
  60095. * cases, setting `crisp` to `false` may look better, even though each
  60096. * column is rendered blurry.
  60097. */
  60098. crisp?: boolean;
  60099. /**
  60100. * (Highcharts, Highstock) When the series contains less points than the
  60101. * crop threshold, all points are drawn, even if the points fall outside the
  60102. * visible plot area at the current zoom. The advantage of drawing all
  60103. * points (including markers and columns), is that animation is performed on
  60104. * updates. On the other hand, when the series contains more points than the
  60105. * crop threshold, the series data is cropped to only contain points that
  60106. * fall within the plot area. The advantage of cropping away invisible
  60107. * points is to increase performance on large series.
  60108. */
  60109. cropThreshold?: number;
  60110. /**
  60111. * (Highstock) You can set the cursor to "pointer" if you have click events
  60112. * attached to the series, to signal to the user that the points and lines
  60113. * can be clicked.
  60114. *
  60115. * In styled mode, the series cursor can be set with the same classes as
  60116. * listed under series.color.
  60117. */
  60118. cursor?: (string|CursorValue);
  60119. /**
  60120. * (Highstock) A reserved subspace to store options and values for
  60121. * customized functionality. Here you can add additional data for your own
  60122. * event callbacks and formatter callbacks.
  60123. */
  60124. custom?: Dictionary<any>;
  60125. /**
  60126. * (Highstock) Name of the dash style to use for the graph, or for some
  60127. * series types the outline of each shape.
  60128. *
  60129. * In styled mode, the stroke dash-array can be set with the same classes as
  60130. * listed under series.color.
  60131. */
  60132. dashStyle?: DashStyleValue;
  60133. /**
  60134. * (Highstock) Data grouping is the concept of sampling the data values into
  60135. * larger blocks in order to ease readability and increase performance of
  60136. * the JavaScript charts. Highstock by default applies data grouping when
  60137. * the points become closer than a certain pixel value, determined by the
  60138. * `groupPixelWidth` option.
  60139. *
  60140. * If data grouping is applied, the grouping information of grouped points
  60141. * can be read from the Point.dataGroup. If point options other than the
  60142. * data itself are set, for example `name` or `color` or custom properties,
  60143. * the grouping logic doesn't know how to group it. In this case the options
  60144. * of the first point instance are copied over to the group point. This can
  60145. * be altered through a custom `approximation` callback function.
  60146. */
  60147. dataGrouping?: DataGroupingOptionsObject;
  60148. /**
  60149. * (Highcharts, Highstock, Highmaps, Gantt) Options for the series data
  60150. * labels, appearing next to each data point.
  60151. *
  60152. * Since v6.2.0, multiple data labels can be applied to each single point by
  60153. * defining them as an array of configs.
  60154. *
  60155. * In styled mode, the data labels can be styled with the
  60156. * `.highcharts-data-label-box` and `.highcharts-data-label` class names
  60157. * (see example).
  60158. */
  60159. dataLabels?: (PlotMfiDataLabelsOptions|Array<PlotMfiDataLabelsOptions>);
  60160. /**
  60161. * (Highcharts, Highstock) Options for the series data sorting.
  60162. */
  60163. dataSorting?: (DataSortingOptionsObject|PlotMfiDataSortingOptions);
  60164. /**
  60165. * (Highstock) A description of the series to add to the screen reader
  60166. * information about the series.
  60167. */
  60168. description?: string;
  60169. /**
  60170. * (Highstock) Enable or disable the mouse tracking for a specific series.
  60171. * This includes point tooltips and click events on graphs and points. For
  60172. * large datasets it improves performance.
  60173. */
  60174. enableMouseTracking?: boolean;
  60175. /**
  60176. * (Highstock) General event handlers for the series items. These event
  60177. * hooks can also be attached to the series at run time using the
  60178. * `Highcharts.addEvent` function.
  60179. */
  60180. events?: SeriesEventsOptionsObject;
  60181. /**
  60182. * (Highstock) Determines whether the series should look for the nearest
  60183. * point in both dimensions or just the x-dimension when hovering the
  60184. * series. Defaults to `'xy'` for scatter series and `'x'` for most other
  60185. * series. If the data has duplicate x-values, it is recommended to set this
  60186. * to `'xy'` to allow hovering over all points.
  60187. *
  60188. * Applies only to series types using nearest neighbor search (not direct
  60189. * hover) for tooltip.
  60190. */
  60191. findNearestPointBy?: OptionsFindNearestPointByValue;
  60192. /**
  60193. * (Highstock) Defines when to display a gap in the graph, together with the
  60194. * gapUnit option.
  60195. *
  60196. * In case when `dataGrouping` is enabled, points can be grouped into a
  60197. * larger time span. This can make the grouped points to have a greater
  60198. * distance than the absolute value of `gapSize` property, which will result
  60199. * in disappearing graph completely. To prevent this situation the mentioned
  60200. * distance between grouped points is used instead of previously defined
  60201. * `gapSize`.
  60202. *
  60203. * In practice, this option is most often used to visualize gaps in time
  60204. * series. In a stock chart, intraday data is available for daytime hours,
  60205. * while gaps will appear in nights and weekends.
  60206. */
  60207. gapSize?: number;
  60208. /**
  60209. * (Highstock) Together with gapSize, this option defines where to draw gaps
  60210. * in the graph.
  60211. *
  60212. * When the `gapUnit` is `"relative"` (default), a gap size of 5 means that
  60213. * if the distance between two points is greater than 5 times that of the
  60214. * two closest points, the graph will be broken.
  60215. *
  60216. * When the `gapUnit` is `"value"`, the gap is based on absolute axis
  60217. * values, which on a datetime axis is milliseconds. This also applies to
  60218. * the navigator series that inherits gap options from the base series.
  60219. */
  60220. gapUnit?: OptionsGapUnitValue;
  60221. /**
  60222. * (Highcharts, Highstock, Gantt) Whether to use the Y extremes of the total
  60223. * chart width or only the zoomed area when zooming in on parts of the X
  60224. * axis. By default, the Y axis adjusts to the min and max of the visible
  60225. * data. Cartesian series only.
  60226. */
  60227. getExtremesFromAll?: boolean;
  60228. /**
  60229. * (Highstock) When set to `false` will prevent the series data from being
  60230. * included in any form of data export.
  60231. *
  60232. * Since version 6.0.0 until 7.1.0 the option was existing undocumented as
  60233. * `includeInCSVExport`.
  60234. */
  60235. includeInDataExport?: boolean;
  60236. /**
  60237. * (Highcharts, Highstock, Gantt) Series labels are placed as close to the
  60238. * series as possible in a natural way, seeking to avoid other series. The
  60239. * goal of this feature is to make the chart more easily readable, like if a
  60240. * human designer placed the labels in the optimal position.
  60241. *
  60242. * The series labels currently work with series types having a `graph` or an
  60243. * `area`.
  60244. */
  60245. label?: SeriesLabelOptionsObject;
  60246. /**
  60247. * (Highstock) The line marks the last price from all points.
  60248. */
  60249. lastPrice?: SeriesLastPriceOptionsObject;
  60250. /**
  60251. * (Highstock) The line marks the last price from visible range of points.
  60252. */
  60253. lastVisiblePrice?: SeriesLastVisiblePriceOptionsObject;
  60254. /**
  60255. * (Highcharts, Highstock) The SVG value used for the `stroke-linecap` and
  60256. * `stroke-linejoin` of a line graph. Round means that lines are rounded in
  60257. * the ends and bends.
  60258. */
  60259. linecap?: SeriesLinecapValue;
  60260. /**
  60261. * (Highcharts, Highstock) Pixel width of the graph line.
  60262. */
  60263. lineWidth?: number;
  60264. /**
  60265. * (Highcharts, Highstock, Gantt) The main series ID that indicator will be
  60266. * based on. Required for this indicator.
  60267. */
  60268. linkedTo?: string;
  60269. /**
  60270. * (Highstock) Options for the point markers of line-like series. Properties
  60271. * like `fillColor`, `lineColor` and `lineWidth` define the visual
  60272. * appearance of the markers. Other series types, like column series, don't
  60273. * have markers, but have visual options on the series level instead.
  60274. *
  60275. * In styled mode, the markers can be styled with the `.highcharts-point`,
  60276. * `.highcharts-point-hover` and `.highcharts-point-select` class names.
  60277. */
  60278. marker?: PointMarkerOptionsObject;
  60279. /**
  60280. * (Highstock) The name of the series as shown in the legend, tooltip etc.
  60281. * If not set, it will be based on a technical indicator type and default
  60282. * params.
  60283. */
  60284. name?: string;
  60285. /**
  60286. * (Highstock) The color for the parts of the graph or points that are below
  60287. * the threshold. Note that `zones` takes precedence over the negative
  60288. * color. Using `negativeColor` is equivalent to applying a zone with value
  60289. * of 0.
  60290. */
  60291. negativeColor?: (ColorString|GradientColorObject|PatternObject);
  60292. /**
  60293. * (Highstock) Opacity of a series parts: line, fill (e.g. area) and
  60294. * dataLabels.
  60295. */
  60296. opacity?: number;
  60297. /**
  60298. * (Highstock) Paramters used in calculation of regression series' points.
  60299. */
  60300. params?: PlotMfiParamsOptions;
  60301. /**
  60302. * (Highstock) Properties for each single point.
  60303. */
  60304. point?: PlotSeriesPointOptions;
  60305. /**
  60306. * (Highstock) Same as accessibility.pointDescriptionFormatter, but for an
  60307. * individual series. Overrides the chart wide configuration.
  60308. */
  60309. pointDescriptionFormatter?: Function;
  60310. /**
  60311. * (Highstock) Whether to select the series initially. If `showCheckbox` is
  60312. * true, the checkbox next to the series name in the legend will be checked
  60313. * for a selected series.
  60314. */
  60315. selected?: boolean;
  60316. /**
  60317. * (Highstock) Whether to apply a drop shadow to the graph line. Since 2.3
  60318. * the shadow can be an object configuration containing `color`, `offsetX`,
  60319. * `offsetY`, `opacity` and `width`.
  60320. */
  60321. shadow?: (boolean|ShadowOptionsObject);
  60322. /**
  60323. * (Highstock) If true, a checkbox is displayed next to the legend item to
  60324. * allow selecting the series. The state of the checkbox is determined by
  60325. * the `selected` option.
  60326. */
  60327. showCheckbox?: boolean;
  60328. /**
  60329. * (Highstock) Whether to display this particular series or series type in
  60330. * the legend. Standalone series are shown in legend by default, and linked
  60331. * series are not. Since v7.2.0 it is possible to show series that use
  60332. * colorAxis by setting this option to `true`.
  60333. */
  60334. showInLegend?: boolean;
  60335. /**
  60336. * (Highstock) If set to `true`, the accessibility module will skip past the
  60337. * points in this series for keyboard navigation.
  60338. */
  60339. skipKeyboardNavigation?: boolean;
  60340. /**
  60341. * (Highcharts, Highstock) When this is true, the series will not cause the
  60342. * Y axis to cross the zero plane (or threshold option) unless the data
  60343. * actually crosses the plane.
  60344. *
  60345. * For example, if `softThreshold` is `false`, a series of 0, 1, 2, 3 will
  60346. * make the Y axis show negative values according to the `minPadding`
  60347. * option. If `softThreshold` is `true`, the Y axis starts at 0.
  60348. */
  60349. softThreshold?: boolean;
  60350. states?: SeriesStatesOptionsObject;
  60351. /**
  60352. * (Highcharts, Highstock) Whether to apply steps to the line. Possible
  60353. * values are `left`, `center` and `right`.
  60354. */
  60355. step?: OptionsStepValue;
  60356. /**
  60357. * (Highstock) Sticky tracking of mouse events. When true, the `mouseOut`
  60358. * event on a series isn't triggered until the mouse moves over another
  60359. * series, or out of the plot area. When false, the `mouseOut` event on a
  60360. * series is triggered when the mouse leaves the area around the series'
  60361. * graph or markers. This also implies the tooltip when not shared. When
  60362. * `stickyTracking` is false and `tooltip.shared` is false, the tooltip will
  60363. * be hidden when moving the mouse between series. Defaults to true for line
  60364. * and area type series, but to false for columns, pies etc.
  60365. *
  60366. * **Note:** The boost module will force this option because of technical
  60367. * limitations.
  60368. */
  60369. stickyTracking?: boolean;
  60370. /**
  60371. * (Highcharts, Highstock) The threshold, also called zero level or base
  60372. * level. For line type series this is only used in conjunction with
  60373. * negativeColor.
  60374. */
  60375. threshold?: (number|null);
  60376. /**
  60377. * (Highstock) A configuration object for the tooltip rendering of each
  60378. * single series. Properties are inherited from tooltip, but only the
  60379. * following properties can be defined on a series level.
  60380. */
  60381. tooltip?: SeriesTooltipOptionsObject;
  60382. /**
  60383. * (Highcharts, Highstock, Gantt) When a series contains a data array that
  60384. * is longer than this, only one dimensional arrays of numbers, or two
  60385. * dimensional arrays with x and y values are allowed. Also, only the first
  60386. * point is tested, and the rest are assumed to be the same format. This
  60387. * saves expensive data checking and indexing in long series. Set it to `0`
  60388. * disable.
  60389. *
  60390. * Note: In boost mode turbo threshold is forced. Only array of numbers or
  60391. * two dimensional arrays are allowed.
  60392. */
  60393. turboThreshold?: number;
  60394. /**
  60395. * (Highstock) Set the initial visibility of the series.
  60396. */
  60397. visible?: boolean;
  60398. /**
  60399. * (Highmaps) Define the z index of the series.
  60400. */
  60401. zIndex?: number;
  60402. /**
  60403. * (Highcharts, Highstock) Defines the Axis on which the zones are applied.
  60404. */
  60405. zoneAxis?: string;
  60406. /**
  60407. * (Highcharts, Highstock) An array defining zones within a series. Zones
  60408. * can be applied to the X axis, Y axis or Z axis for bubbles, according to
  60409. * the `zoneAxis` option. The zone definitions have to be in ascending order
  60410. * regarding to the value.
  60411. *
  60412. * In styled mode, the color zones are styled with the
  60413. * `.highcharts-zone-{n}` class, or custom classed from the `className`
  60414. * option (view live demo).
  60415. */
  60416. zones?: Array<SeriesZonesOptionsObject>;
  60417. }
  60418. /**
  60419. * (Highstock) Paramters used in calculation of regression series' points.
  60420. */
  60421. export interface PlotMfiParamsOptions {
  60422. /**
  60423. * (Highstock) Number of maximum decimals that are used in MFI calculations.
  60424. */
  60425. decimals?: number;
  60426. /**
  60427. * (Highstock) The base period for indicator calculations. This is the
  60428. * number of data points which are taken into account for the indicator
  60429. * calculations.
  60430. */
  60431. period?: number;
  60432. /**
  60433. * (Highstock) The id of volume series which is mandatory. For example using
  60434. * OHLC data, volumeSeriesID='volume' means the indicator will be calculated
  60435. * using OHLC and volume values.
  60436. */
  60437. volumeSeriesID?: string;
  60438. }
  60439. /**
  60440. * (Highstock) Enable or disable the initial animation when a series is
  60441. * displayed. The animation can also be set as a configuration object. Please
  60442. * note that this option only applies to the initial animation of the series
  60443. * itself. For other animations, see chart.animation and the animation parameter
  60444. * under the API methods. The following properties are supported:
  60445. *
  60446. * - `defer`: The animation delay time in milliseconds.
  60447. *
  60448. * - `duration`: The duration of the animation in milliseconds.
  60449. *
  60450. * - `easing`: Can be a string reference to an easing function set on the `Math`
  60451. * object or a function. See the _Custom easing function_ demo below.
  60452. *
  60453. * Due to poor performance, animation is disabled in old IE browsers for several
  60454. * chart types.
  60455. */
  60456. export interface PlotMomentumAnimationOptions {
  60457. defer?: number;
  60458. }
  60459. /**
  60460. * (Highcharts, Highstock, Highmaps, Gantt) Enable or disable the initial
  60461. * animation when a series is displayed for the `dataLabels`. The animation can
  60462. * also be set as a configuration object. Please note that this option only
  60463. * applies to the initial animation. For other animations, see chart.animation
  60464. * and the animation parameter under the API methods. The following properties
  60465. * are supported:
  60466. *
  60467. * - `defer`: The animation delay time in milliseconds.
  60468. */
  60469. export interface PlotMomentumDataLabelsAnimationOptions {
  60470. /**
  60471. * (Highcharts, Highstock, Highmaps, Gantt) The animation delay time in
  60472. * milliseconds. Set to `0` renders dataLabel immediately. As `undefined`
  60473. * inherits defer time from the series.animation.defer.
  60474. */
  60475. defer?: number;
  60476. }
  60477. /**
  60478. * (Highcharts, Highstock, Highmaps, Gantt) Options for the series data labels,
  60479. * appearing next to each data point.
  60480. *
  60481. * Since v6.2.0, multiple data labels can be applied to each single point by
  60482. * defining them as an array of configs.
  60483. *
  60484. * In styled mode, the data labels can be styled with the
  60485. * `.highcharts-data-label-box` and `.highcharts-data-label` class names (see
  60486. * example).
  60487. */
  60488. export interface PlotMomentumDataLabelsOptions {
  60489. /**
  60490. * (Highcharts, Highstock, Highmaps, Gantt) The alignment of the data label
  60491. * compared to the point. If `right`, the right side of the label should be
  60492. * touching the point. For points with an extent, like columns, the
  60493. * alignments also dictates how to align it inside the box, as given with
  60494. * the inside option. Can be one of `left`, `center` or `right`.
  60495. */
  60496. align?: (AlignValue|null);
  60497. /**
  60498. * (Highcharts, Highstock, Highmaps, Gantt) Whether to allow data labels to
  60499. * overlap. To make the labels less sensitive for overlapping, the
  60500. * dataLabels.padding can be set to 0.
  60501. */
  60502. allowOverlap?: boolean;
  60503. /**
  60504. * (Highcharts, Highstock, Highmaps, Gantt) Enable or disable the initial
  60505. * animation when a series is displayed for the `dataLabels`. The animation
  60506. * can also be set as a configuration object. Please note that this option
  60507. * only applies to the initial animation. For other animations, see
  60508. * chart.animation and the animation parameter under the API methods. The
  60509. * following properties are supported:
  60510. *
  60511. * - `defer`: The animation delay time in milliseconds.
  60512. */
  60513. animation?: (boolean|PlotMomentumDataLabelsAnimationOptions|Partial<AnimationOptionsObject>);
  60514. /**
  60515. * (Highcharts, Highstock, Highmaps, Gantt) The background color or gradient
  60516. * for the data label.
  60517. */
  60518. backgroundColor?: (ColorString|GradientColorObject|PatternObject);
  60519. /**
  60520. * (Highcharts, Highstock, Highmaps, Gantt) The border color for the data
  60521. * label. Defaults to `undefined`.
  60522. */
  60523. borderColor?: (ColorString|GradientColorObject|PatternObject);
  60524. /**
  60525. * (Highcharts, Highstock, Highmaps, Gantt) The border radius in pixels for
  60526. * the data label.
  60527. */
  60528. borderRadius?: number;
  60529. /**
  60530. * (Highcharts, Highstock, Highmaps, Gantt) The border width in pixels for
  60531. * the data label.
  60532. */
  60533. borderWidth?: number;
  60534. /**
  60535. * (Highcharts, Highstock, Highmaps, Gantt) A class name for the data label.
  60536. * Particularly in styled mode, this can be used to give each series' or
  60537. * point's data label unique styling. In addition to this option, a default
  60538. * color class name is added so that we can give the labels a contrast text
  60539. * shadow.
  60540. */
  60541. className?: string;
  60542. /**
  60543. * (Highcharts, Highstock, Highmaps, Gantt) The text color for the data
  60544. * labels. Defaults to `undefined`. For certain series types, like column or
  60545. * map, the data labels can be drawn inside the points. In this case the
  60546. * data label will be drawn with maximum contrast by default. Additionally,
  60547. * it will be given a `text-outline` style with the opposite color, to
  60548. * further increase the contrast. This can be overridden by setting the
  60549. * `text-outline` style to `none` in the `dataLabels.style` option.
  60550. */
  60551. color?: (ColorString|GradientColorObject|PatternObject);
  60552. /**
  60553. * (Highcharts, Highstock, Highmaps, Gantt) Whether to hide data labels that
  60554. * are outside the plot area. By default, the data label is moved inside the
  60555. * plot area according to the overflow option.
  60556. */
  60557. crop?: boolean;
  60558. /**
  60559. * (Highcharts, Highstock, Gantt) Whether to defer displaying the data
  60560. * labels until the initial series animation has finished. Setting to
  60561. * `false` renders the data label immediately. If set to `true` inherits the
  60562. * defer time set in plotOptions.series.animation.
  60563. */
  60564. defer?: boolean;
  60565. /**
  60566. * (Highcharts, Highstock, Highmaps, Gantt) Enable or disable the data
  60567. * labels.
  60568. */
  60569. enabled?: boolean;
  60570. /**
  60571. * (Highcharts, Highstock, Highmaps, Gantt) A declarative filter to control
  60572. * of which data labels to display. The declarative filter is designed for
  60573. * use when callback functions are not available, like when the chart
  60574. * options require a pure JSON structure or for use with graphical editors.
  60575. * For programmatic control, use the `formatter` instead, and return
  60576. * `undefined` to disable a single data label.
  60577. */
  60578. filter?: DataLabelsFilterOptionsObject;
  60579. /**
  60580. * (Highcharts, Highstock, Highmaps, Gantt) A format string for the data
  60581. * label. Available variables are the same as for `formatter`.
  60582. */
  60583. format?: string;
  60584. /**
  60585. * (Highcharts, Highstock, Highmaps, Gantt) Callback JavaScript function to
  60586. * format the data label. Note that if a `format` is defined, the format
  60587. * takes precedence and the formatter is ignored.
  60588. */
  60589. formatter?: DataLabelsFormatterCallbackFunction;
  60590. /**
  60591. * (Highcharts, Highstock, Highmaps, Gantt) For points with an extent, like
  60592. * columns or map areas, whether to align the data label inside the box or
  60593. * to the actual value point. Defaults to `false` in most cases, `true` in
  60594. * stacked columns.
  60595. */
  60596. inside?: boolean;
  60597. /**
  60598. * (Highcharts, Highstock, Highmaps, Gantt) Format for points with the value
  60599. * of null. Works analogously to format. `nullFormat` can be applied only to
  60600. * series which support displaying null points.
  60601. */
  60602. nullFormat?: (boolean|string);
  60603. /**
  60604. * (Highcharts, Highstock, Highmaps, Gantt) Callback JavaScript function
  60605. * that defines formatting for points with the value of null. Works
  60606. * analogously to formatter. `nullPointFormatter` can be applied only to
  60607. * series which support displaying null points.
  60608. */
  60609. nullFormatter?: DataLabelsFormatterCallbackFunction;
  60610. /**
  60611. * (Highcharts, Highstock, Highmaps, Gantt) How to handle data labels that
  60612. * flow outside the plot area. The default is `"justify"`, which aligns them
  60613. * inside the plot area. For columns and bars, this means it will be moved
  60614. * inside the bar. To display data labels outside the plot area, set `crop`
  60615. * to `false` and `overflow` to `"allow"`.
  60616. */
  60617. overflow?: DataLabelsOverflowValue;
  60618. /**
  60619. * (Highcharts, Highstock, Highmaps, Gantt) When either the `borderWidth` or
  60620. * the `backgroundColor` is set, this is the padding within the box.
  60621. */
  60622. padding?: number;
  60623. /**
  60624. * (Highcharts, Highstock, Highmaps, Gantt) Aligns data labels relative to
  60625. * points. If `center` alignment is not possible, it defaults to `right`.
  60626. */
  60627. position?: AlignValue;
  60628. /**
  60629. * (Highcharts, Highstock, Highmaps, Gantt) Text rotation in degrees. Note
  60630. * that due to a more complex structure, backgrounds, borders and padding
  60631. * will be lost on a rotated data label.
  60632. */
  60633. rotation?: number;
  60634. /**
  60635. * (Highcharts, Highstock, Highmaps, Gantt) The shadow of the box. Works
  60636. * best with `borderWidth` or `backgroundColor`. Since 2.3 the shadow can be
  60637. * an object configuration containing `color`, `offsetX`, `offsetY`,
  60638. * `opacity` and `width`.
  60639. */
  60640. shadow?: (boolean|ShadowOptionsObject);
  60641. /**
  60642. * (Highcharts, Highstock, Highmaps, Gantt) The name of a symbol to use for
  60643. * the border around the label. Symbols are predefined functions on the
  60644. * Renderer object.
  60645. */
  60646. shape?: string;
  60647. /**
  60648. * (Highcharts, Highstock, Highmaps, Gantt) Styles for the label. The
  60649. * default `color` setting is `"contrast"`, which is a pseudo color that
  60650. * Highcharts picks up and applies the maximum contrast to the underlying
  60651. * point item, for example the bar in a bar chart.
  60652. *
  60653. * The `textOutline` is a pseudo property that applies an outline of the
  60654. * given width with the given color, which by default is the maximum
  60655. * contrast to the text. So a bright text color will result in a black text
  60656. * outline for maximum readability on a mixed background. In some cases,
  60657. * especially with grayscale text, the text outline doesn't work well, in
  60658. * which cases it can be disabled by setting it to `"none"`. When `useHTML`
  60659. * is true, the `textOutline` will not be picked up. In this, case, the same
  60660. * effect can be acheived through the `text-shadow` CSS property.
  60661. *
  60662. * For some series types, where each point has an extent, like for example
  60663. * tree maps, the data label may overflow the point. There are two
  60664. * strategies for handling overflow. By default, the text will wrap to
  60665. * multiple lines. The other strategy is to set `style.textOverflow` to
  60666. * `ellipsis`, which will keep the text on one line plus it will break
  60667. * inside long words.
  60668. */
  60669. style?: CSSObject;
  60670. /**
  60671. * (Highcharts, Highstock, Highmaps, Gantt) Options for a label text which
  60672. * should follow marker's shape. Border and background are disabled for a
  60673. * label that follows a path.
  60674. *
  60675. * **Note:** Only SVG-based renderer supports this option. Setting `useHTML`
  60676. * to true will disable this option.
  60677. */
  60678. textPath?: DataLabelsTextPathOptionsObject;
  60679. /**
  60680. * (Highcharts, Highstock, Highmaps, Gantt) Whether to use HTML to render
  60681. * the labels.
  60682. */
  60683. useHTML?: boolean;
  60684. /**
  60685. * (Highcharts, Highstock, Highmaps, Gantt) The vertical alignment of a data
  60686. * label. Can be one of `top`, `middle` or `bottom`. The default value
  60687. * depends on the data, for instance in a column chart, the label is above
  60688. * positive values and below negative values.
  60689. */
  60690. verticalAlign?: (VerticalAlignValue|null);
  60691. /**
  60692. * (Highcharts, Highstock, Highmaps, Gantt) The x position offset of the
  60693. * label relative to the point in pixels.
  60694. */
  60695. x?: number;
  60696. /**
  60697. * (Highcharts, Highstock, Highmaps, Gantt) The y position offset of the
  60698. * label relative to the point in pixels.
  60699. */
  60700. y?: number;
  60701. /**
  60702. * (Highcharts, Highstock, Highmaps, Gantt) The Z index of the data labels.
  60703. * The default Z index puts it above the series. Use a Z index of 2 to
  60704. * display it behind the series.
  60705. */
  60706. z?: number;
  60707. }
  60708. /**
  60709. * (Highcharts, Highstock) Options for the series data sorting.
  60710. */
  60711. export interface PlotMomentumDataSortingOptions {
  60712. /**
  60713. * (Highcharts, Highstock) Enable or disable data sorting for the series.
  60714. * Use xAxis.reversed to change the sorting order.
  60715. */
  60716. enabled?: boolean;
  60717. /**
  60718. * (Highcharts, Highstock) Whether to allow matching points by name in an
  60719. * update. If this option is disabled, points will be matched by order.
  60720. */
  60721. matchByName?: boolean;
  60722. /**
  60723. * (Highcharts, Highstock) Determines what data value should be used to sort
  60724. * by.
  60725. */
  60726. sortKey?: string;
  60727. }
  60728. /**
  60729. * (Highstock) Momentum. This series requires `linkedTo` option to be set.
  60730. *
  60731. * In TypeScript the type option must always be set.
  60732. *
  60733. * Configuration options for the series are given in three levels:
  60734. *
  60735. * 1. Options for all series in a chart are defined in the plotOptions.series
  60736. * object.
  60737. *
  60738. * 2. Options for all `momentum` series are defined in plotOptions.momentum.
  60739. *
  60740. * 3. Options for one single series are given in the series instance array. (see
  60741. * online documentation for example)
  60742. */
  60743. export interface PlotMomentumOptions {
  60744. /**
  60745. * (Highstock) Accessibility options for a series.
  60746. */
  60747. accessibility?: SeriesAccessibilityOptionsObject;
  60748. /**
  60749. * (Highstock) Allow this series' points to be selected by clicking on the
  60750. * graphic (columns, point markers, pie slices, map areas etc).
  60751. *
  60752. * The selected points can be handled by point select and unselect events,
  60753. * or collectively by the getSelectedPoints function.
  60754. *
  60755. * And alternative way of selecting points is through dragging.
  60756. */
  60757. allowPointSelect?: boolean;
  60758. /**
  60759. * (Highstock) Enable or disable the initial animation when a series is
  60760. * displayed. The animation can also be set as a configuration object.
  60761. * Please note that this option only applies to the initial animation of the
  60762. * series itself. For other animations, see chart.animation and the
  60763. * animation parameter under the API methods. The following properties are
  60764. * supported:
  60765. *
  60766. * - `defer`: The animation delay time in milliseconds.
  60767. *
  60768. * - `duration`: The duration of the animation in milliseconds.
  60769. *
  60770. * - `easing`: Can be a string reference to an easing function set on the
  60771. * `Math` object or a function. See the _Custom easing function_ demo below.
  60772. *
  60773. * Due to poor performance, animation is disabled in old IE browsers for
  60774. * several chart types.
  60775. */
  60776. animation?: (boolean|PlotMomentumAnimationOptions|Partial<AnimationOptionsObject>);
  60777. /**
  60778. * (Highstock) For some series, there is a limit that shuts down initial
  60779. * animation by default when the total number of points in the chart is too
  60780. * high. For example, for a column chart and its derivatives, animation does
  60781. * not run if there is more than 250 points totally. To disable this cap,
  60782. * set `animationLimit` to `Infinity`.
  60783. */
  60784. animationLimit?: number;
  60785. /**
  60786. * (Highstock) Sets the color blending in the boost module.
  60787. */
  60788. boostBlending?: OptionsBoostBlendingValue;
  60789. /**
  60790. * (Highstock) Set the point threshold for when a series should enter boost
  60791. * mode.
  60792. *
  60793. * Setting it to e.g. 2000 will cause the series to enter boost mode when
  60794. * there are 2000 or more points in the series.
  60795. *
  60796. * To disable boosting on the series, set the `boostThreshold` to 0. Setting
  60797. * it to 1 will force boosting.
  60798. *
  60799. * Note that the cropThreshold also affects this setting. When zooming in on
  60800. * a series that has fewer points than the `cropThreshold`, all points are
  60801. * rendered although outside the visible plot area, and the `boostThreshold`
  60802. * won't take effect.
  60803. */
  60804. boostThreshold?: number;
  60805. /**
  60806. * (Highmaps) The border color of the map areas.
  60807. *
  60808. * In styled mode, the border stroke is given in the `.highcharts-point`
  60809. * class.
  60810. */
  60811. borderColor?: (ColorString|GradientColorObject|PatternObject);
  60812. /**
  60813. * (Highmaps) The border width of each map area.
  60814. *
  60815. * In styled mode, the border stroke width is given in the
  60816. * `.highcharts-point` class.
  60817. */
  60818. borderWidth?: number;
  60819. /**
  60820. * (Highstock) An additional class name to apply to the series' graphical
  60821. * elements. This option does not replace default class names of the
  60822. * graphical element.
  60823. */
  60824. className?: string;
  60825. /**
  60826. * (Highstock) Disable this option to allow series rendering in the whole
  60827. * plotting area.
  60828. *
  60829. * **Note:** Clipping should be always enabled when chart.zoomType is set
  60830. */
  60831. clip?: boolean;
  60832. /**
  60833. * (Highstock) The main color of the series. In line type series it applies
  60834. * to the line and the point markers unless otherwise specified. In bar type
  60835. * series it applies to the bars unless a color is specified per point. The
  60836. * default value is pulled from the `options.colors` array.
  60837. *
  60838. * In styled mode, the color can be defined by the colorIndex option. Also,
  60839. * the series color can be set with the `.highcharts-series`,
  60840. * `.highcharts-color-{n}`, `.highcharts-{type}-series` or
  60841. * `.highcharts-series-{n}` class, or individual classes given by the
  60842. * `className` option.
  60843. */
  60844. color?: (ColorString|GradientColorObject|PatternObject);
  60845. /**
  60846. * (Highstock) Styled mode only. A specific color index to use for the
  60847. * series, so its graphic representations are given the class name
  60848. * `highcharts-color-{n}`.
  60849. */
  60850. colorIndex?: number;
  60851. /**
  60852. * (Highcharts, Highstock, Highmaps) Determines what data value should be
  60853. * used to calculate point color if `colorAxis` is used. Requires to set
  60854. * `min` and `max` if some custom point property is used or if approximation
  60855. * for data grouping is set to `'sum'`.
  60856. */
  60857. colorKey?: string;
  60858. /**
  60859. * (Highstock) Compare the values of the series against the first non-null,
  60860. * non- zero value in the visible range. The y axis will show percentage or
  60861. * absolute change depending on whether `compare` is set to `"percent"` or
  60862. * `"value"`. When this is applied to multiple series, it allows comparing
  60863. * the development of the series against each other. Adds a `change` field
  60864. * to every point object.
  60865. */
  60866. compare?: string;
  60867. /**
  60868. * (Highstock) When compare is `percent`, this option dictates whether to
  60869. * use 0 or 100 as the base of comparison.
  60870. */
  60871. compareBase?: (0|100);
  60872. /**
  60873. * (Highstock) Defines if comparison should start from the first point
  60874. * within the visible range or should start from the first point **before**
  60875. * the range.
  60876. *
  60877. * In other words, this flag determines if first point within the visible
  60878. * range will have 0% (`compareStart=true`) or should have been already
  60879. * calculated according to the previous point (`compareStart=false`).
  60880. */
  60881. compareStart?: boolean;
  60882. /**
  60883. * (Highstock) Whether to compare indicator to the main series values or
  60884. * indicator values.
  60885. */
  60886. compareToMain?: boolean;
  60887. /**
  60888. * (Highcharts) Polar charts only. Whether to connect the ends of a line
  60889. * series plot across the extremes.
  60890. */
  60891. connectEnds?: boolean;
  60892. /**
  60893. * (Highcharts, Highstock) Whether to connect a graph line across null
  60894. * points, or render a gap between the two points on either side of the
  60895. * null.
  60896. */
  60897. connectNulls?: boolean;
  60898. /**
  60899. * (Gantt) Override Pathfinder connector options for a series. Requires
  60900. * Highcharts Gantt to be loaded.
  60901. */
  60902. connectors?: SeriesConnectorsOptionsObject;
  60903. /**
  60904. * (Highcharts, Highstock, Gantt) When true, each point or column edge is
  60905. * rounded to its nearest pixel in order to render sharp on screen. In some
  60906. * cases, when there are a lot of densely packed columns, this leads to
  60907. * visible difference in column widths or distance between columns. In these
  60908. * cases, setting `crisp` to `false` may look better, even though each
  60909. * column is rendered blurry.
  60910. */
  60911. crisp?: boolean;
  60912. /**
  60913. * (Highcharts, Highstock) When the series contains less points than the
  60914. * crop threshold, all points are drawn, even if the points fall outside the
  60915. * visible plot area at the current zoom. The advantage of drawing all
  60916. * points (including markers and columns), is that animation is performed on
  60917. * updates. On the other hand, when the series contains more points than the
  60918. * crop threshold, the series data is cropped to only contain points that
  60919. * fall within the plot area. The advantage of cropping away invisible
  60920. * points is to increase performance on large series.
  60921. */
  60922. cropThreshold?: number;
  60923. /**
  60924. * (Highstock) You can set the cursor to "pointer" if you have click events
  60925. * attached to the series, to signal to the user that the points and lines
  60926. * can be clicked.
  60927. *
  60928. * In styled mode, the series cursor can be set with the same classes as
  60929. * listed under series.color.
  60930. */
  60931. cursor?: (string|CursorValue);
  60932. /**
  60933. * (Highstock) A reserved subspace to store options and values for
  60934. * customized functionality. Here you can add additional data for your own
  60935. * event callbacks and formatter callbacks.
  60936. */
  60937. custom?: Dictionary<any>;
  60938. /**
  60939. * (Highstock) Name of the dash style to use for the graph, or for some
  60940. * series types the outline of each shape.
  60941. *
  60942. * In styled mode, the stroke dash-array can be set with the same classes as
  60943. * listed under series.color.
  60944. */
  60945. dashStyle?: DashStyleValue;
  60946. /**
  60947. * (Highstock) Data grouping is the concept of sampling the data values into
  60948. * larger blocks in order to ease readability and increase performance of
  60949. * the JavaScript charts. Highstock by default applies data grouping when
  60950. * the points become closer than a certain pixel value, determined by the
  60951. * `groupPixelWidth` option.
  60952. *
  60953. * If data grouping is applied, the grouping information of grouped points
  60954. * can be read from the Point.dataGroup. If point options other than the
  60955. * data itself are set, for example `name` or `color` or custom properties,
  60956. * the grouping logic doesn't know how to group it. In this case the options
  60957. * of the first point instance are copied over to the group point. This can
  60958. * be altered through a custom `approximation` callback function.
  60959. */
  60960. dataGrouping?: DataGroupingOptionsObject;
  60961. /**
  60962. * (Highcharts, Highstock, Highmaps, Gantt) Options for the series data
  60963. * labels, appearing next to each data point.
  60964. *
  60965. * Since v6.2.0, multiple data labels can be applied to each single point by
  60966. * defining them as an array of configs.
  60967. *
  60968. * In styled mode, the data labels can be styled with the
  60969. * `.highcharts-data-label-box` and `.highcharts-data-label` class names
  60970. * (see example).
  60971. */
  60972. dataLabels?: (PlotMomentumDataLabelsOptions|Array<PlotMomentumDataLabelsOptions>);
  60973. /**
  60974. * (Highcharts, Highstock) Options for the series data sorting.
  60975. */
  60976. dataSorting?: (DataSortingOptionsObject|PlotMomentumDataSortingOptions);
  60977. /**
  60978. * (Highstock) A description of the series to add to the screen reader
  60979. * information about the series.
  60980. */
  60981. description?: string;
  60982. /**
  60983. * (Highstock) Enable or disable the mouse tracking for a specific series.
  60984. * This includes point tooltips and click events on graphs and points. For
  60985. * large datasets it improves performance.
  60986. */
  60987. enableMouseTracking?: boolean;
  60988. /**
  60989. * (Highstock) General event handlers for the series items. These event
  60990. * hooks can also be attached to the series at run time using the
  60991. * `Highcharts.addEvent` function.
  60992. */
  60993. events?: SeriesEventsOptionsObject;
  60994. /**
  60995. * (Highstock) Determines whether the series should look for the nearest
  60996. * point in both dimensions or just the x-dimension when hovering the
  60997. * series. Defaults to `'xy'` for scatter series and `'x'` for most other
  60998. * series. If the data has duplicate x-values, it is recommended to set this
  60999. * to `'xy'` to allow hovering over all points.
  61000. *
  61001. * Applies only to series types using nearest neighbor search (not direct
  61002. * hover) for tooltip.
  61003. */
  61004. findNearestPointBy?: OptionsFindNearestPointByValue;
  61005. /**
  61006. * (Highstock) Defines when to display a gap in the graph, together with the
  61007. * gapUnit option.
  61008. *
  61009. * In case when `dataGrouping` is enabled, points can be grouped into a
  61010. * larger time span. This can make the grouped points to have a greater
  61011. * distance than the absolute value of `gapSize` property, which will result
  61012. * in disappearing graph completely. To prevent this situation the mentioned
  61013. * distance between grouped points is used instead of previously defined
  61014. * `gapSize`.
  61015. *
  61016. * In practice, this option is most often used to visualize gaps in time
  61017. * series. In a stock chart, intraday data is available for daytime hours,
  61018. * while gaps will appear in nights and weekends.
  61019. */
  61020. gapSize?: number;
  61021. /**
  61022. * (Highstock) Together with gapSize, this option defines where to draw gaps
  61023. * in the graph.
  61024. *
  61025. * When the `gapUnit` is `"relative"` (default), a gap size of 5 means that
  61026. * if the distance between two points is greater than 5 times that of the
  61027. * two closest points, the graph will be broken.
  61028. *
  61029. * When the `gapUnit` is `"value"`, the gap is based on absolute axis
  61030. * values, which on a datetime axis is milliseconds. This also applies to
  61031. * the navigator series that inherits gap options from the base series.
  61032. */
  61033. gapUnit?: OptionsGapUnitValue;
  61034. /**
  61035. * (Highcharts, Highstock, Gantt) Whether to use the Y extremes of the total
  61036. * chart width or only the zoomed area when zooming in on parts of the X
  61037. * axis. By default, the Y axis adjusts to the min and max of the visible
  61038. * data. Cartesian series only.
  61039. */
  61040. getExtremesFromAll?: boolean;
  61041. /**
  61042. * (Highstock) When set to `false` will prevent the series data from being
  61043. * included in any form of data export.
  61044. *
  61045. * Since version 6.0.0 until 7.1.0 the option was existing undocumented as
  61046. * `includeInCSVExport`.
  61047. */
  61048. includeInDataExport?: boolean;
  61049. /**
  61050. * (Highcharts, Highstock, Gantt) Series labels are placed as close to the
  61051. * series as possible in a natural way, seeking to avoid other series. The
  61052. * goal of this feature is to make the chart more easily readable, like if a
  61053. * human designer placed the labels in the optimal position.
  61054. *
  61055. * The series labels currently work with series types having a `graph` or an
  61056. * `area`.
  61057. */
  61058. label?: SeriesLabelOptionsObject;
  61059. /**
  61060. * (Highstock) The line marks the last price from all points.
  61061. */
  61062. lastPrice?: SeriesLastPriceOptionsObject;
  61063. /**
  61064. * (Highstock) The line marks the last price from visible range of points.
  61065. */
  61066. lastVisiblePrice?: SeriesLastVisiblePriceOptionsObject;
  61067. /**
  61068. * (Highcharts, Highstock) The SVG value used for the `stroke-linecap` and
  61069. * `stroke-linejoin` of a line graph. Round means that lines are rounded in
  61070. * the ends and bends.
  61071. */
  61072. linecap?: SeriesLinecapValue;
  61073. /**
  61074. * (Highcharts, Highstock) Pixel width of the graph line.
  61075. */
  61076. lineWidth?: number;
  61077. /**
  61078. * (Highcharts, Highstock, Gantt) The main series ID that indicator will be
  61079. * based on. Required for this indicator.
  61080. */
  61081. linkedTo?: string;
  61082. /**
  61083. * (Highstock) Options for the point markers of line-like series. Properties
  61084. * like `fillColor`, `lineColor` and `lineWidth` define the visual
  61085. * appearance of the markers. Other series types, like column series, don't
  61086. * have markers, but have visual options on the series level instead.
  61087. *
  61088. * In styled mode, the markers can be styled with the `.highcharts-point`,
  61089. * `.highcharts-point-hover` and `.highcharts-point-select` class names.
  61090. */
  61091. marker?: PointMarkerOptionsObject;
  61092. /**
  61093. * (Highstock) The name of the series as shown in the legend, tooltip etc.
  61094. * If not set, it will be based on a technical indicator type and default
  61095. * params.
  61096. */
  61097. name?: string;
  61098. /**
  61099. * (Highstock) The color for the parts of the graph or points that are below
  61100. * the threshold. Note that `zones` takes precedence over the negative
  61101. * color. Using `negativeColor` is equivalent to applying a zone with value
  61102. * of 0.
  61103. */
  61104. negativeColor?: (ColorString|GradientColorObject|PatternObject);
  61105. /**
  61106. * (Highstock) Opacity of a series parts: line, fill (e.g. area) and
  61107. * dataLabels.
  61108. */
  61109. opacity?: number;
  61110. /**
  61111. * (Highstock) Paramters used in calculation of regression series' points.
  61112. */
  61113. params?: PlotMomentumParamsOptions;
  61114. /**
  61115. * (Highstock) Properties for each single point.
  61116. */
  61117. point?: PlotSeriesPointOptions;
  61118. /**
  61119. * (Highstock) Same as accessibility.pointDescriptionFormatter, but for an
  61120. * individual series. Overrides the chart wide configuration.
  61121. */
  61122. pointDescriptionFormatter?: Function;
  61123. /**
  61124. * (Highstock) Whether to select the series initially. If `showCheckbox` is
  61125. * true, the checkbox next to the series name in the legend will be checked
  61126. * for a selected series.
  61127. */
  61128. selected?: boolean;
  61129. /**
  61130. * (Highstock) Whether to apply a drop shadow to the graph line. Since 2.3
  61131. * the shadow can be an object configuration containing `color`, `offsetX`,
  61132. * `offsetY`, `opacity` and `width`.
  61133. */
  61134. shadow?: (boolean|ShadowOptionsObject);
  61135. /**
  61136. * (Highstock) If true, a checkbox is displayed next to the legend item to
  61137. * allow selecting the series. The state of the checkbox is determined by
  61138. * the `selected` option.
  61139. */
  61140. showCheckbox?: boolean;
  61141. /**
  61142. * (Highstock) Whether to display this particular series or series type in
  61143. * the legend. Standalone series are shown in legend by default, and linked
  61144. * series are not. Since v7.2.0 it is possible to show series that use
  61145. * colorAxis by setting this option to `true`.
  61146. */
  61147. showInLegend?: boolean;
  61148. /**
  61149. * (Highstock) If set to `true`, the accessibility module will skip past the
  61150. * points in this series for keyboard navigation.
  61151. */
  61152. skipKeyboardNavigation?: boolean;
  61153. /**
  61154. * (Highcharts, Highstock) When this is true, the series will not cause the
  61155. * Y axis to cross the zero plane (or threshold option) unless the data
  61156. * actually crosses the plane.
  61157. *
  61158. * For example, if `softThreshold` is `false`, a series of 0, 1, 2, 3 will
  61159. * make the Y axis show negative values according to the `minPadding`
  61160. * option. If `softThreshold` is `true`, the Y axis starts at 0.
  61161. */
  61162. softThreshold?: boolean;
  61163. states?: SeriesStatesOptionsObject;
  61164. /**
  61165. * (Highcharts, Highstock) Whether to apply steps to the line. Possible
  61166. * values are `left`, `center` and `right`.
  61167. */
  61168. step?: OptionsStepValue;
  61169. /**
  61170. * (Highstock) Sticky tracking of mouse events. When true, the `mouseOut`
  61171. * event on a series isn't triggered until the mouse moves over another
  61172. * series, or out of the plot area. When false, the `mouseOut` event on a
  61173. * series is triggered when the mouse leaves the area around the series'
  61174. * graph or markers. This also implies the tooltip when not shared. When
  61175. * `stickyTracking` is false and `tooltip.shared` is false, the tooltip will
  61176. * be hidden when moving the mouse between series. Defaults to true for line
  61177. * and area type series, but to false for columns, pies etc.
  61178. *
  61179. * **Note:** The boost module will force this option because of technical
  61180. * limitations.
  61181. */
  61182. stickyTracking?: boolean;
  61183. /**
  61184. * (Highcharts, Highstock) The threshold, also called zero level or base
  61185. * level. For line type series this is only used in conjunction with
  61186. * negativeColor.
  61187. */
  61188. threshold?: (number|null);
  61189. /**
  61190. * (Highstock) A configuration object for the tooltip rendering of each
  61191. * single series. Properties are inherited from tooltip, but only the
  61192. * following properties can be defined on a series level.
  61193. */
  61194. tooltip?: SeriesTooltipOptionsObject;
  61195. /**
  61196. * (Highcharts, Highstock, Gantt) When a series contains a data array that
  61197. * is longer than this, only one dimensional arrays of numbers, or two
  61198. * dimensional arrays with x and y values are allowed. Also, only the first
  61199. * point is tested, and the rest are assumed to be the same format. This
  61200. * saves expensive data checking and indexing in long series. Set it to `0`
  61201. * disable.
  61202. *
  61203. * Note: In boost mode turbo threshold is forced. Only array of numbers or
  61204. * two dimensional arrays are allowed.
  61205. */
  61206. turboThreshold?: number;
  61207. /**
  61208. * (Highstock) Set the initial visibility of the series.
  61209. */
  61210. visible?: boolean;
  61211. /**
  61212. * (Highmaps) Define the z index of the series.
  61213. */
  61214. zIndex?: number;
  61215. /**
  61216. * (Highcharts, Highstock) Defines the Axis on which the zones are applied.
  61217. */
  61218. zoneAxis?: string;
  61219. /**
  61220. * (Highcharts, Highstock) An array defining zones within a series. Zones
  61221. * can be applied to the X axis, Y axis or Z axis for bubbles, according to
  61222. * the `zoneAxis` option. The zone definitions have to be in ascending order
  61223. * regarding to the value.
  61224. *
  61225. * In styled mode, the color zones are styled with the
  61226. * `.highcharts-zone-{n}` class, or custom classed from the `className`
  61227. * option (view live demo).
  61228. */
  61229. zones?: Array<SeriesZonesOptionsObject>;
  61230. }
  61231. /**
  61232. * (Highstock) Paramters used in calculation of regression series' points.
  61233. */
  61234. export interface PlotMomentumParamsOptions {
  61235. /**
  61236. * (Highstock) The point index which indicator calculations will base. For
  61237. * example using OHLC data, index=2 means the indicator will be calculated
  61238. * using Low values.
  61239. */
  61240. index?: number;
  61241. /**
  61242. * (Highstock) The base period for indicator calculations. This is the
  61243. * number of data points which are taken into account for the indicator
  61244. * calculations.
  61245. */
  61246. period?: number;
  61247. }
  61248. /**
  61249. * (Highstock) Enable or disable the initial animation when a series is
  61250. * displayed. The animation can also be set as a configuration object. Please
  61251. * note that this option only applies to the initial animation of the series
  61252. * itself. For other animations, see chart.animation and the animation parameter
  61253. * under the API methods. The following properties are supported:
  61254. *
  61255. * - `defer`: The animation delay time in milliseconds.
  61256. *
  61257. * - `duration`: The duration of the animation in milliseconds.
  61258. *
  61259. * - `easing`: Can be a string reference to an easing function set on the `Math`
  61260. * object or a function. See the _Custom easing function_ demo below.
  61261. *
  61262. * Due to poor performance, animation is disabled in old IE browsers for several
  61263. * chart types.
  61264. */
  61265. export interface PlotNatrAnimationOptions {
  61266. defer?: number;
  61267. }
  61268. /**
  61269. * (Highcharts, Highstock, Highmaps, Gantt) Enable or disable the initial
  61270. * animation when a series is displayed for the `dataLabels`. The animation can
  61271. * also be set as a configuration object. Please note that this option only
  61272. * applies to the initial animation. For other animations, see chart.animation
  61273. * and the animation parameter under the API methods. The following properties
  61274. * are supported:
  61275. *
  61276. * - `defer`: The animation delay time in milliseconds.
  61277. */
  61278. export interface PlotNatrDataLabelsAnimationOptions {
  61279. /**
  61280. * (Highcharts, Highstock, Highmaps, Gantt) The animation delay time in
  61281. * milliseconds. Set to `0` renders dataLabel immediately. As `undefined`
  61282. * inherits defer time from the series.animation.defer.
  61283. */
  61284. defer?: number;
  61285. }
  61286. /**
  61287. * (Highcharts, Highstock, Highmaps, Gantt) Options for the series data labels,
  61288. * appearing next to each data point.
  61289. *
  61290. * Since v6.2.0, multiple data labels can be applied to each single point by
  61291. * defining them as an array of configs.
  61292. *
  61293. * In styled mode, the data labels can be styled with the
  61294. * `.highcharts-data-label-box` and `.highcharts-data-label` class names (see
  61295. * example).
  61296. */
  61297. export interface PlotNatrDataLabelsOptions {
  61298. /**
  61299. * (Highcharts, Highstock, Highmaps, Gantt) The alignment of the data label
  61300. * compared to the point. If `right`, the right side of the label should be
  61301. * touching the point. For points with an extent, like columns, the
  61302. * alignments also dictates how to align it inside the box, as given with
  61303. * the inside option. Can be one of `left`, `center` or `right`.
  61304. */
  61305. align?: (AlignValue|null);
  61306. /**
  61307. * (Highcharts, Highstock, Highmaps, Gantt) Whether to allow data labels to
  61308. * overlap. To make the labels less sensitive for overlapping, the
  61309. * dataLabels.padding can be set to 0.
  61310. */
  61311. allowOverlap?: boolean;
  61312. /**
  61313. * (Highcharts, Highstock, Highmaps, Gantt) Enable or disable the initial
  61314. * animation when a series is displayed for the `dataLabels`. The animation
  61315. * can also be set as a configuration object. Please note that this option
  61316. * only applies to the initial animation. For other animations, see
  61317. * chart.animation and the animation parameter under the API methods. The
  61318. * following properties are supported:
  61319. *
  61320. * - `defer`: The animation delay time in milliseconds.
  61321. */
  61322. animation?: (boolean|PlotNatrDataLabelsAnimationOptions|Partial<AnimationOptionsObject>);
  61323. /**
  61324. * (Highcharts, Highstock, Highmaps, Gantt) The background color or gradient
  61325. * for the data label.
  61326. */
  61327. backgroundColor?: (ColorString|GradientColorObject|PatternObject);
  61328. /**
  61329. * (Highcharts, Highstock, Highmaps, Gantt) The border color for the data
  61330. * label. Defaults to `undefined`.
  61331. */
  61332. borderColor?: (ColorString|GradientColorObject|PatternObject);
  61333. /**
  61334. * (Highcharts, Highstock, Highmaps, Gantt) The border radius in pixels for
  61335. * the data label.
  61336. */
  61337. borderRadius?: number;
  61338. /**
  61339. * (Highcharts, Highstock, Highmaps, Gantt) The border width in pixels for
  61340. * the data label.
  61341. */
  61342. borderWidth?: number;
  61343. /**
  61344. * (Highcharts, Highstock, Highmaps, Gantt) A class name for the data label.
  61345. * Particularly in styled mode, this can be used to give each series' or
  61346. * point's data label unique styling. In addition to this option, a default
  61347. * color class name is added so that we can give the labels a contrast text
  61348. * shadow.
  61349. */
  61350. className?: string;
  61351. /**
  61352. * (Highcharts, Highstock, Highmaps, Gantt) The text color for the data
  61353. * labels. Defaults to `undefined`. For certain series types, like column or
  61354. * map, the data labels can be drawn inside the points. In this case the
  61355. * data label will be drawn with maximum contrast by default. Additionally,
  61356. * it will be given a `text-outline` style with the opposite color, to
  61357. * further increase the contrast. This can be overridden by setting the
  61358. * `text-outline` style to `none` in the `dataLabels.style` option.
  61359. */
  61360. color?: (ColorString|GradientColorObject|PatternObject);
  61361. /**
  61362. * (Highcharts, Highstock, Highmaps, Gantt) Whether to hide data labels that
  61363. * are outside the plot area. By default, the data label is moved inside the
  61364. * plot area according to the overflow option.
  61365. */
  61366. crop?: boolean;
  61367. /**
  61368. * (Highcharts, Highstock, Gantt) Whether to defer displaying the data
  61369. * labels until the initial series animation has finished. Setting to
  61370. * `false` renders the data label immediately. If set to `true` inherits the
  61371. * defer time set in plotOptions.series.animation.
  61372. */
  61373. defer?: boolean;
  61374. /**
  61375. * (Highcharts, Highstock, Highmaps, Gantt) Enable or disable the data
  61376. * labels.
  61377. */
  61378. enabled?: boolean;
  61379. /**
  61380. * (Highcharts, Highstock, Highmaps, Gantt) A declarative filter to control
  61381. * of which data labels to display. The declarative filter is designed for
  61382. * use when callback functions are not available, like when the chart
  61383. * options require a pure JSON structure or for use with graphical editors.
  61384. * For programmatic control, use the `formatter` instead, and return
  61385. * `undefined` to disable a single data label.
  61386. */
  61387. filter?: DataLabelsFilterOptionsObject;
  61388. /**
  61389. * (Highcharts, Highstock, Highmaps, Gantt) A format string for the data
  61390. * label. Available variables are the same as for `formatter`.
  61391. */
  61392. format?: string;
  61393. /**
  61394. * (Highcharts, Highstock, Highmaps, Gantt) Callback JavaScript function to
  61395. * format the data label. Note that if a `format` is defined, the format
  61396. * takes precedence and the formatter is ignored.
  61397. */
  61398. formatter?: DataLabelsFormatterCallbackFunction;
  61399. /**
  61400. * (Highcharts, Highstock, Highmaps, Gantt) For points with an extent, like
  61401. * columns or map areas, whether to align the data label inside the box or
  61402. * to the actual value point. Defaults to `false` in most cases, `true` in
  61403. * stacked columns.
  61404. */
  61405. inside?: boolean;
  61406. /**
  61407. * (Highcharts, Highstock, Highmaps, Gantt) Format for points with the value
  61408. * of null. Works analogously to format. `nullFormat` can be applied only to
  61409. * series which support displaying null points.
  61410. */
  61411. nullFormat?: (boolean|string);
  61412. /**
  61413. * (Highcharts, Highstock, Highmaps, Gantt) Callback JavaScript function
  61414. * that defines formatting for points with the value of null. Works
  61415. * analogously to formatter. `nullPointFormatter` can be applied only to
  61416. * series which support displaying null points.
  61417. */
  61418. nullFormatter?: DataLabelsFormatterCallbackFunction;
  61419. /**
  61420. * (Highcharts, Highstock, Highmaps, Gantt) How to handle data labels that
  61421. * flow outside the plot area. The default is `"justify"`, which aligns them
  61422. * inside the plot area. For columns and bars, this means it will be moved
  61423. * inside the bar. To display data labels outside the plot area, set `crop`
  61424. * to `false` and `overflow` to `"allow"`.
  61425. */
  61426. overflow?: DataLabelsOverflowValue;
  61427. /**
  61428. * (Highcharts, Highstock, Highmaps, Gantt) When either the `borderWidth` or
  61429. * the `backgroundColor` is set, this is the padding within the box.
  61430. */
  61431. padding?: number;
  61432. /**
  61433. * (Highcharts, Highstock, Highmaps, Gantt) Aligns data labels relative to
  61434. * points. If `center` alignment is not possible, it defaults to `right`.
  61435. */
  61436. position?: AlignValue;
  61437. /**
  61438. * (Highcharts, Highstock, Highmaps, Gantt) Text rotation in degrees. Note
  61439. * that due to a more complex structure, backgrounds, borders and padding
  61440. * will be lost on a rotated data label.
  61441. */
  61442. rotation?: number;
  61443. /**
  61444. * (Highcharts, Highstock, Highmaps, Gantt) The shadow of the box. Works
  61445. * best with `borderWidth` or `backgroundColor`. Since 2.3 the shadow can be
  61446. * an object configuration containing `color`, `offsetX`, `offsetY`,
  61447. * `opacity` and `width`.
  61448. */
  61449. shadow?: (boolean|ShadowOptionsObject);
  61450. /**
  61451. * (Highcharts, Highstock, Highmaps, Gantt) The name of a symbol to use for
  61452. * the border around the label. Symbols are predefined functions on the
  61453. * Renderer object.
  61454. */
  61455. shape?: string;
  61456. /**
  61457. * (Highcharts, Highstock, Highmaps, Gantt) Styles for the label. The
  61458. * default `color` setting is `"contrast"`, which is a pseudo color that
  61459. * Highcharts picks up and applies the maximum contrast to the underlying
  61460. * point item, for example the bar in a bar chart.
  61461. *
  61462. * The `textOutline` is a pseudo property that applies an outline of the
  61463. * given width with the given color, which by default is the maximum
  61464. * contrast to the text. So a bright text color will result in a black text
  61465. * outline for maximum readability on a mixed background. In some cases,
  61466. * especially with grayscale text, the text outline doesn't work well, in
  61467. * which cases it can be disabled by setting it to `"none"`. When `useHTML`
  61468. * is true, the `textOutline` will not be picked up. In this, case, the same
  61469. * effect can be acheived through the `text-shadow` CSS property.
  61470. *
  61471. * For some series types, where each point has an extent, like for example
  61472. * tree maps, the data label may overflow the point. There are two
  61473. * strategies for handling overflow. By default, the text will wrap to
  61474. * multiple lines. The other strategy is to set `style.textOverflow` to
  61475. * `ellipsis`, which will keep the text on one line plus it will break
  61476. * inside long words.
  61477. */
  61478. style?: CSSObject;
  61479. /**
  61480. * (Highcharts, Highstock, Highmaps, Gantt) Options for a label text which
  61481. * should follow marker's shape. Border and background are disabled for a
  61482. * label that follows a path.
  61483. *
  61484. * **Note:** Only SVG-based renderer supports this option. Setting `useHTML`
  61485. * to true will disable this option.
  61486. */
  61487. textPath?: DataLabelsTextPathOptionsObject;
  61488. /**
  61489. * (Highcharts, Highstock, Highmaps, Gantt) Whether to use HTML to render
  61490. * the labels.
  61491. */
  61492. useHTML?: boolean;
  61493. /**
  61494. * (Highcharts, Highstock, Highmaps, Gantt) The vertical alignment of a data
  61495. * label. Can be one of `top`, `middle` or `bottom`. The default value
  61496. * depends on the data, for instance in a column chart, the label is above
  61497. * positive values and below negative values.
  61498. */
  61499. verticalAlign?: (VerticalAlignValue|null);
  61500. /**
  61501. * (Highcharts, Highstock, Highmaps, Gantt) The x position offset of the
  61502. * label relative to the point in pixels.
  61503. */
  61504. x?: number;
  61505. /**
  61506. * (Highcharts, Highstock, Highmaps, Gantt) The y position offset of the
  61507. * label relative to the point in pixels.
  61508. */
  61509. y?: number;
  61510. /**
  61511. * (Highcharts, Highstock, Highmaps, Gantt) The Z index of the data labels.
  61512. * The default Z index puts it above the series. Use a Z index of 2 to
  61513. * display it behind the series.
  61514. */
  61515. z?: number;
  61516. }
  61517. /**
  61518. * (Highcharts, Highstock) Options for the series data sorting.
  61519. */
  61520. export interface PlotNatrDataSortingOptions {
  61521. /**
  61522. * (Highcharts, Highstock) Enable or disable data sorting for the series.
  61523. * Use xAxis.reversed to change the sorting order.
  61524. */
  61525. enabled?: boolean;
  61526. /**
  61527. * (Highcharts, Highstock) Whether to allow matching points by name in an
  61528. * update. If this option is disabled, points will be matched by order.
  61529. */
  61530. matchByName?: boolean;
  61531. /**
  61532. * (Highcharts, Highstock) Determines what data value should be used to sort
  61533. * by.
  61534. */
  61535. sortKey?: string;
  61536. }
  61537. /**
  61538. * (Highstock) Normalized average true range indicator (NATR). This series
  61539. * requires `linkedTo` option to be set and should be loaded after the
  61540. * `stock/indicators/indicators.js` and `stock/indicators/atr.js`.
  61541. *
  61542. * In TypeScript the type option must always be set.
  61543. *
  61544. * Configuration options for the series are given in three levels:
  61545. *
  61546. * 1. Options for all series in a chart are defined in the plotOptions.series
  61547. * object.
  61548. *
  61549. * 2. Options for all `natr` series are defined in plotOptions.natr.
  61550. *
  61551. * 3. Options for one single series are given in the series instance array. (see
  61552. * online documentation for example)
  61553. */
  61554. export interface PlotNatrOptions {
  61555. /**
  61556. * (Highstock) Accessibility options for a series.
  61557. */
  61558. accessibility?: SeriesAccessibilityOptionsObject;
  61559. /**
  61560. * (Highstock) Allow this series' points to be selected by clicking on the
  61561. * graphic (columns, point markers, pie slices, map areas etc).
  61562. *
  61563. * The selected points can be handled by point select and unselect events,
  61564. * or collectively by the getSelectedPoints function.
  61565. *
  61566. * And alternative way of selecting points is through dragging.
  61567. */
  61568. allowPointSelect?: boolean;
  61569. /**
  61570. * (Highstock) Enable or disable the initial animation when a series is
  61571. * displayed. The animation can also be set as a configuration object.
  61572. * Please note that this option only applies to the initial animation of the
  61573. * series itself. For other animations, see chart.animation and the
  61574. * animation parameter under the API methods. The following properties are
  61575. * supported:
  61576. *
  61577. * - `defer`: The animation delay time in milliseconds.
  61578. *
  61579. * - `duration`: The duration of the animation in milliseconds.
  61580. *
  61581. * - `easing`: Can be a string reference to an easing function set on the
  61582. * `Math` object or a function. See the _Custom easing function_ demo below.
  61583. *
  61584. * Due to poor performance, animation is disabled in old IE browsers for
  61585. * several chart types.
  61586. */
  61587. animation?: (boolean|PlotNatrAnimationOptions|Partial<AnimationOptionsObject>);
  61588. /**
  61589. * (Highstock) For some series, there is a limit that shuts down initial
  61590. * animation by default when the total number of points in the chart is too
  61591. * high. For example, for a column chart and its derivatives, animation does
  61592. * not run if there is more than 250 points totally. To disable this cap,
  61593. * set `animationLimit` to `Infinity`.
  61594. */
  61595. animationLimit?: number;
  61596. /**
  61597. * (Highstock) Sets the color blending in the boost module.
  61598. */
  61599. boostBlending?: OptionsBoostBlendingValue;
  61600. /**
  61601. * (Highstock) Set the point threshold for when a series should enter boost
  61602. * mode.
  61603. *
  61604. * Setting it to e.g. 2000 will cause the series to enter boost mode when
  61605. * there are 2000 or more points in the series.
  61606. *
  61607. * To disable boosting on the series, set the `boostThreshold` to 0. Setting
  61608. * it to 1 will force boosting.
  61609. *
  61610. * Note that the cropThreshold also affects this setting. When zooming in on
  61611. * a series that has fewer points than the `cropThreshold`, all points are
  61612. * rendered although outside the visible plot area, and the `boostThreshold`
  61613. * won't take effect.
  61614. */
  61615. boostThreshold?: number;
  61616. /**
  61617. * (Highmaps) The border color of the map areas.
  61618. *
  61619. * In styled mode, the border stroke is given in the `.highcharts-point`
  61620. * class.
  61621. */
  61622. borderColor?: (ColorString|GradientColorObject|PatternObject);
  61623. /**
  61624. * (Highmaps) The border width of each map area.
  61625. *
  61626. * In styled mode, the border stroke width is given in the
  61627. * `.highcharts-point` class.
  61628. */
  61629. borderWidth?: number;
  61630. /**
  61631. * (Highstock) An additional class name to apply to the series' graphical
  61632. * elements. This option does not replace default class names of the
  61633. * graphical element.
  61634. */
  61635. className?: string;
  61636. /**
  61637. * (Highstock) Disable this option to allow series rendering in the whole
  61638. * plotting area.
  61639. *
  61640. * **Note:** Clipping should be always enabled when chart.zoomType is set
  61641. */
  61642. clip?: boolean;
  61643. /**
  61644. * (Highstock) The main color of the series. In line type series it applies
  61645. * to the line and the point markers unless otherwise specified. In bar type
  61646. * series it applies to the bars unless a color is specified per point. The
  61647. * default value is pulled from the `options.colors` array.
  61648. *
  61649. * In styled mode, the color can be defined by the colorIndex option. Also,
  61650. * the series color can be set with the `.highcharts-series`,
  61651. * `.highcharts-color-{n}`, `.highcharts-{type}-series` or
  61652. * `.highcharts-series-{n}` class, or individual classes given by the
  61653. * `className` option.
  61654. */
  61655. color?: (ColorString|GradientColorObject|PatternObject);
  61656. /**
  61657. * (Highstock) Styled mode only. A specific color index to use for the
  61658. * series, so its graphic representations are given the class name
  61659. * `highcharts-color-{n}`.
  61660. */
  61661. colorIndex?: number;
  61662. /**
  61663. * (Highcharts, Highstock, Highmaps) Determines what data value should be
  61664. * used to calculate point color if `colorAxis` is used. Requires to set
  61665. * `min` and `max` if some custom point property is used or if approximation
  61666. * for data grouping is set to `'sum'`.
  61667. */
  61668. colorKey?: string;
  61669. /**
  61670. * (Highstock) Compare the values of the series against the first non-null,
  61671. * non- zero value in the visible range. The y axis will show percentage or
  61672. * absolute change depending on whether `compare` is set to `"percent"` or
  61673. * `"value"`. When this is applied to multiple series, it allows comparing
  61674. * the development of the series against each other. Adds a `change` field
  61675. * to every point object.
  61676. */
  61677. compare?: string;
  61678. /**
  61679. * (Highstock) When compare is `percent`, this option dictates whether to
  61680. * use 0 or 100 as the base of comparison.
  61681. */
  61682. compareBase?: (0|100);
  61683. /**
  61684. * (Highstock) Defines if comparison should start from the first point
  61685. * within the visible range or should start from the first point **before**
  61686. * the range.
  61687. *
  61688. * In other words, this flag determines if first point within the visible
  61689. * range will have 0% (`compareStart=true`) or should have been already
  61690. * calculated according to the previous point (`compareStart=false`).
  61691. */
  61692. compareStart?: boolean;
  61693. /**
  61694. * (Highstock) Whether to compare indicator to the main series values or
  61695. * indicator values.
  61696. */
  61697. compareToMain?: boolean;
  61698. /**
  61699. * (Highcharts) Polar charts only. Whether to connect the ends of a line
  61700. * series plot across the extremes.
  61701. */
  61702. connectEnds?: boolean;
  61703. /**
  61704. * (Highcharts, Highstock) Whether to connect a graph line across null
  61705. * points, or render a gap between the two points on either side of the
  61706. * null.
  61707. */
  61708. connectNulls?: boolean;
  61709. /**
  61710. * (Gantt) Override Pathfinder connector options for a series. Requires
  61711. * Highcharts Gantt to be loaded.
  61712. */
  61713. connectors?: SeriesConnectorsOptionsObject;
  61714. /**
  61715. * (Highcharts, Highstock, Gantt) When true, each point or column edge is
  61716. * rounded to its nearest pixel in order to render sharp on screen. In some
  61717. * cases, when there are a lot of densely packed columns, this leads to
  61718. * visible difference in column widths or distance between columns. In these
  61719. * cases, setting `crisp` to `false` may look better, even though each
  61720. * column is rendered blurry.
  61721. */
  61722. crisp?: boolean;
  61723. /**
  61724. * (Highcharts, Highstock) When the series contains less points than the
  61725. * crop threshold, all points are drawn, even if the points fall outside the
  61726. * visible plot area at the current zoom. The advantage of drawing all
  61727. * points (including markers and columns), is that animation is performed on
  61728. * updates. On the other hand, when the series contains more points than the
  61729. * crop threshold, the series data is cropped to only contain points that
  61730. * fall within the plot area. The advantage of cropping away invisible
  61731. * points is to increase performance on large series.
  61732. */
  61733. cropThreshold?: number;
  61734. /**
  61735. * (Highstock) You can set the cursor to "pointer" if you have click events
  61736. * attached to the series, to signal to the user that the points and lines
  61737. * can be clicked.
  61738. *
  61739. * In styled mode, the series cursor can be set with the same classes as
  61740. * listed under series.color.
  61741. */
  61742. cursor?: (string|CursorValue);
  61743. /**
  61744. * (Highstock) A reserved subspace to store options and values for
  61745. * customized functionality. Here you can add additional data for your own
  61746. * event callbacks and formatter callbacks.
  61747. */
  61748. custom?: Dictionary<any>;
  61749. /**
  61750. * (Highstock) Name of the dash style to use for the graph, or for some
  61751. * series types the outline of each shape.
  61752. *
  61753. * In styled mode, the stroke dash-array can be set with the same classes as
  61754. * listed under series.color.
  61755. */
  61756. dashStyle?: DashStyleValue;
  61757. /**
  61758. * (Highstock) Data grouping is the concept of sampling the data values into
  61759. * larger blocks in order to ease readability and increase performance of
  61760. * the JavaScript charts. Highstock by default applies data grouping when
  61761. * the points become closer than a certain pixel value, determined by the
  61762. * `groupPixelWidth` option.
  61763. *
  61764. * If data grouping is applied, the grouping information of grouped points
  61765. * can be read from the Point.dataGroup. If point options other than the
  61766. * data itself are set, for example `name` or `color` or custom properties,
  61767. * the grouping logic doesn't know how to group it. In this case the options
  61768. * of the first point instance are copied over to the group point. This can
  61769. * be altered through a custom `approximation` callback function.
  61770. */
  61771. dataGrouping?: DataGroupingOptionsObject;
  61772. /**
  61773. * (Highcharts, Highstock, Highmaps, Gantt) Options for the series data
  61774. * labels, appearing next to each data point.
  61775. *
  61776. * Since v6.2.0, multiple data labels can be applied to each single point by
  61777. * defining them as an array of configs.
  61778. *
  61779. * In styled mode, the data labels can be styled with the
  61780. * `.highcharts-data-label-box` and `.highcharts-data-label` class names
  61781. * (see example).
  61782. */
  61783. dataLabels?: (PlotNatrDataLabelsOptions|Array<PlotNatrDataLabelsOptions>);
  61784. /**
  61785. * (Highcharts, Highstock) Options for the series data sorting.
  61786. */
  61787. dataSorting?: (DataSortingOptionsObject|PlotNatrDataSortingOptions);
  61788. /**
  61789. * (Highstock) A description of the series to add to the screen reader
  61790. * information about the series.
  61791. */
  61792. description?: string;
  61793. /**
  61794. * (Highstock) Enable or disable the mouse tracking for a specific series.
  61795. * This includes point tooltips and click events on graphs and points. For
  61796. * large datasets it improves performance.
  61797. */
  61798. enableMouseTracking?: boolean;
  61799. /**
  61800. * (Highstock) General event handlers for the series items. These event
  61801. * hooks can also be attached to the series at run time using the
  61802. * `Highcharts.addEvent` function.
  61803. */
  61804. events?: SeriesEventsOptionsObject;
  61805. /**
  61806. * (Highstock) Determines whether the series should look for the nearest
  61807. * point in both dimensions or just the x-dimension when hovering the
  61808. * series. Defaults to `'xy'` for scatter series and `'x'` for most other
  61809. * series. If the data has duplicate x-values, it is recommended to set this
  61810. * to `'xy'` to allow hovering over all points.
  61811. *
  61812. * Applies only to series types using nearest neighbor search (not direct
  61813. * hover) for tooltip.
  61814. */
  61815. findNearestPointBy?: OptionsFindNearestPointByValue;
  61816. /**
  61817. * (Highstock) Defines when to display a gap in the graph, together with the
  61818. * gapUnit option.
  61819. *
  61820. * In case when `dataGrouping` is enabled, points can be grouped into a
  61821. * larger time span. This can make the grouped points to have a greater
  61822. * distance than the absolute value of `gapSize` property, which will result
  61823. * in disappearing graph completely. To prevent this situation the mentioned
  61824. * distance between grouped points is used instead of previously defined
  61825. * `gapSize`.
  61826. *
  61827. * In practice, this option is most often used to visualize gaps in time
  61828. * series. In a stock chart, intraday data is available for daytime hours,
  61829. * while gaps will appear in nights and weekends.
  61830. */
  61831. gapSize?: number;
  61832. /**
  61833. * (Highstock) Together with gapSize, this option defines where to draw gaps
  61834. * in the graph.
  61835. *
  61836. * When the `gapUnit` is `"relative"` (default), a gap size of 5 means that
  61837. * if the distance between two points is greater than 5 times that of the
  61838. * two closest points, the graph will be broken.
  61839. *
  61840. * When the `gapUnit` is `"value"`, the gap is based on absolute axis
  61841. * values, which on a datetime axis is milliseconds. This also applies to
  61842. * the navigator series that inherits gap options from the base series.
  61843. */
  61844. gapUnit?: OptionsGapUnitValue;
  61845. /**
  61846. * (Highcharts, Highstock, Gantt) Whether to use the Y extremes of the total
  61847. * chart width or only the zoomed area when zooming in on parts of the X
  61848. * axis. By default, the Y axis adjusts to the min and max of the visible
  61849. * data. Cartesian series only.
  61850. */
  61851. getExtremesFromAll?: boolean;
  61852. /**
  61853. * (Highstock) When set to `false` will prevent the series data from being
  61854. * included in any form of data export.
  61855. *
  61856. * Since version 6.0.0 until 7.1.0 the option was existing undocumented as
  61857. * `includeInCSVExport`.
  61858. */
  61859. includeInDataExport?: boolean;
  61860. /**
  61861. * (Highcharts, Highstock, Gantt) Series labels are placed as close to the
  61862. * series as possible in a natural way, seeking to avoid other series. The
  61863. * goal of this feature is to make the chart more easily readable, like if a
  61864. * human designer placed the labels in the optimal position.
  61865. *
  61866. * The series labels currently work with series types having a `graph` or an
  61867. * `area`.
  61868. */
  61869. label?: SeriesLabelOptionsObject;
  61870. /**
  61871. * (Highstock) The line marks the last price from all points.
  61872. */
  61873. lastPrice?: SeriesLastPriceOptionsObject;
  61874. /**
  61875. * (Highstock) The line marks the last price from visible range of points.
  61876. */
  61877. lastVisiblePrice?: SeriesLastVisiblePriceOptionsObject;
  61878. /**
  61879. * (Highcharts, Highstock) The SVG value used for the `stroke-linecap` and
  61880. * `stroke-linejoin` of a line graph. Round means that lines are rounded in
  61881. * the ends and bends.
  61882. */
  61883. linecap?: SeriesLinecapValue;
  61884. /**
  61885. * (Highcharts, Highstock) Pixel width of the graph line.
  61886. */
  61887. lineWidth?: number;
  61888. /**
  61889. * (Highcharts, Highstock, Gantt) The main series ID that indicator will be
  61890. * based on. Required for this indicator.
  61891. */
  61892. linkedTo?: string;
  61893. /**
  61894. * (Highstock) Options for the point markers of line-like series. Properties
  61895. * like `fillColor`, `lineColor` and `lineWidth` define the visual
  61896. * appearance of the markers. Other series types, like column series, don't
  61897. * have markers, but have visual options on the series level instead.
  61898. *
  61899. * In styled mode, the markers can be styled with the `.highcharts-point`,
  61900. * `.highcharts-point-hover` and `.highcharts-point-select` class names.
  61901. */
  61902. marker?: PointMarkerOptionsObject;
  61903. /**
  61904. * (Highstock) The name of the series as shown in the legend, tooltip etc.
  61905. * If not set, it will be based on a technical indicator type and default
  61906. * params.
  61907. */
  61908. name?: string;
  61909. /**
  61910. * (Highstock) The color for the parts of the graph or points that are below
  61911. * the threshold. Note that `zones` takes precedence over the negative
  61912. * color. Using `negativeColor` is equivalent to applying a zone with value
  61913. * of 0.
  61914. */
  61915. negativeColor?: (ColorString|GradientColorObject|PatternObject);
  61916. /**
  61917. * (Highstock) Opacity of a series parts: line, fill (e.g. area) and
  61918. * dataLabels.
  61919. */
  61920. opacity?: number;
  61921. /**
  61922. * (Highstock) Paramters used in calculation of regression series' points.
  61923. */
  61924. params?: PlotNatrParamsOptions;
  61925. /**
  61926. * (Highstock) Properties for each single point.
  61927. */
  61928. point?: PlotSeriesPointOptions;
  61929. /**
  61930. * (Highstock) Same as accessibility.pointDescriptionFormatter, but for an
  61931. * individual series. Overrides the chart wide configuration.
  61932. */
  61933. pointDescriptionFormatter?: Function;
  61934. /**
  61935. * (Highstock) Whether to select the series initially. If `showCheckbox` is
  61936. * true, the checkbox next to the series name in the legend will be checked
  61937. * for a selected series.
  61938. */
  61939. selected?: boolean;
  61940. /**
  61941. * (Highstock) Whether to apply a drop shadow to the graph line. Since 2.3
  61942. * the shadow can be an object configuration containing `color`, `offsetX`,
  61943. * `offsetY`, `opacity` and `width`.
  61944. */
  61945. shadow?: (boolean|ShadowOptionsObject);
  61946. /**
  61947. * (Highstock) If true, a checkbox is displayed next to the legend item to
  61948. * allow selecting the series. The state of the checkbox is determined by
  61949. * the `selected` option.
  61950. */
  61951. showCheckbox?: boolean;
  61952. /**
  61953. * (Highstock) Whether to display this particular series or series type in
  61954. * the legend. Standalone series are shown in legend by default, and linked
  61955. * series are not. Since v7.2.0 it is possible to show series that use
  61956. * colorAxis by setting this option to `true`.
  61957. */
  61958. showInLegend?: boolean;
  61959. /**
  61960. * (Highstock) If set to `true`, the accessibility module will skip past the
  61961. * points in this series for keyboard navigation.
  61962. */
  61963. skipKeyboardNavigation?: boolean;
  61964. /**
  61965. * (Highcharts, Highstock) When this is true, the series will not cause the
  61966. * Y axis to cross the zero plane (or threshold option) unless the data
  61967. * actually crosses the plane.
  61968. *
  61969. * For example, if `softThreshold` is `false`, a series of 0, 1, 2, 3 will
  61970. * make the Y axis show negative values according to the `minPadding`
  61971. * option. If `softThreshold` is `true`, the Y axis starts at 0.
  61972. */
  61973. softThreshold?: boolean;
  61974. states?: SeriesStatesOptionsObject;
  61975. /**
  61976. * (Highcharts, Highstock) Whether to apply steps to the line. Possible
  61977. * values are `left`, `center` and `right`.
  61978. */
  61979. step?: OptionsStepValue;
  61980. /**
  61981. * (Highstock) Sticky tracking of mouse events. When true, the `mouseOut`
  61982. * event on a series isn't triggered until the mouse moves over another
  61983. * series, or out of the plot area. When false, the `mouseOut` event on a
  61984. * series is triggered when the mouse leaves the area around the series'
  61985. * graph or markers. This also implies the tooltip when not shared. When
  61986. * `stickyTracking` is false and `tooltip.shared` is false, the tooltip will
  61987. * be hidden when moving the mouse between series. Defaults to true for line
  61988. * and area type series, but to false for columns, pies etc.
  61989. *
  61990. * **Note:** The boost module will force this option because of technical
  61991. * limitations.
  61992. */
  61993. stickyTracking?: boolean;
  61994. /**
  61995. * (Highcharts, Highstock) The threshold, also called zero level or base
  61996. * level. For line type series this is only used in conjunction with
  61997. * negativeColor.
  61998. */
  61999. threshold?: (number|null);
  62000. /**
  62001. * (Highstock) A configuration object for the tooltip rendering of each
  62002. * single series. Properties are inherited from tooltip, but only the
  62003. * following properties can be defined on a series level.
  62004. */
  62005. tooltip?: SeriesTooltipOptionsObject;
  62006. /**
  62007. * (Highcharts, Highstock, Gantt) When a series contains a data array that
  62008. * is longer than this, only one dimensional arrays of numbers, or two
  62009. * dimensional arrays with x and y values are allowed. Also, only the first
  62010. * point is tested, and the rest are assumed to be the same format. This
  62011. * saves expensive data checking and indexing in long series. Set it to `0`
  62012. * disable.
  62013. *
  62014. * Note: In boost mode turbo threshold is forced. Only array of numbers or
  62015. * two dimensional arrays are allowed.
  62016. */
  62017. turboThreshold?: number;
  62018. /**
  62019. * (Highstock) Set the initial visibility of the series.
  62020. */
  62021. visible?: boolean;
  62022. /**
  62023. * (Highmaps) Define the z index of the series.
  62024. */
  62025. zIndex?: number;
  62026. /**
  62027. * (Highcharts, Highstock) Defines the Axis on which the zones are applied.
  62028. */
  62029. zoneAxis?: string;
  62030. /**
  62031. * (Highcharts, Highstock) An array defining zones within a series. Zones
  62032. * can be applied to the X axis, Y axis or Z axis for bubbles, according to
  62033. * the `zoneAxis` option. The zone definitions have to be in ascending order
  62034. * regarding to the value.
  62035. *
  62036. * In styled mode, the color zones are styled with the
  62037. * `.highcharts-zone-{n}` class, or custom classed from the `className`
  62038. * option (view live demo).
  62039. */
  62040. zones?: Array<SeriesZonesOptionsObject>;
  62041. }
  62042. /**
  62043. * (Highstock) Paramters used in calculation of regression series' points.
  62044. */
  62045. export interface PlotNatrParamsOptions {
  62046. /**
  62047. * (Highstock) The point index which indicator calculations will base. For
  62048. * example using OHLC data, index=2 means the indicator will be calculated
  62049. * using Low values.
  62050. */
  62051. index?: number;
  62052. /**
  62053. * (Highstock) The base period for indicator calculations. This is the
  62054. * number of data points which are taken into account for the indicator
  62055. * calculations.
  62056. */
  62057. period?: number;
  62058. }
  62059. /**
  62060. * (Highcharts, Highstock, Highmaps, Gantt) Enable or disable the initial
  62061. * animation when a series is displayed for the `dataLabels`. The animation can
  62062. * also be set as a configuration object. Please note that this option only
  62063. * applies to the initial animation. For other animations, see chart.animation
  62064. * and the animation parameter under the API methods. The following properties
  62065. * are supported:
  62066. *
  62067. * - `defer`: The animation delay time in milliseconds.
  62068. */
  62069. export interface PlotNetworkgraphDataLabelsAnimationOptions {
  62070. /**
  62071. * (Highcharts, Highstock, Highmaps, Gantt) The animation delay time in
  62072. * milliseconds. Set to `0` renders dataLabel immediately. As `undefined`
  62073. * inherits defer time from the series.animation.defer.
  62074. */
  62075. defer?: number;
  62076. }
  62077. /**
  62078. * (Highcharts, Highstock, Highmaps, Gantt) Styles for the label. The default
  62079. * `color` setting is `"contrast"`, which is a pseudo color that Highcharts
  62080. * picks up and applies the maximum contrast to the underlying point item, for
  62081. * example the bar in a bar chart.
  62082. *
  62083. * The `textOutline` is a pseudo property that applies an outline of the given
  62084. * width with the given color, which by default is the maximum contrast to the
  62085. * text. So a bright text color will result in a black text outline for maximum
  62086. * readability on a mixed background. In some cases, especially with grayscale
  62087. * text, the text outline doesn't work well, in which cases it can be disabled
  62088. * by setting it to `"none"`. When `useHTML` is true, the `textOutline` will not
  62089. * be picked up. In this, case, the same effect can be acheived through the
  62090. * `text-shadow` CSS property.
  62091. *
  62092. * For some series types, where each point has an extent, like for example tree
  62093. * maps, the data label may overflow the point. There are two strategies for
  62094. * handling overflow. By default, the text will wrap to multiple lines. The
  62095. * other strategy is to set `style.textOverflow` to `ellipsis`, which will keep
  62096. * the text on one line plus it will break inside long words.
  62097. */
  62098. export interface PlotNetworkgraphDataLabelsStyleOptions {
  62099. transition?: string;
  62100. }
  62101. export interface PlotNetworkgraphLayoutAlgorithmOptions {
  62102. /**
  62103. * (Highcharts) Approximation used to calculate repulsive forces affecting
  62104. * nodes. By default, when calculateing net force, nodes are compared
  62105. * against each other, which gives O(N^2) complexity. Using Barnes-Hut
  62106. * approximation, we decrease this to O(N log N), but the resulting graph
  62107. * will have different layout. Barnes-Hut approximation divides space into
  62108. * rectangles via quad tree, where forces exerted on nodes are calculated
  62109. * directly for nearby cells, and for all others, cells are treated as a
  62110. * separate node with center of mass.
  62111. */
  62112. approximation?: OptionsApproximationValue;
  62113. /**
  62114. * (Highcharts) Attraction force applied on a node which is conected to
  62115. * another node by a link. Passed are two arguments:
  62116. *
  62117. * - `d` - which is current distance between two nodes
  62118. *
  62119. * - `k` - which is desired distance between two nodes
  62120. *
  62121. * In `verlet` integration, defaults to: `function (d, k) { return (k - d) /
  62122. * d; }`
  62123. */
  62124. attractiveForce?: Function;
  62125. /**
  62126. * (Highcharts) Experimental. Enables live simulation of the algorithm
  62127. * implementation. All nodes are animated as the forces applies on them.
  62128. */
  62129. enableSimulation?: boolean;
  62130. /**
  62131. * (Highcharts) Friction applied on forces to prevent nodes rushing to fast
  62132. * to the desired positions.
  62133. */
  62134. friction?: number;
  62135. /**
  62136. * (Highcharts) Gravitational const used in the barycenter force of the
  62137. * algorithm.
  62138. */
  62139. gravitationalConstant?: number;
  62140. /**
  62141. * (Highcharts) When `initialPositions` are set to 'circle',
  62142. * `initialPositionRadius` is a distance from the center of circle, in which
  62143. * nodes are created.
  62144. */
  62145. initialPositionRadius?: number;
  62146. /**
  62147. * (Highcharts) Initial layout algorithm for positioning nodes. Can be one
  62148. * of built-in options ("circle", "random") or a function where positions
  62149. * should be set on each node (`this.nodes`) as `node.plotX` and
  62150. * `node.plotY`
  62151. */
  62152. initialPositions?: ("circle"|"random"|Function);
  62153. /**
  62154. * (Highcharts) Integration type. Available options are `'euler'` and
  62155. * `'verlet'`. Integration determines how forces are applied on particles.
  62156. * In Euler integration, force is applied direct as `newPosition +=
  62157. * velocity;`. In Verlet integration, new position is based on a previous
  62158. * posittion without velocity: `newPosition += previousPosition -
  62159. * newPosition`.
  62160. *
  62161. * Note that different integrations give different results as forces are
  62162. * different.
  62163. *
  62164. * In Highcharts v7.0.x only `'euler'` integration was supported.
  62165. */
  62166. integration?: OptionsIntegrationValue;
  62167. /**
  62168. * (Highcharts) Ideal length (px) of the link between two nodes. When not
  62169. * defined, length is calculated as: `Math.pow(availableWidth *
  62170. * availableHeight / nodesLength, 0.4);`
  62171. *
  62172. * Note: Because of the algorithm specification, length of each link might
  62173. * be not exactly as specified.
  62174. */
  62175. linkLength?: number;
  62176. /**
  62177. * (Highcharts) Max number of iterations before algorithm will stop. In
  62178. * general, algorithm should find positions sooner, but when rendering huge
  62179. * number of nodes, it is recommended to increase this value as finding
  62180. * perfect graph positions can require more time.
  62181. */
  62182. maxIterations?: number;
  62183. /**
  62184. * (Highcharts) Verlet integration only. Max speed that node can get in one
  62185. * iteration. In terms of simulation, it's a maximum translation (in pixels)
  62186. * that node can move (in both, x and y, dimensions). While `friction` is
  62187. * applied on all nodes, max speed is applied only for nodes that move very
  62188. * fast, for example small or disconnected ones.
  62189. */
  62190. maxSpeed?: number;
  62191. /**
  62192. * (Highcharts) Repulsive force applied on a node. Passed are two arguments:
  62193. *
  62194. * - `d` - which is current distance between two nodes
  62195. *
  62196. * - `k` - which is desired distance between two nodes
  62197. *
  62198. * In `verlet` integration, defaults to: `function (d, k) { return (k - d) /
  62199. * d * (k > d ? 1 : 0) }`
  62200. */
  62201. repulsiveForce?: Function;
  62202. /**
  62203. * (Highcharts) Barnes-Hut approximation only. Deteremines when distance
  62204. * between cell and node is small enough to caculate forces. Value of
  62205. * `theta` is compared directly with quotient `s / d`, where `s` is the size
  62206. * of the cell, and `d` is distance between center of cell's mass and
  62207. * currently compared node.
  62208. */
  62209. theta?: number;
  62210. /**
  62211. * (Highcharts) Type of the algorithm used when positioning nodes.
  62212. */
  62213. type?: "reingold-fruchterman";
  62214. }
  62215. /**
  62216. * (Highcharts) Link style options
  62217. */
  62218. export interface PlotNetworkgraphLinkOptions {
  62219. /**
  62220. * (Highcharts) Color of the link between two nodes.
  62221. */
  62222. color?: string;
  62223. /**
  62224. * (Highcharts) A name for the dash style to use for links.
  62225. */
  62226. dashStyle?: string;
  62227. /**
  62228. * (Highcharts) Width (px) of the link between two nodes.
  62229. */
  62230. width?: number;
  62231. }
  62232. /**
  62233. * (Highcharts) A networkgraph is a type of relationship chart, where
  62234. * connnections (links) attracts nodes (points) and other nodes repulse each
  62235. * other.
  62236. *
  62237. * In TypeScript the type option must always be set.
  62238. *
  62239. * Configuration options for the series are given in three levels:
  62240. *
  62241. * 1. Options for all series in a chart are defined in the plotOptions.series
  62242. * object.
  62243. *
  62244. * 2. Options for all `networkgraph` series are defined in
  62245. * plotOptions.networkgraph.
  62246. *
  62247. * 3. Options for one single series are given in the series instance array. (see
  62248. * online documentation for example)
  62249. */
  62250. export interface PlotNetworkgraphOptions {
  62251. /**
  62252. * (Highcharts) Accessibility options for a series.
  62253. */
  62254. accessibility?: SeriesAccessibilityOptionsObject;
  62255. /**
  62256. * (Highmaps) Whether all areas of the map defined in `mapData` should be
  62257. * rendered. If `true`, areas which don't correspond to a data point, are
  62258. * rendered as `null` points. If `false`, those areas are skipped.
  62259. */
  62260. allAreas?: boolean;
  62261. /**
  62262. * (Highcharts) Allow this series' points to be selected by clicking on the
  62263. * graphic (columns, point markers, pie slices, map areas etc).
  62264. *
  62265. * The selected points can be handled by point select and unselect events,
  62266. * or collectively by the getSelectedPoints function.
  62267. *
  62268. * And alternative way of selecting points is through dragging.
  62269. */
  62270. allowPointSelect?: boolean;
  62271. /**
  62272. * (Highmaps) The border color of the map areas.
  62273. *
  62274. * In styled mode, the border stroke is given in the `.highcharts-point`
  62275. * class.
  62276. */
  62277. borderColor?: (ColorString|GradientColorObject|PatternObject);
  62278. /**
  62279. * (Highmaps) The border width of each map area.
  62280. *
  62281. * In styled mode, the border stroke width is given in the
  62282. * `.highcharts-point` class.
  62283. */
  62284. borderWidth?: number;
  62285. /**
  62286. * (Highcharts) An additional class name to apply to the series' graphical
  62287. * elements. This option does not replace default class names of the
  62288. * graphical element.
  62289. */
  62290. className?: string;
  62291. /**
  62292. * (Highcharts) Disable this option to allow series rendering in the whole
  62293. * plotting area.
  62294. *
  62295. * **Note:** Clipping should be always enabled when chart.zoomType is set
  62296. */
  62297. clip?: boolean;
  62298. /**
  62299. * (Highcharts) The main color of the series. In line type series it applies
  62300. * to the line and the point markers unless otherwise specified. In bar type
  62301. * series it applies to the bars unless a color is specified per point. The
  62302. * default value is pulled from the `options.colors` array.
  62303. *
  62304. * In styled mode, the color can be defined by the colorIndex option. Also,
  62305. * the series color can be set with the `.highcharts-series`,
  62306. * `.highcharts-color-{n}`, `.highcharts-{type}-series` or
  62307. * `.highcharts-series-{n}` class, or individual classes given by the
  62308. * `className` option.
  62309. */
  62310. color?: (ColorString|GradientColorObject|PatternObject);
  62311. /**
  62312. * (Highcharts) Styled mode only. A specific color index to use for the
  62313. * series, so its graphic representations are given the class name
  62314. * `highcharts-color-{n}`.
  62315. */
  62316. colorIndex?: number;
  62317. /**
  62318. * (Highstock) Compare the values of the series against the first non-null,
  62319. * non- zero value in the visible range. The y axis will show percentage or
  62320. * absolute change depending on whether `compare` is set to `"percent"` or
  62321. * `"value"`. When this is applied to multiple series, it allows comparing
  62322. * the development of the series against each other. Adds a `change` field
  62323. * to every point object.
  62324. */
  62325. compare?: string;
  62326. /**
  62327. * (Highstock) When compare is `percent`, this option dictates whether to
  62328. * use 0 or 100 as the base of comparison.
  62329. */
  62330. compareBase?: (0|100);
  62331. /**
  62332. * (Highstock) Defines if comparison should start from the first point
  62333. * within the visible range or should start from the first point **before**
  62334. * the range.
  62335. *
  62336. * In other words, this flag determines if first point within the visible
  62337. * range will have 0% (`compareStart=true`) or should have been already
  62338. * calculated according to the previous point (`compareStart=false`).
  62339. */
  62340. compareStart?: boolean;
  62341. /**
  62342. * (Gantt) Override Pathfinder connector options for a series. Requires
  62343. * Highcharts Gantt to be loaded.
  62344. */
  62345. connectors?: SeriesConnectorsOptionsObject;
  62346. /**
  62347. * (Highcharts, Highstock, Gantt) When true, each point or column edge is
  62348. * rounded to its nearest pixel in order to render sharp on screen. In some
  62349. * cases, when there are a lot of densely packed columns, this leads to
  62350. * visible difference in column widths or distance between columns. In these
  62351. * cases, setting `crisp` to `false` may look better, even though each
  62352. * column is rendered blurry.
  62353. */
  62354. crisp?: boolean;
  62355. /**
  62356. * (Highcharts) You can set the cursor to "pointer" if you have click events
  62357. * attached to the series, to signal to the user that the points and lines
  62358. * can be clicked.
  62359. *
  62360. * In styled mode, the series cursor can be set with the same classes as
  62361. * listed under series.color.
  62362. */
  62363. cursor?: (string|CursorValue);
  62364. /**
  62365. * (Highcharts) A reserved subspace to store options and values for
  62366. * customized functionality. Here you can add additional data for your own
  62367. * event callbacks and formatter callbacks.
  62368. */
  62369. custom?: Dictionary<any>;
  62370. /**
  62371. * (Highcharts) Name of the dash style to use for the graph, or for some
  62372. * series types the outline of each shape.
  62373. *
  62374. * In styled mode, the stroke dash-array can be set with the same classes as
  62375. * listed under series.color.
  62376. */
  62377. dashStyle?: DashStyleValue;
  62378. /**
  62379. * (Highstock) Data grouping is the concept of sampling the data values into
  62380. * larger blocks in order to ease readability and increase performance of
  62381. * the JavaScript charts. Highstock by default applies data grouping when
  62382. * the points become closer than a certain pixel value, determined by the
  62383. * `groupPixelWidth` option.
  62384. *
  62385. * If data grouping is applied, the grouping information of grouped points
  62386. * can be read from the Point.dataGroup. If point options other than the
  62387. * data itself are set, for example `name` or `color` or custom properties,
  62388. * the grouping logic doesn't know how to group it. In this case the options
  62389. * of the first point instance are copied over to the group point. This can
  62390. * be altered through a custom `approximation` callback function.
  62391. */
  62392. dataGrouping?: DataGroupingOptionsObject;
  62393. /**
  62394. * (Highcharts, Highstock, Highmaps, Gantt) Options for the series data
  62395. * labels, appearing next to each data point.
  62396. *
  62397. * Since v6.2.0, multiple data labels can be applied to each single point by
  62398. * defining them as an array of configs.
  62399. *
  62400. * In styled mode, the data labels can be styled with the
  62401. * `.highcharts-data-label-box` and `.highcharts-data-label` class names
  62402. * (see example).
  62403. */
  62404. dataLabels?: (SeriesNetworkgraphDataLabelsOptionsObject|Array<SeriesNetworkgraphDataLabelsOptionsObject>);
  62405. /**
  62406. * (Highcharts) A description of the series to add to the screen reader
  62407. * information about the series.
  62408. */
  62409. description?: string;
  62410. /**
  62411. * (Highcharts) Flag to determine if nodes are draggable or not.
  62412. */
  62413. draggable?: boolean;
  62414. /**
  62415. * (Highcharts) Enable or disable the mouse tracking for a specific series.
  62416. * This includes point tooltips and click events on graphs and points. For
  62417. * large datasets it improves performance.
  62418. */
  62419. enableMouseTracking?: boolean;
  62420. /**
  62421. * (Highcharts) General event handlers for the series items. These event
  62422. * hooks can also be attached to the series at run time using the
  62423. * `Highcharts.addEvent` function.
  62424. */
  62425. events?: SeriesEventsOptionsObject;
  62426. /**
  62427. * (Highcharts) Determines whether the series should look for the nearest
  62428. * point in both dimensions or just the x-dimension when hovering the
  62429. * series. Defaults to `'xy'` for scatter series and `'x'` for most other
  62430. * series. If the data has duplicate x-values, it is recommended to set this
  62431. * to `'xy'` to allow hovering over all points.
  62432. *
  62433. * Applies only to series types using nearest neighbor search (not direct
  62434. * hover) for tooltip.
  62435. */
  62436. findNearestPointBy?: OptionsFindNearestPointByValue;
  62437. /**
  62438. * (Highstock) Defines when to display a gap in the graph, together with the
  62439. * gapUnit option.
  62440. *
  62441. * In case when `dataGrouping` is enabled, points can be grouped into a
  62442. * larger time span. This can make the grouped points to have a greater
  62443. * distance than the absolute value of `gapSize` property, which will result
  62444. * in disappearing graph completely. To prevent this situation the mentioned
  62445. * distance between grouped points is used instead of previously defined
  62446. * `gapSize`.
  62447. *
  62448. * In practice, this option is most often used to visualize gaps in time
  62449. * series. In a stock chart, intraday data is available for daytime hours,
  62450. * while gaps will appear in nights and weekends.
  62451. */
  62452. gapSize?: number;
  62453. /**
  62454. * (Highstock) Together with gapSize, this option defines where to draw gaps
  62455. * in the graph.
  62456. *
  62457. * When the `gapUnit` is `"relative"` (default), a gap size of 5 means that
  62458. * if the distance between two points is greater than 5 times that of the
  62459. * two closest points, the graph will be broken.
  62460. *
  62461. * When the `gapUnit` is `"value"`, the gap is based on absolute axis
  62462. * values, which on a datetime axis is milliseconds. This also applies to
  62463. * the navigator series that inherits gap options from the base series.
  62464. */
  62465. gapUnit?: OptionsGapUnitValue;
  62466. /**
  62467. * (Highcharts) When set to `false` will prevent the series data from being
  62468. * included in any form of data export.
  62469. *
  62470. * Since version 6.0.0 until 7.1.0 the option was existing undocumented as
  62471. * `includeInCSVExport`.
  62472. */
  62473. includeInDataExport?: boolean;
  62474. /**
  62475. * (Highmaps) What property to join the `mapData` to the value data. For
  62476. * example, if joinBy is "code", the mapData items with a specific code is
  62477. * merged into the data with the same code. For maps loaded from GeoJSON,
  62478. * the keys may be held in each point's `properties` object.
  62479. *
  62480. * The joinBy option can also be an array of two values, where the first
  62481. * points to a key in the `mapData`, and the second points to another key in
  62482. * the `data`.
  62483. *
  62484. * When joinBy is `null`, the map items are joined by their position in the
  62485. * array, which performs much better in maps with many data points. This is
  62486. * the recommended option if you are printing more than a thousand data
  62487. * points and have a backend that can preprocess the data into a parallel
  62488. * array of the mapData.
  62489. */
  62490. joinBy?: (string|Array<string>);
  62491. /**
  62492. * (Highcharts) An array specifying which option maps to which key in the
  62493. * data point array. This makes it convenient to work with unstructured data
  62494. * arrays from different sources.
  62495. */
  62496. keys?: Array<string>;
  62497. /**
  62498. * (Highstock) The line marks the last price from all points.
  62499. */
  62500. lastPrice?: SeriesLastPriceOptionsObject;
  62501. /**
  62502. * (Highstock) The line marks the last price from visible range of points.
  62503. */
  62504. lastVisiblePrice?: SeriesLastVisiblePriceOptionsObject;
  62505. layoutAlgorithm?: PlotNetworkgraphLayoutAlgorithmOptions;
  62506. /**
  62507. * (Highcharts, Highstock) Pixel width of the graph line.
  62508. */
  62509. lineWidth?: number;
  62510. /**
  62511. * (Highcharts) Link style options
  62512. */
  62513. link?: PlotNetworkgraphLinkOptions;
  62514. /**
  62515. * (Highcharts, Highstock, Gantt) The id of another series to link to.
  62516. * Additionally, the value can be ":previous" to link to the previous
  62517. * series. When two series are linked, only the first one appears in the
  62518. * legend. Toggling the visibility of this also toggles the linked series.
  62519. *
  62520. * If master series uses data sorting and linked series does not have its
  62521. * own sorting definition, the linked series will be sorted in the same
  62522. * order as the master one.
  62523. */
  62524. linkedTo?: string;
  62525. /**
  62526. * (Highcharts) Options for the point markers of line-like series.
  62527. * Properties like `fillColor`, `lineColor` and `lineWidth` define the
  62528. * visual appearance of the markers. Other series types, like column series,
  62529. * don't have markers, but have visual options on the series level instead.
  62530. *
  62531. * In styled mode, the markers can be styled with the `.highcharts-point`,
  62532. * `.highcharts-point-hover` and `.highcharts-point-select` class names.
  62533. */
  62534. marker?: PointMarkerOptionsObject;
  62535. /**
  62536. * (Highstock) Options for the corresponding navigator series if
  62537. * `showInNavigator` is `true` for this series. Available options are the
  62538. * same as any series, documented at plotOptions and series.
  62539. *
  62540. * These options are merged with options in navigator.series, and will take
  62541. * precedence if the same option is defined both places.
  62542. */
  62543. navigatorOptions?: PlotSeriesOptions;
  62544. /**
  62545. * (Highcharts) Opacity of a series parts: line, fill (e.g. area) and
  62546. * dataLabels.
  62547. */
  62548. opacity?: number;
  62549. /**
  62550. * (Highcharts) Properties for each single point.
  62551. */
  62552. point?: PlotSeriesPointOptions;
  62553. /**
  62554. * (Highcharts) Same as accessibility.pointDescriptionFormatter, but for an
  62555. * individual series. Overrides the chart wide configuration.
  62556. */
  62557. pointDescriptionFormatter?: Function;
  62558. /**
  62559. * (Highstock) The width of each point on the x axis. For example in a
  62560. * column chart with one value each day, the pointRange would be 1 day (= 24
  62561. * * 3600
  62562. *
  62563. * * 1000 milliseconds). This is normally computed automatically, but this
  62564. * option can be used to override the automatic value.
  62565. */
  62566. pointRange?: number;
  62567. /**
  62568. * (Highcharts) Whether to select the series initially. If `showCheckbox` is
  62569. * true, the checkbox next to the series name in the legend will be checked
  62570. * for a selected series.
  62571. */
  62572. selected?: boolean;
  62573. /**
  62574. * (Highcharts) Whether to apply a drop shadow to the graph line. Since 2.3
  62575. * the shadow can be an object configuration containing `color`, `offsetX`,
  62576. * `offsetY`, `opacity` and `width`.
  62577. */
  62578. shadow?: (boolean|ShadowOptionsObject);
  62579. /**
  62580. * (Highcharts) If true, a checkbox is displayed next to the legend item to
  62581. * allow selecting the series. The state of the checkbox is determined by
  62582. * the `selected` option.
  62583. */
  62584. showCheckbox?: boolean;
  62585. /**
  62586. * (Highcharts) Whether to display this particular series or series type in
  62587. * the legend. Standalone series are shown in legend by default, and linked
  62588. * series are not. Since v7.2.0 it is possible to show series that use
  62589. * colorAxis by setting this option to `true`.
  62590. */
  62591. showInLegend?: boolean;
  62592. /**
  62593. * (Highstock) Whether or not to show the series in the navigator. Takes
  62594. * precedence over navigator.baseSeries if defined.
  62595. */
  62596. showInNavigator?: boolean;
  62597. /**
  62598. * (Highcharts) If set to `true`, the accessibility module will skip past
  62599. * the points in this series for keyboard navigation.
  62600. */
  62601. skipKeyboardNavigation?: boolean;
  62602. states?: SeriesStatesOptionsObject;
  62603. /**
  62604. * (Highcharts) Sticky tracking of mouse events. When true, the `mouseOut`
  62605. * event on a series isn't triggered until the mouse moves over another
  62606. * series, or out of the plot area. When false, the `mouseOut` event on a
  62607. * series is triggered when the mouse leaves the area around the series'
  62608. * graph or markers. This also implies the tooltip when not shared. When
  62609. * `stickyTracking` is false and `tooltip.shared` is false, the tooltip will
  62610. * be hidden when moving the mouse between series. Defaults to true for line
  62611. * and area type series, but to false for columns, pies etc.
  62612. *
  62613. * **Note:** The boost module will force this option because of technical
  62614. * limitations.
  62615. */
  62616. stickyTracking?: boolean;
  62617. /**
  62618. * (Highcharts) A configuration object for the tooltip rendering of each
  62619. * single series. Properties are inherited from tooltip, but only the
  62620. * following properties can be defined on a series level.
  62621. */
  62622. tooltip?: SeriesTooltipOptionsObject;
  62623. /**
  62624. * (Highcharts, Highstock, Gantt) When a series contains a data array that
  62625. * is longer than this, only one dimensional arrays of numbers, or two
  62626. * dimensional arrays with x and y values are allowed. Also, only the first
  62627. * point is tested, and the rest are assumed to be the same format. This
  62628. * saves expensive data checking and indexing in long series. Set it to `0`
  62629. * disable.
  62630. *
  62631. * Note: In boost mode turbo threshold is forced. Only array of numbers or
  62632. * two dimensional arrays are allowed.
  62633. */
  62634. turboThreshold?: number;
  62635. /**
  62636. * (Highstock) The parameter allows setting line series type and use OHLC
  62637. * indicators. Data in OHLC format is required.
  62638. */
  62639. useOhlcData?: boolean;
  62640. /**
  62641. * (Highcharts) Set the initial visibility of the series.
  62642. */
  62643. visible?: boolean;
  62644. /**
  62645. * (Highmaps) Define the z index of the series.
  62646. */
  62647. zIndex?: number;
  62648. /**
  62649. * (Highcharts, Highstock) An array defining zones within a series. Zones
  62650. * can be applied to the X axis, Y axis or Z axis for bubbles, according to
  62651. * the `zoneAxis` option. The zone definitions have to be in ascending order
  62652. * regarding to the value.
  62653. *
  62654. * In styled mode, the color zones are styled with the
  62655. * `.highcharts-zone-{n}` class, or custom classed from the `className`
  62656. * option (view live demo).
  62657. */
  62658. zones?: Array<SeriesZonesOptionsObject>;
  62659. }
  62660. /**
  62661. * (Highstock) Enable or disable the initial animation when a series is
  62662. * displayed. The animation can also be set as a configuration object. Please
  62663. * note that this option only applies to the initial animation of the series
  62664. * itself. For other animations, see chart.animation and the animation parameter
  62665. * under the API methods. The following properties are supported:
  62666. *
  62667. * - `defer`: The animation delay time in milliseconds.
  62668. *
  62669. * - `duration`: The duration of the animation in milliseconds.
  62670. *
  62671. * - `easing`: Can be a string reference to an easing function set on the `Math`
  62672. * object or a function. See the _Custom easing function_ demo below.
  62673. *
  62674. * Due to poor performance, animation is disabled in old IE browsers for several
  62675. * chart types.
  62676. */
  62677. export interface PlotOhlcAnimationOptions {
  62678. defer?: number;
  62679. }
  62680. /**
  62681. * (Highcharts, Highstock, Highmaps, Gantt) Enable or disable the initial
  62682. * animation when a series is displayed for the `dataLabels`. The animation can
  62683. * also be set as a configuration object. Please note that this option only
  62684. * applies to the initial animation. For other animations, see chart.animation
  62685. * and the animation parameter under the API methods. The following properties
  62686. * are supported:
  62687. *
  62688. * - `defer`: The animation delay time in milliseconds.
  62689. */
  62690. export interface PlotOhlcDataLabelsAnimationOptions {
  62691. /**
  62692. * (Highcharts, Highstock, Highmaps, Gantt) The animation delay time in
  62693. * milliseconds. Set to `0` renders dataLabel immediately. As `undefined`
  62694. * inherits defer time from the series.animation.defer.
  62695. */
  62696. defer?: number;
  62697. }
  62698. /**
  62699. * (Highcharts, Highstock, Highmaps, Gantt) Options for the series data labels,
  62700. * appearing next to each data point.
  62701. *
  62702. * Since v6.2.0, multiple data labels can be applied to each single point by
  62703. * defining them as an array of configs.
  62704. *
  62705. * In styled mode, the data labels can be styled with the
  62706. * `.highcharts-data-label-box` and `.highcharts-data-label` class names (see
  62707. * example).
  62708. */
  62709. export interface PlotOhlcDataLabelsOptions {
  62710. /**
  62711. * (Highcharts, Highstock, Highmaps, Gantt) The alignment of the data label
  62712. * compared to the point. If `right`, the right side of the label should be
  62713. * touching the point. For points with an extent, like columns, the
  62714. * alignments also dictates how to align it inside the box, as given with
  62715. * the inside option. Can be one of `left`, `center` or `right`.
  62716. */
  62717. align?: string;
  62718. /**
  62719. * (Highcharts, Highstock, Highmaps, Gantt) Whether to allow data labels to
  62720. * overlap. To make the labels less sensitive for overlapping, the
  62721. * dataLabels.padding can be set to 0.
  62722. */
  62723. allowOverlap?: boolean;
  62724. /**
  62725. * (Highcharts, Highstock, Highmaps, Gantt) Enable or disable the initial
  62726. * animation when a series is displayed for the `dataLabels`. The animation
  62727. * can also be set as a configuration object. Please note that this option
  62728. * only applies to the initial animation. For other animations, see
  62729. * chart.animation and the animation parameter under the API methods. The
  62730. * following properties are supported:
  62731. *
  62732. * - `defer`: The animation delay time in milliseconds.
  62733. */
  62734. animation?: (boolean|PlotOhlcDataLabelsAnimationOptions|Partial<AnimationOptionsObject>);
  62735. /**
  62736. * (Highcharts, Highstock, Highmaps, Gantt) The background color or gradient
  62737. * for the data label.
  62738. */
  62739. backgroundColor?: (ColorString|GradientColorObject|PatternObject);
  62740. /**
  62741. * (Highcharts, Highstock, Highmaps, Gantt) The border color for the data
  62742. * label. Defaults to `undefined`.
  62743. */
  62744. borderColor?: (ColorString|GradientColorObject|PatternObject);
  62745. /**
  62746. * (Highcharts, Highstock, Highmaps, Gantt) The border radius in pixels for
  62747. * the data label.
  62748. */
  62749. borderRadius?: number;
  62750. /**
  62751. * (Highcharts, Highstock, Highmaps, Gantt) The border width in pixels for
  62752. * the data label.
  62753. */
  62754. borderWidth?: number;
  62755. /**
  62756. * (Highcharts, Highstock, Highmaps, Gantt) A class name for the data label.
  62757. * Particularly in styled mode, this can be used to give each series' or
  62758. * point's data label unique styling. In addition to this option, a default
  62759. * color class name is added so that we can give the labels a contrast text
  62760. * shadow.
  62761. */
  62762. className?: string;
  62763. /**
  62764. * (Highcharts, Highstock, Highmaps, Gantt) The text color for the data
  62765. * labels. Defaults to `undefined`. For certain series types, like column or
  62766. * map, the data labels can be drawn inside the points. In this case the
  62767. * data label will be drawn with maximum contrast by default. Additionally,
  62768. * it will be given a `text-outline` style with the opposite color, to
  62769. * further increase the contrast. This can be overridden by setting the
  62770. * `text-outline` style to `none` in the `dataLabels.style` option.
  62771. */
  62772. color?: (ColorString|GradientColorObject|PatternObject);
  62773. /**
  62774. * (Highcharts, Highstock, Highmaps, Gantt) Whether to hide data labels that
  62775. * are outside the plot area. By default, the data label is moved inside the
  62776. * plot area according to the overflow option.
  62777. */
  62778. crop?: boolean;
  62779. /**
  62780. * (Highcharts, Highstock, Gantt) Whether to defer displaying the data
  62781. * labels until the initial series animation has finished. Setting to
  62782. * `false` renders the data label immediately. If set to `true` inherits the
  62783. * defer time set in plotOptions.series.animation.
  62784. */
  62785. defer?: boolean;
  62786. /**
  62787. * (Highcharts, Highstock, Highmaps, Gantt) Enable or disable the data
  62788. * labels.
  62789. */
  62790. enabled?: boolean;
  62791. /**
  62792. * (Highcharts, Highstock, Highmaps, Gantt) A declarative filter to control
  62793. * of which data labels to display. The declarative filter is designed for
  62794. * use when callback functions are not available, like when the chart
  62795. * options require a pure JSON structure or for use with graphical editors.
  62796. * For programmatic control, use the `formatter` instead, and return
  62797. * `undefined` to disable a single data label.
  62798. */
  62799. filter?: DataLabelsFilterOptionsObject;
  62800. /**
  62801. * (Highcharts, Highstock, Highmaps, Gantt) A format string for the data
  62802. * label. Available variables are the same as for `formatter`.
  62803. */
  62804. format?: string;
  62805. /**
  62806. * (Highcharts, Highstock, Highmaps, Gantt) Callback JavaScript function to
  62807. * format the data label. Note that if a `format` is defined, the format
  62808. * takes precedence and the formatter is ignored.
  62809. */
  62810. formatter?: DataLabelsFormatterCallbackFunction;
  62811. /**
  62812. * (Highcharts, Highstock, Highmaps, Gantt) For points with an extent, like
  62813. * columns or map areas, whether to align the data label inside the box or
  62814. * to the actual value point. Defaults to `false` in most cases, `true` in
  62815. * stacked columns.
  62816. */
  62817. inside?: boolean;
  62818. /**
  62819. * (Highcharts, Highstock, Highmaps, Gantt) Format for points with the value
  62820. * of null. Works analogously to format. `nullFormat` can be applied only to
  62821. * series which support displaying null points.
  62822. */
  62823. nullFormat?: (boolean|string);
  62824. /**
  62825. * (Highcharts, Highstock, Highmaps, Gantt) Callback JavaScript function
  62826. * that defines formatting for points with the value of null. Works
  62827. * analogously to formatter. `nullPointFormatter` can be applied only to
  62828. * series which support displaying null points.
  62829. */
  62830. nullFormatter?: DataLabelsFormatterCallbackFunction;
  62831. /**
  62832. * (Highcharts, Highstock, Highmaps, Gantt) How to handle data labels that
  62833. * flow outside the plot area. The default is `"justify"`, which aligns them
  62834. * inside the plot area. For columns and bars, this means it will be moved
  62835. * inside the bar. To display data labels outside the plot area, set `crop`
  62836. * to `false` and `overflow` to `"allow"`.
  62837. */
  62838. overflow?: DataLabelsOverflowValue;
  62839. /**
  62840. * (Highcharts, Highstock, Highmaps, Gantt) When either the `borderWidth` or
  62841. * the `backgroundColor` is set, this is the padding within the box.
  62842. */
  62843. padding?: number;
  62844. /**
  62845. * (Highcharts, Highstock, Highmaps, Gantt) Aligns data labels relative to
  62846. * points. If `center` alignment is not possible, it defaults to `right`.
  62847. */
  62848. position?: AlignValue;
  62849. /**
  62850. * (Highcharts, Highstock, Highmaps, Gantt) Text rotation in degrees. Note
  62851. * that due to a more complex structure, backgrounds, borders and padding
  62852. * will be lost on a rotated data label.
  62853. */
  62854. rotation?: number;
  62855. /**
  62856. * (Highcharts, Highstock, Highmaps, Gantt) The shadow of the box. Works
  62857. * best with `borderWidth` or `backgroundColor`. Since 2.3 the shadow can be
  62858. * an object configuration containing `color`, `offsetX`, `offsetY`,
  62859. * `opacity` and `width`.
  62860. */
  62861. shadow?: (boolean|ShadowOptionsObject);
  62862. /**
  62863. * (Highcharts, Highstock, Highmaps, Gantt) The name of a symbol to use for
  62864. * the border around the label. Symbols are predefined functions on the
  62865. * Renderer object.
  62866. */
  62867. shape?: string;
  62868. /**
  62869. * (Highcharts, Highstock, Highmaps, Gantt) Styles for the label. The
  62870. * default `color` setting is `"contrast"`, which is a pseudo color that
  62871. * Highcharts picks up and applies the maximum contrast to the underlying
  62872. * point item, for example the bar in a bar chart.
  62873. *
  62874. * The `textOutline` is a pseudo property that applies an outline of the
  62875. * given width with the given color, which by default is the maximum
  62876. * contrast to the text. So a bright text color will result in a black text
  62877. * outline for maximum readability on a mixed background. In some cases,
  62878. * especially with grayscale text, the text outline doesn't work well, in
  62879. * which cases it can be disabled by setting it to `"none"`. When `useHTML`
  62880. * is true, the `textOutline` will not be picked up. In this, case, the same
  62881. * effect can be acheived through the `text-shadow` CSS property.
  62882. *
  62883. * For some series types, where each point has an extent, like for example
  62884. * tree maps, the data label may overflow the point. There are two
  62885. * strategies for handling overflow. By default, the text will wrap to
  62886. * multiple lines. The other strategy is to set `style.textOverflow` to
  62887. * `ellipsis`, which will keep the text on one line plus it will break
  62888. * inside long words.
  62889. */
  62890. style?: CSSObject;
  62891. /**
  62892. * (Highcharts, Highstock, Highmaps, Gantt) Options for a label text which
  62893. * should follow marker's shape. Border and background are disabled for a
  62894. * label that follows a path.
  62895. *
  62896. * **Note:** Only SVG-based renderer supports this option. Setting `useHTML`
  62897. * to true will disable this option.
  62898. */
  62899. textPath?: DataLabelsTextPathOptionsObject;
  62900. /**
  62901. * (Highcharts, Highstock, Highmaps, Gantt) Whether to use HTML to render
  62902. * the labels.
  62903. */
  62904. useHTML?: boolean;
  62905. /**
  62906. * (Highcharts, Highstock, Highmaps, Gantt) The vertical alignment of a data
  62907. * label. Can be one of `top`, `middle` or `bottom`. The default value
  62908. * depends on the data, for instance in a column chart, the label is above
  62909. * positive values and below negative values.
  62910. */
  62911. verticalAlign?: string;
  62912. /**
  62913. * (Highcharts, Highstock, Highmaps, Gantt) The x position offset of the
  62914. * label relative to the point in pixels.
  62915. */
  62916. x?: number;
  62917. /**
  62918. * (Highcharts, Highstock, Highmaps, Gantt) The y position offset of the
  62919. * label relative to the point in pixels.
  62920. */
  62921. y?: number;
  62922. /**
  62923. * (Highcharts, Highstock, Highmaps, Gantt) The Z index of the data labels.
  62924. * The default Z index puts it above the series. Use a Z index of 2 to
  62925. * display it behind the series.
  62926. */
  62927. z?: number;
  62928. }
  62929. /**
  62930. * (Highcharts, Highstock) Options for the series data sorting.
  62931. */
  62932. export interface PlotOhlcDataSortingOptions {
  62933. /**
  62934. * (Highcharts, Highstock) Enable or disable data sorting for the series.
  62935. * Use xAxis.reversed to change the sorting order.
  62936. */
  62937. enabled?: boolean;
  62938. /**
  62939. * (Highcharts, Highstock) Whether to allow matching points by name in an
  62940. * update. If this option is disabled, points will be matched by order.
  62941. */
  62942. matchByName?: boolean;
  62943. /**
  62944. * (Highcharts, Highstock) Determines what data value should be used to sort
  62945. * by.
  62946. */
  62947. sortKey?: string;
  62948. }
  62949. /**
  62950. * (Highstock) Style options for the guide box. The guide box has one state by
  62951. * default, the `default` state.
  62952. */
  62953. export interface PlotOhlcDragDropGuideBoxOptions {
  62954. /**
  62955. * (Highstock) Style options for the guide box default state.
  62956. */
  62957. default?: DragDropGuideBoxOptionsObject;
  62958. }
  62959. /**
  62960. * (Highstock) An OHLC chart is a style of financial chart used to describe
  62961. * price movements over time. It displays open, high, low and close values per
  62962. * data point.
  62963. *
  62964. * In TypeScript the type option must always be set.
  62965. *
  62966. * Configuration options for the series are given in three levels:
  62967. *
  62968. * 1. Options for all series in a chart are defined in the plotOptions.series
  62969. * object.
  62970. *
  62971. * 2. Options for all `ohlc` series are defined in plotOptions.ohlc.
  62972. *
  62973. * 3. Options for one single series are given in the series instance array. (see
  62974. * online documentation for example)
  62975. */
  62976. export interface PlotOhlcOptions {
  62977. /**
  62978. * (Highstock) Accessibility options for a series.
  62979. */
  62980. accessibility?: SeriesAccessibilityOptionsObject;
  62981. /**
  62982. * (Highmaps) Whether all areas of the map defined in `mapData` should be
  62983. * rendered. If `true`, areas which don't correspond to a data point, are
  62984. * rendered as `null` points. If `false`, those areas are skipped.
  62985. */
  62986. allAreas?: boolean;
  62987. /**
  62988. * (Highstock) Allow this series' points to be selected by clicking on the
  62989. * graphic (columns, point markers, pie slices, map areas etc).
  62990. *
  62991. * The selected points can be handled by point select and unselect events,
  62992. * or collectively by the getSelectedPoints function.
  62993. *
  62994. * And alternative way of selecting points is through dragging.
  62995. */
  62996. allowPointSelect?: boolean;
  62997. /**
  62998. * (Highstock) Enable or disable the initial animation when a series is
  62999. * displayed. The animation can also be set as a configuration object.
  63000. * Please note that this option only applies to the initial animation of the
  63001. * series itself. For other animations, see chart.animation and the
  63002. * animation parameter under the API methods. The following properties are
  63003. * supported:
  63004. *
  63005. * - `defer`: The animation delay time in milliseconds.
  63006. *
  63007. * - `duration`: The duration of the animation in milliseconds.
  63008. *
  63009. * - `easing`: Can be a string reference to an easing function set on the
  63010. * `Math` object or a function. See the _Custom easing function_ demo below.
  63011. *
  63012. * Due to poor performance, animation is disabled in old IE browsers for
  63013. * several chart types.
  63014. */
  63015. animation?: (boolean|PlotOhlcAnimationOptions|Partial<AnimationOptionsObject>);
  63016. /**
  63017. * (Highstock) For some series, there is a limit that shuts down initial
  63018. * animation by default when the total number of points in the chart is too
  63019. * high. For example, for a column chart and its derivatives, animation does
  63020. * not run if there is more than 250 points totally. To disable this cap,
  63021. * set `animationLimit` to `Infinity`.
  63022. */
  63023. animationLimit?: number;
  63024. /**
  63025. * (Highstock) Sets the color blending in the boost module.
  63026. */
  63027. boostBlending?: OptionsBoostBlendingValue;
  63028. /**
  63029. * (Highstock) Set the point threshold for when a series should enter boost
  63030. * mode.
  63031. *
  63032. * Setting it to e.g. 2000 will cause the series to enter boost mode when
  63033. * there are 2000 or more points in the series.
  63034. *
  63035. * To disable boosting on the series, set the `boostThreshold` to 0. Setting
  63036. * it to 1 will force boosting.
  63037. *
  63038. * Note that the cropThreshold also affects this setting. When zooming in on
  63039. * a series that has fewer points than the `cropThreshold`, all points are
  63040. * rendered although outside the visible plot area, and the `boostThreshold`
  63041. * won't take effect.
  63042. */
  63043. boostThreshold?: number;
  63044. /**
  63045. * (Highcharts, Highstock, Gantt) When `true`, the columns will center in
  63046. * the category, ignoring null or missing points. When `false`, space will
  63047. * be reserved for null or missing points.
  63048. */
  63049. centerInCategory?: boolean;
  63050. /**
  63051. * (Highstock) An additional class name to apply to the series' graphical
  63052. * elements. This option does not replace default class names of the
  63053. * graphical element.
  63054. */
  63055. className?: string;
  63056. /**
  63057. * (Highstock) Disable this option to allow series rendering in the whole
  63058. * plotting area.
  63059. *
  63060. * **Note:** Clipping should be always enabled when chart.zoomType is set
  63061. */
  63062. clip?: boolean;
  63063. /**
  63064. * (Highstock) The main color of the series. In line type series it applies
  63065. * to the line and the point markers unless otherwise specified. In bar type
  63066. * series it applies to the bars unless a color is specified per point. The
  63067. * default value is pulled from the `options.colors` array.
  63068. *
  63069. * In styled mode, the color can be defined by the colorIndex option. Also,
  63070. * the series color can be set with the `.highcharts-series`,
  63071. * `.highcharts-color-{n}`, `.highcharts-{type}-series` or
  63072. * `.highcharts-series-{n}` class, or individual classes given by the
  63073. * `className` option.
  63074. */
  63075. color?: (ColorString|GradientColorObject|PatternObject);
  63076. /**
  63077. * (Highcharts, Highstock, Highmaps) When using dual or multiple color axes,
  63078. * this number defines which colorAxis the particular series is connected
  63079. * to. It refers to either the axis id or the index of the axis in the
  63080. * colorAxis array, with 0 being the first. Set this option to false to
  63081. * prevent a series from connecting to the default color axis.
  63082. *
  63083. * Since v7.2.0 the option can also be an axis id or an axis index instead
  63084. * of a boolean flag.
  63085. */
  63086. colorAxis?: (boolean|number|string);
  63087. /**
  63088. * (Highcharts, Highstock, Gantt) When using automatic point colors pulled
  63089. * from the global colors or series-specific plotOptions.column.colors
  63090. * collections, this option determines whether the chart should receive one
  63091. * color per series or one color per point.
  63092. *
  63093. * In styled mode, the `colors` or `series.colors` arrays are not supported,
  63094. * and instead this option gives the points individual color class names on
  63095. * the form `highcharts-color-{n}`.
  63096. */
  63097. colorByPoint?: boolean;
  63098. /**
  63099. * (Highstock) Styled mode only. A specific color index to use for the
  63100. * series, so its graphic representations are given the class name
  63101. * `highcharts-color-{n}`.
  63102. */
  63103. colorIndex?: number;
  63104. /**
  63105. * (Highcharts, Highstock, Highmaps) Determines what data value should be
  63106. * used to calculate point color if `colorAxis` is used. Requires to set
  63107. * `min` and `max` if some custom point property is used or if approximation
  63108. * for data grouping is set to `'sum'`.
  63109. */
  63110. colorKey?: string;
  63111. /**
  63112. * (Highcharts, Highstock, Gantt) A series specific or series type specific
  63113. * color set to apply instead of the global colors when colorByPoint is
  63114. * true.
  63115. */
  63116. colors?: Array<(ColorString|GradientColorObject|PatternObject)>;
  63117. /**
  63118. * (Highstock) Compare the values of the series against the first non-null,
  63119. * non- zero value in the visible range. The y axis will show percentage or
  63120. * absolute change depending on whether `compare` is set to `"percent"` or
  63121. * `"value"`. When this is applied to multiple series, it allows comparing
  63122. * the development of the series against each other. Adds a `change` field
  63123. * to every point object.
  63124. */
  63125. compare?: string;
  63126. /**
  63127. * (Highstock) When compare is `percent`, this option dictates whether to
  63128. * use 0 or 100 as the base of comparison.
  63129. */
  63130. compareBase?: (0|100);
  63131. /**
  63132. * (Highstock) Defines if comparison should start from the first point
  63133. * within the visible range or should start from the first point **before**
  63134. * the range.
  63135. *
  63136. * In other words, this flag determines if first point within the visible
  63137. * range will have 0% (`compareStart=true`) or should have been already
  63138. * calculated according to the previous point (`compareStart=false`).
  63139. */
  63140. compareStart?: boolean;
  63141. /**
  63142. * (Gantt) Override Pathfinder connector options for a series. Requires
  63143. * Highcharts Gantt to be loaded.
  63144. */
  63145. connectors?: SeriesConnectorsOptionsObject;
  63146. /**
  63147. * (Highcharts, Highstock, Gantt) When the series contains less points than
  63148. * the crop threshold, all points are drawn, event if the points fall
  63149. * outside the visible plot area at the current zoom. The advantage of
  63150. * drawing all points (including markers and columns), is that animation is
  63151. * performed on updates. On the other hand, when the series contains more
  63152. * points than the crop threshold, the series data is cropped to only
  63153. * contain points that fall within the plot area. The advantage of cropping
  63154. * away invisible points is to increase performance on large series.
  63155. */
  63156. cropThreshold?: number;
  63157. /**
  63158. * (Highstock) You can set the cursor to "pointer" if you have click events
  63159. * attached to the series, to signal to the user that the points and lines
  63160. * can be clicked.
  63161. *
  63162. * In styled mode, the series cursor can be set with the same classes as
  63163. * listed under series.color.
  63164. */
  63165. cursor?: (string|CursorValue);
  63166. /**
  63167. * (Highstock) A reserved subspace to store options and values for
  63168. * customized functionality. Here you can add additional data for your own
  63169. * event callbacks and formatter callbacks.
  63170. */
  63171. custom?: Dictionary<any>;
  63172. /**
  63173. * (Highstock) Name of the dash style to use for the graph, or for some
  63174. * series types the outline of each shape.
  63175. *
  63176. * In styled mode, the stroke dash-array can be set with the same classes as
  63177. * listed under series.color.
  63178. */
  63179. dashStyle?: DashStyleValue;
  63180. /**
  63181. * (Highstock) Data grouping is the concept of sampling the data values into
  63182. * larger blocks in order to ease readability and increase performance of
  63183. * the JavaScript charts. Highstock by default applies data grouping when
  63184. * the points become closer than a certain pixel value, determined by the
  63185. * `groupPixelWidth` option.
  63186. *
  63187. * If data grouping is applied, the grouping information of grouped points
  63188. * can be read from the Point.dataGroup. If point options other than the
  63189. * data itself are set, for example `name` or `color` or custom properties,
  63190. * the grouping logic doesn't know how to group it. In this case the options
  63191. * of the first point instance are copied over to the group point. This can
  63192. * be altered through a custom `approximation` callback function.
  63193. */
  63194. dataGrouping?: DataGroupingOptionsObject;
  63195. /**
  63196. * (Highcharts, Highstock, Highmaps, Gantt) Options for the series data
  63197. * labels, appearing next to each data point.
  63198. *
  63199. * Since v6.2.0, multiple data labels can be applied to each single point by
  63200. * defining them as an array of configs.
  63201. *
  63202. * In styled mode, the data labels can be styled with the
  63203. * `.highcharts-data-label-box` and `.highcharts-data-label` class names
  63204. * (see example).
  63205. */
  63206. dataLabels?: (PlotOhlcDataLabelsOptions|Array<PlotOhlcDataLabelsOptions>);
  63207. /**
  63208. * (Highcharts, Highstock) Options for the series data sorting.
  63209. */
  63210. dataSorting?: (DataSortingOptionsObject|PlotOhlcDataSortingOptions);
  63211. /**
  63212. * (Highcharts) Depth of the columns in a 3D column chart.
  63213. */
  63214. depth?: number;
  63215. /**
  63216. * (Highstock) A description of the series to add to the screen reader
  63217. * information about the series.
  63218. */
  63219. description?: string;
  63220. /**
  63221. * (Highstock) The draggable-points module allows points to be moved around
  63222. * or modified in the chart. In addition to the options mentioned under the
  63223. * `dragDrop` API structure, the module fires three events, point.dragStart,
  63224. * point.drag and point.drop.
  63225. */
  63226. dragDrop?: SeriesDragDropOptionsObject;
  63227. /**
  63228. * (Highcharts) 3D columns only. The color of the edges. Similar to
  63229. * `borderColor`, except it defaults to the same color as the column.
  63230. */
  63231. edgeColor?: ColorString;
  63232. /**
  63233. * (Highcharts) 3D columns only. The width of the colored edges.
  63234. */
  63235. edgeWidth?: number;
  63236. /**
  63237. * (Highstock) Enable or disable the mouse tracking for a specific series.
  63238. * This includes point tooltips and click events on graphs and points. For
  63239. * large datasets it improves performance.
  63240. */
  63241. enableMouseTracking?: boolean;
  63242. /**
  63243. * (Highstock) General event handlers for the series items. These event
  63244. * hooks can also be attached to the series at run time using the
  63245. * `Highcharts.addEvent` function.
  63246. */
  63247. events?: SeriesEventsOptionsObject;
  63248. /**
  63249. * (Highstock) Determines whether the series should look for the nearest
  63250. * point in both dimensions or just the x-dimension when hovering the
  63251. * series. Defaults to `'xy'` for scatter series and `'x'` for most other
  63252. * series. If the data has duplicate x-values, it is recommended to set this
  63253. * to `'xy'` to allow hovering over all points.
  63254. *
  63255. * Applies only to series types using nearest neighbor search (not direct
  63256. * hover) for tooltip.
  63257. */
  63258. findNearestPointBy?: OptionsFindNearestPointByValue;
  63259. /**
  63260. * (Highcharts, Highstock, Gantt) Whether to use the Y extremes of the total
  63261. * chart width or only the zoomed area when zooming in on parts of the X
  63262. * axis. By default, the Y axis adjusts to the min and max of the visible
  63263. * data. Cartesian series only.
  63264. */
  63265. getExtremesFromAll?: boolean;
  63266. /**
  63267. * (Highcharts, Highstock, Gantt) Whether to group non-stacked columns or to
  63268. * let them render independent of each other. Non-grouped columns will be
  63269. * laid out individually and overlap each other.
  63270. */
  63271. grouping?: boolean;
  63272. /**
  63273. * (Highcharts, Highstock, Gantt) Padding between each value groups, in x
  63274. * axis units.
  63275. */
  63276. groupPadding?: number;
  63277. /**
  63278. * (Highcharts) The spacing between columns on the Z Axis in a 3D chart.
  63279. */
  63280. groupZPadding?: number;
  63281. /**
  63282. * (Highstock) When set to `false` will prevent the series data from being
  63283. * included in any form of data export.
  63284. *
  63285. * Since version 6.0.0 until 7.1.0 the option was existing undocumented as
  63286. * `includeInCSVExport`.
  63287. */
  63288. includeInDataExport?: boolean;
  63289. /**
  63290. * (Highmaps) What property to join the `mapData` to the value data. For
  63291. * example, if joinBy is "code", the mapData items with a specific code is
  63292. * merged into the data with the same code. For maps loaded from GeoJSON,
  63293. * the keys may be held in each point's `properties` object.
  63294. *
  63295. * The joinBy option can also be an array of two values, where the first
  63296. * points to a key in the `mapData`, and the second points to another key in
  63297. * the `data`.
  63298. *
  63299. * When joinBy is `null`, the map items are joined by their position in the
  63300. * array, which performs much better in maps with many data points. This is
  63301. * the recommended option if you are printing more than a thousand data
  63302. * points and have a backend that can preprocess the data into a parallel
  63303. * array of the mapData.
  63304. */
  63305. joinBy?: (string|Array<string>);
  63306. /**
  63307. * (Highstock) An array specifying which option maps to which key in the
  63308. * data point array. This makes it convenient to work with unstructured data
  63309. * arrays from different sources.
  63310. */
  63311. keys?: Array<string>;
  63312. /**
  63313. * (Highcharts, Highstock, Gantt) Series labels are placed as close to the
  63314. * series as possible in a natural way, seeking to avoid other series. The
  63315. * goal of this feature is to make the chart more easily readable, like if a
  63316. * human designer placed the labels in the optimal position.
  63317. *
  63318. * The series labels currently work with series types having a `graph` or an
  63319. * `area`.
  63320. */
  63321. label?: SeriesLabelOptionsObject;
  63322. /**
  63323. * (Highstock) The line marks the last price from all points.
  63324. */
  63325. lastPrice?: SeriesLastPriceOptionsObject;
  63326. /**
  63327. * (Highstock) The line marks the last price from visible range of points.
  63328. */
  63329. lastVisiblePrice?: SeriesLastVisiblePriceOptionsObject;
  63330. /**
  63331. * (Highstock) The pixel width of the line/border. Defaults to `1`.
  63332. */
  63333. lineWidth?: number;
  63334. /**
  63335. * (Highcharts, Highstock, Gantt) The id of another series to link to.
  63336. * Additionally, the value can be ":previous" to link to the previous
  63337. * series. When two series are linked, only the first one appears in the
  63338. * legend. Toggling the visibility of this also toggles the linked series.
  63339. *
  63340. * If master series uses data sorting and linked series does not have its
  63341. * own sorting definition, the linked series will be sorted in the same
  63342. * order as the master one.
  63343. */
  63344. linkedTo?: string;
  63345. /**
  63346. * (Highcharts, Highstock, Gantt) The maximum allowed pixel width for a
  63347. * column, translated to the height of a bar in a bar chart. This prevents
  63348. * the columns from becoming too wide when there is a small number of points
  63349. * in the chart.
  63350. */
  63351. maxPointWidth?: number;
  63352. /**
  63353. * (Highcharts, Highstock, Gantt) The minimal height for a column or width
  63354. * for a bar. By default, 0 values are not shown. To visualize a 0 (or close
  63355. * to zero) point, set the minimal point length to a pixel value like 3\. In
  63356. * stacked column charts, minPointLength might not be respected for tightly
  63357. * packed values.
  63358. */
  63359. minPointLength?: number;
  63360. /**
  63361. * (Highstock) Options for the corresponding navigator series if
  63362. * `showInNavigator` is `true` for this series. Available options are the
  63363. * same as any series, documented at plotOptions and series.
  63364. *
  63365. * These options are merged with options in navigator.series, and will take
  63366. * precedence if the same option is defined both places.
  63367. */
  63368. navigatorOptions?: PlotSeriesOptions;
  63369. /**
  63370. * (Highstock) The color for the parts of the graph or points that are below
  63371. * the threshold. Note that `zones` takes precedence over the negative
  63372. * color. Using `negativeColor` is equivalent to applying a zone with value
  63373. * of 0.
  63374. */
  63375. negativeColor?: (ColorString|GradientColorObject|PatternObject);
  63376. /**
  63377. * (Highstock) Opacity of a series parts: line, fill (e.g. area) and
  63378. * dataLabels.
  63379. */
  63380. opacity?: number;
  63381. /**
  63382. * (Highstock) Properties for each single point.
  63383. */
  63384. point?: PlotSeriesPointOptions;
  63385. /**
  63386. * (Highstock) Same as accessibility.pointDescriptionFormatter, but for an
  63387. * individual series. Overrides the chart wide configuration.
  63388. */
  63389. pointDescriptionFormatter?: Function;
  63390. /**
  63391. * (Highcharts, Highstock, Gantt) If no x values are given for the points in
  63392. * a series, `pointInterval` defines the interval of the x values. For
  63393. * example, if a series contains one value every decade starting from year
  63394. * 0, set `pointInterval` to `10`. In true `datetime` axes, the
  63395. * `pointInterval` is set in milliseconds.
  63396. *
  63397. * It can be also be combined with `pointIntervalUnit` to draw irregular
  63398. * time intervals.
  63399. *
  63400. * Please note that this options applies to the _series data_, not the
  63401. * interval of the axis ticks, which is independent.
  63402. */
  63403. pointInterval?: number;
  63404. /**
  63405. * (Highcharts, Highstock, Gantt) On datetime series, this allows for
  63406. * setting the pointInterval to irregular time units, `day`, `month` and
  63407. * `year`. A day is usually the same as 24 hours, but `pointIntervalUnit`
  63408. * also takes the DST crossover into consideration when dealing with local
  63409. * time. Combine this option with `pointInterval` to draw weeks, quarters, 6
  63410. * months, 10 years etc.
  63411. *
  63412. * Please note that this options applies to the _series data_, not the
  63413. * interval of the axis ticks, which is independent.
  63414. */
  63415. pointIntervalUnit?: OptionsPointIntervalUnitValue;
  63416. /**
  63417. * (Highcharts, Highstock, Gantt) Padding between each column or bar, in x
  63418. * axis units.
  63419. */
  63420. pointPadding?: number;
  63421. /**
  63422. * (Highcharts, Highstock, Gantt) Possible values: `"on"`, `"between"`,
  63423. * `number`.
  63424. *
  63425. * In a column chart, when pointPlacement is `"on"`, the point will not
  63426. * create any padding of the X axis. In a polar column chart this means that
  63427. * the first column points directly north. If the pointPlacement is
  63428. * `"between"`, the columns will be laid out between ticks. This is useful
  63429. * for example for visualising an amount between two points in time or in a
  63430. * certain sector of a polar chart.
  63431. *
  63432. * Since Highcharts 3.0.2, the point placement can also be numeric, where 0
  63433. * is on the axis value, -0.5 is between this value and the previous, and
  63434. * 0.5 is between this value and the next. Unlike the textual options,
  63435. * numeric point placement options won't affect axis padding.
  63436. *
  63437. * Note that pointPlacement needs a pointRange to work. For column series
  63438. * this is computed, but for line-type series it needs to be set.
  63439. *
  63440. * For the `xrange` series type and gantt charts, if the Y axis is a
  63441. * category axis, the `pointPlacement` applies to the Y axis rather than the
  63442. * (typically datetime) X axis.
  63443. *
  63444. * Defaults to `undefined` in cartesian charts, `"between"` in polar charts.
  63445. */
  63446. pointPlacement?: (number|string);
  63447. /**
  63448. * (Highcharts, Highstock, Gantt) The X axis range that each point is valid
  63449. * for. This determines the width of the column. On a categorized axis, the
  63450. * range will be 1 by default (one category unit). On linear and datetime
  63451. * axes, the range will be computed as the distance between the two closest
  63452. * data points.
  63453. *
  63454. * The default `null` means it is computed automatically, but this option
  63455. * can be used to override the automatic value.
  63456. *
  63457. * This option is set by default to 1 if data sorting is enabled.
  63458. */
  63459. pointRange?: (number|null);
  63460. /**
  63461. * (Highcharts, Highstock, Gantt) If no x values are given for the points in
  63462. * a series, pointStart defines on what value to start. For example, if a
  63463. * series contains one yearly value starting from 1945, set pointStart to
  63464. * 1945.
  63465. */
  63466. pointStart?: number;
  63467. /**
  63468. * (Highstock) Determines which one of `open`, `high`, `low`, `close` values
  63469. * should be represented as `point.y`, which is later used to set dataLabel
  63470. * position and compare.
  63471. */
  63472. pointValKey?: OptionsPointValKeyValue;
  63473. /**
  63474. * (Highcharts, Highstock, Gantt) A pixel value specifying a fixed width for
  63475. * each column or bar point. When set to `undefined`, the width is
  63476. * calculated from the `pointPadding` and `groupPadding`. The width effects
  63477. * the dimension that is not based on the point value. For column series it
  63478. * is the hoizontal length and for bar series it is the vertical length.
  63479. */
  63480. pointWidth?: number;
  63481. /**
  63482. * (Highstock) Whether to select the series initially. If `showCheckbox` is
  63483. * true, the checkbox next to the series name in the legend will be checked
  63484. * for a selected series.
  63485. */
  63486. selected?: boolean;
  63487. /**
  63488. * (Highstock) Whether to apply a drop shadow to the graph line. Since 2.3
  63489. * the shadow can be an object configuration containing `color`, `offsetX`,
  63490. * `offsetY`, `opacity` and `width`.
  63491. */
  63492. shadow?: (boolean|ShadowOptionsObject);
  63493. /**
  63494. * (Highstock) If true, a checkbox is displayed next to the legend item to
  63495. * allow selecting the series. The state of the checkbox is determined by
  63496. * the `selected` option.
  63497. */
  63498. showCheckbox?: boolean;
  63499. /**
  63500. * (Highstock) Whether to display this particular series or series type in
  63501. * the legend. Standalone series are shown in legend by default, and linked
  63502. * series are not. Since v7.2.0 it is possible to show series that use
  63503. * colorAxis by setting this option to `true`.
  63504. */
  63505. showInLegend?: boolean;
  63506. /**
  63507. * (Highstock) Whether or not to show the series in the navigator. Takes
  63508. * precedence over navigator.baseSeries if defined.
  63509. */
  63510. showInNavigator?: boolean;
  63511. /**
  63512. * (Highstock) If set to `true`, the accessibility module will skip past the
  63513. * points in this series for keyboard navigation.
  63514. */
  63515. skipKeyboardNavigation?: boolean;
  63516. /**
  63517. * (Highcharts, Highstock) When this is true, the series will not cause the
  63518. * Y axis to cross the zero plane (or threshold option) unless the data
  63519. * actually crosses the plane.
  63520. *
  63521. * For example, if `softThreshold` is `false`, a series of 0, 1, 2, 3 will
  63522. * make the Y axis show negative values according to the `minPadding`
  63523. * option. If `softThreshold` is `true`, the Y axis starts at 0.
  63524. */
  63525. softThreshold?: boolean;
  63526. states?: SeriesStatesOptionsObject;
  63527. /**
  63528. * (Highstock) Sticky tracking of mouse events. When true, the `mouseOut`
  63529. * event on a series isn't triggered until the mouse moves over another
  63530. * series, or out of the plot area. When false, the `mouseOut` event on a
  63531. * series is triggered when the mouse leaves the area around the series'
  63532. * graph or markers. This also implies the tooltip when not shared. When
  63533. * `stickyTracking` is false and `tooltip.shared` is false, the tooltip will
  63534. * be hidden when moving the mouse between series. Defaults to true for line
  63535. * and area type series, but to false for columns, pies etc.
  63536. *
  63537. * **Note:** The boost module will force this option because of technical
  63538. * limitations.
  63539. */
  63540. stickyTracking?: boolean;
  63541. /**
  63542. * (Highcharts) The Y axis value to serve as the base for the columns, for
  63543. * distinguishing between values above and below a threshold. If `null`, the
  63544. * columns extend from the padding Y axis minimum.
  63545. */
  63546. threshold?: (number|null);
  63547. /**
  63548. * (Highstock) A configuration object for the tooltip rendering of each
  63549. * single series. Properties are inherited from tooltip, but only the
  63550. * following properties can be defined on a series level.
  63551. */
  63552. tooltip?: SeriesTooltipOptionsObject;
  63553. /**
  63554. * (Highcharts, Highstock, Gantt) When a series contains a data array that
  63555. * is longer than this, only one dimensional arrays of numbers, or two
  63556. * dimensional arrays with x and y values are allowed. Also, only the first
  63557. * point is tested, and the rest are assumed to be the same format. This
  63558. * saves expensive data checking and indexing in long series. Set it to `0`
  63559. * disable.
  63560. *
  63561. * Note: In boost mode turbo threshold is forced. Only array of numbers or
  63562. * two dimensional arrays are allowed.
  63563. */
  63564. turboThreshold?: number;
  63565. /**
  63566. * (Highstock) Line color for up points.
  63567. */
  63568. upColor?: (ColorString|GradientColorObject|PatternObject);
  63569. /**
  63570. * (Highstock) Set the initial visibility of the series.
  63571. */
  63572. visible?: boolean;
  63573. /**
  63574. * (Highmaps) Define the z index of the series.
  63575. */
  63576. zIndex?: number;
  63577. /**
  63578. * (Highcharts, Highstock) Defines the Axis on which the zones are applied.
  63579. */
  63580. zoneAxis?: string;
  63581. /**
  63582. * (Highcharts, Highstock) An array defining zones within a series. Zones
  63583. * can be applied to the X axis, Y axis or Z axis for bubbles, according to
  63584. * the `zoneAxis` option. The zone definitions have to be in ascending order
  63585. * regarding to the value.
  63586. *
  63587. * In styled mode, the color zones are styled with the
  63588. * `.highcharts-zone-{n}` class, or custom classed from the `className`
  63589. * option (view live demo).
  63590. */
  63591. zones?: Array<SeriesZonesOptionsObject>;
  63592. }
  63593. /**
  63594. * (Highcharts, Highstock, Highmaps, Gantt) The plotOptions is a wrapper object
  63595. * for config objects for each series type. The config objects for each series
  63596. * can also be overridden for each series item as given in the series array.
  63597. *
  63598. * Configuration options for the series are given in three levels. Options for
  63599. * all series in a chart are given in the plotOptions.series object. Then
  63600. * options for all series of a specific type are given in the plotOptions of
  63601. * that type, for example `plotOptions.line`. Next, options for one single
  63602. * series are given in the series array.
  63603. */
  63604. export interface PlotOptions {
  63605. /**
  63606. * (Highstock) Acceleration bands (ABANDS). This series requires the
  63607. * `linkedTo` option to be set and should be loaded after the
  63608. * `stock/indicators/indicators.js`.
  63609. *
  63610. * In TypeScript the type option must always be set.
  63611. *
  63612. * Configuration options for the series are given in three levels:
  63613. *
  63614. * 1. Options for all series in a chart are defined in the
  63615. * plotOptions.series object.
  63616. *
  63617. * 2. Options for all `abands` series are defined in plotOptions.abands.
  63618. *
  63619. * 3. Options for one single series are given in the series instance array.
  63620. * (see online documentation for example)
  63621. */
  63622. abands?: PlotAbandsOptions;
  63623. /**
  63624. * (Highstock) Accumulation Distribution (AD). This series requires
  63625. * `linkedTo` option to be set.
  63626. *
  63627. * In TypeScript the type option must always be set.
  63628. *
  63629. * Configuration options for the series are given in three levels:
  63630. *
  63631. * 1. Options for all series in a chart are defined in the
  63632. * plotOptions.series object.
  63633. *
  63634. * 2. Options for all `ad` series are defined in plotOptions.ad.
  63635. *
  63636. * 3. Options for one single series are given in the series instance array.
  63637. * (see online documentation for example)
  63638. */
  63639. ad?: PlotAdOptions;
  63640. /**
  63641. * (Highstock) Awesome Oscillator. This series requires the `linkedTo`
  63642. * option to be set and should be loaded after the
  63643. * `stock/indicators/indicators.js`
  63644. *
  63645. * In TypeScript the type option must always be set.
  63646. *
  63647. * Configuration options for the series are given in three levels:
  63648. *
  63649. * 1. Options for all series in a chart are defined in the
  63650. * plotOptions.series object.
  63651. *
  63652. * 2. Options for all `ao` series are defined in plotOptions.ao.
  63653. *
  63654. * 3. Options for one single series are given in the series instance array.
  63655. * (see online documentation for example)
  63656. */
  63657. ao?: PlotAoOptions;
  63658. /**
  63659. * (Highstock) Absolute Price Oscillator. This series requires the
  63660. * `linkedTo` option to be set and should be loaded after the
  63661. * `stock/indicators/indicators.js` and `stock/indicators/ema.js`.
  63662. *
  63663. * In TypeScript the type option must always be set.
  63664. *
  63665. * Configuration options for the series are given in three levels:
  63666. *
  63667. * 1. Options for all series in a chart are defined in the
  63668. * plotOptions.series object.
  63669. *
  63670. * 2. Options for all `apo` series are defined in plotOptions.apo.
  63671. *
  63672. * 3. Options for one single series are given in the series instance array.
  63673. * (see online documentation for example)
  63674. */
  63675. apo?: PlotApoOptions;
  63676. /**
  63677. * (Highcharts, Highstock) The area series type.
  63678. *
  63679. * In TypeScript the type option must always be set.
  63680. *
  63681. * Configuration options for the series are given in three levels:
  63682. *
  63683. * 1. Options for all series in a chart are defined in the
  63684. * plotOptions.series object.
  63685. *
  63686. * 2. Options for all `area` series are defined in plotOptions.area.
  63687. *
  63688. * 3. Options for one single series are given in the series instance array.
  63689. * (see online documentation for example)
  63690. */
  63691. area?: PlotAreaOptions;
  63692. /**
  63693. * (Highcharts, Highstock) The area range series is a carteseian series with
  63694. * higher and lower values for each point along an X axis, where the area
  63695. * between the values is shaded.
  63696. *
  63697. * In TypeScript the type option must always be set.
  63698. *
  63699. * Configuration options for the series are given in three levels:
  63700. *
  63701. * 1. Options for all series in a chart are defined in the
  63702. * plotOptions.series object.
  63703. *
  63704. * 2. Options for all `arearange` series are defined in
  63705. * plotOptions.arearange.
  63706. *
  63707. * 3. Options for one single series are given in the series instance array.
  63708. * (see online documentation for example)
  63709. */
  63710. arearange?: PlotArearangeOptions;
  63711. /**
  63712. * (Highcharts, Highstock) The area spline series is an area series where
  63713. * the graph between the points is smoothed into a spline.
  63714. *
  63715. * In TypeScript the type option must always be set.
  63716. *
  63717. * Configuration options for the series are given in three levels:
  63718. *
  63719. * 1. Options for all series in a chart are defined in the
  63720. * plotOptions.series object.
  63721. *
  63722. * 2. Options for all `areaspline` series are defined in
  63723. * plotOptions.areaspline.
  63724. *
  63725. * 3. Options for one single series are given in the series instance array.
  63726. * (see online documentation for example)
  63727. */
  63728. areaspline?: PlotAreasplineOptions;
  63729. /**
  63730. * (Highcharts, Highstock) The area spline range is a cartesian series type
  63731. * with higher and lower Y values along an X axis. The area inside the range
  63732. * is colored, and the graph outlining the area is a smoothed spline.
  63733. *
  63734. * In TypeScript the type option must always be set.
  63735. *
  63736. * Configuration options for the series are given in three levels:
  63737. *
  63738. * 1. Options for all series in a chart are defined in the
  63739. * plotOptions.series object.
  63740. *
  63741. * 2. Options for all `areasplinerange` series are defined in
  63742. * plotOptions.areasplinerange.
  63743. *
  63744. * 3. Options for one single series are given in the series instance array.
  63745. * (see online documentation for example)
  63746. */
  63747. areasplinerange?: PlotAreasplinerangeOptions;
  63748. /**
  63749. * (Highstock) Aroon. This series requires the `linkedTo` option to be set
  63750. * and should be loaded after the `stock/indicators/indicators.js`.
  63751. *
  63752. * In TypeScript the type option must always be set.
  63753. *
  63754. * Configuration options for the series are given in three levels:
  63755. *
  63756. * 1. Options for all series in a chart are defined in the
  63757. * plotOptions.series object.
  63758. *
  63759. * 2. Options for all `aroon` series are defined in plotOptions.aroon.
  63760. *
  63761. * 3. Options for one single series are given in the series instance array.
  63762. * (see online documentation for example)
  63763. */
  63764. aroon?: PlotAroonOptions;
  63765. /**
  63766. * (Highstock) Aroon Oscillator. This series requires the `linkedTo` option
  63767. * to be set and should be loaded after the `stock/indicators/indicators.js`
  63768. * and `stock/indicators/aroon.js`.
  63769. *
  63770. * In TypeScript the type option must always be set.
  63771. *
  63772. * Configuration options for the series are given in three levels:
  63773. *
  63774. * 1. Options for all series in a chart are defined in the
  63775. * plotOptions.series object.
  63776. *
  63777. * 2. Options for all `aroonoscillator` series are defined in
  63778. * plotOptions.aroonoscillator.
  63779. *
  63780. * 3. Options for one single series are given in the series instance array.
  63781. * (see online documentation for example)
  63782. */
  63783. aroonoscillator?: PlotAroonoscillatorOptions;
  63784. /**
  63785. * (Highstock) Average true range indicator (ATR). This series requires
  63786. * `linkedTo` option to be set.
  63787. *
  63788. * In TypeScript the type option must always be set.
  63789. *
  63790. * Configuration options for the series are given in three levels:
  63791. *
  63792. * 1. Options for all series in a chart are defined in the
  63793. * plotOptions.series object.
  63794. *
  63795. * 2. Options for all `atr` series are defined in plotOptions.atr.
  63796. *
  63797. * 3. Options for one single series are given in the series instance array.
  63798. * (see online documentation for example)
  63799. */
  63800. atr?: PlotAtrOptions;
  63801. /**
  63802. * (Highcharts) A bar series is a special type of column series where the
  63803. * columns are horizontal.
  63804. *
  63805. * In TypeScript the type option must always be set.
  63806. *
  63807. * Configuration options for the series are given in three levels:
  63808. *
  63809. * 1. Options for all series in a chart are defined in the
  63810. * plotOptions.series object.
  63811. *
  63812. * 2. Options for all `bar` series are defined in plotOptions.bar.
  63813. *
  63814. * 3. Options for one single series are given in the series instance array.
  63815. * (see online documentation for example)
  63816. */
  63817. bar?: PlotBarOptions;
  63818. /**
  63819. * (Highstock) Bollinger bands (BB). This series requires the `linkedTo`
  63820. * option to be set and should be loaded after the
  63821. * `stock/indicators/indicators.js` file.
  63822. *
  63823. * In TypeScript the type option must always be set.
  63824. *
  63825. * Configuration options for the series are given in three levels:
  63826. *
  63827. * 1. Options for all series in a chart are defined in the
  63828. * plotOptions.series object.
  63829. *
  63830. * 2. Options for all `bb` series are defined in plotOptions.bb.
  63831. *
  63832. * 3. Options for one single series are given in the series instance array.
  63833. * (see online documentation for example)
  63834. */
  63835. bb?: PlotBbOptions;
  63836. /**
  63837. * (Highcharts) A bell curve is an areaspline series which represents the
  63838. * probability density function of the normal distribution. It calculates
  63839. * mean and standard deviation of the base series data and plots the curve
  63840. * according to the calculated parameters.
  63841. *
  63842. * In TypeScript the type option must always be set.
  63843. *
  63844. * Configuration options for the series are given in three levels:
  63845. *
  63846. * 1. Options for all series in a chart are defined in the
  63847. * plotOptions.series object.
  63848. *
  63849. * 2. Options for all `bellcurve` series are defined in
  63850. * plotOptions.bellcurve.
  63851. *
  63852. * 3. Options for one single series are given in the series instance array.
  63853. * (see online documentation for example)
  63854. */
  63855. bellcurve?: PlotBellcurveOptions;
  63856. /**
  63857. * (Highcharts) A box plot is a convenient way of depicting groups of data
  63858. * through their five-number summaries: the smallest observation (sample
  63859. * minimum), lower quartile (Q1), median (Q2), upper quartile (Q3), and
  63860. * largest observation (sample maximum).
  63861. *
  63862. * In TypeScript the type option must always be set.
  63863. *
  63864. * Configuration options for the series are given in three levels:
  63865. *
  63866. * 1. Options for all series in a chart are defined in the
  63867. * plotOptions.series object.
  63868. *
  63869. * 2. Options for all `boxplot` series are defined in plotOptions.boxplot.
  63870. *
  63871. * 3. Options for one single series are given in the series instance array.
  63872. * (see online documentation for example)
  63873. */
  63874. boxplot?: PlotBoxplotOptions;
  63875. /**
  63876. * (Highcharts, Highstock) A bubble series is a three dimensional series
  63877. * type where each point renders an X, Y and Z value. Each points is drawn
  63878. * as a bubble where the position along the X and Y axes mark the X and Y
  63879. * values, and the size of the bubble relates to the Z value.
  63880. *
  63881. * In TypeScript the type option must always be set.
  63882. *
  63883. * Configuration options for the series are given in three levels:
  63884. *
  63885. * 1. Options for all series in a chart are defined in the
  63886. * plotOptions.series object.
  63887. *
  63888. * 2. Options for all `bubble` series are defined in plotOptions.bubble.
  63889. *
  63890. * 3. Options for one single series are given in the series instance array.
  63891. * (see online documentation for example)
  63892. */
  63893. bubble?: PlotBubbleOptions;
  63894. /**
  63895. * (Highcharts) A bullet graph is a variation of a bar graph. The bullet
  63896. * graph features a single measure, compares it to a target, and displays it
  63897. * in the context of qualitative ranges of performance that could be set
  63898. * using plotBands on yAxis.
  63899. *
  63900. * In TypeScript the type option must always be set.
  63901. *
  63902. * Configuration options for the series are given in three levels:
  63903. *
  63904. * 1. Options for all series in a chart are defined in the
  63905. * plotOptions.series object.
  63906. *
  63907. * 2. Options for all `bullet` series are defined in plotOptions.bullet.
  63908. *
  63909. * 3. Options for one single series are given in the series instance array.
  63910. * (see online documentation for example)
  63911. */
  63912. bullet?: PlotBulletOptions;
  63913. /**
  63914. * (Highstock) A candlestick chart is a style of financial chart used to
  63915. * describe price movements over time.
  63916. *
  63917. * In TypeScript the type option must always be set.
  63918. *
  63919. * Configuration options for the series are given in three levels:
  63920. *
  63921. * 1. Options for all series in a chart are defined in the
  63922. * plotOptions.series object.
  63923. *
  63924. * 2. Options for all `candlestick` series are defined in
  63925. * plotOptions.candlestick.
  63926. *
  63927. * 3. Options for one single series are given in the series instance array.
  63928. * (see online documentation for example)
  63929. */
  63930. candlestick?: PlotCandlestickOptions;
  63931. /**
  63932. * (Highstock) Commodity Channel Index (CCI). This series requires
  63933. * `linkedTo` option to be set.
  63934. *
  63935. * In TypeScript the type option must always be set.
  63936. *
  63937. * Configuration options for the series are given in three levels:
  63938. *
  63939. * 1. Options for all series in a chart are defined in the
  63940. * plotOptions.series object.
  63941. *
  63942. * 2. Options for all `cci` series are defined in plotOptions.cci.
  63943. *
  63944. * 3. Options for one single series are given in the series instance array.
  63945. * (see online documentation for example)
  63946. */
  63947. cci?: PlotCciOptions;
  63948. /**
  63949. * (Highstock) Chaikin Oscillator. This series requires the `linkedTo`
  63950. * option to be set and should be loaded after the
  63951. * `stock/indicators/indicators.js` and `stock/indicators/ema.js`.
  63952. *
  63953. * In TypeScript the type option must always be set.
  63954. *
  63955. * Configuration options for the series are given in three levels:
  63956. *
  63957. * 1. Options for all series in a chart are defined in the
  63958. * plotOptions.series object.
  63959. *
  63960. * 2. Options for all `chaikin` series are defined in plotOptions.chaikin.
  63961. *
  63962. * 3. Options for one single series are given in the series instance array.
  63963. * (see online documentation for example)
  63964. */
  63965. chaikin?: PlotChaikinOptions;
  63966. /**
  63967. * (Highstock) Chaikin Money Flow indicator (cmf).
  63968. *
  63969. * In TypeScript the type option must always be set.
  63970. *
  63971. * Configuration options for the series are given in three levels:
  63972. *
  63973. * 1. Options for all series in a chart are defined in the
  63974. * plotOptions.series object.
  63975. *
  63976. * 2. Options for all `cmf` series are defined in plotOptions.cmf.
  63977. *
  63978. * 3. Options for one single series are given in the series instance array.
  63979. * (see online documentation for example)
  63980. */
  63981. cmf?: PlotCmfOptions;
  63982. /**
  63983. * (Highcharts, Highstock) Column series display one column per value along
  63984. * an X axis.
  63985. *
  63986. * In TypeScript the type option must always be set.
  63987. *
  63988. * Configuration options for the series are given in three levels:
  63989. *
  63990. * 1. Options for all series in a chart are defined in the
  63991. * plotOptions.series object.
  63992. *
  63993. * 2. Options for all `column` series are defined in plotOptions.column.
  63994. *
  63995. * 3. Options for one single series are given in the series instance array.
  63996. * (see online documentation for example)
  63997. */
  63998. column?: PlotColumnOptions;
  63999. /**
  64000. * (Highcharts, Highstock) Column pyramid series display one pyramid per
  64001. * value along an X axis. To display horizontal pyramids, set chart.inverted
  64002. * to `true`.
  64003. *
  64004. * In TypeScript the type option must always be set.
  64005. *
  64006. * Configuration options for the series are given in three levels:
  64007. *
  64008. * 1. Options for all series in a chart are defined in the
  64009. * plotOptions.series object.
  64010. *
  64011. * 2. Options for all `columnpyramid` series are defined in
  64012. * plotOptions.columnpyramid.
  64013. *
  64014. * 3. Options for one single series are given in the series instance array.
  64015. * (see online documentation for example)
  64016. */
  64017. columnpyramid?: PlotColumnpyramidOptions;
  64018. /**
  64019. * (Highcharts, Highstock) The column range is a cartesian series type with
  64020. * higher and lower Y values along an X axis. To display horizontal bars,
  64021. * set chart.inverted to `true`.
  64022. *
  64023. * In TypeScript the type option must always be set.
  64024. *
  64025. * Configuration options for the series are given in three levels:
  64026. *
  64027. * 1. Options for all series in a chart are defined in the
  64028. * plotOptions.series object.
  64029. *
  64030. * 2. Options for all `columnrange` series are defined in
  64031. * plotOptions.columnrange.
  64032. *
  64033. * 3. Options for one single series are given in the series instance array.
  64034. * (see online documentation for example)
  64035. */
  64036. columnrange?: PlotColumnrangeOptions;
  64037. /**
  64038. * (Highcharts) A cylinder graph is a variation of a 3d column graph. The
  64039. * cylinder graph features cylindrical points.
  64040. *
  64041. * In TypeScript the type option must always be set.
  64042. *
  64043. * Configuration options for the series are given in three levels:
  64044. *
  64045. * 1. Options for all series in a chart are defined in the
  64046. * plotOptions.series object.
  64047. *
  64048. * 2. Options for all `cylinder` series are defined in plotOptions.cylinder.
  64049. *
  64050. * 3. Options for one single series are given in the series instance array.
  64051. * (see online documentation for example)
  64052. */
  64053. cylinder?: PlotCylinderOptions;
  64054. /**
  64055. * (Highstock) Double exponential moving average (DEMA) indicator. This
  64056. * series requires `linkedTo` option to be set and should be loaded after
  64057. * the `stock/indicators/indicators.js` and `stock/indicators/ema.js`.
  64058. *
  64059. * In TypeScript the type option must always be set.
  64060. *
  64061. * Configuration options for the series are given in three levels:
  64062. *
  64063. * 1. Options for all series in a chart are defined in the
  64064. * plotOptions.series object.
  64065. *
  64066. * 2. Options for all `dema` series are defined in plotOptions.dema.
  64067. *
  64068. * 3. Options for one single series are given in the series instance array.
  64069. * (see online documentation for example)
  64070. */
  64071. dema?: PlotDemaOptions;
  64072. /**
  64073. * (Highcharts) A dependency wheel chart is a type of flow diagram, where
  64074. * all nodes are laid out in a circle, and the flow between the are drawn as
  64075. * link bands.
  64076. *
  64077. * In TypeScript the type option must always be set.
  64078. *
  64079. * Configuration options for the series are given in three levels:
  64080. *
  64081. * 1. Options for all series in a chart are defined in the
  64082. * plotOptions.series object.
  64083. *
  64084. * 2. Options for all `dependencywheel` series are defined in
  64085. * plotOptions.dependencywheel.
  64086. *
  64087. * 3. Options for one single series are given in the series instance array.
  64088. * (see online documentation for example)
  64089. */
  64090. dependencywheel?: PlotDependencywheelOptions;
  64091. /**
  64092. * (Highstock) Detrended Price Oscillator. This series requires the
  64093. * `linkedTo` option to be set and should be loaded after the
  64094. * `stock/indicators/indicators.js`.
  64095. *
  64096. * In TypeScript the type option must always be set.
  64097. *
  64098. * Configuration options for the series are given in three levels:
  64099. *
  64100. * 1. Options for all series in a chart are defined in the
  64101. * plotOptions.series object.
  64102. *
  64103. * 2. Options for all `dpo` series are defined in plotOptions.dpo.
  64104. *
  64105. * 3. Options for one single series are given in the series instance array.
  64106. * (see online documentation for example)
  64107. */
  64108. dpo?: PlotDpoOptions;
  64109. /**
  64110. * (Highcharts, Highstock) The dumbbell series is a cartesian series with
  64111. * higher and lower values for each point along an X axis, connected with a
  64112. * line between the values.
  64113. *
  64114. * Requires `highcharts-more.js` and `modules/dumbbell.js`.
  64115. *
  64116. * In TypeScript the type option must always be set.
  64117. *
  64118. * Configuration options for the series are given in three levels:
  64119. *
  64120. * 1. Options for all series in a chart are defined in the
  64121. * plotOptions.series object.
  64122. *
  64123. * 2. Options for all `dumbbell` series are defined in plotOptions.dumbbell.
  64124. *
  64125. * 3. Options for one single series are given in the series instance array.
  64126. * (see online documentation for example)
  64127. */
  64128. dumbbell?: PlotDumbbellOptions;
  64129. /**
  64130. * (Highstock) Exponential moving average indicator (EMA). This series
  64131. * requires the `linkedTo` option to be set.
  64132. *
  64133. * In TypeScript the type option must always be set.
  64134. *
  64135. * Configuration options for the series are given in three levels:
  64136. *
  64137. * 1. Options for all series in a chart are defined in the
  64138. * plotOptions.series object.
  64139. *
  64140. * 2. Options for all `ema` series are defined in plotOptions.ema.
  64141. *
  64142. * 3. Options for one single series are given in the series instance array.
  64143. * (see online documentation for example)
  64144. */
  64145. ema?: PlotEmaOptions;
  64146. /**
  64147. * (Highcharts, Highstock) Error bars are a graphical representation of the
  64148. * variability of data and are used on graphs to indicate the error, or
  64149. * uncertainty in a reported measurement.
  64150. *
  64151. * In TypeScript the type option must always be set.
  64152. *
  64153. * Configuration options for the series are given in three levels:
  64154. *
  64155. * 1. Options for all series in a chart are defined in the
  64156. * plotOptions.series object.
  64157. *
  64158. * 2. Options for all `errorbar` series are defined in plotOptions.errorbar.
  64159. *
  64160. * 3. Options for one single series are given in the series instance array.
  64161. * (see online documentation for example)
  64162. */
  64163. errorbar?: PlotErrorbarOptions;
  64164. /**
  64165. * (Highstock) Flags are used to mark events in stock charts. They can be
  64166. * added on the timeline, or attached to a specific series.
  64167. *
  64168. * In TypeScript the type option must always be set.
  64169. *
  64170. * Configuration options for the series are given in three levels:
  64171. *
  64172. * 1. Options for all series in a chart are defined in the
  64173. * plotOptions.series object.
  64174. *
  64175. * 2. Options for all `flags` series are defined in plotOptions.flags.
  64176. *
  64177. * 3. Options for one single series are given in the series instance array.
  64178. * (see online documentation for example)
  64179. */
  64180. flags?: PlotFlagsOptions;
  64181. /**
  64182. * (Highcharts) Funnel charts are a type of chart often used to visualize
  64183. * stages in a sales project, where the top are the initial stages with the
  64184. * most clients. It requires that the modules/funnel.js file is loaded.
  64185. *
  64186. * In TypeScript the type option must always be set.
  64187. *
  64188. * Configuration options for the series are given in three levels:
  64189. *
  64190. * 1. Options for all series in a chart are defined in the
  64191. * plotOptions.series object.
  64192. *
  64193. * 2. Options for all `funnel` series are defined in plotOptions.funnel.
  64194. *
  64195. * 3. Options for one single series are given in the series instance array.
  64196. * (see online documentation for example)
  64197. */
  64198. funnel?: PlotFunnelOptions;
  64199. /**
  64200. * (Highcharts) A funnel3d is a 3d version of funnel series type. Funnel
  64201. * charts are a type of chart often used to visualize stages in a sales
  64202. * project, where the top are the initial stages with the most clients.
  64203. *
  64204. * It requires that the `highcharts-3d.js`, `cylinder.js` and `funnel3d.js`
  64205. * module are loaded.
  64206. *
  64207. * In TypeScript the type option must always be set.
  64208. *
  64209. * Configuration options for the series are given in three levels:
  64210. *
  64211. * 1. Options for all series in a chart are defined in the
  64212. * plotOptions.series object.
  64213. *
  64214. * 2. Options for all `funnel3d` series are defined in plotOptions.funnel3d.
  64215. *
  64216. * 3. Options for one single series are given in the series instance array.
  64217. * (see online documentation for example)
  64218. */
  64219. funnel3d?: PlotFunnel3dOptions;
  64220. /**
  64221. * (Gantt) A `gantt` series. If the type option is not specified, it is
  64222. * inherited from chart.type.
  64223. *
  64224. * In TypeScript the type option must always be set.
  64225. *
  64226. * Configuration options for the series are given in three levels:
  64227. *
  64228. * 1. Options for all series in a chart are defined in the
  64229. * plotOptions.series object.
  64230. *
  64231. * 2. Options for all `gantt` series are defined in plotOptions.gantt.
  64232. *
  64233. * 3. Options for one single series are given in the series instance array.
  64234. * (see online documentation for example)
  64235. */
  64236. gantt?: PlotGanttOptions;
  64237. /**
  64238. * (Highcharts) Gauges are circular plots displaying one or more values with
  64239. * a dial pointing to values along the perimeter.
  64240. *
  64241. * In TypeScript the type option must always be set.
  64242. *
  64243. * Configuration options for the series are given in three levels:
  64244. *
  64245. * 1. Options for all series in a chart are defined in the
  64246. * plotOptions.series object.
  64247. *
  64248. * 2. Options for all `gauge` series are defined in plotOptions.gauge.
  64249. *
  64250. * 3. Options for one single series are given in the series instance array.
  64251. * (see online documentation for example)
  64252. */
  64253. gauge?: PlotGaugeOptions;
  64254. /**
  64255. * (Highcharts, Highmaps) A heatmap is a graphical representation of data
  64256. * where the individual values contained in a matrix are represented as
  64257. * colors.
  64258. *
  64259. * In TypeScript the type option must always be set.
  64260. *
  64261. * Configuration options for the series are given in three levels:
  64262. *
  64263. * 1. Options for all series in a chart are defined in the
  64264. * plotOptions.series object.
  64265. *
  64266. * 2. Options for all `heatmap` series are defined in plotOptions.heatmap.
  64267. *
  64268. * 3. Options for one single series are given in the series instance array.
  64269. * (see online documentation for example)
  64270. */
  64271. heatmap?: PlotHeatmapOptions;
  64272. /**
  64273. * (Highcharts) A histogram is a column series which represents the
  64274. * distribution of the data set in the base series. Histogram splits data
  64275. * into bins and shows their frequencies.
  64276. *
  64277. * In TypeScript the type option must always be set.
  64278. *
  64279. * Configuration options for the series are given in three levels:
  64280. *
  64281. * 1. Options for all series in a chart are defined in the
  64282. * plotOptions.series object.
  64283. *
  64284. * 2. Options for all `histogram` series are defined in
  64285. * plotOptions.histogram.
  64286. *
  64287. * 3. Options for one single series are given in the series instance array.
  64288. * (see online documentation for example)
  64289. */
  64290. histogram?: PlotHistogramOptions;
  64291. /**
  64292. * (Highstock) Ichimoku Kinko Hyo (IKH). This series requires `linkedTo`
  64293. * option to be set.
  64294. *
  64295. * In TypeScript the type option must always be set.
  64296. *
  64297. * Configuration options for the series are given in three levels:
  64298. *
  64299. * 1. Options for all series in a chart are defined in the
  64300. * plotOptions.series object.
  64301. *
  64302. * 2. Options for all `ikh` series are defined in plotOptions.ikh.
  64303. *
  64304. * 3. Options for one single series are given in the series instance array.
  64305. * (see online documentation for example)
  64306. */
  64307. ikh?: PlotIkhOptions;
  64308. /**
  64309. * (Highcharts) An item chart is an infographic chart where a number of
  64310. * items are laid out in either a rectangular or circular pattern. It can be
  64311. * used to visualize counts within a group, or for the circular pattern,
  64312. * typically a parliament.
  64313. *
  64314. * The circular layout has much in common with a pie chart. Many of the item
  64315. * series options, like `center`, `size` and data label positioning, are
  64316. * inherited from the pie series and don't apply for rectangular layouts.
  64317. *
  64318. * In TypeScript the type option must always be set.
  64319. *
  64320. * Configuration options for the series are given in three levels:
  64321. *
  64322. * 1. Options for all series in a chart are defined in the
  64323. * plotOptions.series object.
  64324. *
  64325. * 2. Options for all `item` series are defined in plotOptions.item.
  64326. *
  64327. * 3. Options for one single series are given in the series instance array.
  64328. * (see online documentation for example)
  64329. */
  64330. item?: PlotItemOptions;
  64331. /**
  64332. * (Highstock) Keltner Channels. This series requires the `linkedTo` option
  64333. * to be set and should be loaded after the
  64334. * `stock/indicators/indicators.js`, `stock/indicators/atr.js`, and
  64335. * `stock/ema/.js`.
  64336. *
  64337. * In TypeScript the type option must always be set.
  64338. *
  64339. * Configuration options for the series are given in three levels:
  64340. *
  64341. * 1. Options for all series in a chart are defined in the
  64342. * plotOptions.series object.
  64343. *
  64344. * 2. Options for all `keltnerchannels` series are defined in
  64345. * plotOptions.keltnerchannels.
  64346. *
  64347. * 3. Options for one single series are given in the series instance array.
  64348. * (see online documentation for example)
  64349. */
  64350. keltnerchannels?: PlotKeltnerchannelsOptions;
  64351. /**
  64352. * (Highcharts, Highstock) A line series displays information as a series of
  64353. * data points connected by straight line segments.
  64354. *
  64355. * In TypeScript the type option must always be set.
  64356. *
  64357. * Configuration options for the series are given in three levels:
  64358. *
  64359. * 1. Options for all series in a chart are defined in the
  64360. * plotOptions.series object.
  64361. *
  64362. * 2. Options for all `line` series are defined in plotOptions.line.
  64363. *
  64364. * 3. Options for one single series are given in the series instance array.
  64365. * (see online documentation for example)
  64366. */
  64367. line?: PlotLineOptions;
  64368. /**
  64369. * (Highstock) Linear regression indicator. This series requires `linkedTo`
  64370. * option to be set.
  64371. *
  64372. * In TypeScript the type option must always be set.
  64373. *
  64374. * Configuration options for the series are given in three levels:
  64375. *
  64376. * 1. Options for all series in a chart are defined in the
  64377. * plotOptions.series object.
  64378. *
  64379. * 2. Options for all `linearregression` series are defined in
  64380. * plotOptions.linearregression.
  64381. *
  64382. * 3. Options for one single series are given in the series instance array.
  64383. * (see online documentation for example)
  64384. */
  64385. linearregression?: PlotLinearregressionOptions;
  64386. /**
  64387. * (Highstock) Linear regression angle indicator. This series requires
  64388. * `linkedTo` option to be set.
  64389. *
  64390. * In TypeScript the type option must always be set.
  64391. *
  64392. * Configuration options for the series are given in three levels:
  64393. *
  64394. * 1. Options for all series in a chart are defined in the
  64395. * plotOptions.series object.
  64396. *
  64397. * 2. Options for all `linearregressionangle` series are defined in
  64398. * plotOptions.linearregressionangle.
  64399. *
  64400. * 3. Options for one single series are given in the series instance array.
  64401. * (see online documentation for example)
  64402. */
  64403. linearregressionangle?: PlotLinearregressionangleOptions;
  64404. /**
  64405. * (Highstock) Linear regression intercept indicator. This series requires
  64406. * `linkedTo` option to be set.
  64407. *
  64408. * In TypeScript the type option must always be set.
  64409. *
  64410. * Configuration options for the series are given in three levels:
  64411. *
  64412. * 1. Options for all series in a chart are defined in the
  64413. * plotOptions.series object.
  64414. *
  64415. * 2. Options for all `linearregressionintercept` series are defined in
  64416. * plotOptions.linearregressionintercept.
  64417. *
  64418. * 3. Options for one single series are given in the series instance array.
  64419. * (see online documentation for example)
  64420. */
  64421. linearregressionintercept?: PlotLinearregressioninterceptOptions;
  64422. /**
  64423. * (Highstock) Linear regression slope indicator. This series requires
  64424. * `linkedTo` option to be set.
  64425. *
  64426. * In TypeScript the type option must always be set.
  64427. *
  64428. * Configuration options for the series are given in three levels:
  64429. *
  64430. * 1. Options for all series in a chart are defined in the
  64431. * plotOptions.series object.
  64432. *
  64433. * 2. Options for all `linearregressionslope` series are defined in
  64434. * plotOptions.linearregressionslope.
  64435. *
  64436. * 3. Options for one single series are given in the series instance array.
  64437. * (see online documentation for example)
  64438. */
  64439. linearregressionslope?: PlotLinearregressionslopeOptions;
  64440. /**
  64441. * (Highcharts, Highstock) The lollipop series is a carteseian series with a
  64442. * line anchored from the x axis and a dot at the end to mark the value.
  64443. * Requires `highcharts-more.js`, `modules/dumbbell.js` and
  64444. * `modules/lollipop.js`.
  64445. *
  64446. * In TypeScript the type option must always be set.
  64447. *
  64448. * Configuration options for the series are given in three levels:
  64449. *
  64450. * 1. Options for all series in a chart are defined in the
  64451. * plotOptions.series object.
  64452. *
  64453. * 2. Options for all `lollipop` series are defined in plotOptions.lollipop.
  64454. *
  64455. * 3. Options for one single series are given in the series instance array.
  64456. * (see online documentation for example)
  64457. */
  64458. lollipop?: PlotLollipopOptions;
  64459. /**
  64460. * (Highstock) Moving Average Convergence Divergence (MACD). This series
  64461. * requires `linkedTo` option to be set and should be loaded after the
  64462. * `stock/indicators/indicators.js` and `stock/indicators/ema.js`.
  64463. *
  64464. * In TypeScript the type option must always be set.
  64465. *
  64466. * Configuration options for the series are given in three levels:
  64467. *
  64468. * 1. Options for all series in a chart are defined in the
  64469. * plotOptions.series object.
  64470. *
  64471. * 2. Options for all `macd` series are defined in plotOptions.macd.
  64472. *
  64473. * 3. Options for one single series are given in the series instance array.
  64474. * (see online documentation for example)
  64475. */
  64476. macd?: PlotMacdOptions;
  64477. /**
  64478. * (Highmaps) The map series is used for basic choropleth maps, where each
  64479. * map area has a color based on its value.
  64480. *
  64481. * In TypeScript the type option must always be set.
  64482. *
  64483. * Configuration options for the series are given in three levels:
  64484. *
  64485. * 1. Options for all series in a chart are defined in the
  64486. * plotOptions.series object.
  64487. *
  64488. * 2. Options for all `map` series are defined in plotOptions.map.
  64489. *
  64490. * 3. Options for one single series are given in the series instance array.
  64491. * (see online documentation for example)
  64492. */
  64493. map?: PlotMapOptions;
  64494. /**
  64495. * (Highmaps) A map bubble series is a bubble series laid out on top of a
  64496. * map series, where each bubble is tied to a specific map area.
  64497. *
  64498. * In TypeScript the type option must always be set.
  64499. *
  64500. * Configuration options for the series are given in three levels:
  64501. *
  64502. * 1. Options for all series in a chart are defined in the
  64503. * plotOptions.series object.
  64504. *
  64505. * 2. Options for all `mapbubble` series are defined in
  64506. * plotOptions.mapbubble.
  64507. *
  64508. * 3. Options for one single series are given in the series instance array.
  64509. * (see online documentation for example)
  64510. */
  64511. mapbubble?: PlotMapbubbleOptions;
  64512. /**
  64513. * (Highmaps) A mapline series is a special case of the map series where the
  64514. * value colors are applied to the strokes rather than the fills. It can
  64515. * also be used for freeform drawing, like dividers, in the map.
  64516. *
  64517. * In TypeScript the type option must always be set.
  64518. *
  64519. * Configuration options for the series are given in three levels:
  64520. *
  64521. * 1. Options for all series in a chart are defined in the
  64522. * plotOptions.series object.
  64523. *
  64524. * 2. Options for all `mapline` series are defined in plotOptions.mapline.
  64525. *
  64526. * 3. Options for one single series are given in the series instance array.
  64527. * (see online documentation for example)
  64528. */
  64529. mapline?: PlotMaplineOptions;
  64530. /**
  64531. * (Highmaps) A mappoint series is a special form of scatter series where
  64532. * the points can be laid out in map coordinates on top of a map.
  64533. *
  64534. * In TypeScript the type option must always be set.
  64535. *
  64536. * Configuration options for the series are given in three levels:
  64537. *
  64538. * 1. Options for all series in a chart are defined in the
  64539. * plotOptions.series object.
  64540. *
  64541. * 2. Options for all `mappoint` series are defined in plotOptions.mappoint.
  64542. *
  64543. * 3. Options for one single series are given in the series instance array.
  64544. * (see online documentation for example)
  64545. */
  64546. mappoint?: PlotMappointOptions;
  64547. /**
  64548. * (Highstock) Money Flow Index. This series requires `linkedTo` option to
  64549. * be set and should be loaded after the `stock/indicators/indicators.js`
  64550. * file.
  64551. *
  64552. * In TypeScript the type option must always be set.
  64553. *
  64554. * Configuration options for the series are given in three levels:
  64555. *
  64556. * 1. Options for all series in a chart are defined in the
  64557. * plotOptions.series object.
  64558. *
  64559. * 2. Options for all `mfi` series are defined in plotOptions.mfi.
  64560. *
  64561. * 3. Options for one single series are given in the series instance array.
  64562. * (see online documentation for example)
  64563. */
  64564. mfi?: PlotMfiOptions;
  64565. /**
  64566. * (Highstock) Momentum. This series requires `linkedTo` option to be set.
  64567. *
  64568. * In TypeScript the type option must always be set.
  64569. *
  64570. * Configuration options for the series are given in three levels:
  64571. *
  64572. * 1. Options for all series in a chart are defined in the
  64573. * plotOptions.series object.
  64574. *
  64575. * 2. Options for all `momentum` series are defined in plotOptions.momentum.
  64576. *
  64577. * 3. Options for one single series are given in the series instance array.
  64578. * (see online documentation for example)
  64579. */
  64580. momentum?: PlotMomentumOptions;
  64581. /**
  64582. * (Highstock) Normalized average true range indicator (NATR). This series
  64583. * requires `linkedTo` option to be set and should be loaded after the
  64584. * `stock/indicators/indicators.js` and `stock/indicators/atr.js`.
  64585. *
  64586. * In TypeScript the type option must always be set.
  64587. *
  64588. * Configuration options for the series are given in three levels:
  64589. *
  64590. * 1. Options for all series in a chart are defined in the
  64591. * plotOptions.series object.
  64592. *
  64593. * 2. Options for all `natr` series are defined in plotOptions.natr.
  64594. *
  64595. * 3. Options for one single series are given in the series instance array.
  64596. * (see online documentation for example)
  64597. */
  64598. natr?: PlotNatrOptions;
  64599. /**
  64600. * (Highcharts) A networkgraph is a type of relationship chart, where
  64601. * connnections (links) attracts nodes (points) and other nodes repulse each
  64602. * other.
  64603. *
  64604. * In TypeScript the type option must always be set.
  64605. *
  64606. * Configuration options for the series are given in three levels:
  64607. *
  64608. * 1. Options for all series in a chart are defined in the
  64609. * plotOptions.series object.
  64610. *
  64611. * 2. Options for all `networkgraph` series are defined in
  64612. * plotOptions.networkgraph.
  64613. *
  64614. * 3. Options for one single series are given in the series instance array.
  64615. * (see online documentation for example)
  64616. */
  64617. networkgraph?: PlotNetworkgraphOptions;
  64618. /**
  64619. * (Highstock) An OHLC chart is a style of financial chart used to describe
  64620. * price movements over time. It displays open, high, low and close values
  64621. * per data point.
  64622. *
  64623. * In TypeScript the type option must always be set.
  64624. *
  64625. * Configuration options for the series are given in three levels:
  64626. *
  64627. * 1. Options for all series in a chart are defined in the
  64628. * plotOptions.series object.
  64629. *
  64630. * 2. Options for all `ohlc` series are defined in plotOptions.ohlc.
  64631. *
  64632. * 3. Options for one single series are given in the series instance array.
  64633. * (see online documentation for example)
  64634. */
  64635. ohlc?: PlotOhlcOptions;
  64636. /**
  64637. * (Highcharts) An organization chart is a diagram that shows the structure
  64638. * of an organization and the relationships and relative ranks of its parts
  64639. * and positions.
  64640. *
  64641. * In TypeScript the type option must always be set.
  64642. *
  64643. * Configuration options for the series are given in three levels:
  64644. *
  64645. * 1. Options for all series in a chart are defined in the
  64646. * plotOptions.series object.
  64647. *
  64648. * 2. Options for all `organization` series are defined in
  64649. * plotOptions.organization.
  64650. *
  64651. * 3. Options for one single series are given in the series instance array.
  64652. * (see online documentation for example)
  64653. */
  64654. organization?: PlotOrganizationOptions;
  64655. /**
  64656. * (Highcharts) A packed bubble series is a two dimensional series type,
  64657. * where each point renders a value in X, Y position. Each point is drawn as
  64658. * a bubble where the bubbles don't overlap with each other and the radius
  64659. * of the bubble relates to the value.
  64660. *
  64661. * In TypeScript the type option must always be set.
  64662. *
  64663. * Configuration options for the series are given in three levels:
  64664. *
  64665. * 1. Options for all series in a chart are defined in the
  64666. * plotOptions.series object.
  64667. *
  64668. * 2. Options for all `packedbubble` series are defined in
  64669. * plotOptions.packedbubble.
  64670. *
  64671. * 3. Options for one single series are given in the series instance array.
  64672. * (see online documentation for example)
  64673. */
  64674. packedbubble?: PlotPackedbubbleOptions;
  64675. /**
  64676. * (Highcharts) A pareto diagram is a type of chart that contains both bars
  64677. * and a line graph, where individual values are represented in descending
  64678. * order by bars, and the cumulative total is represented by the line.
  64679. *
  64680. * In TypeScript the type option must always be set.
  64681. *
  64682. * Configuration options for the series are given in three levels:
  64683. *
  64684. * 1. Options for all series in a chart are defined in the
  64685. * plotOptions.series object.
  64686. *
  64687. * 2. Options for all `pareto` series are defined in plotOptions.pareto.
  64688. *
  64689. * 3. Options for one single series are given in the series instance array.
  64690. * (see online documentation for example)
  64691. */
  64692. pareto?: PlotParetoOptions;
  64693. /**
  64694. * (Highstock) Price channel (PC). This series requires the `linkedTo`
  64695. * option to be set and should be loaded after the
  64696. * `stock/indicators/indicators.js`.
  64697. *
  64698. * In TypeScript the type option must always be set.
  64699. *
  64700. * Configuration options for the series are given in three levels:
  64701. *
  64702. * 1. Options for all series in a chart are defined in the
  64703. * plotOptions.series object.
  64704. *
  64705. * 2. Options for all `pc` series are defined in plotOptions.pc.
  64706. *
  64707. * 3. Options for one single series are given in the series instance array.
  64708. * (see online documentation for example)
  64709. */
  64710. pc?: PlotPcOptions;
  64711. /**
  64712. * (Highcharts) A pie chart is a circular graphic which is divided into
  64713. * slices to illustrate numerical proportion.
  64714. *
  64715. * In TypeScript the type option must always be set.
  64716. *
  64717. * Configuration options for the series are given in three levels:
  64718. *
  64719. * 1. Options for all series in a chart are defined in the
  64720. * plotOptions.series object.
  64721. *
  64722. * 2. Options for all `pie` series are defined in plotOptions.pie.
  64723. *
  64724. * 3. Options for one single series are given in the series instance array.
  64725. * (see online documentation for example)
  64726. */
  64727. pie?: PlotPieOptions;
  64728. /**
  64729. * (Highstock) Pivot points indicator. This series requires the `linkedTo`
  64730. * option to be set and should be loaded after
  64731. * `stock/indicators/indicators.js` file.
  64732. *
  64733. * In TypeScript the type option must always be set.
  64734. *
  64735. * Configuration options for the series are given in three levels:
  64736. *
  64737. * 1. Options for all series in a chart are defined in the
  64738. * plotOptions.series object.
  64739. *
  64740. * 2. Options for all `pivotpoints` series are defined in
  64741. * plotOptions.pivotpoints.
  64742. *
  64743. * 3. Options for one single series are given in the series instance array.
  64744. * (see online documentation for example)
  64745. */
  64746. pivotpoints?: PlotPivotpointsOptions;
  64747. /**
  64748. * (Highcharts, Highstock) A polygon series can be used to draw any freeform
  64749. * shape in the cartesian coordinate system. A fill is applied with the
  64750. * `color` option, and stroke is applied through `lineWidth` and `lineColor`
  64751. * options.
  64752. *
  64753. * In TypeScript the type option must always be set.
  64754. *
  64755. * Configuration options for the series are given in three levels:
  64756. *
  64757. * 1. Options for all series in a chart are defined in the
  64758. * plotOptions.series object.
  64759. *
  64760. * 2. Options for all `polygon` series are defined in plotOptions.polygon.
  64761. *
  64762. * 3. Options for one single series are given in the series instance array.
  64763. * (see online documentation for example)
  64764. */
  64765. polygon?: PlotPolygonOptions;
  64766. /**
  64767. * (Highstock) Percentage Price Oscillator. This series requires the
  64768. * `linkedTo` option to be set and should be loaded after the
  64769. * `stock/indicators/indicators.js` and `stock/indicators/ema.js`.
  64770. *
  64771. * In TypeScript the type option must always be set.
  64772. *
  64773. * Configuration options for the series are given in three levels:
  64774. *
  64775. * 1. Options for all series in a chart are defined in the
  64776. * plotOptions.series object.
  64777. *
  64778. * 2. Options for all `ppo` series are defined in plotOptions.ppo.
  64779. *
  64780. * 3. Options for one single series are given in the series instance array.
  64781. * (see online documentation for example)
  64782. */
  64783. ppo?: PlotPpoOptions;
  64784. /**
  64785. * (Highstock) Price envelopes indicator based on SMA calculations. This
  64786. * series requires the `linkedTo` option to be set and should be loaded
  64787. * after the `stock/indicators/indicators.js` file.
  64788. *
  64789. * In TypeScript the type option must always be set.
  64790. *
  64791. * Configuration options for the series are given in three levels:
  64792. *
  64793. * 1. Options for all series in a chart are defined in the
  64794. * plotOptions.series object.
  64795. *
  64796. * 2. Options for all `priceenvelopes` series are defined in
  64797. * plotOptions.priceenvelopes.
  64798. *
  64799. * 3. Options for one single series are given in the series instance array.
  64800. * (see online documentation for example)
  64801. */
  64802. priceenvelopes?: PlotPriceenvelopesOptions;
  64803. /**
  64804. * (Highstock) Parabolic SAR. This series requires `linkedTo` option to be
  64805. * set and should be loaded after `stock/indicators/indicators.js` file.
  64806. *
  64807. * In TypeScript the type option must always be set.
  64808. *
  64809. * Configuration options for the series are given in three levels:
  64810. *
  64811. * 1. Options for all series in a chart are defined in the
  64812. * plotOptions.series object.
  64813. *
  64814. * 2. Options for all `psar` series are defined in plotOptions.psar.
  64815. *
  64816. * 3. Options for one single series are given in the series instance array.
  64817. * (see online documentation for example)
  64818. */
  64819. psar?: PlotPsarOptions;
  64820. /**
  64821. * (Highcharts) A pyramid series is a special type of funnel, without neck
  64822. * and reversed by default.
  64823. *
  64824. * In TypeScript the type option must always be set.
  64825. *
  64826. * Configuration options for the series are given in three levels:
  64827. *
  64828. * 1. Options for all series in a chart are defined in the
  64829. * plotOptions.series object.
  64830. *
  64831. * 2. Options for all `pyramid` series are defined in plotOptions.pyramid.
  64832. *
  64833. * 3. Options for one single series are given in the series instance array.
  64834. * (see online documentation for example)
  64835. */
  64836. pyramid?: PlotPyramidOptions;
  64837. /**
  64838. * (Highcharts) A pyramid3d is a 3d version of pyramid series type. Pyramid
  64839. * charts are a type of chart often used to visualize stages in a sales
  64840. * project, where the top are the initial stages with the most clients.
  64841. *
  64842. * In TypeScript the type option must always be set.
  64843. *
  64844. * Configuration options for the series are given in three levels:
  64845. *
  64846. * 1. Options for all series in a chart are defined in the
  64847. * plotOptions.series object.
  64848. *
  64849. * 2. Options for all `pyramid3d` series are defined in
  64850. * plotOptions.pyramid3d.
  64851. *
  64852. * 3. Options for one single series are given in the series instance array.
  64853. * (see online documentation for example)
  64854. */
  64855. pyramid3d?: PlotPyramid3dOptions;
  64856. /**
  64857. * (Highstock) Rate of change indicator (ROC). The indicator value for each
  64858. * point is defined as:
  64859. *
  64860. * `(C - Cn) / Cn * 100`
  64861. *
  64862. * where: `C` is the close value of the point of the same x in the linked
  64863. * series and `Cn` is the close value of the point `n` periods ago. `n` is
  64864. * set through period.
  64865. *
  64866. * This series requires `linkedTo` option to be set.
  64867. *
  64868. * In TypeScript the type option must always be set.
  64869. *
  64870. * Configuration options for the series are given in three levels:
  64871. *
  64872. * 1. Options for all series in a chart are defined in the
  64873. * plotOptions.series object.
  64874. *
  64875. * 2. Options for all `roc` series are defined in plotOptions.roc.
  64876. *
  64877. * 3. Options for one single series are given in the series instance array.
  64878. * (see online documentation for example)
  64879. */
  64880. roc?: PlotRocOptions;
  64881. /**
  64882. * (Highstock) Relative strength index (RSI) technical indicator. This
  64883. * series requires the `linkedTo` option to be set and should be loaded
  64884. * after the `stock/indicators/indicators.js` file.
  64885. *
  64886. * In TypeScript the type option must always be set.
  64887. *
  64888. * Configuration options for the series are given in three levels:
  64889. *
  64890. * 1. Options for all series in a chart are defined in the
  64891. * plotOptions.series object.
  64892. *
  64893. * 2. Options for all `rsi` series are defined in plotOptions.rsi.
  64894. *
  64895. * 3. Options for one single series are given in the series instance array.
  64896. * (see online documentation for example)
  64897. */
  64898. rsi?: PlotRsiOptions;
  64899. /**
  64900. * (Highcharts) A sankey diagram is a type of flow diagram, in which the
  64901. * width of the link between two nodes is shown proportionally to the flow
  64902. * quantity.
  64903. *
  64904. * In TypeScript the type option must always be set.
  64905. *
  64906. * Configuration options for the series are given in three levels:
  64907. *
  64908. * 1. Options for all series in a chart are defined in the
  64909. * plotOptions.series object.
  64910. *
  64911. * 2. Options for all `sankey` series are defined in plotOptions.sankey.
  64912. *
  64913. * 3. Options for one single series are given in the series instance array.
  64914. * (see online documentation for example)
  64915. */
  64916. sankey?: PlotSankeyOptions;
  64917. /**
  64918. * (Highcharts, Highstock) A scatter plot uses cartesian coordinates to
  64919. * display values for two variables for a set of data.
  64920. *
  64921. * In TypeScript the type option must always be set.
  64922. *
  64923. * Configuration options for the series are given in three levels:
  64924. *
  64925. * 1. Options for all series in a chart are defined in the
  64926. * plotOptions.series object.
  64927. *
  64928. * 2. Options for all `scatter` series are defined in plotOptions.scatter.
  64929. *
  64930. * 3. Options for one single series are given in the series instance array.
  64931. * (see online documentation for example)
  64932. */
  64933. scatter?: PlotScatterOptions;
  64934. /**
  64935. * (Highcharts) A 3D scatter plot uses x, y and z coordinates to display
  64936. * values for three variables for a set of data.
  64937. *
  64938. * In TypeScript the type option must always be set.
  64939. *
  64940. * Configuration options for the series are given in three levels:
  64941. *
  64942. * 1. Options for all series in a chart are defined in the
  64943. * plotOptions.series object.
  64944. *
  64945. * 2. Options for all `scatter3d` series are defined in
  64946. * plotOptions.scatter3d.
  64947. *
  64948. * 3. Options for one single series are given in the series instance array.
  64949. * (see online documentation for example)
  64950. */
  64951. scatter3d?: PlotScatter3dOptions;
  64952. /**
  64953. * (Highcharts, Highstock, Highmaps, Gantt) General options for all series
  64954. * types.
  64955. *
  64956. * In TypeScript the type option must always be set.
  64957. *
  64958. * Configuration options for the series are given in three levels:
  64959. *
  64960. * 1. Options for all series in a chart are defined in the
  64961. * plotOptions.series object.
  64962. *
  64963. * 2. Options for all `line` series are defined in plotOptions.line.
  64964. *
  64965. * 3. Options for one single series are given in the series instance array.
  64966. * (see online documentation for example)
  64967. */
  64968. series?: PlotSeriesOptions;
  64969. /**
  64970. * (Highstock) Slow Stochastic oscillator. This series requires the
  64971. * `linkedTo` option to be set and should be loaded after
  64972. * `stock/indicators/indicators.js` and `stock/indicators/stochastic.js`
  64973. * files.
  64974. *
  64975. * In TypeScript the type option must always be set.
  64976. *
  64977. * Configuration options for the series are given in three levels:
  64978. *
  64979. * 1. Options for all series in a chart are defined in the
  64980. * plotOptions.series object.
  64981. *
  64982. * 2. Options for all `slowstochastic` series are defined in
  64983. * plotOptions.slowstochastic.
  64984. *
  64985. * 3. Options for one single series are given in the series instance array.
  64986. * (see online documentation for example)
  64987. */
  64988. slowstochastic?: PlotSlowstochasticOptions;
  64989. /**
  64990. * (Highstock) Simple moving average indicator (SMA). This series requires
  64991. * `linkedTo` option to be set.
  64992. *
  64993. * In TypeScript the type option must always be set.
  64994. *
  64995. * Configuration options for the series are given in three levels:
  64996. *
  64997. * 1. Options for all series in a chart are defined in the
  64998. * plotOptions.series object.
  64999. *
  65000. * 2. Options for all `sma` series are defined in plotOptions.sma.
  65001. *
  65002. * 3. Options for one single series are given in the series instance array.
  65003. * (see online documentation for example)
  65004. */
  65005. sma?: PlotSmaOptions;
  65006. /**
  65007. * (Highcharts) A solid gauge is a circular gauge where the value is
  65008. * indicated by a filled arc, and the color of the arc may variate with the
  65009. * value.
  65010. *
  65011. * In TypeScript the type option must always be set.
  65012. *
  65013. * Configuration options for the series are given in three levels:
  65014. *
  65015. * 1. Options for all series in a chart are defined in the
  65016. * plotOptions.series object.
  65017. *
  65018. * 2. Options for all `solidgauge` series are defined in
  65019. * plotOptions.solidgauge.
  65020. *
  65021. * 3. Options for one single series are given in the series instance array.
  65022. * (see online documentation for example)
  65023. */
  65024. solidgauge?: PlotSolidgaugeOptions;
  65025. /**
  65026. * (Highcharts, Highstock) A spline series is a special type of line series,
  65027. * where the segments between the data points are smoothed.
  65028. *
  65029. * In TypeScript the type option must always be set.
  65030. *
  65031. * Configuration options for the series are given in three levels:
  65032. *
  65033. * 1. Options for all series in a chart are defined in the
  65034. * plotOptions.series object.
  65035. *
  65036. * 2. Options for all `spline` series are defined in plotOptions.spline.
  65037. *
  65038. * 3. Options for one single series are given in the series instance array.
  65039. * (see online documentation for example)
  65040. */
  65041. spline?: PlotSplineOptions;
  65042. /**
  65043. * (Highstock) Stochastic oscillator. This series requires the `linkedTo`
  65044. * option to be set and should be loaded after the
  65045. * `stock/indicators/indicators.js` file.
  65046. *
  65047. * In TypeScript the type option must always be set.
  65048. *
  65049. * Configuration options for the series are given in three levels:
  65050. *
  65051. * 1. Options for all series in a chart are defined in the
  65052. * plotOptions.series object.
  65053. *
  65054. * 2. Options for all `stochastic` series are defined in
  65055. * plotOptions.stochastic.
  65056. *
  65057. * 3. Options for one single series are given in the series instance array.
  65058. * (see online documentation for example)
  65059. */
  65060. stochastic?: PlotStochasticOptions;
  65061. /**
  65062. * (Highcharts, Highstock) A streamgraph is a type of stacked area graph
  65063. * which is displaced around a central axis, resulting in a flowing, organic
  65064. * shape.
  65065. *
  65066. * In TypeScript the type option must always be set.
  65067. *
  65068. * Configuration options for the series are given in three levels:
  65069. *
  65070. * 1. Options for all series in a chart are defined in the
  65071. * plotOptions.series object.
  65072. *
  65073. * 2. Options for all `streamgraph` series are defined in
  65074. * plotOptions.streamgraph.
  65075. *
  65076. * 3. Options for one single series are given in the series instance array.
  65077. * (see online documentation for example)
  65078. */
  65079. streamgraph?: PlotStreamgraphOptions;
  65080. /**
  65081. * (Highcharts) A Sunburst displays hierarchical data, where a level in the
  65082. * hierarchy is represented by a circle. The center represents the root node
  65083. * of the tree. The visualization bears a resemblance to both treemap and
  65084. * pie charts.
  65085. *
  65086. * In TypeScript the type option must always be set.
  65087. *
  65088. * Configuration options for the series are given in three levels:
  65089. *
  65090. * 1. Options for all series in a chart are defined in the
  65091. * plotOptions.series object.
  65092. *
  65093. * 2. Options for all `sunburst` series are defined in plotOptions.sunburst.
  65094. *
  65095. * 3. Options for one single series are given in the series instance array.
  65096. * (see online documentation for example)
  65097. */
  65098. sunburst?: PlotSunburstOptions;
  65099. /**
  65100. * (Highstock) Supertrend indicator. This series requires the `linkedTo`
  65101. * option to be set and should be loaded after the
  65102. * `stock/indicators/indicators.js` and `stock/indicators/sma.js`.
  65103. *
  65104. * In TypeScript the type option must always be set.
  65105. *
  65106. * Configuration options for the series are given in three levels:
  65107. *
  65108. * 1. Options for all series in a chart are defined in the
  65109. * plotOptions.series object.
  65110. *
  65111. * 2. Options for all `supertrend` series are defined in
  65112. * plotOptions.supertrend.
  65113. *
  65114. * 3. Options for one single series are given in the series instance array.
  65115. * (see online documentation for example)
  65116. */
  65117. supertrend?: PlotSupertrendOptions;
  65118. /**
  65119. * (Highstock) Triple exponential moving average (TEMA) indicator. This
  65120. * series requires `linkedTo` option to be set and should be loaded after
  65121. * the `stock/indicators/indicators.js` and `stock/indicators/ema.js`.
  65122. *
  65123. * In TypeScript the type option must always be set.
  65124. *
  65125. * Configuration options for the series are given in three levels:
  65126. *
  65127. * 1. Options for all series in a chart are defined in the
  65128. * plotOptions.series object.
  65129. *
  65130. * 2. Options for all `tema` series are defined in plotOptions.tema.
  65131. *
  65132. * 3. Options for one single series are given in the series instance array.
  65133. * (see online documentation for example)
  65134. */
  65135. tema?: PlotTemaOptions;
  65136. /**
  65137. * (Highcharts, Highmaps) A tilemap series is a type of heatmap where the
  65138. * tile shapes are configurable.
  65139. *
  65140. * In TypeScript the type option must always be set.
  65141. *
  65142. * Configuration options for the series are given in three levels:
  65143. *
  65144. * 1. Options for all series in a chart are defined in the
  65145. * plotOptions.series object.
  65146. *
  65147. * 2. Options for all `tilemap` series are defined in plotOptions.tilemap.
  65148. *
  65149. * 3. Options for one single series are given in the series instance array.
  65150. * (see online documentation for example)
  65151. */
  65152. tilemap?: PlotTilemapOptions;
  65153. /**
  65154. * (Highcharts) The timeline series presents given events along a drawn
  65155. * line.
  65156. *
  65157. * In TypeScript the type option must always be set.
  65158. *
  65159. * Configuration options for the series are given in three levels:
  65160. *
  65161. * 1. Options for all series in a chart are defined in the
  65162. * plotOptions.series object.
  65163. *
  65164. * 2. Options for all `timeline` series are defined in plotOptions.timeline.
  65165. *
  65166. * 3. Options for one single series are given in the series instance array.
  65167. * (see online documentation for example)
  65168. */
  65169. timeline?: PlotTimelineOptions;
  65170. /**
  65171. * (Highcharts) A treemap displays hierarchical data using nested
  65172. * rectangles. The data can be laid out in varying ways depending on
  65173. * options.
  65174. *
  65175. * In TypeScript the type option must always be set.
  65176. *
  65177. * Configuration options for the series are given in three levels:
  65178. *
  65179. * 1. Options for all series in a chart are defined in the
  65180. * plotOptions.series object.
  65181. *
  65182. * 2. Options for all `treemap` series are defined in plotOptions.treemap.
  65183. *
  65184. * 3. Options for one single series are given in the series instance array.
  65185. * (see online documentation for example)
  65186. */
  65187. treemap?: PlotTreemapOptions;
  65188. /**
  65189. * (Highstock) Trendline (linear regression) fits a straight line to the
  65190. * selected data using a method called the Sum Of Least Squares. This series
  65191. * requires the `linkedTo` option to be set.
  65192. *
  65193. * In TypeScript the type option must always be set.
  65194. *
  65195. * Configuration options for the series are given in three levels:
  65196. *
  65197. * 1. Options for all series in a chart are defined in the
  65198. * plotOptions.series object.
  65199. *
  65200. * 2. Options for all `trendline` series are defined in
  65201. * plotOptions.trendline.
  65202. *
  65203. * 3. Options for one single series are given in the series instance array.
  65204. * (see online documentation for example)
  65205. */
  65206. trendline?: PlotTrendlineOptions;
  65207. /**
  65208. * (Highstock) Triple exponential average (TRIX) oscillator. This series
  65209. * requires `linkedTo` option to be set.
  65210. *
  65211. * Requires https://code.highcharts.com/stock/indicators/ema.js and
  65212. * https://code.highcharts.com/stock/indicators/tema.js.
  65213. *
  65214. * In TypeScript the type option must always be set.
  65215. *
  65216. * Configuration options for the series are given in three levels:
  65217. *
  65218. * 1. Options for all series in a chart are defined in the
  65219. * plotOptions.series object.
  65220. *
  65221. * 2. Options for all `trix` series are defined in plotOptions.trix.
  65222. *
  65223. * 3. Options for one single series are given in the series instance array.
  65224. * (see online documentation for example)
  65225. */
  65226. trix?: PlotTrixOptions;
  65227. /**
  65228. * (Highcharts) A variable pie series is a two dimensional series type,
  65229. * where each point renders an Y and Z value. Each point is drawn as a pie
  65230. * slice where the size (arc) of the slice relates to the Y value and the
  65231. * radius of pie slice relates to the Z value.
  65232. *
  65233. * In TypeScript the type option must always be set.
  65234. *
  65235. * Configuration options for the series are given in three levels:
  65236. *
  65237. * 1. Options for all series in a chart are defined in the
  65238. * plotOptions.series object.
  65239. *
  65240. * 2. Options for all `variablepie` series are defined in
  65241. * plotOptions.variablepie.
  65242. *
  65243. * 3. Options for one single series are given in the series instance array.
  65244. * (see online documentation for example)
  65245. */
  65246. variablepie?: PlotVariablepieOptions;
  65247. /**
  65248. * (Highcharts) A variwide chart (related to marimekko chart) is a column
  65249. * chart with a variable width expressing a third dimension.
  65250. *
  65251. * In TypeScript the type option must always be set.
  65252. *
  65253. * Configuration options for the series are given in three levels:
  65254. *
  65255. * 1. Options for all series in a chart are defined in the
  65256. * plotOptions.series object.
  65257. *
  65258. * 2. Options for all `variwide` series are defined in plotOptions.variwide.
  65259. *
  65260. * 3. Options for one single series are given in the series instance array.
  65261. * (see online documentation for example)
  65262. */
  65263. variwide?: PlotVariwideOptions;
  65264. /**
  65265. * (Highstock) Volume By Price indicator.
  65266. *
  65267. * This series requires `linkedTo` option to be set.
  65268. *
  65269. * In TypeScript the type option must always be set.
  65270. *
  65271. * Configuration options for the series are given in three levels:
  65272. *
  65273. * 1. Options for all series in a chart are defined in the
  65274. * plotOptions.series object.
  65275. *
  65276. * 2. Options for all `vbp` series are defined in plotOptions.vbp.
  65277. *
  65278. * 3. Options for one single series are given in the series instance array.
  65279. * (see online documentation for example)
  65280. */
  65281. vbp?: PlotVbpOptions;
  65282. /**
  65283. * (Highcharts, Highstock) A vector plot is a type of cartesian chart where
  65284. * each point has an X and Y position, a length and a direction. Vectors are
  65285. * drawn as arrows.
  65286. *
  65287. * In TypeScript the type option must always be set.
  65288. *
  65289. * Configuration options for the series are given in three levels:
  65290. *
  65291. * 1. Options for all series in a chart are defined in the
  65292. * plotOptions.series object.
  65293. *
  65294. * 2. Options for all `vector` series are defined in plotOptions.vector.
  65295. *
  65296. * 3. Options for one single series are given in the series instance array.
  65297. * (see online documentation for example)
  65298. */
  65299. vector?: PlotVectorOptions;
  65300. /**
  65301. * (Highcharts) A Venn diagram displays all possible logical relations
  65302. * between a collection of different sets. The sets are represented by
  65303. * circles, and the relation between the sets are displayed by the overlap
  65304. * or lack of overlap between them. The venn diagram is a special case of
  65305. * Euler diagrams, which can also be displayed by this series type.
  65306. *
  65307. * In TypeScript the type option must always be set.
  65308. *
  65309. * Configuration options for the series are given in three levels:
  65310. *
  65311. * 1. Options for all series in a chart are defined in the
  65312. * plotOptions.series object.
  65313. *
  65314. * 2. Options for all `venn` series are defined in plotOptions.venn.
  65315. *
  65316. * 3. Options for one single series are given in the series instance array.
  65317. * (see online documentation for example)
  65318. */
  65319. venn?: PlotVennOptions;
  65320. /**
  65321. * (Highstock) Volume Weighted Average Price indicator.
  65322. *
  65323. * This series requires `linkedTo` option to be set.
  65324. *
  65325. * In TypeScript the type option must always be set.
  65326. *
  65327. * Configuration options for the series are given in three levels:
  65328. *
  65329. * 1. Options for all series in a chart are defined in the
  65330. * plotOptions.series object.
  65331. *
  65332. * 2. Options for all `vwap` series are defined in plotOptions.vwap.
  65333. *
  65334. * 3. Options for one single series are given in the series instance array.
  65335. * (see online documentation for example)
  65336. */
  65337. vwap?: PlotVwapOptions;
  65338. /**
  65339. * (Highcharts) A waterfall chart displays sequentially introduced positive
  65340. * or negative values in cumulative columns.
  65341. *
  65342. * In TypeScript the type option must always be set.
  65343. *
  65344. * Configuration options for the series are given in three levels:
  65345. *
  65346. * 1. Options for all series in a chart are defined in the
  65347. * plotOptions.series object.
  65348. *
  65349. * 2. Options for all `waterfall` series are defined in
  65350. * plotOptions.waterfall.
  65351. *
  65352. * 3. Options for one single series are given in the series instance array.
  65353. * (see online documentation for example)
  65354. */
  65355. waterfall?: PlotWaterfallOptions;
  65356. /**
  65357. * (Highstock) Williams %R. This series requires the `linkedTo` option to be
  65358. * set and should be loaded after the `stock/indicators/indicators.js`.
  65359. *
  65360. * In TypeScript the type option must always be set.
  65361. *
  65362. * Configuration options for the series are given in three levels:
  65363. *
  65364. * 1. Options for all series in a chart are defined in the
  65365. * plotOptions.series object.
  65366. *
  65367. * 2. Options for all `williamsr` series are defined in
  65368. * plotOptions.williamsr.
  65369. *
  65370. * 3. Options for one single series are given in the series instance array.
  65371. * (see online documentation for example)
  65372. */
  65373. williamsr?: PlotWilliamsrOptions;
  65374. /**
  65375. * (Highcharts, Highstock) Wind barbs are a convenient way to represent wind
  65376. * speed and direction in one graphical form. Wind direction is given by the
  65377. * stem direction, and wind speed by the number and shape of barbs.
  65378. *
  65379. * In TypeScript the type option must always be set.
  65380. *
  65381. * Configuration options for the series are given in three levels:
  65382. *
  65383. * 1. Options for all series in a chart are defined in the
  65384. * plotOptions.series object.
  65385. *
  65386. * 2. Options for all `windbarb` series are defined in plotOptions.windbarb.
  65387. *
  65388. * 3. Options for one single series are given in the series instance array.
  65389. * (see online documentation for example)
  65390. */
  65391. windbarb?: PlotWindbarbOptions;
  65392. /**
  65393. * (Highstock) Weighted moving average indicator (WMA). This series requires
  65394. * `linkedTo` option to be set.
  65395. *
  65396. * In TypeScript the type option must always be set.
  65397. *
  65398. * Configuration options for the series are given in three levels:
  65399. *
  65400. * 1. Options for all series in a chart are defined in the
  65401. * plotOptions.series object.
  65402. *
  65403. * 2. Options for all `wma` series are defined in plotOptions.wma.
  65404. *
  65405. * 3. Options for one single series are given in the series instance array.
  65406. * (see online documentation for example)
  65407. */
  65408. wma?: PlotWmaOptions;
  65409. /**
  65410. * (Highcharts) A word cloud is a visualization of a set of words, where the
  65411. * size and placement of a word is determined by how it is weighted.
  65412. *
  65413. * In TypeScript the type option must always be set.
  65414. *
  65415. * Configuration options for the series are given in three levels:
  65416. *
  65417. * 1. Options for all series in a chart are defined in the
  65418. * plotOptions.series object.
  65419. *
  65420. * 2. Options for all `wordcloud` series are defined in
  65421. * plotOptions.wordcloud.
  65422. *
  65423. * 3. Options for one single series are given in the series instance array.
  65424. * (see online documentation for example)
  65425. */
  65426. wordcloud?: PlotWordcloudOptions;
  65427. /**
  65428. * (Highcharts, Highstock, Gantt) The X-range series displays ranges on the
  65429. * X axis, typically time intervals with a start and end date.
  65430. *
  65431. * In TypeScript the type option must always be set.
  65432. *
  65433. * Configuration options for the series are given in three levels:
  65434. *
  65435. * 1. Options for all series in a chart are defined in the
  65436. * plotOptions.series object.
  65437. *
  65438. * 2. Options for all `xrange` series are defined in plotOptions.xrange.
  65439. *
  65440. * 3. Options for one single series are given in the series instance array.
  65441. * (see online documentation for example)
  65442. */
  65443. xrange?: PlotXrangeOptions;
  65444. /**
  65445. * (Highstock) Zig Zag indicator.
  65446. *
  65447. * This series requires `linkedTo` option to be set.
  65448. *
  65449. * In TypeScript the type option must always be set.
  65450. *
  65451. * Configuration options for the series are given in three levels:
  65452. *
  65453. * 1. Options for all series in a chart are defined in the
  65454. * plotOptions.series object.
  65455. *
  65456. * 2. Options for all `zigzag` series are defined in plotOptions.zigzag.
  65457. *
  65458. * 3. Options for one single series are given in the series instance array.
  65459. * (see online documentation for example)
  65460. */
  65461. zigzag?: PlotZigzagOptions;
  65462. }
  65463. /**
  65464. * (Highcharts) Enable or disable the initial animation when a series is
  65465. * displayed. The animation can also be set as a configuration object. Please
  65466. * note that this option only applies to the initial animation of the series
  65467. * itself. For other animations, see chart.animation and the animation parameter
  65468. * under the API methods. The following properties are supported:
  65469. *
  65470. * - `defer`: The animation delay time in milliseconds.
  65471. *
  65472. * - `duration`: The duration of the animation in milliseconds.
  65473. *
  65474. * - `easing`: Can be a string reference to an easing function set on the `Math`
  65475. * object or a function. See the _Custom easing function_ demo below.
  65476. *
  65477. * Due to poor performance, animation is disabled in old IE browsers for several
  65478. * chart types.
  65479. */
  65480. export interface PlotOrganizationAnimationOptions {
  65481. defer?: number;
  65482. }
  65483. /**
  65484. * (Highcharts, Highstock, Highmaps, Gantt) Enable or disable the initial
  65485. * animation when a series is displayed for the `dataLabels`. The animation can
  65486. * also be set as a configuration object. Please note that this option only
  65487. * applies to the initial animation. For other animations, see chart.animation
  65488. * and the animation parameter under the API methods. The following properties
  65489. * are supported:
  65490. *
  65491. * - `defer`: The animation delay time in milliseconds.
  65492. */
  65493. export interface PlotOrganizationDataLabelsAnimationOptions {
  65494. /**
  65495. * (Highcharts, Highstock, Highmaps, Gantt) The animation delay time in
  65496. * milliseconds. Set to `0` renders dataLabel immediately. As `undefined`
  65497. * inherits defer time from the series.animation.defer.
  65498. */
  65499. defer?: number;
  65500. }
  65501. /**
  65502. * (Highcharts, Highstock, Highmaps, Gantt) Enable or disable the initial
  65503. * animation when a series is displayed for the `dataLabels`. The animation can
  65504. * also be set as a configuration object. Please note that this option only
  65505. * applies to the initial animation. For other animations, see chart.animation
  65506. * and the animation parameter under the API methods. The following properties
  65507. * are supported:
  65508. *
  65509. * - `defer`: The animation delay time in milliseconds.
  65510. */
  65511. export interface PlotOrganizationLevelsDataLabelsAnimationOptions {
  65512. /**
  65513. * (Highcharts, Highstock, Highmaps, Gantt) The animation delay time in
  65514. * milliseconds. Set to `0` renders dataLabel immediately. As `undefined`
  65515. * inherits defer time from the series.animation.defer.
  65516. */
  65517. defer?: number;
  65518. }
  65519. /**
  65520. * (Highcharts) Set options on specific levels. Takes precedence over series
  65521. * options, but not node and link options.
  65522. */
  65523. export interface PlotOrganizationLevelsOptions {
  65524. /**
  65525. * (Highcharts) Can set `borderColor` on all nodes which lay on the same
  65526. * level.
  65527. */
  65528. borderColor?: ColorString;
  65529. /**
  65530. * (Highcharts) Can set `borderWidth` on all nodes which lay on the same
  65531. * level.
  65532. */
  65533. borderWidth?: number;
  65534. /**
  65535. * (Highcharts) Can set `color` on all nodes which lay on the same level.
  65536. */
  65537. color?: (ColorString|GradientColorObject|PatternObject);
  65538. /**
  65539. * (Highcharts) Can set `colorByPoint` on all nodes which lay on the same
  65540. * level.
  65541. */
  65542. colorByPoint?: boolean;
  65543. /**
  65544. * (Highcharts, Highstock, Highmaps, Gantt) Can set `dataLabels` on all
  65545. * points which lay on the same level.
  65546. */
  65547. dataLabels?: (SeriesSankeyDataLabelsOptionsObject|Array<SeriesSankeyDataLabelsOptionsObject>);
  65548. /**
  65549. * (Highcharts) Decides which level takes effect from the options set in the
  65550. * levels object.
  65551. */
  65552. level?: number;
  65553. /**
  65554. * (Highcharts) Can set `linkOpacity` on all points which lay on the same
  65555. * level.
  65556. */
  65557. linkOpacity?: number;
  65558. /**
  65559. * (Highcharts) Can set `states` on all nodes and points which lay on the
  65560. * same level.
  65561. */
  65562. states?: SeriesStatesOptionsObject;
  65563. }
  65564. /**
  65565. * (Highcharts) An organization chart is a diagram that shows the structure of
  65566. * an organization and the relationships and relative ranks of its parts and
  65567. * positions.
  65568. *
  65569. * In TypeScript the type option must always be set.
  65570. *
  65571. * Configuration options for the series are given in three levels:
  65572. *
  65573. * 1. Options for all series in a chart are defined in the plotOptions.series
  65574. * object.
  65575. *
  65576. * 2. Options for all `organization` series are defined in
  65577. * plotOptions.organization.
  65578. *
  65579. * 3. Options for one single series are given in the series instance array. (see
  65580. * online documentation for example)
  65581. */
  65582. export interface PlotOrganizationOptions {
  65583. /**
  65584. * (Highcharts) Accessibility options for a series.
  65585. */
  65586. accessibility?: SeriesAccessibilityOptionsObject;
  65587. /**
  65588. * (Highmaps) Whether all areas of the map defined in `mapData` should be
  65589. * rendered. If `true`, areas which don't correspond to a data point, are
  65590. * rendered as `null` points. If `false`, those areas are skipped.
  65591. */
  65592. allAreas?: boolean;
  65593. /**
  65594. * (Highcharts) Enable or disable the initial animation when a series is
  65595. * displayed. The animation can also be set as a configuration object.
  65596. * Please note that this option only applies to the initial animation of the
  65597. * series itself. For other animations, see chart.animation and the
  65598. * animation parameter under the API methods. The following properties are
  65599. * supported:
  65600. *
  65601. * - `defer`: The animation delay time in milliseconds.
  65602. *
  65603. * - `duration`: The duration of the animation in milliseconds.
  65604. *
  65605. * - `easing`: Can be a string reference to an easing function set on the
  65606. * `Math` object or a function. See the _Custom easing function_ demo below.
  65607. *
  65608. * Due to poor performance, animation is disabled in old IE browsers for
  65609. * several chart types.
  65610. */
  65611. animation?: (boolean|PlotOrganizationAnimationOptions|Partial<AnimationOptionsObject>);
  65612. /**
  65613. * (Highcharts, Highstock, Gantt) The border color of the node cards.
  65614. */
  65615. borderColor?: ColorString;
  65616. /**
  65617. * (Highcharts) The border radius of the node cards.
  65618. */
  65619. borderRadius?: number;
  65620. /**
  65621. * (Highcharts, Highstock, Gantt) The width of the border surrounding each
  65622. * column or bar. Defaults to `1` when there is room for a border, but to
  65623. * `0` when the columns are so dense that a border would cover the next
  65624. * column.
  65625. *
  65626. * In styled mode, the stroke width can be set with the `.highcharts-point`
  65627. * rule.
  65628. */
  65629. borderWidth?: number;
  65630. /**
  65631. * (Highcharts, Highstock, Gantt) When `true`, the columns will center in
  65632. * the category, ignoring null or missing points. When `false`, space will
  65633. * be reserved for null or missing points.
  65634. */
  65635. centerInCategory?: boolean;
  65636. /**
  65637. * (Highcharts) An additional class name to apply to the series' graphical
  65638. * elements. This option does not replace default class names of the
  65639. * graphical element.
  65640. */
  65641. className?: string;
  65642. /**
  65643. * (Highcharts) Disable this option to allow series rendering in the whole
  65644. * plotting area.
  65645. *
  65646. * **Note:** Clipping should be always enabled when chart.zoomType is set
  65647. */
  65648. clip?: boolean;
  65649. /**
  65650. * (Highcharts) The main color of the series. In line type series it applies
  65651. * to the line and the point markers unless otherwise specified. In bar type
  65652. * series it applies to the bars unless a color is specified per point. The
  65653. * default value is pulled from the `options.colors` array.
  65654. *
  65655. * In styled mode, the color can be defined by the colorIndex option. Also,
  65656. * the series color can be set with the `.highcharts-series`,
  65657. * `.highcharts-color-{n}`, `.highcharts-{type}-series` or
  65658. * `.highcharts-series-{n}` class, or individual classes given by the
  65659. * `className` option.
  65660. */
  65661. color?: (ColorString|GradientColorObject|PatternObject);
  65662. /**
  65663. * (Highcharts, Highstock, Gantt) When using automatic point colors pulled
  65664. * from the global colors or series-specific plotOptions.column.colors
  65665. * collections, this option determines whether the chart should receive one
  65666. * color per series or one color per point.
  65667. *
  65668. * In styled mode, the `colors` or `series.colors` arrays are not supported,
  65669. * and instead this option gives the points individual color class names on
  65670. * the form `highcharts-color-{n}`.
  65671. */
  65672. colorByPoint?: boolean;
  65673. /**
  65674. * (Highcharts) Styled mode only. A specific color index to use for the
  65675. * series, so its graphic representations are given the class name
  65676. * `highcharts-color-{n}`.
  65677. */
  65678. colorIndex?: number;
  65679. /**
  65680. * (Highcharts, Highstock, Gantt) A series specific or series type specific
  65681. * color set to apply instead of the global colors when colorByPoint is
  65682. * true.
  65683. */
  65684. colors?: Array<(ColorString|GradientColorObject|PatternObject)>;
  65685. /**
  65686. * (Highstock) Compare the values of the series against the first non-null,
  65687. * non- zero value in the visible range. The y axis will show percentage or
  65688. * absolute change depending on whether `compare` is set to `"percent"` or
  65689. * `"value"`. When this is applied to multiple series, it allows comparing
  65690. * the development of the series against each other. Adds a `change` field
  65691. * to every point object.
  65692. */
  65693. compare?: string;
  65694. /**
  65695. * (Highstock) When compare is `percent`, this option dictates whether to
  65696. * use 0 or 100 as the base of comparison.
  65697. */
  65698. compareBase?: (0|100);
  65699. /**
  65700. * (Highstock) Defines if comparison should start from the first point
  65701. * within the visible range or should start from the first point **before**
  65702. * the range.
  65703. *
  65704. * In other words, this flag determines if first point within the visible
  65705. * range will have 0% (`compareStart=true`) or should have been already
  65706. * calculated according to the previous point (`compareStart=false`).
  65707. */
  65708. compareStart?: boolean;
  65709. /**
  65710. * (Gantt) Override Pathfinder connector options for a series. Requires
  65711. * Highcharts Gantt to be loaded.
  65712. */
  65713. connectors?: SeriesConnectorsOptionsObject;
  65714. /**
  65715. * (Highcharts) You can set the cursor to "pointer" if you have click events
  65716. * attached to the series, to signal to the user that the points and lines
  65717. * can be clicked.
  65718. *
  65719. * In styled mode, the series cursor can be set with the same classes as
  65720. * listed under series.color.
  65721. */
  65722. cursor?: (string|CursorValue);
  65723. /**
  65724. * (Highcharts) A reserved subspace to store options and values for
  65725. * customized functionality. Here you can add additional data for your own
  65726. * event callbacks and formatter callbacks.
  65727. */
  65728. custom?: Dictionary<any>;
  65729. /**
  65730. * (Highcharts) Name of the dash style to use for the graph, or for some
  65731. * series types the outline of each shape.
  65732. *
  65733. * In styled mode, the stroke dash-array can be set with the same classes as
  65734. * listed under series.color.
  65735. */
  65736. dashStyle?: DashStyleValue;
  65737. /**
  65738. * (Highstock) Data grouping is the concept of sampling the data values into
  65739. * larger blocks in order to ease readability and increase performance of
  65740. * the JavaScript charts. Highstock by default applies data grouping when
  65741. * the points become closer than a certain pixel value, determined by the
  65742. * `groupPixelWidth` option.
  65743. *
  65744. * If data grouping is applied, the grouping information of grouped points
  65745. * can be read from the Point.dataGroup. If point options other than the
  65746. * data itself are set, for example `name` or `color` or custom properties,
  65747. * the grouping logic doesn't know how to group it. In this case the options
  65748. * of the first point instance are copied over to the group point. This can
  65749. * be altered through a custom `approximation` callback function.
  65750. */
  65751. dataGrouping?: DataGroupingOptionsObject;
  65752. /**
  65753. * (Highcharts, Highstock, Highmaps, Gantt) Options for the data labels
  65754. * appearing on top of the nodes and links. For sankey charts, data labels
  65755. * are visible for the nodes by default, but hidden for links. This is
  65756. * controlled by modifying the `nodeFormat`, and the `format` that applies
  65757. * to links and is an empty string by default.
  65758. */
  65759. dataLabels?: (SeriesOrganizationDataLabelsOptionsObject|Array<SeriesOrganizationDataLabelsOptionsObject>);
  65760. /**
  65761. * (Highcharts) A description of the series to add to the screen reader
  65762. * information about the series.
  65763. */
  65764. description?: string;
  65765. /**
  65766. * (Highcharts) Enable or disable the mouse tracking for a specific series.
  65767. * This includes point tooltips and click events on graphs and points. For
  65768. * large datasets it improves performance.
  65769. */
  65770. enableMouseTracking?: boolean;
  65771. /**
  65772. * (Highcharts) General event handlers for the series items. These event
  65773. * hooks can also be attached to the series at run time using the
  65774. * `Highcharts.addEvent` function.
  65775. */
  65776. events?: SeriesEventsOptionsObject;
  65777. /**
  65778. * (Highcharts, Highstock, Gantt) Whether to use the Y extremes of the total
  65779. * chart width or only the zoomed area when zooming in on parts of the X
  65780. * axis. By default, the Y axis adjusts to the min and max of the visible
  65781. * data. Cartesian series only.
  65782. */
  65783. getExtremesFromAll?: boolean;
  65784. /**
  65785. * (Highcharts) The indentation in pixels of hanging nodes, nodes which
  65786. * parent has layout set to `hanging`.
  65787. */
  65788. hangingIndent?: number;
  65789. /**
  65790. * (Highcharts) When set to `false` will prevent the series data from being
  65791. * included in any form of data export.
  65792. *
  65793. * Since version 6.0.0 until 7.1.0 the option was existing undocumented as
  65794. * `includeInCSVExport`.
  65795. */
  65796. includeInDataExport?: boolean;
  65797. /**
  65798. * (Highmaps) What property to join the `mapData` to the value data. For
  65799. * example, if joinBy is "code", the mapData items with a specific code is
  65800. * merged into the data with the same code. For maps loaded from GeoJSON,
  65801. * the keys may be held in each point's `properties` object.
  65802. *
  65803. * The joinBy option can also be an array of two values, where the first
  65804. * points to a key in the `mapData`, and the second points to another key in
  65805. * the `data`.
  65806. *
  65807. * When joinBy is `null`, the map items are joined by their position in the
  65808. * array, which performs much better in maps with many data points. This is
  65809. * the recommended option if you are printing more than a thousand data
  65810. * points and have a backend that can preprocess the data into a parallel
  65811. * array of the mapData.
  65812. */
  65813. joinBy?: (string|Array<string>);
  65814. /**
  65815. * (Highcharts) An array specifying which option maps to which key in the
  65816. * data point array. This makes it convenient to work with unstructured data
  65817. * arrays from different sources.
  65818. */
  65819. keys?: Array<string>;
  65820. /**
  65821. * (Highcharts, Highstock, Gantt) Series labels are placed as close to the
  65822. * series as possible in a natural way, seeking to avoid other series. The
  65823. * goal of this feature is to make the chart more easily readable, like if a
  65824. * human designer placed the labels in the optimal position.
  65825. *
  65826. * The series labels currently work with series types having a `graph` or an
  65827. * `area`.
  65828. */
  65829. label?: SeriesLabelOptionsObject;
  65830. /**
  65831. * (Highstock) The line marks the last price from all points.
  65832. */
  65833. lastPrice?: SeriesLastPriceOptionsObject;
  65834. /**
  65835. * (Highstock) The line marks the last price from visible range of points.
  65836. */
  65837. lastVisiblePrice?: SeriesLastVisiblePriceOptionsObject;
  65838. /**
  65839. * (Highcharts) Set options on specific levels. Takes precedence over series
  65840. * options, but not node and link options.
  65841. */
  65842. levels?: Array<PlotOrganizationLevelsOptions>;
  65843. /**
  65844. * (Highcharts) The color of the links between nodes.
  65845. */
  65846. linkColor?: ColorString;
  65847. /**
  65848. * (Highcharts, Highstock, Gantt) The id of another series to link to.
  65849. * Additionally, the value can be ":previous" to link to the previous
  65850. * series. When two series are linked, only the first one appears in the
  65851. * legend. Toggling the visibility of this also toggles the linked series.
  65852. *
  65853. * If master series uses data sorting and linked series does not have its
  65854. * own sorting definition, the linked series will be sorted in the same
  65855. * order as the master one.
  65856. */
  65857. linkedTo?: string;
  65858. /**
  65859. * (Highcharts) The line width of the links connecting nodes, in pixels.
  65860. */
  65861. linkLineWidth?: number;
  65862. /**
  65863. * (Highcharts) Opacity for the links between nodes in the sankey diagram.
  65864. */
  65865. linkOpacity?: number;
  65866. /**
  65867. * (Highcharts) Radius for the rounded corners of the links between nodes.
  65868. */
  65869. linkRadius?: number;
  65870. /**
  65871. * (Highcharts) The minimal width for a line of a sankey. By default, 0
  65872. * values are not shown.
  65873. */
  65874. minLinkWidth?: number;
  65875. /**
  65876. * (Highstock) Options for the corresponding navigator series if
  65877. * `showInNavigator` is `true` for this series. Available options are the
  65878. * same as any series, documented at plotOptions and series.
  65879. *
  65880. * These options are merged with options in navigator.series, and will take
  65881. * precedence if the same option is defined both places.
  65882. */
  65883. navigatorOptions?: PlotSeriesOptions;
  65884. /**
  65885. * (Highcharts) The padding between nodes in a sankey diagram or dependency
  65886. * wheel, in pixels.
  65887. *
  65888. * If the number of nodes is so great that it is possible to lay them out
  65889. * within the plot area with the given `nodePadding`, they will be rendered
  65890. * with a smaller padding as a strategy to avoid overflow.
  65891. */
  65892. nodePadding?: number;
  65893. /**
  65894. * (Highcharts) In a horizontal chart, the width of the nodes in pixels.
  65895. * Node that most organization charts are vertical, so the name of this
  65896. * option is counterintuitive.
  65897. */
  65898. nodeWidth?: number;
  65899. /**
  65900. * (Highcharts) Opacity of a series parts: line, fill (e.g. area) and
  65901. * dataLabels.
  65902. */
  65903. opacity?: number;
  65904. /**
  65905. * (Highcharts) Properties for each single point.
  65906. */
  65907. point?: PlotSeriesPointOptions;
  65908. /**
  65909. * (Highcharts) Same as accessibility.pointDescriptionFormatter, but for an
  65910. * individual series. Overrides the chart wide configuration.
  65911. */
  65912. pointDescriptionFormatter?: Function;
  65913. /**
  65914. * (Highcharts) Whether to select the series initially. If `showCheckbox` is
  65915. * true, the checkbox next to the series name in the legend will be checked
  65916. * for a selected series.
  65917. */
  65918. selected?: boolean;
  65919. /**
  65920. * (Highcharts) If true, a checkbox is displayed next to the legend item to
  65921. * allow selecting the series. The state of the checkbox is determined by
  65922. * the `selected` option.
  65923. */
  65924. showCheckbox?: boolean;
  65925. /**
  65926. * (Highcharts) Whether to display this particular series or series type in
  65927. * the legend. Standalone series are shown in legend by default, and linked
  65928. * series are not. Since v7.2.0 it is possible to show series that use
  65929. * colorAxis by setting this option to `true`.
  65930. */
  65931. showInLegend?: boolean;
  65932. /**
  65933. * (Highstock) Whether or not to show the series in the navigator. Takes
  65934. * precedence over navigator.baseSeries if defined.
  65935. */
  65936. showInNavigator?: boolean;
  65937. /**
  65938. * (Highcharts) If set to `true`, the accessibility module will skip past
  65939. * the points in this series for keyboard navigation.
  65940. */
  65941. skipKeyboardNavigation?: boolean;
  65942. states?: SeriesStatesOptionsObject;
  65943. /**
  65944. * (Highcharts) Sticky tracking of mouse events. When true, the `mouseOut`
  65945. * event on a series isn't triggered until the mouse moves over another
  65946. * series, or out of the plot area. When false, the `mouseOut` event on a
  65947. * series is triggered when the mouse leaves the area around the series'
  65948. * graph or markers. This also implies the tooltip when not shared. When
  65949. * `stickyTracking` is false and `tooltip.shared` is false, the tooltip will
  65950. * be hidden when moving the mouse between series. Defaults to true for line
  65951. * and area type series, but to false for columns, pies etc.
  65952. *
  65953. * **Note:** The boost module will force this option because of technical
  65954. * limitations.
  65955. */
  65956. stickyTracking?: boolean;
  65957. /**
  65958. * (Highcharts) A configuration object for the tooltip rendering of each
  65959. * single series. Properties are inherited from tooltip, but only the
  65960. * following properties can be defined on a series level.
  65961. */
  65962. tooltip?: SeriesTooltipOptionsObject;
  65963. /**
  65964. * (Highcharts, Highstock, Gantt) When a series contains a data array that
  65965. * is longer than this, only one dimensional arrays of numbers, or two
  65966. * dimensional arrays with x and y values are allowed. Also, only the first
  65967. * point is tested, and the rest are assumed to be the same format. This
  65968. * saves expensive data checking and indexing in long series. Set it to `0`
  65969. * disable.
  65970. *
  65971. * Note: In boost mode turbo threshold is forced. Only array of numbers or
  65972. * two dimensional arrays are allowed.
  65973. */
  65974. turboThreshold?: number;
  65975. /**
  65976. * (Highcharts) Set the initial visibility of the series.
  65977. */
  65978. visible?: boolean;
  65979. /**
  65980. * (Highmaps) Define the z index of the series.
  65981. */
  65982. zIndex?: number;
  65983. }
  65984. /**
  65985. * (Highcharts) Enable or disable the initial animation when a series is
  65986. * displayed. The animation can also be set as a configuration object. Please
  65987. * note that this option only applies to the initial animation of the series
  65988. * itself. For other animations, see chart.animation and the animation parameter
  65989. * under the API methods. The following properties are supported:
  65990. *
  65991. * - `defer`: The animation delay time in milliseconds.
  65992. *
  65993. * - `duration`: The duration of the animation in milliseconds.
  65994. *
  65995. * - `easing`: Can be a string reference to an easing function set on the `Math`
  65996. * object or a function. See the _Custom easing function_ demo below.
  65997. *
  65998. * Due to poor performance, animation is disabled in old IE browsers for several
  65999. * chart types.
  66000. */
  66001. export interface PlotPackedbubbleAnimationOptions {
  66002. defer?: number;
  66003. }
  66004. /**
  66005. * (Highcharts, Highstock, Highmaps, Gantt) Enable or disable the initial
  66006. * animation when a series is displayed for the `dataLabels`. The animation can
  66007. * also be set as a configuration object. Please note that this option only
  66008. * applies to the initial animation. For other animations, see chart.animation
  66009. * and the animation parameter under the API methods. The following properties
  66010. * are supported:
  66011. *
  66012. * - `defer`: The animation delay time in milliseconds.
  66013. */
  66014. export interface PlotPackedbubbleDataLabelsAnimationOptions {
  66015. /**
  66016. * (Highcharts, Highstock, Highmaps, Gantt) The animation delay time in
  66017. * milliseconds. Set to `0` renders dataLabel immediately. As `undefined`
  66018. * inherits defer time from the series.animation.defer.
  66019. */
  66020. defer?: number;
  66021. }
  66022. /**
  66023. * (Highcharts, Highstock, Highmaps, Gantt) Styles for the label. The default
  66024. * `color` setting is `"contrast"`, which is a pseudo color that Highcharts
  66025. * picks up and applies the maximum contrast to the underlying point item, for
  66026. * example the bar in a bar chart.
  66027. *
  66028. * The `textOutline` is a pseudo property that applies an outline of the given
  66029. * width with the given color, which by default is the maximum contrast to the
  66030. * text. So a bright text color will result in a black text outline for maximum
  66031. * readability on a mixed background. In some cases, especially with grayscale
  66032. * text, the text outline doesn't work well, in which cases it can be disabled
  66033. * by setting it to `"none"`. When `useHTML` is true, the `textOutline` will not
  66034. * be picked up. In this, case, the same effect can be acheived through the
  66035. * `text-shadow` CSS property.
  66036. *
  66037. * For some series types, where each point has an extent, like for example tree
  66038. * maps, the data label may overflow the point. There are two strategies for
  66039. * handling overflow. By default, the text will wrap to multiple lines. The
  66040. * other strategy is to set `style.textOverflow` to `ellipsis`, which will keep
  66041. * the text on one line plus it will break inside long words.
  66042. */
  66043. export interface PlotPackedbubbleDataLabelsStyleOptions {
  66044. transition?: string;
  66045. }
  66046. /**
  66047. * (Highcharts) Options for layout algorithm when simulation is enabled. Inside
  66048. * there are options to change the speed, padding, initial bubbles positions and
  66049. * more.
  66050. */
  66051. export interface PlotPackedbubbleLayoutAlgorithmOptions {
  66052. /**
  66053. * (Highcharts) The distance between two bubbles, when the algorithm starts
  66054. * to treat two bubbles as overlapping. The `bubblePadding` is also the
  66055. * expected distance between all the bubbles on simulation end.
  66056. */
  66057. bubblePadding?: number;
  66058. /**
  66059. * (Highcharts) In case of split series, this option allows user to drag and
  66060. * drop points between series, for changing point related series.
  66061. */
  66062. dragBetweenSeries?: boolean;
  66063. /**
  66064. * (Highcharts) Experimental. Enables live simulation of the algorithm
  66065. * implementation. All nodes are animated as the forces applies on them.
  66066. */
  66067. enableSimulation?: boolean;
  66068. /**
  66069. * (Highcharts) Friction applied on forces to prevent nodes rushing to fast
  66070. * to the desired positions.
  66071. */
  66072. friction?: number;
  66073. /**
  66074. * (Highcharts) Gravitational const used in the barycenter force of the
  66075. * algorithm.
  66076. */
  66077. gravitationalConstant?: number;
  66078. /**
  66079. * (Highcharts) When `initialPositions` are set to 'circle',
  66080. * `initialPositionRadius` is a distance from the center of circle, in which
  66081. * nodes are created.
  66082. */
  66083. initialPositionRadius?: number;
  66084. /**
  66085. * (Highcharts) Initial layout algorithm for positioning nodes. Can be one
  66086. * of the built-in options ("circle", "random") or a function where
  66087. * positions should be set on each node (`this.nodes`) as `node.plotX` and
  66088. * `node.plotY`.
  66089. */
  66090. initialPositions?: ("circle"|"random"|Function);
  66091. /**
  66092. * (Highcharts) Integration type. Available options are `'euler'` and
  66093. * `'verlet'`. Integration determines how forces are applied on particles.
  66094. * In Euler integration, force is applied direct as `newPosition +=
  66095. * velocity;`. In Verlet integration, new position is based on a previous
  66096. * posittion without velocity: `newPosition += previousPosition -
  66097. * newPosition`.
  66098. *
  66099. * Note that different integrations give different results as forces are
  66100. * different.
  66101. *
  66102. * In Highcharts v7.0.x only `'euler'` integration was supported.
  66103. */
  66104. integration?: OptionsIntegrationValue;
  66105. /**
  66106. * (Highcharts) Ideal length (px) of the link between two nodes. When not
  66107. * defined, length is calculated as: `Math.pow(availableWidth *
  66108. * availableHeight / nodesLength, 0.4);`
  66109. *
  66110. * Note: Because of the algorithm specification, length of each link might
  66111. * be not exactly as specified.
  66112. */
  66113. linkLength?: number;
  66114. /**
  66115. * (Highcharts) Max number of iterations before algorithm will stop. In
  66116. * general, algorithm should find positions sooner, but when rendering huge
  66117. * number of nodes, it is recommended to increase this value as finding
  66118. * perfect graph positions can require more time.
  66119. */
  66120. maxIterations?: number;
  66121. /**
  66122. * (Highcharts) Max speed that node can get in one iteration. In terms of
  66123. * simulation, it's a maximum translation (in pixels) that a node can move
  66124. * (in both, x and y, dimensions). While `friction` is applied on all nodes,
  66125. * max speed is applied only for nodes that move very fast, for example
  66126. * small or disconnected ones.
  66127. */
  66128. maxSpeed?: number;
  66129. /**
  66130. * (Highcharts) Whether bubbles should interact with their parentNode to
  66131. * keep them inside.
  66132. */
  66133. parentNodeLimit?: boolean;
  66134. /**
  66135. * (Highcharts) Layout algorithm options for parent nodes.
  66136. */
  66137. parentNodeOptions?: PlotPackedbubbleLayoutAlgorithmParentNodeOptions;
  66138. /**
  66139. * (Highcharts) Whether series should interact with each other or not. When
  66140. * `parentNodeLimit` is set to true, thi option should be set to false to
  66141. * avoid sticking points in wrong series parentNode.
  66142. */
  66143. seriesInteraction?: boolean;
  66144. /**
  66145. * (Highcharts) Whether to split series into individual groups or to mix all
  66146. * series together.
  66147. */
  66148. splitSeries?: string;
  66149. /**
  66150. * (Highcharts) Type of the algorithm used when positioning nodes.
  66151. */
  66152. type?: "reingold-fruchterman";
  66153. }
  66154. /**
  66155. * (Highcharts) Layout algorithm options for parent nodes.
  66156. */
  66157. export interface PlotPackedbubbleLayoutAlgorithmParentNodeOptions {
  66158. /**
  66159. * (Highcharts) Friction applied on forces to prevent nodes rushing to fast
  66160. * to the desired positions.
  66161. */
  66162. friction?: number;
  66163. /**
  66164. * (Highcharts) Gravitational const used in the barycenter force of the
  66165. * algorithm.
  66166. */
  66167. gravitationalConstant?: number;
  66168. /**
  66169. * (Highcharts) When `initialPositions` are set to 'circle',
  66170. * `initialPositionRadius` is a distance from the center of circle, in which
  66171. * nodes are created.
  66172. */
  66173. initialPositionRadius?: number;
  66174. /**
  66175. * (Highcharts) Initial layout algorithm for positioning nodes. Can be one
  66176. * of built-in options ("circle", "random") or a function where positions
  66177. * should be set on each node (`this.nodes`) as `node.plotX` and
  66178. * `node.plotY`
  66179. */
  66180. initialPositions?: ("circle"|"random"|Function);
  66181. /**
  66182. * (Highcharts) Integration type. Available options are `'euler'` and
  66183. * `'verlet'`. Integration determines how forces are applied on particles.
  66184. * In Euler integration, force is applied direct as `newPosition +=
  66185. * velocity;`. In Verlet integration, new position is based on a previous
  66186. * posittion without velocity: `newPosition += previousPosition -
  66187. * newPosition`.
  66188. *
  66189. * Note that different integrations give different results as forces are
  66190. * different.
  66191. *
  66192. * In Highcharts v7.0.x only `'euler'` integration was supported.
  66193. */
  66194. integration?: OptionsIntegrationValue;
  66195. /**
  66196. * (Highcharts) Ideal length (px) of the link between two nodes. When not
  66197. * defined, length is calculated as: `Math.pow(availableWidth *
  66198. * availableHeight / nodesLength, 0.4);`
  66199. *
  66200. * Note: Because of the algorithm specification, length of each link might
  66201. * be not exactly as specified.
  66202. */
  66203. linkLength?: number;
  66204. /**
  66205. * (Highcharts) Styling options for parentNodes markers. Similar to
  66206. * line.marker options.
  66207. */
  66208. marker?: PointMarkerOptionsObject;
  66209. /**
  66210. * (Highcharts) Max number of iterations before algorithm will stop. In
  66211. * general, algorithm should find positions sooner, but when rendering huge
  66212. * number of nodes, it is recommended to increase this value as finding
  66213. * perfect graph positions can require more time.
  66214. */
  66215. maxIterations?: number;
  66216. /**
  66217. * (Highcharts) Verlet integration only. Max speed that node can get in one
  66218. * iteration. In terms of simulation, it's a maximum translation (in pixels)
  66219. * that node can move (in both, x and y, dimensions). While `friction` is
  66220. * applied on all nodes, max speed is applied only for nodes that move very
  66221. * fast, for example small or disconnected ones.
  66222. */
  66223. maxSpeed?: number;
  66224. seriesInteraction?: boolean;
  66225. /**
  66226. * (Highcharts) Type of the algorithm used when positioning nodes.
  66227. */
  66228. type?: "reingold-fruchterman";
  66229. }
  66230. /**
  66231. * (Highcharts) A packed bubble series is a two dimensional series type, where
  66232. * each point renders a value in X, Y position. Each point is drawn as a bubble
  66233. * where the bubbles don't overlap with each other and the radius of the bubble
  66234. * relates to the value.
  66235. *
  66236. * In TypeScript the type option must always be set.
  66237. *
  66238. * Configuration options for the series are given in three levels:
  66239. *
  66240. * 1. Options for all series in a chart are defined in the plotOptions.series
  66241. * object.
  66242. *
  66243. * 2. Options for all `packedbubble` series are defined in
  66244. * plotOptions.packedbubble.
  66245. *
  66246. * 3. Options for one single series are given in the series instance array. (see
  66247. * online documentation for example)
  66248. */
  66249. export interface PlotPackedbubbleOptions {
  66250. /**
  66251. * (Highcharts) Accessibility options for a series.
  66252. */
  66253. accessibility?: SeriesAccessibilityOptionsObject;
  66254. /**
  66255. * (Highmaps) Whether all areas of the map defined in `mapData` should be
  66256. * rendered. If `true`, areas which don't correspond to a data point, are
  66257. * rendered as `null` points. If `false`, those areas are skipped.
  66258. */
  66259. allAreas?: boolean;
  66260. /**
  66261. * (Highcharts) Allow this series' points to be selected by clicking on the
  66262. * graphic (columns, point markers, pie slices, map areas etc).
  66263. *
  66264. * The selected points can be handled by point select and unselect events,
  66265. * or collectively by the getSelectedPoints function.
  66266. *
  66267. * And alternative way of selecting points is through dragging.
  66268. */
  66269. allowPointSelect?: boolean;
  66270. /**
  66271. * (Highcharts) Enable or disable the initial animation when a series is
  66272. * displayed. The animation can also be set as a configuration object.
  66273. * Please note that this option only applies to the initial animation of the
  66274. * series itself. For other animations, see chart.animation and the
  66275. * animation parameter under the API methods. The following properties are
  66276. * supported:
  66277. *
  66278. * - `defer`: The animation delay time in milliseconds.
  66279. *
  66280. * - `duration`: The duration of the animation in milliseconds.
  66281. *
  66282. * - `easing`: Can be a string reference to an easing function set on the
  66283. * `Math` object or a function. See the _Custom easing function_ demo below.
  66284. *
  66285. * Due to poor performance, animation is disabled in old IE browsers for
  66286. * several chart types.
  66287. */
  66288. animation?: (boolean|PlotPackedbubbleAnimationOptions|Partial<AnimationOptionsObject>);
  66289. /**
  66290. * (Highcharts) If there are more points in the series than the
  66291. * `animationLimit`, the animation won't run. Animation affects overall
  66292. * performance and doesn't work well with heavy data series.
  66293. */
  66294. animationLimit?: number;
  66295. /**
  66296. * (Highmaps) The border color of the map areas.
  66297. *
  66298. * In styled mode, the border stroke is given in the `.highcharts-point`
  66299. * class.
  66300. */
  66301. borderColor?: (ColorString|GradientColorObject|PatternObject);
  66302. /**
  66303. * (Highmaps) The border width of each map area.
  66304. *
  66305. * In styled mode, the border stroke width is given in the
  66306. * `.highcharts-point` class.
  66307. */
  66308. borderWidth?: number;
  66309. /**
  66310. * (Highcharts) An additional class name to apply to the series' graphical
  66311. * elements. This option does not replace default class names of the
  66312. * graphical element.
  66313. */
  66314. className?: string;
  66315. /**
  66316. * (Highcharts) Disable this option to allow series rendering in the whole
  66317. * plotting area.
  66318. *
  66319. * **Note:** Clipping should be always enabled when chart.zoomType is set
  66320. */
  66321. clip?: boolean;
  66322. /**
  66323. * (Highcharts) The main color of the series. In line type series it applies
  66324. * to the line and the point markers unless otherwise specified. In bar type
  66325. * series it applies to the bars unless a color is specified per point. The
  66326. * default value is pulled from the `options.colors` array.
  66327. *
  66328. * In styled mode, the color can be defined by the colorIndex option. Also,
  66329. * the series color can be set with the `.highcharts-series`,
  66330. * `.highcharts-color-{n}`, `.highcharts-{type}-series` or
  66331. * `.highcharts-series-{n}` class, or individual classes given by the
  66332. * `className` option.
  66333. */
  66334. color?: (ColorString|GradientColorObject|PatternObject);
  66335. /**
  66336. * (Highcharts, Highstock, Highmaps) When using dual or multiple color axes,
  66337. * this number defines which colorAxis the particular series is connected
  66338. * to. It refers to either the axis id or the index of the axis in the
  66339. * colorAxis array, with 0 being the first. Set this option to false to
  66340. * prevent a series from connecting to the default color axis.
  66341. *
  66342. * Since v7.2.0 the option can also be an axis id or an axis index instead
  66343. * of a boolean flag.
  66344. */
  66345. colorAxis?: (boolean|number|string);
  66346. /**
  66347. * (Highcharts) Styled mode only. A specific color index to use for the
  66348. * series, so its graphic representations are given the class name
  66349. * `highcharts-color-{n}`.
  66350. */
  66351. colorIndex?: number;
  66352. /**
  66353. * (Highcharts, Highstock, Highmaps) Determines what data value should be
  66354. * used to calculate point color if `colorAxis` is used. Requires to set
  66355. * `min` and `max` if some custom point property is used or if approximation
  66356. * for data grouping is set to `'sum'`.
  66357. */
  66358. colorKey?: string;
  66359. /**
  66360. * (Highstock) Compare the values of the series against the first non-null,
  66361. * non- zero value in the visible range. The y axis will show percentage or
  66362. * absolute change depending on whether `compare` is set to `"percent"` or
  66363. * `"value"`. When this is applied to multiple series, it allows comparing
  66364. * the development of the series against each other. Adds a `change` field
  66365. * to every point object.
  66366. */
  66367. compare?: string;
  66368. /**
  66369. * (Highstock) When compare is `percent`, this option dictates whether to
  66370. * use 0 or 100 as the base of comparison.
  66371. */
  66372. compareBase?: (0|100);
  66373. /**
  66374. * (Highstock) Defines if comparison should start from the first point
  66375. * within the visible range or should start from the first point **before**
  66376. * the range.
  66377. *
  66378. * In other words, this flag determines if first point within the visible
  66379. * range will have 0% (`compareStart=true`) or should have been already
  66380. * calculated according to the previous point (`compareStart=false`).
  66381. */
  66382. compareStart?: boolean;
  66383. /**
  66384. * (Gantt) Override Pathfinder connector options for a series. Requires
  66385. * Highcharts Gantt to be loaded.
  66386. */
  66387. connectors?: SeriesConnectorsOptionsObject;
  66388. /**
  66389. * (Highcharts, Highstock, Gantt) When true, each point or column edge is
  66390. * rounded to its nearest pixel in order to render sharp on screen. In some
  66391. * cases, when there are a lot of densely packed columns, this leads to
  66392. * visible difference in column widths or distance between columns. In these
  66393. * cases, setting `crisp` to `false` may look better, even though each
  66394. * column is rendered blurry.
  66395. */
  66396. crisp?: boolean;
  66397. /**
  66398. * (Highcharts) You can set the cursor to "pointer" if you have click events
  66399. * attached to the series, to signal to the user that the points and lines
  66400. * can be clicked.
  66401. *
  66402. * In styled mode, the series cursor can be set with the same classes as
  66403. * listed under series.color.
  66404. */
  66405. cursor?: (string|CursorValue);
  66406. /**
  66407. * (Highcharts) A reserved subspace to store options and values for
  66408. * customized functionality. Here you can add additional data for your own
  66409. * event callbacks and formatter callbacks.
  66410. */
  66411. custom?: Dictionary<any>;
  66412. /**
  66413. * (Highcharts) Name of the dash style to use for the graph, or for some
  66414. * series types the outline of each shape.
  66415. *
  66416. * In styled mode, the stroke dash-array can be set with the same classes as
  66417. * listed under series.color.
  66418. */
  66419. dashStyle?: DashStyleValue;
  66420. /**
  66421. * (Highstock) Data grouping is the concept of sampling the data values into
  66422. * larger blocks in order to ease readability and increase performance of
  66423. * the JavaScript charts. Highstock by default applies data grouping when
  66424. * the points become closer than a certain pixel value, determined by the
  66425. * `groupPixelWidth` option.
  66426. *
  66427. * If data grouping is applied, the grouping information of grouped points
  66428. * can be read from the Point.dataGroup. If point options other than the
  66429. * data itself are set, for example `name` or `color` or custom properties,
  66430. * the grouping logic doesn't know how to group it. In this case the options
  66431. * of the first point instance are copied over to the group point. This can
  66432. * be altered through a custom `approximation` callback function.
  66433. */
  66434. dataGrouping?: DataGroupingOptionsObject;
  66435. /**
  66436. * (Highcharts, Highstock, Highmaps, Gantt) Options for the series data
  66437. * labels, appearing next to each data point.
  66438. *
  66439. * Since v6.2.0, multiple data labels can be applied to each single point by
  66440. * defining them as an array of configs.
  66441. *
  66442. * In styled mode, the data labels can be styled with the
  66443. * `.highcharts-data-label-box` and `.highcharts-data-label` class names
  66444. * (see example).
  66445. */
  66446. dataLabels?: (SeriesPackedBubbleDataLabelsOptionsObject|Array<SeriesPackedBubbleDataLabelsOptionsObject>);
  66447. /**
  66448. * (Highcharts) A description of the series to add to the screen reader
  66449. * information about the series.
  66450. */
  66451. description?: string;
  66452. /**
  66453. * (Highcharts) Whether to display negative sized bubbles. The threshold is
  66454. * given by the zThreshold option, and negative bubbles can be visualized by
  66455. * setting negativeColor.
  66456. */
  66457. displayNegative?: boolean;
  66458. /**
  66459. * (Highcharts) Flag to determine if nodes are draggable or not. Available
  66460. * for graph with useSimulation set to true only.
  66461. */
  66462. draggable?: boolean;
  66463. /**
  66464. * (Highcharts) Enable or disable the mouse tracking for a specific series.
  66465. * This includes point tooltips and click events on graphs and points. For
  66466. * large datasets it improves performance.
  66467. */
  66468. enableMouseTracking?: boolean;
  66469. /**
  66470. * (Highcharts) General event handlers for the series items. These event
  66471. * hooks can also be attached to the series at run time using the
  66472. * `Highcharts.addEvent` function.
  66473. */
  66474. events?: SeriesEventsOptionsObject;
  66475. /**
  66476. * (Highcharts) Determines whether the series should look for the nearest
  66477. * point in both dimensions or just the x-dimension when hovering the
  66478. * series. Defaults to `'xy'` for scatter series and `'x'` for most other
  66479. * series. If the data has duplicate x-values, it is recommended to set this
  66480. * to `'xy'` to allow hovering over all points.
  66481. *
  66482. * Applies only to series types using nearest neighbor search (not direct
  66483. * hover) for tooltip.
  66484. */
  66485. findNearestPointBy?: OptionsFindNearestPointByValue;
  66486. /**
  66487. * (Highstock) Defines when to display a gap in the graph, together with the
  66488. * gapUnit option.
  66489. *
  66490. * In case when `dataGrouping` is enabled, points can be grouped into a
  66491. * larger time span. This can make the grouped points to have a greater
  66492. * distance than the absolute value of `gapSize` property, which will result
  66493. * in disappearing graph completely. To prevent this situation the mentioned
  66494. * distance between grouped points is used instead of previously defined
  66495. * `gapSize`.
  66496. *
  66497. * In practice, this option is most often used to visualize gaps in time
  66498. * series. In a stock chart, intraday data is available for daytime hours,
  66499. * while gaps will appear in nights and weekends.
  66500. */
  66501. gapSize?: number;
  66502. /**
  66503. * (Highstock) Together with gapSize, this option defines where to draw gaps
  66504. * in the graph.
  66505. *
  66506. * When the `gapUnit` is `"relative"` (default), a gap size of 5 means that
  66507. * if the distance between two points is greater than 5 times that of the
  66508. * two closest points, the graph will be broken.
  66509. *
  66510. * When the `gapUnit` is `"value"`, the gap is based on absolute axis
  66511. * values, which on a datetime axis is milliseconds. This also applies to
  66512. * the navigator series that inherits gap options from the base series.
  66513. */
  66514. gapUnit?: OptionsGapUnitValue;
  66515. /**
  66516. * (Highcharts, Highstock, Gantt) Whether to use the Y extremes of the total
  66517. * chart width or only the zoomed area when zooming in on parts of the X
  66518. * axis. By default, the Y axis adjusts to the min and max of the visible
  66519. * data. Cartesian series only.
  66520. */
  66521. getExtremesFromAll?: boolean;
  66522. /**
  66523. * (Highcharts) When set to `false` will prevent the series data from being
  66524. * included in any form of data export.
  66525. *
  66526. * Since version 6.0.0 until 7.1.0 the option was existing undocumented as
  66527. * `includeInCSVExport`.
  66528. */
  66529. includeInDataExport?: boolean;
  66530. /**
  66531. * (Highmaps) What property to join the `mapData` to the value data. For
  66532. * example, if joinBy is "code", the mapData items with a specific code is
  66533. * merged into the data with the same code. For maps loaded from GeoJSON,
  66534. * the keys may be held in each point's `properties` object.
  66535. *
  66536. * The joinBy option can also be an array of two values, where the first
  66537. * points to a key in the `mapData`, and the second points to another key in
  66538. * the `data`.
  66539. *
  66540. * When joinBy is `null`, the map items are joined by their position in the
  66541. * array, which performs much better in maps with many data points. This is
  66542. * the recommended option if you are printing more than a thousand data
  66543. * points and have a backend that can preprocess the data into a parallel
  66544. * array of the mapData.
  66545. */
  66546. joinBy?: (string|Array<string>);
  66547. /**
  66548. * (Highcharts, Highstock, Gantt) Series labels are placed as close to the
  66549. * series as possible in a natural way, seeking to avoid other series. The
  66550. * goal of this feature is to make the chart more easily readable, like if a
  66551. * human designer placed the labels in the optimal position.
  66552. *
  66553. * The series labels currently work with series types having a `graph` or an
  66554. * `area`.
  66555. */
  66556. label?: SeriesLabelOptionsObject;
  66557. /**
  66558. * (Highstock) The line marks the last price from all points.
  66559. */
  66560. lastPrice?: SeriesLastPriceOptionsObject;
  66561. /**
  66562. * (Highstock) The line marks the last price from visible range of points.
  66563. */
  66564. lastVisiblePrice?: SeriesLastVisiblePriceOptionsObject;
  66565. /**
  66566. * (Highcharts) Options for layout algorithm when simulation is enabled.
  66567. * Inside there are options to change the speed, padding, initial bubbles
  66568. * positions and more.
  66569. */
  66570. layoutAlgorithm?: PlotPackedbubbleLayoutAlgorithmOptions;
  66571. /**
  66572. * (Highcharts, Highstock) The SVG value used for the `stroke-linecap` and
  66573. * `stroke-linejoin` of a line graph. Round means that lines are rounded in
  66574. * the ends and bends.
  66575. */
  66576. linecap?: SeriesLinecapValue;
  66577. /**
  66578. * (Highcharts, Highstock) The width of the line connecting the data points.
  66579. */
  66580. lineWidth?: number;
  66581. /**
  66582. * (Highcharts, Highstock, Gantt) The id of another series to link to.
  66583. * Additionally, the value can be ":previous" to link to the previous
  66584. * series. When two series are linked, only the first one appears in the
  66585. * legend. Toggling the visibility of this also toggles the linked series.
  66586. *
  66587. * If master series uses data sorting and linked series does not have its
  66588. * own sorting definition, the linked series will be sorted in the same
  66589. * order as the master one.
  66590. */
  66591. linkedTo?: string;
  66592. /**
  66593. * (Highcharts) Options for the point markers of line-like series.
  66594. * Properties like `fillColor`, `lineColor` and `lineWidth` define the
  66595. * visual appearance of the markers. Other series types, like column series,
  66596. * don't have markers, but have visual options on the series level instead.
  66597. *
  66598. * In styled mode, the markers can be styled with the `.highcharts-point`,
  66599. * `.highcharts-point-hover` and `.highcharts-point-select` class names.
  66600. */
  66601. marker?: PointMarkerOptionsObject;
  66602. /**
  66603. * (Highcharts, Highstock) Maximum bubble size. Bubbles will automatically
  66604. * size between the `minSize` and `maxSize` to reflect the value of each
  66605. * bubble. Can be either pixels (when no unit is given), or a percentage of
  66606. * the smallest one of the plot width and height, divided by the square root
  66607. * of total number of points.
  66608. */
  66609. maxSize?: (number|string);
  66610. /**
  66611. * (Highcharts, Highstock) Minimum bubble size. Bubbles will automatically
  66612. * size between the `minSize` and `maxSize` to reflect the value of each
  66613. * bubble. Can be either pixels (when no unit is given), or a percentage of
  66614. * the smallest one of the plot width and height, divided by the square root
  66615. * of total number of points.
  66616. */
  66617. minSize?: (number|string);
  66618. /**
  66619. * (Highstock) Options for the corresponding navigator series if
  66620. * `showInNavigator` is `true` for this series. Available options are the
  66621. * same as any series, documented at plotOptions and series.
  66622. *
  66623. * These options are merged with options in navigator.series, and will take
  66624. * precedence if the same option is defined both places.
  66625. */
  66626. navigatorOptions?: PlotSeriesOptions;
  66627. /**
  66628. * (Highcharts) When a point's Z value is below the zThreshold setting, this
  66629. * color is used.
  66630. */
  66631. negativeColor?: (ColorString|GradientColorObject|PatternObject);
  66632. /**
  66633. * (Highcharts) Opacity of a series parts: line, fill (e.g. area) and
  66634. * dataLabels.
  66635. */
  66636. opacity?: number;
  66637. /**
  66638. * (Highcharts) Series options for parent nodes.
  66639. */
  66640. parentNode?: PlotPackedbubbleParentNodeOptions;
  66641. /**
  66642. * (Highcharts) Properties for each single point.
  66643. */
  66644. point?: PlotSeriesPointOptions;
  66645. /**
  66646. * (Highcharts) Same as accessibility.pointDescriptionFormatter, but for an
  66647. * individual series. Overrides the chart wide configuration.
  66648. */
  66649. pointDescriptionFormatter?: Function;
  66650. /**
  66651. * (Highcharts, Highstock, Gantt) If no x values are given for the points in
  66652. * a series, `pointInterval` defines the interval of the x values. For
  66653. * example, if a series contains one value every decade starting from year
  66654. * 0, set `pointInterval` to `10`. In true `datetime` axes, the
  66655. * `pointInterval` is set in milliseconds.
  66656. *
  66657. * It can be also be combined with `pointIntervalUnit` to draw irregular
  66658. * time intervals.
  66659. *
  66660. * Please note that this options applies to the _series data_, not the
  66661. * interval of the axis ticks, which is independent.
  66662. */
  66663. pointInterval?: number;
  66664. /**
  66665. * (Highcharts, Highstock, Gantt) On datetime series, this allows for
  66666. * setting the pointInterval to irregular time units, `day`, `month` and
  66667. * `year`. A day is usually the same as 24 hours, but `pointIntervalUnit`
  66668. * also takes the DST crossover into consideration when dealing with local
  66669. * time. Combine this option with `pointInterval` to draw weeks, quarters, 6
  66670. * months, 10 years etc.
  66671. *
  66672. * Please note that this options applies to the _series data_, not the
  66673. * interval of the axis ticks, which is independent.
  66674. */
  66675. pointIntervalUnit?: OptionsPointIntervalUnitValue;
  66676. /**
  66677. * (Highstock) The width of each point on the x axis. For example in a
  66678. * column chart with one value each day, the pointRange would be 1 day (= 24
  66679. * * 3600
  66680. *
  66681. * * 1000 milliseconds). This is normally computed automatically, but this
  66682. * option can be used to override the automatic value.
  66683. */
  66684. pointRange?: number;
  66685. /**
  66686. * (Highcharts, Highstock, Gantt) If no x values are given for the points in
  66687. * a series, pointStart defines on what value to start. For example, if a
  66688. * series contains one yearly value starting from 1945, set pointStart to
  66689. * 1945.
  66690. */
  66691. pointStart?: number;
  66692. /**
  66693. * (Highcharts) Whether to select the series initially. If `showCheckbox` is
  66694. * true, the checkbox next to the series name in the legend will be checked
  66695. * for a selected series.
  66696. */
  66697. selected?: boolean;
  66698. /**
  66699. * (Highcharts) If true, a checkbox is displayed next to the legend item to
  66700. * allow selecting the series. The state of the checkbox is determined by
  66701. * the `selected` option.
  66702. */
  66703. showCheckbox?: boolean;
  66704. /**
  66705. * (Highcharts) Whether to display this particular series or series type in
  66706. * the legend. Standalone series are shown in legend by default, and linked
  66707. * series are not. Since v7.2.0 it is possible to show series that use
  66708. * colorAxis by setting this option to `true`.
  66709. */
  66710. showInLegend?: boolean;
  66711. /**
  66712. * (Highstock) Whether or not to show the series in the navigator. Takes
  66713. * precedence over navigator.baseSeries if defined.
  66714. */
  66715. showInNavigator?: boolean;
  66716. /**
  66717. * (Highcharts) Whether the bubble's value should be represented by the area
  66718. * or the width of the bubble. The default, `area`, corresponds best to the
  66719. * human perception of the size of each bubble.
  66720. */
  66721. sizeBy?: string;
  66722. /**
  66723. * (Highcharts) If set to `true`, the accessibility module will skip past
  66724. * the points in this series for keyboard navigation.
  66725. */
  66726. skipKeyboardNavigation?: boolean;
  66727. /**
  66728. * (Highcharts) When this is true, the series will not cause the Y axis to
  66729. * cross the zero plane (or threshold option) unless the data actually
  66730. * crosses the plane.
  66731. *
  66732. * For example, if `softThreshold` is `false`, a series of 0, 1, 2, 3 will
  66733. * make the Y axis show negative values according to the `minPadding`
  66734. * option. If `softThreshold` is `true`, the Y axis starts at 0.
  66735. */
  66736. softThreshold?: boolean;
  66737. /**
  66738. * (Highcharts, Highstock) Whether to stack the values of each series on top
  66739. * of each other. Possible values are `undefined` to disable, `"normal"` to
  66740. * stack by value or `"percent"`.
  66741. *
  66742. * When stacking is enabled, data must be sorted in ascending X order.
  66743. *
  66744. * Some stacking options are related to specific series types. In the
  66745. * streamgraph series type, the stacking option is set to `"stream"`. The
  66746. * second one is `"overlap"`, which only applies to waterfall series.
  66747. */
  66748. stacking?: OptionsStackingValue;
  66749. states?: SeriesStatesOptionsObject;
  66750. /**
  66751. * (Highcharts, Highstock) Sticky tracking of mouse events. When true, the
  66752. * `mouseOut` event on a series isn't triggered until the mouse moves over
  66753. * another series, or out of the plot area. When false, the `mouseOut` event
  66754. * on a series is triggered when the mouse leaves the area around the
  66755. * series' graph or markers. This also implies the tooltip. When
  66756. * `stickyTracking` is false and `tooltip.shared` is false, the tooltip will
  66757. * be hidden when moving the mouse between series.
  66758. */
  66759. stickyTracking?: boolean;
  66760. /**
  66761. * (Highcharts, Highstock) The threshold, also called zero level or base
  66762. * level. For line type series this is only used in conjunction with
  66763. * negativeColor.
  66764. */
  66765. threshold?: (number|null);
  66766. /**
  66767. * (Highcharts, Highstock) A configuration object for the tooltip rendering
  66768. * of each single series. Properties are inherited from tooltip. Overridable
  66769. * properties are `headerFormat`, `pointFormat`, `yDecimals`, `xDateFormat`,
  66770. * `yPrefix` and `ySuffix`. Unlike other series, in a scatter plot the
  66771. * series.name by default shows in the headerFormat and point.x and point.y
  66772. * in the pointFormat.
  66773. */
  66774. tooltip?: SeriesTooltipOptionsObject;
  66775. /**
  66776. * (Highcharts, Highstock, Gantt) When a series contains a data array that
  66777. * is longer than this, only one dimensional arrays of numbers, or two
  66778. * dimensional arrays with x and y values are allowed. Also, only the first
  66779. * point is tested, and the rest are assumed to be the same format. This
  66780. * saves expensive data checking and indexing in long series. Set it to `0`
  66781. * disable.
  66782. *
  66783. * Note: In boost mode turbo threshold is forced. Only array of numbers or
  66784. * two dimensional arrays are allowed.
  66785. */
  66786. turboThreshold?: number;
  66787. /**
  66788. * (Highcharts) An option is giving a possibility to choose between using
  66789. * simulation for calculating bubble positions. These reflects in both
  66790. * animation and final position of bubbles. Simulation is also adding
  66791. * options to the series graph based on used layout. In case of big data
  66792. * sets, with any performance issues, it is possible to disable animation
  66793. * and pack bubble in a simple circular way.
  66794. */
  66795. useSimulation?: boolean;
  66796. /**
  66797. * (Highcharts) Set the initial visibility of the series.
  66798. */
  66799. visible?: boolean;
  66800. /**
  66801. * (Highmaps) Define the z index of the series.
  66802. */
  66803. zIndex?: number;
  66804. /**
  66805. * (Highcharts, Highstock) Defines the Axis on which the zones are applied.
  66806. */
  66807. zoneAxis?: string;
  66808. /**
  66809. * (Highcharts, Highstock) An array defining zones within a series. Zones
  66810. * can be applied to the X axis, Y axis or Z axis for bubbles, according to
  66811. * the `zoneAxis` option. The zone definitions have to be in ascending order
  66812. * regarding to the value.
  66813. *
  66814. * In styled mode, the color zones are styled with the
  66815. * `.highcharts-zone-{n}` class, or custom classed from the `className`
  66816. * option (view live demo).
  66817. */
  66818. zones?: Array<SeriesZonesOptionsObject>;
  66819. /**
  66820. * (Highcharts) When displayNegative is `false`, bubbles with lower Z values
  66821. * are skipped. When `displayNegative` is `true` and a negativeColor is
  66822. * given, points with lower Z is colored.
  66823. */
  66824. zThreshold?: number;
  66825. }
  66826. /**
  66827. * (Highcharts) Series options for parent nodes.
  66828. */
  66829. export interface PlotPackedbubbleParentNodeOptions {
  66830. /**
  66831. * (Highcharts) Allow this series' parent nodes to be selected by clicking
  66832. * on the graph.
  66833. */
  66834. allowPointSelect?: boolean;
  66835. }
  66836. /**
  66837. * (Highcharts) Enable or disable the initial animation when a series is
  66838. * displayed. The animation can also be set as a configuration object. Please
  66839. * note that this option only applies to the initial animation of the series
  66840. * itself. For other animations, see chart.animation and the animation parameter
  66841. * under the API methods. The following properties are supported:
  66842. *
  66843. * - `defer`: The animation delay time in milliseconds.
  66844. *
  66845. * - `duration`: The duration of the animation in milliseconds.
  66846. *
  66847. * - `easing`: Can be a string reference to an easing function set on the `Math`
  66848. * object or a function. See the _Custom easing function_ demo below.
  66849. *
  66850. * Due to poor performance, animation is disabled in old IE browsers for several
  66851. * chart types.
  66852. */
  66853. export interface PlotParetoAnimationOptions {
  66854. defer?: number;
  66855. }
  66856. /**
  66857. * (Highcharts, Highstock, Highmaps, Gantt) Enable or disable the initial
  66858. * animation when a series is displayed for the `dataLabels`. The animation can
  66859. * also be set as a configuration object. Please note that this option only
  66860. * applies to the initial animation. For other animations, see chart.animation
  66861. * and the animation parameter under the API methods. The following properties
  66862. * are supported:
  66863. *
  66864. * - `defer`: The animation delay time in milliseconds.
  66865. */
  66866. export interface PlotParetoDataLabelsAnimationOptions {
  66867. /**
  66868. * (Highcharts, Highstock, Highmaps, Gantt) The animation delay time in
  66869. * milliseconds. Set to `0` renders dataLabel immediately. As `undefined`
  66870. * inherits defer time from the series.animation.defer.
  66871. */
  66872. defer?: number;
  66873. }
  66874. /**
  66875. * (Highcharts, Highstock, Highmaps, Gantt) Options for the series data labels,
  66876. * appearing next to each data point.
  66877. *
  66878. * Since v6.2.0, multiple data labels can be applied to each single point by
  66879. * defining them as an array of configs.
  66880. *
  66881. * In styled mode, the data labels can be styled with the
  66882. * `.highcharts-data-label-box` and `.highcharts-data-label` class names (see
  66883. * example).
  66884. */
  66885. export interface PlotParetoDataLabelsOptions {
  66886. /**
  66887. * (Highcharts, Highstock, Highmaps, Gantt) The alignment of the data label
  66888. * compared to the point. If `right`, the right side of the label should be
  66889. * touching the point. For points with an extent, like columns, the
  66890. * alignments also dictates how to align it inside the box, as given with
  66891. * the inside option. Can be one of `left`, `center` or `right`.
  66892. */
  66893. align?: (AlignValue|null);
  66894. /**
  66895. * (Highcharts, Highstock, Highmaps, Gantt) Whether to allow data labels to
  66896. * overlap. To make the labels less sensitive for overlapping, the
  66897. * dataLabels.padding can be set to 0.
  66898. */
  66899. allowOverlap?: boolean;
  66900. /**
  66901. * (Highcharts, Highstock, Highmaps, Gantt) Enable or disable the initial
  66902. * animation when a series is displayed for the `dataLabels`. The animation
  66903. * can also be set as a configuration object. Please note that this option
  66904. * only applies to the initial animation. For other animations, see
  66905. * chart.animation and the animation parameter under the API methods. The
  66906. * following properties are supported:
  66907. *
  66908. * - `defer`: The animation delay time in milliseconds.
  66909. */
  66910. animation?: (boolean|PlotParetoDataLabelsAnimationOptions|Partial<AnimationOptionsObject>);
  66911. /**
  66912. * (Highcharts, Highstock, Highmaps, Gantt) The background color or gradient
  66913. * for the data label.
  66914. */
  66915. backgroundColor?: (ColorString|GradientColorObject|PatternObject);
  66916. /**
  66917. * (Highcharts, Highstock, Highmaps, Gantt) The border color for the data
  66918. * label. Defaults to `undefined`.
  66919. */
  66920. borderColor?: (ColorString|GradientColorObject|PatternObject);
  66921. /**
  66922. * (Highcharts, Highstock, Highmaps, Gantt) The border radius in pixels for
  66923. * the data label.
  66924. */
  66925. borderRadius?: number;
  66926. /**
  66927. * (Highcharts, Highstock, Highmaps, Gantt) The border width in pixels for
  66928. * the data label.
  66929. */
  66930. borderWidth?: number;
  66931. /**
  66932. * (Highcharts, Highstock, Highmaps, Gantt) A class name for the data label.
  66933. * Particularly in styled mode, this can be used to give each series' or
  66934. * point's data label unique styling. In addition to this option, a default
  66935. * color class name is added so that we can give the labels a contrast text
  66936. * shadow.
  66937. */
  66938. className?: string;
  66939. /**
  66940. * (Highcharts, Highstock, Highmaps, Gantt) The text color for the data
  66941. * labels. Defaults to `undefined`. For certain series types, like column or
  66942. * map, the data labels can be drawn inside the points. In this case the
  66943. * data label will be drawn with maximum contrast by default. Additionally,
  66944. * it will be given a `text-outline` style with the opposite color, to
  66945. * further increase the contrast. This can be overridden by setting the
  66946. * `text-outline` style to `none` in the `dataLabels.style` option.
  66947. */
  66948. color?: (ColorString|GradientColorObject|PatternObject);
  66949. /**
  66950. * (Highcharts, Highstock, Highmaps, Gantt) Whether to hide data labels that
  66951. * are outside the plot area. By default, the data label is moved inside the
  66952. * plot area according to the overflow option.
  66953. */
  66954. crop?: boolean;
  66955. /**
  66956. * (Highcharts, Highstock, Gantt) Whether to defer displaying the data
  66957. * labels until the initial series animation has finished. Setting to
  66958. * `false` renders the data label immediately. If set to `true` inherits the
  66959. * defer time set in plotOptions.series.animation.
  66960. */
  66961. defer?: boolean;
  66962. /**
  66963. * (Highcharts, Highstock, Highmaps, Gantt) Enable or disable the data
  66964. * labels.
  66965. */
  66966. enabled?: boolean;
  66967. /**
  66968. * (Highcharts, Highstock, Highmaps, Gantt) A declarative filter to control
  66969. * of which data labels to display. The declarative filter is designed for
  66970. * use when callback functions are not available, like when the chart
  66971. * options require a pure JSON structure or for use with graphical editors.
  66972. * For programmatic control, use the `formatter` instead, and return
  66973. * `undefined` to disable a single data label.
  66974. */
  66975. filter?: DataLabelsFilterOptionsObject;
  66976. /**
  66977. * (Highcharts, Highstock, Highmaps, Gantt) A format string for the data
  66978. * label. Available variables are the same as for `formatter`.
  66979. */
  66980. format?: string;
  66981. /**
  66982. * (Highcharts, Highstock, Highmaps, Gantt) Callback JavaScript function to
  66983. * format the data label. Note that if a `format` is defined, the format
  66984. * takes precedence and the formatter is ignored.
  66985. */
  66986. formatter?: DataLabelsFormatterCallbackFunction;
  66987. /**
  66988. * (Highcharts, Highstock, Highmaps, Gantt) For points with an extent, like
  66989. * columns or map areas, whether to align the data label inside the box or
  66990. * to the actual value point. Defaults to `false` in most cases, `true` in
  66991. * stacked columns.
  66992. */
  66993. inside?: boolean;
  66994. /**
  66995. * (Highcharts, Highstock, Highmaps, Gantt) Format for points with the value
  66996. * of null. Works analogously to format. `nullFormat` can be applied only to
  66997. * series which support displaying null points.
  66998. */
  66999. nullFormat?: (boolean|string);
  67000. /**
  67001. * (Highcharts, Highstock, Highmaps, Gantt) Callback JavaScript function
  67002. * that defines formatting for points with the value of null. Works
  67003. * analogously to formatter. `nullPointFormatter` can be applied only to
  67004. * series which support displaying null points.
  67005. */
  67006. nullFormatter?: DataLabelsFormatterCallbackFunction;
  67007. /**
  67008. * (Highcharts, Highstock, Highmaps, Gantt) How to handle data labels that
  67009. * flow outside the plot area. The default is `"justify"`, which aligns them
  67010. * inside the plot area. For columns and bars, this means it will be moved
  67011. * inside the bar. To display data labels outside the plot area, set `crop`
  67012. * to `false` and `overflow` to `"allow"`.
  67013. */
  67014. overflow?: DataLabelsOverflowValue;
  67015. /**
  67016. * (Highcharts, Highstock, Highmaps, Gantt) When either the `borderWidth` or
  67017. * the `backgroundColor` is set, this is the padding within the box.
  67018. */
  67019. padding?: number;
  67020. /**
  67021. * (Highcharts, Highstock, Highmaps, Gantt) Aligns data labels relative to
  67022. * points. If `center` alignment is not possible, it defaults to `right`.
  67023. */
  67024. position?: AlignValue;
  67025. /**
  67026. * (Highcharts, Highstock, Highmaps, Gantt) Text rotation in degrees. Note
  67027. * that due to a more complex structure, backgrounds, borders and padding
  67028. * will be lost on a rotated data label.
  67029. */
  67030. rotation?: number;
  67031. /**
  67032. * (Highcharts, Highstock, Highmaps, Gantt) The shadow of the box. Works
  67033. * best with `borderWidth` or `backgroundColor`. Since 2.3 the shadow can be
  67034. * an object configuration containing `color`, `offsetX`, `offsetY`,
  67035. * `opacity` and `width`.
  67036. */
  67037. shadow?: (boolean|ShadowOptionsObject);
  67038. /**
  67039. * (Highcharts, Highstock, Highmaps, Gantt) The name of a symbol to use for
  67040. * the border around the label. Symbols are predefined functions on the
  67041. * Renderer object.
  67042. */
  67043. shape?: string;
  67044. /**
  67045. * (Highcharts, Highstock, Highmaps, Gantt) Styles for the label. The
  67046. * default `color` setting is `"contrast"`, which is a pseudo color that
  67047. * Highcharts picks up and applies the maximum contrast to the underlying
  67048. * point item, for example the bar in a bar chart.
  67049. *
  67050. * The `textOutline` is a pseudo property that applies an outline of the
  67051. * given width with the given color, which by default is the maximum
  67052. * contrast to the text. So a bright text color will result in a black text
  67053. * outline for maximum readability on a mixed background. In some cases,
  67054. * especially with grayscale text, the text outline doesn't work well, in
  67055. * which cases it can be disabled by setting it to `"none"`. When `useHTML`
  67056. * is true, the `textOutline` will not be picked up. In this, case, the same
  67057. * effect can be acheived through the `text-shadow` CSS property.
  67058. *
  67059. * For some series types, where each point has an extent, like for example
  67060. * tree maps, the data label may overflow the point. There are two
  67061. * strategies for handling overflow. By default, the text will wrap to
  67062. * multiple lines. The other strategy is to set `style.textOverflow` to
  67063. * `ellipsis`, which will keep the text on one line plus it will break
  67064. * inside long words.
  67065. */
  67066. style?: CSSObject;
  67067. /**
  67068. * (Highcharts, Highstock, Highmaps, Gantt) Options for a label text which
  67069. * should follow marker's shape. Border and background are disabled for a
  67070. * label that follows a path.
  67071. *
  67072. * **Note:** Only SVG-based renderer supports this option. Setting `useHTML`
  67073. * to true will disable this option.
  67074. */
  67075. textPath?: DataLabelsTextPathOptionsObject;
  67076. /**
  67077. * (Highcharts, Highstock, Highmaps, Gantt) Whether to use HTML to render
  67078. * the labels.
  67079. */
  67080. useHTML?: boolean;
  67081. /**
  67082. * (Highcharts, Highstock, Highmaps, Gantt) The vertical alignment of a data
  67083. * label. Can be one of `top`, `middle` or `bottom`. The default value
  67084. * depends on the data, for instance in a column chart, the label is above
  67085. * positive values and below negative values.
  67086. */
  67087. verticalAlign?: (VerticalAlignValue|null);
  67088. /**
  67089. * (Highcharts, Highstock, Highmaps, Gantt) The x position offset of the
  67090. * label relative to the point in pixels.
  67091. */
  67092. x?: number;
  67093. /**
  67094. * (Highcharts, Highstock, Highmaps, Gantt) The y position offset of the
  67095. * label relative to the point in pixels.
  67096. */
  67097. y?: number;
  67098. /**
  67099. * (Highcharts, Highstock, Highmaps, Gantt) The Z index of the data labels.
  67100. * The default Z index puts it above the series. Use a Z index of 2 to
  67101. * display it behind the series.
  67102. */
  67103. z?: number;
  67104. }
  67105. /**
  67106. * (Highcharts, Highstock) Options for the series data sorting.
  67107. */
  67108. export interface PlotParetoDataSortingOptions {
  67109. /**
  67110. * (Highcharts, Highstock) Enable or disable data sorting for the series.
  67111. * Use xAxis.reversed to change the sorting order.
  67112. */
  67113. enabled?: boolean;
  67114. /**
  67115. * (Highcharts, Highstock) Whether to allow matching points by name in an
  67116. * update. If this option is disabled, points will be matched by order.
  67117. */
  67118. matchByName?: boolean;
  67119. /**
  67120. * (Highcharts, Highstock) Determines what data value should be used to sort
  67121. * by.
  67122. */
  67123. sortKey?: string;
  67124. }
  67125. /**
  67126. * (Highcharts) A pareto diagram is a type of chart that contains both bars and
  67127. * a line graph, where individual values are represented in descending order by
  67128. * bars, and the cumulative total is represented by the line.
  67129. *
  67130. * In TypeScript the type option must always be set.
  67131. *
  67132. * Configuration options for the series are given in three levels:
  67133. *
  67134. * 1. Options for all series in a chart are defined in the plotOptions.series
  67135. * object.
  67136. *
  67137. * 2. Options for all `pareto` series are defined in plotOptions.pareto.
  67138. *
  67139. * 3. Options for one single series are given in the series instance array. (see
  67140. * online documentation for example)
  67141. */
  67142. export interface PlotParetoOptions {
  67143. /**
  67144. * (Highcharts) Accessibility options for a series.
  67145. */
  67146. accessibility?: SeriesAccessibilityOptionsObject;
  67147. /**
  67148. * (Highcharts) Allow this series' points to be selected by clicking on the
  67149. * graphic (columns, point markers, pie slices, map areas etc).
  67150. *
  67151. * The selected points can be handled by point select and unselect events,
  67152. * or collectively by the getSelectedPoints function.
  67153. *
  67154. * And alternative way of selecting points is through dragging.
  67155. */
  67156. allowPointSelect?: boolean;
  67157. /**
  67158. * (Highcharts) Enable or disable the initial animation when a series is
  67159. * displayed. The animation can also be set as a configuration object.
  67160. * Please note that this option only applies to the initial animation of the
  67161. * series itself. For other animations, see chart.animation and the
  67162. * animation parameter under the API methods. The following properties are
  67163. * supported:
  67164. *
  67165. * - `defer`: The animation delay time in milliseconds.
  67166. *
  67167. * - `duration`: The duration of the animation in milliseconds.
  67168. *
  67169. * - `easing`: Can be a string reference to an easing function set on the
  67170. * `Math` object or a function. See the _Custom easing function_ demo below.
  67171. *
  67172. * Due to poor performance, animation is disabled in old IE browsers for
  67173. * several chart types.
  67174. */
  67175. animation?: (boolean|PlotParetoAnimationOptions|Partial<AnimationOptionsObject>);
  67176. /**
  67177. * (Highcharts) For some series, there is a limit that shuts down initial
  67178. * animation by default when the total number of points in the chart is too
  67179. * high. For example, for a column chart and its derivatives, animation does
  67180. * not run if there is more than 250 points totally. To disable this cap,
  67181. * set `animationLimit` to `Infinity`.
  67182. */
  67183. animationLimit?: number;
  67184. /**
  67185. * (Highcharts) An additional class name to apply to the series' graphical
  67186. * elements. This option does not replace default class names of the
  67187. * graphical element.
  67188. */
  67189. className?: string;
  67190. /**
  67191. * (Highcharts) Disable this option to allow series rendering in the whole
  67192. * plotting area.
  67193. *
  67194. * **Note:** Clipping should be always enabled when chart.zoomType is set
  67195. */
  67196. clip?: boolean;
  67197. /**
  67198. * (Highcharts) The main color of the series. In line type series it applies
  67199. * to the line and the point markers unless otherwise specified. In bar type
  67200. * series it applies to the bars unless a color is specified per point. The
  67201. * default value is pulled from the `options.colors` array.
  67202. *
  67203. * In styled mode, the color can be defined by the colorIndex option. Also,
  67204. * the series color can be set with the `.highcharts-series`,
  67205. * `.highcharts-color-{n}`, `.highcharts-{type}-series` or
  67206. * `.highcharts-series-{n}` class, or individual classes given by the
  67207. * `className` option.
  67208. */
  67209. color?: (ColorString|GradientColorObject|PatternObject);
  67210. /**
  67211. * (Highcharts) Styled mode only. A specific color index to use for the
  67212. * series, so its graphic representations are given the class name
  67213. * `highcharts-color-{n}`.
  67214. */
  67215. colorIndex?: number;
  67216. /**
  67217. * (Highcharts, Highstock, Highmaps) Determines what data value should be
  67218. * used to calculate point color if `colorAxis` is used. Requires to set
  67219. * `min` and `max` if some custom point property is used or if approximation
  67220. * for data grouping is set to `'sum'`.
  67221. */
  67222. colorKey?: string;
  67223. /**
  67224. * (Highstock) Compare the values of the series against the first non-null,
  67225. * non- zero value in the visible range. The y axis will show percentage or
  67226. * absolute change depending on whether `compare` is set to `"percent"` or
  67227. * `"value"`. When this is applied to multiple series, it allows comparing
  67228. * the development of the series against each other. Adds a `change` field
  67229. * to every point object.
  67230. */
  67231. compare?: string;
  67232. /**
  67233. * (Highstock) When compare is `percent`, this option dictates whether to
  67234. * use 0 or 100 as the base of comparison.
  67235. */
  67236. compareBase?: (0|100);
  67237. /**
  67238. * (Highstock) Defines if comparison should start from the first point
  67239. * within the visible range or should start from the first point **before**
  67240. * the range.
  67241. *
  67242. * In other words, this flag determines if first point within the visible
  67243. * range will have 0% (`compareStart=true`) or should have been already
  67244. * calculated according to the previous point (`compareStart=false`).
  67245. */
  67246. compareStart?: boolean;
  67247. /**
  67248. * (Highcharts) Polar charts only. Whether to connect the ends of a line
  67249. * series plot across the extremes.
  67250. */
  67251. connectEnds?: boolean;
  67252. /**
  67253. * (Highcharts, Highstock) Whether to connect a graph line across null
  67254. * points, or render a gap between the two points on either side of the
  67255. * null.
  67256. */
  67257. connectNulls?: boolean;
  67258. /**
  67259. * (Gantt) Override Pathfinder connector options for a series. Requires
  67260. * Highcharts Gantt to be loaded.
  67261. */
  67262. connectors?: SeriesConnectorsOptionsObject;
  67263. /**
  67264. * (Highcharts, Highstock) When the series contains less points than the
  67265. * crop threshold, all points are drawn, even if the points fall outside the
  67266. * visible plot area at the current zoom. The advantage of drawing all
  67267. * points (including markers and columns), is that animation is performed on
  67268. * updates. On the other hand, when the series contains more points than the
  67269. * crop threshold, the series data is cropped to only contain points that
  67270. * fall within the plot area. The advantage of cropping away invisible
  67271. * points is to increase performance on large series.
  67272. */
  67273. cropThreshold?: number;
  67274. /**
  67275. * (Highcharts) You can set the cursor to "pointer" if you have click events
  67276. * attached to the series, to signal to the user that the points and lines
  67277. * can be clicked.
  67278. *
  67279. * In styled mode, the series cursor can be set with the same classes as
  67280. * listed under series.color.
  67281. */
  67282. cursor?: (string|CursorValue);
  67283. /**
  67284. * (Highcharts) A reserved subspace to store options and values for
  67285. * customized functionality. Here you can add additional data for your own
  67286. * event callbacks and formatter callbacks.
  67287. */
  67288. custom?: Dictionary<any>;
  67289. /**
  67290. * (Highcharts) Name of the dash style to use for the graph, or for some
  67291. * series types the outline of each shape.
  67292. *
  67293. * In styled mode, the stroke dash-array can be set with the same classes as
  67294. * listed under series.color.
  67295. */
  67296. dashStyle?: DashStyleValue;
  67297. /**
  67298. * (Highstock) Data grouping is the concept of sampling the data values into
  67299. * larger blocks in order to ease readability and increase performance of
  67300. * the JavaScript charts. Highstock by default applies data grouping when
  67301. * the points become closer than a certain pixel value, determined by the
  67302. * `groupPixelWidth` option.
  67303. *
  67304. * If data grouping is applied, the grouping information of grouped points
  67305. * can be read from the Point.dataGroup. If point options other than the
  67306. * data itself are set, for example `name` or `color` or custom properties,
  67307. * the grouping logic doesn't know how to group it. In this case the options
  67308. * of the first point instance are copied over to the group point. This can
  67309. * be altered through a custom `approximation` callback function.
  67310. */
  67311. dataGrouping?: DataGroupingOptionsObject;
  67312. /**
  67313. * (Highcharts, Highstock, Highmaps, Gantt) Options for the series data
  67314. * labels, appearing next to each data point.
  67315. *
  67316. * Since v6.2.0, multiple data labels can be applied to each single point by
  67317. * defining them as an array of configs.
  67318. *
  67319. * In styled mode, the data labels can be styled with the
  67320. * `.highcharts-data-label-box` and `.highcharts-data-label` class names
  67321. * (see example).
  67322. */
  67323. dataLabels?: (PlotParetoDataLabelsOptions|Array<PlotParetoDataLabelsOptions>);
  67324. /**
  67325. * (Highcharts, Highstock) Options for the series data sorting.
  67326. */
  67327. dataSorting?: (DataSortingOptionsObject|PlotParetoDataSortingOptions);
  67328. /**
  67329. * (Highcharts) A description of the series to add to the screen reader
  67330. * information about the series.
  67331. */
  67332. description?: string;
  67333. /**
  67334. * (Highcharts) Enable or disable the mouse tracking for a specific series.
  67335. * This includes point tooltips and click events on graphs and points. For
  67336. * large datasets it improves performance.
  67337. */
  67338. enableMouseTracking?: boolean;
  67339. /**
  67340. * (Highcharts) General event handlers for the series items. These event
  67341. * hooks can also be attached to the series at run time using the
  67342. * `Highcharts.addEvent` function.
  67343. */
  67344. events?: SeriesEventsOptionsObject;
  67345. /**
  67346. * (Highcharts, Highstock, Gantt) Whether to use the Y extremes of the total
  67347. * chart width or only the zoomed area when zooming in on parts of the X
  67348. * axis. By default, the Y axis adjusts to the min and max of the visible
  67349. * data. Cartesian series only.
  67350. */
  67351. getExtremesFromAll?: boolean;
  67352. /**
  67353. * (Highcharts) When set to `false` will prevent the series data from being
  67354. * included in any form of data export.
  67355. *
  67356. * Since version 6.0.0 until 7.1.0 the option was existing undocumented as
  67357. * `includeInCSVExport`.
  67358. */
  67359. includeInDataExport?: boolean;
  67360. /**
  67361. * (Highmaps) What property to join the `mapData` to the value data. For
  67362. * example, if joinBy is "code", the mapData items with a specific code is
  67363. * merged into the data with the same code. For maps loaded from GeoJSON,
  67364. * the keys may be held in each point's `properties` object.
  67365. *
  67366. * The joinBy option can also be an array of two values, where the first
  67367. * points to a key in the `mapData`, and the second points to another key in
  67368. * the `data`.
  67369. *
  67370. * When joinBy is `null`, the map items are joined by their position in the
  67371. * array, which performs much better in maps with many data points. This is
  67372. * the recommended option if you are printing more than a thousand data
  67373. * points and have a backend that can preprocess the data into a parallel
  67374. * array of the mapData.
  67375. */
  67376. joinBy?: (string|Array<string>);
  67377. /**
  67378. * (Highcharts, Highstock, Gantt) Series labels are placed as close to the
  67379. * series as possible in a natural way, seeking to avoid other series. The
  67380. * goal of this feature is to make the chart more easily readable, like if a
  67381. * human designer placed the labels in the optimal position.
  67382. *
  67383. * The series labels currently work with series types having a `graph` or an
  67384. * `area`.
  67385. */
  67386. label?: SeriesLabelOptionsObject;
  67387. /**
  67388. * (Highstock) The line marks the last price from all points.
  67389. */
  67390. lastPrice?: SeriesLastPriceOptionsObject;
  67391. /**
  67392. * (Highstock) The line marks the last price from visible range of points.
  67393. */
  67394. lastVisiblePrice?: SeriesLastVisiblePriceOptionsObject;
  67395. /**
  67396. * (Highcharts, Highstock) The SVG value used for the `stroke-linecap` and
  67397. * `stroke-linejoin` of a line graph. Round means that lines are rounded in
  67398. * the ends and bends.
  67399. */
  67400. linecap?: SeriesLinecapValue;
  67401. /**
  67402. * (Highcharts, Highstock) Pixel width of the graph line.
  67403. */
  67404. lineWidth?: number;
  67405. /**
  67406. * (Highcharts, Highstock, Gantt) The id of another series to link to.
  67407. * Additionally, the value can be ":previous" to link to the previous
  67408. * series. When two series are linked, only the first one appears in the
  67409. * legend. Toggling the visibility of this also toggles the linked series.
  67410. *
  67411. * If master series uses data sorting and linked series does not have its
  67412. * own sorting definition, the linked series will be sorted in the same
  67413. * order as the master one.
  67414. */
  67415. linkedTo?: string;
  67416. /**
  67417. * (Highcharts) Options for the point markers of line-like series.
  67418. * Properties like `fillColor`, `lineColor` and `lineWidth` define the
  67419. * visual appearance of the markers. Other series types, like column series,
  67420. * don't have markers, but have visual options on the series level instead.
  67421. *
  67422. * In styled mode, the markers can be styled with the `.highcharts-point`,
  67423. * `.highcharts-point-hover` and `.highcharts-point-select` class names.
  67424. */
  67425. marker?: PointMarkerOptionsObject;
  67426. /**
  67427. * (Highstock) Options for the corresponding navigator series if
  67428. * `showInNavigator` is `true` for this series. Available options are the
  67429. * same as any series, documented at plotOptions and series.
  67430. *
  67431. * These options are merged with options in navigator.series, and will take
  67432. * precedence if the same option is defined both places.
  67433. */
  67434. navigatorOptions?: PlotSeriesOptions;
  67435. /**
  67436. * (Highcharts) Opacity of a series parts: line, fill (e.g. area) and
  67437. * dataLabels.
  67438. */
  67439. opacity?: number;
  67440. /**
  67441. * (Highcharts) Properties for each single point.
  67442. */
  67443. point?: PlotSeriesPointOptions;
  67444. /**
  67445. * (Highcharts) Same as accessibility.pointDescriptionFormatter, but for an
  67446. * individual series. Overrides the chart wide configuration.
  67447. */
  67448. pointDescriptionFormatter?: Function;
  67449. /**
  67450. * (Highcharts) Whether to select the series initially. If `showCheckbox` is
  67451. * true, the checkbox next to the series name in the legend will be checked
  67452. * for a selected series.
  67453. */
  67454. selected?: boolean;
  67455. /**
  67456. * (Highcharts) If true, a checkbox is displayed next to the legend item to
  67457. * allow selecting the series. The state of the checkbox is determined by
  67458. * the `selected` option.
  67459. */
  67460. showCheckbox?: boolean;
  67461. /**
  67462. * (Highcharts) Whether to display this particular series or series type in
  67463. * the legend. Standalone series are shown in legend by default, and linked
  67464. * series are not. Since v7.2.0 it is possible to show series that use
  67465. * colorAxis by setting this option to `true`.
  67466. */
  67467. showInLegend?: boolean;
  67468. /**
  67469. * (Highstock) Whether or not to show the series in the navigator. Takes
  67470. * precedence over navigator.baseSeries if defined.
  67471. */
  67472. showInNavigator?: boolean;
  67473. /**
  67474. * (Highcharts) If set to `true`, the accessibility module will skip past
  67475. * the points in this series for keyboard navigation.
  67476. */
  67477. skipKeyboardNavigation?: boolean;
  67478. states?: SeriesStatesOptionsObject;
  67479. /**
  67480. * (Highcharts) Sticky tracking of mouse events. When true, the `mouseOut`
  67481. * event on a series isn't triggered until the mouse moves over another
  67482. * series, or out of the plot area. When false, the `mouseOut` event on a
  67483. * series is triggered when the mouse leaves the area around the series'
  67484. * graph or markers. This also implies the tooltip when not shared. When
  67485. * `stickyTracking` is false and `tooltip.shared` is false, the tooltip will
  67486. * be hidden when moving the mouse between series. Defaults to true for line
  67487. * and area type series, but to false for columns, pies etc.
  67488. *
  67489. * **Note:** The boost module will force this option because of technical
  67490. * limitations.
  67491. */
  67492. stickyTracking?: boolean;
  67493. /**
  67494. * (Highcharts) A configuration object for the tooltip rendering of each
  67495. * single series. Properties are inherited from tooltip, but only the
  67496. * following properties can be defined on a series level.
  67497. */
  67498. tooltip?: SeriesTooltipOptionsObject;
  67499. /**
  67500. * (Highcharts, Highstock, Gantt) When a series contains a data array that
  67501. * is longer than this, only one dimensional arrays of numbers, or two
  67502. * dimensional arrays with x and y values are allowed. Also, only the first
  67503. * point is tested, and the rest are assumed to be the same format. This
  67504. * saves expensive data checking and indexing in long series. Set it to `0`
  67505. * disable.
  67506. *
  67507. * Note: In boost mode turbo threshold is forced. Only array of numbers or
  67508. * two dimensional arrays are allowed.
  67509. */
  67510. turboThreshold?: number;
  67511. /**
  67512. * (Highstock) The parameter allows setting line series type and use OHLC
  67513. * indicators. Data in OHLC format is required.
  67514. */
  67515. useOhlcData?: boolean;
  67516. /**
  67517. * (Highcharts) Set the initial visibility of the series.
  67518. */
  67519. visible?: boolean;
  67520. /**
  67521. * (Highmaps) Higher zIndex than column series to draw line above shapes.
  67522. */
  67523. zIndex?: number;
  67524. }
  67525. /**
  67526. * (Highstock) Enable or disable the initial animation when a series is
  67527. * displayed. The animation can also be set as a configuration object. Please
  67528. * note that this option only applies to the initial animation of the series
  67529. * itself. For other animations, see chart.animation and the animation parameter
  67530. * under the API methods. The following properties are supported:
  67531. *
  67532. * - `defer`: The animation delay time in milliseconds.
  67533. *
  67534. * - `duration`: The duration of the animation in milliseconds.
  67535. *
  67536. * - `easing`: Can be a string reference to an easing function set on the `Math`
  67537. * object or a function. See the _Custom easing function_ demo below.
  67538. *
  67539. * Due to poor performance, animation is disabled in old IE browsers for several
  67540. * chart types.
  67541. */
  67542. export interface PlotPcAnimationOptions {
  67543. defer?: number;
  67544. }
  67545. export interface PlotPcBottomLineOptions {
  67546. styles?: PlotPcBottomLineStylesOptions;
  67547. }
  67548. export interface PlotPcBottomLineStylesOptions {
  67549. /**
  67550. * (Highstock) Color of the bottom line. If not set, it's inherited from
  67551. * plotOptions.pc.color.
  67552. */
  67553. lineColor?: ColorString;
  67554. /**
  67555. * (Highstock) Pixel width of the line.
  67556. */
  67557. lineWidth?: number;
  67558. }
  67559. /**
  67560. * (Highcharts, Highstock, Highmaps, Gantt) Enable or disable the initial
  67561. * animation when a series is displayed for the `dataLabels`. The animation can
  67562. * also be set as a configuration object. Please note that this option only
  67563. * applies to the initial animation. For other animations, see chart.animation
  67564. * and the animation parameter under the API methods. The following properties
  67565. * are supported:
  67566. *
  67567. * - `defer`: The animation delay time in milliseconds.
  67568. */
  67569. export interface PlotPcDataLabelsAnimationOptions {
  67570. /**
  67571. * (Highcharts, Highstock, Highmaps, Gantt) The animation delay time in
  67572. * milliseconds. Set to `0` renders dataLabel immediately. As `undefined`
  67573. * inherits defer time from the series.animation.defer.
  67574. */
  67575. defer?: number;
  67576. }
  67577. /**
  67578. * (Highcharts, Highstock, Highmaps, Gantt) Options for the series data labels,
  67579. * appearing next to each data point.
  67580. *
  67581. * Since v6.2.0, multiple data labels can be applied to each single point by
  67582. * defining them as an array of configs.
  67583. *
  67584. * In styled mode, the data labels can be styled with the
  67585. * `.highcharts-data-label-box` and `.highcharts-data-label` class names (see
  67586. * example).
  67587. */
  67588. export interface PlotPcDataLabelsOptions {
  67589. /**
  67590. * (Highcharts, Highstock, Highmaps, Gantt) The alignment of the data label
  67591. * compared to the point. If `right`, the right side of the label should be
  67592. * touching the point. For points with an extent, like columns, the
  67593. * alignments also dictates how to align it inside the box, as given with
  67594. * the inside option. Can be one of `left`, `center` or `right`.
  67595. */
  67596. align?: (AlignValue|null);
  67597. /**
  67598. * (Highcharts, Highstock, Highmaps, Gantt) Whether to allow data labels to
  67599. * overlap. To make the labels less sensitive for overlapping, the
  67600. * dataLabels.padding can be set to 0.
  67601. */
  67602. allowOverlap?: boolean;
  67603. /**
  67604. * (Highcharts, Highstock, Highmaps, Gantt) Enable or disable the initial
  67605. * animation when a series is displayed for the `dataLabels`. The animation
  67606. * can also be set as a configuration object. Please note that this option
  67607. * only applies to the initial animation. For other animations, see
  67608. * chart.animation and the animation parameter under the API methods. The
  67609. * following properties are supported:
  67610. *
  67611. * - `defer`: The animation delay time in milliseconds.
  67612. */
  67613. animation?: (boolean|PlotPcDataLabelsAnimationOptions|Partial<AnimationOptionsObject>);
  67614. /**
  67615. * (Highcharts, Highstock, Highmaps, Gantt) The background color or gradient
  67616. * for the data label.
  67617. */
  67618. backgroundColor?: (ColorString|GradientColorObject|PatternObject);
  67619. /**
  67620. * (Highcharts, Highstock, Highmaps, Gantt) The border color for the data
  67621. * label. Defaults to `undefined`.
  67622. */
  67623. borderColor?: (ColorString|GradientColorObject|PatternObject);
  67624. /**
  67625. * (Highcharts, Highstock, Highmaps, Gantt) The border radius in pixels for
  67626. * the data label.
  67627. */
  67628. borderRadius?: number;
  67629. /**
  67630. * (Highcharts, Highstock, Highmaps, Gantt) The border width in pixels for
  67631. * the data label.
  67632. */
  67633. borderWidth?: number;
  67634. /**
  67635. * (Highcharts, Highstock, Highmaps, Gantt) A class name for the data label.
  67636. * Particularly in styled mode, this can be used to give each series' or
  67637. * point's data label unique styling. In addition to this option, a default
  67638. * color class name is added so that we can give the labels a contrast text
  67639. * shadow.
  67640. */
  67641. className?: string;
  67642. /**
  67643. * (Highcharts, Highstock, Highmaps, Gantt) The text color for the data
  67644. * labels. Defaults to `undefined`. For certain series types, like column or
  67645. * map, the data labels can be drawn inside the points. In this case the
  67646. * data label will be drawn with maximum contrast by default. Additionally,
  67647. * it will be given a `text-outline` style with the opposite color, to
  67648. * further increase the contrast. This can be overridden by setting the
  67649. * `text-outline` style to `none` in the `dataLabels.style` option.
  67650. */
  67651. color?: (ColorString|GradientColorObject|PatternObject);
  67652. /**
  67653. * (Highcharts, Highstock, Highmaps, Gantt) Whether to hide data labels that
  67654. * are outside the plot area. By default, the data label is moved inside the
  67655. * plot area according to the overflow option.
  67656. */
  67657. crop?: boolean;
  67658. /**
  67659. * (Highcharts, Highstock, Gantt) Whether to defer displaying the data
  67660. * labels until the initial series animation has finished. Setting to
  67661. * `false` renders the data label immediately. If set to `true` inherits the
  67662. * defer time set in plotOptions.series.animation.
  67663. */
  67664. defer?: boolean;
  67665. /**
  67666. * (Highcharts, Highstock, Highmaps, Gantt) Enable or disable the data
  67667. * labels.
  67668. */
  67669. enabled?: boolean;
  67670. /**
  67671. * (Highcharts, Highstock, Highmaps, Gantt) A declarative filter to control
  67672. * of which data labels to display. The declarative filter is designed for
  67673. * use when callback functions are not available, like when the chart
  67674. * options require a pure JSON structure or for use with graphical editors.
  67675. * For programmatic control, use the `formatter` instead, and return
  67676. * `undefined` to disable a single data label.
  67677. */
  67678. filter?: DataLabelsFilterOptionsObject;
  67679. /**
  67680. * (Highcharts, Highstock, Highmaps, Gantt) A format string for the data
  67681. * label. Available variables are the same as for `formatter`.
  67682. */
  67683. format?: string;
  67684. /**
  67685. * (Highcharts, Highstock, Highmaps, Gantt) Callback JavaScript function to
  67686. * format the data label. Note that if a `format` is defined, the format
  67687. * takes precedence and the formatter is ignored.
  67688. */
  67689. formatter?: DataLabelsFormatterCallbackFunction;
  67690. /**
  67691. * (Highcharts, Highstock, Highmaps, Gantt) For points with an extent, like
  67692. * columns or map areas, whether to align the data label inside the box or
  67693. * to the actual value point. Defaults to `false` in most cases, `true` in
  67694. * stacked columns.
  67695. */
  67696. inside?: boolean;
  67697. /**
  67698. * (Highcharts, Highstock, Highmaps, Gantt) Format for points with the value
  67699. * of null. Works analogously to format. `nullFormat` can be applied only to
  67700. * series which support displaying null points.
  67701. */
  67702. nullFormat?: (boolean|string);
  67703. /**
  67704. * (Highcharts, Highstock, Highmaps, Gantt) Callback JavaScript function
  67705. * that defines formatting for points with the value of null. Works
  67706. * analogously to formatter. `nullPointFormatter` can be applied only to
  67707. * series which support displaying null points.
  67708. */
  67709. nullFormatter?: DataLabelsFormatterCallbackFunction;
  67710. /**
  67711. * (Highcharts, Highstock, Highmaps, Gantt) How to handle data labels that
  67712. * flow outside the plot area. The default is `"justify"`, which aligns them
  67713. * inside the plot area. For columns and bars, this means it will be moved
  67714. * inside the bar. To display data labels outside the plot area, set `crop`
  67715. * to `false` and `overflow` to `"allow"`.
  67716. */
  67717. overflow?: DataLabelsOverflowValue;
  67718. /**
  67719. * (Highcharts, Highstock, Highmaps, Gantt) When either the `borderWidth` or
  67720. * the `backgroundColor` is set, this is the padding within the box.
  67721. */
  67722. padding?: number;
  67723. /**
  67724. * (Highcharts, Highstock, Highmaps, Gantt) Aligns data labels relative to
  67725. * points. If `center` alignment is not possible, it defaults to `right`.
  67726. */
  67727. position?: AlignValue;
  67728. /**
  67729. * (Highcharts, Highstock, Highmaps, Gantt) Text rotation in degrees. Note
  67730. * that due to a more complex structure, backgrounds, borders and padding
  67731. * will be lost on a rotated data label.
  67732. */
  67733. rotation?: number;
  67734. /**
  67735. * (Highcharts, Highstock, Highmaps, Gantt) The shadow of the box. Works
  67736. * best with `borderWidth` or `backgroundColor`. Since 2.3 the shadow can be
  67737. * an object configuration containing `color`, `offsetX`, `offsetY`,
  67738. * `opacity` and `width`.
  67739. */
  67740. shadow?: (boolean|ShadowOptionsObject);
  67741. /**
  67742. * (Highcharts, Highstock, Highmaps, Gantt) The name of a symbol to use for
  67743. * the border around the label. Symbols are predefined functions on the
  67744. * Renderer object.
  67745. */
  67746. shape?: string;
  67747. /**
  67748. * (Highcharts, Highstock, Highmaps, Gantt) Styles for the label. The
  67749. * default `color` setting is `"contrast"`, which is a pseudo color that
  67750. * Highcharts picks up and applies the maximum contrast to the underlying
  67751. * point item, for example the bar in a bar chart.
  67752. *
  67753. * The `textOutline` is a pseudo property that applies an outline of the
  67754. * given width with the given color, which by default is the maximum
  67755. * contrast to the text. So a bright text color will result in a black text
  67756. * outline for maximum readability on a mixed background. In some cases,
  67757. * especially with grayscale text, the text outline doesn't work well, in
  67758. * which cases it can be disabled by setting it to `"none"`. When `useHTML`
  67759. * is true, the `textOutline` will not be picked up. In this, case, the same
  67760. * effect can be acheived through the `text-shadow` CSS property.
  67761. *
  67762. * For some series types, where each point has an extent, like for example
  67763. * tree maps, the data label may overflow the point. There are two
  67764. * strategies for handling overflow. By default, the text will wrap to
  67765. * multiple lines. The other strategy is to set `style.textOverflow` to
  67766. * `ellipsis`, which will keep the text on one line plus it will break
  67767. * inside long words.
  67768. */
  67769. style?: CSSObject;
  67770. /**
  67771. * (Highcharts, Highstock, Highmaps, Gantt) Options for a label text which
  67772. * should follow marker's shape. Border and background are disabled for a
  67773. * label that follows a path.
  67774. *
  67775. * **Note:** Only SVG-based renderer supports this option. Setting `useHTML`
  67776. * to true will disable this option.
  67777. */
  67778. textPath?: DataLabelsTextPathOptionsObject;
  67779. /**
  67780. * (Highcharts, Highstock, Highmaps, Gantt) Whether to use HTML to render
  67781. * the labels.
  67782. */
  67783. useHTML?: boolean;
  67784. /**
  67785. * (Highcharts, Highstock, Highmaps, Gantt) The vertical alignment of a data
  67786. * label. Can be one of `top`, `middle` or `bottom`. The default value
  67787. * depends on the data, for instance in a column chart, the label is above
  67788. * positive values and below negative values.
  67789. */
  67790. verticalAlign?: (VerticalAlignValue|null);
  67791. /**
  67792. * (Highcharts, Highstock, Highmaps, Gantt) The x position offset of the
  67793. * label relative to the point in pixels.
  67794. */
  67795. x?: number;
  67796. /**
  67797. * (Highcharts, Highstock, Highmaps, Gantt) The y position offset of the
  67798. * label relative to the point in pixels.
  67799. */
  67800. y?: number;
  67801. /**
  67802. * (Highcharts, Highstock, Highmaps, Gantt) The Z index of the data labels.
  67803. * The default Z index puts it above the series. Use a Z index of 2 to
  67804. * display it behind the series.
  67805. */
  67806. z?: number;
  67807. }
  67808. /**
  67809. * (Highcharts, Highstock) Options for the series data sorting.
  67810. */
  67811. export interface PlotPcDataSortingOptions {
  67812. /**
  67813. * (Highcharts, Highstock) Enable or disable data sorting for the series.
  67814. * Use xAxis.reversed to change the sorting order.
  67815. */
  67816. enabled?: boolean;
  67817. /**
  67818. * (Highcharts, Highstock) Whether to allow matching points by name in an
  67819. * update. If this option is disabled, points will be matched by order.
  67820. */
  67821. matchByName?: boolean;
  67822. /**
  67823. * (Highcharts, Highstock) Determines what data value should be used to sort
  67824. * by.
  67825. */
  67826. sortKey?: string;
  67827. }
  67828. /**
  67829. * (Highstock) Price channel (PC). This series requires the `linkedTo` option to
  67830. * be set and should be loaded after the `stock/indicators/indicators.js`.
  67831. *
  67832. * In TypeScript the type option must always be set.
  67833. *
  67834. * Configuration options for the series are given in three levels:
  67835. *
  67836. * 1. Options for all series in a chart are defined in the plotOptions.series
  67837. * object.
  67838. *
  67839. * 2. Options for all `pc` series are defined in plotOptions.pc.
  67840. *
  67841. * 3. Options for one single series are given in the series instance array. (see
  67842. * online documentation for example)
  67843. */
  67844. export interface PlotPcOptions {
  67845. /**
  67846. * (Highstock) Accessibility options for a series.
  67847. */
  67848. accessibility?: SeriesAccessibilityOptionsObject;
  67849. /**
  67850. * (Highstock) Allow this series' points to be selected by clicking on the
  67851. * graphic (columns, point markers, pie slices, map areas etc).
  67852. *
  67853. * The selected points can be handled by point select and unselect events,
  67854. * or collectively by the getSelectedPoints function.
  67855. *
  67856. * And alternative way of selecting points is through dragging.
  67857. */
  67858. allowPointSelect?: boolean;
  67859. /**
  67860. * (Highstock) Enable or disable the initial animation when a series is
  67861. * displayed. The animation can also be set as a configuration object.
  67862. * Please note that this option only applies to the initial animation of the
  67863. * series itself. For other animations, see chart.animation and the
  67864. * animation parameter under the API methods. The following properties are
  67865. * supported:
  67866. *
  67867. * - `defer`: The animation delay time in milliseconds.
  67868. *
  67869. * - `duration`: The duration of the animation in milliseconds.
  67870. *
  67871. * - `easing`: Can be a string reference to an easing function set on the
  67872. * `Math` object or a function. See the _Custom easing function_ demo below.
  67873. *
  67874. * Due to poor performance, animation is disabled in old IE browsers for
  67875. * several chart types.
  67876. */
  67877. animation?: (boolean|PlotPcAnimationOptions|Partial<AnimationOptionsObject>);
  67878. /**
  67879. * (Highstock) For some series, there is a limit that shuts down initial
  67880. * animation by default when the total number of points in the chart is too
  67881. * high. For example, for a column chart and its derivatives, animation does
  67882. * not run if there is more than 250 points totally. To disable this cap,
  67883. * set `animationLimit` to `Infinity`.
  67884. */
  67885. animationLimit?: number;
  67886. /**
  67887. * (Highstock) Sets the color blending in the boost module.
  67888. */
  67889. boostBlending?: OptionsBoostBlendingValue;
  67890. /**
  67891. * (Highstock) Set the point threshold for when a series should enter boost
  67892. * mode.
  67893. *
  67894. * Setting it to e.g. 2000 will cause the series to enter boost mode when
  67895. * there are 2000 or more points in the series.
  67896. *
  67897. * To disable boosting on the series, set the `boostThreshold` to 0. Setting
  67898. * it to 1 will force boosting.
  67899. *
  67900. * Note that the cropThreshold also affects this setting. When zooming in on
  67901. * a series that has fewer points than the `cropThreshold`, all points are
  67902. * rendered although outside the visible plot area, and the `boostThreshold`
  67903. * won't take effect.
  67904. */
  67905. boostThreshold?: number;
  67906. /**
  67907. * (Highmaps) The border color of the map areas.
  67908. *
  67909. * In styled mode, the border stroke is given in the `.highcharts-point`
  67910. * class.
  67911. */
  67912. borderColor?: (ColorString|GradientColorObject|PatternObject);
  67913. /**
  67914. * (Highmaps) The border width of each map area.
  67915. *
  67916. * In styled mode, the border stroke width is given in the
  67917. * `.highcharts-point` class.
  67918. */
  67919. borderWidth?: number;
  67920. bottomLine?: PlotPcBottomLineOptions;
  67921. /**
  67922. * (Highstock) An additional class name to apply to the series' graphical
  67923. * elements. This option does not replace default class names of the
  67924. * graphical element.
  67925. */
  67926. className?: string;
  67927. /**
  67928. * (Highstock) Disable this option to allow series rendering in the whole
  67929. * plotting area.
  67930. *
  67931. * **Note:** Clipping should be always enabled when chart.zoomType is set
  67932. */
  67933. clip?: boolean;
  67934. /**
  67935. * (Highstock) The main color of the series. In line type series it applies
  67936. * to the line and the point markers unless otherwise specified. In bar type
  67937. * series it applies to the bars unless a color is specified per point. The
  67938. * default value is pulled from the `options.colors` array.
  67939. *
  67940. * In styled mode, the color can be defined by the colorIndex option. Also,
  67941. * the series color can be set with the `.highcharts-series`,
  67942. * `.highcharts-color-{n}`, `.highcharts-{type}-series` or
  67943. * `.highcharts-series-{n}` class, or individual classes given by the
  67944. * `className` option.
  67945. */
  67946. color?: (ColorString|GradientColorObject|PatternObject);
  67947. /**
  67948. * (Highstock) Styled mode only. A specific color index to use for the
  67949. * series, so its graphic representations are given the class name
  67950. * `highcharts-color-{n}`.
  67951. */
  67952. colorIndex?: number;
  67953. /**
  67954. * (Highcharts, Highstock, Highmaps) Determines what data value should be
  67955. * used to calculate point color if `colorAxis` is used. Requires to set
  67956. * `min` and `max` if some custom point property is used or if approximation
  67957. * for data grouping is set to `'sum'`.
  67958. */
  67959. colorKey?: string;
  67960. /**
  67961. * (Highstock) Defines if comparison should start from the first point
  67962. * within the visible range or should start from the first point **before**
  67963. * the range.
  67964. *
  67965. * In other words, this flag determines if first point within the visible
  67966. * range will have 0% (`compareStart=true`) or should have been already
  67967. * calculated according to the previous point (`compareStart=false`).
  67968. */
  67969. compareStart?: boolean;
  67970. /**
  67971. * (Highstock) Whether to compare indicator to the main series values or
  67972. * indicator values.
  67973. */
  67974. compareToMain?: boolean;
  67975. /**
  67976. * (Highcharts) Polar charts only. Whether to connect the ends of a line
  67977. * series plot across the extremes.
  67978. */
  67979. connectEnds?: boolean;
  67980. /**
  67981. * (Highcharts, Highstock) Whether to connect a graph line across null
  67982. * points, or render a gap between the two points on either side of the
  67983. * null.
  67984. */
  67985. connectNulls?: boolean;
  67986. /**
  67987. * (Gantt) Override Pathfinder connector options for a series. Requires
  67988. * Highcharts Gantt to be loaded.
  67989. */
  67990. connectors?: SeriesConnectorsOptionsObject;
  67991. /**
  67992. * (Highcharts, Highstock, Gantt) When true, each point or column edge is
  67993. * rounded to its nearest pixel in order to render sharp on screen. In some
  67994. * cases, when there are a lot of densely packed columns, this leads to
  67995. * visible difference in column widths or distance between columns. In these
  67996. * cases, setting `crisp` to `false` may look better, even though each
  67997. * column is rendered blurry.
  67998. */
  67999. crisp?: boolean;
  68000. /**
  68001. * (Highcharts, Highstock) When the series contains less points than the
  68002. * crop threshold, all points are drawn, even if the points fall outside the
  68003. * visible plot area at the current zoom. The advantage of drawing all
  68004. * points (including markers and columns), is that animation is performed on
  68005. * updates. On the other hand, when the series contains more points than the
  68006. * crop threshold, the series data is cropped to only contain points that
  68007. * fall within the plot area. The advantage of cropping away invisible
  68008. * points is to increase performance on large series.
  68009. */
  68010. cropThreshold?: number;
  68011. /**
  68012. * (Highstock) You can set the cursor to "pointer" if you have click events
  68013. * attached to the series, to signal to the user that the points and lines
  68014. * can be clicked.
  68015. *
  68016. * In styled mode, the series cursor can be set with the same classes as
  68017. * listed under series.color.
  68018. */
  68019. cursor?: (string|CursorValue);
  68020. /**
  68021. * (Highstock) A reserved subspace to store options and values for
  68022. * customized functionality. Here you can add additional data for your own
  68023. * event callbacks and formatter callbacks.
  68024. */
  68025. custom?: Dictionary<any>;
  68026. /**
  68027. * (Highstock) Name of the dash style to use for the graph, or for some
  68028. * series types the outline of each shape.
  68029. *
  68030. * In styled mode, the stroke dash-array can be set with the same classes as
  68031. * listed under series.color.
  68032. */
  68033. dashStyle?: DashStyleValue;
  68034. /**
  68035. * (Highstock) Data grouping is the concept of sampling the data values into
  68036. * larger blocks in order to ease readability and increase performance of
  68037. * the JavaScript charts. Highstock by default applies data grouping when
  68038. * the points become closer than a certain pixel value, determined by the
  68039. * `groupPixelWidth` option.
  68040. *
  68041. * If data grouping is applied, the grouping information of grouped points
  68042. * can be read from the Point.dataGroup. If point options other than the
  68043. * data itself are set, for example `name` or `color` or custom properties,
  68044. * the grouping logic doesn't know how to group it. In this case the options
  68045. * of the first point instance are copied over to the group point. This can
  68046. * be altered through a custom `approximation` callback function.
  68047. */
  68048. dataGrouping?: DataGroupingOptionsObject;
  68049. /**
  68050. * (Highcharts, Highstock, Highmaps, Gantt) Options for the series data
  68051. * labels, appearing next to each data point.
  68052. *
  68053. * Since v6.2.0, multiple data labels can be applied to each single point by
  68054. * defining them as an array of configs.
  68055. *
  68056. * In styled mode, the data labels can be styled with the
  68057. * `.highcharts-data-label-box` and `.highcharts-data-label` class names
  68058. * (see example).
  68059. */
  68060. dataLabels?: (PlotPcDataLabelsOptions|Array<PlotPcDataLabelsOptions>);
  68061. /**
  68062. * (Highcharts, Highstock) Options for the series data sorting.
  68063. */
  68064. dataSorting?: (DataSortingOptionsObject|PlotPcDataSortingOptions);
  68065. /**
  68066. * (Highstock) A description of the series to add to the screen reader
  68067. * information about the series.
  68068. */
  68069. description?: string;
  68070. /**
  68071. * (Highstock) Enable or disable the mouse tracking for a specific series.
  68072. * This includes point tooltips and click events on graphs and points. For
  68073. * large datasets it improves performance.
  68074. */
  68075. enableMouseTracking?: boolean;
  68076. /**
  68077. * (Highstock) General event handlers for the series items. These event
  68078. * hooks can also be attached to the series at run time using the
  68079. * `Highcharts.addEvent` function.
  68080. */
  68081. events?: SeriesEventsOptionsObject;
  68082. /**
  68083. * (Highstock) Determines whether the series should look for the nearest
  68084. * point in both dimensions or just the x-dimension when hovering the
  68085. * series. Defaults to `'xy'` for scatter series and `'x'` for most other
  68086. * series. If the data has duplicate x-values, it is recommended to set this
  68087. * to `'xy'` to allow hovering over all points.
  68088. *
  68089. * Applies only to series types using nearest neighbor search (not direct
  68090. * hover) for tooltip.
  68091. */
  68092. findNearestPointBy?: OptionsFindNearestPointByValue;
  68093. /**
  68094. * (Highstock) Defines when to display a gap in the graph, together with the
  68095. * gapUnit option.
  68096. *
  68097. * In case when `dataGrouping` is enabled, points can be grouped into a
  68098. * larger time span. This can make the grouped points to have a greater
  68099. * distance than the absolute value of `gapSize` property, which will result
  68100. * in disappearing graph completely. To prevent this situation the mentioned
  68101. * distance between grouped points is used instead of previously defined
  68102. * `gapSize`.
  68103. *
  68104. * In practice, this option is most often used to visualize gaps in time
  68105. * series. In a stock chart, intraday data is available for daytime hours,
  68106. * while gaps will appear in nights and weekends.
  68107. */
  68108. gapSize?: number;
  68109. /**
  68110. * (Highstock) Together with gapSize, this option defines where to draw gaps
  68111. * in the graph.
  68112. *
  68113. * When the `gapUnit` is `"relative"` (default), a gap size of 5 means that
  68114. * if the distance between two points is greater than 5 times that of the
  68115. * two closest points, the graph will be broken.
  68116. *
  68117. * When the `gapUnit` is `"value"`, the gap is based on absolute axis
  68118. * values, which on a datetime axis is milliseconds. This also applies to
  68119. * the navigator series that inherits gap options from the base series.
  68120. */
  68121. gapUnit?: OptionsGapUnitValue;
  68122. /**
  68123. * (Highcharts, Highstock, Gantt) Whether to use the Y extremes of the total
  68124. * chart width or only the zoomed area when zooming in on parts of the X
  68125. * axis. By default, the Y axis adjusts to the min and max of the visible
  68126. * data. Cartesian series only.
  68127. */
  68128. getExtremesFromAll?: boolean;
  68129. /**
  68130. * (Highstock) When set to `false` will prevent the series data from being
  68131. * included in any form of data export.
  68132. *
  68133. * Since version 6.0.0 until 7.1.0 the option was existing undocumented as
  68134. * `includeInCSVExport`.
  68135. */
  68136. includeInDataExport?: boolean;
  68137. /**
  68138. * (Highcharts, Highstock, Gantt) Series labels are placed as close to the
  68139. * series as possible in a natural way, seeking to avoid other series. The
  68140. * goal of this feature is to make the chart more easily readable, like if a
  68141. * human designer placed the labels in the optimal position.
  68142. *
  68143. * The series labels currently work with series types having a `graph` or an
  68144. * `area`.
  68145. */
  68146. label?: SeriesLabelOptionsObject;
  68147. /**
  68148. * (Highstock) The line marks the last price from all points.
  68149. */
  68150. lastPrice?: SeriesLastPriceOptionsObject;
  68151. /**
  68152. * (Highstock) The line marks the last price from visible range of points.
  68153. */
  68154. lastVisiblePrice?: SeriesLastVisiblePriceOptionsObject;
  68155. /**
  68156. * (Highcharts, Highstock) The SVG value used for the `stroke-linecap` and
  68157. * `stroke-linejoin` of a line graph. Round means that lines are rounded in
  68158. * the ends and bends.
  68159. */
  68160. linecap?: SeriesLinecapValue;
  68161. /**
  68162. * (Highcharts, Highstock) Pixel width of the graph line.
  68163. */
  68164. lineWidth?: number;
  68165. /**
  68166. * (Highcharts, Highstock, Gantt) The main series ID that indicator will be
  68167. * based on. Required for this indicator.
  68168. */
  68169. linkedTo?: string;
  68170. /**
  68171. * (Highstock) Options for the point markers of line-like series. Properties
  68172. * like `fillColor`, `lineColor` and `lineWidth` define the visual
  68173. * appearance of the markers. Other series types, like column series, don't
  68174. * have markers, but have visual options on the series level instead.
  68175. *
  68176. * In styled mode, the markers can be styled with the `.highcharts-point`,
  68177. * `.highcharts-point-hover` and `.highcharts-point-select` class names.
  68178. */
  68179. marker?: PointMarkerOptionsObject;
  68180. /**
  68181. * (Highstock) The name of the series as shown in the legend, tooltip etc.
  68182. * If not set, it will be based on a technical indicator type and default
  68183. * params.
  68184. */
  68185. name?: string;
  68186. /**
  68187. * (Highstock) The color for the parts of the graph or points that are below
  68188. * the threshold. Note that `zones` takes precedence over the negative
  68189. * color. Using `negativeColor` is equivalent to applying a zone with value
  68190. * of 0.
  68191. */
  68192. negativeColor?: (ColorString|GradientColorObject|PatternObject);
  68193. /**
  68194. * (Highstock) Opacity of a series parts: line, fill (e.g. area) and
  68195. * dataLabels.
  68196. */
  68197. opacity?: number;
  68198. /**
  68199. * (Highstock) Paramters used in calculation of regression series' points.
  68200. */
  68201. params?: PlotPcParamsOptions;
  68202. /**
  68203. * (Highstock) Properties for each single point.
  68204. */
  68205. point?: PlotSeriesPointOptions;
  68206. /**
  68207. * (Highstock) Same as accessibility.pointDescriptionFormatter, but for an
  68208. * individual series. Overrides the chart wide configuration.
  68209. */
  68210. pointDescriptionFormatter?: Function;
  68211. /**
  68212. * (Highstock) Whether to select the series initially. If `showCheckbox` is
  68213. * true, the checkbox next to the series name in the legend will be checked
  68214. * for a selected series.
  68215. */
  68216. selected?: boolean;
  68217. /**
  68218. * (Highstock) Whether to apply a drop shadow to the graph line. Since 2.3
  68219. * the shadow can be an object configuration containing `color`, `offsetX`,
  68220. * `offsetY`, `opacity` and `width`.
  68221. */
  68222. shadow?: (boolean|ShadowOptionsObject);
  68223. /**
  68224. * (Highstock) If true, a checkbox is displayed next to the legend item to
  68225. * allow selecting the series. The state of the checkbox is determined by
  68226. * the `selected` option.
  68227. */
  68228. showCheckbox?: boolean;
  68229. /**
  68230. * (Highstock) Whether to display this particular series or series type in
  68231. * the legend. Standalone series are shown in legend by default, and linked
  68232. * series are not. Since v7.2.0 it is possible to show series that use
  68233. * colorAxis by setting this option to `true`.
  68234. */
  68235. showInLegend?: boolean;
  68236. /**
  68237. * (Highstock) If set to `true`, the accessibility module will skip past the
  68238. * points in this series for keyboard navigation.
  68239. */
  68240. skipKeyboardNavigation?: boolean;
  68241. /**
  68242. * (Highcharts, Highstock) When this is true, the series will not cause the
  68243. * Y axis to cross the zero plane (or threshold option) unless the data
  68244. * actually crosses the plane.
  68245. *
  68246. * For example, if `softThreshold` is `false`, a series of 0, 1, 2, 3 will
  68247. * make the Y axis show negative values according to the `minPadding`
  68248. * option. If `softThreshold` is `true`, the Y axis starts at 0.
  68249. */
  68250. softThreshold?: boolean;
  68251. states?: SeriesStatesOptionsObject;
  68252. /**
  68253. * (Highcharts, Highstock) Whether to apply steps to the line. Possible
  68254. * values are `left`, `center` and `right`.
  68255. */
  68256. step?: OptionsStepValue;
  68257. /**
  68258. * (Highstock) Sticky tracking of mouse events. When true, the `mouseOut`
  68259. * event on a series isn't triggered until the mouse moves over another
  68260. * series, or out of the plot area. When false, the `mouseOut` event on a
  68261. * series is triggered when the mouse leaves the area around the series'
  68262. * graph or markers. This also implies the tooltip when not shared. When
  68263. * `stickyTracking` is false and `tooltip.shared` is false, the tooltip will
  68264. * be hidden when moving the mouse between series. Defaults to true for line
  68265. * and area type series, but to false for columns, pies etc.
  68266. *
  68267. * **Note:** The boost module will force this option because of technical
  68268. * limitations.
  68269. */
  68270. stickyTracking?: boolean;
  68271. /**
  68272. * (Highcharts, Highstock) The threshold, also called zero level or base
  68273. * level. For line type series this is only used in conjunction with
  68274. * negativeColor.
  68275. */
  68276. threshold?: (number|null);
  68277. /**
  68278. * (Highstock) A configuration object for the tooltip rendering of each
  68279. * single series. Properties are inherited from tooltip, but only the
  68280. * following properties can be defined on a series level.
  68281. */
  68282. tooltip?: SeriesTooltipOptionsObject;
  68283. topLine?: PlotPcTopLineOptions;
  68284. /**
  68285. * (Highcharts, Highstock, Gantt) When a series contains a data array that
  68286. * is longer than this, only one dimensional arrays of numbers, or two
  68287. * dimensional arrays with x and y values are allowed. Also, only the first
  68288. * point is tested, and the rest are assumed to be the same format. This
  68289. * saves expensive data checking and indexing in long series. Set it to `0`
  68290. * disable.
  68291. *
  68292. * Note: In boost mode turbo threshold is forced. Only array of numbers or
  68293. * two dimensional arrays are allowed.
  68294. */
  68295. turboThreshold?: number;
  68296. /**
  68297. * (Highstock) Set the initial visibility of the series.
  68298. */
  68299. visible?: boolean;
  68300. /**
  68301. * (Highmaps) Define the z index of the series.
  68302. */
  68303. zIndex?: number;
  68304. /**
  68305. * (Highcharts, Highstock) Defines the Axis on which the zones are applied.
  68306. */
  68307. zoneAxis?: string;
  68308. /**
  68309. * (Highcharts, Highstock) An array defining zones within a series. Zones
  68310. * can be applied to the X axis, Y axis or Z axis for bubbles, according to
  68311. * the `zoneAxis` option. The zone definitions have to be in ascending order
  68312. * regarding to the value.
  68313. *
  68314. * In styled mode, the color zones are styled with the
  68315. * `.highcharts-zone-{n}` class, or custom classed from the `className`
  68316. * option (view live demo).
  68317. */
  68318. zones?: Array<SeriesZonesOptionsObject>;
  68319. }
  68320. /**
  68321. * (Highstock) Paramters used in calculation of regression series' points.
  68322. */
  68323. export interface PlotPcParamsOptions {
  68324. /**
  68325. * (Highstock) The base period for indicator calculations. This is the
  68326. * number of data points which are taken into account for the indicator
  68327. * calculations.
  68328. */
  68329. period?: number;
  68330. }
  68331. export interface PlotPcTopLineOptions {
  68332. styles?: PlotPcTopLineStylesOptions;
  68333. }
  68334. export interface PlotPcTopLineStylesOptions {
  68335. /**
  68336. * (Highstock) Color of the top line. If not set, it's inherited from
  68337. * plotOptions.pc.color.
  68338. */
  68339. lineColor?: ColorString;
  68340. /**
  68341. * (Highstock) Pixel width of the line.
  68342. */
  68343. lineWidth?: number;
  68344. }
  68345. /**
  68346. * (Highcharts) Enable or disable the initial animation when a series is
  68347. * displayed. The animation can also be set as a configuration object. Please
  68348. * note that this option only applies to the initial animation of the series
  68349. * itself. For other animations, see chart.animation and the animation parameter
  68350. * under the API methods. The following properties are supported:
  68351. *
  68352. * - `defer`: The animation delay time in milliseconds.
  68353. *
  68354. * - `duration`: The duration of the animation in milliseconds.
  68355. *
  68356. * - `easing`: Can be a string reference to an easing function set on the `Math`
  68357. * object or a function. See the _Custom easing function_ demo below.
  68358. *
  68359. * Due to poor performance, animation is disabled in old IE browsers for several
  68360. * chart types.
  68361. */
  68362. export interface PlotPieAnimationOptions {
  68363. defer?: number;
  68364. }
  68365. /**
  68366. * (Highcharts, Highstock, Highmaps, Gantt) Enable or disable the initial
  68367. * animation when a series is displayed for the `dataLabels`. The animation can
  68368. * also be set as a configuration object. Please note that this option only
  68369. * applies to the initial animation. For other animations, see chart.animation
  68370. * and the animation parameter under the API methods. The following properties
  68371. * are supported:
  68372. *
  68373. * - `defer`: The animation delay time in milliseconds.
  68374. */
  68375. export interface PlotPieDataLabelsAnimationOptions {
  68376. /**
  68377. * (Highcharts, Highstock, Highmaps, Gantt) The animation delay time in
  68378. * milliseconds. Set to `0` renders dataLabel immediately. As `undefined`
  68379. * inherits defer time from the series.animation.defer.
  68380. */
  68381. defer?: number;
  68382. }
  68383. /**
  68384. * (Highcharts) A pie chart is a circular graphic which is divided into slices
  68385. * to illustrate numerical proportion.
  68386. *
  68387. * In TypeScript the type option must always be set.
  68388. *
  68389. * Configuration options for the series are given in three levels:
  68390. *
  68391. * 1. Options for all series in a chart are defined in the plotOptions.series
  68392. * object.
  68393. *
  68394. * 2. Options for all `pie` series are defined in plotOptions.pie.
  68395. *
  68396. * 3. Options for one single series are given in the series instance array. (see
  68397. * online documentation for example)
  68398. */
  68399. export interface PlotPieOptions {
  68400. /**
  68401. * (Highcharts) Accessibility options for a series.
  68402. */
  68403. accessibility?: SeriesAccessibilityOptionsObject;
  68404. /**
  68405. * (Highmaps) Whether all areas of the map defined in `mapData` should be
  68406. * rendered. If `true`, areas which don't correspond to a data point, are
  68407. * rendered as `null` points. If `false`, those areas are skipped.
  68408. */
  68409. allAreas?: boolean;
  68410. /**
  68411. * (Highcharts) Allow this series' points to be selected by clicking on the
  68412. * graphic (columns, point markers, pie slices, map areas etc).
  68413. *
  68414. * The selected points can be handled by point select and unselect events,
  68415. * or collectively by the getSelectedPoints function.
  68416. *
  68417. * And alternative way of selecting points is through dragging.
  68418. */
  68419. allowPointSelect?: boolean;
  68420. /**
  68421. * (Highcharts) Enable or disable the initial animation when a series is
  68422. * displayed. The animation can also be set as a configuration object.
  68423. * Please note that this option only applies to the initial animation of the
  68424. * series itself. For other animations, see chart.animation and the
  68425. * animation parameter under the API methods. The following properties are
  68426. * supported:
  68427. *
  68428. * - `defer`: The animation delay time in milliseconds.
  68429. *
  68430. * - `duration`: The duration of the animation in milliseconds.
  68431. *
  68432. * - `easing`: Can be a string reference to an easing function set on the
  68433. * `Math` object or a function. See the _Custom easing function_ demo below.
  68434. *
  68435. * Due to poor performance, animation is disabled in old IE browsers for
  68436. * several chart types.
  68437. */
  68438. animation?: (boolean|PlotPieAnimationOptions|Partial<AnimationOptionsObject>);
  68439. /**
  68440. * (Highcharts) The color of the border surrounding each slice. When `null`,
  68441. * the border takes the same color as the slice fill. This can be used
  68442. * together with a `borderWidth` to fill drawing gaps created by
  68443. * antialiazing artefacts in borderless pies.
  68444. *
  68445. * In styled mode, the border stroke is given in the `.highcharts-point`
  68446. * class.
  68447. */
  68448. borderColor?: (ColorString|GradientColorObject|PatternObject);
  68449. /**
  68450. * (Highcharts) The width of the border surrounding each slice.
  68451. *
  68452. * When setting the border width to 0, there may be small gaps between the
  68453. * slices due to SVG antialiasing artefacts. To work around this, keep the
  68454. * border width at 0.5 or 1, but set the `borderColor` to `null` instead.
  68455. *
  68456. * In styled mode, the border stroke width is given in the
  68457. * `.highcharts-point` class.
  68458. */
  68459. borderWidth?: number;
  68460. /**
  68461. * (Highcharts) The center of the pie chart relative to the plot area. Can
  68462. * be percentages or pixel values. The default behaviour (as of 3.0) is to
  68463. * center the pie so that all slices and data labels are within the plot
  68464. * area. As a consequence, the pie may actually jump around in a chart with
  68465. * dynamic values, as the data labels move. In that case, the center should
  68466. * be explicitly set, for example to `["50%", "50%"]`.
  68467. */
  68468. center?: [(number|string|null), (number|string|null)];
  68469. /**
  68470. * (Highcharts) An additional class name to apply to the series' graphical
  68471. * elements. This option does not replace default class names of the
  68472. * graphical element.
  68473. */
  68474. className?: string;
  68475. /**
  68476. * (Highcharts) Disable this option to allow series rendering in the whole
  68477. * plotting area.
  68478. *
  68479. * **Note:** Clipping should be always enabled when chart.zoomType is set
  68480. */
  68481. clip?: boolean;
  68482. /**
  68483. * (Highcharts) The color of the pie series. A pie series is represented as
  68484. * an empty circle if the total sum of its values is 0. Use this property to
  68485. * define the color of its border.
  68486. *
  68487. * In styled mode, the color can be defined by the colorIndex option. Also,
  68488. * the series color can be set with the `.highcharts-series`,
  68489. * `.highcharts-color-{n}`, `.highcharts-{type}-series` or
  68490. * `.highcharts-series-{n}` class, or individual classes given by the
  68491. * `className` option.
  68492. */
  68493. color?: (ColorString|GradientColorObject|PatternObject);
  68494. /**
  68495. * (Highcharts, Highstock, Highmaps) When using dual or multiple color axes,
  68496. * this number defines which colorAxis the particular series is connected
  68497. * to. It refers to either the axis id or the index of the axis in the
  68498. * colorAxis array, with 0 being the first. Set this option to false to
  68499. * prevent a series from connecting to the default color axis.
  68500. *
  68501. * Since v7.2.0 the option can also be an axis id or an axis index instead
  68502. * of a boolean flag.
  68503. */
  68504. colorAxis?: (boolean|number|string);
  68505. /**
  68506. * (Highcharts) Styled mode only. A specific color index to use for the
  68507. * series, so its graphic representations are given the class name
  68508. * `highcharts-color-{n}`.
  68509. */
  68510. colorIndex?: number;
  68511. /**
  68512. * (Highcharts, Highstock, Highmaps) Determines what data value should be
  68513. * used to calculate point color if `colorAxis` is used. Requires to set
  68514. * `min` and `max` if some custom point property is used or if approximation
  68515. * for data grouping is set to `'sum'`.
  68516. */
  68517. colorKey?: string;
  68518. /**
  68519. * (Highcharts) A series specific or series type specific color set to use
  68520. * instead of the global colors.
  68521. */
  68522. colors?: Array<(ColorString|GradientColorObject|PatternObject)>;
  68523. /**
  68524. * (Highstock) Compare the values of the series against the first non-null,
  68525. * non- zero value in the visible range. The y axis will show percentage or
  68526. * absolute change depending on whether `compare` is set to `"percent"` or
  68527. * `"value"`. When this is applied to multiple series, it allows comparing
  68528. * the development of the series against each other. Adds a `change` field
  68529. * to every point object.
  68530. */
  68531. compare?: string;
  68532. /**
  68533. * (Highstock) When compare is `percent`, this option dictates whether to
  68534. * use 0 or 100 as the base of comparison.
  68535. */
  68536. compareBase?: (0|100);
  68537. /**
  68538. * (Highstock) Defines if comparison should start from the first point
  68539. * within the visible range or should start from the first point **before**
  68540. * the range.
  68541. *
  68542. * In other words, this flag determines if first point within the visible
  68543. * range will have 0% (`compareStart=true`) or should have been already
  68544. * calculated according to the previous point (`compareStart=false`).
  68545. */
  68546. compareStart?: boolean;
  68547. /**
  68548. * (Gantt) Override Pathfinder connector options for a series. Requires
  68549. * Highcharts Gantt to be loaded.
  68550. */
  68551. connectors?: SeriesConnectorsOptionsObject;
  68552. /**
  68553. * (Highcharts, Highstock, Gantt) When true, each point or column edge is
  68554. * rounded to its nearest pixel in order to render sharp on screen. In some
  68555. * cases, when there are a lot of densely packed columns, this leads to
  68556. * visible difference in column widths or distance between columns. In these
  68557. * cases, setting `crisp` to `false` may look better, even though each
  68558. * column is rendered blurry.
  68559. */
  68560. crisp?: boolean;
  68561. /**
  68562. * (Highcharts) You can set the cursor to "pointer" if you have click events
  68563. * attached to the series, to signal to the user that the points and lines
  68564. * can be clicked.
  68565. *
  68566. * In styled mode, the series cursor can be set with the same classes as
  68567. * listed under series.color.
  68568. */
  68569. cursor?: (string|CursorValue);
  68570. /**
  68571. * (Highcharts) A reserved subspace to store options and values for
  68572. * customized functionality. Here you can add additional data for your own
  68573. * event callbacks and formatter callbacks.
  68574. */
  68575. custom?: Dictionary<any>;
  68576. /**
  68577. * (Highstock) Data grouping is the concept of sampling the data values into
  68578. * larger blocks in order to ease readability and increase performance of
  68579. * the JavaScript charts. Highstock by default applies data grouping when
  68580. * the points become closer than a certain pixel value, determined by the
  68581. * `groupPixelWidth` option.
  68582. *
  68583. * If data grouping is applied, the grouping information of grouped points
  68584. * can be read from the Point.dataGroup. If point options other than the
  68585. * data itself are set, for example `name` or `color` or custom properties,
  68586. * the grouping logic doesn't know how to group it. In this case the options
  68587. * of the first point instance are copied over to the group point. This can
  68588. * be altered through a custom `approximation` callback function.
  68589. */
  68590. dataGrouping?: DataGroupingOptionsObject;
  68591. /**
  68592. * (Highcharts, Highstock, Highmaps, Gantt) Options for the series data
  68593. * labels, appearing next to each data point.
  68594. *
  68595. * Since v6.2.0, multiple data labels can be applied to each single point by
  68596. * defining them as an array of configs.
  68597. *
  68598. * In styled mode, the data labels can be styled with the
  68599. * `.highcharts-data-label-box` and `.highcharts-data-label` class names
  68600. * (see example).
  68601. */
  68602. dataLabels?: (SeriesPieDataLabelsOptionsObject|Array<SeriesPieDataLabelsOptionsObject>);
  68603. /**
  68604. * (Highcharts) The thickness of a 3D pie.
  68605. */
  68606. depth?: number;
  68607. /**
  68608. * (Highcharts) A description of the series to add to the screen reader
  68609. * information about the series.
  68610. */
  68611. description?: string;
  68612. /**
  68613. * (Highcharts) Enable or disable the mouse tracking for a specific series.
  68614. * This includes point tooltips and click events on graphs and points. For
  68615. * large datasets it improves performance.
  68616. */
  68617. enableMouseTracking?: boolean;
  68618. /**
  68619. * (Highcharts) The end angle of the pie in degrees where 0 is top and 90 is
  68620. * right. Defaults to `startAngle` plus 360.
  68621. */
  68622. endAngle?: number;
  68623. /**
  68624. * (Highcharts) General event handlers for the series items. These event
  68625. * hooks can also be attached to the series at run time using the
  68626. * `Highcharts.addEvent` function.
  68627. */
  68628. events?: SeriesEventsOptionsObject;
  68629. /**
  68630. * (Highcharts) If the total sum of the pie's values is 0, the series is
  68631. * represented as an empty circle . The `fillColor` option defines the color
  68632. * of that circle. Use pie.borderWidth to set the border thickness.
  68633. */
  68634. fillColor?: (ColorString|GradientColorObject|PatternObject);
  68635. /**
  68636. * (Highstock) Defines when to display a gap in the graph, together with the
  68637. * gapUnit option.
  68638. *
  68639. * In case when `dataGrouping` is enabled, points can be grouped into a
  68640. * larger time span. This can make the grouped points to have a greater
  68641. * distance than the absolute value of `gapSize` property, which will result
  68642. * in disappearing graph completely. To prevent this situation the mentioned
  68643. * distance between grouped points is used instead of previously defined
  68644. * `gapSize`.
  68645. *
  68646. * In practice, this option is most often used to visualize gaps in time
  68647. * series. In a stock chart, intraday data is available for daytime hours,
  68648. * while gaps will appear in nights and weekends.
  68649. */
  68650. gapSize?: number;
  68651. /**
  68652. * (Highstock) Together with gapSize, this option defines where to draw gaps
  68653. * in the graph.
  68654. *
  68655. * When the `gapUnit` is `"relative"` (default), a gap size of 5 means that
  68656. * if the distance between two points is greater than 5 times that of the
  68657. * two closest points, the graph will be broken.
  68658. *
  68659. * When the `gapUnit` is `"value"`, the gap is based on absolute axis
  68660. * values, which on a datetime axis is milliseconds. This also applies to
  68661. * the navigator series that inherits gap options from the base series.
  68662. */
  68663. gapUnit?: OptionsGapUnitValue;
  68664. /**
  68665. * (Highcharts) Equivalent to chart.ignoreHiddenSeries, this option tells
  68666. * whether the series shall be redrawn as if the hidden point were `null`.
  68667. *
  68668. * The default value changed from `false` to `true` with Highcharts 3.0.
  68669. */
  68670. ignoreHiddenPoint?: boolean;
  68671. /**
  68672. * (Highcharts) When set to `false` will prevent the series data from being
  68673. * included in any form of data export.
  68674. *
  68675. * Since version 6.0.0 until 7.1.0 the option was existing undocumented as
  68676. * `includeInCSVExport`.
  68677. */
  68678. includeInDataExport?: boolean;
  68679. /**
  68680. * (Highcharts) The size of the inner diameter for the pie. A size greater
  68681. * than 0 renders a donut chart. Can be a percentage or pixel value.
  68682. * Percentages are relative to the pie size. Pixel values are given as
  68683. * integers.
  68684. *
  68685. * Note: in Highcharts < 4.1.2, the percentage was relative to the plot
  68686. * area, not the pie size.
  68687. */
  68688. innerSize?: (number|string);
  68689. /**
  68690. * (Highmaps) What property to join the `mapData` to the value data. For
  68691. * example, if joinBy is "code", the mapData items with a specific code is
  68692. * merged into the data with the same code. For maps loaded from GeoJSON,
  68693. * the keys may be held in each point's `properties` object.
  68694. *
  68695. * The joinBy option can also be an array of two values, where the first
  68696. * points to a key in the `mapData`, and the second points to another key in
  68697. * the `data`.
  68698. *
  68699. * When joinBy is `null`, the map items are joined by their position in the
  68700. * array, which performs much better in maps with many data points. This is
  68701. * the recommended option if you are printing more than a thousand data
  68702. * points and have a backend that can preprocess the data into a parallel
  68703. * array of the mapData.
  68704. */
  68705. joinBy?: (string|Array<string>);
  68706. /**
  68707. * (Highcharts) An array specifying which option maps to which key in the
  68708. * data point array. This makes it convenient to work with unstructured data
  68709. * arrays from different sources.
  68710. */
  68711. keys?: Array<string>;
  68712. /**
  68713. * (Highstock) The line marks the last price from all points.
  68714. */
  68715. lastPrice?: SeriesLastPriceOptionsObject;
  68716. /**
  68717. * (Highstock) The line marks the last price from visible range of points.
  68718. */
  68719. lastVisiblePrice?: SeriesLastVisiblePriceOptionsObject;
  68720. /**
  68721. * (Highcharts, Highstock) The SVG value used for the `stroke-linecap` and
  68722. * `stroke-linejoin` of a line graph. Round means that lines are rounded in
  68723. * the ends and bends.
  68724. */
  68725. linecap?: SeriesLinecapValue;
  68726. /**
  68727. * (Highcharts, Highstock, Gantt) The id of another series to link to.
  68728. * Additionally, the value can be ":previous" to link to the previous
  68729. * series. When two series are linked, only the first one appears in the
  68730. * legend. Toggling the visibility of this also toggles the linked series.
  68731. *
  68732. * If master series uses data sorting and linked series does not have its
  68733. * own sorting definition, the linked series will be sorted in the same
  68734. * order as the master one.
  68735. */
  68736. linkedTo?: string;
  68737. /**
  68738. * (Highcharts) The minimum size for a pie in response to auto margins. The
  68739. * pie will try to shrink to make room for data labels in side the plot
  68740. * area, but only to this size.
  68741. */
  68742. minSize?: (number|string);
  68743. /**
  68744. * (Highstock) Options for the corresponding navigator series if
  68745. * `showInNavigator` is `true` for this series. Available options are the
  68746. * same as any series, documented at plotOptions and series.
  68747. *
  68748. * These options are merged with options in navigator.series, and will take
  68749. * precedence if the same option is defined both places.
  68750. */
  68751. navigatorOptions?: PlotSeriesOptions;
  68752. /**
  68753. * (Highcharts) Opacity of a series parts: line, fill (e.g. area) and
  68754. * dataLabels.
  68755. */
  68756. opacity?: number;
  68757. /**
  68758. * (Highcharts) Properties for each single point.
  68759. */
  68760. point?: PlotSeriesPointOptions;
  68761. /**
  68762. * (Highcharts) Same as accessibility.pointDescriptionFormatter, but for an
  68763. * individual series. Overrides the chart wide configuration.
  68764. */
  68765. pointDescriptionFormatter?: Function;
  68766. /**
  68767. * (Highstock) The width of each point on the x axis. For example in a
  68768. * column chart with one value each day, the pointRange would be 1 day (= 24
  68769. * * 3600
  68770. *
  68771. * * 1000 milliseconds). This is normally computed automatically, but this
  68772. * option can be used to override the automatic value.
  68773. */
  68774. pointRange?: number;
  68775. /**
  68776. * (Highcharts) Whether to select the series initially. If `showCheckbox` is
  68777. * true, the checkbox next to the series name in the legend will be checked
  68778. * for a selected series.
  68779. */
  68780. selected?: boolean;
  68781. /**
  68782. * (Highcharts) Whether to apply a drop shadow to the graph line. Since 2.3
  68783. * the shadow can be an object configuration containing `color`, `offsetX`,
  68784. * `offsetY`, `opacity` and `width`.
  68785. */
  68786. shadow?: (boolean|ShadowOptionsObject);
  68787. /**
  68788. * (Highcharts) If true, a checkbox is displayed next to the legend item to
  68789. * allow selecting the series. The state of the checkbox is determined by
  68790. * the `selected` option.
  68791. */
  68792. showCheckbox?: boolean;
  68793. /**
  68794. * (Highcharts) Whether to display this particular series or series type in
  68795. * the legend. Since 2.1, pies are not shown in the legend by default.
  68796. */
  68797. showInLegend?: boolean;
  68798. /**
  68799. * (Highstock) Whether or not to show the series in the navigator. Takes
  68800. * precedence over navigator.baseSeries if defined.
  68801. */
  68802. showInNavigator?: boolean;
  68803. /**
  68804. * (Highcharts) The diameter of the pie relative to the plot area. Can be a
  68805. * percentage or pixel value. Pixel values are given as integers. The
  68806. * default behaviour (as of 3.0) is to scale to the plot area and give room
  68807. * for data labels within the plot area. slicedOffset is also included in
  68808. * the default size calculation. As a consequence, the size of the pie may
  68809. * vary when points are updated and data labels more around. In that case it
  68810. * is best to set a fixed value, for example `"75%"`.
  68811. */
  68812. size?: (number|string|null);
  68813. /**
  68814. * (Highcharts) If set to `true`, the accessibility module will skip past
  68815. * the points in this series for keyboard navigation.
  68816. */
  68817. skipKeyboardNavigation?: boolean;
  68818. /**
  68819. * (Highcharts) If a point is sliced, moved out from the center, how many
  68820. * pixels should it be moved?.
  68821. */
  68822. slicedOffset?: number;
  68823. /**
  68824. * (Highcharts) The start angle of the pie slices in degrees where 0 is top
  68825. * and 90 right.
  68826. */
  68827. startAngle?: number;
  68828. states?: SeriesStatesOptionsObject;
  68829. /**
  68830. * (Highcharts) Sticky tracking of mouse events. When true, the `mouseOut`
  68831. * event on a series isn't triggered until the mouse moves over another
  68832. * series, or out of the plot area. When false, the `mouseOut` event on a
  68833. * series is triggered when the mouse leaves the area around the series'
  68834. * graph or markers. This also implies the tooltip. When `stickyTracking` is
  68835. * false and `tooltip.shared` is false, the tooltip will be hidden when
  68836. * moving the mouse between series.
  68837. */
  68838. stickyTracking?: boolean;
  68839. /**
  68840. * (Highcharts) A configuration object for the tooltip rendering of each
  68841. * single series. Properties are inherited from tooltip, but only the
  68842. * following properties can be defined on a series level.
  68843. */
  68844. tooltip?: SeriesTooltipOptionsObject;
  68845. /**
  68846. * (Highstock) The parameter allows setting line series type and use OHLC
  68847. * indicators. Data in OHLC format is required.
  68848. */
  68849. useOhlcData?: boolean;
  68850. /**
  68851. * (Highcharts) Set the initial visibility of the series.
  68852. */
  68853. visible?: boolean;
  68854. /**
  68855. * (Highmaps) Define the z index of the series.
  68856. */
  68857. zIndex?: number;
  68858. }
  68859. /**
  68860. * (Highstock) Enable or disable the initial animation when a series is
  68861. * displayed. The animation can also be set as a configuration object. Please
  68862. * note that this option only applies to the initial animation of the series
  68863. * itself. For other animations, see chart.animation and the animation parameter
  68864. * under the API methods. The following properties are supported:
  68865. *
  68866. * - `defer`: The animation delay time in milliseconds.
  68867. *
  68868. * - `duration`: The duration of the animation in milliseconds.
  68869. *
  68870. * - `easing`: Can be a string reference to an easing function set on the `Math`
  68871. * object or a function. See the _Custom easing function_ demo below.
  68872. *
  68873. * Due to poor performance, animation is disabled in old IE browsers for several
  68874. * chart types.
  68875. */
  68876. export interface PlotPivotpointsAnimationOptions {
  68877. defer?: number;
  68878. }
  68879. /**
  68880. * (Highcharts, Highstock, Highmaps, Gantt) Enable or disable the initial
  68881. * animation when a series is displayed for the `dataLabels`. The animation can
  68882. * also be set as a configuration object. Please note that this option only
  68883. * applies to the initial animation. For other animations, see chart.animation
  68884. * and the animation parameter under the API methods. The following properties
  68885. * are supported:
  68886. *
  68887. * - `defer`: The animation delay time in milliseconds.
  68888. */
  68889. export interface PlotPivotpointsDataLabelsAnimationOptions {
  68890. /**
  68891. * (Highcharts, Highstock, Highmaps, Gantt) The animation delay time in
  68892. * milliseconds. Set to `0` renders dataLabel immediately. As `undefined`
  68893. * inherits defer time from the series.animation.defer.
  68894. */
  68895. defer?: number;
  68896. }
  68897. /**
  68898. * (Highcharts, Highstock, Highmaps, Gantt) Options for the series data labels,
  68899. * appearing next to each data point.
  68900. *
  68901. * Since v6.2.0, multiple data labels can be applied to each single point by
  68902. * defining them as an array of configs.
  68903. *
  68904. * In styled mode, the data labels can be styled with the
  68905. * `.highcharts-data-label-box` and `.highcharts-data-label` class names (see
  68906. * example).
  68907. */
  68908. export interface PlotPivotpointsDataLabelsOptions {
  68909. /**
  68910. * (Highcharts, Highstock, Highmaps, Gantt) The alignment of the data label
  68911. * compared to the point. If `right`, the right side of the label should be
  68912. * touching the point. For points with an extent, like columns, the
  68913. * alignments also dictates how to align it inside the box, as given with
  68914. * the inside option. Can be one of `left`, `center` or `right`.
  68915. */
  68916. align?: (AlignValue|null);
  68917. /**
  68918. * (Highcharts, Highstock, Highmaps, Gantt) Whether to allow data labels to
  68919. * overlap. To make the labels less sensitive for overlapping, the
  68920. * dataLabels.padding can be set to 0.
  68921. */
  68922. allowOverlap?: boolean;
  68923. /**
  68924. * (Highcharts, Highstock, Highmaps, Gantt) Enable or disable the initial
  68925. * animation when a series is displayed for the `dataLabels`. The animation
  68926. * can also be set as a configuration object. Please note that this option
  68927. * only applies to the initial animation. For other animations, see
  68928. * chart.animation and the animation parameter under the API methods. The
  68929. * following properties are supported:
  68930. *
  68931. * - `defer`: The animation delay time in milliseconds.
  68932. */
  68933. animation?: (boolean|PlotPivotpointsDataLabelsAnimationOptions|Partial<AnimationOptionsObject>);
  68934. /**
  68935. * (Highcharts, Highstock, Highmaps, Gantt) The background color or gradient
  68936. * for the data label.
  68937. */
  68938. backgroundColor?: (ColorString|GradientColorObject|PatternObject);
  68939. /**
  68940. * (Highcharts, Highstock, Highmaps, Gantt) The border color for the data
  68941. * label. Defaults to `undefined`.
  68942. */
  68943. borderColor?: (ColorString|GradientColorObject|PatternObject);
  68944. /**
  68945. * (Highcharts, Highstock, Highmaps, Gantt) The border radius in pixels for
  68946. * the data label.
  68947. */
  68948. borderRadius?: number;
  68949. /**
  68950. * (Highcharts, Highstock, Highmaps, Gantt) The border width in pixels for
  68951. * the data label.
  68952. */
  68953. borderWidth?: number;
  68954. /**
  68955. * (Highcharts, Highstock, Highmaps, Gantt) A class name for the data label.
  68956. * Particularly in styled mode, this can be used to give each series' or
  68957. * point's data label unique styling. In addition to this option, a default
  68958. * color class name is added so that we can give the labels a contrast text
  68959. * shadow.
  68960. */
  68961. className?: string;
  68962. /**
  68963. * (Highcharts, Highstock, Highmaps, Gantt) The text color for the data
  68964. * labels. Defaults to `undefined`. For certain series types, like column or
  68965. * map, the data labels can be drawn inside the points. In this case the
  68966. * data label will be drawn with maximum contrast by default. Additionally,
  68967. * it will be given a `text-outline` style with the opposite color, to
  68968. * further increase the contrast. This can be overridden by setting the
  68969. * `text-outline` style to `none` in the `dataLabels.style` option.
  68970. */
  68971. color?: (ColorString|GradientColorObject|PatternObject);
  68972. /**
  68973. * (Highcharts, Highstock, Highmaps, Gantt) Whether to hide data labels that
  68974. * are outside the plot area. By default, the data label is moved inside the
  68975. * plot area according to the overflow option.
  68976. */
  68977. crop?: boolean;
  68978. /**
  68979. * (Highcharts, Highstock, Gantt) Whether to defer displaying the data
  68980. * labels until the initial series animation has finished. Setting to
  68981. * `false` renders the data label immediately. If set to `true` inherits the
  68982. * defer time set in plotOptions.series.animation.
  68983. */
  68984. defer?: boolean;
  68985. /**
  68986. * (Highcharts, Highstock, Highmaps, Gantt) Enable or disable the data
  68987. * labels.
  68988. */
  68989. enabled?: boolean;
  68990. /**
  68991. * (Highcharts, Highstock, Highmaps, Gantt) A declarative filter to control
  68992. * of which data labels to display. The declarative filter is designed for
  68993. * use when callback functions are not available, like when the chart
  68994. * options require a pure JSON structure or for use with graphical editors.
  68995. * For programmatic control, use the `formatter` instead, and return
  68996. * `undefined` to disable a single data label.
  68997. */
  68998. filter?: DataLabelsFilterOptionsObject;
  68999. /**
  69000. * (Highcharts, Highstock, Highmaps, Gantt) A format string for the data
  69001. * label. Available variables are the same as for `formatter`.
  69002. */
  69003. format?: string;
  69004. /**
  69005. * (Highcharts, Highstock, Highmaps, Gantt) Callback JavaScript function to
  69006. * format the data label. Note that if a `format` is defined, the format
  69007. * takes precedence and the formatter is ignored.
  69008. */
  69009. formatter?: DataLabelsFormatterCallbackFunction;
  69010. /**
  69011. * (Highcharts, Highstock, Highmaps, Gantt) For points with an extent, like
  69012. * columns or map areas, whether to align the data label inside the box or
  69013. * to the actual value point. Defaults to `false` in most cases, `true` in
  69014. * stacked columns.
  69015. */
  69016. inside?: boolean;
  69017. /**
  69018. * (Highcharts, Highstock, Highmaps, Gantt) Format for points with the value
  69019. * of null. Works analogously to format. `nullFormat` can be applied only to
  69020. * series which support displaying null points.
  69021. */
  69022. nullFormat?: (boolean|string);
  69023. /**
  69024. * (Highcharts, Highstock, Highmaps, Gantt) Callback JavaScript function
  69025. * that defines formatting for points with the value of null. Works
  69026. * analogously to formatter. `nullPointFormatter` can be applied only to
  69027. * series which support displaying null points.
  69028. */
  69029. nullFormatter?: DataLabelsFormatterCallbackFunction;
  69030. /**
  69031. * (Highcharts, Highstock, Highmaps, Gantt) How to handle data labels that
  69032. * flow outside the plot area. The default is `"justify"`, which aligns them
  69033. * inside the plot area. For columns and bars, this means it will be moved
  69034. * inside the bar. To display data labels outside the plot area, set `crop`
  69035. * to `false` and `overflow` to `"allow"`.
  69036. */
  69037. overflow?: DataLabelsOverflowValue;
  69038. /**
  69039. * (Highcharts, Highstock, Highmaps, Gantt) When either the `borderWidth` or
  69040. * the `backgroundColor` is set, this is the padding within the box.
  69041. */
  69042. padding?: number;
  69043. /**
  69044. * (Highcharts, Highstock, Highmaps, Gantt) Aligns data labels relative to
  69045. * points. If `center` alignment is not possible, it defaults to `right`.
  69046. */
  69047. position?: AlignValue;
  69048. /**
  69049. * (Highcharts, Highstock, Highmaps, Gantt) Text rotation in degrees. Note
  69050. * that due to a more complex structure, backgrounds, borders and padding
  69051. * will be lost on a rotated data label.
  69052. */
  69053. rotation?: number;
  69054. /**
  69055. * (Highcharts, Highstock, Highmaps, Gantt) The shadow of the box. Works
  69056. * best with `borderWidth` or `backgroundColor`. Since 2.3 the shadow can be
  69057. * an object configuration containing `color`, `offsetX`, `offsetY`,
  69058. * `opacity` and `width`.
  69059. */
  69060. shadow?: (boolean|ShadowOptionsObject);
  69061. /**
  69062. * (Highcharts, Highstock, Highmaps, Gantt) The name of a symbol to use for
  69063. * the border around the label. Symbols are predefined functions on the
  69064. * Renderer object.
  69065. */
  69066. shape?: string;
  69067. /**
  69068. * (Highcharts, Highstock, Highmaps, Gantt) Styles for the label. The
  69069. * default `color` setting is `"contrast"`, which is a pseudo color that
  69070. * Highcharts picks up and applies the maximum contrast to the underlying
  69071. * point item, for example the bar in a bar chart.
  69072. *
  69073. * The `textOutline` is a pseudo property that applies an outline of the
  69074. * given width with the given color, which by default is the maximum
  69075. * contrast to the text. So a bright text color will result in a black text
  69076. * outline for maximum readability on a mixed background. In some cases,
  69077. * especially with grayscale text, the text outline doesn't work well, in
  69078. * which cases it can be disabled by setting it to `"none"`. When `useHTML`
  69079. * is true, the `textOutline` will not be picked up. In this, case, the same
  69080. * effect can be acheived through the `text-shadow` CSS property.
  69081. *
  69082. * For some series types, where each point has an extent, like for example
  69083. * tree maps, the data label may overflow the point. There are two
  69084. * strategies for handling overflow. By default, the text will wrap to
  69085. * multiple lines. The other strategy is to set `style.textOverflow` to
  69086. * `ellipsis`, which will keep the text on one line plus it will break
  69087. * inside long words.
  69088. */
  69089. style?: CSSObject;
  69090. /**
  69091. * (Highcharts, Highstock, Highmaps, Gantt) Options for a label text which
  69092. * should follow marker's shape. Border and background are disabled for a
  69093. * label that follows a path.
  69094. *
  69095. * **Note:** Only SVG-based renderer supports this option. Setting `useHTML`
  69096. * to true will disable this option.
  69097. */
  69098. textPath?: DataLabelsTextPathOptionsObject;
  69099. /**
  69100. * (Highcharts, Highstock, Highmaps, Gantt) Whether to use HTML to render
  69101. * the labels.
  69102. */
  69103. useHTML?: boolean;
  69104. /**
  69105. * (Highcharts, Highstock, Highmaps, Gantt) The vertical alignment of a data
  69106. * label. Can be one of `top`, `middle` or `bottom`. The default value
  69107. * depends on the data, for instance in a column chart, the label is above
  69108. * positive values and below negative values.
  69109. */
  69110. verticalAlign?: (VerticalAlignValue|null);
  69111. /**
  69112. * (Highcharts, Highstock, Highmaps, Gantt) The x position offset of the
  69113. * label relative to the point in pixels.
  69114. */
  69115. x?: number;
  69116. /**
  69117. * (Highcharts, Highstock, Highmaps, Gantt) The y position offset of the
  69118. * label relative to the point in pixels.
  69119. */
  69120. y?: number;
  69121. /**
  69122. * (Highcharts, Highstock, Highmaps, Gantt) The Z index of the data labels.
  69123. * The default Z index puts it above the series. Use a Z index of 2 to
  69124. * display it behind the series.
  69125. */
  69126. z?: number;
  69127. }
  69128. /**
  69129. * (Highcharts, Highstock) Options for the series data sorting.
  69130. */
  69131. export interface PlotPivotpointsDataSortingOptions {
  69132. /**
  69133. * (Highcharts, Highstock) Enable or disable data sorting for the series.
  69134. * Use xAxis.reversed to change the sorting order.
  69135. */
  69136. enabled?: boolean;
  69137. /**
  69138. * (Highcharts, Highstock) Whether to allow matching points by name in an
  69139. * update. If this option is disabled, points will be matched by order.
  69140. */
  69141. matchByName?: boolean;
  69142. /**
  69143. * (Highcharts, Highstock) Determines what data value should be used to sort
  69144. * by.
  69145. */
  69146. sortKey?: string;
  69147. }
  69148. /**
  69149. * (Highstock) Pivot points indicator. This series requires the `linkedTo`
  69150. * option to be set and should be loaded after `stock/indicators/indicators.js`
  69151. * file.
  69152. *
  69153. * In TypeScript the type option must always be set.
  69154. *
  69155. * Configuration options for the series are given in three levels:
  69156. *
  69157. * 1. Options for all series in a chart are defined in the plotOptions.series
  69158. * object.
  69159. *
  69160. * 2. Options for all `pivotpoints` series are defined in
  69161. * plotOptions.pivotpoints.
  69162. *
  69163. * 3. Options for one single series are given in the series instance array. (see
  69164. * online documentation for example)
  69165. */
  69166. export interface PlotPivotpointsOptions {
  69167. /**
  69168. * (Highstock) Accessibility options for a series.
  69169. */
  69170. accessibility?: SeriesAccessibilityOptionsObject;
  69171. /**
  69172. * (Highstock) Allow this series' points to be selected by clicking on the
  69173. * graphic (columns, point markers, pie slices, map areas etc).
  69174. *
  69175. * The selected points can be handled by point select and unselect events,
  69176. * or collectively by the getSelectedPoints function.
  69177. *
  69178. * And alternative way of selecting points is through dragging.
  69179. */
  69180. allowPointSelect?: boolean;
  69181. /**
  69182. * (Highstock) Enable or disable the initial animation when a series is
  69183. * displayed. The animation can also be set as a configuration object.
  69184. * Please note that this option only applies to the initial animation of the
  69185. * series itself. For other animations, see chart.animation and the
  69186. * animation parameter under the API methods. The following properties are
  69187. * supported:
  69188. *
  69189. * - `defer`: The animation delay time in milliseconds.
  69190. *
  69191. * - `duration`: The duration of the animation in milliseconds.
  69192. *
  69193. * - `easing`: Can be a string reference to an easing function set on the
  69194. * `Math` object or a function. See the _Custom easing function_ demo below.
  69195. *
  69196. * Due to poor performance, animation is disabled in old IE browsers for
  69197. * several chart types.
  69198. */
  69199. animation?: (boolean|PlotPivotpointsAnimationOptions|Partial<AnimationOptionsObject>);
  69200. /**
  69201. * (Highstock) For some series, there is a limit that shuts down initial
  69202. * animation by default when the total number of points in the chart is too
  69203. * high. For example, for a column chart and its derivatives, animation does
  69204. * not run if there is more than 250 points totally. To disable this cap,
  69205. * set `animationLimit` to `Infinity`.
  69206. */
  69207. animationLimit?: number;
  69208. /**
  69209. * (Highstock) Sets the color blending in the boost module.
  69210. */
  69211. boostBlending?: OptionsBoostBlendingValue;
  69212. /**
  69213. * (Highstock) Set the point threshold for when a series should enter boost
  69214. * mode.
  69215. *
  69216. * Setting it to e.g. 2000 will cause the series to enter boost mode when
  69217. * there are 2000 or more points in the series.
  69218. *
  69219. * To disable boosting on the series, set the `boostThreshold` to 0. Setting
  69220. * it to 1 will force boosting.
  69221. *
  69222. * Note that the cropThreshold also affects this setting. When zooming in on
  69223. * a series that has fewer points than the `cropThreshold`, all points are
  69224. * rendered although outside the visible plot area, and the `boostThreshold`
  69225. * won't take effect.
  69226. */
  69227. boostThreshold?: number;
  69228. /**
  69229. * (Highmaps) The border color of the map areas.
  69230. *
  69231. * In styled mode, the border stroke is given in the `.highcharts-point`
  69232. * class.
  69233. */
  69234. borderColor?: (ColorString|GradientColorObject|PatternObject);
  69235. /**
  69236. * (Highmaps) The border width of each map area.
  69237. *
  69238. * In styled mode, the border stroke width is given in the
  69239. * `.highcharts-point` class.
  69240. */
  69241. borderWidth?: number;
  69242. /**
  69243. * (Highstock) An additional class name to apply to the series' graphical
  69244. * elements. This option does not replace default class names of the
  69245. * graphical element.
  69246. */
  69247. className?: string;
  69248. /**
  69249. * (Highstock) Disable this option to allow series rendering in the whole
  69250. * plotting area.
  69251. *
  69252. * **Note:** Clipping should be always enabled when chart.zoomType is set
  69253. */
  69254. clip?: boolean;
  69255. /**
  69256. * (Highstock) The main color of the series. In line type series it applies
  69257. * to the line and the point markers unless otherwise specified. In bar type
  69258. * series it applies to the bars unless a color is specified per point. The
  69259. * default value is pulled from the `options.colors` array.
  69260. *
  69261. * In styled mode, the color can be defined by the colorIndex option. Also,
  69262. * the series color can be set with the `.highcharts-series`,
  69263. * `.highcharts-color-{n}`, `.highcharts-{type}-series` or
  69264. * `.highcharts-series-{n}` class, or individual classes given by the
  69265. * `className` option.
  69266. */
  69267. color?: (ColorString|GradientColorObject|PatternObject);
  69268. /**
  69269. * (Highstock) Styled mode only. A specific color index to use for the
  69270. * series, so its graphic representations are given the class name
  69271. * `highcharts-color-{n}`.
  69272. */
  69273. colorIndex?: number;
  69274. /**
  69275. * (Highcharts, Highstock, Highmaps) Determines what data value should be
  69276. * used to calculate point color if `colorAxis` is used. Requires to set
  69277. * `min` and `max` if some custom point property is used or if approximation
  69278. * for data grouping is set to `'sum'`.
  69279. */
  69280. colorKey?: string;
  69281. /**
  69282. * (Highstock) Compare the values of the series against the first non-null,
  69283. * non- zero value in the visible range. The y axis will show percentage or
  69284. * absolute change depending on whether `compare` is set to `"percent"` or
  69285. * `"value"`. When this is applied to multiple series, it allows comparing
  69286. * the development of the series against each other. Adds a `change` field
  69287. * to every point object.
  69288. */
  69289. compare?: string;
  69290. /**
  69291. * (Highstock) When compare is `percent`, this option dictates whether to
  69292. * use 0 or 100 as the base of comparison.
  69293. */
  69294. compareBase?: (0|100);
  69295. /**
  69296. * (Highstock) Defines if comparison should start from the first point
  69297. * within the visible range or should start from the first point **before**
  69298. * the range.
  69299. *
  69300. * In other words, this flag determines if first point within the visible
  69301. * range will have 0% (`compareStart=true`) or should have been already
  69302. * calculated according to the previous point (`compareStart=false`).
  69303. */
  69304. compareStart?: boolean;
  69305. /**
  69306. * (Highstock) Whether to compare indicator to the main series values or
  69307. * indicator values.
  69308. */
  69309. compareToMain?: boolean;
  69310. /**
  69311. * (Highcharts) Polar charts only. Whether to connect the ends of a line
  69312. * series plot across the extremes.
  69313. */
  69314. connectEnds?: boolean;
  69315. /**
  69316. * (Highcharts, Highstock) Whether to connect a graph line across null
  69317. * points, or render a gap between the two points on either side of the
  69318. * null.
  69319. */
  69320. connectNulls?: boolean;
  69321. /**
  69322. * (Gantt) Override Pathfinder connector options for a series. Requires
  69323. * Highcharts Gantt to be loaded.
  69324. */
  69325. connectors?: SeriesConnectorsOptionsObject;
  69326. /**
  69327. * (Highcharts, Highstock, Gantt) When true, each point or column edge is
  69328. * rounded to its nearest pixel in order to render sharp on screen. In some
  69329. * cases, when there are a lot of densely packed columns, this leads to
  69330. * visible difference in column widths or distance between columns. In these
  69331. * cases, setting `crisp` to `false` may look better, even though each
  69332. * column is rendered blurry.
  69333. */
  69334. crisp?: boolean;
  69335. /**
  69336. * (Highcharts, Highstock) When the series contains less points than the
  69337. * crop threshold, all points are drawn, even if the points fall outside the
  69338. * visible plot area at the current zoom. The advantage of drawing all
  69339. * points (including markers and columns), is that animation is performed on
  69340. * updates. On the other hand, when the series contains more points than the
  69341. * crop threshold, the series data is cropped to only contain points that
  69342. * fall within the plot area. The advantage of cropping away invisible
  69343. * points is to increase performance on large series.
  69344. */
  69345. cropThreshold?: number;
  69346. /**
  69347. * (Highstock) You can set the cursor to "pointer" if you have click events
  69348. * attached to the series, to signal to the user that the points and lines
  69349. * can be clicked.
  69350. *
  69351. * In styled mode, the series cursor can be set with the same classes as
  69352. * listed under series.color.
  69353. */
  69354. cursor?: (string|CursorValue);
  69355. /**
  69356. * (Highstock) A reserved subspace to store options and values for
  69357. * customized functionality. Here you can add additional data for your own
  69358. * event callbacks and formatter callbacks.
  69359. */
  69360. custom?: Dictionary<any>;
  69361. /**
  69362. * (Highstock) Name of the dash style to use for the graph, or for some
  69363. * series types the outline of each shape.
  69364. *
  69365. * In styled mode, the stroke dash-array can be set with the same classes as
  69366. * listed under series.color.
  69367. */
  69368. dashStyle?: DashStyleValue;
  69369. /**
  69370. * (Highstock) Data grouping is the concept of sampling the data values into
  69371. * larger blocks in order to ease readability and increase performance of
  69372. * the JavaScript charts. Highstock by default applies data grouping when
  69373. * the points become closer than a certain pixel value, determined by the
  69374. * `groupPixelWidth` option.
  69375. *
  69376. * If data grouping is applied, the grouping information of grouped points
  69377. * can be read from the Point.dataGroup. If point options other than the
  69378. * data itself are set, for example `name` or `color` or custom properties,
  69379. * the grouping logic doesn't know how to group it. In this case the options
  69380. * of the first point instance are copied over to the group point. This can
  69381. * be altered through a custom `approximation` callback function.
  69382. */
  69383. dataGrouping?: DataGroupingOptionsObject;
  69384. /**
  69385. * (Highcharts, Highstock, Highmaps, Gantt) Options for the series data
  69386. * labels, appearing next to each data point.
  69387. *
  69388. * Since v6.2.0, multiple data labels can be applied to each single point by
  69389. * defining them as an array of configs.
  69390. *
  69391. * In styled mode, the data labels can be styled with the
  69392. * `.highcharts-data-label-box` and `.highcharts-data-label` class names
  69393. * (see example).
  69394. */
  69395. dataLabels?: (PlotPivotpointsDataLabelsOptions|Array<PlotPivotpointsDataLabelsOptions>);
  69396. /**
  69397. * (Highcharts, Highstock) Options for the series data sorting.
  69398. */
  69399. dataSorting?: (DataSortingOptionsObject|PlotPivotpointsDataSortingOptions);
  69400. /**
  69401. * (Highstock) A description of the series to add to the screen reader
  69402. * information about the series.
  69403. */
  69404. description?: string;
  69405. /**
  69406. * (Highstock) Enable or disable the mouse tracking for a specific series.
  69407. * This includes point tooltips and click events on graphs and points. For
  69408. * large datasets it improves performance.
  69409. */
  69410. enableMouseTracking?: boolean;
  69411. /**
  69412. * (Highstock) General event handlers for the series items. These event
  69413. * hooks can also be attached to the series at run time using the
  69414. * `Highcharts.addEvent` function.
  69415. */
  69416. events?: SeriesEventsOptionsObject;
  69417. /**
  69418. * (Highstock) Determines whether the series should look for the nearest
  69419. * point in both dimensions or just the x-dimension when hovering the
  69420. * series. Defaults to `'xy'` for scatter series and `'x'` for most other
  69421. * series. If the data has duplicate x-values, it is recommended to set this
  69422. * to `'xy'` to allow hovering over all points.
  69423. *
  69424. * Applies only to series types using nearest neighbor search (not direct
  69425. * hover) for tooltip.
  69426. */
  69427. findNearestPointBy?: OptionsFindNearestPointByValue;
  69428. /**
  69429. * (Highstock) Defines when to display a gap in the graph, together with the
  69430. * gapUnit option.
  69431. *
  69432. * In case when `dataGrouping` is enabled, points can be grouped into a
  69433. * larger time span. This can make the grouped points to have a greater
  69434. * distance than the absolute value of `gapSize` property, which will result
  69435. * in disappearing graph completely. To prevent this situation the mentioned
  69436. * distance between grouped points is used instead of previously defined
  69437. * `gapSize`.
  69438. *
  69439. * In practice, this option is most often used to visualize gaps in time
  69440. * series. In a stock chart, intraday data is available for daytime hours,
  69441. * while gaps will appear in nights and weekends.
  69442. */
  69443. gapSize?: number;
  69444. /**
  69445. * (Highstock) Together with gapSize, this option defines where to draw gaps
  69446. * in the graph.
  69447. *
  69448. * When the `gapUnit` is `"relative"` (default), a gap size of 5 means that
  69449. * if the distance between two points is greater than 5 times that of the
  69450. * two closest points, the graph will be broken.
  69451. *
  69452. * When the `gapUnit` is `"value"`, the gap is based on absolute axis
  69453. * values, which on a datetime axis is milliseconds. This also applies to
  69454. * the navigator series that inherits gap options from the base series.
  69455. */
  69456. gapUnit?: OptionsGapUnitValue;
  69457. /**
  69458. * (Highcharts, Highstock, Gantt) Whether to use the Y extremes of the total
  69459. * chart width or only the zoomed area when zooming in on parts of the X
  69460. * axis. By default, the Y axis adjusts to the min and max of the visible
  69461. * data. Cartesian series only.
  69462. */
  69463. getExtremesFromAll?: boolean;
  69464. /**
  69465. * (Highstock) When set to `false` will prevent the series data from being
  69466. * included in any form of data export.
  69467. *
  69468. * Since version 6.0.0 until 7.1.0 the option was existing undocumented as
  69469. * `includeInCSVExport`.
  69470. */
  69471. includeInDataExport?: boolean;
  69472. /**
  69473. * (Highcharts, Highstock, Gantt) Series labels are placed as close to the
  69474. * series as possible in a natural way, seeking to avoid other series. The
  69475. * goal of this feature is to make the chart more easily readable, like if a
  69476. * human designer placed the labels in the optimal position.
  69477. *
  69478. * The series labels currently work with series types having a `graph` or an
  69479. * `area`.
  69480. */
  69481. label?: SeriesLabelOptionsObject;
  69482. /**
  69483. * (Highstock) The line marks the last price from all points.
  69484. */
  69485. lastPrice?: SeriesLastPriceOptionsObject;
  69486. /**
  69487. * (Highstock) The line marks the last price from visible range of points.
  69488. */
  69489. lastVisiblePrice?: SeriesLastVisiblePriceOptionsObject;
  69490. /**
  69491. * (Highcharts, Highstock) The SVG value used for the `stroke-linecap` and
  69492. * `stroke-linejoin` of a line graph. Round means that lines are rounded in
  69493. * the ends and bends.
  69494. */
  69495. linecap?: SeriesLinecapValue;
  69496. /**
  69497. * (Highcharts, Highstock) Pixel width of the graph line.
  69498. */
  69499. lineWidth?: number;
  69500. /**
  69501. * (Highcharts, Highstock, Gantt) The main series ID that indicator will be
  69502. * based on. Required for this indicator.
  69503. */
  69504. linkedTo?: string;
  69505. /**
  69506. * (Highstock) Options for the point markers of line-like series. Properties
  69507. * like `fillColor`, `lineColor` and `lineWidth` define the visual
  69508. * appearance of the markers. Other series types, like column series, don't
  69509. * have markers, but have visual options on the series level instead.
  69510. *
  69511. * In styled mode, the markers can be styled with the `.highcharts-point`,
  69512. * `.highcharts-point-hover` and `.highcharts-point-select` class names.
  69513. */
  69514. marker?: PointMarkerOptionsObject;
  69515. /**
  69516. * (Highstock) The name of the series as shown in the legend, tooltip etc.
  69517. * If not set, it will be based on a technical indicator type and default
  69518. * params.
  69519. */
  69520. name?: string;
  69521. /**
  69522. * (Highstock) The color for the parts of the graph or points that are below
  69523. * the threshold. Note that `zones` takes precedence over the negative
  69524. * color. Using `negativeColor` is equivalent to applying a zone with value
  69525. * of 0.
  69526. */
  69527. negativeColor?: (ColorString|GradientColorObject|PatternObject);
  69528. /**
  69529. * (Highstock) Opacity of a series parts: line, fill (e.g. area) and
  69530. * dataLabels.
  69531. */
  69532. opacity?: number;
  69533. /**
  69534. * (Highstock) Paramters used in calculation of regression series' points.
  69535. */
  69536. params?: PlotPivotpointsParamsOptions;
  69537. /**
  69538. * (Highstock) Properties for each single point.
  69539. */
  69540. point?: PlotSeriesPointOptions;
  69541. /**
  69542. * (Highstock) Same as accessibility.pointDescriptionFormatter, but for an
  69543. * individual series. Overrides the chart wide configuration.
  69544. */
  69545. pointDescriptionFormatter?: Function;
  69546. /**
  69547. * (Highstock) Whether to select the series initially. If `showCheckbox` is
  69548. * true, the checkbox next to the series name in the legend will be checked
  69549. * for a selected series.
  69550. */
  69551. selected?: boolean;
  69552. /**
  69553. * (Highstock) Whether to apply a drop shadow to the graph line. Since 2.3
  69554. * the shadow can be an object configuration containing `color`, `offsetX`,
  69555. * `offsetY`, `opacity` and `width`.
  69556. */
  69557. shadow?: (boolean|ShadowOptionsObject);
  69558. /**
  69559. * (Highstock) If true, a checkbox is displayed next to the legend item to
  69560. * allow selecting the series. The state of the checkbox is determined by
  69561. * the `selected` option.
  69562. */
  69563. showCheckbox?: boolean;
  69564. /**
  69565. * (Highstock) Whether to display this particular series or series type in
  69566. * the legend. Standalone series are shown in legend by default, and linked
  69567. * series are not. Since v7.2.0 it is possible to show series that use
  69568. * colorAxis by setting this option to `true`.
  69569. */
  69570. showInLegend?: boolean;
  69571. /**
  69572. * (Highstock) If set to `true`, the accessibility module will skip past the
  69573. * points in this series for keyboard navigation.
  69574. */
  69575. skipKeyboardNavigation?: boolean;
  69576. /**
  69577. * (Highcharts, Highstock) When this is true, the series will not cause the
  69578. * Y axis to cross the zero plane (or threshold option) unless the data
  69579. * actually crosses the plane.
  69580. *
  69581. * For example, if `softThreshold` is `false`, a series of 0, 1, 2, 3 will
  69582. * make the Y axis show negative values according to the `minPadding`
  69583. * option. If `softThreshold` is `true`, the Y axis starts at 0.
  69584. */
  69585. softThreshold?: boolean;
  69586. states?: SeriesStatesOptionsObject;
  69587. /**
  69588. * (Highcharts, Highstock) Whether to apply steps to the line. Possible
  69589. * values are `left`, `center` and `right`.
  69590. */
  69591. step?: OptionsStepValue;
  69592. /**
  69593. * (Highstock) Sticky tracking of mouse events. When true, the `mouseOut`
  69594. * event on a series isn't triggered until the mouse moves over another
  69595. * series, or out of the plot area. When false, the `mouseOut` event on a
  69596. * series is triggered when the mouse leaves the area around the series'
  69597. * graph or markers. This also implies the tooltip when not shared. When
  69598. * `stickyTracking` is false and `tooltip.shared` is false, the tooltip will
  69599. * be hidden when moving the mouse between series. Defaults to true for line
  69600. * and area type series, but to false for columns, pies etc.
  69601. *
  69602. * **Note:** The boost module will force this option because of technical
  69603. * limitations.
  69604. */
  69605. stickyTracking?: boolean;
  69606. /**
  69607. * (Highcharts, Highstock) The threshold, also called zero level or base
  69608. * level. For line type series this is only used in conjunction with
  69609. * negativeColor.
  69610. */
  69611. threshold?: (number|null);
  69612. /**
  69613. * (Highstock) A configuration object for the tooltip rendering of each
  69614. * single series. Properties are inherited from tooltip, but only the
  69615. * following properties can be defined on a series level.
  69616. */
  69617. tooltip?: SeriesTooltipOptionsObject;
  69618. /**
  69619. * (Highcharts, Highstock, Gantt) When a series contains a data array that
  69620. * is longer than this, only one dimensional arrays of numbers, or two
  69621. * dimensional arrays with x and y values are allowed. Also, only the first
  69622. * point is tested, and the rest are assumed to be the same format. This
  69623. * saves expensive data checking and indexing in long series. Set it to `0`
  69624. * disable.
  69625. *
  69626. * Note: In boost mode turbo threshold is forced. Only array of numbers or
  69627. * two dimensional arrays are allowed.
  69628. */
  69629. turboThreshold?: number;
  69630. /**
  69631. * (Highstock) Set the initial visibility of the series.
  69632. */
  69633. visible?: boolean;
  69634. /**
  69635. * (Highmaps) Define the z index of the series.
  69636. */
  69637. zIndex?: number;
  69638. /**
  69639. * (Highcharts, Highstock) Defines the Axis on which the zones are applied.
  69640. */
  69641. zoneAxis?: string;
  69642. /**
  69643. * (Highcharts, Highstock) An array defining zones within a series. Zones
  69644. * can be applied to the X axis, Y axis or Z axis for bubbles, according to
  69645. * the `zoneAxis` option. The zone definitions have to be in ascending order
  69646. * regarding to the value.
  69647. *
  69648. * In styled mode, the color zones are styled with the
  69649. * `.highcharts-zone-{n}` class, or custom classed from the `className`
  69650. * option (view live demo).
  69651. */
  69652. zones?: Array<SeriesZonesOptionsObject>;
  69653. }
  69654. /**
  69655. * (Highstock) Paramters used in calculation of regression series' points.
  69656. */
  69657. export interface PlotPivotpointsParamsOptions {
  69658. /**
  69659. * (Highstock) Algorithm used to calculate ressistance and support lines
  69660. * based on pivot points. Implemented algorithms: `'standard'`,
  69661. * `'fibonacci'` and `'camarilla'`
  69662. */
  69663. algorithm?: string;
  69664. /**
  69665. * (Highstock) The base period for indicator calculations. This is the
  69666. * number of data points which are taken into account for the indicator
  69667. * calculations.
  69668. */
  69669. period?: number;
  69670. }
  69671. /**
  69672. * (Highcharts, Highstock) Enable or disable the initial animation when a series
  69673. * is displayed. The animation can also be set as a configuration object. Please
  69674. * note that this option only applies to the initial animation of the series
  69675. * itself. For other animations, see chart.animation and the animation parameter
  69676. * under the API methods. The following properties are supported:
  69677. *
  69678. * - `defer`: The animation delay time in milliseconds.
  69679. *
  69680. * - `duration`: The duration of the animation in milliseconds.
  69681. *
  69682. * - `easing`: Can be a string reference to an easing function set on the `Math`
  69683. * object or a function. See the _Custom easing function_ demo below.
  69684. *
  69685. * Due to poor performance, animation is disabled in old IE browsers for several
  69686. * chart types.
  69687. */
  69688. export interface PlotPolygonAnimationOptions {
  69689. defer?: number;
  69690. }
  69691. /**
  69692. * (Highcharts, Highstock, Highmaps, Gantt) Enable or disable the initial
  69693. * animation when a series is displayed for the `dataLabels`. The animation can
  69694. * also be set as a configuration object. Please note that this option only
  69695. * applies to the initial animation. For other animations, see chart.animation
  69696. * and the animation parameter under the API methods. The following properties
  69697. * are supported:
  69698. *
  69699. * - `defer`: The animation delay time in milliseconds.
  69700. */
  69701. export interface PlotPolygonDataLabelsAnimationOptions {
  69702. /**
  69703. * (Highcharts, Highstock, Highmaps, Gantt) The animation delay time in
  69704. * milliseconds. Set to `0` renders dataLabel immediately. As `undefined`
  69705. * inherits defer time from the series.animation.defer.
  69706. */
  69707. defer?: number;
  69708. }
  69709. /**
  69710. * (Highcharts, Highstock, Highmaps, Gantt) Options for the series data labels,
  69711. * appearing next to each data point.
  69712. *
  69713. * Since v6.2.0, multiple data labels can be applied to each single point by
  69714. * defining them as an array of configs.
  69715. *
  69716. * In styled mode, the data labels can be styled with the
  69717. * `.highcharts-data-label-box` and `.highcharts-data-label` class names (see
  69718. * example).
  69719. */
  69720. export interface PlotPolygonDataLabelsOptions {
  69721. /**
  69722. * (Highcharts, Highstock, Highmaps, Gantt) The alignment of the data label
  69723. * compared to the point. If `right`, the right side of the label should be
  69724. * touching the point. For points with an extent, like columns, the
  69725. * alignments also dictates how to align it inside the box, as given with
  69726. * the inside option. Can be one of `left`, `center` or `right`.
  69727. */
  69728. align?: (AlignValue|null);
  69729. /**
  69730. * (Highcharts, Highstock, Highmaps, Gantt) Whether to allow data labels to
  69731. * overlap. To make the labels less sensitive for overlapping, the
  69732. * dataLabels.padding can be set to 0.
  69733. */
  69734. allowOverlap?: boolean;
  69735. /**
  69736. * (Highcharts, Highstock, Highmaps, Gantt) Enable or disable the initial
  69737. * animation when a series is displayed for the `dataLabels`. The animation
  69738. * can also be set as a configuration object. Please note that this option
  69739. * only applies to the initial animation. For other animations, see
  69740. * chart.animation and the animation parameter under the API methods. The
  69741. * following properties are supported:
  69742. *
  69743. * - `defer`: The animation delay time in milliseconds.
  69744. */
  69745. animation?: (boolean|PlotPolygonDataLabelsAnimationOptions|Partial<AnimationOptionsObject>);
  69746. /**
  69747. * (Highcharts, Highstock, Highmaps, Gantt) The background color or gradient
  69748. * for the data label.
  69749. */
  69750. backgroundColor?: (ColorString|GradientColorObject|PatternObject);
  69751. /**
  69752. * (Highcharts, Highstock, Highmaps, Gantt) The border color for the data
  69753. * label. Defaults to `undefined`.
  69754. */
  69755. borderColor?: (ColorString|GradientColorObject|PatternObject);
  69756. /**
  69757. * (Highcharts, Highstock, Highmaps, Gantt) The border radius in pixels for
  69758. * the data label.
  69759. */
  69760. borderRadius?: number;
  69761. /**
  69762. * (Highcharts, Highstock, Highmaps, Gantt) The border width in pixels for
  69763. * the data label.
  69764. */
  69765. borderWidth?: number;
  69766. /**
  69767. * (Highcharts, Highstock, Highmaps, Gantt) A class name for the data label.
  69768. * Particularly in styled mode, this can be used to give each series' or
  69769. * point's data label unique styling. In addition to this option, a default
  69770. * color class name is added so that we can give the labels a contrast text
  69771. * shadow.
  69772. */
  69773. className?: string;
  69774. /**
  69775. * (Highcharts, Highstock, Highmaps, Gantt) The text color for the data
  69776. * labels. Defaults to `undefined`. For certain series types, like column or
  69777. * map, the data labels can be drawn inside the points. In this case the
  69778. * data label will be drawn with maximum contrast by default. Additionally,
  69779. * it will be given a `text-outline` style with the opposite color, to
  69780. * further increase the contrast. This can be overridden by setting the
  69781. * `text-outline` style to `none` in the `dataLabels.style` option.
  69782. */
  69783. color?: (ColorString|GradientColorObject|PatternObject);
  69784. /**
  69785. * (Highcharts, Highstock, Highmaps, Gantt) Whether to hide data labels that
  69786. * are outside the plot area. By default, the data label is moved inside the
  69787. * plot area according to the overflow option.
  69788. */
  69789. crop?: boolean;
  69790. /**
  69791. * (Highcharts, Highstock, Gantt) Whether to defer displaying the data
  69792. * labels until the initial series animation has finished. Setting to
  69793. * `false` renders the data label immediately. If set to `true` inherits the
  69794. * defer time set in plotOptions.series.animation.
  69795. */
  69796. defer?: boolean;
  69797. /**
  69798. * (Highcharts, Highstock, Highmaps, Gantt) Enable or disable the data
  69799. * labels.
  69800. */
  69801. enabled?: boolean;
  69802. /**
  69803. * (Highcharts, Highstock, Highmaps, Gantt) A declarative filter to control
  69804. * of which data labels to display. The declarative filter is designed for
  69805. * use when callback functions are not available, like when the chart
  69806. * options require a pure JSON structure or for use with graphical editors.
  69807. * For programmatic control, use the `formatter` instead, and return
  69808. * `undefined` to disable a single data label.
  69809. */
  69810. filter?: DataLabelsFilterOptionsObject;
  69811. /**
  69812. * (Highcharts, Highstock, Highmaps, Gantt) A format string for the data
  69813. * label. Available variables are the same as for `formatter`.
  69814. */
  69815. format?: string;
  69816. /**
  69817. * (Highcharts, Highstock, Highmaps, Gantt) Callback JavaScript function to
  69818. * format the data label. Note that if a `format` is defined, the format
  69819. * takes precedence and the formatter is ignored.
  69820. */
  69821. formatter?: DataLabelsFormatterCallbackFunction;
  69822. /**
  69823. * (Highcharts, Highstock, Highmaps, Gantt) For points with an extent, like
  69824. * columns or map areas, whether to align the data label inside the box or
  69825. * to the actual value point. Defaults to `false` in most cases, `true` in
  69826. * stacked columns.
  69827. */
  69828. inside?: boolean;
  69829. /**
  69830. * (Highcharts, Highstock, Highmaps, Gantt) Format for points with the value
  69831. * of null. Works analogously to format. `nullFormat` can be applied only to
  69832. * series which support displaying null points.
  69833. */
  69834. nullFormat?: (boolean|string);
  69835. /**
  69836. * (Highcharts, Highstock, Highmaps, Gantt) Callback JavaScript function
  69837. * that defines formatting for points with the value of null. Works
  69838. * analogously to formatter. `nullPointFormatter` can be applied only to
  69839. * series which support displaying null points.
  69840. */
  69841. nullFormatter?: DataLabelsFormatterCallbackFunction;
  69842. /**
  69843. * (Highcharts, Highstock, Highmaps, Gantt) How to handle data labels that
  69844. * flow outside the plot area. The default is `"justify"`, which aligns them
  69845. * inside the plot area. For columns and bars, this means it will be moved
  69846. * inside the bar. To display data labels outside the plot area, set `crop`
  69847. * to `false` and `overflow` to `"allow"`.
  69848. */
  69849. overflow?: DataLabelsOverflowValue;
  69850. /**
  69851. * (Highcharts, Highstock, Highmaps, Gantt) When either the `borderWidth` or
  69852. * the `backgroundColor` is set, this is the padding within the box.
  69853. */
  69854. padding?: number;
  69855. /**
  69856. * (Highcharts, Highstock, Highmaps, Gantt) Aligns data labels relative to
  69857. * points. If `center` alignment is not possible, it defaults to `right`.
  69858. */
  69859. position?: AlignValue;
  69860. /**
  69861. * (Highcharts, Highstock, Highmaps, Gantt) Text rotation in degrees. Note
  69862. * that due to a more complex structure, backgrounds, borders and padding
  69863. * will be lost on a rotated data label.
  69864. */
  69865. rotation?: number;
  69866. /**
  69867. * (Highcharts, Highstock, Highmaps, Gantt) The shadow of the box. Works
  69868. * best with `borderWidth` or `backgroundColor`. Since 2.3 the shadow can be
  69869. * an object configuration containing `color`, `offsetX`, `offsetY`,
  69870. * `opacity` and `width`.
  69871. */
  69872. shadow?: (boolean|ShadowOptionsObject);
  69873. /**
  69874. * (Highcharts, Highstock, Highmaps, Gantt) The name of a symbol to use for
  69875. * the border around the label. Symbols are predefined functions on the
  69876. * Renderer object.
  69877. */
  69878. shape?: string;
  69879. /**
  69880. * (Highcharts, Highstock, Highmaps, Gantt) Styles for the label. The
  69881. * default `color` setting is `"contrast"`, which is a pseudo color that
  69882. * Highcharts picks up and applies the maximum contrast to the underlying
  69883. * point item, for example the bar in a bar chart.
  69884. *
  69885. * The `textOutline` is a pseudo property that applies an outline of the
  69886. * given width with the given color, which by default is the maximum
  69887. * contrast to the text. So a bright text color will result in a black text
  69888. * outline for maximum readability on a mixed background. In some cases,
  69889. * especially with grayscale text, the text outline doesn't work well, in
  69890. * which cases it can be disabled by setting it to `"none"`. When `useHTML`
  69891. * is true, the `textOutline` will not be picked up. In this, case, the same
  69892. * effect can be acheived through the `text-shadow` CSS property.
  69893. *
  69894. * For some series types, where each point has an extent, like for example
  69895. * tree maps, the data label may overflow the point. There are two
  69896. * strategies for handling overflow. By default, the text will wrap to
  69897. * multiple lines. The other strategy is to set `style.textOverflow` to
  69898. * `ellipsis`, which will keep the text on one line plus it will break
  69899. * inside long words.
  69900. */
  69901. style?: CSSObject;
  69902. /**
  69903. * (Highcharts, Highstock, Highmaps, Gantt) Options for a label text which
  69904. * should follow marker's shape. Border and background are disabled for a
  69905. * label that follows a path.
  69906. *
  69907. * **Note:** Only SVG-based renderer supports this option. Setting `useHTML`
  69908. * to true will disable this option.
  69909. */
  69910. textPath?: DataLabelsTextPathOptionsObject;
  69911. /**
  69912. * (Highcharts, Highstock, Highmaps, Gantt) Whether to use HTML to render
  69913. * the labels.
  69914. */
  69915. useHTML?: boolean;
  69916. /**
  69917. * (Highcharts, Highstock, Highmaps, Gantt) The vertical alignment of a data
  69918. * label. Can be one of `top`, `middle` or `bottom`. The default value
  69919. * depends on the data, for instance in a column chart, the label is above
  69920. * positive values and below negative values.
  69921. */
  69922. verticalAlign?: (VerticalAlignValue|null);
  69923. /**
  69924. * (Highcharts, Highstock, Highmaps, Gantt) The x position offset of the
  69925. * label relative to the point in pixels.
  69926. */
  69927. x?: number;
  69928. /**
  69929. * (Highcharts, Highstock, Highmaps, Gantt) The y position offset of the
  69930. * label relative to the point in pixels.
  69931. */
  69932. y?: number;
  69933. /**
  69934. * (Highcharts, Highstock, Highmaps, Gantt) The Z index of the data labels.
  69935. * The default Z index puts it above the series. Use a Z index of 2 to
  69936. * display it behind the series.
  69937. */
  69938. z?: number;
  69939. }
  69940. /**
  69941. * (Highcharts, Highstock) Options for the series data sorting.
  69942. */
  69943. export interface PlotPolygonDataSortingOptions {
  69944. /**
  69945. * (Highcharts, Highstock) Enable or disable data sorting for the series.
  69946. * Use xAxis.reversed to change the sorting order.
  69947. */
  69948. enabled?: boolean;
  69949. /**
  69950. * (Highcharts, Highstock) Whether to allow matching points by name in an
  69951. * update. If this option is disabled, points will be matched by order.
  69952. */
  69953. matchByName?: boolean;
  69954. /**
  69955. * (Highcharts, Highstock) Determines what data value should be used to sort
  69956. * by.
  69957. */
  69958. sortKey?: string;
  69959. }
  69960. /**
  69961. * (Highcharts, Highstock) Style options for the guide box. The guide box has
  69962. * one state by default, the `default` state.
  69963. */
  69964. export interface PlotPolygonDragDropGuideBoxOptions {
  69965. /**
  69966. * (Highcharts, Highstock) Style options for the guide box default state.
  69967. */
  69968. default?: DragDropGuideBoxOptionsObject;
  69969. }
  69970. /**
  69971. * (Highcharts, Highstock) A polygon series can be used to draw any freeform
  69972. * shape in the cartesian coordinate system. A fill is applied with the `color`
  69973. * option, and stroke is applied through `lineWidth` and `lineColor` options.
  69974. *
  69975. * In TypeScript the type option must always be set.
  69976. *
  69977. * Configuration options for the series are given in three levels:
  69978. *
  69979. * 1. Options for all series in a chart are defined in the plotOptions.series
  69980. * object.
  69981. *
  69982. * 2. Options for all `polygon` series are defined in plotOptions.polygon.
  69983. *
  69984. * 3. Options for one single series are given in the series instance array. (see
  69985. * online documentation for example)
  69986. */
  69987. export interface PlotPolygonOptions {
  69988. /**
  69989. * (Highcharts, Highstock) Accessibility options for a series.
  69990. */
  69991. accessibility?: SeriesAccessibilityOptionsObject;
  69992. /**
  69993. * (Highmaps) Whether all areas of the map defined in `mapData` should be
  69994. * rendered. If `true`, areas which don't correspond to a data point, are
  69995. * rendered as `null` points. If `false`, those areas are skipped.
  69996. */
  69997. allAreas?: boolean;
  69998. /**
  69999. * (Highcharts, Highstock) Allow this series' points to be selected by
  70000. * clicking on the graphic (columns, point markers, pie slices, map areas
  70001. * etc).
  70002. *
  70003. * The selected points can be handled by point select and unselect events,
  70004. * or collectively by the getSelectedPoints function.
  70005. *
  70006. * And alternative way of selecting points is through dragging.
  70007. */
  70008. allowPointSelect?: boolean;
  70009. /**
  70010. * (Highcharts, Highstock) Enable or disable the initial animation when a
  70011. * series is displayed. The animation can also be set as a configuration
  70012. * object. Please note that this option only applies to the initial
  70013. * animation of the series itself. For other animations, see chart.animation
  70014. * and the animation parameter under the API methods. The following
  70015. * properties are supported:
  70016. *
  70017. * - `defer`: The animation delay time in milliseconds.
  70018. *
  70019. * - `duration`: The duration of the animation in milliseconds.
  70020. *
  70021. * - `easing`: Can be a string reference to an easing function set on the
  70022. * `Math` object or a function. See the _Custom easing function_ demo below.
  70023. *
  70024. * Due to poor performance, animation is disabled in old IE browsers for
  70025. * several chart types.
  70026. */
  70027. animation?: (boolean|PlotPolygonAnimationOptions|Partial<AnimationOptionsObject>);
  70028. /**
  70029. * (Highcharts, Highstock) For some series, there is a limit that shuts down
  70030. * initial animation by default when the total number of points in the chart
  70031. * is too high. For example, for a column chart and its derivatives,
  70032. * animation does not run if there is more than 250 points totally. To
  70033. * disable this cap, set `animationLimit` to `Infinity`.
  70034. */
  70035. animationLimit?: number;
  70036. /**
  70037. * (Highmaps) The border color of the map areas.
  70038. *
  70039. * In styled mode, the border stroke is given in the `.highcharts-point`
  70040. * class.
  70041. */
  70042. borderColor?: (ColorString|GradientColorObject|PatternObject);
  70043. /**
  70044. * (Highmaps) The border width of each map area.
  70045. *
  70046. * In styled mode, the border stroke width is given in the
  70047. * `.highcharts-point` class.
  70048. */
  70049. borderWidth?: number;
  70050. /**
  70051. * (Highcharts, Highstock) An additional class name to apply to the series'
  70052. * graphical elements. This option does not replace default class names of
  70053. * the graphical element.
  70054. */
  70055. className?: string;
  70056. /**
  70057. * (Highcharts, Highstock) Disable this option to allow series rendering in
  70058. * the whole plotting area.
  70059. *
  70060. * **Note:** Clipping should be always enabled when chart.zoomType is set
  70061. */
  70062. clip?: boolean;
  70063. /**
  70064. * (Highcharts, Highstock) The main color of the series. In line type series
  70065. * it applies to the line and the point markers unless otherwise specified.
  70066. * In bar type series it applies to the bars unless a color is specified per
  70067. * point. The default value is pulled from the `options.colors` array.
  70068. *
  70069. * In styled mode, the color can be defined by the colorIndex option. Also,
  70070. * the series color can be set with the `.highcharts-series`,
  70071. * `.highcharts-color-{n}`, `.highcharts-{type}-series` or
  70072. * `.highcharts-series-{n}` class, or individual classes given by the
  70073. * `className` option.
  70074. */
  70075. color?: (ColorString|GradientColorObject|PatternObject);
  70076. /**
  70077. * (Highcharts, Highstock, Highmaps) When using dual or multiple color axes,
  70078. * this number defines which colorAxis the particular series is connected
  70079. * to. It refers to either the axis id or the index of the axis in the
  70080. * colorAxis array, with 0 being the first. Set this option to false to
  70081. * prevent a series from connecting to the default color axis.
  70082. *
  70083. * Since v7.2.0 the option can also be an axis id or an axis index instead
  70084. * of a boolean flag.
  70085. */
  70086. colorAxis?: (boolean|number|string);
  70087. /**
  70088. * (Highcharts, Highstock) Styled mode only. A specific color index to use
  70089. * for the series, so its graphic representations are given the class name
  70090. * `highcharts-color-{n}`.
  70091. */
  70092. colorIndex?: number;
  70093. /**
  70094. * (Highcharts, Highstock, Highmaps) Determines what data value should be
  70095. * used to calculate point color if `colorAxis` is used. Requires to set
  70096. * `min` and `max` if some custom point property is used or if approximation
  70097. * for data grouping is set to `'sum'`.
  70098. */
  70099. colorKey?: string;
  70100. /**
  70101. * (Highstock) Compare the values of the series against the first non-null,
  70102. * non- zero value in the visible range. The y axis will show percentage or
  70103. * absolute change depending on whether `compare` is set to `"percent"` or
  70104. * `"value"`. When this is applied to multiple series, it allows comparing
  70105. * the development of the series against each other. Adds a `change` field
  70106. * to every point object.
  70107. */
  70108. compare?: string;
  70109. /**
  70110. * (Highstock) When compare is `percent`, this option dictates whether to
  70111. * use 0 or 100 as the base of comparison.
  70112. */
  70113. compareBase?: (0|100);
  70114. /**
  70115. * (Highstock) Defines if comparison should start from the first point
  70116. * within the visible range or should start from the first point **before**
  70117. * the range.
  70118. *
  70119. * In other words, this flag determines if first point within the visible
  70120. * range will have 0% (`compareStart=true`) or should have been already
  70121. * calculated according to the previous point (`compareStart=false`).
  70122. */
  70123. compareStart?: boolean;
  70124. /**
  70125. * (Highcharts) Polar charts only. Whether to connect the ends of a line
  70126. * series plot across the extremes.
  70127. */
  70128. connectEnds?: boolean;
  70129. /**
  70130. * (Highcharts, Highstock) Whether to connect a graph line across null
  70131. * points, or render a gap between the two points on either side of the
  70132. * null.
  70133. */
  70134. connectNulls?: boolean;
  70135. /**
  70136. * (Gantt) Override Pathfinder connector options for a series. Requires
  70137. * Highcharts Gantt to be loaded.
  70138. */
  70139. connectors?: SeriesConnectorsOptionsObject;
  70140. /**
  70141. * (Highcharts, Highstock, Gantt) When true, each point or column edge is
  70142. * rounded to its nearest pixel in order to render sharp on screen. In some
  70143. * cases, when there are a lot of densely packed columns, this leads to
  70144. * visible difference in column widths or distance between columns. In these
  70145. * cases, setting `crisp` to `false` may look better, even though each
  70146. * column is rendered blurry.
  70147. */
  70148. crisp?: boolean;
  70149. /**
  70150. * (Highcharts, Highstock) You can set the cursor to "pointer" if you have
  70151. * click events attached to the series, to signal to the user that the
  70152. * points and lines can be clicked.
  70153. *
  70154. * In styled mode, the series cursor can be set with the same classes as
  70155. * listed under series.color.
  70156. */
  70157. cursor?: (string|CursorValue);
  70158. /**
  70159. * (Highcharts, Highstock) A reserved subspace to store options and values
  70160. * for customized functionality. Here you can add additional data for your
  70161. * own event callbacks and formatter callbacks.
  70162. */
  70163. custom?: Dictionary<any>;
  70164. /**
  70165. * (Highcharts, Highstock) Name of the dash style to use for the graph, or
  70166. * for some series types the outline of each shape.
  70167. *
  70168. * In styled mode, the stroke dash-array can be set with the same classes as
  70169. * listed under series.color.
  70170. */
  70171. dashStyle?: DashStyleValue;
  70172. /**
  70173. * (Highstock) Data grouping is the concept of sampling the data values into
  70174. * larger blocks in order to ease readability and increase performance of
  70175. * the JavaScript charts. Highstock by default applies data grouping when
  70176. * the points become closer than a certain pixel value, determined by the
  70177. * `groupPixelWidth` option.
  70178. *
  70179. * If data grouping is applied, the grouping information of grouped points
  70180. * can be read from the Point.dataGroup. If point options other than the
  70181. * data itself are set, for example `name` or `color` or custom properties,
  70182. * the grouping logic doesn't know how to group it. In this case the options
  70183. * of the first point instance are copied over to the group point. This can
  70184. * be altered through a custom `approximation` callback function.
  70185. */
  70186. dataGrouping?: DataGroupingOptionsObject;
  70187. /**
  70188. * (Highcharts, Highstock, Highmaps, Gantt) Options for the series data
  70189. * labels, appearing next to each data point.
  70190. *
  70191. * Since v6.2.0, multiple data labels can be applied to each single point by
  70192. * defining them as an array of configs.
  70193. *
  70194. * In styled mode, the data labels can be styled with the
  70195. * `.highcharts-data-label-box` and `.highcharts-data-label` class names
  70196. * (see example).
  70197. */
  70198. dataLabels?: (PlotPolygonDataLabelsOptions|Array<PlotPolygonDataLabelsOptions>);
  70199. /**
  70200. * (Highcharts, Highstock) Options for the series data sorting.
  70201. */
  70202. dataSorting?: (DataSortingOptionsObject|PlotPolygonDataSortingOptions);
  70203. /**
  70204. * (Highcharts, Highstock) A description of the series to add to the screen
  70205. * reader information about the series.
  70206. */
  70207. description?: string;
  70208. /**
  70209. * (Highcharts, Highstock) The draggable-points module allows points to be
  70210. * moved around or modified in the chart. In addition to the options
  70211. * mentioned under the `dragDrop` API structure, the module fires three
  70212. * events, point.dragStart, point.drag and point.drop.
  70213. */
  70214. dragDrop?: SeriesDragDropOptionsObject;
  70215. /**
  70216. * (Highcharts, Highstock) Enable or disable the mouse tracking for a
  70217. * specific series. This includes point tooltips and click events on graphs
  70218. * and points. For large datasets it improves performance.
  70219. */
  70220. enableMouseTracking?: boolean;
  70221. /**
  70222. * (Highcharts, Highstock) General event handlers for the series items.
  70223. * These event hooks can also be attached to the series at run time using
  70224. * the `Highcharts.addEvent` function.
  70225. */
  70226. events?: SeriesEventsOptionsObject;
  70227. /**
  70228. * (Highcharts, Highstock) Determines whether the series should look for the
  70229. * nearest point in both dimensions or just the x-dimension when hovering
  70230. * the series. Defaults to `'xy'` for scatter series and `'x'` for most
  70231. * other series. If the data has duplicate x-values, it is recommended to
  70232. * set this to `'xy'` to allow hovering over all points.
  70233. *
  70234. * Applies only to series types using nearest neighbor search (not direct
  70235. * hover) for tooltip.
  70236. */
  70237. findNearestPointBy?: OptionsFindNearestPointByValue;
  70238. /**
  70239. * (Highstock) Defines when to display a gap in the graph, together with the
  70240. * gapUnit option.
  70241. *
  70242. * In case when `dataGrouping` is enabled, points can be grouped into a
  70243. * larger time span. This can make the grouped points to have a greater
  70244. * distance than the absolute value of `gapSize` property, which will result
  70245. * in disappearing graph completely. To prevent this situation the mentioned
  70246. * distance between grouped points is used instead of previously defined
  70247. * `gapSize`.
  70248. *
  70249. * In practice, this option is most often used to visualize gaps in time
  70250. * series. In a stock chart, intraday data is available for daytime hours,
  70251. * while gaps will appear in nights and weekends.
  70252. */
  70253. gapSize?: number;
  70254. /**
  70255. * (Highstock) Together with gapSize, this option defines where to draw gaps
  70256. * in the graph.
  70257. *
  70258. * When the `gapUnit` is `"relative"` (default), a gap size of 5 means that
  70259. * if the distance between two points is greater than 5 times that of the
  70260. * two closest points, the graph will be broken.
  70261. *
  70262. * When the `gapUnit` is `"value"`, the gap is based on absolute axis
  70263. * values, which on a datetime axis is milliseconds. This also applies to
  70264. * the navigator series that inherits gap options from the base series.
  70265. */
  70266. gapUnit?: OptionsGapUnitValue;
  70267. /**
  70268. * (Highcharts, Highstock, Gantt) Whether to use the Y extremes of the total
  70269. * chart width or only the zoomed area when zooming in on parts of the X
  70270. * axis. By default, the Y axis adjusts to the min and max of the visible
  70271. * data. Cartesian series only.
  70272. */
  70273. getExtremesFromAll?: boolean;
  70274. /**
  70275. * (Highcharts, Highstock) When set to `false` will prevent the series data
  70276. * from being included in any form of data export.
  70277. *
  70278. * Since version 6.0.0 until 7.1.0 the option was existing undocumented as
  70279. * `includeInCSVExport`.
  70280. */
  70281. includeInDataExport?: boolean;
  70282. /**
  70283. * (Highmaps) What property to join the `mapData` to the value data. For
  70284. * example, if joinBy is "code", the mapData items with a specific code is
  70285. * merged into the data with the same code. For maps loaded from GeoJSON,
  70286. * the keys may be held in each point's `properties` object.
  70287. *
  70288. * The joinBy option can also be an array of two values, where the first
  70289. * points to a key in the `mapData`, and the second points to another key in
  70290. * the `data`.
  70291. *
  70292. * When joinBy is `null`, the map items are joined by their position in the
  70293. * array, which performs much better in maps with many data points. This is
  70294. * the recommended option if you are printing more than a thousand data
  70295. * points and have a backend that can preprocess the data into a parallel
  70296. * array of the mapData.
  70297. */
  70298. joinBy?: (string|Array<string>);
  70299. /**
  70300. * (Highcharts, Highstock) An array specifying which option maps to which
  70301. * key in the data point array. This makes it convenient to work with
  70302. * unstructured data arrays from different sources.
  70303. */
  70304. keys?: Array<string>;
  70305. /**
  70306. * (Highcharts, Highstock, Gantt) Series labels are placed as close to the
  70307. * series as possible in a natural way, seeking to avoid other series. The
  70308. * goal of this feature is to make the chart more easily readable, like if a
  70309. * human designer placed the labels in the optimal position.
  70310. *
  70311. * The series labels currently work with series types having a `graph` or an
  70312. * `area`.
  70313. */
  70314. label?: SeriesLabelOptionsObject;
  70315. /**
  70316. * (Highstock) The line marks the last price from all points.
  70317. */
  70318. lastPrice?: SeriesLastPriceOptionsObject;
  70319. /**
  70320. * (Highstock) The line marks the last price from visible range of points.
  70321. */
  70322. lastVisiblePrice?: SeriesLastVisiblePriceOptionsObject;
  70323. /**
  70324. * (Highcharts, Highstock) The SVG value used for the `stroke-linecap` and
  70325. * `stroke-linejoin` of a line graph. Round means that lines are rounded in
  70326. * the ends and bends.
  70327. */
  70328. linecap?: SeriesLinecapValue;
  70329. /**
  70330. * (Highcharts, Highstock) The width of the line connecting the data points.
  70331. */
  70332. lineWidth?: number;
  70333. /**
  70334. * (Highcharts, Highstock, Gantt) The id of another series to link to.
  70335. * Additionally, the value can be ":previous" to link to the previous
  70336. * series. When two series are linked, only the first one appears in the
  70337. * legend. Toggling the visibility of this also toggles the linked series.
  70338. *
  70339. * If master series uses data sorting and linked series does not have its
  70340. * own sorting definition, the linked series will be sorted in the same
  70341. * order as the master one.
  70342. */
  70343. linkedTo?: string;
  70344. /**
  70345. * (Highcharts, Highstock) Options for the point markers of line-like
  70346. * series. Properties like `fillColor`, `lineColor` and `lineWidth` define
  70347. * the visual appearance of the markers. Other series types, like column
  70348. * series, don't have markers, but have visual options on the series level
  70349. * instead.
  70350. *
  70351. * In styled mode, the markers can be styled with the `.highcharts-point`,
  70352. * `.highcharts-point-hover` and `.highcharts-point-select` class names.
  70353. */
  70354. marker?: PointMarkerOptionsObject;
  70355. /**
  70356. * (Highstock) Options for the corresponding navigator series if
  70357. * `showInNavigator` is `true` for this series. Available options are the
  70358. * same as any series, documented at plotOptions and series.
  70359. *
  70360. * These options are merged with options in navigator.series, and will take
  70361. * precedence if the same option is defined both places.
  70362. */
  70363. navigatorOptions?: PlotSeriesOptions;
  70364. /**
  70365. * (Highcharts, Highstock) The color for the parts of the graph or points
  70366. * that are below the threshold. Note that `zones` takes precedence over the
  70367. * negative color. Using `negativeColor` is equivalent to applying a zone
  70368. * with value of 0.
  70369. */
  70370. negativeColor?: (ColorString|GradientColorObject|PatternObject);
  70371. /**
  70372. * (Highcharts, Highstock) Opacity of a series parts: line, fill (e.g. area)
  70373. * and dataLabels.
  70374. */
  70375. opacity?: number;
  70376. /**
  70377. * (Highcharts, Highstock) Properties for each single point.
  70378. */
  70379. point?: PlotSeriesPointOptions;
  70380. /**
  70381. * (Highcharts, Highstock) Same as accessibility.pointDescriptionFormatter,
  70382. * but for an individual series. Overrides the chart wide configuration.
  70383. */
  70384. pointDescriptionFormatter?: Function;
  70385. /**
  70386. * (Highcharts, Highstock, Gantt) If no x values are given for the points in
  70387. * a series, `pointInterval` defines the interval of the x values. For
  70388. * example, if a series contains one value every decade starting from year
  70389. * 0, set `pointInterval` to `10`. In true `datetime` axes, the
  70390. * `pointInterval` is set in milliseconds.
  70391. *
  70392. * It can be also be combined with `pointIntervalUnit` to draw irregular
  70393. * time intervals.
  70394. *
  70395. * Please note that this options applies to the _series data_, not the
  70396. * interval of the axis ticks, which is independent.
  70397. */
  70398. pointInterval?: number;
  70399. /**
  70400. * (Highcharts, Highstock, Gantt) On datetime series, this allows for
  70401. * setting the pointInterval to irregular time units, `day`, `month` and
  70402. * `year`. A day is usually the same as 24 hours, but `pointIntervalUnit`
  70403. * also takes the DST crossover into consideration when dealing with local
  70404. * time. Combine this option with `pointInterval` to draw weeks, quarters, 6
  70405. * months, 10 years etc.
  70406. *
  70407. * Please note that this options applies to the _series data_, not the
  70408. * interval of the axis ticks, which is independent.
  70409. */
  70410. pointIntervalUnit?: OptionsPointIntervalUnitValue;
  70411. /**
  70412. * (Highstock) The width of each point on the x axis. For example in a
  70413. * column chart with one value each day, the pointRange would be 1 day (= 24
  70414. * * 3600
  70415. *
  70416. * * 1000 milliseconds). This is normally computed automatically, but this
  70417. * option can be used to override the automatic value.
  70418. */
  70419. pointRange?: number;
  70420. /**
  70421. * (Highcharts, Highstock, Gantt) If no x values are given for the points in
  70422. * a series, pointStart defines on what value to start. For example, if a
  70423. * series contains one yearly value starting from 1945, set pointStart to
  70424. * 1945.
  70425. */
  70426. pointStart?: number;
  70427. /**
  70428. * (Highcharts, Highstock) Whether to select the series initially. If
  70429. * `showCheckbox` is true, the checkbox next to the series name in the
  70430. * legend will be checked for a selected series.
  70431. */
  70432. selected?: boolean;
  70433. /**
  70434. * (Highcharts, Highstock) If true, a checkbox is displayed next to the
  70435. * legend item to allow selecting the series. The state of the checkbox is
  70436. * determined by the `selected` option.
  70437. */
  70438. showCheckbox?: boolean;
  70439. /**
  70440. * (Highcharts, Highstock) Whether to display this particular series or
  70441. * series type in the legend. Standalone series are shown in legend by
  70442. * default, and linked series are not. Since v7.2.0 it is possible to show
  70443. * series that use colorAxis by setting this option to `true`.
  70444. */
  70445. showInLegend?: boolean;
  70446. /**
  70447. * (Highstock) Whether or not to show the series in the navigator. Takes
  70448. * precedence over navigator.baseSeries if defined.
  70449. */
  70450. showInNavigator?: boolean;
  70451. /**
  70452. * (Highcharts, Highstock) If set to `true`, the accessibility module will
  70453. * skip past the points in this series for keyboard navigation.
  70454. */
  70455. skipKeyboardNavigation?: boolean;
  70456. /**
  70457. * (Highcharts, Highstock) Whether to stack the values of each series on top
  70458. * of each other. Possible values are `undefined` to disable, `"normal"` to
  70459. * stack by value or `"percent"`.
  70460. *
  70461. * When stacking is enabled, data must be sorted in ascending X order.
  70462. *
  70463. * Some stacking options are related to specific series types. In the
  70464. * streamgraph series type, the stacking option is set to `"stream"`. The
  70465. * second one is `"overlap"`, which only applies to waterfall series.
  70466. */
  70467. stacking?: OptionsStackingValue;
  70468. states?: SeriesStatesOptionsObject;
  70469. /**
  70470. * (Highcharts, Highstock) Whether to apply steps to the line. Possible
  70471. * values are `left`, `center` and `right`.
  70472. */
  70473. step?: OptionsStepValue;
  70474. /**
  70475. * (Highcharts, Highstock) Sticky tracking of mouse events. When true, the
  70476. * `mouseOut` event on a series isn't triggered until the mouse moves over
  70477. * another series, or out of the plot area. When false, the `mouseOut` event
  70478. * on a series is triggered when the mouse leaves the area around the
  70479. * series' graph or markers. This also implies the tooltip. When
  70480. * `stickyTracking` is false and `tooltip.shared` is false, the tooltip will
  70481. * be hidden when moving the mouse between series.
  70482. */
  70483. stickyTracking?: boolean;
  70484. /**
  70485. * (Highcharts, Highstock) A configuration object for the tooltip rendering
  70486. * of each single series. Properties are inherited from tooltip. Overridable
  70487. * properties are `headerFormat`, `pointFormat`, `yDecimals`, `xDateFormat`,
  70488. * `yPrefix` and `ySuffix`. Unlike other series, in a scatter plot the
  70489. * series.name by default shows in the headerFormat and point.x and point.y
  70490. * in the pointFormat.
  70491. */
  70492. tooltip?: SeriesTooltipOptionsObject;
  70493. trackByArea?: boolean;
  70494. /**
  70495. * (Highcharts, Highstock, Gantt) When a series contains a data array that
  70496. * is longer than this, only one dimensional arrays of numbers, or two
  70497. * dimensional arrays with x and y values are allowed. Also, only the first
  70498. * point is tested, and the rest are assumed to be the same format. This
  70499. * saves expensive data checking and indexing in long series. Set it to `0`
  70500. * disable.
  70501. *
  70502. * Note: In boost mode turbo threshold is forced. Only array of numbers or
  70503. * two dimensional arrays are allowed.
  70504. */
  70505. turboThreshold?: number;
  70506. /**
  70507. * (Highcharts, Highstock) Set the initial visibility of the series.
  70508. */
  70509. visible?: boolean;
  70510. /**
  70511. * (Highmaps) Define the z index of the series.
  70512. */
  70513. zIndex?: number;
  70514. /**
  70515. * (Highcharts, Highstock) Defines the Axis on which the zones are applied.
  70516. */
  70517. zoneAxis?: string;
  70518. /**
  70519. * (Highcharts, Highstock) An array defining zones within a series. Zones
  70520. * can be applied to the X axis, Y axis or Z axis for bubbles, according to
  70521. * the `zoneAxis` option. The zone definitions have to be in ascending order
  70522. * regarding to the value.
  70523. *
  70524. * In styled mode, the color zones are styled with the
  70525. * `.highcharts-zone-{n}` class, or custom classed from the `className`
  70526. * option (view live demo).
  70527. */
  70528. zones?: Array<SeriesZonesOptionsObject>;
  70529. }
  70530. /**
  70531. * (Highstock) Enable or disable the initial animation when a series is
  70532. * displayed. The animation can also be set as a configuration object. Please
  70533. * note that this option only applies to the initial animation of the series
  70534. * itself. For other animations, see chart.animation and the animation parameter
  70535. * under the API methods. The following properties are supported:
  70536. *
  70537. * - `defer`: The animation delay time in milliseconds.
  70538. *
  70539. * - `duration`: The duration of the animation in milliseconds.
  70540. *
  70541. * - `easing`: Can be a string reference to an easing function set on the `Math`
  70542. * object or a function. See the _Custom easing function_ demo below.
  70543. *
  70544. * Due to poor performance, animation is disabled in old IE browsers for several
  70545. * chart types.
  70546. */
  70547. export interface PlotPpoAnimationOptions {
  70548. defer?: number;
  70549. }
  70550. /**
  70551. * (Highcharts, Highstock, Highmaps, Gantt) Enable or disable the initial
  70552. * animation when a series is displayed for the `dataLabels`. The animation can
  70553. * also be set as a configuration object. Please note that this option only
  70554. * applies to the initial animation. For other animations, see chart.animation
  70555. * and the animation parameter under the API methods. The following properties
  70556. * are supported:
  70557. *
  70558. * - `defer`: The animation delay time in milliseconds.
  70559. */
  70560. export interface PlotPpoDataLabelsAnimationOptions {
  70561. /**
  70562. * (Highcharts, Highstock, Highmaps, Gantt) The animation delay time in
  70563. * milliseconds. Set to `0` renders dataLabel immediately. As `undefined`
  70564. * inherits defer time from the series.animation.defer.
  70565. */
  70566. defer?: number;
  70567. }
  70568. /**
  70569. * (Highcharts, Highstock, Highmaps, Gantt) Options for the series data labels,
  70570. * appearing next to each data point.
  70571. *
  70572. * Since v6.2.0, multiple data labels can be applied to each single point by
  70573. * defining them as an array of configs.
  70574. *
  70575. * In styled mode, the data labels can be styled with the
  70576. * `.highcharts-data-label-box` and `.highcharts-data-label` class names (see
  70577. * example).
  70578. */
  70579. export interface PlotPpoDataLabelsOptions {
  70580. /**
  70581. * (Highcharts, Highstock, Highmaps, Gantt) The alignment of the data label
  70582. * compared to the point. If `right`, the right side of the label should be
  70583. * touching the point. For points with an extent, like columns, the
  70584. * alignments also dictates how to align it inside the box, as given with
  70585. * the inside option. Can be one of `left`, `center` or `right`.
  70586. */
  70587. align?: (AlignValue|null);
  70588. /**
  70589. * (Highcharts, Highstock, Highmaps, Gantt) Whether to allow data labels to
  70590. * overlap. To make the labels less sensitive for overlapping, the
  70591. * dataLabels.padding can be set to 0.
  70592. */
  70593. allowOverlap?: boolean;
  70594. /**
  70595. * (Highcharts, Highstock, Highmaps, Gantt) Enable or disable the initial
  70596. * animation when a series is displayed for the `dataLabels`. The animation
  70597. * can also be set as a configuration object. Please note that this option
  70598. * only applies to the initial animation. For other animations, see
  70599. * chart.animation and the animation parameter under the API methods. The
  70600. * following properties are supported:
  70601. *
  70602. * - `defer`: The animation delay time in milliseconds.
  70603. */
  70604. animation?: (boolean|PlotPpoDataLabelsAnimationOptions|Partial<AnimationOptionsObject>);
  70605. /**
  70606. * (Highcharts, Highstock, Highmaps, Gantt) The background color or gradient
  70607. * for the data label.
  70608. */
  70609. backgroundColor?: (ColorString|GradientColorObject|PatternObject);
  70610. /**
  70611. * (Highcharts, Highstock, Highmaps, Gantt) The border color for the data
  70612. * label. Defaults to `undefined`.
  70613. */
  70614. borderColor?: (ColorString|GradientColorObject|PatternObject);
  70615. /**
  70616. * (Highcharts, Highstock, Highmaps, Gantt) The border radius in pixels for
  70617. * the data label.
  70618. */
  70619. borderRadius?: number;
  70620. /**
  70621. * (Highcharts, Highstock, Highmaps, Gantt) The border width in pixels for
  70622. * the data label.
  70623. */
  70624. borderWidth?: number;
  70625. /**
  70626. * (Highcharts, Highstock, Highmaps, Gantt) A class name for the data label.
  70627. * Particularly in styled mode, this can be used to give each series' or
  70628. * point's data label unique styling. In addition to this option, a default
  70629. * color class name is added so that we can give the labels a contrast text
  70630. * shadow.
  70631. */
  70632. className?: string;
  70633. /**
  70634. * (Highcharts, Highstock, Highmaps, Gantt) The text color for the data
  70635. * labels. Defaults to `undefined`. For certain series types, like column or
  70636. * map, the data labels can be drawn inside the points. In this case the
  70637. * data label will be drawn with maximum contrast by default. Additionally,
  70638. * it will be given a `text-outline` style with the opposite color, to
  70639. * further increase the contrast. This can be overridden by setting the
  70640. * `text-outline` style to `none` in the `dataLabels.style` option.
  70641. */
  70642. color?: (ColorString|GradientColorObject|PatternObject);
  70643. /**
  70644. * (Highcharts, Highstock, Highmaps, Gantt) Whether to hide data labels that
  70645. * are outside the plot area. By default, the data label is moved inside the
  70646. * plot area according to the overflow option.
  70647. */
  70648. crop?: boolean;
  70649. /**
  70650. * (Highcharts, Highstock, Gantt) Whether to defer displaying the data
  70651. * labels until the initial series animation has finished. Setting to
  70652. * `false` renders the data label immediately. If set to `true` inherits the
  70653. * defer time set in plotOptions.series.animation.
  70654. */
  70655. defer?: boolean;
  70656. /**
  70657. * (Highcharts, Highstock, Highmaps, Gantt) Enable or disable the data
  70658. * labels.
  70659. */
  70660. enabled?: boolean;
  70661. /**
  70662. * (Highcharts, Highstock, Highmaps, Gantt) A declarative filter to control
  70663. * of which data labels to display. The declarative filter is designed for
  70664. * use when callback functions are not available, like when the chart
  70665. * options require a pure JSON structure or for use with graphical editors.
  70666. * For programmatic control, use the `formatter` instead, and return
  70667. * `undefined` to disable a single data label.
  70668. */
  70669. filter?: DataLabelsFilterOptionsObject;
  70670. /**
  70671. * (Highcharts, Highstock, Highmaps, Gantt) A format string for the data
  70672. * label. Available variables are the same as for `formatter`.
  70673. */
  70674. format?: string;
  70675. /**
  70676. * (Highcharts, Highstock, Highmaps, Gantt) Callback JavaScript function to
  70677. * format the data label. Note that if a `format` is defined, the format
  70678. * takes precedence and the formatter is ignored.
  70679. */
  70680. formatter?: DataLabelsFormatterCallbackFunction;
  70681. /**
  70682. * (Highcharts, Highstock, Highmaps, Gantt) For points with an extent, like
  70683. * columns or map areas, whether to align the data label inside the box or
  70684. * to the actual value point. Defaults to `false` in most cases, `true` in
  70685. * stacked columns.
  70686. */
  70687. inside?: boolean;
  70688. /**
  70689. * (Highcharts, Highstock, Highmaps, Gantt) Format for points with the value
  70690. * of null. Works analogously to format. `nullFormat` can be applied only to
  70691. * series which support displaying null points.
  70692. */
  70693. nullFormat?: (boolean|string);
  70694. /**
  70695. * (Highcharts, Highstock, Highmaps, Gantt) Callback JavaScript function
  70696. * that defines formatting for points with the value of null. Works
  70697. * analogously to formatter. `nullPointFormatter` can be applied only to
  70698. * series which support displaying null points.
  70699. */
  70700. nullFormatter?: DataLabelsFormatterCallbackFunction;
  70701. /**
  70702. * (Highcharts, Highstock, Highmaps, Gantt) How to handle data labels that
  70703. * flow outside the plot area. The default is `"justify"`, which aligns them
  70704. * inside the plot area. For columns and bars, this means it will be moved
  70705. * inside the bar. To display data labels outside the plot area, set `crop`
  70706. * to `false` and `overflow` to `"allow"`.
  70707. */
  70708. overflow?: DataLabelsOverflowValue;
  70709. /**
  70710. * (Highcharts, Highstock, Highmaps, Gantt) When either the `borderWidth` or
  70711. * the `backgroundColor` is set, this is the padding within the box.
  70712. */
  70713. padding?: number;
  70714. /**
  70715. * (Highcharts, Highstock, Highmaps, Gantt) Aligns data labels relative to
  70716. * points. If `center` alignment is not possible, it defaults to `right`.
  70717. */
  70718. position?: AlignValue;
  70719. /**
  70720. * (Highcharts, Highstock, Highmaps, Gantt) Text rotation in degrees. Note
  70721. * that due to a more complex structure, backgrounds, borders and padding
  70722. * will be lost on a rotated data label.
  70723. */
  70724. rotation?: number;
  70725. /**
  70726. * (Highcharts, Highstock, Highmaps, Gantt) The shadow of the box. Works
  70727. * best with `borderWidth` or `backgroundColor`. Since 2.3 the shadow can be
  70728. * an object configuration containing `color`, `offsetX`, `offsetY`,
  70729. * `opacity` and `width`.
  70730. */
  70731. shadow?: (boolean|ShadowOptionsObject);
  70732. /**
  70733. * (Highcharts, Highstock, Highmaps, Gantt) The name of a symbol to use for
  70734. * the border around the label. Symbols are predefined functions on the
  70735. * Renderer object.
  70736. */
  70737. shape?: string;
  70738. /**
  70739. * (Highcharts, Highstock, Highmaps, Gantt) Styles for the label. The
  70740. * default `color` setting is `"contrast"`, which is a pseudo color that
  70741. * Highcharts picks up and applies the maximum contrast to the underlying
  70742. * point item, for example the bar in a bar chart.
  70743. *
  70744. * The `textOutline` is a pseudo property that applies an outline of the
  70745. * given width with the given color, which by default is the maximum
  70746. * contrast to the text. So a bright text color will result in a black text
  70747. * outline for maximum readability on a mixed background. In some cases,
  70748. * especially with grayscale text, the text outline doesn't work well, in
  70749. * which cases it can be disabled by setting it to `"none"`. When `useHTML`
  70750. * is true, the `textOutline` will not be picked up. In this, case, the same
  70751. * effect can be acheived through the `text-shadow` CSS property.
  70752. *
  70753. * For some series types, where each point has an extent, like for example
  70754. * tree maps, the data label may overflow the point. There are two
  70755. * strategies for handling overflow. By default, the text will wrap to
  70756. * multiple lines. The other strategy is to set `style.textOverflow` to
  70757. * `ellipsis`, which will keep the text on one line plus it will break
  70758. * inside long words.
  70759. */
  70760. style?: CSSObject;
  70761. /**
  70762. * (Highcharts, Highstock, Highmaps, Gantt) Options for a label text which
  70763. * should follow marker's shape. Border and background are disabled for a
  70764. * label that follows a path.
  70765. *
  70766. * **Note:** Only SVG-based renderer supports this option. Setting `useHTML`
  70767. * to true will disable this option.
  70768. */
  70769. textPath?: DataLabelsTextPathOptionsObject;
  70770. /**
  70771. * (Highcharts, Highstock, Highmaps, Gantt) Whether to use HTML to render
  70772. * the labels.
  70773. */
  70774. useHTML?: boolean;
  70775. /**
  70776. * (Highcharts, Highstock, Highmaps, Gantt) The vertical alignment of a data
  70777. * label. Can be one of `top`, `middle` or `bottom`. The default value
  70778. * depends on the data, for instance in a column chart, the label is above
  70779. * positive values and below negative values.
  70780. */
  70781. verticalAlign?: (VerticalAlignValue|null);
  70782. /**
  70783. * (Highcharts, Highstock, Highmaps, Gantt) The x position offset of the
  70784. * label relative to the point in pixels.
  70785. */
  70786. x?: number;
  70787. /**
  70788. * (Highcharts, Highstock, Highmaps, Gantt) The y position offset of the
  70789. * label relative to the point in pixels.
  70790. */
  70791. y?: number;
  70792. /**
  70793. * (Highcharts, Highstock, Highmaps, Gantt) The Z index of the data labels.
  70794. * The default Z index puts it above the series. Use a Z index of 2 to
  70795. * display it behind the series.
  70796. */
  70797. z?: number;
  70798. }
  70799. /**
  70800. * (Highcharts, Highstock) Options for the series data sorting.
  70801. */
  70802. export interface PlotPpoDataSortingOptions {
  70803. /**
  70804. * (Highcharts, Highstock) Enable or disable data sorting for the series.
  70805. * Use xAxis.reversed to change the sorting order.
  70806. */
  70807. enabled?: boolean;
  70808. /**
  70809. * (Highcharts, Highstock) Whether to allow matching points by name in an
  70810. * update. If this option is disabled, points will be matched by order.
  70811. */
  70812. matchByName?: boolean;
  70813. /**
  70814. * (Highcharts, Highstock) Determines what data value should be used to sort
  70815. * by.
  70816. */
  70817. sortKey?: string;
  70818. }
  70819. /**
  70820. * (Highstock) Percentage Price Oscillator. This series requires the `linkedTo`
  70821. * option to be set and should be loaded after the
  70822. * `stock/indicators/indicators.js` and `stock/indicators/ema.js`.
  70823. *
  70824. * In TypeScript the type option must always be set.
  70825. *
  70826. * Configuration options for the series are given in three levels:
  70827. *
  70828. * 1. Options for all series in a chart are defined in the plotOptions.series
  70829. * object.
  70830. *
  70831. * 2. Options for all `ppo` series are defined in plotOptions.ppo.
  70832. *
  70833. * 3. Options for one single series are given in the series instance array. (see
  70834. * online documentation for example)
  70835. */
  70836. export interface PlotPpoOptions {
  70837. /**
  70838. * (Highstock) Accessibility options for a series.
  70839. */
  70840. accessibility?: SeriesAccessibilityOptionsObject;
  70841. /**
  70842. * (Highstock) Allow this series' points to be selected by clicking on the
  70843. * graphic (columns, point markers, pie slices, map areas etc).
  70844. *
  70845. * The selected points can be handled by point select and unselect events,
  70846. * or collectively by the getSelectedPoints function.
  70847. *
  70848. * And alternative way of selecting points is through dragging.
  70849. */
  70850. allowPointSelect?: boolean;
  70851. /**
  70852. * (Highstock) Enable or disable the initial animation when a series is
  70853. * displayed. The animation can also be set as a configuration object.
  70854. * Please note that this option only applies to the initial animation of the
  70855. * series itself. For other animations, see chart.animation and the
  70856. * animation parameter under the API methods. The following properties are
  70857. * supported:
  70858. *
  70859. * - `defer`: The animation delay time in milliseconds.
  70860. *
  70861. * - `duration`: The duration of the animation in milliseconds.
  70862. *
  70863. * - `easing`: Can be a string reference to an easing function set on the
  70864. * `Math` object or a function. See the _Custom easing function_ demo below.
  70865. *
  70866. * Due to poor performance, animation is disabled in old IE browsers for
  70867. * several chart types.
  70868. */
  70869. animation?: (boolean|PlotPpoAnimationOptions|Partial<AnimationOptionsObject>);
  70870. /**
  70871. * (Highstock) For some series, there is a limit that shuts down initial
  70872. * animation by default when the total number of points in the chart is too
  70873. * high. For example, for a column chart and its derivatives, animation does
  70874. * not run if there is more than 250 points totally. To disable this cap,
  70875. * set `animationLimit` to `Infinity`.
  70876. */
  70877. animationLimit?: number;
  70878. /**
  70879. * (Highstock) Sets the color blending in the boost module.
  70880. */
  70881. boostBlending?: OptionsBoostBlendingValue;
  70882. /**
  70883. * (Highstock) Set the point threshold for when a series should enter boost
  70884. * mode.
  70885. *
  70886. * Setting it to e.g. 2000 will cause the series to enter boost mode when
  70887. * there are 2000 or more points in the series.
  70888. *
  70889. * To disable boosting on the series, set the `boostThreshold` to 0. Setting
  70890. * it to 1 will force boosting.
  70891. *
  70892. * Note that the cropThreshold also affects this setting. When zooming in on
  70893. * a series that has fewer points than the `cropThreshold`, all points are
  70894. * rendered although outside the visible plot area, and the `boostThreshold`
  70895. * won't take effect.
  70896. */
  70897. boostThreshold?: number;
  70898. /**
  70899. * (Highmaps) The border color of the map areas.
  70900. *
  70901. * In styled mode, the border stroke is given in the `.highcharts-point`
  70902. * class.
  70903. */
  70904. borderColor?: (ColorString|GradientColorObject|PatternObject);
  70905. /**
  70906. * (Highmaps) The border width of each map area.
  70907. *
  70908. * In styled mode, the border stroke width is given in the
  70909. * `.highcharts-point` class.
  70910. */
  70911. borderWidth?: number;
  70912. /**
  70913. * (Highstock) An additional class name to apply to the series' graphical
  70914. * elements. This option does not replace default class names of the
  70915. * graphical element.
  70916. */
  70917. className?: string;
  70918. /**
  70919. * (Highstock) Disable this option to allow series rendering in the whole
  70920. * plotting area.
  70921. *
  70922. * **Note:** Clipping should be always enabled when chart.zoomType is set
  70923. */
  70924. clip?: boolean;
  70925. /**
  70926. * (Highstock) The main color of the series. In line type series it applies
  70927. * to the line and the point markers unless otherwise specified. In bar type
  70928. * series it applies to the bars unless a color is specified per point. The
  70929. * default value is pulled from the `options.colors` array.
  70930. *
  70931. * In styled mode, the color can be defined by the colorIndex option. Also,
  70932. * the series color can be set with the `.highcharts-series`,
  70933. * `.highcharts-color-{n}`, `.highcharts-{type}-series` or
  70934. * `.highcharts-series-{n}` class, or individual classes given by the
  70935. * `className` option.
  70936. */
  70937. color?: (ColorString|GradientColorObject|PatternObject);
  70938. /**
  70939. * (Highstock) Styled mode only. A specific color index to use for the
  70940. * series, so its graphic representations are given the class name
  70941. * `highcharts-color-{n}`.
  70942. */
  70943. colorIndex?: number;
  70944. /**
  70945. * (Highcharts, Highstock, Highmaps) Determines what data value should be
  70946. * used to calculate point color if `colorAxis` is used. Requires to set
  70947. * `min` and `max` if some custom point property is used or if approximation
  70948. * for data grouping is set to `'sum'`.
  70949. */
  70950. colorKey?: string;
  70951. /**
  70952. * (Highstock) Compare the values of the series against the first non-null,
  70953. * non- zero value in the visible range. The y axis will show percentage or
  70954. * absolute change depending on whether `compare` is set to `"percent"` or
  70955. * `"value"`. When this is applied to multiple series, it allows comparing
  70956. * the development of the series against each other. Adds a `change` field
  70957. * to every point object.
  70958. */
  70959. compare?: string;
  70960. /**
  70961. * (Highstock) When compare is `percent`, this option dictates whether to
  70962. * use 0 or 100 as the base of comparison.
  70963. */
  70964. compareBase?: (0|100);
  70965. /**
  70966. * (Highstock) Defines if comparison should start from the first point
  70967. * within the visible range or should start from the first point **before**
  70968. * the range.
  70969. *
  70970. * In other words, this flag determines if first point within the visible
  70971. * range will have 0% (`compareStart=true`) or should have been already
  70972. * calculated according to the previous point (`compareStart=false`).
  70973. */
  70974. compareStart?: boolean;
  70975. /**
  70976. * (Highstock) Whether to compare indicator to the main series values or
  70977. * indicator values.
  70978. */
  70979. compareToMain?: boolean;
  70980. /**
  70981. * (Highcharts) Polar charts only. Whether to connect the ends of a line
  70982. * series plot across the extremes.
  70983. */
  70984. connectEnds?: boolean;
  70985. /**
  70986. * (Highcharts, Highstock) Whether to connect a graph line across null
  70987. * points, or render a gap between the two points on either side of the
  70988. * null.
  70989. */
  70990. connectNulls?: boolean;
  70991. /**
  70992. * (Gantt) Override Pathfinder connector options for a series. Requires
  70993. * Highcharts Gantt to be loaded.
  70994. */
  70995. connectors?: SeriesConnectorsOptionsObject;
  70996. /**
  70997. * (Highcharts, Highstock, Gantt) When true, each point or column edge is
  70998. * rounded to its nearest pixel in order to render sharp on screen. In some
  70999. * cases, when there are a lot of densely packed columns, this leads to
  71000. * visible difference in column widths or distance between columns. In these
  71001. * cases, setting `crisp` to `false` may look better, even though each
  71002. * column is rendered blurry.
  71003. */
  71004. crisp?: boolean;
  71005. /**
  71006. * (Highcharts, Highstock) When the series contains less points than the
  71007. * crop threshold, all points are drawn, even if the points fall outside the
  71008. * visible plot area at the current zoom. The advantage of drawing all
  71009. * points (including markers and columns), is that animation is performed on
  71010. * updates. On the other hand, when the series contains more points than the
  71011. * crop threshold, the series data is cropped to only contain points that
  71012. * fall within the plot area. The advantage of cropping away invisible
  71013. * points is to increase performance on large series.
  71014. */
  71015. cropThreshold?: number;
  71016. /**
  71017. * (Highstock) You can set the cursor to "pointer" if you have click events
  71018. * attached to the series, to signal to the user that the points and lines
  71019. * can be clicked.
  71020. *
  71021. * In styled mode, the series cursor can be set with the same classes as
  71022. * listed under series.color.
  71023. */
  71024. cursor?: (string|CursorValue);
  71025. /**
  71026. * (Highstock) A reserved subspace to store options and values for
  71027. * customized functionality. Here you can add additional data for your own
  71028. * event callbacks and formatter callbacks.
  71029. */
  71030. custom?: Dictionary<any>;
  71031. /**
  71032. * (Highstock) Name of the dash style to use for the graph, or for some
  71033. * series types the outline of each shape.
  71034. *
  71035. * In styled mode, the stroke dash-array can be set with the same classes as
  71036. * listed under series.color.
  71037. */
  71038. dashStyle?: DashStyleValue;
  71039. /**
  71040. * (Highstock) Data grouping is the concept of sampling the data values into
  71041. * larger blocks in order to ease readability and increase performance of
  71042. * the JavaScript charts. Highstock by default applies data grouping when
  71043. * the points become closer than a certain pixel value, determined by the
  71044. * `groupPixelWidth` option.
  71045. *
  71046. * If data grouping is applied, the grouping information of grouped points
  71047. * can be read from the Point.dataGroup. If point options other than the
  71048. * data itself are set, for example `name` or `color` or custom properties,
  71049. * the grouping logic doesn't know how to group it. In this case the options
  71050. * of the first point instance are copied over to the group point. This can
  71051. * be altered through a custom `approximation` callback function.
  71052. */
  71053. dataGrouping?: DataGroupingOptionsObject;
  71054. /**
  71055. * (Highcharts, Highstock, Highmaps, Gantt) Options for the series data
  71056. * labels, appearing next to each data point.
  71057. *
  71058. * Since v6.2.0, multiple data labels can be applied to each single point by
  71059. * defining them as an array of configs.
  71060. *
  71061. * In styled mode, the data labels can be styled with the
  71062. * `.highcharts-data-label-box` and `.highcharts-data-label` class names
  71063. * (see example).
  71064. */
  71065. dataLabels?: (PlotPpoDataLabelsOptions|Array<PlotPpoDataLabelsOptions>);
  71066. /**
  71067. * (Highcharts, Highstock) Options for the series data sorting.
  71068. */
  71069. dataSorting?: (DataSortingOptionsObject|PlotPpoDataSortingOptions);
  71070. /**
  71071. * (Highstock) A description of the series to add to the screen reader
  71072. * information about the series.
  71073. */
  71074. description?: string;
  71075. /**
  71076. * (Highstock) Enable or disable the mouse tracking for a specific series.
  71077. * This includes point tooltips and click events on graphs and points. For
  71078. * large datasets it improves performance.
  71079. */
  71080. enableMouseTracking?: boolean;
  71081. /**
  71082. * (Highstock) General event handlers for the series items. These event
  71083. * hooks can also be attached to the series at run time using the
  71084. * `Highcharts.addEvent` function.
  71085. */
  71086. events?: SeriesEventsOptionsObject;
  71087. /**
  71088. * (Highstock) Determines whether the series should look for the nearest
  71089. * point in both dimensions or just the x-dimension when hovering the
  71090. * series. Defaults to `'xy'` for scatter series and `'x'` for most other
  71091. * series. If the data has duplicate x-values, it is recommended to set this
  71092. * to `'xy'` to allow hovering over all points.
  71093. *
  71094. * Applies only to series types using nearest neighbor search (not direct
  71095. * hover) for tooltip.
  71096. */
  71097. findNearestPointBy?: OptionsFindNearestPointByValue;
  71098. /**
  71099. * (Highstock) Defines when to display a gap in the graph, together with the
  71100. * gapUnit option.
  71101. *
  71102. * In case when `dataGrouping` is enabled, points can be grouped into a
  71103. * larger time span. This can make the grouped points to have a greater
  71104. * distance than the absolute value of `gapSize` property, which will result
  71105. * in disappearing graph completely. To prevent this situation the mentioned
  71106. * distance between grouped points is used instead of previously defined
  71107. * `gapSize`.
  71108. *
  71109. * In practice, this option is most often used to visualize gaps in time
  71110. * series. In a stock chart, intraday data is available for daytime hours,
  71111. * while gaps will appear in nights and weekends.
  71112. */
  71113. gapSize?: number;
  71114. /**
  71115. * (Highstock) Together with gapSize, this option defines where to draw gaps
  71116. * in the graph.
  71117. *
  71118. * When the `gapUnit` is `"relative"` (default), a gap size of 5 means that
  71119. * if the distance between two points is greater than 5 times that of the
  71120. * two closest points, the graph will be broken.
  71121. *
  71122. * When the `gapUnit` is `"value"`, the gap is based on absolute axis
  71123. * values, which on a datetime axis is milliseconds. This also applies to
  71124. * the navigator series that inherits gap options from the base series.
  71125. */
  71126. gapUnit?: OptionsGapUnitValue;
  71127. /**
  71128. * (Highcharts, Highstock, Gantt) Whether to use the Y extremes of the total
  71129. * chart width or only the zoomed area when zooming in on parts of the X
  71130. * axis. By default, the Y axis adjusts to the min and max of the visible
  71131. * data. Cartesian series only.
  71132. */
  71133. getExtremesFromAll?: boolean;
  71134. /**
  71135. * (Highstock) When set to `false` will prevent the series data from being
  71136. * included in any form of data export.
  71137. *
  71138. * Since version 6.0.0 until 7.1.0 the option was existing undocumented as
  71139. * `includeInCSVExport`.
  71140. */
  71141. includeInDataExport?: boolean;
  71142. /**
  71143. * (Highcharts, Highstock, Gantt) Series labels are placed as close to the
  71144. * series as possible in a natural way, seeking to avoid other series. The
  71145. * goal of this feature is to make the chart more easily readable, like if a
  71146. * human designer placed the labels in the optimal position.
  71147. *
  71148. * The series labels currently work with series types having a `graph` or an
  71149. * `area`.
  71150. */
  71151. label?: SeriesLabelOptionsObject;
  71152. /**
  71153. * (Highstock) The line marks the last price from all points.
  71154. */
  71155. lastPrice?: SeriesLastPriceOptionsObject;
  71156. /**
  71157. * (Highstock) The line marks the last price from visible range of points.
  71158. */
  71159. lastVisiblePrice?: SeriesLastVisiblePriceOptionsObject;
  71160. /**
  71161. * (Highcharts, Highstock) The SVG value used for the `stroke-linecap` and
  71162. * `stroke-linejoin` of a line graph. Round means that lines are rounded in
  71163. * the ends and bends.
  71164. */
  71165. linecap?: SeriesLinecapValue;
  71166. /**
  71167. * (Highcharts, Highstock) Pixel width of the graph line.
  71168. */
  71169. lineWidth?: number;
  71170. /**
  71171. * (Highcharts, Highstock, Gantt) The main series ID that indicator will be
  71172. * based on. Required for this indicator.
  71173. */
  71174. linkedTo?: string;
  71175. /**
  71176. * (Highstock) Options for the point markers of line-like series. Properties
  71177. * like `fillColor`, `lineColor` and `lineWidth` define the visual
  71178. * appearance of the markers. Other series types, like column series, don't
  71179. * have markers, but have visual options on the series level instead.
  71180. *
  71181. * In styled mode, the markers can be styled with the `.highcharts-point`,
  71182. * `.highcharts-point-hover` and `.highcharts-point-select` class names.
  71183. */
  71184. marker?: PointMarkerOptionsObject;
  71185. /**
  71186. * (Highstock) The name of the series as shown in the legend, tooltip etc.
  71187. * If not set, it will be based on a technical indicator type and default
  71188. * params.
  71189. */
  71190. name?: string;
  71191. /**
  71192. * (Highstock) The color for the parts of the graph or points that are below
  71193. * the threshold. Note that `zones` takes precedence over the negative
  71194. * color. Using `negativeColor` is equivalent to applying a zone with value
  71195. * of 0.
  71196. */
  71197. negativeColor?: (ColorString|GradientColorObject|PatternObject);
  71198. /**
  71199. * (Highstock) Opacity of a series parts: line, fill (e.g. area) and
  71200. * dataLabels.
  71201. */
  71202. opacity?: number;
  71203. /**
  71204. * (Highstock) Paramters used in calculation of Percentage Price Oscillator
  71205. * series points.
  71206. */
  71207. params?: PlotPpoParamsOptions;
  71208. /**
  71209. * (Highstock) Properties for each single point.
  71210. */
  71211. point?: PlotSeriesPointOptions;
  71212. /**
  71213. * (Highstock) Same as accessibility.pointDescriptionFormatter, but for an
  71214. * individual series. Overrides the chart wide configuration.
  71215. */
  71216. pointDescriptionFormatter?: Function;
  71217. /**
  71218. * (Highstock) Whether to select the series initially. If `showCheckbox` is
  71219. * true, the checkbox next to the series name in the legend will be checked
  71220. * for a selected series.
  71221. */
  71222. selected?: boolean;
  71223. /**
  71224. * (Highstock) Whether to apply a drop shadow to the graph line. Since 2.3
  71225. * the shadow can be an object configuration containing `color`, `offsetX`,
  71226. * `offsetY`, `opacity` and `width`.
  71227. */
  71228. shadow?: (boolean|ShadowOptionsObject);
  71229. /**
  71230. * (Highstock) If true, a checkbox is displayed next to the legend item to
  71231. * allow selecting the series. The state of the checkbox is determined by
  71232. * the `selected` option.
  71233. */
  71234. showCheckbox?: boolean;
  71235. /**
  71236. * (Highstock) Whether to display this particular series or series type in
  71237. * the legend. Standalone series are shown in legend by default, and linked
  71238. * series are not. Since v7.2.0 it is possible to show series that use
  71239. * colorAxis by setting this option to `true`.
  71240. */
  71241. showInLegend?: boolean;
  71242. /**
  71243. * (Highstock) If set to `true`, the accessibility module will skip past the
  71244. * points in this series for keyboard navigation.
  71245. */
  71246. skipKeyboardNavigation?: boolean;
  71247. /**
  71248. * (Highcharts, Highstock) When this is true, the series will not cause the
  71249. * Y axis to cross the zero plane (or threshold option) unless the data
  71250. * actually crosses the plane.
  71251. *
  71252. * For example, if `softThreshold` is `false`, a series of 0, 1, 2, 3 will
  71253. * make the Y axis show negative values according to the `minPadding`
  71254. * option. If `softThreshold` is `true`, the Y axis starts at 0.
  71255. */
  71256. softThreshold?: boolean;
  71257. states?: SeriesStatesOptionsObject;
  71258. /**
  71259. * (Highcharts, Highstock) Whether to apply steps to the line. Possible
  71260. * values are `left`, `center` and `right`.
  71261. */
  71262. step?: OptionsStepValue;
  71263. /**
  71264. * (Highstock) Sticky tracking of mouse events. When true, the `mouseOut`
  71265. * event on a series isn't triggered until the mouse moves over another
  71266. * series, or out of the plot area. When false, the `mouseOut` event on a
  71267. * series is triggered when the mouse leaves the area around the series'
  71268. * graph or markers. This also implies the tooltip when not shared. When
  71269. * `stickyTracking` is false and `tooltip.shared` is false, the tooltip will
  71270. * be hidden when moving the mouse between series. Defaults to true for line
  71271. * and area type series, but to false for columns, pies etc.
  71272. *
  71273. * **Note:** The boost module will force this option because of technical
  71274. * limitations.
  71275. */
  71276. stickyTracking?: boolean;
  71277. /**
  71278. * (Highcharts, Highstock) The threshold, also called zero level or base
  71279. * level. For line type series this is only used in conjunction with
  71280. * negativeColor.
  71281. */
  71282. threshold?: (number|null);
  71283. /**
  71284. * (Highstock) A configuration object for the tooltip rendering of each
  71285. * single series. Properties are inherited from tooltip, but only the
  71286. * following properties can be defined on a series level.
  71287. */
  71288. tooltip?: SeriesTooltipOptionsObject;
  71289. /**
  71290. * (Highcharts, Highstock, Gantt) When a series contains a data array that
  71291. * is longer than this, only one dimensional arrays of numbers, or two
  71292. * dimensional arrays with x and y values are allowed. Also, only the first
  71293. * point is tested, and the rest are assumed to be the same format. This
  71294. * saves expensive data checking and indexing in long series. Set it to `0`
  71295. * disable.
  71296. *
  71297. * Note: In boost mode turbo threshold is forced. Only array of numbers or
  71298. * two dimensional arrays are allowed.
  71299. */
  71300. turboThreshold?: number;
  71301. /**
  71302. * (Highstock) Set the initial visibility of the series.
  71303. */
  71304. visible?: boolean;
  71305. /**
  71306. * (Highmaps) Define the z index of the series.
  71307. */
  71308. zIndex?: number;
  71309. /**
  71310. * (Highcharts, Highstock) Defines the Axis on which the zones are applied.
  71311. */
  71312. zoneAxis?: string;
  71313. /**
  71314. * (Highcharts, Highstock) An array defining zones within a series. Zones
  71315. * can be applied to the X axis, Y axis or Z axis for bubbles, according to
  71316. * the `zoneAxis` option. The zone definitions have to be in ascending order
  71317. * regarding to the value.
  71318. *
  71319. * In styled mode, the color zones are styled with the
  71320. * `.highcharts-zone-{n}` class, or custom classed from the `className`
  71321. * option (view live demo).
  71322. */
  71323. zones?: Array<SeriesZonesOptionsObject>;
  71324. }
  71325. /**
  71326. * (Highstock) Paramters used in calculation of Percentage Price Oscillator
  71327. * series points.
  71328. */
  71329. export interface PlotPpoParamsOptions {
  71330. /**
  71331. * (Highstock) The point index which indicator calculations will base. For
  71332. * example using OHLC data, index=2 means the indicator will be calculated
  71333. * using Low values.
  71334. *
  71335. * By default index value used to be set to 0. Since Highstock 7 by default
  71336. * index is set to 3 which means that the ema indicator will be calculated
  71337. * using Close values.
  71338. */
  71339. index?: number;
  71340. /**
  71341. * (Highstock) Periods for Percentage Price Oscillator calculations.
  71342. */
  71343. periods?: Array<number>;
  71344. }
  71345. /**
  71346. * (Highstock) Enable or disable the initial animation when a series is
  71347. * displayed. The animation can also be set as a configuration object. Please
  71348. * note that this option only applies to the initial animation of the series
  71349. * itself. For other animations, see chart.animation and the animation parameter
  71350. * under the API methods. The following properties are supported:
  71351. *
  71352. * - `defer`: The animation delay time in milliseconds.
  71353. *
  71354. * - `duration`: The duration of the animation in milliseconds.
  71355. *
  71356. * - `easing`: Can be a string reference to an easing function set on the `Math`
  71357. * object or a function. See the _Custom easing function_ demo below.
  71358. *
  71359. * Due to poor performance, animation is disabled in old IE browsers for several
  71360. * chart types.
  71361. */
  71362. export interface PlotPriceenvelopesAnimationOptions {
  71363. defer?: number;
  71364. }
  71365. /**
  71366. * (Highstock) Bottom line options.
  71367. */
  71368. export interface PlotPriceenvelopesBottomLineOptions {
  71369. styles?: PlotPriceenvelopesBottomLineStylesOptions;
  71370. }
  71371. export interface PlotPriceenvelopesBottomLineStylesOptions {
  71372. /**
  71373. * (Highstock) Color of the line. If not set, it's inherited from
  71374. * plotOptions.priceenvelopes.color.
  71375. */
  71376. lineColor?: ColorString;
  71377. /**
  71378. * (Highstock) Pixel width of the line.
  71379. */
  71380. lineWidth?: number;
  71381. }
  71382. /**
  71383. * (Highcharts, Highstock, Highmaps, Gantt) Enable or disable the initial
  71384. * animation when a series is displayed for the `dataLabels`. The animation can
  71385. * also be set as a configuration object. Please note that this option only
  71386. * applies to the initial animation. For other animations, see chart.animation
  71387. * and the animation parameter under the API methods. The following properties
  71388. * are supported:
  71389. *
  71390. * - `defer`: The animation delay time in milliseconds.
  71391. */
  71392. export interface PlotPriceenvelopesDataLabelsAnimationOptions {
  71393. /**
  71394. * (Highcharts, Highstock, Highmaps, Gantt) The animation delay time in
  71395. * milliseconds. Set to `0` renders dataLabel immediately. As `undefined`
  71396. * inherits defer time from the series.animation.defer.
  71397. */
  71398. defer?: number;
  71399. }
  71400. /**
  71401. * (Highcharts, Highstock, Highmaps, Gantt) Options for the series data labels,
  71402. * appearing next to each data point.
  71403. *
  71404. * Since v6.2.0, multiple data labels can be applied to each single point by
  71405. * defining them as an array of configs.
  71406. *
  71407. * In styled mode, the data labels can be styled with the
  71408. * `.highcharts-data-label-box` and `.highcharts-data-label` class names (see
  71409. * example).
  71410. */
  71411. export interface PlotPriceenvelopesDataLabelsOptions {
  71412. /**
  71413. * (Highcharts, Highstock, Highmaps, Gantt) The alignment of the data label
  71414. * compared to the point. If `right`, the right side of the label should be
  71415. * touching the point. For points with an extent, like columns, the
  71416. * alignments also dictates how to align it inside the box, as given with
  71417. * the inside option. Can be one of `left`, `center` or `right`.
  71418. */
  71419. align?: (AlignValue|null);
  71420. /**
  71421. * (Highcharts, Highstock, Highmaps, Gantt) Whether to allow data labels to
  71422. * overlap. To make the labels less sensitive for overlapping, the
  71423. * dataLabels.padding can be set to 0.
  71424. */
  71425. allowOverlap?: boolean;
  71426. /**
  71427. * (Highcharts, Highstock, Highmaps, Gantt) Enable or disable the initial
  71428. * animation when a series is displayed for the `dataLabels`. The animation
  71429. * can also be set as a configuration object. Please note that this option
  71430. * only applies to the initial animation. For other animations, see
  71431. * chart.animation and the animation parameter under the API methods. The
  71432. * following properties are supported:
  71433. *
  71434. * - `defer`: The animation delay time in milliseconds.
  71435. */
  71436. animation?: (boolean|PlotPriceenvelopesDataLabelsAnimationOptions|Partial<AnimationOptionsObject>);
  71437. /**
  71438. * (Highcharts, Highstock, Highmaps, Gantt) The background color or gradient
  71439. * for the data label.
  71440. */
  71441. backgroundColor?: (ColorString|GradientColorObject|PatternObject);
  71442. /**
  71443. * (Highcharts, Highstock, Highmaps, Gantt) The border color for the data
  71444. * label. Defaults to `undefined`.
  71445. */
  71446. borderColor?: (ColorString|GradientColorObject|PatternObject);
  71447. /**
  71448. * (Highcharts, Highstock, Highmaps, Gantt) The border radius in pixels for
  71449. * the data label.
  71450. */
  71451. borderRadius?: number;
  71452. /**
  71453. * (Highcharts, Highstock, Highmaps, Gantt) The border width in pixels for
  71454. * the data label.
  71455. */
  71456. borderWidth?: number;
  71457. /**
  71458. * (Highcharts, Highstock, Highmaps, Gantt) A class name for the data label.
  71459. * Particularly in styled mode, this can be used to give each series' or
  71460. * point's data label unique styling. In addition to this option, a default
  71461. * color class name is added so that we can give the labels a contrast text
  71462. * shadow.
  71463. */
  71464. className?: string;
  71465. /**
  71466. * (Highcharts, Highstock, Highmaps, Gantt) The text color for the data
  71467. * labels. Defaults to `undefined`. For certain series types, like column or
  71468. * map, the data labels can be drawn inside the points. In this case the
  71469. * data label will be drawn with maximum contrast by default. Additionally,
  71470. * it will be given a `text-outline` style with the opposite color, to
  71471. * further increase the contrast. This can be overridden by setting the
  71472. * `text-outline` style to `none` in the `dataLabels.style` option.
  71473. */
  71474. color?: (ColorString|GradientColorObject|PatternObject);
  71475. /**
  71476. * (Highcharts, Highstock, Highmaps, Gantt) Whether to hide data labels that
  71477. * are outside the plot area. By default, the data label is moved inside the
  71478. * plot area according to the overflow option.
  71479. */
  71480. crop?: boolean;
  71481. /**
  71482. * (Highcharts, Highstock, Gantt) Whether to defer displaying the data
  71483. * labels until the initial series animation has finished. Setting to
  71484. * `false` renders the data label immediately. If set to `true` inherits the
  71485. * defer time set in plotOptions.series.animation.
  71486. */
  71487. defer?: boolean;
  71488. /**
  71489. * (Highcharts, Highstock, Highmaps, Gantt) Enable or disable the data
  71490. * labels.
  71491. */
  71492. enabled?: boolean;
  71493. /**
  71494. * (Highcharts, Highstock, Highmaps, Gantt) A declarative filter to control
  71495. * of which data labels to display. The declarative filter is designed for
  71496. * use when callback functions are not available, like when the chart
  71497. * options require a pure JSON structure or for use with graphical editors.
  71498. * For programmatic control, use the `formatter` instead, and return
  71499. * `undefined` to disable a single data label.
  71500. */
  71501. filter?: DataLabelsFilterOptionsObject;
  71502. /**
  71503. * (Highcharts, Highstock, Highmaps, Gantt) A format string for the data
  71504. * label. Available variables are the same as for `formatter`.
  71505. */
  71506. format?: string;
  71507. /**
  71508. * (Highcharts, Highstock, Highmaps, Gantt) Callback JavaScript function to
  71509. * format the data label. Note that if a `format` is defined, the format
  71510. * takes precedence and the formatter is ignored.
  71511. */
  71512. formatter?: DataLabelsFormatterCallbackFunction;
  71513. /**
  71514. * (Highcharts, Highstock, Highmaps, Gantt) For points with an extent, like
  71515. * columns or map areas, whether to align the data label inside the box or
  71516. * to the actual value point. Defaults to `false` in most cases, `true` in
  71517. * stacked columns.
  71518. */
  71519. inside?: boolean;
  71520. /**
  71521. * (Highcharts, Highstock, Highmaps, Gantt) Format for points with the value
  71522. * of null. Works analogously to format. `nullFormat` can be applied only to
  71523. * series which support displaying null points.
  71524. */
  71525. nullFormat?: (boolean|string);
  71526. /**
  71527. * (Highcharts, Highstock, Highmaps, Gantt) Callback JavaScript function
  71528. * that defines formatting for points with the value of null. Works
  71529. * analogously to formatter. `nullPointFormatter` can be applied only to
  71530. * series which support displaying null points.
  71531. */
  71532. nullFormatter?: DataLabelsFormatterCallbackFunction;
  71533. /**
  71534. * (Highcharts, Highstock, Highmaps, Gantt) How to handle data labels that
  71535. * flow outside the plot area. The default is `"justify"`, which aligns them
  71536. * inside the plot area. For columns and bars, this means it will be moved
  71537. * inside the bar. To display data labels outside the plot area, set `crop`
  71538. * to `false` and `overflow` to `"allow"`.
  71539. */
  71540. overflow?: DataLabelsOverflowValue;
  71541. /**
  71542. * (Highcharts, Highstock, Highmaps, Gantt) When either the `borderWidth` or
  71543. * the `backgroundColor` is set, this is the padding within the box.
  71544. */
  71545. padding?: number;
  71546. /**
  71547. * (Highcharts, Highstock, Highmaps, Gantt) Aligns data labels relative to
  71548. * points. If `center` alignment is not possible, it defaults to `right`.
  71549. */
  71550. position?: AlignValue;
  71551. /**
  71552. * (Highcharts, Highstock, Highmaps, Gantt) Text rotation in degrees. Note
  71553. * that due to a more complex structure, backgrounds, borders and padding
  71554. * will be lost on a rotated data label.
  71555. */
  71556. rotation?: number;
  71557. /**
  71558. * (Highcharts, Highstock, Highmaps, Gantt) The shadow of the box. Works
  71559. * best with `borderWidth` or `backgroundColor`. Since 2.3 the shadow can be
  71560. * an object configuration containing `color`, `offsetX`, `offsetY`,
  71561. * `opacity` and `width`.
  71562. */
  71563. shadow?: (boolean|ShadowOptionsObject);
  71564. /**
  71565. * (Highcharts, Highstock, Highmaps, Gantt) The name of a symbol to use for
  71566. * the border around the label. Symbols are predefined functions on the
  71567. * Renderer object.
  71568. */
  71569. shape?: string;
  71570. /**
  71571. * (Highcharts, Highstock, Highmaps, Gantt) Styles for the label. The
  71572. * default `color` setting is `"contrast"`, which is a pseudo color that
  71573. * Highcharts picks up and applies the maximum contrast to the underlying
  71574. * point item, for example the bar in a bar chart.
  71575. *
  71576. * The `textOutline` is a pseudo property that applies an outline of the
  71577. * given width with the given color, which by default is the maximum
  71578. * contrast to the text. So a bright text color will result in a black text
  71579. * outline for maximum readability on a mixed background. In some cases,
  71580. * especially with grayscale text, the text outline doesn't work well, in
  71581. * which cases it can be disabled by setting it to `"none"`. When `useHTML`
  71582. * is true, the `textOutline` will not be picked up. In this, case, the same
  71583. * effect can be acheived through the `text-shadow` CSS property.
  71584. *
  71585. * For some series types, where each point has an extent, like for example
  71586. * tree maps, the data label may overflow the point. There are two
  71587. * strategies for handling overflow. By default, the text will wrap to
  71588. * multiple lines. The other strategy is to set `style.textOverflow` to
  71589. * `ellipsis`, which will keep the text on one line plus it will break
  71590. * inside long words.
  71591. */
  71592. style?: CSSObject;
  71593. /**
  71594. * (Highcharts, Highstock, Highmaps, Gantt) Options for a label text which
  71595. * should follow marker's shape. Border and background are disabled for a
  71596. * label that follows a path.
  71597. *
  71598. * **Note:** Only SVG-based renderer supports this option. Setting `useHTML`
  71599. * to true will disable this option.
  71600. */
  71601. textPath?: DataLabelsTextPathOptionsObject;
  71602. /**
  71603. * (Highcharts, Highstock, Highmaps, Gantt) Whether to use HTML to render
  71604. * the labels.
  71605. */
  71606. useHTML?: boolean;
  71607. /**
  71608. * (Highcharts, Highstock, Highmaps, Gantt) The vertical alignment of a data
  71609. * label. Can be one of `top`, `middle` or `bottom`. The default value
  71610. * depends on the data, for instance in a column chart, the label is above
  71611. * positive values and below negative values.
  71612. */
  71613. verticalAlign?: (VerticalAlignValue|null);
  71614. /**
  71615. * (Highcharts, Highstock, Highmaps, Gantt) The x position offset of the
  71616. * label relative to the point in pixels.
  71617. */
  71618. x?: number;
  71619. /**
  71620. * (Highcharts, Highstock, Highmaps, Gantt) The y position offset of the
  71621. * label relative to the point in pixels.
  71622. */
  71623. y?: number;
  71624. /**
  71625. * (Highcharts, Highstock, Highmaps, Gantt) The Z index of the data labels.
  71626. * The default Z index puts it above the series. Use a Z index of 2 to
  71627. * display it behind the series.
  71628. */
  71629. z?: number;
  71630. }
  71631. /**
  71632. * (Highcharts, Highstock) Options for the series data sorting.
  71633. */
  71634. export interface PlotPriceenvelopesDataSortingOptions {
  71635. /**
  71636. * (Highcharts, Highstock) Enable or disable data sorting for the series.
  71637. * Use xAxis.reversed to change the sorting order.
  71638. */
  71639. enabled?: boolean;
  71640. /**
  71641. * (Highcharts, Highstock) Whether to allow matching points by name in an
  71642. * update. If this option is disabled, points will be matched by order.
  71643. */
  71644. matchByName?: boolean;
  71645. /**
  71646. * (Highcharts, Highstock) Determines what data value should be used to sort
  71647. * by.
  71648. */
  71649. sortKey?: string;
  71650. }
  71651. /**
  71652. * (Highstock) Price envelopes indicator based on SMA calculations. This series
  71653. * requires the `linkedTo` option to be set and should be loaded after the
  71654. * `stock/indicators/indicators.js` file.
  71655. *
  71656. * In TypeScript the type option must always be set.
  71657. *
  71658. * Configuration options for the series are given in three levels:
  71659. *
  71660. * 1. Options for all series in a chart are defined in the plotOptions.series
  71661. * object.
  71662. *
  71663. * 2. Options for all `priceenvelopes` series are defined in
  71664. * plotOptions.priceenvelopes.
  71665. *
  71666. * 3. Options for one single series are given in the series instance array. (see
  71667. * online documentation for example)
  71668. */
  71669. export interface PlotPriceenvelopesOptions {
  71670. /**
  71671. * (Highstock) Accessibility options for a series.
  71672. */
  71673. accessibility?: SeriesAccessibilityOptionsObject;
  71674. /**
  71675. * (Highstock) Allow this series' points to be selected by clicking on the
  71676. * graphic (columns, point markers, pie slices, map areas etc).
  71677. *
  71678. * The selected points can be handled by point select and unselect events,
  71679. * or collectively by the getSelectedPoints function.
  71680. *
  71681. * And alternative way of selecting points is through dragging.
  71682. */
  71683. allowPointSelect?: boolean;
  71684. /**
  71685. * (Highstock) Enable or disable the initial animation when a series is
  71686. * displayed. The animation can also be set as a configuration object.
  71687. * Please note that this option only applies to the initial animation of the
  71688. * series itself. For other animations, see chart.animation and the
  71689. * animation parameter under the API methods. The following properties are
  71690. * supported:
  71691. *
  71692. * - `defer`: The animation delay time in milliseconds.
  71693. *
  71694. * - `duration`: The duration of the animation in milliseconds.
  71695. *
  71696. * - `easing`: Can be a string reference to an easing function set on the
  71697. * `Math` object or a function. See the _Custom easing function_ demo below.
  71698. *
  71699. * Due to poor performance, animation is disabled in old IE browsers for
  71700. * several chart types.
  71701. */
  71702. animation?: (boolean|PlotPriceenvelopesAnimationOptions|Partial<AnimationOptionsObject>);
  71703. /**
  71704. * (Highstock) For some series, there is a limit that shuts down initial
  71705. * animation by default when the total number of points in the chart is too
  71706. * high. For example, for a column chart and its derivatives, animation does
  71707. * not run if there is more than 250 points totally. To disable this cap,
  71708. * set `animationLimit` to `Infinity`.
  71709. */
  71710. animationLimit?: number;
  71711. /**
  71712. * (Highstock) Sets the color blending in the boost module.
  71713. */
  71714. boostBlending?: OptionsBoostBlendingValue;
  71715. /**
  71716. * (Highstock) Set the point threshold for when a series should enter boost
  71717. * mode.
  71718. *
  71719. * Setting it to e.g. 2000 will cause the series to enter boost mode when
  71720. * there are 2000 or more points in the series.
  71721. *
  71722. * To disable boosting on the series, set the `boostThreshold` to 0. Setting
  71723. * it to 1 will force boosting.
  71724. *
  71725. * Note that the cropThreshold also affects this setting. When zooming in on
  71726. * a series that has fewer points than the `cropThreshold`, all points are
  71727. * rendered although outside the visible plot area, and the `boostThreshold`
  71728. * won't take effect.
  71729. */
  71730. boostThreshold?: number;
  71731. /**
  71732. * (Highmaps) The border color of the map areas.
  71733. *
  71734. * In styled mode, the border stroke is given in the `.highcharts-point`
  71735. * class.
  71736. */
  71737. borderColor?: (ColorString|GradientColorObject|PatternObject);
  71738. /**
  71739. * (Highmaps) The border width of each map area.
  71740. *
  71741. * In styled mode, the border stroke width is given in the
  71742. * `.highcharts-point` class.
  71743. */
  71744. borderWidth?: number;
  71745. /**
  71746. * (Highstock) Bottom line options.
  71747. */
  71748. bottomLine?: PlotPriceenvelopesBottomLineOptions;
  71749. /**
  71750. * (Highstock) An additional class name to apply to the series' graphical
  71751. * elements. This option does not replace default class names of the
  71752. * graphical element.
  71753. */
  71754. className?: string;
  71755. /**
  71756. * (Highstock) Disable this option to allow series rendering in the whole
  71757. * plotting area.
  71758. *
  71759. * **Note:** Clipping should be always enabled when chart.zoomType is set
  71760. */
  71761. clip?: boolean;
  71762. /**
  71763. * (Highstock) The main color of the series. In line type series it applies
  71764. * to the line and the point markers unless otherwise specified. In bar type
  71765. * series it applies to the bars unless a color is specified per point. The
  71766. * default value is pulled from the `options.colors` array.
  71767. *
  71768. * In styled mode, the color can be defined by the colorIndex option. Also,
  71769. * the series color can be set with the `.highcharts-series`,
  71770. * `.highcharts-color-{n}`, `.highcharts-{type}-series` or
  71771. * `.highcharts-series-{n}` class, or individual classes given by the
  71772. * `className` option.
  71773. */
  71774. color?: (ColorString|GradientColorObject|PatternObject);
  71775. /**
  71776. * (Highstock) Styled mode only. A specific color index to use for the
  71777. * series, so its graphic representations are given the class name
  71778. * `highcharts-color-{n}`.
  71779. */
  71780. colorIndex?: number;
  71781. /**
  71782. * (Highcharts, Highstock, Highmaps) Determines what data value should be
  71783. * used to calculate point color if `colorAxis` is used. Requires to set
  71784. * `min` and `max` if some custom point property is used or if approximation
  71785. * for data grouping is set to `'sum'`.
  71786. */
  71787. colorKey?: string;
  71788. /**
  71789. * (Highstock) Compare the values of the series against the first non-null,
  71790. * non- zero value in the visible range. The y axis will show percentage or
  71791. * absolute change depending on whether `compare` is set to `"percent"` or
  71792. * `"value"`. When this is applied to multiple series, it allows comparing
  71793. * the development of the series against each other. Adds a `change` field
  71794. * to every point object.
  71795. */
  71796. compare?: string;
  71797. /**
  71798. * (Highstock) When compare is `percent`, this option dictates whether to
  71799. * use 0 or 100 as the base of comparison.
  71800. */
  71801. compareBase?: (0|100);
  71802. /**
  71803. * (Highstock) Defines if comparison should start from the first point
  71804. * within the visible range or should start from the first point **before**
  71805. * the range.
  71806. *
  71807. * In other words, this flag determines if first point within the visible
  71808. * range will have 0% (`compareStart=true`) or should have been already
  71809. * calculated according to the previous point (`compareStart=false`).
  71810. */
  71811. compareStart?: boolean;
  71812. /**
  71813. * (Highstock) Whether to compare indicator to the main series values or
  71814. * indicator values.
  71815. */
  71816. compareToMain?: boolean;
  71817. /**
  71818. * (Highcharts) Polar charts only. Whether to connect the ends of a line
  71819. * series plot across the extremes.
  71820. */
  71821. connectEnds?: boolean;
  71822. /**
  71823. * (Highcharts, Highstock) Whether to connect a graph line across null
  71824. * points, or render a gap between the two points on either side of the
  71825. * null.
  71826. */
  71827. connectNulls?: boolean;
  71828. /**
  71829. * (Gantt) Override Pathfinder connector options for a series. Requires
  71830. * Highcharts Gantt to be loaded.
  71831. */
  71832. connectors?: SeriesConnectorsOptionsObject;
  71833. /**
  71834. * (Highcharts, Highstock, Gantt) When true, each point or column edge is
  71835. * rounded to its nearest pixel in order to render sharp on screen. In some
  71836. * cases, when there are a lot of densely packed columns, this leads to
  71837. * visible difference in column widths or distance between columns. In these
  71838. * cases, setting `crisp` to `false` may look better, even though each
  71839. * column is rendered blurry.
  71840. */
  71841. crisp?: boolean;
  71842. /**
  71843. * (Highcharts, Highstock) When the series contains less points than the
  71844. * crop threshold, all points are drawn, even if the points fall outside the
  71845. * visible plot area at the current zoom. The advantage of drawing all
  71846. * points (including markers and columns), is that animation is performed on
  71847. * updates. On the other hand, when the series contains more points than the
  71848. * crop threshold, the series data is cropped to only contain points that
  71849. * fall within the plot area. The advantage of cropping away invisible
  71850. * points is to increase performance on large series.
  71851. */
  71852. cropThreshold?: number;
  71853. /**
  71854. * (Highstock) You can set the cursor to "pointer" if you have click events
  71855. * attached to the series, to signal to the user that the points and lines
  71856. * can be clicked.
  71857. *
  71858. * In styled mode, the series cursor can be set with the same classes as
  71859. * listed under series.color.
  71860. */
  71861. cursor?: (string|CursorValue);
  71862. /**
  71863. * (Highstock) A reserved subspace to store options and values for
  71864. * customized functionality. Here you can add additional data for your own
  71865. * event callbacks and formatter callbacks.
  71866. */
  71867. custom?: Dictionary<any>;
  71868. /**
  71869. * (Highstock) Name of the dash style to use for the graph, or for some
  71870. * series types the outline of each shape.
  71871. *
  71872. * In styled mode, the stroke dash-array can be set with the same classes as
  71873. * listed under series.color.
  71874. */
  71875. dashStyle?: DashStyleValue;
  71876. /**
  71877. * (Highstock) Data grouping is the concept of sampling the data values into
  71878. * larger blocks in order to ease readability and increase performance of
  71879. * the JavaScript charts. Highstock by default applies data grouping when
  71880. * the points become closer than a certain pixel value, determined by the
  71881. * `groupPixelWidth` option.
  71882. *
  71883. * If data grouping is applied, the grouping information of grouped points
  71884. * can be read from the Point.dataGroup. If point options other than the
  71885. * data itself are set, for example `name` or `color` or custom properties,
  71886. * the grouping logic doesn't know how to group it. In this case the options
  71887. * of the first point instance are copied over to the group point. This can
  71888. * be altered through a custom `approximation` callback function.
  71889. */
  71890. dataGrouping?: DataGroupingOptionsObject;
  71891. /**
  71892. * (Highcharts, Highstock, Highmaps, Gantt) Options for the series data
  71893. * labels, appearing next to each data point.
  71894. *
  71895. * Since v6.2.0, multiple data labels can be applied to each single point by
  71896. * defining them as an array of configs.
  71897. *
  71898. * In styled mode, the data labels can be styled with the
  71899. * `.highcharts-data-label-box` and `.highcharts-data-label` class names
  71900. * (see example).
  71901. */
  71902. dataLabels?: (PlotPriceenvelopesDataLabelsOptions|Array<PlotPriceenvelopesDataLabelsOptions>);
  71903. /**
  71904. * (Highcharts, Highstock) Options for the series data sorting.
  71905. */
  71906. dataSorting?: (DataSortingOptionsObject|PlotPriceenvelopesDataSortingOptions);
  71907. /**
  71908. * (Highstock) A description of the series to add to the screen reader
  71909. * information about the series.
  71910. */
  71911. description?: string;
  71912. /**
  71913. * (Highstock) Enable or disable the mouse tracking for a specific series.
  71914. * This includes point tooltips and click events on graphs and points. For
  71915. * large datasets it improves performance.
  71916. */
  71917. enableMouseTracking?: boolean;
  71918. /**
  71919. * (Highstock) General event handlers for the series items. These event
  71920. * hooks can also be attached to the series at run time using the
  71921. * `Highcharts.addEvent` function.
  71922. */
  71923. events?: SeriesEventsOptionsObject;
  71924. /**
  71925. * (Highstock) Determines whether the series should look for the nearest
  71926. * point in both dimensions or just the x-dimension when hovering the
  71927. * series. Defaults to `'xy'` for scatter series and `'x'` for most other
  71928. * series. If the data has duplicate x-values, it is recommended to set this
  71929. * to `'xy'` to allow hovering over all points.
  71930. *
  71931. * Applies only to series types using nearest neighbor search (not direct
  71932. * hover) for tooltip.
  71933. */
  71934. findNearestPointBy?: OptionsFindNearestPointByValue;
  71935. /**
  71936. * (Highstock) Defines when to display a gap in the graph, together with the
  71937. * gapUnit option.
  71938. *
  71939. * In case when `dataGrouping` is enabled, points can be grouped into a
  71940. * larger time span. This can make the grouped points to have a greater
  71941. * distance than the absolute value of `gapSize` property, which will result
  71942. * in disappearing graph completely. To prevent this situation the mentioned
  71943. * distance between grouped points is used instead of previously defined
  71944. * `gapSize`.
  71945. *
  71946. * In practice, this option is most often used to visualize gaps in time
  71947. * series. In a stock chart, intraday data is available for daytime hours,
  71948. * while gaps will appear in nights and weekends.
  71949. */
  71950. gapSize?: number;
  71951. /**
  71952. * (Highstock) Together with gapSize, this option defines where to draw gaps
  71953. * in the graph.
  71954. *
  71955. * When the `gapUnit` is `"relative"` (default), a gap size of 5 means that
  71956. * if the distance between two points is greater than 5 times that of the
  71957. * two closest points, the graph will be broken.
  71958. *
  71959. * When the `gapUnit` is `"value"`, the gap is based on absolute axis
  71960. * values, which on a datetime axis is milliseconds. This also applies to
  71961. * the navigator series that inherits gap options from the base series.
  71962. */
  71963. gapUnit?: OptionsGapUnitValue;
  71964. /**
  71965. * (Highcharts, Highstock, Gantt) Whether to use the Y extremes of the total
  71966. * chart width or only the zoomed area when zooming in on parts of the X
  71967. * axis. By default, the Y axis adjusts to the min and max of the visible
  71968. * data. Cartesian series only.
  71969. */
  71970. getExtremesFromAll?: boolean;
  71971. /**
  71972. * (Highstock) When set to `false` will prevent the series data from being
  71973. * included in any form of data export.
  71974. *
  71975. * Since version 6.0.0 until 7.1.0 the option was existing undocumented as
  71976. * `includeInCSVExport`.
  71977. */
  71978. includeInDataExport?: boolean;
  71979. /**
  71980. * (Highcharts, Highstock, Gantt) Series labels are placed as close to the
  71981. * series as possible in a natural way, seeking to avoid other series. The
  71982. * goal of this feature is to make the chart more easily readable, like if a
  71983. * human designer placed the labels in the optimal position.
  71984. *
  71985. * The series labels currently work with series types having a `graph` or an
  71986. * `area`.
  71987. */
  71988. label?: SeriesLabelOptionsObject;
  71989. /**
  71990. * (Highstock) The line marks the last price from all points.
  71991. */
  71992. lastPrice?: SeriesLastPriceOptionsObject;
  71993. /**
  71994. * (Highstock) The line marks the last price from visible range of points.
  71995. */
  71996. lastVisiblePrice?: SeriesLastVisiblePriceOptionsObject;
  71997. /**
  71998. * (Highcharts, Highstock) The SVG value used for the `stroke-linecap` and
  71999. * `stroke-linejoin` of a line graph. Round means that lines are rounded in
  72000. * the ends and bends.
  72001. */
  72002. linecap?: SeriesLinecapValue;
  72003. /**
  72004. * (Highcharts, Highstock) Pixel width of the graph line.
  72005. */
  72006. lineWidth?: number;
  72007. /**
  72008. * (Highcharts, Highstock, Gantt) The main series ID that indicator will be
  72009. * based on. Required for this indicator.
  72010. */
  72011. linkedTo?: string;
  72012. /**
  72013. * (Highstock) Options for the point markers of line-like series. Properties
  72014. * like `fillColor`, `lineColor` and `lineWidth` define the visual
  72015. * appearance of the markers. Other series types, like column series, don't
  72016. * have markers, but have visual options on the series level instead.
  72017. *
  72018. * In styled mode, the markers can be styled with the `.highcharts-point`,
  72019. * `.highcharts-point-hover` and `.highcharts-point-select` class names.
  72020. */
  72021. marker?: PointMarkerOptionsObject;
  72022. /**
  72023. * (Highstock) The name of the series as shown in the legend, tooltip etc.
  72024. * If not set, it will be based on a technical indicator type and default
  72025. * params.
  72026. */
  72027. name?: string;
  72028. /**
  72029. * (Highstock) The color for the parts of the graph or points that are below
  72030. * the threshold. Note that `zones` takes precedence over the negative
  72031. * color. Using `negativeColor` is equivalent to applying a zone with value
  72032. * of 0.
  72033. */
  72034. negativeColor?: (ColorString|GradientColorObject|PatternObject);
  72035. /**
  72036. * (Highstock) Opacity of a series parts: line, fill (e.g. area) and
  72037. * dataLabels.
  72038. */
  72039. opacity?: number;
  72040. /**
  72041. * (Highstock) Paramters used in calculation of regression series' points.
  72042. */
  72043. params?: PlotPriceenvelopesParamsOptions;
  72044. /**
  72045. * (Highstock) Properties for each single point.
  72046. */
  72047. point?: PlotSeriesPointOptions;
  72048. /**
  72049. * (Highstock) Same as accessibility.pointDescriptionFormatter, but for an
  72050. * individual series. Overrides the chart wide configuration.
  72051. */
  72052. pointDescriptionFormatter?: Function;
  72053. /**
  72054. * (Highstock) Whether to select the series initially. If `showCheckbox` is
  72055. * true, the checkbox next to the series name in the legend will be checked
  72056. * for a selected series.
  72057. */
  72058. selected?: boolean;
  72059. /**
  72060. * (Highstock) Whether to apply a drop shadow to the graph line. Since 2.3
  72061. * the shadow can be an object configuration containing `color`, `offsetX`,
  72062. * `offsetY`, `opacity` and `width`.
  72063. */
  72064. shadow?: (boolean|ShadowOptionsObject);
  72065. /**
  72066. * (Highstock) If true, a checkbox is displayed next to the legend item to
  72067. * allow selecting the series. The state of the checkbox is determined by
  72068. * the `selected` option.
  72069. */
  72070. showCheckbox?: boolean;
  72071. /**
  72072. * (Highstock) Whether to display this particular series or series type in
  72073. * the legend. Standalone series are shown in legend by default, and linked
  72074. * series are not. Since v7.2.0 it is possible to show series that use
  72075. * colorAxis by setting this option to `true`.
  72076. */
  72077. showInLegend?: boolean;
  72078. /**
  72079. * (Highstock) If set to `true`, the accessibility module will skip past the
  72080. * points in this series for keyboard navigation.
  72081. */
  72082. skipKeyboardNavigation?: boolean;
  72083. /**
  72084. * (Highcharts, Highstock) When this is true, the series will not cause the
  72085. * Y axis to cross the zero plane (or threshold option) unless the data
  72086. * actually crosses the plane.
  72087. *
  72088. * For example, if `softThreshold` is `false`, a series of 0, 1, 2, 3 will
  72089. * make the Y axis show negative values according to the `minPadding`
  72090. * option. If `softThreshold` is `true`, the Y axis starts at 0.
  72091. */
  72092. softThreshold?: boolean;
  72093. states?: SeriesStatesOptionsObject;
  72094. /**
  72095. * (Highcharts, Highstock) Whether to apply steps to the line. Possible
  72096. * values are `left`, `center` and `right`.
  72097. */
  72098. step?: OptionsStepValue;
  72099. /**
  72100. * (Highstock) Sticky tracking of mouse events. When true, the `mouseOut`
  72101. * event on a series isn't triggered until the mouse moves over another
  72102. * series, or out of the plot area. When false, the `mouseOut` event on a
  72103. * series is triggered when the mouse leaves the area around the series'
  72104. * graph or markers. This also implies the tooltip when not shared. When
  72105. * `stickyTracking` is false and `tooltip.shared` is false, the tooltip will
  72106. * be hidden when moving the mouse between series. Defaults to true for line
  72107. * and area type series, but to false for columns, pies etc.
  72108. *
  72109. * **Note:** The boost module will force this option because of technical
  72110. * limitations.
  72111. */
  72112. stickyTracking?: boolean;
  72113. /**
  72114. * (Highcharts, Highstock) The threshold, also called zero level or base
  72115. * level. For line type series this is only used in conjunction with
  72116. * negativeColor.
  72117. */
  72118. threshold?: (number|null);
  72119. /**
  72120. * (Highstock) A configuration object for the tooltip rendering of each
  72121. * single series. Properties are inherited from tooltip, but only the
  72122. * following properties can be defined on a series level.
  72123. */
  72124. tooltip?: SeriesTooltipOptionsObject;
  72125. /**
  72126. * (Highstock) Top line options.
  72127. */
  72128. topLine?: PlotPriceenvelopesTopLineOptions;
  72129. /**
  72130. * (Highcharts, Highstock, Gantt) When a series contains a data array that
  72131. * is longer than this, only one dimensional arrays of numbers, or two
  72132. * dimensional arrays with x and y values are allowed. Also, only the first
  72133. * point is tested, and the rest are assumed to be the same format. This
  72134. * saves expensive data checking and indexing in long series. Set it to `0`
  72135. * disable.
  72136. *
  72137. * Note: In boost mode turbo threshold is forced. Only array of numbers or
  72138. * two dimensional arrays are allowed.
  72139. */
  72140. turboThreshold?: number;
  72141. /**
  72142. * (Highstock) Set the initial visibility of the series.
  72143. */
  72144. visible?: boolean;
  72145. /**
  72146. * (Highmaps) Define the z index of the series.
  72147. */
  72148. zIndex?: number;
  72149. /**
  72150. * (Highcharts, Highstock) Defines the Axis on which the zones are applied.
  72151. */
  72152. zoneAxis?: string;
  72153. /**
  72154. * (Highcharts, Highstock) An array defining zones within a series. Zones
  72155. * can be applied to the X axis, Y axis or Z axis for bubbles, according to
  72156. * the `zoneAxis` option. The zone definitions have to be in ascending order
  72157. * regarding to the value.
  72158. *
  72159. * In styled mode, the color zones are styled with the
  72160. * `.highcharts-zone-{n}` class, or custom classed from the `className`
  72161. * option (view live demo).
  72162. */
  72163. zones?: Array<SeriesZonesOptionsObject>;
  72164. }
  72165. /**
  72166. * (Highstock) Paramters used in calculation of regression series' points.
  72167. */
  72168. export interface PlotPriceenvelopesParamsOptions {
  72169. /**
  72170. * (Highstock) Percentage below the moving average that should be displayed.
  72171. * 0.1 means 90%. Relative to the calculated value.
  72172. */
  72173. bottomBand?: number;
  72174. /**
  72175. * (Highstock) The point index which indicator calculations will base. For
  72176. * example using OHLC data, index=2 means the indicator will be calculated
  72177. * using Low values.
  72178. */
  72179. index?: number;
  72180. /**
  72181. * (Highstock) The base period for indicator calculations. This is the
  72182. * number of data points which are taken into account for the indicator
  72183. * calculations.
  72184. */
  72185. period?: number;
  72186. /**
  72187. * (Highstock) Percentage above the moving average that should be displayed.
  72188. * 0.1 means 110%. Relative to the calculated value.
  72189. */
  72190. topBand?: number;
  72191. }
  72192. /**
  72193. * (Highstock) Top line options.
  72194. */
  72195. export interface PlotPriceenvelopesTopLineOptions {
  72196. styles?: PlotPriceenvelopesTopLineStylesOptions;
  72197. }
  72198. export interface PlotPriceenvelopesTopLineStylesOptions {
  72199. /**
  72200. * (Highstock) Color of the line. If not set, it's inherited from
  72201. * plotOptions.priceenvelopes.color.
  72202. */
  72203. lineColor?: ColorString;
  72204. /**
  72205. * (Highstock) Pixel width of the line.
  72206. */
  72207. lineWidth?: number;
  72208. }
  72209. /**
  72210. * (Highstock) Enable or disable the initial animation when a series is
  72211. * displayed. The animation can also be set as a configuration object. Please
  72212. * note that this option only applies to the initial animation of the series
  72213. * itself. For other animations, see chart.animation and the animation parameter
  72214. * under the API methods. The following properties are supported:
  72215. *
  72216. * - `defer`: The animation delay time in milliseconds.
  72217. *
  72218. * - `duration`: The duration of the animation in milliseconds.
  72219. *
  72220. * - `easing`: Can be a string reference to an easing function set on the `Math`
  72221. * object or a function. See the _Custom easing function_ demo below.
  72222. *
  72223. * Due to poor performance, animation is disabled in old IE browsers for several
  72224. * chart types.
  72225. */
  72226. export interface PlotPsarAnimationOptions {
  72227. defer?: number;
  72228. }
  72229. /**
  72230. * (Highcharts, Highstock, Highmaps, Gantt) Enable or disable the initial
  72231. * animation when a series is displayed for the `dataLabels`. The animation can
  72232. * also be set as a configuration object. Please note that this option only
  72233. * applies to the initial animation. For other animations, see chart.animation
  72234. * and the animation parameter under the API methods. The following properties
  72235. * are supported:
  72236. *
  72237. * - `defer`: The animation delay time in milliseconds.
  72238. */
  72239. export interface PlotPsarDataLabelsAnimationOptions {
  72240. /**
  72241. * (Highcharts, Highstock, Highmaps, Gantt) The animation delay time in
  72242. * milliseconds. Set to `0` renders dataLabel immediately. As `undefined`
  72243. * inherits defer time from the series.animation.defer.
  72244. */
  72245. defer?: number;
  72246. }
  72247. /**
  72248. * (Highcharts, Highstock, Highmaps, Gantt) Options for the series data labels,
  72249. * appearing next to each data point.
  72250. *
  72251. * Since v6.2.0, multiple data labels can be applied to each single point by
  72252. * defining them as an array of configs.
  72253. *
  72254. * In styled mode, the data labels can be styled with the
  72255. * `.highcharts-data-label-box` and `.highcharts-data-label` class names (see
  72256. * example).
  72257. */
  72258. export interface PlotPsarDataLabelsOptions {
  72259. /**
  72260. * (Highcharts, Highstock, Highmaps, Gantt) The alignment of the data label
  72261. * compared to the point. If `right`, the right side of the label should be
  72262. * touching the point. For points with an extent, like columns, the
  72263. * alignments also dictates how to align it inside the box, as given with
  72264. * the inside option. Can be one of `left`, `center` or `right`.
  72265. */
  72266. align?: (AlignValue|null);
  72267. /**
  72268. * (Highcharts, Highstock, Highmaps, Gantt) Whether to allow data labels to
  72269. * overlap. To make the labels less sensitive for overlapping, the
  72270. * dataLabels.padding can be set to 0.
  72271. */
  72272. allowOverlap?: boolean;
  72273. /**
  72274. * (Highcharts, Highstock, Highmaps, Gantt) Enable or disable the initial
  72275. * animation when a series is displayed for the `dataLabels`. The animation
  72276. * can also be set as a configuration object. Please note that this option
  72277. * only applies to the initial animation. For other animations, see
  72278. * chart.animation and the animation parameter under the API methods. The
  72279. * following properties are supported:
  72280. *
  72281. * - `defer`: The animation delay time in milliseconds.
  72282. */
  72283. animation?: (boolean|PlotPsarDataLabelsAnimationOptions|Partial<AnimationOptionsObject>);
  72284. /**
  72285. * (Highcharts, Highstock, Highmaps, Gantt) The background color or gradient
  72286. * for the data label.
  72287. */
  72288. backgroundColor?: (ColorString|GradientColorObject|PatternObject);
  72289. /**
  72290. * (Highcharts, Highstock, Highmaps, Gantt) The border color for the data
  72291. * label. Defaults to `undefined`.
  72292. */
  72293. borderColor?: (ColorString|GradientColorObject|PatternObject);
  72294. /**
  72295. * (Highcharts, Highstock, Highmaps, Gantt) The border radius in pixels for
  72296. * the data label.
  72297. */
  72298. borderRadius?: number;
  72299. /**
  72300. * (Highcharts, Highstock, Highmaps, Gantt) The border width in pixels for
  72301. * the data label.
  72302. */
  72303. borderWidth?: number;
  72304. /**
  72305. * (Highcharts, Highstock, Highmaps, Gantt) A class name for the data label.
  72306. * Particularly in styled mode, this can be used to give each series' or
  72307. * point's data label unique styling. In addition to this option, a default
  72308. * color class name is added so that we can give the labels a contrast text
  72309. * shadow.
  72310. */
  72311. className?: string;
  72312. /**
  72313. * (Highcharts, Highstock, Highmaps, Gantt) The text color for the data
  72314. * labels. Defaults to `undefined`. For certain series types, like column or
  72315. * map, the data labels can be drawn inside the points. In this case the
  72316. * data label will be drawn with maximum contrast by default. Additionally,
  72317. * it will be given a `text-outline` style with the opposite color, to
  72318. * further increase the contrast. This can be overridden by setting the
  72319. * `text-outline` style to `none` in the `dataLabels.style` option.
  72320. */
  72321. color?: (ColorString|GradientColorObject|PatternObject);
  72322. /**
  72323. * (Highcharts, Highstock, Highmaps, Gantt) Whether to hide data labels that
  72324. * are outside the plot area. By default, the data label is moved inside the
  72325. * plot area according to the overflow option.
  72326. */
  72327. crop?: boolean;
  72328. /**
  72329. * (Highcharts, Highstock, Gantt) Whether to defer displaying the data
  72330. * labels until the initial series animation has finished. Setting to
  72331. * `false` renders the data label immediately. If set to `true` inherits the
  72332. * defer time set in plotOptions.series.animation.
  72333. */
  72334. defer?: boolean;
  72335. /**
  72336. * (Highcharts, Highstock, Highmaps, Gantt) Enable or disable the data
  72337. * labels.
  72338. */
  72339. enabled?: boolean;
  72340. /**
  72341. * (Highcharts, Highstock, Highmaps, Gantt) A declarative filter to control
  72342. * of which data labels to display. The declarative filter is designed for
  72343. * use when callback functions are not available, like when the chart
  72344. * options require a pure JSON structure or for use with graphical editors.
  72345. * For programmatic control, use the `formatter` instead, and return
  72346. * `undefined` to disable a single data label.
  72347. */
  72348. filter?: DataLabelsFilterOptionsObject;
  72349. /**
  72350. * (Highcharts, Highstock, Highmaps, Gantt) A format string for the data
  72351. * label. Available variables are the same as for `formatter`.
  72352. */
  72353. format?: string;
  72354. /**
  72355. * (Highcharts, Highstock, Highmaps, Gantt) Callback JavaScript function to
  72356. * format the data label. Note that if a `format` is defined, the format
  72357. * takes precedence and the formatter is ignored.
  72358. */
  72359. formatter?: DataLabelsFormatterCallbackFunction;
  72360. /**
  72361. * (Highcharts, Highstock, Highmaps, Gantt) For points with an extent, like
  72362. * columns or map areas, whether to align the data label inside the box or
  72363. * to the actual value point. Defaults to `false` in most cases, `true` in
  72364. * stacked columns.
  72365. */
  72366. inside?: boolean;
  72367. /**
  72368. * (Highcharts, Highstock, Highmaps, Gantt) Format for points with the value
  72369. * of null. Works analogously to format. `nullFormat` can be applied only to
  72370. * series which support displaying null points.
  72371. */
  72372. nullFormat?: (boolean|string);
  72373. /**
  72374. * (Highcharts, Highstock, Highmaps, Gantt) Callback JavaScript function
  72375. * that defines formatting for points with the value of null. Works
  72376. * analogously to formatter. `nullPointFormatter` can be applied only to
  72377. * series which support displaying null points.
  72378. */
  72379. nullFormatter?: DataLabelsFormatterCallbackFunction;
  72380. /**
  72381. * (Highcharts, Highstock, Highmaps, Gantt) How to handle data labels that
  72382. * flow outside the plot area. The default is `"justify"`, which aligns them
  72383. * inside the plot area. For columns and bars, this means it will be moved
  72384. * inside the bar. To display data labels outside the plot area, set `crop`
  72385. * to `false` and `overflow` to `"allow"`.
  72386. */
  72387. overflow?: DataLabelsOverflowValue;
  72388. /**
  72389. * (Highcharts, Highstock, Highmaps, Gantt) When either the `borderWidth` or
  72390. * the `backgroundColor` is set, this is the padding within the box.
  72391. */
  72392. padding?: number;
  72393. /**
  72394. * (Highcharts, Highstock, Highmaps, Gantt) Aligns data labels relative to
  72395. * points. If `center` alignment is not possible, it defaults to `right`.
  72396. */
  72397. position?: AlignValue;
  72398. /**
  72399. * (Highcharts, Highstock, Highmaps, Gantt) Text rotation in degrees. Note
  72400. * that due to a more complex structure, backgrounds, borders and padding
  72401. * will be lost on a rotated data label.
  72402. */
  72403. rotation?: number;
  72404. /**
  72405. * (Highcharts, Highstock, Highmaps, Gantt) The shadow of the box. Works
  72406. * best with `borderWidth` or `backgroundColor`. Since 2.3 the shadow can be
  72407. * an object configuration containing `color`, `offsetX`, `offsetY`,
  72408. * `opacity` and `width`.
  72409. */
  72410. shadow?: (boolean|ShadowOptionsObject);
  72411. /**
  72412. * (Highcharts, Highstock, Highmaps, Gantt) The name of a symbol to use for
  72413. * the border around the label. Symbols are predefined functions on the
  72414. * Renderer object.
  72415. */
  72416. shape?: string;
  72417. /**
  72418. * (Highcharts, Highstock, Highmaps, Gantt) Styles for the label. The
  72419. * default `color` setting is `"contrast"`, which is a pseudo color that
  72420. * Highcharts picks up and applies the maximum contrast to the underlying
  72421. * point item, for example the bar in a bar chart.
  72422. *
  72423. * The `textOutline` is a pseudo property that applies an outline of the
  72424. * given width with the given color, which by default is the maximum
  72425. * contrast to the text. So a bright text color will result in a black text
  72426. * outline for maximum readability on a mixed background. In some cases,
  72427. * especially with grayscale text, the text outline doesn't work well, in
  72428. * which cases it can be disabled by setting it to `"none"`. When `useHTML`
  72429. * is true, the `textOutline` will not be picked up. In this, case, the same
  72430. * effect can be acheived through the `text-shadow` CSS property.
  72431. *
  72432. * For some series types, where each point has an extent, like for example
  72433. * tree maps, the data label may overflow the point. There are two
  72434. * strategies for handling overflow. By default, the text will wrap to
  72435. * multiple lines. The other strategy is to set `style.textOverflow` to
  72436. * `ellipsis`, which will keep the text on one line plus it will break
  72437. * inside long words.
  72438. */
  72439. style?: CSSObject;
  72440. /**
  72441. * (Highcharts, Highstock, Highmaps, Gantt) Options for a label text which
  72442. * should follow marker's shape. Border and background are disabled for a
  72443. * label that follows a path.
  72444. *
  72445. * **Note:** Only SVG-based renderer supports this option. Setting `useHTML`
  72446. * to true will disable this option.
  72447. */
  72448. textPath?: DataLabelsTextPathOptionsObject;
  72449. /**
  72450. * (Highcharts, Highstock, Highmaps, Gantt) Whether to use HTML to render
  72451. * the labels.
  72452. */
  72453. useHTML?: boolean;
  72454. /**
  72455. * (Highcharts, Highstock, Highmaps, Gantt) The vertical alignment of a data
  72456. * label. Can be one of `top`, `middle` or `bottom`. The default value
  72457. * depends on the data, for instance in a column chart, the label is above
  72458. * positive values and below negative values.
  72459. */
  72460. verticalAlign?: (VerticalAlignValue|null);
  72461. /**
  72462. * (Highcharts, Highstock, Highmaps, Gantt) The x position offset of the
  72463. * label relative to the point in pixels.
  72464. */
  72465. x?: number;
  72466. /**
  72467. * (Highcharts, Highstock, Highmaps, Gantt) The y position offset of the
  72468. * label relative to the point in pixels.
  72469. */
  72470. y?: number;
  72471. /**
  72472. * (Highcharts, Highstock, Highmaps, Gantt) The Z index of the data labels.
  72473. * The default Z index puts it above the series. Use a Z index of 2 to
  72474. * display it behind the series.
  72475. */
  72476. z?: number;
  72477. }
  72478. /**
  72479. * (Highcharts, Highstock) Options for the series data sorting.
  72480. */
  72481. export interface PlotPsarDataSortingOptions {
  72482. /**
  72483. * (Highcharts, Highstock) Enable or disable data sorting for the series.
  72484. * Use xAxis.reversed to change the sorting order.
  72485. */
  72486. enabled?: boolean;
  72487. /**
  72488. * (Highcharts, Highstock) Whether to allow matching points by name in an
  72489. * update. If this option is disabled, points will be matched by order.
  72490. */
  72491. matchByName?: boolean;
  72492. /**
  72493. * (Highcharts, Highstock) Determines what data value should be used to sort
  72494. * by.
  72495. */
  72496. sortKey?: string;
  72497. }
  72498. /**
  72499. * (Highstock) Parabolic SAR. This series requires `linkedTo` option to be set
  72500. * and should be loaded after `stock/indicators/indicators.js` file.
  72501. *
  72502. * In TypeScript the type option must always be set.
  72503. *
  72504. * Configuration options for the series are given in three levels:
  72505. *
  72506. * 1. Options for all series in a chart are defined in the plotOptions.series
  72507. * object.
  72508. *
  72509. * 2. Options for all `psar` series are defined in plotOptions.psar.
  72510. *
  72511. * 3. Options for one single series are given in the series instance array. (see
  72512. * online documentation for example)
  72513. */
  72514. export interface PlotPsarOptions {
  72515. /**
  72516. * (Highstock) Accessibility options for a series.
  72517. */
  72518. accessibility?: SeriesAccessibilityOptionsObject;
  72519. /**
  72520. * (Highstock) Allow this series' points to be selected by clicking on the
  72521. * graphic (columns, point markers, pie slices, map areas etc).
  72522. *
  72523. * The selected points can be handled by point select and unselect events,
  72524. * or collectively by the getSelectedPoints function.
  72525. *
  72526. * And alternative way of selecting points is through dragging.
  72527. */
  72528. allowPointSelect?: boolean;
  72529. /**
  72530. * (Highstock) Enable or disable the initial animation when a series is
  72531. * displayed. The animation can also be set as a configuration object.
  72532. * Please note that this option only applies to the initial animation of the
  72533. * series itself. For other animations, see chart.animation and the
  72534. * animation parameter under the API methods. The following properties are
  72535. * supported:
  72536. *
  72537. * - `defer`: The animation delay time in milliseconds.
  72538. *
  72539. * - `duration`: The duration of the animation in milliseconds.
  72540. *
  72541. * - `easing`: Can be a string reference to an easing function set on the
  72542. * `Math` object or a function. See the _Custom easing function_ demo below.
  72543. *
  72544. * Due to poor performance, animation is disabled in old IE browsers for
  72545. * several chart types.
  72546. */
  72547. animation?: (boolean|PlotPsarAnimationOptions|Partial<AnimationOptionsObject>);
  72548. /**
  72549. * (Highstock) For some series, there is a limit that shuts down initial
  72550. * animation by default when the total number of points in the chart is too
  72551. * high. For example, for a column chart and its derivatives, animation does
  72552. * not run if there is more than 250 points totally. To disable this cap,
  72553. * set `animationLimit` to `Infinity`.
  72554. */
  72555. animationLimit?: number;
  72556. /**
  72557. * (Highstock) Sets the color blending in the boost module.
  72558. */
  72559. boostBlending?: OptionsBoostBlendingValue;
  72560. /**
  72561. * (Highstock) Set the point threshold for when a series should enter boost
  72562. * mode.
  72563. *
  72564. * Setting it to e.g. 2000 will cause the series to enter boost mode when
  72565. * there are 2000 or more points in the series.
  72566. *
  72567. * To disable boosting on the series, set the `boostThreshold` to 0. Setting
  72568. * it to 1 will force boosting.
  72569. *
  72570. * Note that the cropThreshold also affects this setting. When zooming in on
  72571. * a series that has fewer points than the `cropThreshold`, all points are
  72572. * rendered although outside the visible plot area, and the `boostThreshold`
  72573. * won't take effect.
  72574. */
  72575. boostThreshold?: number;
  72576. /**
  72577. * (Highmaps) The border color of the map areas.
  72578. *
  72579. * In styled mode, the border stroke is given in the `.highcharts-point`
  72580. * class.
  72581. */
  72582. borderColor?: (ColorString|GradientColorObject|PatternObject);
  72583. /**
  72584. * (Highmaps) The border width of each map area.
  72585. *
  72586. * In styled mode, the border stroke width is given in the
  72587. * `.highcharts-point` class.
  72588. */
  72589. borderWidth?: number;
  72590. /**
  72591. * (Highstock) An additional class name to apply to the series' graphical
  72592. * elements. This option does not replace default class names of the
  72593. * graphical element.
  72594. */
  72595. className?: string;
  72596. /**
  72597. * (Highstock) Disable this option to allow series rendering in the whole
  72598. * plotting area.
  72599. *
  72600. * **Note:** Clipping should be always enabled when chart.zoomType is set
  72601. */
  72602. clip?: boolean;
  72603. /**
  72604. * (Highstock) The main color of the series. In line type series it applies
  72605. * to the line and the point markers unless otherwise specified. In bar type
  72606. * series it applies to the bars unless a color is specified per point. The
  72607. * default value is pulled from the `options.colors` array.
  72608. *
  72609. * In styled mode, the color can be defined by the colorIndex option. Also,
  72610. * the series color can be set with the `.highcharts-series`,
  72611. * `.highcharts-color-{n}`, `.highcharts-{type}-series` or
  72612. * `.highcharts-series-{n}` class, or individual classes given by the
  72613. * `className` option.
  72614. */
  72615. color?: (ColorString|GradientColorObject|PatternObject);
  72616. /**
  72617. * (Highstock) Styled mode only. A specific color index to use for the
  72618. * series, so its graphic representations are given the class name
  72619. * `highcharts-color-{n}`.
  72620. */
  72621. colorIndex?: number;
  72622. /**
  72623. * (Highcharts, Highstock, Highmaps) Determines what data value should be
  72624. * used to calculate point color if `colorAxis` is used. Requires to set
  72625. * `min` and `max` if some custom point property is used or if approximation
  72626. * for data grouping is set to `'sum'`.
  72627. */
  72628. colorKey?: string;
  72629. /**
  72630. * (Highstock) Compare the values of the series against the first non-null,
  72631. * non- zero value in the visible range. The y axis will show percentage or
  72632. * absolute change depending on whether `compare` is set to `"percent"` or
  72633. * `"value"`. When this is applied to multiple series, it allows comparing
  72634. * the development of the series against each other. Adds a `change` field
  72635. * to every point object.
  72636. */
  72637. compare?: string;
  72638. /**
  72639. * (Highstock) When compare is `percent`, this option dictates whether to
  72640. * use 0 or 100 as the base of comparison.
  72641. */
  72642. compareBase?: (0|100);
  72643. /**
  72644. * (Highstock) Defines if comparison should start from the first point
  72645. * within the visible range or should start from the first point **before**
  72646. * the range.
  72647. *
  72648. * In other words, this flag determines if first point within the visible
  72649. * range will have 0% (`compareStart=true`) or should have been already
  72650. * calculated according to the previous point (`compareStart=false`).
  72651. */
  72652. compareStart?: boolean;
  72653. /**
  72654. * (Highstock) Whether to compare indicator to the main series values or
  72655. * indicator values.
  72656. */
  72657. compareToMain?: boolean;
  72658. /**
  72659. * (Highcharts) Polar charts only. Whether to connect the ends of a line
  72660. * series plot across the extremes.
  72661. */
  72662. connectEnds?: boolean;
  72663. /**
  72664. * (Highcharts, Highstock) Whether to connect a graph line across null
  72665. * points, or render a gap between the two points on either side of the
  72666. * null.
  72667. */
  72668. connectNulls?: boolean;
  72669. /**
  72670. * (Gantt) Override Pathfinder connector options for a series. Requires
  72671. * Highcharts Gantt to be loaded.
  72672. */
  72673. connectors?: SeriesConnectorsOptionsObject;
  72674. /**
  72675. * (Highcharts, Highstock, Gantt) When true, each point or column edge is
  72676. * rounded to its nearest pixel in order to render sharp on screen. In some
  72677. * cases, when there are a lot of densely packed columns, this leads to
  72678. * visible difference in column widths or distance between columns. In these
  72679. * cases, setting `crisp` to `false` may look better, even though each
  72680. * column is rendered blurry.
  72681. */
  72682. crisp?: boolean;
  72683. /**
  72684. * (Highcharts, Highstock) When the series contains less points than the
  72685. * crop threshold, all points are drawn, even if the points fall outside the
  72686. * visible plot area at the current zoom. The advantage of drawing all
  72687. * points (including markers and columns), is that animation is performed on
  72688. * updates. On the other hand, when the series contains more points than the
  72689. * crop threshold, the series data is cropped to only contain points that
  72690. * fall within the plot area. The advantage of cropping away invisible
  72691. * points is to increase performance on large series.
  72692. */
  72693. cropThreshold?: number;
  72694. /**
  72695. * (Highstock) You can set the cursor to "pointer" if you have click events
  72696. * attached to the series, to signal to the user that the points and lines
  72697. * can be clicked.
  72698. *
  72699. * In styled mode, the series cursor can be set with the same classes as
  72700. * listed under series.color.
  72701. */
  72702. cursor?: (string|CursorValue);
  72703. /**
  72704. * (Highstock) A reserved subspace to store options and values for
  72705. * customized functionality. Here you can add additional data for your own
  72706. * event callbacks and formatter callbacks.
  72707. */
  72708. custom?: Dictionary<any>;
  72709. /**
  72710. * (Highstock) Name of the dash style to use for the graph, or for some
  72711. * series types the outline of each shape.
  72712. *
  72713. * In styled mode, the stroke dash-array can be set with the same classes as
  72714. * listed under series.color.
  72715. */
  72716. dashStyle?: DashStyleValue;
  72717. /**
  72718. * (Highstock) Data grouping is the concept of sampling the data values into
  72719. * larger blocks in order to ease readability and increase performance of
  72720. * the JavaScript charts. Highstock by default applies data grouping when
  72721. * the points become closer than a certain pixel value, determined by the
  72722. * `groupPixelWidth` option.
  72723. *
  72724. * If data grouping is applied, the grouping information of grouped points
  72725. * can be read from the Point.dataGroup. If point options other than the
  72726. * data itself are set, for example `name` or `color` or custom properties,
  72727. * the grouping logic doesn't know how to group it. In this case the options
  72728. * of the first point instance are copied over to the group point. This can
  72729. * be altered through a custom `approximation` callback function.
  72730. */
  72731. dataGrouping?: DataGroupingOptionsObject;
  72732. /**
  72733. * (Highcharts, Highstock, Highmaps, Gantt) Options for the series data
  72734. * labels, appearing next to each data point.
  72735. *
  72736. * Since v6.2.0, multiple data labels can be applied to each single point by
  72737. * defining them as an array of configs.
  72738. *
  72739. * In styled mode, the data labels can be styled with the
  72740. * `.highcharts-data-label-box` and `.highcharts-data-label` class names
  72741. * (see example).
  72742. */
  72743. dataLabels?: (PlotPsarDataLabelsOptions|Array<PlotPsarDataLabelsOptions>);
  72744. /**
  72745. * (Highcharts, Highstock) Options for the series data sorting.
  72746. */
  72747. dataSorting?: (DataSortingOptionsObject|PlotPsarDataSortingOptions);
  72748. /**
  72749. * (Highstock) A description of the series to add to the screen reader
  72750. * information about the series.
  72751. */
  72752. description?: string;
  72753. /**
  72754. * (Highstock) Enable or disable the mouse tracking for a specific series.
  72755. * This includes point tooltips and click events on graphs and points. For
  72756. * large datasets it improves performance.
  72757. */
  72758. enableMouseTracking?: boolean;
  72759. /**
  72760. * (Highstock) General event handlers for the series items. These event
  72761. * hooks can also be attached to the series at run time using the
  72762. * `Highcharts.addEvent` function.
  72763. */
  72764. events?: SeriesEventsOptionsObject;
  72765. /**
  72766. * (Highstock) Determines whether the series should look for the nearest
  72767. * point in both dimensions or just the x-dimension when hovering the
  72768. * series. Defaults to `'xy'` for scatter series and `'x'` for most other
  72769. * series. If the data has duplicate x-values, it is recommended to set this
  72770. * to `'xy'` to allow hovering over all points.
  72771. *
  72772. * Applies only to series types using nearest neighbor search (not direct
  72773. * hover) for tooltip.
  72774. */
  72775. findNearestPointBy?: OptionsFindNearestPointByValue;
  72776. /**
  72777. * (Highstock) Defines when to display a gap in the graph, together with the
  72778. * gapUnit option.
  72779. *
  72780. * In case when `dataGrouping` is enabled, points can be grouped into a
  72781. * larger time span. This can make the grouped points to have a greater
  72782. * distance than the absolute value of `gapSize` property, which will result
  72783. * in disappearing graph completely. To prevent this situation the mentioned
  72784. * distance between grouped points is used instead of previously defined
  72785. * `gapSize`.
  72786. *
  72787. * In practice, this option is most often used to visualize gaps in time
  72788. * series. In a stock chart, intraday data is available for daytime hours,
  72789. * while gaps will appear in nights and weekends.
  72790. */
  72791. gapSize?: number;
  72792. /**
  72793. * (Highstock) Together with gapSize, this option defines where to draw gaps
  72794. * in the graph.
  72795. *
  72796. * When the `gapUnit` is `"relative"` (default), a gap size of 5 means that
  72797. * if the distance between two points is greater than 5 times that of the
  72798. * two closest points, the graph will be broken.
  72799. *
  72800. * When the `gapUnit` is `"value"`, the gap is based on absolute axis
  72801. * values, which on a datetime axis is milliseconds. This also applies to
  72802. * the navigator series that inherits gap options from the base series.
  72803. */
  72804. gapUnit?: OptionsGapUnitValue;
  72805. /**
  72806. * (Highcharts, Highstock, Gantt) Whether to use the Y extremes of the total
  72807. * chart width or only the zoomed area when zooming in on parts of the X
  72808. * axis. By default, the Y axis adjusts to the min and max of the visible
  72809. * data. Cartesian series only.
  72810. */
  72811. getExtremesFromAll?: boolean;
  72812. /**
  72813. * (Highstock) When set to `false` will prevent the series data from being
  72814. * included in any form of data export.
  72815. *
  72816. * Since version 6.0.0 until 7.1.0 the option was existing undocumented as
  72817. * `includeInCSVExport`.
  72818. */
  72819. includeInDataExport?: boolean;
  72820. /**
  72821. * (Highcharts, Highstock, Gantt) Series labels are placed as close to the
  72822. * series as possible in a natural way, seeking to avoid other series. The
  72823. * goal of this feature is to make the chart more easily readable, like if a
  72824. * human designer placed the labels in the optimal position.
  72825. *
  72826. * The series labels currently work with series types having a `graph` or an
  72827. * `area`.
  72828. */
  72829. label?: SeriesLabelOptionsObject;
  72830. /**
  72831. * (Highstock) The line marks the last price from all points.
  72832. */
  72833. lastPrice?: SeriesLastPriceOptionsObject;
  72834. /**
  72835. * (Highstock) The line marks the last price from visible range of points.
  72836. */
  72837. lastVisiblePrice?: SeriesLastVisiblePriceOptionsObject;
  72838. /**
  72839. * (Highcharts, Highstock) The SVG value used for the `stroke-linecap` and
  72840. * `stroke-linejoin` of a line graph. Round means that lines are rounded in
  72841. * the ends and bends.
  72842. */
  72843. linecap?: SeriesLinecapValue;
  72844. /**
  72845. * (Highcharts, Highstock) Pixel width of the graph line.
  72846. */
  72847. lineWidth?: number;
  72848. /**
  72849. * (Highcharts, Highstock, Gantt) The main series ID that indicator will be
  72850. * based on. Required for this indicator.
  72851. */
  72852. linkedTo?: string;
  72853. /**
  72854. * (Highstock) Options for the point markers of line-like series. Properties
  72855. * like `fillColor`, `lineColor` and `lineWidth` define the visual
  72856. * appearance of the markers. Other series types, like column series, don't
  72857. * have markers, but have visual options on the series level instead.
  72858. *
  72859. * In styled mode, the markers can be styled with the `.highcharts-point`,
  72860. * `.highcharts-point-hover` and `.highcharts-point-select` class names.
  72861. */
  72862. marker?: PointMarkerOptionsObject;
  72863. /**
  72864. * (Highstock) The name of the series as shown in the legend, tooltip etc.
  72865. * If not set, it will be based on a technical indicator type and default
  72866. * params.
  72867. */
  72868. name?: string;
  72869. /**
  72870. * (Highstock) The color for the parts of the graph or points that are below
  72871. * the threshold. Note that `zones` takes precedence over the negative
  72872. * color. Using `negativeColor` is equivalent to applying a zone with value
  72873. * of 0.
  72874. */
  72875. negativeColor?: (ColorString|GradientColorObject|PatternObject);
  72876. /**
  72877. * (Highstock) Opacity of a series parts: line, fill (e.g. area) and
  72878. * dataLabels.
  72879. */
  72880. opacity?: number;
  72881. /**
  72882. * (Highstock) Paramters used in calculation of regression series' points.
  72883. */
  72884. params?: PlotPsarParamsOptions;
  72885. /**
  72886. * (Highstock) Properties for each single point.
  72887. */
  72888. point?: PlotSeriesPointOptions;
  72889. /**
  72890. * (Highstock) Same as accessibility.pointDescriptionFormatter, but for an
  72891. * individual series. Overrides the chart wide configuration.
  72892. */
  72893. pointDescriptionFormatter?: Function;
  72894. /**
  72895. * (Highstock) Whether to select the series initially. If `showCheckbox` is
  72896. * true, the checkbox next to the series name in the legend will be checked
  72897. * for a selected series.
  72898. */
  72899. selected?: boolean;
  72900. /**
  72901. * (Highstock) Whether to apply a drop shadow to the graph line. Since 2.3
  72902. * the shadow can be an object configuration containing `color`, `offsetX`,
  72903. * `offsetY`, `opacity` and `width`.
  72904. */
  72905. shadow?: (boolean|ShadowOptionsObject);
  72906. /**
  72907. * (Highstock) If true, a checkbox is displayed next to the legend item to
  72908. * allow selecting the series. The state of the checkbox is determined by
  72909. * the `selected` option.
  72910. */
  72911. showCheckbox?: boolean;
  72912. /**
  72913. * (Highstock) Whether to display this particular series or series type in
  72914. * the legend. Standalone series are shown in legend by default, and linked
  72915. * series are not. Since v7.2.0 it is possible to show series that use
  72916. * colorAxis by setting this option to `true`.
  72917. */
  72918. showInLegend?: boolean;
  72919. /**
  72920. * (Highstock) If set to `true`, the accessibility module will skip past the
  72921. * points in this series for keyboard navigation.
  72922. */
  72923. skipKeyboardNavigation?: boolean;
  72924. /**
  72925. * (Highcharts, Highstock) When this is true, the series will not cause the
  72926. * Y axis to cross the zero plane (or threshold option) unless the data
  72927. * actually crosses the plane.
  72928. *
  72929. * For example, if `softThreshold` is `false`, a series of 0, 1, 2, 3 will
  72930. * make the Y axis show negative values according to the `minPadding`
  72931. * option. If `softThreshold` is `true`, the Y axis starts at 0.
  72932. */
  72933. softThreshold?: boolean;
  72934. states?: SeriesStatesOptionsObject;
  72935. /**
  72936. * (Highcharts, Highstock) Whether to apply steps to the line. Possible
  72937. * values are `left`, `center` and `right`.
  72938. */
  72939. step?: OptionsStepValue;
  72940. /**
  72941. * (Highstock) Sticky tracking of mouse events. When true, the `mouseOut`
  72942. * event on a series isn't triggered until the mouse moves over another
  72943. * series, or out of the plot area. When false, the `mouseOut` event on a
  72944. * series is triggered when the mouse leaves the area around the series'
  72945. * graph or markers. This also implies the tooltip when not shared. When
  72946. * `stickyTracking` is false and `tooltip.shared` is false, the tooltip will
  72947. * be hidden when moving the mouse between series. Defaults to true for line
  72948. * and area type series, but to false for columns, pies etc.
  72949. *
  72950. * **Note:** The boost module will force this option because of technical
  72951. * limitations.
  72952. */
  72953. stickyTracking?: boolean;
  72954. /**
  72955. * (Highcharts, Highstock) The threshold, also called zero level or base
  72956. * level. For line type series this is only used in conjunction with
  72957. * negativeColor.
  72958. */
  72959. threshold?: (number|null);
  72960. /**
  72961. * (Highstock) A configuration object for the tooltip rendering of each
  72962. * single series. Properties are inherited from tooltip, but only the
  72963. * following properties can be defined on a series level.
  72964. */
  72965. tooltip?: SeriesTooltipOptionsObject;
  72966. /**
  72967. * (Highcharts, Highstock, Gantt) When a series contains a data array that
  72968. * is longer than this, only one dimensional arrays of numbers, or two
  72969. * dimensional arrays with x and y values are allowed. Also, only the first
  72970. * point is tested, and the rest are assumed to be the same format. This
  72971. * saves expensive data checking and indexing in long series. Set it to `0`
  72972. * disable.
  72973. *
  72974. * Note: In boost mode turbo threshold is forced. Only array of numbers or
  72975. * two dimensional arrays are allowed.
  72976. */
  72977. turboThreshold?: number;
  72978. /**
  72979. * (Highstock) Set the initial visibility of the series.
  72980. */
  72981. visible?: boolean;
  72982. /**
  72983. * (Highmaps) Define the z index of the series.
  72984. */
  72985. zIndex?: number;
  72986. /**
  72987. * (Highcharts, Highstock) Defines the Axis on which the zones are applied.
  72988. */
  72989. zoneAxis?: string;
  72990. /**
  72991. * (Highcharts, Highstock) An array defining zones within a series. Zones
  72992. * can be applied to the X axis, Y axis or Z axis for bubbles, according to
  72993. * the `zoneAxis` option. The zone definitions have to be in ascending order
  72994. * regarding to the value.
  72995. *
  72996. * In styled mode, the color zones are styled with the
  72997. * `.highcharts-zone-{n}` class, or custom classed from the `className`
  72998. * option (view live demo).
  72999. */
  73000. zones?: Array<SeriesZonesOptionsObject>;
  73001. }
  73002. /**
  73003. * (Highstock) Paramters used in calculation of regression series' points.
  73004. */
  73005. export interface PlotPsarParamsOptions {
  73006. /**
  73007. * (Highstock) Number of maximum decimals that are used in PSAR
  73008. * calculations.
  73009. */
  73010. decimals?: number;
  73011. /**
  73012. * (Highstock) Acceleration factor increases by increment each time the
  73013. * extreme point makes a new high.
  73014. */
  73015. increment?: number;
  73016. /**
  73017. * (Highstock) Index from which PSAR is starting calculation
  73018. */
  73019. index?: number;
  73020. /**
  73021. * (Highstock) The initial value for acceleration factor. Acceleration
  73022. * factor is starting with this value and increases by specified increment
  73023. * each time the extreme point makes a new high. AF can reach a maximum of
  73024. * maxAccelerationFactor, no matter how long the uptrend extends.
  73025. */
  73026. initialAccelerationFactor?: number;
  73027. /**
  73028. * (Highstock) The Maximum value for acceleration factor. AF can reach a
  73029. * maximum of maxAccelerationFactor, no matter how long the uptrend extends.
  73030. */
  73031. maxAccelerationFactor?: number;
  73032. }
  73033. /**
  73034. * (Highcharts) Enable or disable the initial animation when a series is
  73035. * displayed. The animation can also be set as a configuration object. Please
  73036. * note that this option only applies to the initial animation of the series
  73037. * itself. For other animations, see chart.animation and the animation parameter
  73038. * under the API methods. The following properties are supported:
  73039. *
  73040. * - `defer`: The animation delay time in milliseconds.
  73041. *
  73042. * - `duration`: The duration of the animation in milliseconds.
  73043. *
  73044. * - `easing`: Can be a string reference to an easing function set on the `Math`
  73045. * object or a function. See the _Custom easing function_ demo below.
  73046. *
  73047. * Due to poor performance, animation is disabled in old IE browsers for several
  73048. * chart types.
  73049. */
  73050. export interface PlotPyramid3dAnimationOptions {
  73051. defer?: number;
  73052. }
  73053. /**
  73054. * (Highcharts, Highstock, Highmaps, Gantt) Enable or disable the initial
  73055. * animation when a series is displayed for the `dataLabels`. The animation can
  73056. * also be set as a configuration object. Please note that this option only
  73057. * applies to the initial animation. For other animations, see chart.animation
  73058. * and the animation parameter under the API methods. The following properties
  73059. * are supported:
  73060. *
  73061. * - `defer`: The animation delay time in milliseconds.
  73062. */
  73063. export interface PlotPyramid3dDataLabelsAnimationOptions {
  73064. /**
  73065. * (Highcharts, Highstock, Highmaps, Gantt) The animation delay time in
  73066. * milliseconds. Set to `0` renders dataLabel immediately. As `undefined`
  73067. * inherits defer time from the series.animation.defer.
  73068. */
  73069. defer?: number;
  73070. }
  73071. /**
  73072. * (Highcharts, Highstock, Highmaps, Gantt) Options for the series data labels,
  73073. * appearing next to each data point.
  73074. *
  73075. * Since v6.2.0, multiple data labels can be applied to each single point by
  73076. * defining them as an array of configs.
  73077. *
  73078. * In styled mode, the data labels can be styled with the
  73079. * `.highcharts-data-label-box` and `.highcharts-data-label` class names (see
  73080. * example).
  73081. */
  73082. export interface PlotPyramid3dDataLabelsOptions {
  73083. /**
  73084. * (Highcharts, Highstock, Highmaps, Gantt) The alignment of the data label
  73085. * compared to the point. If `right`, the right side of the label should be
  73086. * touching the point. For points with an extent, like columns, the
  73087. * alignments also dictates how to align it inside the box, as given with
  73088. * the inside option. Can be one of `left`, `center` or `right`.
  73089. */
  73090. align?: string;
  73091. /**
  73092. * (Highcharts, Highstock, Highmaps, Gantt) Whether to allow data labels to
  73093. * overlap. To make the labels less sensitive for overlapping, the
  73094. * dataLabels.padding can be set to 0.
  73095. */
  73096. allowOverlap?: boolean;
  73097. /**
  73098. * (Highcharts, Highstock, Highmaps, Gantt) Enable or disable the initial
  73099. * animation when a series is displayed for the `dataLabels`. The animation
  73100. * can also be set as a configuration object. Please note that this option
  73101. * only applies to the initial animation. For other animations, see
  73102. * chart.animation and the animation parameter under the API methods. The
  73103. * following properties are supported:
  73104. *
  73105. * - `defer`: The animation delay time in milliseconds.
  73106. */
  73107. animation?: (boolean|PlotPyramid3dDataLabelsAnimationOptions|Partial<AnimationOptionsObject>);
  73108. /**
  73109. * (Highcharts, Highstock, Highmaps, Gantt) The background color or gradient
  73110. * for the data label.
  73111. */
  73112. backgroundColor?: (ColorString|GradientColorObject|PatternObject);
  73113. /**
  73114. * (Highcharts, Highstock, Highmaps, Gantt) The border color for the data
  73115. * label. Defaults to `undefined`.
  73116. */
  73117. borderColor?: (ColorString|GradientColorObject|PatternObject);
  73118. /**
  73119. * (Highcharts, Highstock, Highmaps, Gantt) The border radius in pixels for
  73120. * the data label.
  73121. */
  73122. borderRadius?: number;
  73123. /**
  73124. * (Highcharts, Highstock, Highmaps, Gantt) The border width in pixels for
  73125. * the data label.
  73126. */
  73127. borderWidth?: number;
  73128. /**
  73129. * (Highcharts, Highstock, Highmaps, Gantt) A class name for the data label.
  73130. * Particularly in styled mode, this can be used to give each series' or
  73131. * point's data label unique styling. In addition to this option, a default
  73132. * color class name is added so that we can give the labels a contrast text
  73133. * shadow.
  73134. */
  73135. className?: string;
  73136. /**
  73137. * (Highcharts, Highstock, Highmaps, Gantt) The text color for the data
  73138. * labels. Defaults to `undefined`. For certain series types, like column or
  73139. * map, the data labels can be drawn inside the points. In this case the
  73140. * data label will be drawn with maximum contrast by default. Additionally,
  73141. * it will be given a `text-outline` style with the opposite color, to
  73142. * further increase the contrast. This can be overridden by setting the
  73143. * `text-outline` style to `none` in the `dataLabels.style` option.
  73144. */
  73145. color?: (ColorString|GradientColorObject|PatternObject);
  73146. /**
  73147. * (Highcharts, Highstock, Highmaps, Gantt) Whether to hide data labels that
  73148. * are outside the plot area. By default, the data label is moved inside the
  73149. * plot area according to the overflow option.
  73150. */
  73151. crop?: boolean;
  73152. /**
  73153. * (Highcharts, Highstock, Gantt) Whether to defer displaying the data
  73154. * labels until the initial series animation has finished. Setting to
  73155. * `false` renders the data label immediately. If set to `true` inherits the
  73156. * defer time set in plotOptions.series.animation.
  73157. */
  73158. defer?: boolean;
  73159. /**
  73160. * (Highcharts, Highstock, Highmaps, Gantt) Enable or disable the data
  73161. * labels.
  73162. */
  73163. enabled?: boolean;
  73164. /**
  73165. * (Highcharts, Highstock, Highmaps, Gantt) A declarative filter to control
  73166. * of which data labels to display. The declarative filter is designed for
  73167. * use when callback functions are not available, like when the chart
  73168. * options require a pure JSON structure or for use with graphical editors.
  73169. * For programmatic control, use the `formatter` instead, and return
  73170. * `undefined` to disable a single data label.
  73171. */
  73172. filter?: DataLabelsFilterOptionsObject;
  73173. /**
  73174. * (Highcharts, Highstock, Highmaps, Gantt) A format string for the data
  73175. * label. Available variables are the same as for `formatter`.
  73176. */
  73177. format?: string;
  73178. /**
  73179. * (Highcharts, Highstock, Highmaps, Gantt) Callback JavaScript function to
  73180. * format the data label. Note that if a `format` is defined, the format
  73181. * takes precedence and the formatter is ignored.
  73182. */
  73183. formatter?: DataLabelsFormatterCallbackFunction;
  73184. /**
  73185. * (Highcharts, Highstock, Highmaps, Gantt) For points with an extent, like
  73186. * columns or map areas, whether to align the data label inside the box or
  73187. * to the actual value point. Defaults to `false` in most cases, `true` in
  73188. * stacked columns.
  73189. */
  73190. inside?: boolean;
  73191. /**
  73192. * (Highcharts, Highstock, Highmaps, Gantt) Format for points with the value
  73193. * of null. Works analogously to format. `nullFormat` can be applied only to
  73194. * series which support displaying null points.
  73195. */
  73196. nullFormat?: (boolean|string);
  73197. /**
  73198. * (Highcharts, Highstock, Highmaps, Gantt) Callback JavaScript function
  73199. * that defines formatting for points with the value of null. Works
  73200. * analogously to formatter. `nullPointFormatter` can be applied only to
  73201. * series which support displaying null points.
  73202. */
  73203. nullFormatter?: DataLabelsFormatterCallbackFunction;
  73204. /**
  73205. * (Highcharts, Highstock, Highmaps, Gantt) How to handle data labels that
  73206. * flow outside the plot area. The default is `"justify"`, which aligns them
  73207. * inside the plot area. For columns and bars, this means it will be moved
  73208. * inside the bar. To display data labels outside the plot area, set `crop`
  73209. * to `false` and `overflow` to `"allow"`.
  73210. */
  73211. overflow?: string;
  73212. /**
  73213. * (Highcharts, Highstock, Highmaps, Gantt) When either the `borderWidth` or
  73214. * the `backgroundColor` is set, this is the padding within the box.
  73215. */
  73216. padding?: number;
  73217. /**
  73218. * (Highcharts, Highstock, Highmaps, Gantt) Aligns data labels relative to
  73219. * points. If `center` alignment is not possible, it defaults to `right`.
  73220. */
  73221. position?: AlignValue;
  73222. /**
  73223. * (Highcharts, Highstock, Highmaps, Gantt) Text rotation in degrees. Note
  73224. * that due to a more complex structure, backgrounds, borders and padding
  73225. * will be lost on a rotated data label.
  73226. */
  73227. rotation?: number;
  73228. /**
  73229. * (Highcharts, Highstock, Highmaps, Gantt) The shadow of the box. Works
  73230. * best with `borderWidth` or `backgroundColor`. Since 2.3 the shadow can be
  73231. * an object configuration containing `color`, `offsetX`, `offsetY`,
  73232. * `opacity` and `width`.
  73233. */
  73234. shadow?: (boolean|ShadowOptionsObject);
  73235. /**
  73236. * (Highcharts, Highstock, Highmaps, Gantt) The name of a symbol to use for
  73237. * the border around the label. Symbols are predefined functions on the
  73238. * Renderer object.
  73239. */
  73240. shape?: string;
  73241. /**
  73242. * (Highcharts, Highstock, Highmaps, Gantt) Styles for the label. The
  73243. * default `color` setting is `"contrast"`, which is a pseudo color that
  73244. * Highcharts picks up and applies the maximum contrast to the underlying
  73245. * point item, for example the bar in a bar chart.
  73246. *
  73247. * The `textOutline` is a pseudo property that applies an outline of the
  73248. * given width with the given color, which by default is the maximum
  73249. * contrast to the text. So a bright text color will result in a black text
  73250. * outline for maximum readability on a mixed background. In some cases,
  73251. * especially with grayscale text, the text outline doesn't work well, in
  73252. * which cases it can be disabled by setting it to `"none"`. When `useHTML`
  73253. * is true, the `textOutline` will not be picked up. In this, case, the same
  73254. * effect can be acheived through the `text-shadow` CSS property.
  73255. *
  73256. * For some series types, where each point has an extent, like for example
  73257. * tree maps, the data label may overflow the point. There are two
  73258. * strategies for handling overflow. By default, the text will wrap to
  73259. * multiple lines. The other strategy is to set `style.textOverflow` to
  73260. * `ellipsis`, which will keep the text on one line plus it will break
  73261. * inside long words.
  73262. */
  73263. style?: CSSObject;
  73264. /**
  73265. * (Highcharts, Highstock, Highmaps, Gantt) Options for a label text which
  73266. * should follow marker's shape. Border and background are disabled for a
  73267. * label that follows a path.
  73268. *
  73269. * **Note:** Only SVG-based renderer supports this option. Setting `useHTML`
  73270. * to true will disable this option.
  73271. */
  73272. textPath?: DataLabelsTextPathOptionsObject;
  73273. /**
  73274. * (Highcharts, Highstock, Highmaps, Gantt) Whether to use HTML to render
  73275. * the labels.
  73276. */
  73277. useHTML?: boolean;
  73278. /**
  73279. * (Highcharts, Highstock, Highmaps, Gantt) The vertical alignment of a data
  73280. * label. Can be one of `top`, `middle` or `bottom`. The default value
  73281. * depends on the data, for instance in a column chart, the label is above
  73282. * positive values and below negative values.
  73283. */
  73284. verticalAlign?: string;
  73285. /**
  73286. * (Highcharts, Highstock, Highmaps, Gantt) The x position offset of the
  73287. * label relative to the point in pixels.
  73288. */
  73289. x?: number;
  73290. /**
  73291. * (Highcharts, Highstock, Highmaps, Gantt) The y position offset of the
  73292. * label relative to the point in pixels.
  73293. */
  73294. y?: number;
  73295. /**
  73296. * (Highcharts, Highstock, Highmaps, Gantt) The Z index of the data labels.
  73297. * The default Z index puts it above the series. Use a Z index of 2 to
  73298. * display it behind the series.
  73299. */
  73300. z?: number;
  73301. }
  73302. /**
  73303. * (Highcharts) Style options for the guide box. The guide box has one state by
  73304. * default, the `default` state.
  73305. */
  73306. export interface PlotPyramid3dDragDropGuideBoxOptions {
  73307. /**
  73308. * (Highcharts) Style options for the guide box default state.
  73309. */
  73310. default?: DragDropGuideBoxOptionsObject;
  73311. }
  73312. /**
  73313. * (Highcharts) A pyramid3d is a 3d version of pyramid series type. Pyramid
  73314. * charts are a type of chart often used to visualize stages in a sales project,
  73315. * where the top are the initial stages with the most clients.
  73316. *
  73317. * In TypeScript the type option must always be set.
  73318. *
  73319. * Configuration options for the series are given in three levels:
  73320. *
  73321. * 1. Options for all series in a chart are defined in the plotOptions.series
  73322. * object.
  73323. *
  73324. * 2. Options for all `pyramid3d` series are defined in plotOptions.pyramid3d.
  73325. *
  73326. * 3. Options for one single series are given in the series instance array. (see
  73327. * online documentation for example)
  73328. */
  73329. export interface PlotPyramid3dOptions {
  73330. /**
  73331. * (Highcharts) Accessibility options for a series.
  73332. */
  73333. accessibility?: SeriesAccessibilityOptionsObject;
  73334. /**
  73335. * (Highcharts) Allow this series' points to be selected by clicking on the
  73336. * graphic (columns, point markers, pie slices, map areas etc).
  73337. *
  73338. * The selected points can be handled by point select and unselect events,
  73339. * or collectively by the getSelectedPoints function.
  73340. *
  73341. * And alternative way of selecting points is through dragging.
  73342. */
  73343. allowPointSelect?: boolean;
  73344. /**
  73345. * (Highcharts) Enable or disable the initial animation when a series is
  73346. * displayed. The animation can also be set as a configuration object.
  73347. * Please note that this option only applies to the initial animation of the
  73348. * series itself. For other animations, see chart.animation and the
  73349. * animation parameter under the API methods. The following properties are
  73350. * supported:
  73351. *
  73352. * - `defer`: The animation delay time in milliseconds.
  73353. *
  73354. * - `duration`: The duration of the animation in milliseconds.
  73355. *
  73356. * - `easing`: Can be a string reference to an easing function set on the
  73357. * `Math` object or a function. See the _Custom easing function_ demo below.
  73358. *
  73359. * Due to poor performance, animation is disabled in old IE browsers for
  73360. * several chart types.
  73361. */
  73362. animation?: (boolean|PlotPyramid3dAnimationOptions);
  73363. /**
  73364. * (Highcharts) For some series, there is a limit that shuts down initial
  73365. * animation by default when the total number of points in the chart is too
  73366. * high. For example, for a column chart and its derivatives, animation does
  73367. * not run if there is more than 250 points totally. To disable this cap,
  73368. * set `animationLimit` to `Infinity`.
  73369. */
  73370. animationLimit?: number;
  73371. /**
  73372. * (Highcharts, Highstock, Gantt) The color of the border surrounding each
  73373. * column or bar.
  73374. *
  73375. * In styled mode, the border stroke can be set with the `.highcharts-point`
  73376. * rule.
  73377. */
  73378. borderColor?: (ColorString|GradientColorObject|PatternObject);
  73379. /**
  73380. * (Highcharts, Highstock, Gantt) The corner radius of the border
  73381. * surrounding each column or bar.
  73382. */
  73383. borderRadius?: number;
  73384. /**
  73385. * (Highcharts, Highstock, Gantt) The width of the border surrounding each
  73386. * column or bar. Defaults to `1` when there is room for a border, but to
  73387. * `0` when the columns are so dense that a border would cover the next
  73388. * column.
  73389. *
  73390. * In styled mode, the stroke width can be set with the `.highcharts-point`
  73391. * rule.
  73392. */
  73393. borderWidth?: number;
  73394. /**
  73395. * (Highcharts, Highstock, Gantt) When `true`, the columns will center in
  73396. * the category, ignoring null or missing points. When `false`, space will
  73397. * be reserved for null or missing points.
  73398. */
  73399. centerInCategory?: boolean;
  73400. /**
  73401. * (Highcharts) An additional class name to apply to the series' graphical
  73402. * elements. This option does not replace default class names of the
  73403. * graphical element.
  73404. */
  73405. className?: string;
  73406. /**
  73407. * (Highcharts) Disable this option to allow series rendering in the whole
  73408. * plotting area.
  73409. *
  73410. * **Note:** Clipping should be always enabled when chart.zoomType is set
  73411. */
  73412. clip?: boolean;
  73413. /**
  73414. * (Highcharts) The main color of the series. In line type series it applies
  73415. * to the line and the point markers unless otherwise specified. In bar type
  73416. * series it applies to the bars unless a color is specified per point. The
  73417. * default value is pulled from the `options.colors` array.
  73418. *
  73419. * In styled mode, the color can be defined by the colorIndex option. Also,
  73420. * the series color can be set with the `.highcharts-series`,
  73421. * `.highcharts-color-{n}`, `.highcharts-{type}-series` or
  73422. * `.highcharts-series-{n}` class, or individual classes given by the
  73423. * `className` option.
  73424. */
  73425. color?: (ColorString|GradientColorObject|PatternObject);
  73426. /**
  73427. * (Highcharts, Highstock, Gantt) When using automatic point colors pulled
  73428. * from the global colors or series-specific plotOptions.column.colors
  73429. * collections, this option determines whether the chart should receive one
  73430. * color per series or one color per point.
  73431. *
  73432. * In styled mode, the `colors` or `series.colors` arrays are not supported,
  73433. * and instead this option gives the points individual color class names on
  73434. * the form `highcharts-color-{n}`.
  73435. */
  73436. colorByPoint?: boolean;
  73437. /**
  73438. * (Highcharts) Styled mode only. A specific color index to use for the
  73439. * series, so its graphic representations are given the class name
  73440. * `highcharts-color-{n}`.
  73441. */
  73442. colorIndex?: number;
  73443. /**
  73444. * (Highcharts, Highstock, Highmaps) Determines what data value should be
  73445. * used to calculate point color if `colorAxis` is used. Requires to set
  73446. * `min` and `max` if some custom point property is used or if approximation
  73447. * for data grouping is set to `'sum'`.
  73448. */
  73449. colorKey?: string;
  73450. /**
  73451. * (Highcharts, Highstock, Gantt) A series specific or series type specific
  73452. * color set to apply instead of the global colors when colorByPoint is
  73453. * true.
  73454. */
  73455. colors?: Array<(ColorString|GradientColorObject|PatternObject)>;
  73456. /**
  73457. * (Highstock) Defines if comparison should start from the first point
  73458. * within the visible range or should start from the first point **before**
  73459. * the range.
  73460. *
  73461. * In other words, this flag determines if first point within the visible
  73462. * range will have 0% (`compareStart=true`) or should have been already
  73463. * calculated according to the previous point (`compareStart=false`).
  73464. */
  73465. compareStart?: boolean;
  73466. /**
  73467. * (Gantt) Override Pathfinder connector options for a series. Requires
  73468. * Highcharts Gantt to be loaded.
  73469. */
  73470. connectors?: SeriesConnectorsOptionsObject;
  73471. /**
  73472. * (Highcharts, Highstock, Gantt) When true, each point or column edge is
  73473. * rounded to its nearest pixel in order to render sharp on screen. In some
  73474. * cases, when there are a lot of densely packed columns, this leads to
  73475. * visible difference in column widths or distance between columns. In these
  73476. * cases, setting `crisp` to `false` may look better, even though each
  73477. * column is rendered blurry.
  73478. */
  73479. crisp?: boolean;
  73480. /**
  73481. * (Highcharts, Highstock, Gantt) When the series contains less points than
  73482. * the crop threshold, all points are drawn, event if the points fall
  73483. * outside the visible plot area at the current zoom. The advantage of
  73484. * drawing all points (including markers and columns), is that animation is
  73485. * performed on updates. On the other hand, when the series contains more
  73486. * points than the crop threshold, the series data is cropped to only
  73487. * contain points that fall within the plot area. The advantage of cropping
  73488. * away invisible points is to increase performance on large series.
  73489. */
  73490. cropThreshold?: number;
  73491. /**
  73492. * (Highcharts) You can set the cursor to "pointer" if you have click events
  73493. * attached to the series, to signal to the user that the points and lines
  73494. * can be clicked.
  73495. *
  73496. * In styled mode, the series cursor can be set with the same classes as
  73497. * listed under series.color.
  73498. */
  73499. cursor?: (string|CursorValue);
  73500. /**
  73501. * (Highcharts) A reserved subspace to store options and values for
  73502. * customized functionality. Here you can add additional data for your own
  73503. * event callbacks and formatter callbacks.
  73504. */
  73505. custom?: Dictionary<any>;
  73506. /**
  73507. * (Highcharts) Name of the dash style to use for the graph, or for some
  73508. * series types the outline of each shape.
  73509. *
  73510. * In styled mode, the stroke dash-array can be set with the same classes as
  73511. * listed under series.color.
  73512. */
  73513. dashStyle?: DashStyleValue;
  73514. /**
  73515. * (Highstock) Data grouping is the concept of sampling the data values into
  73516. * larger blocks in order to ease readability and increase performance of
  73517. * the JavaScript charts. Highstock by default applies data grouping when
  73518. * the points become closer than a certain pixel value, determined by the
  73519. * `groupPixelWidth` option.
  73520. *
  73521. * If data grouping is applied, the grouping information of grouped points
  73522. * can be read from the Point.dataGroup. If point options other than the
  73523. * data itself are set, for example `name` or `color` or custom properties,
  73524. * the grouping logic doesn't know how to group it. In this case the options
  73525. * of the first point instance are copied over to the group point. This can
  73526. * be altered through a custom `approximation` callback function.
  73527. */
  73528. dataGrouping?: DataGroupingOptionsObject;
  73529. /**
  73530. * (Highcharts, Highstock, Highmaps, Gantt) Options for the series data
  73531. * labels, appearing next to each data point.
  73532. *
  73533. * Since v6.2.0, multiple data labels can be applied to each single point by
  73534. * defining them as an array of configs.
  73535. *
  73536. * In styled mode, the data labels can be styled with the
  73537. * `.highcharts-data-label-box` and `.highcharts-data-label` class names
  73538. * (see example).
  73539. */
  73540. dataLabels?: (PlotPyramid3dDataLabelsOptions|Array<PlotPyramid3dDataLabelsOptions>);
  73541. /**
  73542. * (Highcharts) Depth of the columns in a 3D column chart.
  73543. */
  73544. depth?: number;
  73545. /**
  73546. * (Highcharts) A description of the series to add to the screen reader
  73547. * information about the series.
  73548. */
  73549. description?: string;
  73550. /**
  73551. * (Highcharts) The draggable-points module allows points to be moved around
  73552. * or modified in the chart. In addition to the options mentioned under the
  73553. * `dragDrop` API structure, the module fires three events, point.dragStart,
  73554. * point.drag and point.drop.
  73555. */
  73556. dragDrop?: SeriesDragDropOptionsObject;
  73557. /**
  73558. * (Highcharts) 3D columns only. The color of the edges. Similar to
  73559. * `borderColor`, except it defaults to the same color as the column.
  73560. */
  73561. edgeColor?: ColorString;
  73562. /**
  73563. * (Highcharts) 3D columns only. The width of the colored edges.
  73564. */
  73565. edgeWidth?: number;
  73566. /**
  73567. * (Highcharts) Enable or disable the mouse tracking for a specific series.
  73568. * This includes point tooltips and click events on graphs and points. For
  73569. * large datasets it improves performance.
  73570. */
  73571. enableMouseTracking?: boolean;
  73572. /**
  73573. * (Highcharts) General event handlers for the series items. These event
  73574. * hooks can also be attached to the series at run time using the
  73575. * `Highcharts.addEvent` function.
  73576. */
  73577. events?: SeriesEventsOptionsObject;
  73578. /**
  73579. * (Highcharts) Determines whether the series should look for the nearest
  73580. * point in both dimensions or just the x-dimension when hovering the
  73581. * series. Defaults to `'xy'` for scatter series and `'x'` for most other
  73582. * series. If the data has duplicate x-values, it is recommended to set this
  73583. * to `'xy'` to allow hovering over all points.
  73584. *
  73585. * Applies only to series types using nearest neighbor search (not direct
  73586. * hover) for tooltip.
  73587. */
  73588. findNearestPointBy?: OptionsFindNearestPointByValue;
  73589. /**
  73590. * (Highcharts, Highstock, Gantt) Whether to use the Y extremes of the total
  73591. * chart width or only the zoomed area when zooming in on parts of the X
  73592. * axis. By default, the Y axis adjusts to the min and max of the visible
  73593. * data. Cartesian series only.
  73594. */
  73595. getExtremesFromAll?: boolean;
  73596. /**
  73597. * (Highcharts) By deafult sides fill is set to a gradient through this
  73598. * option being set to `true`. Set to `false` to get solid color for the
  73599. * sides.
  73600. */
  73601. gradientForSides?: boolean;
  73602. /**
  73603. * (Highcharts, Highstock, Gantt) Whether to group non-stacked columns or to
  73604. * let them render independent of each other. Non-grouped columns will be
  73605. * laid out individually and overlap each other.
  73606. */
  73607. grouping?: boolean;
  73608. /**
  73609. * (Highcharts, Highstock, Gantt) Padding between each value groups, in x
  73610. * axis units.
  73611. */
  73612. groupPadding?: number;
  73613. /**
  73614. * (Highcharts) The spacing between columns on the Z Axis in a 3D chart.
  73615. */
  73616. groupZPadding?: number;
  73617. /**
  73618. * (Highcharts) The height of the series. If it is a number it defines the
  73619. * pixel height, if it is a percentage string it is the percentage of the
  73620. * plot area height.
  73621. */
  73622. height?: (number|string);
  73623. /**
  73624. * (Highcharts) When set to `false` will prevent the series data from being
  73625. * included in any form of data export.
  73626. *
  73627. * Since version 6.0.0 until 7.1.0 the option was existing undocumented as
  73628. * `includeInCSVExport`.
  73629. */
  73630. includeInDataExport?: boolean;
  73631. /**
  73632. * (Highmaps) What property to join the `mapData` to the value data. For
  73633. * example, if joinBy is "code", the mapData items with a specific code is
  73634. * merged into the data with the same code. For maps loaded from GeoJSON,
  73635. * the keys may be held in each point's `properties` object.
  73636. *
  73637. * The joinBy option can also be an array of two values, where the first
  73638. * points to a key in the `mapData`, and the second points to another key in
  73639. * the `data`.
  73640. *
  73641. * When joinBy is `null`, the map items are joined by their position in the
  73642. * array, which performs much better in maps with many data points. This is
  73643. * the recommended option if you are printing more than a thousand data
  73644. * points and have a backend that can preprocess the data into a parallel
  73645. * array of the mapData.
  73646. */
  73647. joinBy?: (string|Array<string>);
  73648. /**
  73649. * (Highcharts) An array specifying which option maps to which key in the
  73650. * data point array. This makes it convenient to work with unstructured data
  73651. * arrays from different sources.
  73652. */
  73653. keys?: Array<string>;
  73654. /**
  73655. * (Highcharts, Highstock, Gantt) Series labels are placed as close to the
  73656. * series as possible in a natural way, seeking to avoid other series. The
  73657. * goal of this feature is to make the chart more easily readable, like if a
  73658. * human designer placed the labels in the optimal position.
  73659. *
  73660. * The series labels currently work with series types having a `graph` or an
  73661. * `area`.
  73662. */
  73663. label?: SeriesLabelOptionsObject;
  73664. /**
  73665. * (Highstock) The line marks the last price from all points.
  73666. */
  73667. lastPrice?: SeriesLastPriceOptionsObject;
  73668. /**
  73669. * (Highstock) The line marks the last price from visible range of points.
  73670. */
  73671. lastVisiblePrice?: SeriesLastVisiblePriceOptionsObject;
  73672. /**
  73673. * (Highcharts, Highstock, Gantt) The id of another series to link to.
  73674. * Additionally, the value can be ":previous" to link to the previous
  73675. * series. When two series are linked, only the first one appears in the
  73676. * legend. Toggling the visibility of this also toggles the linked series.
  73677. *
  73678. * If master series uses data sorting and linked series does not have its
  73679. * own sorting definition, the linked series will be sorted in the same
  73680. * order as the master one.
  73681. */
  73682. linkedTo?: string;
  73683. /**
  73684. * (Highcharts, Highstock, Gantt) The maximum allowed pixel width for a
  73685. * column, translated to the height of a bar in a bar chart. This prevents
  73686. * the columns from becoming too wide when there is a small number of points
  73687. * in the chart.
  73688. */
  73689. maxPointWidth?: number;
  73690. /**
  73691. * (Highcharts, Highstock, Gantt) The minimal height for a column or width
  73692. * for a bar. By default, 0 values are not shown. To visualize a 0 (or close
  73693. * to zero) point, set the minimal point length to a pixel value like 3\. In
  73694. * stacked column charts, minPointLength might not be respected for tightly
  73695. * packed values.
  73696. */
  73697. minPointLength?: number;
  73698. /**
  73699. * (Highstock) Options for the corresponding navigator series if
  73700. * `showInNavigator` is `true` for this series. Available options are the
  73701. * same as any series, documented at plotOptions and series.
  73702. *
  73703. * These options are merged with options in navigator.series, and will take
  73704. * precedence if the same option is defined both places.
  73705. */
  73706. navigatorOptions?: PlotSeriesOptions;
  73707. neckHeight?: number;
  73708. neckWidth?: number;
  73709. /**
  73710. * (Highcharts) The color for the parts of the graph or points that are
  73711. * below the threshold. Note that `zones` takes precedence over the negative
  73712. * color. Using `negativeColor` is equivalent to applying a zone with value
  73713. * of 0.
  73714. */
  73715. negativeColor?: (ColorString|GradientColorObject|PatternObject);
  73716. /**
  73717. * (Highcharts) Opacity of a series parts: line, fill (e.g. area) and
  73718. * dataLabels.
  73719. */
  73720. opacity?: number;
  73721. /**
  73722. * (Highcharts) Properties for each single point.
  73723. */
  73724. point?: PlotSeriesPointOptions;
  73725. /**
  73726. * (Highcharts) Same as accessibility.pointDescriptionFormatter, but for an
  73727. * individual series. Overrides the chart wide configuration.
  73728. */
  73729. pointDescriptionFormatter?: Function;
  73730. /**
  73731. * (Highcharts, Highstock, Gantt) If no x values are given for the points in
  73732. * a series, `pointInterval` defines the interval of the x values. For
  73733. * example, if a series contains one value every decade starting from year
  73734. * 0, set `pointInterval` to `10`. In true `datetime` axes, the
  73735. * `pointInterval` is set in milliseconds.
  73736. *
  73737. * It can be also be combined with `pointIntervalUnit` to draw irregular
  73738. * time intervals.
  73739. *
  73740. * Please note that this options applies to the _series data_, not the
  73741. * interval of the axis ticks, which is independent.
  73742. */
  73743. pointInterval?: number;
  73744. /**
  73745. * (Highcharts, Highstock, Gantt) On datetime series, this allows for
  73746. * setting the pointInterval to irregular time units, `day`, `month` and
  73747. * `year`. A day is usually the same as 24 hours, but `pointIntervalUnit`
  73748. * also takes the DST crossover into consideration when dealing with local
  73749. * time. Combine this option with `pointInterval` to draw weeks, quarters, 6
  73750. * months, 10 years etc.
  73751. *
  73752. * Please note that this options applies to the _series data_, not the
  73753. * interval of the axis ticks, which is independent.
  73754. */
  73755. pointIntervalUnit?: OptionsPointIntervalUnitValue;
  73756. /**
  73757. * (Highcharts, Highstock, Gantt) Padding between each column or bar, in x
  73758. * axis units.
  73759. */
  73760. pointPadding?: number;
  73761. /**
  73762. * (Highcharts, Highstock, Gantt) Possible values: `"on"`, `"between"`,
  73763. * `number`.
  73764. *
  73765. * In a column chart, when pointPlacement is `"on"`, the point will not
  73766. * create any padding of the X axis. In a polar column chart this means that
  73767. * the first column points directly north. If the pointPlacement is
  73768. * `"between"`, the columns will be laid out between ticks. This is useful
  73769. * for example for visualising an amount between two points in time or in a
  73770. * certain sector of a polar chart.
  73771. *
  73772. * Since Highcharts 3.0.2, the point placement can also be numeric, where 0
  73773. * is on the axis value, -0.5 is between this value and the previous, and
  73774. * 0.5 is between this value and the next. Unlike the textual options,
  73775. * numeric point placement options won't affect axis padding.
  73776. *
  73777. * Note that pointPlacement needs a pointRange to work. For column series
  73778. * this is computed, but for line-type series it needs to be set.
  73779. *
  73780. * For the `xrange` series type and gantt charts, if the Y axis is a
  73781. * category axis, the `pointPlacement` applies to the Y axis rather than the
  73782. * (typically datetime) X axis.
  73783. *
  73784. * Defaults to `undefined` in cartesian charts, `"between"` in polar charts.
  73785. */
  73786. pointPlacement?: (number|string);
  73787. /**
  73788. * (Highcharts, Highstock, Gantt) The X axis range that each point is valid
  73789. * for. This determines the width of the column. On a categorized axis, the
  73790. * range will be 1 by default (one category unit). On linear and datetime
  73791. * axes, the range will be computed as the distance between the two closest
  73792. * data points.
  73793. *
  73794. * The default `null` means it is computed automatically, but this option
  73795. * can be used to override the automatic value.
  73796. *
  73797. * This option is set by default to 1 if data sorting is enabled.
  73798. */
  73799. pointRange?: (number|null);
  73800. /**
  73801. * (Highcharts, Highstock, Gantt) If no x values are given for the points in
  73802. * a series, pointStart defines on what value to start. For example, if a
  73803. * series contains one yearly value starting from 1945, set pointStart to
  73804. * 1945.
  73805. */
  73806. pointStart?: number;
  73807. /**
  73808. * (Highcharts, Highstock, Gantt) A pixel value specifying a fixed width for
  73809. * each column or bar point. When set to `undefined`, the width is
  73810. * calculated from the `pointPadding` and `groupPadding`. The width effects
  73811. * the dimension that is not based on the point value. For column series it
  73812. * is the hoizontal length and for bar series it is the vertical length.
  73813. */
  73814. pointWidth?: number;
  73815. /**
  73816. * (Highcharts) A reversed pyramid3d is funnel3d, but the latter supports
  73817. * neck related options: neckHeight and neckWidth
  73818. */
  73819. reversed?: boolean;
  73820. /**
  73821. * (Highcharts) Whether to select the series initially. If `showCheckbox` is
  73822. * true, the checkbox next to the series name in the legend will be checked
  73823. * for a selected series.
  73824. */
  73825. selected?: boolean;
  73826. /**
  73827. * (Highcharts) Whether to apply a drop shadow to the graph line. Since 2.3
  73828. * the shadow can be an object configuration containing `color`, `offsetX`,
  73829. * `offsetY`, `opacity` and `width`.
  73830. */
  73831. shadow?: (boolean|ShadowOptionsObject);
  73832. /**
  73833. * (Highcharts) If true, a checkbox is displayed next to the legend item to
  73834. * allow selecting the series. The state of the checkbox is determined by
  73835. * the `selected` option.
  73836. */
  73837. showCheckbox?: boolean;
  73838. /**
  73839. * (Highcharts) Whether to display this particular series or series type in
  73840. * the legend. Standalone series are shown in legend by default, and linked
  73841. * series are not. Since v7.2.0 it is possible to show series that use
  73842. * colorAxis by setting this option to `true`.
  73843. */
  73844. showInLegend?: boolean;
  73845. /**
  73846. * (Highstock) Whether or not to show the series in the navigator. Takes
  73847. * precedence over navigator.baseSeries if defined.
  73848. */
  73849. showInNavigator?: boolean;
  73850. /**
  73851. * (Highcharts) If set to `true`, the accessibility module will skip past
  73852. * the points in this series for keyboard navigation.
  73853. */
  73854. skipKeyboardNavigation?: boolean;
  73855. /**
  73856. * (Highcharts, Highstock) When this is true, the series will not cause the
  73857. * Y axis to cross the zero plane (or threshold option) unless the data
  73858. * actually crosses the plane.
  73859. *
  73860. * For example, if `softThreshold` is `false`, a series of 0, 1, 2, 3 will
  73861. * make the Y axis show negative values according to the `minPadding`
  73862. * option. If `softThreshold` is `true`, the Y axis starts at 0.
  73863. */
  73864. softThreshold?: boolean;
  73865. /**
  73866. * (Highcharts, Highstock) Whether to stack the values of each series on top
  73867. * of each other. Possible values are `undefined` to disable, `"normal"` to
  73868. * stack by value or `"percent"`.
  73869. *
  73870. * When stacking is enabled, data must be sorted in ascending X order.
  73871. *
  73872. * Some stacking options are related to specific series types. In the
  73873. * streamgraph series type, the stacking option is set to `"stream"`. The
  73874. * second one is `"overlap"`, which only applies to waterfall series.
  73875. */
  73876. stacking?: OptionsStackingValue;
  73877. states?: SeriesStatesOptionsObject;
  73878. /**
  73879. * (Highcharts) Sticky tracking of mouse events. When true, the `mouseOut`
  73880. * event on a series isn't triggered until the mouse moves over another
  73881. * series, or out of the plot area. When false, the `mouseOut` event on a
  73882. * series is triggered when the mouse leaves the area around the series'
  73883. * graph or markers. This also implies the tooltip when not shared. When
  73884. * `stickyTracking` is false and `tooltip.shared` is false, the tooltip will
  73885. * be hidden when moving the mouse between series. Defaults to true for line
  73886. * and area type series, but to false for columns, pies etc.
  73887. *
  73888. * **Note:** The boost module will force this option because of technical
  73889. * limitations.
  73890. */
  73891. stickyTracking?: boolean;
  73892. /**
  73893. * (Highcharts) The Y axis value to serve as the base for the columns, for
  73894. * distinguishing between values above and below a threshold. If `null`, the
  73895. * columns extend from the padding Y axis minimum.
  73896. */
  73897. threshold?: (number|null);
  73898. /**
  73899. * (Highcharts) A configuration object for the tooltip rendering of each
  73900. * single series. Properties are inherited from tooltip, but only the
  73901. * following properties can be defined on a series level.
  73902. */
  73903. tooltip?: SeriesTooltipOptionsObject;
  73904. /**
  73905. * (Highcharts, Highstock, Gantt) When a series contains a data array that
  73906. * is longer than this, only one dimensional arrays of numbers, or two
  73907. * dimensional arrays with x and y values are allowed. Also, only the first
  73908. * point is tested, and the rest are assumed to be the same format. This
  73909. * saves expensive data checking and indexing in long series. Set it to `0`
  73910. * disable.
  73911. *
  73912. * Note: In boost mode turbo threshold is forced. Only array of numbers or
  73913. * two dimensional arrays are allowed.
  73914. */
  73915. turboThreshold?: number;
  73916. /**
  73917. * (Highcharts) Set the initial visibility of the series.
  73918. */
  73919. visible?: boolean;
  73920. /**
  73921. * (Highcharts) The max width of the series compared to the width of the
  73922. * plot area, or the pixel width if it is a number.
  73923. */
  73924. width?: (number|string);
  73925. /**
  73926. * (Highmaps) Define the z index of the series.
  73927. */
  73928. zIndex?: number;
  73929. /**
  73930. * (Highcharts, Highstock) Defines the Axis on which the zones are applied.
  73931. */
  73932. zoneAxis?: string;
  73933. /**
  73934. * (Highcharts, Highstock) An array defining zones within a series. Zones
  73935. * can be applied to the X axis, Y axis or Z axis for bubbles, according to
  73936. * the `zoneAxis` option. The zone definitions have to be in ascending order
  73937. * regarding to the value.
  73938. *
  73939. * In styled mode, the color zones are styled with the
  73940. * `.highcharts-zone-{n}` class, or custom classed from the `className`
  73941. * option (view live demo).
  73942. */
  73943. zones?: Array<SeriesZonesOptionsObject>;
  73944. }
  73945. /**
  73946. * (Highcharts) Initial animation is by default disabled for the funnel chart.
  73947. */
  73948. export interface PlotPyramidAnimationOptions {
  73949. defer?: number;
  73950. }
  73951. /**
  73952. * (Highcharts, Highstock, Highmaps, Gantt) Enable or disable the initial
  73953. * animation when a series is displayed for the `dataLabels`. The animation can
  73954. * also be set as a configuration object. Please note that this option only
  73955. * applies to the initial animation. For other animations, see chart.animation
  73956. * and the animation parameter under the API methods. The following properties
  73957. * are supported:
  73958. *
  73959. * - `defer`: The animation delay time in milliseconds.
  73960. */
  73961. export interface PlotPyramidDataLabelsAnimationOptions {
  73962. /**
  73963. * (Highcharts, Highstock, Highmaps, Gantt) The animation delay time in
  73964. * milliseconds. Set to `0` renders dataLabel immediately. As `undefined`
  73965. * inherits defer time from the series.animation.defer.
  73966. */
  73967. defer?: number;
  73968. }
  73969. /**
  73970. * (Highcharts) A pyramid series is a special type of funnel, without neck and
  73971. * reversed by default.
  73972. *
  73973. * In TypeScript the type option must always be set.
  73974. *
  73975. * Configuration options for the series are given in three levels:
  73976. *
  73977. * 1. Options for all series in a chart are defined in the plotOptions.series
  73978. * object.
  73979. *
  73980. * 2. Options for all `pyramid` series are defined in plotOptions.pyramid.
  73981. *
  73982. * 3. Options for one single series are given in the series instance array. (see
  73983. * online documentation for example)
  73984. */
  73985. export interface PlotPyramidOptions {
  73986. /**
  73987. * (Highcharts) Accessibility options for a series.
  73988. */
  73989. accessibility?: SeriesAccessibilityOptionsObject;
  73990. /**
  73991. * (Highmaps) Whether all areas of the map defined in `mapData` should be
  73992. * rendered. If `true`, areas which don't correspond to a data point, are
  73993. * rendered as `null` points. If `false`, those areas are skipped.
  73994. */
  73995. allAreas?: boolean;
  73996. /**
  73997. * (Highcharts) Allow this series' points to be selected by clicking on the
  73998. * graphic (columns, point markers, pie slices, map areas etc).
  73999. *
  74000. * The selected points can be handled by point select and unselect events,
  74001. * or collectively by the getSelectedPoints function.
  74002. *
  74003. * And alternative way of selecting points is through dragging.
  74004. */
  74005. allowPointSelect?: boolean;
  74006. /**
  74007. * (Highcharts) Initial animation is by default disabled for the funnel
  74008. * chart.
  74009. */
  74010. animation?: (boolean|PlotPyramidAnimationOptions);
  74011. /**
  74012. * (Highcharts) The color of the border surrounding each slice. When `null`,
  74013. * the border takes the same color as the slice fill. This can be used
  74014. * together with a `borderWidth` to fill drawing gaps created by
  74015. * antialiazing artefacts in borderless pies.
  74016. *
  74017. * In styled mode, the border stroke is given in the `.highcharts-point`
  74018. * class.
  74019. */
  74020. borderColor?: (ColorString|GradientColorObject|PatternObject);
  74021. /**
  74022. * (Highcharts) The width of the border surrounding each slice.
  74023. *
  74024. * When setting the border width to 0, there may be small gaps between the
  74025. * slices due to SVG antialiasing artefacts. To work around this, keep the
  74026. * border width at 0.5 or 1, but set the `borderColor` to `null` instead.
  74027. *
  74028. * In styled mode, the border stroke width is given in the
  74029. * `.highcharts-point` class.
  74030. */
  74031. borderWidth?: number;
  74032. /**
  74033. * (Highcharts) The center of the series. By default, it is centered in the
  74034. * middle of the plot area, so it fills the plot area height.
  74035. */
  74036. center?: Array<(number|string)>;
  74037. /**
  74038. * (Highcharts) An additional class name to apply to the series' graphical
  74039. * elements. This option does not replace default class names of the
  74040. * graphical element.
  74041. */
  74042. className?: string;
  74043. /**
  74044. * (Highcharts) Disable this option to allow series rendering in the whole
  74045. * plotting area.
  74046. *
  74047. * **Note:** Clipping should be always enabled when chart.zoomType is set
  74048. */
  74049. clip?: boolean;
  74050. /**
  74051. * (Highcharts) The color of the pie series. A pie series is represented as
  74052. * an empty circle if the total sum of its values is 0. Use this property to
  74053. * define the color of its border.
  74054. *
  74055. * In styled mode, the color can be defined by the colorIndex option. Also,
  74056. * the series color can be set with the `.highcharts-series`,
  74057. * `.highcharts-color-{n}`, `.highcharts-{type}-series` or
  74058. * `.highcharts-series-{n}` class, or individual classes given by the
  74059. * `className` option.
  74060. */
  74061. color?: (ColorString|GradientColorObject|PatternObject);
  74062. /**
  74063. * (Highcharts, Highstock, Highmaps) When using dual or multiple color axes,
  74064. * this number defines which colorAxis the particular series is connected
  74065. * to. It refers to either the axis id or the index of the axis in the
  74066. * colorAxis array, with 0 being the first. Set this option to false to
  74067. * prevent a series from connecting to the default color axis.
  74068. *
  74069. * Since v7.2.0 the option can also be an axis id or an axis index instead
  74070. * of a boolean flag.
  74071. */
  74072. colorAxis?: (boolean|number|string);
  74073. /**
  74074. * (Highcharts) Styled mode only. A specific color index to use for the
  74075. * series, so its graphic representations are given the class name
  74076. * `highcharts-color-{n}`.
  74077. */
  74078. colorIndex?: number;
  74079. /**
  74080. * (Highcharts, Highstock, Highmaps) Determines what data value should be
  74081. * used to calculate point color if `colorAxis` is used. Requires to set
  74082. * `min` and `max` if some custom point property is used or if approximation
  74083. * for data grouping is set to `'sum'`.
  74084. */
  74085. colorKey?: string;
  74086. /**
  74087. * (Highcharts) A series specific or series type specific color set to use
  74088. * instead of the global colors.
  74089. */
  74090. colors?: Array<(ColorString|GradientColorObject|PatternObject)>;
  74091. /**
  74092. * (Highstock) Compare the values of the series against the first non-null,
  74093. * non- zero value in the visible range. The y axis will show percentage or
  74094. * absolute change depending on whether `compare` is set to `"percent"` or
  74095. * `"value"`. When this is applied to multiple series, it allows comparing
  74096. * the development of the series against each other. Adds a `change` field
  74097. * to every point object.
  74098. */
  74099. compare?: string;
  74100. /**
  74101. * (Highstock) When compare is `percent`, this option dictates whether to
  74102. * use 0 or 100 as the base of comparison.
  74103. */
  74104. compareBase?: (0|100);
  74105. /**
  74106. * (Highstock) Defines if comparison should start from the first point
  74107. * within the visible range or should start from the first point **before**
  74108. * the range.
  74109. *
  74110. * In other words, this flag determines if first point within the visible
  74111. * range will have 0% (`compareStart=true`) or should have been already
  74112. * calculated according to the previous point (`compareStart=false`).
  74113. */
  74114. compareStart?: boolean;
  74115. /**
  74116. * (Gantt) Override Pathfinder connector options for a series. Requires
  74117. * Highcharts Gantt to be loaded.
  74118. */
  74119. connectors?: SeriesConnectorsOptionsObject;
  74120. /**
  74121. * (Highcharts, Highstock, Gantt) When true, each point or column edge is
  74122. * rounded to its nearest pixel in order to render sharp on screen. In some
  74123. * cases, when there are a lot of densely packed columns, this leads to
  74124. * visible difference in column widths or distance between columns. In these
  74125. * cases, setting `crisp` to `false` may look better, even though each
  74126. * column is rendered blurry.
  74127. */
  74128. crisp?: boolean;
  74129. /**
  74130. * (Highcharts) You can set the cursor to "pointer" if you have click events
  74131. * attached to the series, to signal to the user that the points and lines
  74132. * can be clicked.
  74133. *
  74134. * In styled mode, the series cursor can be set with the same classes as
  74135. * listed under series.color.
  74136. */
  74137. cursor?: (string|CursorValue);
  74138. /**
  74139. * (Highcharts) A reserved subspace to store options and values for
  74140. * customized functionality. Here you can add additional data for your own
  74141. * event callbacks and formatter callbacks.
  74142. */
  74143. custom?: Dictionary<any>;
  74144. /**
  74145. * (Highstock) Data grouping is the concept of sampling the data values into
  74146. * larger blocks in order to ease readability and increase performance of
  74147. * the JavaScript charts. Highstock by default applies data grouping when
  74148. * the points become closer than a certain pixel value, determined by the
  74149. * `groupPixelWidth` option.
  74150. *
  74151. * If data grouping is applied, the grouping information of grouped points
  74152. * can be read from the Point.dataGroup. If point options other than the
  74153. * data itself are set, for example `name` or `color` or custom properties,
  74154. * the grouping logic doesn't know how to group it. In this case the options
  74155. * of the first point instance are copied over to the group point. This can
  74156. * be altered through a custom `approximation` callback function.
  74157. */
  74158. dataGrouping?: DataGroupingOptionsObject;
  74159. /**
  74160. * (Highcharts, Highstock, Highmaps, Gantt) Options for the series data
  74161. * labels, appearing next to each data point.
  74162. *
  74163. * Since v6.2.0, multiple data labels can be applied to each single point by
  74164. * defining them as an array of configs.
  74165. *
  74166. * In styled mode, the data labels can be styled with the
  74167. * `.highcharts-data-label-box` and `.highcharts-data-label` class names
  74168. * (see example).
  74169. */
  74170. dataLabels?: (SeriesPieDataLabelsOptionsObject|Array<SeriesPieDataLabelsOptionsObject>);
  74171. /**
  74172. * (Highcharts) The thickness of a 3D pie.
  74173. */
  74174. depth?: number;
  74175. /**
  74176. * (Highcharts) A description of the series to add to the screen reader
  74177. * information about the series.
  74178. */
  74179. description?: string;
  74180. /**
  74181. * (Highcharts) Enable or disable the mouse tracking for a specific series.
  74182. * This includes point tooltips and click events on graphs and points. For
  74183. * large datasets it improves performance.
  74184. */
  74185. enableMouseTracking?: boolean;
  74186. /**
  74187. * (Highcharts) The end angle of the pie in degrees where 0 is top and 90 is
  74188. * right. Defaults to `startAngle` plus 360.
  74189. */
  74190. endAngle?: number;
  74191. /**
  74192. * (Highcharts) General event handlers for the series items. These event
  74193. * hooks can also be attached to the series at run time using the
  74194. * `Highcharts.addEvent` function.
  74195. */
  74196. events?: SeriesEventsOptionsObject;
  74197. /**
  74198. * (Highcharts) If the total sum of the pie's values is 0, the series is
  74199. * represented as an empty circle . The `fillColor` option defines the color
  74200. * of that circle. Use pie.borderWidth to set the border thickness.
  74201. */
  74202. fillColor?: (ColorString|GradientColorObject|PatternObject);
  74203. /**
  74204. * (Highstock) Defines when to display a gap in the graph, together with the
  74205. * gapUnit option.
  74206. *
  74207. * In case when `dataGrouping` is enabled, points can be grouped into a
  74208. * larger time span. This can make the grouped points to have a greater
  74209. * distance than the absolute value of `gapSize` property, which will result
  74210. * in disappearing graph completely. To prevent this situation the mentioned
  74211. * distance between grouped points is used instead of previously defined
  74212. * `gapSize`.
  74213. *
  74214. * In practice, this option is most often used to visualize gaps in time
  74215. * series. In a stock chart, intraday data is available for daytime hours,
  74216. * while gaps will appear in nights and weekends.
  74217. */
  74218. gapSize?: number;
  74219. /**
  74220. * (Highstock) Together with gapSize, this option defines where to draw gaps
  74221. * in the graph.
  74222. *
  74223. * When the `gapUnit` is `"relative"` (default), a gap size of 5 means that
  74224. * if the distance between two points is greater than 5 times that of the
  74225. * two closest points, the graph will be broken.
  74226. *
  74227. * When the `gapUnit` is `"value"`, the gap is based on absolute axis
  74228. * values, which on a datetime axis is milliseconds. This also applies to
  74229. * the navigator series that inherits gap options from the base series.
  74230. */
  74231. gapUnit?: OptionsGapUnitValue;
  74232. /**
  74233. * (Highcharts) The height of the funnel or pyramid. If it is a number it
  74234. * defines the pixel height, if it is a percentage string it is the
  74235. * percentage of the plot area height.
  74236. */
  74237. height?: (number|string);
  74238. /**
  74239. * (Highcharts) Equivalent to chart.ignoreHiddenSeries, this option tells
  74240. * whether the series shall be redrawn as if the hidden point were `null`.
  74241. *
  74242. * The default value changed from `false` to `true` with Highcharts 3.0.
  74243. */
  74244. ignoreHiddenPoint?: boolean;
  74245. /**
  74246. * (Highcharts) When set to `false` will prevent the series data from being
  74247. * included in any form of data export.
  74248. *
  74249. * Since version 6.0.0 until 7.1.0 the option was existing undocumented as
  74250. * `includeInCSVExport`.
  74251. */
  74252. includeInDataExport?: boolean;
  74253. /**
  74254. * (Highmaps) What property to join the `mapData` to the value data. For
  74255. * example, if joinBy is "code", the mapData items with a specific code is
  74256. * merged into the data with the same code. For maps loaded from GeoJSON,
  74257. * the keys may be held in each point's `properties` object.
  74258. *
  74259. * The joinBy option can also be an array of two values, where the first
  74260. * points to a key in the `mapData`, and the second points to another key in
  74261. * the `data`.
  74262. *
  74263. * When joinBy is `null`, the map items are joined by their position in the
  74264. * array, which performs much better in maps with many data points. This is
  74265. * the recommended option if you are printing more than a thousand data
  74266. * points and have a backend that can preprocess the data into a parallel
  74267. * array of the mapData.
  74268. */
  74269. joinBy?: (string|Array<string>);
  74270. /**
  74271. * (Highcharts) An array specifying which option maps to which key in the
  74272. * data point array. This makes it convenient to work with unstructured data
  74273. * arrays from different sources.
  74274. */
  74275. keys?: Array<string>;
  74276. /**
  74277. * (Highstock) The line marks the last price from all points.
  74278. */
  74279. lastPrice?: SeriesLastPriceOptionsObject;
  74280. /**
  74281. * (Highstock) The line marks the last price from visible range of points.
  74282. */
  74283. lastVisiblePrice?: SeriesLastVisiblePriceOptionsObject;
  74284. /**
  74285. * (Highcharts, Highstock) The SVG value used for the `stroke-linecap` and
  74286. * `stroke-linejoin` of a line graph. Round means that lines are rounded in
  74287. * the ends and bends.
  74288. */
  74289. linecap?: SeriesLinecapValue;
  74290. /**
  74291. * (Highcharts, Highstock, Gantt) The id of another series to link to.
  74292. * Additionally, the value can be ":previous" to link to the previous
  74293. * series. When two series are linked, only the first one appears in the
  74294. * legend. Toggling the visibility of this also toggles the linked series.
  74295. *
  74296. * If master series uses data sorting and linked series does not have its
  74297. * own sorting definition, the linked series will be sorted in the same
  74298. * order as the master one.
  74299. */
  74300. linkedTo?: string;
  74301. /**
  74302. * (Highcharts) The minimum size for a pie in response to auto margins. The
  74303. * pie will try to shrink to make room for data labels in side the plot
  74304. * area, but only to this size.
  74305. */
  74306. minSize?: (number|string);
  74307. /**
  74308. * (Highstock) Options for the corresponding navigator series if
  74309. * `showInNavigator` is `true` for this series. Available options are the
  74310. * same as any series, documented at plotOptions and series.
  74311. *
  74312. * These options are merged with options in navigator.series, and will take
  74313. * precedence if the same option is defined both places.
  74314. */
  74315. navigatorOptions?: PlotSeriesOptions;
  74316. /**
  74317. * (Highcharts) The pyramid neck width is zero by default, as opposed to the
  74318. * funnel, which shares the same layout logic.
  74319. */
  74320. neckHeight?: string;
  74321. /**
  74322. * (Highcharts) The pyramid neck width is zero by default, as opposed to the
  74323. * funnel, which shares the same layout logic.
  74324. */
  74325. neckWidth?: string;
  74326. /**
  74327. * (Highcharts) Opacity of a series parts: line, fill (e.g. area) and
  74328. * dataLabels.
  74329. */
  74330. opacity?: number;
  74331. /**
  74332. * (Highcharts) Properties for each single point.
  74333. */
  74334. point?: PlotSeriesPointOptions;
  74335. /**
  74336. * (Highcharts) Same as accessibility.pointDescriptionFormatter, but for an
  74337. * individual series. Overrides the chart wide configuration.
  74338. */
  74339. pointDescriptionFormatter?: Function;
  74340. /**
  74341. * (Highstock) The width of each point on the x axis. For example in a
  74342. * column chart with one value each day, the pointRange would be 1 day (= 24
  74343. * * 3600
  74344. *
  74345. * * 1000 milliseconds). This is normally computed automatically, but this
  74346. * option can be used to override the automatic value.
  74347. */
  74348. pointRange?: number;
  74349. /**
  74350. * (Highcharts) The pyramid is reversed by default, as opposed to the
  74351. * funnel, which shares the layout engine, and is not reversed.
  74352. */
  74353. reversed?: boolean;
  74354. /**
  74355. * (Highcharts) Whether to select the series initially. If `showCheckbox` is
  74356. * true, the checkbox next to the series name in the legend will be checked
  74357. * for a selected series.
  74358. */
  74359. selected?: boolean;
  74360. /**
  74361. * (Highcharts) Whether to apply a drop shadow to the graph line. Since 2.3
  74362. * the shadow can be an object configuration containing `color`, `offsetX`,
  74363. * `offsetY`, `opacity` and `width`.
  74364. */
  74365. shadow?: (boolean|ShadowOptionsObject);
  74366. /**
  74367. * (Highcharts) If true, a checkbox is displayed next to the legend item to
  74368. * allow selecting the series. The state of the checkbox is determined by
  74369. * the `selected` option.
  74370. */
  74371. showCheckbox?: boolean;
  74372. /**
  74373. * (Highcharts) Whether to display this particular series or series type in
  74374. * the legend. Since 2.1, pies are not shown in the legend by default.
  74375. */
  74376. showInLegend?: boolean;
  74377. /**
  74378. * (Highstock) Whether or not to show the series in the navigator. Takes
  74379. * precedence over navigator.baseSeries if defined.
  74380. */
  74381. showInNavigator?: boolean;
  74382. /**
  74383. * (Highcharts) If set to `true`, the accessibility module will skip past
  74384. * the points in this series for keyboard navigation.
  74385. */
  74386. skipKeyboardNavigation?: boolean;
  74387. /**
  74388. * (Highcharts) If a point is sliced, moved out from the center, how many
  74389. * pixels should it be moved?.
  74390. */
  74391. slicedOffset?: number;
  74392. /**
  74393. * (Highcharts) The start angle of the pie slices in degrees where 0 is top
  74394. * and 90 right.
  74395. */
  74396. startAngle?: number;
  74397. /**
  74398. * (Highcharts) Options for the series states.
  74399. */
  74400. states?: SeriesStatesOptionsObject;
  74401. /**
  74402. * (Highcharts) Sticky tracking of mouse events. When true, the `mouseOut`
  74403. * event on a series isn't triggered until the mouse moves over another
  74404. * series, or out of the plot area. When false, the `mouseOut` event on a
  74405. * series is triggered when the mouse leaves the area around the series'
  74406. * graph or markers. This also implies the tooltip. When `stickyTracking` is
  74407. * false and `tooltip.shared` is false, the tooltip will be hidden when
  74408. * moving the mouse between series.
  74409. */
  74410. stickyTracking?: boolean;
  74411. /**
  74412. * (Highcharts) A configuration object for the tooltip rendering of each
  74413. * single series. Properties are inherited from tooltip, but only the
  74414. * following properties can be defined on a series level.
  74415. */
  74416. tooltip?: SeriesTooltipOptionsObject;
  74417. /**
  74418. * (Highstock) The parameter allows setting line series type and use OHLC
  74419. * indicators. Data in OHLC format is required.
  74420. */
  74421. useOhlcData?: boolean;
  74422. /**
  74423. * (Highcharts) Set the initial visibility of the series.
  74424. */
  74425. visible?: boolean;
  74426. /**
  74427. * (Highcharts) The width of the funnel compared to the width of the plot
  74428. * area, or the pixel width if it is a number.
  74429. */
  74430. width?: (number|string);
  74431. /**
  74432. * (Highmaps) Define the z index of the series.
  74433. */
  74434. zIndex?: number;
  74435. }
  74436. /**
  74437. * (Highstock) Enable or disable the initial animation when a series is
  74438. * displayed. The animation can also be set as a configuration object. Please
  74439. * note that this option only applies to the initial animation of the series
  74440. * itself. For other animations, see chart.animation and the animation parameter
  74441. * under the API methods. The following properties are supported:
  74442. *
  74443. * - `defer`: The animation delay time in milliseconds.
  74444. *
  74445. * - `duration`: The duration of the animation in milliseconds.
  74446. *
  74447. * - `easing`: Can be a string reference to an easing function set on the `Math`
  74448. * object or a function. See the _Custom easing function_ demo below.
  74449. *
  74450. * Due to poor performance, animation is disabled in old IE browsers for several
  74451. * chart types.
  74452. */
  74453. export interface PlotRocAnimationOptions {
  74454. defer?: number;
  74455. }
  74456. /**
  74457. * (Highcharts, Highstock, Highmaps, Gantt) Enable or disable the initial
  74458. * animation when a series is displayed for the `dataLabels`. The animation can
  74459. * also be set as a configuration object. Please note that this option only
  74460. * applies to the initial animation. For other animations, see chart.animation
  74461. * and the animation parameter under the API methods. The following properties
  74462. * are supported:
  74463. *
  74464. * - `defer`: The animation delay time in milliseconds.
  74465. */
  74466. export interface PlotRocDataLabelsAnimationOptions {
  74467. /**
  74468. * (Highcharts, Highstock, Highmaps, Gantt) The animation delay time in
  74469. * milliseconds. Set to `0` renders dataLabel immediately. As `undefined`
  74470. * inherits defer time from the series.animation.defer.
  74471. */
  74472. defer?: number;
  74473. }
  74474. /**
  74475. * (Highcharts, Highstock, Highmaps, Gantt) Options for the series data labels,
  74476. * appearing next to each data point.
  74477. *
  74478. * Since v6.2.0, multiple data labels can be applied to each single point by
  74479. * defining them as an array of configs.
  74480. *
  74481. * In styled mode, the data labels can be styled with the
  74482. * `.highcharts-data-label-box` and `.highcharts-data-label` class names (see
  74483. * example).
  74484. */
  74485. export interface PlotRocDataLabelsOptions {
  74486. /**
  74487. * (Highcharts, Highstock, Highmaps, Gantt) The alignment of the data label
  74488. * compared to the point. If `right`, the right side of the label should be
  74489. * touching the point. For points with an extent, like columns, the
  74490. * alignments also dictates how to align it inside the box, as given with
  74491. * the inside option. Can be one of `left`, `center` or `right`.
  74492. */
  74493. align?: (AlignValue|null);
  74494. /**
  74495. * (Highcharts, Highstock, Highmaps, Gantt) Whether to allow data labels to
  74496. * overlap. To make the labels less sensitive for overlapping, the
  74497. * dataLabels.padding can be set to 0.
  74498. */
  74499. allowOverlap?: boolean;
  74500. /**
  74501. * (Highcharts, Highstock, Highmaps, Gantt) Enable or disable the initial
  74502. * animation when a series is displayed for the `dataLabels`. The animation
  74503. * can also be set as a configuration object. Please note that this option
  74504. * only applies to the initial animation. For other animations, see
  74505. * chart.animation and the animation parameter under the API methods. The
  74506. * following properties are supported:
  74507. *
  74508. * - `defer`: The animation delay time in milliseconds.
  74509. */
  74510. animation?: (boolean|PlotRocDataLabelsAnimationOptions|Partial<AnimationOptionsObject>);
  74511. /**
  74512. * (Highcharts, Highstock, Highmaps, Gantt) The background color or gradient
  74513. * for the data label.
  74514. */
  74515. backgroundColor?: (ColorString|GradientColorObject|PatternObject);
  74516. /**
  74517. * (Highcharts, Highstock, Highmaps, Gantt) The border color for the data
  74518. * label. Defaults to `undefined`.
  74519. */
  74520. borderColor?: (ColorString|GradientColorObject|PatternObject);
  74521. /**
  74522. * (Highcharts, Highstock, Highmaps, Gantt) The border radius in pixels for
  74523. * the data label.
  74524. */
  74525. borderRadius?: number;
  74526. /**
  74527. * (Highcharts, Highstock, Highmaps, Gantt) The border width in pixels for
  74528. * the data label.
  74529. */
  74530. borderWidth?: number;
  74531. /**
  74532. * (Highcharts, Highstock, Highmaps, Gantt) A class name for the data label.
  74533. * Particularly in styled mode, this can be used to give each series' or
  74534. * point's data label unique styling. In addition to this option, a default
  74535. * color class name is added so that we can give the labels a contrast text
  74536. * shadow.
  74537. */
  74538. className?: string;
  74539. /**
  74540. * (Highcharts, Highstock, Highmaps, Gantt) The text color for the data
  74541. * labels. Defaults to `undefined`. For certain series types, like column or
  74542. * map, the data labels can be drawn inside the points. In this case the
  74543. * data label will be drawn with maximum contrast by default. Additionally,
  74544. * it will be given a `text-outline` style with the opposite color, to
  74545. * further increase the contrast. This can be overridden by setting the
  74546. * `text-outline` style to `none` in the `dataLabels.style` option.
  74547. */
  74548. color?: (ColorString|GradientColorObject|PatternObject);
  74549. /**
  74550. * (Highcharts, Highstock, Highmaps, Gantt) Whether to hide data labels that
  74551. * are outside the plot area. By default, the data label is moved inside the
  74552. * plot area according to the overflow option.
  74553. */
  74554. crop?: boolean;
  74555. /**
  74556. * (Highcharts, Highstock, Gantt) Whether to defer displaying the data
  74557. * labels until the initial series animation has finished. Setting to
  74558. * `false` renders the data label immediately. If set to `true` inherits the
  74559. * defer time set in plotOptions.series.animation.
  74560. */
  74561. defer?: boolean;
  74562. /**
  74563. * (Highcharts, Highstock, Highmaps, Gantt) Enable or disable the data
  74564. * labels.
  74565. */
  74566. enabled?: boolean;
  74567. /**
  74568. * (Highcharts, Highstock, Highmaps, Gantt) A declarative filter to control
  74569. * of which data labels to display. The declarative filter is designed for
  74570. * use when callback functions are not available, like when the chart
  74571. * options require a pure JSON structure or for use with graphical editors.
  74572. * For programmatic control, use the `formatter` instead, and return
  74573. * `undefined` to disable a single data label.
  74574. */
  74575. filter?: DataLabelsFilterOptionsObject;
  74576. /**
  74577. * (Highcharts, Highstock, Highmaps, Gantt) A format string for the data
  74578. * label. Available variables are the same as for `formatter`.
  74579. */
  74580. format?: string;
  74581. /**
  74582. * (Highcharts, Highstock, Highmaps, Gantt) Callback JavaScript function to
  74583. * format the data label. Note that if a `format` is defined, the format
  74584. * takes precedence and the formatter is ignored.
  74585. */
  74586. formatter?: DataLabelsFormatterCallbackFunction;
  74587. /**
  74588. * (Highcharts, Highstock, Highmaps, Gantt) For points with an extent, like
  74589. * columns or map areas, whether to align the data label inside the box or
  74590. * to the actual value point. Defaults to `false` in most cases, `true` in
  74591. * stacked columns.
  74592. */
  74593. inside?: boolean;
  74594. /**
  74595. * (Highcharts, Highstock, Highmaps, Gantt) Format for points with the value
  74596. * of null. Works analogously to format. `nullFormat` can be applied only to
  74597. * series which support displaying null points.
  74598. */
  74599. nullFormat?: (boolean|string);
  74600. /**
  74601. * (Highcharts, Highstock, Highmaps, Gantt) Callback JavaScript function
  74602. * that defines formatting for points with the value of null. Works
  74603. * analogously to formatter. `nullPointFormatter` can be applied only to
  74604. * series which support displaying null points.
  74605. */
  74606. nullFormatter?: DataLabelsFormatterCallbackFunction;
  74607. /**
  74608. * (Highcharts, Highstock, Highmaps, Gantt) How to handle data labels that
  74609. * flow outside the plot area. The default is `"justify"`, which aligns them
  74610. * inside the plot area. For columns and bars, this means it will be moved
  74611. * inside the bar. To display data labels outside the plot area, set `crop`
  74612. * to `false` and `overflow` to `"allow"`.
  74613. */
  74614. overflow?: DataLabelsOverflowValue;
  74615. /**
  74616. * (Highcharts, Highstock, Highmaps, Gantt) When either the `borderWidth` or
  74617. * the `backgroundColor` is set, this is the padding within the box.
  74618. */
  74619. padding?: number;
  74620. /**
  74621. * (Highcharts, Highstock, Highmaps, Gantt) Aligns data labels relative to
  74622. * points. If `center` alignment is not possible, it defaults to `right`.
  74623. */
  74624. position?: AlignValue;
  74625. /**
  74626. * (Highcharts, Highstock, Highmaps, Gantt) Text rotation in degrees. Note
  74627. * that due to a more complex structure, backgrounds, borders and padding
  74628. * will be lost on a rotated data label.
  74629. */
  74630. rotation?: number;
  74631. /**
  74632. * (Highcharts, Highstock, Highmaps, Gantt) The shadow of the box. Works
  74633. * best with `borderWidth` or `backgroundColor`. Since 2.3 the shadow can be
  74634. * an object configuration containing `color`, `offsetX`, `offsetY`,
  74635. * `opacity` and `width`.
  74636. */
  74637. shadow?: (boolean|ShadowOptionsObject);
  74638. /**
  74639. * (Highcharts, Highstock, Highmaps, Gantt) The name of a symbol to use for
  74640. * the border around the label. Symbols are predefined functions on the
  74641. * Renderer object.
  74642. */
  74643. shape?: string;
  74644. /**
  74645. * (Highcharts, Highstock, Highmaps, Gantt) Styles for the label. The
  74646. * default `color` setting is `"contrast"`, which is a pseudo color that
  74647. * Highcharts picks up and applies the maximum contrast to the underlying
  74648. * point item, for example the bar in a bar chart.
  74649. *
  74650. * The `textOutline` is a pseudo property that applies an outline of the
  74651. * given width with the given color, which by default is the maximum
  74652. * contrast to the text. So a bright text color will result in a black text
  74653. * outline for maximum readability on a mixed background. In some cases,
  74654. * especially with grayscale text, the text outline doesn't work well, in
  74655. * which cases it can be disabled by setting it to `"none"`. When `useHTML`
  74656. * is true, the `textOutline` will not be picked up. In this, case, the same
  74657. * effect can be acheived through the `text-shadow` CSS property.
  74658. *
  74659. * For some series types, where each point has an extent, like for example
  74660. * tree maps, the data label may overflow the point. There are two
  74661. * strategies for handling overflow. By default, the text will wrap to
  74662. * multiple lines. The other strategy is to set `style.textOverflow` to
  74663. * `ellipsis`, which will keep the text on one line plus it will break
  74664. * inside long words.
  74665. */
  74666. style?: CSSObject;
  74667. /**
  74668. * (Highcharts, Highstock, Highmaps, Gantt) Options for a label text which
  74669. * should follow marker's shape. Border and background are disabled for a
  74670. * label that follows a path.
  74671. *
  74672. * **Note:** Only SVG-based renderer supports this option. Setting `useHTML`
  74673. * to true will disable this option.
  74674. */
  74675. textPath?: DataLabelsTextPathOptionsObject;
  74676. /**
  74677. * (Highcharts, Highstock, Highmaps, Gantt) Whether to use HTML to render
  74678. * the labels.
  74679. */
  74680. useHTML?: boolean;
  74681. /**
  74682. * (Highcharts, Highstock, Highmaps, Gantt) The vertical alignment of a data
  74683. * label. Can be one of `top`, `middle` or `bottom`. The default value
  74684. * depends on the data, for instance in a column chart, the label is above
  74685. * positive values and below negative values.
  74686. */
  74687. verticalAlign?: (VerticalAlignValue|null);
  74688. /**
  74689. * (Highcharts, Highstock, Highmaps, Gantt) The x position offset of the
  74690. * label relative to the point in pixels.
  74691. */
  74692. x?: number;
  74693. /**
  74694. * (Highcharts, Highstock, Highmaps, Gantt) The y position offset of the
  74695. * label relative to the point in pixels.
  74696. */
  74697. y?: number;
  74698. /**
  74699. * (Highcharts, Highstock, Highmaps, Gantt) The Z index of the data labels.
  74700. * The default Z index puts it above the series. Use a Z index of 2 to
  74701. * display it behind the series.
  74702. */
  74703. z?: number;
  74704. }
  74705. /**
  74706. * (Highcharts, Highstock) Options for the series data sorting.
  74707. */
  74708. export interface PlotRocDataSortingOptions {
  74709. /**
  74710. * (Highcharts, Highstock) Enable or disable data sorting for the series.
  74711. * Use xAxis.reversed to change the sorting order.
  74712. */
  74713. enabled?: boolean;
  74714. /**
  74715. * (Highcharts, Highstock) Whether to allow matching points by name in an
  74716. * update. If this option is disabled, points will be matched by order.
  74717. */
  74718. matchByName?: boolean;
  74719. /**
  74720. * (Highcharts, Highstock) Determines what data value should be used to sort
  74721. * by.
  74722. */
  74723. sortKey?: string;
  74724. }
  74725. /**
  74726. * (Highstock) Rate of change indicator (ROC). The indicator value for each
  74727. * point is defined as:
  74728. *
  74729. * `(C - Cn) / Cn * 100`
  74730. *
  74731. * where: `C` is the close value of the point of the same x in the linked series
  74732. * and `Cn` is the close value of the point `n` periods ago. `n` is set through
  74733. * period.
  74734. *
  74735. * This series requires `linkedTo` option to be set.
  74736. *
  74737. * In TypeScript the type option must always be set.
  74738. *
  74739. * Configuration options for the series are given in three levels:
  74740. *
  74741. * 1. Options for all series in a chart are defined in the plotOptions.series
  74742. * object.
  74743. *
  74744. * 2. Options for all `roc` series are defined in plotOptions.roc.
  74745. *
  74746. * 3. Options for one single series are given in the series instance array. (see
  74747. * online documentation for example)
  74748. */
  74749. export interface PlotRocOptions {
  74750. /**
  74751. * (Highstock) Accessibility options for a series.
  74752. */
  74753. accessibility?: SeriesAccessibilityOptionsObject;
  74754. /**
  74755. * (Highstock) Allow this series' points to be selected by clicking on the
  74756. * graphic (columns, point markers, pie slices, map areas etc).
  74757. *
  74758. * The selected points can be handled by point select and unselect events,
  74759. * or collectively by the getSelectedPoints function.
  74760. *
  74761. * And alternative way of selecting points is through dragging.
  74762. */
  74763. allowPointSelect?: boolean;
  74764. /**
  74765. * (Highstock) Enable or disable the initial animation when a series is
  74766. * displayed. The animation can also be set as a configuration object.
  74767. * Please note that this option only applies to the initial animation of the
  74768. * series itself. For other animations, see chart.animation and the
  74769. * animation parameter under the API methods. The following properties are
  74770. * supported:
  74771. *
  74772. * - `defer`: The animation delay time in milliseconds.
  74773. *
  74774. * - `duration`: The duration of the animation in milliseconds.
  74775. *
  74776. * - `easing`: Can be a string reference to an easing function set on the
  74777. * `Math` object or a function. See the _Custom easing function_ demo below.
  74778. *
  74779. * Due to poor performance, animation is disabled in old IE browsers for
  74780. * several chart types.
  74781. */
  74782. animation?: (boolean|PlotRocAnimationOptions|Partial<AnimationOptionsObject>);
  74783. /**
  74784. * (Highstock) For some series, there is a limit that shuts down initial
  74785. * animation by default when the total number of points in the chart is too
  74786. * high. For example, for a column chart and its derivatives, animation does
  74787. * not run if there is more than 250 points totally. To disable this cap,
  74788. * set `animationLimit` to `Infinity`.
  74789. */
  74790. animationLimit?: number;
  74791. /**
  74792. * (Highstock) Sets the color blending in the boost module.
  74793. */
  74794. boostBlending?: OptionsBoostBlendingValue;
  74795. /**
  74796. * (Highstock) Set the point threshold for when a series should enter boost
  74797. * mode.
  74798. *
  74799. * Setting it to e.g. 2000 will cause the series to enter boost mode when
  74800. * there are 2000 or more points in the series.
  74801. *
  74802. * To disable boosting on the series, set the `boostThreshold` to 0. Setting
  74803. * it to 1 will force boosting.
  74804. *
  74805. * Note that the cropThreshold also affects this setting. When zooming in on
  74806. * a series that has fewer points than the `cropThreshold`, all points are
  74807. * rendered although outside the visible plot area, and the `boostThreshold`
  74808. * won't take effect.
  74809. */
  74810. boostThreshold?: number;
  74811. /**
  74812. * (Highmaps) The border color of the map areas.
  74813. *
  74814. * In styled mode, the border stroke is given in the `.highcharts-point`
  74815. * class.
  74816. */
  74817. borderColor?: (ColorString|GradientColorObject|PatternObject);
  74818. /**
  74819. * (Highmaps) The border width of each map area.
  74820. *
  74821. * In styled mode, the border stroke width is given in the
  74822. * `.highcharts-point` class.
  74823. */
  74824. borderWidth?: number;
  74825. /**
  74826. * (Highstock) An additional class name to apply to the series' graphical
  74827. * elements. This option does not replace default class names of the
  74828. * graphical element.
  74829. */
  74830. className?: string;
  74831. /**
  74832. * (Highstock) Disable this option to allow series rendering in the whole
  74833. * plotting area.
  74834. *
  74835. * **Note:** Clipping should be always enabled when chart.zoomType is set
  74836. */
  74837. clip?: boolean;
  74838. /**
  74839. * (Highstock) The main color of the series. In line type series it applies
  74840. * to the line and the point markers unless otherwise specified. In bar type
  74841. * series it applies to the bars unless a color is specified per point. The
  74842. * default value is pulled from the `options.colors` array.
  74843. *
  74844. * In styled mode, the color can be defined by the colorIndex option. Also,
  74845. * the series color can be set with the `.highcharts-series`,
  74846. * `.highcharts-color-{n}`, `.highcharts-{type}-series` or
  74847. * `.highcharts-series-{n}` class, or individual classes given by the
  74848. * `className` option.
  74849. */
  74850. color?: (ColorString|GradientColorObject|PatternObject);
  74851. /**
  74852. * (Highstock) Styled mode only. A specific color index to use for the
  74853. * series, so its graphic representations are given the class name
  74854. * `highcharts-color-{n}`.
  74855. */
  74856. colorIndex?: number;
  74857. /**
  74858. * (Highcharts, Highstock, Highmaps) Determines what data value should be
  74859. * used to calculate point color if `colorAxis` is used. Requires to set
  74860. * `min` and `max` if some custom point property is used or if approximation
  74861. * for data grouping is set to `'sum'`.
  74862. */
  74863. colorKey?: string;
  74864. /**
  74865. * (Highstock) Compare the values of the series against the first non-null,
  74866. * non- zero value in the visible range. The y axis will show percentage or
  74867. * absolute change depending on whether `compare` is set to `"percent"` or
  74868. * `"value"`. When this is applied to multiple series, it allows comparing
  74869. * the development of the series against each other. Adds a `change` field
  74870. * to every point object.
  74871. */
  74872. compare?: string;
  74873. /**
  74874. * (Highstock) When compare is `percent`, this option dictates whether to
  74875. * use 0 or 100 as the base of comparison.
  74876. */
  74877. compareBase?: (0|100);
  74878. /**
  74879. * (Highstock) Defines if comparison should start from the first point
  74880. * within the visible range or should start from the first point **before**
  74881. * the range.
  74882. *
  74883. * In other words, this flag determines if first point within the visible
  74884. * range will have 0% (`compareStart=true`) or should have been already
  74885. * calculated according to the previous point (`compareStart=false`).
  74886. */
  74887. compareStart?: boolean;
  74888. /**
  74889. * (Highstock) Whether to compare indicator to the main series values or
  74890. * indicator values.
  74891. */
  74892. compareToMain?: boolean;
  74893. /**
  74894. * (Highcharts) Polar charts only. Whether to connect the ends of a line
  74895. * series plot across the extremes.
  74896. */
  74897. connectEnds?: boolean;
  74898. /**
  74899. * (Highcharts, Highstock) Whether to connect a graph line across null
  74900. * points, or render a gap between the two points on either side of the
  74901. * null.
  74902. */
  74903. connectNulls?: boolean;
  74904. /**
  74905. * (Gantt) Override Pathfinder connector options for a series. Requires
  74906. * Highcharts Gantt to be loaded.
  74907. */
  74908. connectors?: SeriesConnectorsOptionsObject;
  74909. /**
  74910. * (Highcharts, Highstock, Gantt) When true, each point or column edge is
  74911. * rounded to its nearest pixel in order to render sharp on screen. In some
  74912. * cases, when there are a lot of densely packed columns, this leads to
  74913. * visible difference in column widths or distance between columns. In these
  74914. * cases, setting `crisp` to `false` may look better, even though each
  74915. * column is rendered blurry.
  74916. */
  74917. crisp?: boolean;
  74918. /**
  74919. * (Highcharts, Highstock) When the series contains less points than the
  74920. * crop threshold, all points are drawn, even if the points fall outside the
  74921. * visible plot area at the current zoom. The advantage of drawing all
  74922. * points (including markers and columns), is that animation is performed on
  74923. * updates. On the other hand, when the series contains more points than the
  74924. * crop threshold, the series data is cropped to only contain points that
  74925. * fall within the plot area. The advantage of cropping away invisible
  74926. * points is to increase performance on large series.
  74927. */
  74928. cropThreshold?: number;
  74929. /**
  74930. * (Highstock) You can set the cursor to "pointer" if you have click events
  74931. * attached to the series, to signal to the user that the points and lines
  74932. * can be clicked.
  74933. *
  74934. * In styled mode, the series cursor can be set with the same classes as
  74935. * listed under series.color.
  74936. */
  74937. cursor?: (string|CursorValue);
  74938. /**
  74939. * (Highstock) A reserved subspace to store options and values for
  74940. * customized functionality. Here you can add additional data for your own
  74941. * event callbacks and formatter callbacks.
  74942. */
  74943. custom?: Dictionary<any>;
  74944. /**
  74945. * (Highstock) Name of the dash style to use for the graph, or for some
  74946. * series types the outline of each shape.
  74947. *
  74948. * In styled mode, the stroke dash-array can be set with the same classes as
  74949. * listed under series.color.
  74950. */
  74951. dashStyle?: DashStyleValue;
  74952. /**
  74953. * (Highstock) Data grouping is the concept of sampling the data values into
  74954. * larger blocks in order to ease readability and increase performance of
  74955. * the JavaScript charts. Highstock by default applies data grouping when
  74956. * the points become closer than a certain pixel value, determined by the
  74957. * `groupPixelWidth` option.
  74958. *
  74959. * If data grouping is applied, the grouping information of grouped points
  74960. * can be read from the Point.dataGroup. If point options other than the
  74961. * data itself are set, for example `name` or `color` or custom properties,
  74962. * the grouping logic doesn't know how to group it. In this case the options
  74963. * of the first point instance are copied over to the group point. This can
  74964. * be altered through a custom `approximation` callback function.
  74965. */
  74966. dataGrouping?: DataGroupingOptionsObject;
  74967. /**
  74968. * (Highcharts, Highstock, Highmaps, Gantt) Options for the series data
  74969. * labels, appearing next to each data point.
  74970. *
  74971. * Since v6.2.0, multiple data labels can be applied to each single point by
  74972. * defining them as an array of configs.
  74973. *
  74974. * In styled mode, the data labels can be styled with the
  74975. * `.highcharts-data-label-box` and `.highcharts-data-label` class names
  74976. * (see example).
  74977. */
  74978. dataLabels?: (PlotRocDataLabelsOptions|Array<PlotRocDataLabelsOptions>);
  74979. /**
  74980. * (Highcharts, Highstock) Options for the series data sorting.
  74981. */
  74982. dataSorting?: (DataSortingOptionsObject|PlotRocDataSortingOptions);
  74983. /**
  74984. * (Highstock) A description of the series to add to the screen reader
  74985. * information about the series.
  74986. */
  74987. description?: string;
  74988. /**
  74989. * (Highstock) Enable or disable the mouse tracking for a specific series.
  74990. * This includes point tooltips and click events on graphs and points. For
  74991. * large datasets it improves performance.
  74992. */
  74993. enableMouseTracking?: boolean;
  74994. /**
  74995. * (Highstock) General event handlers for the series items. These event
  74996. * hooks can also be attached to the series at run time using the
  74997. * `Highcharts.addEvent` function.
  74998. */
  74999. events?: SeriesEventsOptionsObject;
  75000. /**
  75001. * (Highstock) Determines whether the series should look for the nearest
  75002. * point in both dimensions or just the x-dimension when hovering the
  75003. * series. Defaults to `'xy'` for scatter series and `'x'` for most other
  75004. * series. If the data has duplicate x-values, it is recommended to set this
  75005. * to `'xy'` to allow hovering over all points.
  75006. *
  75007. * Applies only to series types using nearest neighbor search (not direct
  75008. * hover) for tooltip.
  75009. */
  75010. findNearestPointBy?: OptionsFindNearestPointByValue;
  75011. /**
  75012. * (Highstock) Defines when to display a gap in the graph, together with the
  75013. * gapUnit option.
  75014. *
  75015. * In case when `dataGrouping` is enabled, points can be grouped into a
  75016. * larger time span. This can make the grouped points to have a greater
  75017. * distance than the absolute value of `gapSize` property, which will result
  75018. * in disappearing graph completely. To prevent this situation the mentioned
  75019. * distance between grouped points is used instead of previously defined
  75020. * `gapSize`.
  75021. *
  75022. * In practice, this option is most often used to visualize gaps in time
  75023. * series. In a stock chart, intraday data is available for daytime hours,
  75024. * while gaps will appear in nights and weekends.
  75025. */
  75026. gapSize?: number;
  75027. /**
  75028. * (Highstock) Together with gapSize, this option defines where to draw gaps
  75029. * in the graph.
  75030. *
  75031. * When the `gapUnit` is `"relative"` (default), a gap size of 5 means that
  75032. * if the distance between two points is greater than 5 times that of the
  75033. * two closest points, the graph will be broken.
  75034. *
  75035. * When the `gapUnit` is `"value"`, the gap is based on absolute axis
  75036. * values, which on a datetime axis is milliseconds. This also applies to
  75037. * the navigator series that inherits gap options from the base series.
  75038. */
  75039. gapUnit?: OptionsGapUnitValue;
  75040. /**
  75041. * (Highcharts, Highstock, Gantt) Whether to use the Y extremes of the total
  75042. * chart width or only the zoomed area when zooming in on parts of the X
  75043. * axis. By default, the Y axis adjusts to the min and max of the visible
  75044. * data. Cartesian series only.
  75045. */
  75046. getExtremesFromAll?: boolean;
  75047. /**
  75048. * (Highstock) When set to `false` will prevent the series data from being
  75049. * included in any form of data export.
  75050. *
  75051. * Since version 6.0.0 until 7.1.0 the option was existing undocumented as
  75052. * `includeInCSVExport`.
  75053. */
  75054. includeInDataExport?: boolean;
  75055. /**
  75056. * (Highcharts, Highstock, Gantt) Series labels are placed as close to the
  75057. * series as possible in a natural way, seeking to avoid other series. The
  75058. * goal of this feature is to make the chart more easily readable, like if a
  75059. * human designer placed the labels in the optimal position.
  75060. *
  75061. * The series labels currently work with series types having a `graph` or an
  75062. * `area`.
  75063. */
  75064. label?: SeriesLabelOptionsObject;
  75065. /**
  75066. * (Highstock) The line marks the last price from all points.
  75067. */
  75068. lastPrice?: SeriesLastPriceOptionsObject;
  75069. /**
  75070. * (Highstock) The line marks the last price from visible range of points.
  75071. */
  75072. lastVisiblePrice?: SeriesLastVisiblePriceOptionsObject;
  75073. /**
  75074. * (Highcharts, Highstock) The SVG value used for the `stroke-linecap` and
  75075. * `stroke-linejoin` of a line graph. Round means that lines are rounded in
  75076. * the ends and bends.
  75077. */
  75078. linecap?: SeriesLinecapValue;
  75079. /**
  75080. * (Highcharts, Highstock) Pixel width of the graph line.
  75081. */
  75082. lineWidth?: number;
  75083. /**
  75084. * (Highcharts, Highstock, Gantt) The main series ID that indicator will be
  75085. * based on. Required for this indicator.
  75086. */
  75087. linkedTo?: string;
  75088. /**
  75089. * (Highstock) Options for the point markers of line-like series. Properties
  75090. * like `fillColor`, `lineColor` and `lineWidth` define the visual
  75091. * appearance of the markers. Other series types, like column series, don't
  75092. * have markers, but have visual options on the series level instead.
  75093. *
  75094. * In styled mode, the markers can be styled with the `.highcharts-point`,
  75095. * `.highcharts-point-hover` and `.highcharts-point-select` class names.
  75096. */
  75097. marker?: PointMarkerOptionsObject;
  75098. /**
  75099. * (Highstock) The name of the series as shown in the legend, tooltip etc.
  75100. * If not set, it will be based on a technical indicator type and default
  75101. * params.
  75102. */
  75103. name?: string;
  75104. /**
  75105. * (Highstock) The color for the parts of the graph or points that are below
  75106. * the threshold. Note that `zones` takes precedence over the negative
  75107. * color. Using `negativeColor` is equivalent to applying a zone with value
  75108. * of 0.
  75109. */
  75110. negativeColor?: (ColorString|GradientColorObject|PatternObject);
  75111. /**
  75112. * (Highstock) Opacity of a series parts: line, fill (e.g. area) and
  75113. * dataLabels.
  75114. */
  75115. opacity?: number;
  75116. /**
  75117. * (Highstock) Paramters used in calculation of regression series' points.
  75118. */
  75119. params?: PlotRocParamsOptions;
  75120. /**
  75121. * (Highstock) Properties for each single point.
  75122. */
  75123. point?: PlotSeriesPointOptions;
  75124. /**
  75125. * (Highstock) Same as accessibility.pointDescriptionFormatter, but for an
  75126. * individual series. Overrides the chart wide configuration.
  75127. */
  75128. pointDescriptionFormatter?: Function;
  75129. /**
  75130. * (Highstock) Whether to select the series initially. If `showCheckbox` is
  75131. * true, the checkbox next to the series name in the legend will be checked
  75132. * for a selected series.
  75133. */
  75134. selected?: boolean;
  75135. /**
  75136. * (Highstock) Whether to apply a drop shadow to the graph line. Since 2.3
  75137. * the shadow can be an object configuration containing `color`, `offsetX`,
  75138. * `offsetY`, `opacity` and `width`.
  75139. */
  75140. shadow?: (boolean|ShadowOptionsObject);
  75141. /**
  75142. * (Highstock) If true, a checkbox is displayed next to the legend item to
  75143. * allow selecting the series. The state of the checkbox is determined by
  75144. * the `selected` option.
  75145. */
  75146. showCheckbox?: boolean;
  75147. /**
  75148. * (Highstock) Whether to display this particular series or series type in
  75149. * the legend. Standalone series are shown in legend by default, and linked
  75150. * series are not. Since v7.2.0 it is possible to show series that use
  75151. * colorAxis by setting this option to `true`.
  75152. */
  75153. showInLegend?: boolean;
  75154. /**
  75155. * (Highstock) If set to `true`, the accessibility module will skip past the
  75156. * points in this series for keyboard navigation.
  75157. */
  75158. skipKeyboardNavigation?: boolean;
  75159. /**
  75160. * (Highcharts, Highstock) When this is true, the series will not cause the
  75161. * Y axis to cross the zero plane (or threshold option) unless the data
  75162. * actually crosses the plane.
  75163. *
  75164. * For example, if `softThreshold` is `false`, a series of 0, 1, 2, 3 will
  75165. * make the Y axis show negative values according to the `minPadding`
  75166. * option. If `softThreshold` is `true`, the Y axis starts at 0.
  75167. */
  75168. softThreshold?: boolean;
  75169. states?: SeriesStatesOptionsObject;
  75170. /**
  75171. * (Highcharts, Highstock) Whether to apply steps to the line. Possible
  75172. * values are `left`, `center` and `right`.
  75173. */
  75174. step?: OptionsStepValue;
  75175. /**
  75176. * (Highstock) Sticky tracking of mouse events. When true, the `mouseOut`
  75177. * event on a series isn't triggered until the mouse moves over another
  75178. * series, or out of the plot area. When false, the `mouseOut` event on a
  75179. * series is triggered when the mouse leaves the area around the series'
  75180. * graph or markers. This also implies the tooltip when not shared. When
  75181. * `stickyTracking` is false and `tooltip.shared` is false, the tooltip will
  75182. * be hidden when moving the mouse between series. Defaults to true for line
  75183. * and area type series, but to false for columns, pies etc.
  75184. *
  75185. * **Note:** The boost module will force this option because of technical
  75186. * limitations.
  75187. */
  75188. stickyTracking?: boolean;
  75189. /**
  75190. * (Highcharts, Highstock) The threshold, also called zero level or base
  75191. * level. For line type series this is only used in conjunction with
  75192. * negativeColor.
  75193. */
  75194. threshold?: (number|null);
  75195. /**
  75196. * (Highstock) A configuration object for the tooltip rendering of each
  75197. * single series. Properties are inherited from tooltip, but only the
  75198. * following properties can be defined on a series level.
  75199. */
  75200. tooltip?: SeriesTooltipOptionsObject;
  75201. /**
  75202. * (Highcharts, Highstock, Gantt) When a series contains a data array that
  75203. * is longer than this, only one dimensional arrays of numbers, or two
  75204. * dimensional arrays with x and y values are allowed. Also, only the first
  75205. * point is tested, and the rest are assumed to be the same format. This
  75206. * saves expensive data checking and indexing in long series. Set it to `0`
  75207. * disable.
  75208. *
  75209. * Note: In boost mode turbo threshold is forced. Only array of numbers or
  75210. * two dimensional arrays are allowed.
  75211. */
  75212. turboThreshold?: number;
  75213. /**
  75214. * (Highstock) Set the initial visibility of the series.
  75215. */
  75216. visible?: boolean;
  75217. /**
  75218. * (Highmaps) Define the z index of the series.
  75219. */
  75220. zIndex?: number;
  75221. /**
  75222. * (Highcharts, Highstock) Defines the Axis on which the zones are applied.
  75223. */
  75224. zoneAxis?: string;
  75225. /**
  75226. * (Highcharts, Highstock) An array defining zones within a series. Zones
  75227. * can be applied to the X axis, Y axis or Z axis for bubbles, according to
  75228. * the `zoneAxis` option. The zone definitions have to be in ascending order
  75229. * regarding to the value.
  75230. *
  75231. * In styled mode, the color zones are styled with the
  75232. * `.highcharts-zone-{n}` class, or custom classed from the `className`
  75233. * option (view live demo).
  75234. */
  75235. zones?: Array<SeriesZonesOptionsObject>;
  75236. }
  75237. /**
  75238. * (Highstock) Paramters used in calculation of regression series' points.
  75239. */
  75240. export interface PlotRocParamsOptions {
  75241. /**
  75242. * (Highstock) The point index which indicator calculations will base. For
  75243. * example using OHLC data, index=2 means the indicator will be calculated
  75244. * using Low values.
  75245. */
  75246. index?: number;
  75247. /**
  75248. * (Highstock) The base period for indicator calculations. This is the
  75249. * number of data points which are taken into account for the indicator
  75250. * calculations.
  75251. */
  75252. period?: number;
  75253. }
  75254. /**
  75255. * (Highstock) Enable or disable the initial animation when a series is
  75256. * displayed. The animation can also be set as a configuration object. Please
  75257. * note that this option only applies to the initial animation of the series
  75258. * itself. For other animations, see chart.animation and the animation parameter
  75259. * under the API methods. The following properties are supported:
  75260. *
  75261. * - `defer`: The animation delay time in milliseconds.
  75262. *
  75263. * - `duration`: The duration of the animation in milliseconds.
  75264. *
  75265. * - `easing`: Can be a string reference to an easing function set on the `Math`
  75266. * object or a function. See the _Custom easing function_ demo below.
  75267. *
  75268. * Due to poor performance, animation is disabled in old IE browsers for several
  75269. * chart types.
  75270. */
  75271. export interface PlotRsiAnimationOptions {
  75272. defer?: number;
  75273. }
  75274. /**
  75275. * (Highcharts, Highstock, Highmaps, Gantt) Enable or disable the initial
  75276. * animation when a series is displayed for the `dataLabels`. The animation can
  75277. * also be set as a configuration object. Please note that this option only
  75278. * applies to the initial animation. For other animations, see chart.animation
  75279. * and the animation parameter under the API methods. The following properties
  75280. * are supported:
  75281. *
  75282. * - `defer`: The animation delay time in milliseconds.
  75283. */
  75284. export interface PlotRsiDataLabelsAnimationOptions {
  75285. /**
  75286. * (Highcharts, Highstock, Highmaps, Gantt) The animation delay time in
  75287. * milliseconds. Set to `0` renders dataLabel immediately. As `undefined`
  75288. * inherits defer time from the series.animation.defer.
  75289. */
  75290. defer?: number;
  75291. }
  75292. /**
  75293. * (Highcharts, Highstock, Highmaps, Gantt) Options for the series data labels,
  75294. * appearing next to each data point.
  75295. *
  75296. * Since v6.2.0, multiple data labels can be applied to each single point by
  75297. * defining them as an array of configs.
  75298. *
  75299. * In styled mode, the data labels can be styled with the
  75300. * `.highcharts-data-label-box` and `.highcharts-data-label` class names (see
  75301. * example).
  75302. */
  75303. export interface PlotRsiDataLabelsOptions {
  75304. /**
  75305. * (Highcharts, Highstock, Highmaps, Gantt) The alignment of the data label
  75306. * compared to the point. If `right`, the right side of the label should be
  75307. * touching the point. For points with an extent, like columns, the
  75308. * alignments also dictates how to align it inside the box, as given with
  75309. * the inside option. Can be one of `left`, `center` or `right`.
  75310. */
  75311. align?: (AlignValue|null);
  75312. /**
  75313. * (Highcharts, Highstock, Highmaps, Gantt) Whether to allow data labels to
  75314. * overlap. To make the labels less sensitive for overlapping, the
  75315. * dataLabels.padding can be set to 0.
  75316. */
  75317. allowOverlap?: boolean;
  75318. /**
  75319. * (Highcharts, Highstock, Highmaps, Gantt) Enable or disable the initial
  75320. * animation when a series is displayed for the `dataLabels`. The animation
  75321. * can also be set as a configuration object. Please note that this option
  75322. * only applies to the initial animation. For other animations, see
  75323. * chart.animation and the animation parameter under the API methods. The
  75324. * following properties are supported:
  75325. *
  75326. * - `defer`: The animation delay time in milliseconds.
  75327. */
  75328. animation?: (boolean|PlotRsiDataLabelsAnimationOptions|Partial<AnimationOptionsObject>);
  75329. /**
  75330. * (Highcharts, Highstock, Highmaps, Gantt) The background color or gradient
  75331. * for the data label.
  75332. */
  75333. backgroundColor?: (ColorString|GradientColorObject|PatternObject);
  75334. /**
  75335. * (Highcharts, Highstock, Highmaps, Gantt) The border color for the data
  75336. * label. Defaults to `undefined`.
  75337. */
  75338. borderColor?: (ColorString|GradientColorObject|PatternObject);
  75339. /**
  75340. * (Highcharts, Highstock, Highmaps, Gantt) The border radius in pixels for
  75341. * the data label.
  75342. */
  75343. borderRadius?: number;
  75344. /**
  75345. * (Highcharts, Highstock, Highmaps, Gantt) The border width in pixels for
  75346. * the data label.
  75347. */
  75348. borderWidth?: number;
  75349. /**
  75350. * (Highcharts, Highstock, Highmaps, Gantt) A class name for the data label.
  75351. * Particularly in styled mode, this can be used to give each series' or
  75352. * point's data label unique styling. In addition to this option, a default
  75353. * color class name is added so that we can give the labels a contrast text
  75354. * shadow.
  75355. */
  75356. className?: string;
  75357. /**
  75358. * (Highcharts, Highstock, Highmaps, Gantt) The text color for the data
  75359. * labels. Defaults to `undefined`. For certain series types, like column or
  75360. * map, the data labels can be drawn inside the points. In this case the
  75361. * data label will be drawn with maximum contrast by default. Additionally,
  75362. * it will be given a `text-outline` style with the opposite color, to
  75363. * further increase the contrast. This can be overridden by setting the
  75364. * `text-outline` style to `none` in the `dataLabels.style` option.
  75365. */
  75366. color?: (ColorString|GradientColorObject|PatternObject);
  75367. /**
  75368. * (Highcharts, Highstock, Highmaps, Gantt) Whether to hide data labels that
  75369. * are outside the plot area. By default, the data label is moved inside the
  75370. * plot area according to the overflow option.
  75371. */
  75372. crop?: boolean;
  75373. /**
  75374. * (Highcharts, Highstock, Gantt) Whether to defer displaying the data
  75375. * labels until the initial series animation has finished. Setting to
  75376. * `false` renders the data label immediately. If set to `true` inherits the
  75377. * defer time set in plotOptions.series.animation.
  75378. */
  75379. defer?: boolean;
  75380. /**
  75381. * (Highcharts, Highstock, Highmaps, Gantt) Enable or disable the data
  75382. * labels.
  75383. */
  75384. enabled?: boolean;
  75385. /**
  75386. * (Highcharts, Highstock, Highmaps, Gantt) A declarative filter to control
  75387. * of which data labels to display. The declarative filter is designed for
  75388. * use when callback functions are not available, like when the chart
  75389. * options require a pure JSON structure or for use with graphical editors.
  75390. * For programmatic control, use the `formatter` instead, and return
  75391. * `undefined` to disable a single data label.
  75392. */
  75393. filter?: DataLabelsFilterOptionsObject;
  75394. /**
  75395. * (Highcharts, Highstock, Highmaps, Gantt) A format string for the data
  75396. * label. Available variables are the same as for `formatter`.
  75397. */
  75398. format?: string;
  75399. /**
  75400. * (Highcharts, Highstock, Highmaps, Gantt) Callback JavaScript function to
  75401. * format the data label. Note that if a `format` is defined, the format
  75402. * takes precedence and the formatter is ignored.
  75403. */
  75404. formatter?: DataLabelsFormatterCallbackFunction;
  75405. /**
  75406. * (Highcharts, Highstock, Highmaps, Gantt) For points with an extent, like
  75407. * columns or map areas, whether to align the data label inside the box or
  75408. * to the actual value point. Defaults to `false` in most cases, `true` in
  75409. * stacked columns.
  75410. */
  75411. inside?: boolean;
  75412. /**
  75413. * (Highcharts, Highstock, Highmaps, Gantt) Format for points with the value
  75414. * of null. Works analogously to format. `nullFormat` can be applied only to
  75415. * series which support displaying null points.
  75416. */
  75417. nullFormat?: (boolean|string);
  75418. /**
  75419. * (Highcharts, Highstock, Highmaps, Gantt) Callback JavaScript function
  75420. * that defines formatting for points with the value of null. Works
  75421. * analogously to formatter. `nullPointFormatter` can be applied only to
  75422. * series which support displaying null points.
  75423. */
  75424. nullFormatter?: DataLabelsFormatterCallbackFunction;
  75425. /**
  75426. * (Highcharts, Highstock, Highmaps, Gantt) How to handle data labels that
  75427. * flow outside the plot area. The default is `"justify"`, which aligns them
  75428. * inside the plot area. For columns and bars, this means it will be moved
  75429. * inside the bar. To display data labels outside the plot area, set `crop`
  75430. * to `false` and `overflow` to `"allow"`.
  75431. */
  75432. overflow?: DataLabelsOverflowValue;
  75433. /**
  75434. * (Highcharts, Highstock, Highmaps, Gantt) When either the `borderWidth` or
  75435. * the `backgroundColor` is set, this is the padding within the box.
  75436. */
  75437. padding?: number;
  75438. /**
  75439. * (Highcharts, Highstock, Highmaps, Gantt) Aligns data labels relative to
  75440. * points. If `center` alignment is not possible, it defaults to `right`.
  75441. */
  75442. position?: AlignValue;
  75443. /**
  75444. * (Highcharts, Highstock, Highmaps, Gantt) Text rotation in degrees. Note
  75445. * that due to a more complex structure, backgrounds, borders and padding
  75446. * will be lost on a rotated data label.
  75447. */
  75448. rotation?: number;
  75449. /**
  75450. * (Highcharts, Highstock, Highmaps, Gantt) The shadow of the box. Works
  75451. * best with `borderWidth` or `backgroundColor`. Since 2.3 the shadow can be
  75452. * an object configuration containing `color`, `offsetX`, `offsetY`,
  75453. * `opacity` and `width`.
  75454. */
  75455. shadow?: (boolean|ShadowOptionsObject);
  75456. /**
  75457. * (Highcharts, Highstock, Highmaps, Gantt) The name of a symbol to use for
  75458. * the border around the label. Symbols are predefined functions on the
  75459. * Renderer object.
  75460. */
  75461. shape?: string;
  75462. /**
  75463. * (Highcharts, Highstock, Highmaps, Gantt) Styles for the label. The
  75464. * default `color` setting is `"contrast"`, which is a pseudo color that
  75465. * Highcharts picks up and applies the maximum contrast to the underlying
  75466. * point item, for example the bar in a bar chart.
  75467. *
  75468. * The `textOutline` is a pseudo property that applies an outline of the
  75469. * given width with the given color, which by default is the maximum
  75470. * contrast to the text. So a bright text color will result in a black text
  75471. * outline for maximum readability on a mixed background. In some cases,
  75472. * especially with grayscale text, the text outline doesn't work well, in
  75473. * which cases it can be disabled by setting it to `"none"`. When `useHTML`
  75474. * is true, the `textOutline` will not be picked up. In this, case, the same
  75475. * effect can be acheived through the `text-shadow` CSS property.
  75476. *
  75477. * For some series types, where each point has an extent, like for example
  75478. * tree maps, the data label may overflow the point. There are two
  75479. * strategies for handling overflow. By default, the text will wrap to
  75480. * multiple lines. The other strategy is to set `style.textOverflow` to
  75481. * `ellipsis`, which will keep the text on one line plus it will break
  75482. * inside long words.
  75483. */
  75484. style?: CSSObject;
  75485. /**
  75486. * (Highcharts, Highstock, Highmaps, Gantt) Options for a label text which
  75487. * should follow marker's shape. Border and background are disabled for a
  75488. * label that follows a path.
  75489. *
  75490. * **Note:** Only SVG-based renderer supports this option. Setting `useHTML`
  75491. * to true will disable this option.
  75492. */
  75493. textPath?: DataLabelsTextPathOptionsObject;
  75494. /**
  75495. * (Highcharts, Highstock, Highmaps, Gantt) Whether to use HTML to render
  75496. * the labels.
  75497. */
  75498. useHTML?: boolean;
  75499. /**
  75500. * (Highcharts, Highstock, Highmaps, Gantt) The vertical alignment of a data
  75501. * label. Can be one of `top`, `middle` or `bottom`. The default value
  75502. * depends on the data, for instance in a column chart, the label is above
  75503. * positive values and below negative values.
  75504. */
  75505. verticalAlign?: (VerticalAlignValue|null);
  75506. /**
  75507. * (Highcharts, Highstock, Highmaps, Gantt) The x position offset of the
  75508. * label relative to the point in pixels.
  75509. */
  75510. x?: number;
  75511. /**
  75512. * (Highcharts, Highstock, Highmaps, Gantt) The y position offset of the
  75513. * label relative to the point in pixels.
  75514. */
  75515. y?: number;
  75516. /**
  75517. * (Highcharts, Highstock, Highmaps, Gantt) The Z index of the data labels.
  75518. * The default Z index puts it above the series. Use a Z index of 2 to
  75519. * display it behind the series.
  75520. */
  75521. z?: number;
  75522. }
  75523. /**
  75524. * (Highcharts, Highstock) Options for the series data sorting.
  75525. */
  75526. export interface PlotRsiDataSortingOptions {
  75527. /**
  75528. * (Highcharts, Highstock) Enable or disable data sorting for the series.
  75529. * Use xAxis.reversed to change the sorting order.
  75530. */
  75531. enabled?: boolean;
  75532. /**
  75533. * (Highcharts, Highstock) Whether to allow matching points by name in an
  75534. * update. If this option is disabled, points will be matched by order.
  75535. */
  75536. matchByName?: boolean;
  75537. /**
  75538. * (Highcharts, Highstock) Determines what data value should be used to sort
  75539. * by.
  75540. */
  75541. sortKey?: string;
  75542. }
  75543. /**
  75544. * (Highstock) Relative strength index (RSI) technical indicator. This series
  75545. * requires the `linkedTo` option to be set and should be loaded after the
  75546. * `stock/indicators/indicators.js` file.
  75547. *
  75548. * In TypeScript the type option must always be set.
  75549. *
  75550. * Configuration options for the series are given in three levels:
  75551. *
  75552. * 1. Options for all series in a chart are defined in the plotOptions.series
  75553. * object.
  75554. *
  75555. * 2. Options for all `rsi` series are defined in plotOptions.rsi.
  75556. *
  75557. * 3. Options for one single series are given in the series instance array. (see
  75558. * online documentation for example)
  75559. */
  75560. export interface PlotRsiOptions {
  75561. /**
  75562. * (Highstock) Accessibility options for a series.
  75563. */
  75564. accessibility?: SeriesAccessibilityOptionsObject;
  75565. /**
  75566. * (Highstock) Allow this series' points to be selected by clicking on the
  75567. * graphic (columns, point markers, pie slices, map areas etc).
  75568. *
  75569. * The selected points can be handled by point select and unselect events,
  75570. * or collectively by the getSelectedPoints function.
  75571. *
  75572. * And alternative way of selecting points is through dragging.
  75573. */
  75574. allowPointSelect?: boolean;
  75575. /**
  75576. * (Highstock) Enable or disable the initial animation when a series is
  75577. * displayed. The animation can also be set as a configuration object.
  75578. * Please note that this option only applies to the initial animation of the
  75579. * series itself. For other animations, see chart.animation and the
  75580. * animation parameter under the API methods. The following properties are
  75581. * supported:
  75582. *
  75583. * - `defer`: The animation delay time in milliseconds.
  75584. *
  75585. * - `duration`: The duration of the animation in milliseconds.
  75586. *
  75587. * - `easing`: Can be a string reference to an easing function set on the
  75588. * `Math` object or a function. See the _Custom easing function_ demo below.
  75589. *
  75590. * Due to poor performance, animation is disabled in old IE browsers for
  75591. * several chart types.
  75592. */
  75593. animation?: (boolean|PlotRsiAnimationOptions|Partial<AnimationOptionsObject>);
  75594. /**
  75595. * (Highstock) For some series, there is a limit that shuts down initial
  75596. * animation by default when the total number of points in the chart is too
  75597. * high. For example, for a column chart and its derivatives, animation does
  75598. * not run if there is more than 250 points totally. To disable this cap,
  75599. * set `animationLimit` to `Infinity`.
  75600. */
  75601. animationLimit?: number;
  75602. /**
  75603. * (Highstock) Sets the color blending in the boost module.
  75604. */
  75605. boostBlending?: OptionsBoostBlendingValue;
  75606. /**
  75607. * (Highstock) Set the point threshold for when a series should enter boost
  75608. * mode.
  75609. *
  75610. * Setting it to e.g. 2000 will cause the series to enter boost mode when
  75611. * there are 2000 or more points in the series.
  75612. *
  75613. * To disable boosting on the series, set the `boostThreshold` to 0. Setting
  75614. * it to 1 will force boosting.
  75615. *
  75616. * Note that the cropThreshold also affects this setting. When zooming in on
  75617. * a series that has fewer points than the `cropThreshold`, all points are
  75618. * rendered although outside the visible plot area, and the `boostThreshold`
  75619. * won't take effect.
  75620. */
  75621. boostThreshold?: number;
  75622. /**
  75623. * (Highmaps) The border color of the map areas.
  75624. *
  75625. * In styled mode, the border stroke is given in the `.highcharts-point`
  75626. * class.
  75627. */
  75628. borderColor?: (ColorString|GradientColorObject|PatternObject);
  75629. /**
  75630. * (Highmaps) The border width of each map area.
  75631. *
  75632. * In styled mode, the border stroke width is given in the
  75633. * `.highcharts-point` class.
  75634. */
  75635. borderWidth?: number;
  75636. /**
  75637. * (Highstock) An additional class name to apply to the series' graphical
  75638. * elements. This option does not replace default class names of the
  75639. * graphical element.
  75640. */
  75641. className?: string;
  75642. /**
  75643. * (Highstock) Disable this option to allow series rendering in the whole
  75644. * plotting area.
  75645. *
  75646. * **Note:** Clipping should be always enabled when chart.zoomType is set
  75647. */
  75648. clip?: boolean;
  75649. /**
  75650. * (Highstock) The main color of the series. In line type series it applies
  75651. * to the line and the point markers unless otherwise specified. In bar type
  75652. * series it applies to the bars unless a color is specified per point. The
  75653. * default value is pulled from the `options.colors` array.
  75654. *
  75655. * In styled mode, the color can be defined by the colorIndex option. Also,
  75656. * the series color can be set with the `.highcharts-series`,
  75657. * `.highcharts-color-{n}`, `.highcharts-{type}-series` or
  75658. * `.highcharts-series-{n}` class, or individual classes given by the
  75659. * `className` option.
  75660. */
  75661. color?: (ColorString|GradientColorObject|PatternObject);
  75662. /**
  75663. * (Highstock) Styled mode only. A specific color index to use for the
  75664. * series, so its graphic representations are given the class name
  75665. * `highcharts-color-{n}`.
  75666. */
  75667. colorIndex?: number;
  75668. /**
  75669. * (Highcharts, Highstock, Highmaps) Determines what data value should be
  75670. * used to calculate point color if `colorAxis` is used. Requires to set
  75671. * `min` and `max` if some custom point property is used or if approximation
  75672. * for data grouping is set to `'sum'`.
  75673. */
  75674. colorKey?: string;
  75675. /**
  75676. * (Highstock) Compare the values of the series against the first non-null,
  75677. * non- zero value in the visible range. The y axis will show percentage or
  75678. * absolute change depending on whether `compare` is set to `"percent"` or
  75679. * `"value"`. When this is applied to multiple series, it allows comparing
  75680. * the development of the series against each other. Adds a `change` field
  75681. * to every point object.
  75682. */
  75683. compare?: string;
  75684. /**
  75685. * (Highstock) When compare is `percent`, this option dictates whether to
  75686. * use 0 or 100 as the base of comparison.
  75687. */
  75688. compareBase?: (0|100);
  75689. /**
  75690. * (Highstock) Defines if comparison should start from the first point
  75691. * within the visible range or should start from the first point **before**
  75692. * the range.
  75693. *
  75694. * In other words, this flag determines if first point within the visible
  75695. * range will have 0% (`compareStart=true`) or should have been already
  75696. * calculated according to the previous point (`compareStart=false`).
  75697. */
  75698. compareStart?: boolean;
  75699. /**
  75700. * (Highstock) Whether to compare indicator to the main series values or
  75701. * indicator values.
  75702. */
  75703. compareToMain?: boolean;
  75704. /**
  75705. * (Highcharts) Polar charts only. Whether to connect the ends of a line
  75706. * series plot across the extremes.
  75707. */
  75708. connectEnds?: boolean;
  75709. /**
  75710. * (Highcharts, Highstock) Whether to connect a graph line across null
  75711. * points, or render a gap between the two points on either side of the
  75712. * null.
  75713. */
  75714. connectNulls?: boolean;
  75715. /**
  75716. * (Gantt) Override Pathfinder connector options for a series. Requires
  75717. * Highcharts Gantt to be loaded.
  75718. */
  75719. connectors?: SeriesConnectorsOptionsObject;
  75720. /**
  75721. * (Highcharts, Highstock, Gantt) When true, each point or column edge is
  75722. * rounded to its nearest pixel in order to render sharp on screen. In some
  75723. * cases, when there are a lot of densely packed columns, this leads to
  75724. * visible difference in column widths or distance between columns. In these
  75725. * cases, setting `crisp` to `false` may look better, even though each
  75726. * column is rendered blurry.
  75727. */
  75728. crisp?: boolean;
  75729. /**
  75730. * (Highcharts, Highstock) When the series contains less points than the
  75731. * crop threshold, all points are drawn, even if the points fall outside the
  75732. * visible plot area at the current zoom. The advantage of drawing all
  75733. * points (including markers and columns), is that animation is performed on
  75734. * updates. On the other hand, when the series contains more points than the
  75735. * crop threshold, the series data is cropped to only contain points that
  75736. * fall within the plot area. The advantage of cropping away invisible
  75737. * points is to increase performance on large series.
  75738. */
  75739. cropThreshold?: number;
  75740. /**
  75741. * (Highstock) You can set the cursor to "pointer" if you have click events
  75742. * attached to the series, to signal to the user that the points and lines
  75743. * can be clicked.
  75744. *
  75745. * In styled mode, the series cursor can be set with the same classes as
  75746. * listed under series.color.
  75747. */
  75748. cursor?: (string|CursorValue);
  75749. /**
  75750. * (Highstock) A reserved subspace to store options and values for
  75751. * customized functionality. Here you can add additional data for your own
  75752. * event callbacks and formatter callbacks.
  75753. */
  75754. custom?: Dictionary<any>;
  75755. /**
  75756. * (Highstock) Name of the dash style to use for the graph, or for some
  75757. * series types the outline of each shape.
  75758. *
  75759. * In styled mode, the stroke dash-array can be set with the same classes as
  75760. * listed under series.color.
  75761. */
  75762. dashStyle?: DashStyleValue;
  75763. /**
  75764. * (Highstock) Data grouping is the concept of sampling the data values into
  75765. * larger blocks in order to ease readability and increase performance of
  75766. * the JavaScript charts. Highstock by default applies data grouping when
  75767. * the points become closer than a certain pixel value, determined by the
  75768. * `groupPixelWidth` option.
  75769. *
  75770. * If data grouping is applied, the grouping information of grouped points
  75771. * can be read from the Point.dataGroup. If point options other than the
  75772. * data itself are set, for example `name` or `color` or custom properties,
  75773. * the grouping logic doesn't know how to group it. In this case the options
  75774. * of the first point instance are copied over to the group point. This can
  75775. * be altered through a custom `approximation` callback function.
  75776. */
  75777. dataGrouping?: DataGroupingOptionsObject;
  75778. /**
  75779. * (Highcharts, Highstock, Highmaps, Gantt) Options for the series data
  75780. * labels, appearing next to each data point.
  75781. *
  75782. * Since v6.2.0, multiple data labels can be applied to each single point by
  75783. * defining them as an array of configs.
  75784. *
  75785. * In styled mode, the data labels can be styled with the
  75786. * `.highcharts-data-label-box` and `.highcharts-data-label` class names
  75787. * (see example).
  75788. */
  75789. dataLabels?: (PlotRsiDataLabelsOptions|Array<PlotRsiDataLabelsOptions>);
  75790. /**
  75791. * (Highcharts, Highstock) Options for the series data sorting.
  75792. */
  75793. dataSorting?: (DataSortingOptionsObject|PlotRsiDataSortingOptions);
  75794. /**
  75795. * (Highstock) A description of the series to add to the screen reader
  75796. * information about the series.
  75797. */
  75798. description?: string;
  75799. /**
  75800. * (Highstock) Enable or disable the mouse tracking for a specific series.
  75801. * This includes point tooltips and click events on graphs and points. For
  75802. * large datasets it improves performance.
  75803. */
  75804. enableMouseTracking?: boolean;
  75805. /**
  75806. * (Highstock) General event handlers for the series items. These event
  75807. * hooks can also be attached to the series at run time using the
  75808. * `Highcharts.addEvent` function.
  75809. */
  75810. events?: SeriesEventsOptionsObject;
  75811. /**
  75812. * (Highstock) Determines whether the series should look for the nearest
  75813. * point in both dimensions or just the x-dimension when hovering the
  75814. * series. Defaults to `'xy'` for scatter series and `'x'` for most other
  75815. * series. If the data has duplicate x-values, it is recommended to set this
  75816. * to `'xy'` to allow hovering over all points.
  75817. *
  75818. * Applies only to series types using nearest neighbor search (not direct
  75819. * hover) for tooltip.
  75820. */
  75821. findNearestPointBy?: OptionsFindNearestPointByValue;
  75822. /**
  75823. * (Highstock) Defines when to display a gap in the graph, together with the
  75824. * gapUnit option.
  75825. *
  75826. * In case when `dataGrouping` is enabled, points can be grouped into a
  75827. * larger time span. This can make the grouped points to have a greater
  75828. * distance than the absolute value of `gapSize` property, which will result
  75829. * in disappearing graph completely. To prevent this situation the mentioned
  75830. * distance between grouped points is used instead of previously defined
  75831. * `gapSize`.
  75832. *
  75833. * In practice, this option is most often used to visualize gaps in time
  75834. * series. In a stock chart, intraday data is available for daytime hours,
  75835. * while gaps will appear in nights and weekends.
  75836. */
  75837. gapSize?: number;
  75838. /**
  75839. * (Highstock) Together with gapSize, this option defines where to draw gaps
  75840. * in the graph.
  75841. *
  75842. * When the `gapUnit` is `"relative"` (default), a gap size of 5 means that
  75843. * if the distance between two points is greater than 5 times that of the
  75844. * two closest points, the graph will be broken.
  75845. *
  75846. * When the `gapUnit` is `"value"`, the gap is based on absolute axis
  75847. * values, which on a datetime axis is milliseconds. This also applies to
  75848. * the navigator series that inherits gap options from the base series.
  75849. */
  75850. gapUnit?: OptionsGapUnitValue;
  75851. /**
  75852. * (Highcharts, Highstock, Gantt) Whether to use the Y extremes of the total
  75853. * chart width or only the zoomed area when zooming in on parts of the X
  75854. * axis. By default, the Y axis adjusts to the min and max of the visible
  75855. * data. Cartesian series only.
  75856. */
  75857. getExtremesFromAll?: boolean;
  75858. /**
  75859. * (Highstock) When set to `false` will prevent the series data from being
  75860. * included in any form of data export.
  75861. *
  75862. * Since version 6.0.0 until 7.1.0 the option was existing undocumented as
  75863. * `includeInCSVExport`.
  75864. */
  75865. includeInDataExport?: boolean;
  75866. /**
  75867. * (Highcharts, Highstock, Gantt) Series labels are placed as close to the
  75868. * series as possible in a natural way, seeking to avoid other series. The
  75869. * goal of this feature is to make the chart more easily readable, like if a
  75870. * human designer placed the labels in the optimal position.
  75871. *
  75872. * The series labels currently work with series types having a `graph` or an
  75873. * `area`.
  75874. */
  75875. label?: SeriesLabelOptionsObject;
  75876. /**
  75877. * (Highstock) The line marks the last price from all points.
  75878. */
  75879. lastPrice?: SeriesLastPriceOptionsObject;
  75880. /**
  75881. * (Highstock) The line marks the last price from visible range of points.
  75882. */
  75883. lastVisiblePrice?: SeriesLastVisiblePriceOptionsObject;
  75884. /**
  75885. * (Highcharts, Highstock) The SVG value used for the `stroke-linecap` and
  75886. * `stroke-linejoin` of a line graph. Round means that lines are rounded in
  75887. * the ends and bends.
  75888. */
  75889. linecap?: SeriesLinecapValue;
  75890. /**
  75891. * (Highcharts, Highstock) Pixel width of the graph line.
  75892. */
  75893. lineWidth?: number;
  75894. /**
  75895. * (Highcharts, Highstock, Gantt) The main series ID that indicator will be
  75896. * based on. Required for this indicator.
  75897. */
  75898. linkedTo?: string;
  75899. /**
  75900. * (Highstock) Options for the point markers of line-like series. Properties
  75901. * like `fillColor`, `lineColor` and `lineWidth` define the visual
  75902. * appearance of the markers. Other series types, like column series, don't
  75903. * have markers, but have visual options on the series level instead.
  75904. *
  75905. * In styled mode, the markers can be styled with the `.highcharts-point`,
  75906. * `.highcharts-point-hover` and `.highcharts-point-select` class names.
  75907. */
  75908. marker?: PointMarkerOptionsObject;
  75909. /**
  75910. * (Highstock) The name of the series as shown in the legend, tooltip etc.
  75911. * If not set, it will be based on a technical indicator type and default
  75912. * params.
  75913. */
  75914. name?: string;
  75915. /**
  75916. * (Highstock) The color for the parts of the graph or points that are below
  75917. * the threshold. Note that `zones` takes precedence over the negative
  75918. * color. Using `negativeColor` is equivalent to applying a zone with value
  75919. * of 0.
  75920. */
  75921. negativeColor?: (ColorString|GradientColorObject|PatternObject);
  75922. /**
  75923. * (Highstock) Opacity of a series parts: line, fill (e.g. area) and
  75924. * dataLabels.
  75925. */
  75926. opacity?: number;
  75927. /**
  75928. * (Highstock) Paramters used in calculation of regression series' points.
  75929. */
  75930. params?: PlotRsiParamsOptions;
  75931. /**
  75932. * (Highstock) Properties for each single point.
  75933. */
  75934. point?: PlotSeriesPointOptions;
  75935. /**
  75936. * (Highstock) Same as accessibility.pointDescriptionFormatter, but for an
  75937. * individual series. Overrides the chart wide configuration.
  75938. */
  75939. pointDescriptionFormatter?: Function;
  75940. /**
  75941. * (Highstock) Whether to select the series initially. If `showCheckbox` is
  75942. * true, the checkbox next to the series name in the legend will be checked
  75943. * for a selected series.
  75944. */
  75945. selected?: boolean;
  75946. /**
  75947. * (Highstock) Whether to apply a drop shadow to the graph line. Since 2.3
  75948. * the shadow can be an object configuration containing `color`, `offsetX`,
  75949. * `offsetY`, `opacity` and `width`.
  75950. */
  75951. shadow?: (boolean|ShadowOptionsObject);
  75952. /**
  75953. * (Highstock) If true, a checkbox is displayed next to the legend item to
  75954. * allow selecting the series. The state of the checkbox is determined by
  75955. * the `selected` option.
  75956. */
  75957. showCheckbox?: boolean;
  75958. /**
  75959. * (Highstock) Whether to display this particular series or series type in
  75960. * the legend. Standalone series are shown in legend by default, and linked
  75961. * series are not. Since v7.2.0 it is possible to show series that use
  75962. * colorAxis by setting this option to `true`.
  75963. */
  75964. showInLegend?: boolean;
  75965. /**
  75966. * (Highstock) If set to `true`, the accessibility module will skip past the
  75967. * points in this series for keyboard navigation.
  75968. */
  75969. skipKeyboardNavigation?: boolean;
  75970. /**
  75971. * (Highcharts, Highstock) When this is true, the series will not cause the
  75972. * Y axis to cross the zero plane (or threshold option) unless the data
  75973. * actually crosses the plane.
  75974. *
  75975. * For example, if `softThreshold` is `false`, a series of 0, 1, 2, 3 will
  75976. * make the Y axis show negative values according to the `minPadding`
  75977. * option. If `softThreshold` is `true`, the Y axis starts at 0.
  75978. */
  75979. softThreshold?: boolean;
  75980. states?: SeriesStatesOptionsObject;
  75981. /**
  75982. * (Highcharts, Highstock) Whether to apply steps to the line. Possible
  75983. * values are `left`, `center` and `right`.
  75984. */
  75985. step?: OptionsStepValue;
  75986. /**
  75987. * (Highstock) Sticky tracking of mouse events. When true, the `mouseOut`
  75988. * event on a series isn't triggered until the mouse moves over another
  75989. * series, or out of the plot area. When false, the `mouseOut` event on a
  75990. * series is triggered when the mouse leaves the area around the series'
  75991. * graph or markers. This also implies the tooltip when not shared. When
  75992. * `stickyTracking` is false and `tooltip.shared` is false, the tooltip will
  75993. * be hidden when moving the mouse between series. Defaults to true for line
  75994. * and area type series, but to false for columns, pies etc.
  75995. *
  75996. * **Note:** The boost module will force this option because of technical
  75997. * limitations.
  75998. */
  75999. stickyTracking?: boolean;
  76000. /**
  76001. * (Highcharts, Highstock) The threshold, also called zero level or base
  76002. * level. For line type series this is only used in conjunction with
  76003. * negativeColor.
  76004. */
  76005. threshold?: (number|null);
  76006. /**
  76007. * (Highstock) A configuration object for the tooltip rendering of each
  76008. * single series. Properties are inherited from tooltip, but only the
  76009. * following properties can be defined on a series level.
  76010. */
  76011. tooltip?: SeriesTooltipOptionsObject;
  76012. /**
  76013. * (Highcharts, Highstock, Gantt) When a series contains a data array that
  76014. * is longer than this, only one dimensional arrays of numbers, or two
  76015. * dimensional arrays with x and y values are allowed. Also, only the first
  76016. * point is tested, and the rest are assumed to be the same format. This
  76017. * saves expensive data checking and indexing in long series. Set it to `0`
  76018. * disable.
  76019. *
  76020. * Note: In boost mode turbo threshold is forced. Only array of numbers or
  76021. * two dimensional arrays are allowed.
  76022. */
  76023. turboThreshold?: number;
  76024. /**
  76025. * (Highstock) Set the initial visibility of the series.
  76026. */
  76027. visible?: boolean;
  76028. /**
  76029. * (Highmaps) Define the z index of the series.
  76030. */
  76031. zIndex?: number;
  76032. /**
  76033. * (Highcharts, Highstock) Defines the Axis on which the zones are applied.
  76034. */
  76035. zoneAxis?: string;
  76036. /**
  76037. * (Highcharts, Highstock) An array defining zones within a series. Zones
  76038. * can be applied to the X axis, Y axis or Z axis for bubbles, according to
  76039. * the `zoneAxis` option. The zone definitions have to be in ascending order
  76040. * regarding to the value.
  76041. *
  76042. * In styled mode, the color zones are styled with the
  76043. * `.highcharts-zone-{n}` class, or custom classed from the `className`
  76044. * option (view live demo).
  76045. */
  76046. zones?: Array<SeriesZonesOptionsObject>;
  76047. }
  76048. /**
  76049. * (Highstock) Paramters used in calculation of regression series' points.
  76050. */
  76051. export interface PlotRsiParamsOptions {
  76052. decimals?: number;
  76053. /**
  76054. * (Highstock) The point index which indicator calculations will base. For
  76055. * example using OHLC data, index=2 means the indicator will be calculated
  76056. * using Low values.
  76057. */
  76058. index?: number;
  76059. /**
  76060. * (Highstock) The base period for indicator calculations. This is the
  76061. * number of data points which are taken into account for the indicator
  76062. * calculations.
  76063. */
  76064. period?: number;
  76065. }
  76066. /**
  76067. * (Highcharts) Enable or disable the initial animation when a series is
  76068. * displayed. The animation can also be set as a configuration object. Please
  76069. * note that this option only applies to the initial animation of the series
  76070. * itself. For other animations, see chart.animation and the animation parameter
  76071. * under the API methods. The following properties are supported:
  76072. *
  76073. * - `defer`: The animation delay time in milliseconds.
  76074. *
  76075. * - `duration`: The duration of the animation in milliseconds.
  76076. *
  76077. * - `easing`: Can be a string reference to an easing function set on the `Math`
  76078. * object or a function. See the _Custom easing function_ demo below.
  76079. *
  76080. * Due to poor performance, animation is disabled in old IE browsers for several
  76081. * chart types.
  76082. */
  76083. export interface PlotSankeyAnimationOptions {
  76084. defer?: number;
  76085. }
  76086. /**
  76087. * (Highcharts, Highstock, Highmaps, Gantt) Enable or disable the initial
  76088. * animation when a series is displayed for the `dataLabels`. The animation can
  76089. * also be set as a configuration object. Please note that this option only
  76090. * applies to the initial animation. For other animations, see chart.animation
  76091. * and the animation parameter under the API methods. The following properties
  76092. * are supported:
  76093. *
  76094. * - `defer`: The animation delay time in milliseconds.
  76095. */
  76096. export interface PlotSankeyDataLabelsAnimationOptions {
  76097. /**
  76098. * (Highcharts, Highstock, Highmaps, Gantt) The animation delay time in
  76099. * milliseconds. Set to `0` renders dataLabel immediately. As `undefined`
  76100. * inherits defer time from the series.animation.defer.
  76101. */
  76102. defer?: number;
  76103. }
  76104. /**
  76105. * (Highcharts, Highstock, Highmaps, Gantt) Enable or disable the initial
  76106. * animation when a series is displayed for the `dataLabels`. The animation can
  76107. * also be set as a configuration object. Please note that this option only
  76108. * applies to the initial animation. For other animations, see chart.animation
  76109. * and the animation parameter under the API methods. The following properties
  76110. * are supported:
  76111. *
  76112. * - `defer`: The animation delay time in milliseconds.
  76113. */
  76114. export interface PlotSankeyLevelsDataLabelsAnimationOptions {
  76115. /**
  76116. * (Highcharts, Highstock, Highmaps, Gantt) The animation delay time in
  76117. * milliseconds. Set to `0` renders dataLabel immediately. As `undefined`
  76118. * inherits defer time from the series.animation.defer.
  76119. */
  76120. defer?: number;
  76121. }
  76122. /**
  76123. * (Highcharts) Set options on specific levels. Takes precedence over series
  76124. * options, but not node and link options.
  76125. */
  76126. export interface PlotSankeyLevelsOptions {
  76127. /**
  76128. * (Highcharts) Can set `borderColor` on all nodes which lay on the same
  76129. * level.
  76130. */
  76131. borderColor?: ColorString;
  76132. /**
  76133. * (Highcharts) Can set `borderWidth` on all nodes which lay on the same
  76134. * level.
  76135. */
  76136. borderWidth?: number;
  76137. /**
  76138. * (Highcharts) Can set `color` on all nodes which lay on the same level.
  76139. */
  76140. color?: (ColorString|GradientColorObject|PatternObject);
  76141. /**
  76142. * (Highcharts) Can set `colorByPoint` on all nodes which lay on the same
  76143. * level.
  76144. */
  76145. colorByPoint?: boolean;
  76146. /**
  76147. * (Highcharts, Highstock, Highmaps, Gantt) Can set `dataLabels` on all
  76148. * points which lay on the same level.
  76149. */
  76150. dataLabels?: (SeriesSankeyDataLabelsOptionsObject|Array<SeriesSankeyDataLabelsOptionsObject>);
  76151. /**
  76152. * (Highcharts) Decides which level takes effect from the options set in the
  76153. * levels object.
  76154. */
  76155. level?: number;
  76156. /**
  76157. * (Highcharts) Can set `linkOpacity` on all points which lay on the same
  76158. * level.
  76159. */
  76160. linkOpacity?: number;
  76161. /**
  76162. * (Highcharts) Can set `states` on all nodes and points which lay on the
  76163. * same level.
  76164. */
  76165. states?: SeriesStatesOptionsObject;
  76166. }
  76167. /**
  76168. * (Highcharts) A sankey diagram is a type of flow diagram, in which the width
  76169. * of the link between two nodes is shown proportionally to the flow quantity.
  76170. *
  76171. * In TypeScript the type option must always be set.
  76172. *
  76173. * Configuration options for the series are given in three levels:
  76174. *
  76175. * 1. Options for all series in a chart are defined in the plotOptions.series
  76176. * object.
  76177. *
  76178. * 2. Options for all `sankey` series are defined in plotOptions.sankey.
  76179. *
  76180. * 3. Options for one single series are given in the series instance array. (see
  76181. * online documentation for example)
  76182. */
  76183. export interface PlotSankeyOptions {
  76184. /**
  76185. * (Highcharts) Accessibility options for a series.
  76186. */
  76187. accessibility?: SeriesAccessibilityOptionsObject;
  76188. /**
  76189. * (Highmaps) Whether all areas of the map defined in `mapData` should be
  76190. * rendered. If `true`, areas which don't correspond to a data point, are
  76191. * rendered as `null` points. If `false`, those areas are skipped.
  76192. */
  76193. allAreas?: boolean;
  76194. /**
  76195. * (Highcharts) Allow this series' points to be selected by clicking on the
  76196. * graphic (columns, point markers, pie slices, map areas etc).
  76197. *
  76198. * The selected points can be handled by point select and unselect events,
  76199. * or collectively by the getSelectedPoints function.
  76200. *
  76201. * And alternative way of selecting points is through dragging.
  76202. */
  76203. allowPointSelect?: boolean;
  76204. /**
  76205. * (Highcharts) Enable or disable the initial animation when a series is
  76206. * displayed. The animation can also be set as a configuration object.
  76207. * Please note that this option only applies to the initial animation of the
  76208. * series itself. For other animations, see chart.animation and the
  76209. * animation parameter under the API methods. The following properties are
  76210. * supported:
  76211. *
  76212. * - `defer`: The animation delay time in milliseconds.
  76213. *
  76214. * - `duration`: The duration of the animation in milliseconds.
  76215. *
  76216. * - `easing`: Can be a string reference to an easing function set on the
  76217. * `Math` object or a function. See the _Custom easing function_ demo below.
  76218. *
  76219. * Due to poor performance, animation is disabled in old IE browsers for
  76220. * several chart types.
  76221. */
  76222. animation?: (boolean|PlotSankeyAnimationOptions|Partial<AnimationOptionsObject>);
  76223. /**
  76224. * (Highcharts, Highstock, Gantt) The color of the border surrounding each
  76225. * column or bar.
  76226. *
  76227. * In styled mode, the border stroke can be set with the `.highcharts-point`
  76228. * rule.
  76229. */
  76230. borderColor?: (ColorString|GradientColorObject|PatternObject);
  76231. /**
  76232. * (Highcharts, Highstock, Gantt) The width of the border surrounding each
  76233. * column or bar. Defaults to `1` when there is room for a border, but to
  76234. * `0` when the columns are so dense that a border would cover the next
  76235. * column.
  76236. *
  76237. * In styled mode, the stroke width can be set with the `.highcharts-point`
  76238. * rule.
  76239. */
  76240. borderWidth?: number;
  76241. /**
  76242. * (Highcharts, Highstock, Gantt) When `true`, the columns will center in
  76243. * the category, ignoring null or missing points. When `false`, space will
  76244. * be reserved for null or missing points.
  76245. */
  76246. centerInCategory?: boolean;
  76247. /**
  76248. * (Highcharts) An additional class name to apply to the series' graphical
  76249. * elements. This option does not replace default class names of the
  76250. * graphical element.
  76251. */
  76252. className?: string;
  76253. /**
  76254. * (Highcharts) Disable this option to allow series rendering in the whole
  76255. * plotting area.
  76256. *
  76257. * **Note:** Clipping should be always enabled when chart.zoomType is set
  76258. */
  76259. clip?: boolean;
  76260. /**
  76261. * (Highcharts) The main color of the series. In line type series it applies
  76262. * to the line and the point markers unless otherwise specified. In bar type
  76263. * series it applies to the bars unless a color is specified per point. The
  76264. * default value is pulled from the `options.colors` array.
  76265. *
  76266. * In styled mode, the color can be defined by the colorIndex option. Also,
  76267. * the series color can be set with the `.highcharts-series`,
  76268. * `.highcharts-color-{n}`, `.highcharts-{type}-series` or
  76269. * `.highcharts-series-{n}` class, or individual classes given by the
  76270. * `className` option.
  76271. */
  76272. color?: (ColorString|GradientColorObject|PatternObject);
  76273. /**
  76274. * (Highcharts, Highstock, Gantt) When using automatic point colors pulled
  76275. * from the global colors or series-specific plotOptions.column.colors
  76276. * collections, this option determines whether the chart should receive one
  76277. * color per series or one color per point.
  76278. *
  76279. * In styled mode, the `colors` or `series.colors` arrays are not supported,
  76280. * and instead this option gives the points individual color class names on
  76281. * the form `highcharts-color-{n}`.
  76282. */
  76283. colorByPoint?: boolean;
  76284. /**
  76285. * (Highcharts) Styled mode only. A specific color index to use for the
  76286. * series, so its graphic representations are given the class name
  76287. * `highcharts-color-{n}`.
  76288. */
  76289. colorIndex?: number;
  76290. /**
  76291. * (Highcharts, Highstock, Gantt) A series specific or series type specific
  76292. * color set to apply instead of the global colors when colorByPoint is
  76293. * true.
  76294. */
  76295. colors?: Array<(ColorString|GradientColorObject|PatternObject)>;
  76296. /**
  76297. * (Highstock) Compare the values of the series against the first non-null,
  76298. * non- zero value in the visible range. The y axis will show percentage or
  76299. * absolute change depending on whether `compare` is set to `"percent"` or
  76300. * `"value"`. When this is applied to multiple series, it allows comparing
  76301. * the development of the series against each other. Adds a `change` field
  76302. * to every point object.
  76303. */
  76304. compare?: string;
  76305. /**
  76306. * (Highstock) When compare is `percent`, this option dictates whether to
  76307. * use 0 or 100 as the base of comparison.
  76308. */
  76309. compareBase?: (0|100);
  76310. /**
  76311. * (Highstock) Defines if comparison should start from the first point
  76312. * within the visible range or should start from the first point **before**
  76313. * the range.
  76314. *
  76315. * In other words, this flag determines if first point within the visible
  76316. * range will have 0% (`compareStart=true`) or should have been already
  76317. * calculated according to the previous point (`compareStart=false`).
  76318. */
  76319. compareStart?: boolean;
  76320. /**
  76321. * (Gantt) Override Pathfinder connector options for a series. Requires
  76322. * Highcharts Gantt to be loaded.
  76323. */
  76324. connectors?: SeriesConnectorsOptionsObject;
  76325. /**
  76326. * (Highcharts) You can set the cursor to "pointer" if you have click events
  76327. * attached to the series, to signal to the user that the points and lines
  76328. * can be clicked.
  76329. *
  76330. * In styled mode, the series cursor can be set with the same classes as
  76331. * listed under series.color.
  76332. */
  76333. cursor?: (string|CursorValue);
  76334. /**
  76335. * (Highcharts) Higher numbers makes the links in a sankey diagram or
  76336. * dependency wheelrender more curved. A `curveFactor` of 0 makes the lines
  76337. * straight.
  76338. */
  76339. curveFactor?: number;
  76340. /**
  76341. * (Highcharts) A reserved subspace to store options and values for
  76342. * customized functionality. Here you can add additional data for your own
  76343. * event callbacks and formatter callbacks.
  76344. */
  76345. custom?: Dictionary<any>;
  76346. /**
  76347. * (Highcharts) Name of the dash style to use for the graph, or for some
  76348. * series types the outline of each shape.
  76349. *
  76350. * In styled mode, the stroke dash-array can be set with the same classes as
  76351. * listed under series.color.
  76352. */
  76353. dashStyle?: DashStyleValue;
  76354. /**
  76355. * (Highstock) Data grouping is the concept of sampling the data values into
  76356. * larger blocks in order to ease readability and increase performance of
  76357. * the JavaScript charts. Highstock by default applies data grouping when
  76358. * the points become closer than a certain pixel value, determined by the
  76359. * `groupPixelWidth` option.
  76360. *
  76361. * If data grouping is applied, the grouping information of grouped points
  76362. * can be read from the Point.dataGroup. If point options other than the
  76363. * data itself are set, for example `name` or `color` or custom properties,
  76364. * the grouping logic doesn't know how to group it. In this case the options
  76365. * of the first point instance are copied over to the group point. This can
  76366. * be altered through a custom `approximation` callback function.
  76367. */
  76368. dataGrouping?: DataGroupingOptionsObject;
  76369. /**
  76370. * (Highcharts, Highstock, Highmaps, Gantt) Options for the data labels
  76371. * appearing on top of the nodes and links. For sankey charts, data labels
  76372. * are visible for the nodes by default, but hidden for links. This is
  76373. * controlled by modifying the `nodeFormat`, and the `format` that applies
  76374. * to links and is an empty string by default.
  76375. */
  76376. dataLabels?: (SeriesSankeyDataLabelsOptionsObject|Array<SeriesSankeyDataLabelsOptionsObject>);
  76377. /**
  76378. * (Highcharts) A description of the series to add to the screen reader
  76379. * information about the series.
  76380. */
  76381. description?: string;
  76382. /**
  76383. * (Highcharts) Enable or disable the mouse tracking for a specific series.
  76384. * This includes point tooltips and click events on graphs and points. For
  76385. * large datasets it improves performance.
  76386. */
  76387. enableMouseTracking?: boolean;
  76388. /**
  76389. * (Highcharts) General event handlers for the series items. These event
  76390. * hooks can also be attached to the series at run time using the
  76391. * `Highcharts.addEvent` function.
  76392. */
  76393. events?: SeriesEventsOptionsObject;
  76394. /**
  76395. * (Highcharts, Highstock, Gantt) Whether to use the Y extremes of the total
  76396. * chart width or only the zoomed area when zooming in on parts of the X
  76397. * axis. By default, the Y axis adjusts to the min and max of the visible
  76398. * data. Cartesian series only.
  76399. */
  76400. getExtremesFromAll?: boolean;
  76401. /**
  76402. * (Highcharts) When set to `false` will prevent the series data from being
  76403. * included in any form of data export.
  76404. *
  76405. * Since version 6.0.0 until 7.1.0 the option was existing undocumented as
  76406. * `includeInCSVExport`.
  76407. */
  76408. includeInDataExport?: boolean;
  76409. /**
  76410. * (Highmaps) What property to join the `mapData` to the value data. For
  76411. * example, if joinBy is "code", the mapData items with a specific code is
  76412. * merged into the data with the same code. For maps loaded from GeoJSON,
  76413. * the keys may be held in each point's `properties` object.
  76414. *
  76415. * The joinBy option can also be an array of two values, where the first
  76416. * points to a key in the `mapData`, and the second points to another key in
  76417. * the `data`.
  76418. *
  76419. * When joinBy is `null`, the map items are joined by their position in the
  76420. * array, which performs much better in maps with many data points. This is
  76421. * the recommended option if you are printing more than a thousand data
  76422. * points and have a backend that can preprocess the data into a parallel
  76423. * array of the mapData.
  76424. */
  76425. joinBy?: (string|Array<string>);
  76426. /**
  76427. * (Highcharts) An array specifying which option maps to which key in the
  76428. * data point array. This makes it convenient to work with unstructured data
  76429. * arrays from different sources.
  76430. */
  76431. keys?: Array<string>;
  76432. /**
  76433. * (Highcharts, Highstock, Gantt) Series labels are placed as close to the
  76434. * series as possible in a natural way, seeking to avoid other series. The
  76435. * goal of this feature is to make the chart more easily readable, like if a
  76436. * human designer placed the labels in the optimal position.
  76437. *
  76438. * The series labels currently work with series types having a `graph` or an
  76439. * `area`.
  76440. */
  76441. label?: SeriesLabelOptionsObject;
  76442. /**
  76443. * (Highstock) The line marks the last price from all points.
  76444. */
  76445. lastPrice?: SeriesLastPriceOptionsObject;
  76446. /**
  76447. * (Highstock) The line marks the last price from visible range of points.
  76448. */
  76449. lastVisiblePrice?: SeriesLastVisiblePriceOptionsObject;
  76450. /**
  76451. * (Highcharts) Set options on specific levels. Takes precedence over series
  76452. * options, but not node and link options.
  76453. */
  76454. levels?: Array<PlotSankeyLevelsOptions>;
  76455. /**
  76456. * (Highcharts, Highstock, Gantt) The id of another series to link to.
  76457. * Additionally, the value can be ":previous" to link to the previous
  76458. * series. When two series are linked, only the first one appears in the
  76459. * legend. Toggling the visibility of this also toggles the linked series.
  76460. *
  76461. * If master series uses data sorting and linked series does not have its
  76462. * own sorting definition, the linked series will be sorted in the same
  76463. * order as the master one.
  76464. */
  76465. linkedTo?: string;
  76466. /**
  76467. * (Highcharts) Opacity for the links between nodes in the sankey diagram.
  76468. */
  76469. linkOpacity?: number;
  76470. /**
  76471. * (Highcharts) The minimal width for a line of a sankey. By default, 0
  76472. * values are not shown.
  76473. */
  76474. minLinkWidth?: number;
  76475. /**
  76476. * (Highstock) Options for the corresponding navigator series if
  76477. * `showInNavigator` is `true` for this series. Available options are the
  76478. * same as any series, documented at plotOptions and series.
  76479. *
  76480. * These options are merged with options in navigator.series, and will take
  76481. * precedence if the same option is defined both places.
  76482. */
  76483. navigatorOptions?: PlotSeriesOptions;
  76484. /**
  76485. * (Highcharts) The padding between nodes in a sankey diagram or dependency
  76486. * wheel, in pixels.
  76487. *
  76488. * If the number of nodes is so great that it is possible to lay them out
  76489. * within the plot area with the given `nodePadding`, they will be rendered
  76490. * with a smaller padding as a strategy to avoid overflow.
  76491. */
  76492. nodePadding?: number;
  76493. /**
  76494. * (Highcharts) The pixel width of each node in a sankey diagram or
  76495. * dependency wheel, or the height in case the chart is inverted.
  76496. */
  76497. nodeWidth?: number;
  76498. /**
  76499. * (Highcharts) Opacity of a series parts: line, fill (e.g. area) and
  76500. * dataLabels.
  76501. */
  76502. opacity?: number;
  76503. /**
  76504. * (Highcharts) Properties for each single point.
  76505. */
  76506. point?: PlotSeriesPointOptions;
  76507. /**
  76508. * (Highcharts) Same as accessibility.pointDescriptionFormatter, but for an
  76509. * individual series. Overrides the chart wide configuration.
  76510. */
  76511. pointDescriptionFormatter?: Function;
  76512. /**
  76513. * (Highcharts) Whether to select the series initially. If `showCheckbox` is
  76514. * true, the checkbox next to the series name in the legend will be checked
  76515. * for a selected series.
  76516. */
  76517. selected?: boolean;
  76518. /**
  76519. * (Highcharts) If true, a checkbox is displayed next to the legend item to
  76520. * allow selecting the series. The state of the checkbox is determined by
  76521. * the `selected` option.
  76522. */
  76523. showCheckbox?: boolean;
  76524. /**
  76525. * (Highcharts) Whether to display this particular series or series type in
  76526. * the legend. Standalone series are shown in legend by default, and linked
  76527. * series are not. Since v7.2.0 it is possible to show series that use
  76528. * colorAxis by setting this option to `true`.
  76529. */
  76530. showInLegend?: boolean;
  76531. /**
  76532. * (Highstock) Whether or not to show the series in the navigator. Takes
  76533. * precedence over navigator.baseSeries if defined.
  76534. */
  76535. showInNavigator?: boolean;
  76536. /**
  76537. * (Highcharts) If set to `true`, the accessibility module will skip past
  76538. * the points in this series for keyboard navigation.
  76539. */
  76540. skipKeyboardNavigation?: boolean;
  76541. states?: SeriesStatesOptionsObject;
  76542. /**
  76543. * (Highcharts) Sticky tracking of mouse events. When true, the `mouseOut`
  76544. * event on a series isn't triggered until the mouse moves over another
  76545. * series, or out of the plot area. When false, the `mouseOut` event on a
  76546. * series is triggered when the mouse leaves the area around the series'
  76547. * graph or markers. This also implies the tooltip when not shared. When
  76548. * `stickyTracking` is false and `tooltip.shared` is false, the tooltip will
  76549. * be hidden when moving the mouse between series. Defaults to true for line
  76550. * and area type series, but to false for columns, pies etc.
  76551. *
  76552. * **Note:** The boost module will force this option because of technical
  76553. * limitations.
  76554. */
  76555. stickyTracking?: boolean;
  76556. /**
  76557. * (Highcharts) A configuration object for the tooltip rendering of each
  76558. * single series. Properties are inherited from tooltip, but only the
  76559. * following properties can be defined on a series level.
  76560. */
  76561. tooltip?: SeriesTooltipOptionsObject;
  76562. /**
  76563. * (Highcharts, Highstock, Gantt) When a series contains a data array that
  76564. * is longer than this, only one dimensional arrays of numbers, or two
  76565. * dimensional arrays with x and y values are allowed. Also, only the first
  76566. * point is tested, and the rest are assumed to be the same format. This
  76567. * saves expensive data checking and indexing in long series. Set it to `0`
  76568. * disable.
  76569. *
  76570. * Note: In boost mode turbo threshold is forced. Only array of numbers or
  76571. * two dimensional arrays are allowed.
  76572. */
  76573. turboThreshold?: number;
  76574. /**
  76575. * (Highcharts) Set the initial visibility of the series.
  76576. */
  76577. visible?: boolean;
  76578. /**
  76579. * (Highmaps) Define the z index of the series.
  76580. */
  76581. zIndex?: number;
  76582. }
  76583. /**
  76584. * (Highcharts) Enable or disable the initial animation when a series is
  76585. * displayed. The animation can also be set as a configuration object. Please
  76586. * note that this option only applies to the initial animation of the series
  76587. * itself. For other animations, see chart.animation and the animation parameter
  76588. * under the API methods. The following properties are supported:
  76589. *
  76590. * - `defer`: The animation delay time in milliseconds.
  76591. *
  76592. * - `duration`: The duration of the animation in milliseconds.
  76593. *
  76594. * - `easing`: Can be a string reference to an easing function set on the `Math`
  76595. * object or a function. See the _Custom easing function_ demo below.
  76596. *
  76597. * Due to poor performance, animation is disabled in old IE browsers for several
  76598. * chart types.
  76599. */
  76600. export interface PlotScatter3dAnimationOptions {
  76601. defer?: number;
  76602. }
  76603. /**
  76604. * (Highcharts, Highstock, Highmaps, Gantt) Enable or disable the initial
  76605. * animation when a series is displayed for the `dataLabels`. The animation can
  76606. * also be set as a configuration object. Please note that this option only
  76607. * applies to the initial animation. For other animations, see chart.animation
  76608. * and the animation parameter under the API methods. The following properties
  76609. * are supported:
  76610. *
  76611. * - `defer`: The animation delay time in milliseconds.
  76612. */
  76613. export interface PlotScatter3dDataLabelsAnimationOptions {
  76614. /**
  76615. * (Highcharts, Highstock, Highmaps, Gantt) The animation delay time in
  76616. * milliseconds. Set to `0` renders dataLabel immediately. As `undefined`
  76617. * inherits defer time from the series.animation.defer.
  76618. */
  76619. defer?: number;
  76620. }
  76621. /**
  76622. * (Highcharts, Highstock, Highmaps, Gantt) Options for the series data labels,
  76623. * appearing next to each data point.
  76624. *
  76625. * Since v6.2.0, multiple data labels can be applied to each single point by
  76626. * defining them as an array of configs.
  76627. *
  76628. * In styled mode, the data labels can be styled with the
  76629. * `.highcharts-data-label-box` and `.highcharts-data-label` class names (see
  76630. * example).
  76631. */
  76632. export interface PlotScatter3dDataLabelsOptions {
  76633. /**
  76634. * (Highcharts, Highstock, Highmaps, Gantt) The alignment of the data label
  76635. * compared to the point. If `right`, the right side of the label should be
  76636. * touching the point. For points with an extent, like columns, the
  76637. * alignments also dictates how to align it inside the box, as given with
  76638. * the inside option. Can be one of `left`, `center` or `right`.
  76639. */
  76640. align?: (AlignValue|null);
  76641. /**
  76642. * (Highcharts, Highstock, Highmaps, Gantt) Whether to allow data labels to
  76643. * overlap. To make the labels less sensitive for overlapping, the
  76644. * dataLabels.padding can be set to 0.
  76645. */
  76646. allowOverlap?: boolean;
  76647. /**
  76648. * (Highcharts, Highstock, Highmaps, Gantt) Enable or disable the initial
  76649. * animation when a series is displayed for the `dataLabels`. The animation
  76650. * can also be set as a configuration object. Please note that this option
  76651. * only applies to the initial animation. For other animations, see
  76652. * chart.animation and the animation parameter under the API methods. The
  76653. * following properties are supported:
  76654. *
  76655. * - `defer`: The animation delay time in milliseconds.
  76656. */
  76657. animation?: (boolean|PlotScatter3dDataLabelsAnimationOptions|Partial<AnimationOptionsObject>);
  76658. /**
  76659. * (Highcharts, Highstock, Highmaps, Gantt) The background color or gradient
  76660. * for the data label.
  76661. */
  76662. backgroundColor?: (ColorString|GradientColorObject|PatternObject);
  76663. /**
  76664. * (Highcharts, Highstock, Highmaps, Gantt) The border color for the data
  76665. * label. Defaults to `undefined`.
  76666. */
  76667. borderColor?: (ColorString|GradientColorObject|PatternObject);
  76668. /**
  76669. * (Highcharts, Highstock, Highmaps, Gantt) The border radius in pixels for
  76670. * the data label.
  76671. */
  76672. borderRadius?: number;
  76673. /**
  76674. * (Highcharts, Highstock, Highmaps, Gantt) The border width in pixels for
  76675. * the data label.
  76676. */
  76677. borderWidth?: number;
  76678. /**
  76679. * (Highcharts, Highstock, Highmaps, Gantt) A class name for the data label.
  76680. * Particularly in styled mode, this can be used to give each series' or
  76681. * point's data label unique styling. In addition to this option, a default
  76682. * color class name is added so that we can give the labels a contrast text
  76683. * shadow.
  76684. */
  76685. className?: string;
  76686. /**
  76687. * (Highcharts, Highstock, Highmaps, Gantt) The text color for the data
  76688. * labels. Defaults to `undefined`. For certain series types, like column or
  76689. * map, the data labels can be drawn inside the points. In this case the
  76690. * data label will be drawn with maximum contrast by default. Additionally,
  76691. * it will be given a `text-outline` style with the opposite color, to
  76692. * further increase the contrast. This can be overridden by setting the
  76693. * `text-outline` style to `none` in the `dataLabels.style` option.
  76694. */
  76695. color?: (ColorString|GradientColorObject|PatternObject);
  76696. /**
  76697. * (Highcharts, Highstock, Highmaps, Gantt) Whether to hide data labels that
  76698. * are outside the plot area. By default, the data label is moved inside the
  76699. * plot area according to the overflow option.
  76700. */
  76701. crop?: boolean;
  76702. /**
  76703. * (Highcharts, Highstock, Gantt) Whether to defer displaying the data
  76704. * labels until the initial series animation has finished. Setting to
  76705. * `false` renders the data label immediately. If set to `true` inherits the
  76706. * defer time set in plotOptions.series.animation.
  76707. */
  76708. defer?: boolean;
  76709. /**
  76710. * (Highcharts, Highstock, Highmaps, Gantt) Enable or disable the data
  76711. * labels.
  76712. */
  76713. enabled?: boolean;
  76714. /**
  76715. * (Highcharts, Highstock, Highmaps, Gantt) A declarative filter to control
  76716. * of which data labels to display. The declarative filter is designed for
  76717. * use when callback functions are not available, like when the chart
  76718. * options require a pure JSON structure or for use with graphical editors.
  76719. * For programmatic control, use the `formatter` instead, and return
  76720. * `undefined` to disable a single data label.
  76721. */
  76722. filter?: DataLabelsFilterOptionsObject;
  76723. /**
  76724. * (Highcharts, Highstock, Highmaps, Gantt) A format string for the data
  76725. * label. Available variables are the same as for `formatter`.
  76726. */
  76727. format?: string;
  76728. /**
  76729. * (Highcharts, Highstock, Highmaps, Gantt) Callback JavaScript function to
  76730. * format the data label. Note that if a `format` is defined, the format
  76731. * takes precedence and the formatter is ignored.
  76732. */
  76733. formatter?: DataLabelsFormatterCallbackFunction;
  76734. /**
  76735. * (Highcharts, Highstock, Highmaps, Gantt) For points with an extent, like
  76736. * columns or map areas, whether to align the data label inside the box or
  76737. * to the actual value point. Defaults to `false` in most cases, `true` in
  76738. * stacked columns.
  76739. */
  76740. inside?: boolean;
  76741. /**
  76742. * (Highcharts, Highstock, Highmaps, Gantt) Format for points with the value
  76743. * of null. Works analogously to format. `nullFormat` can be applied only to
  76744. * series which support displaying null points.
  76745. */
  76746. nullFormat?: (boolean|string);
  76747. /**
  76748. * (Highcharts, Highstock, Highmaps, Gantt) Callback JavaScript function
  76749. * that defines formatting for points with the value of null. Works
  76750. * analogously to formatter. `nullPointFormatter` can be applied only to
  76751. * series which support displaying null points.
  76752. */
  76753. nullFormatter?: DataLabelsFormatterCallbackFunction;
  76754. /**
  76755. * (Highcharts, Highstock, Highmaps, Gantt) How to handle data labels that
  76756. * flow outside the plot area. The default is `"justify"`, which aligns them
  76757. * inside the plot area. For columns and bars, this means it will be moved
  76758. * inside the bar. To display data labels outside the plot area, set `crop`
  76759. * to `false` and `overflow` to `"allow"`.
  76760. */
  76761. overflow?: DataLabelsOverflowValue;
  76762. /**
  76763. * (Highcharts, Highstock, Highmaps, Gantt) When either the `borderWidth` or
  76764. * the `backgroundColor` is set, this is the padding within the box.
  76765. */
  76766. padding?: number;
  76767. /**
  76768. * (Highcharts, Highstock, Highmaps, Gantt) Aligns data labels relative to
  76769. * points. If `center` alignment is not possible, it defaults to `right`.
  76770. */
  76771. position?: AlignValue;
  76772. /**
  76773. * (Highcharts, Highstock, Highmaps, Gantt) Text rotation in degrees. Note
  76774. * that due to a more complex structure, backgrounds, borders and padding
  76775. * will be lost on a rotated data label.
  76776. */
  76777. rotation?: number;
  76778. /**
  76779. * (Highcharts, Highstock, Highmaps, Gantt) The shadow of the box. Works
  76780. * best with `borderWidth` or `backgroundColor`. Since 2.3 the shadow can be
  76781. * an object configuration containing `color`, `offsetX`, `offsetY`,
  76782. * `opacity` and `width`.
  76783. */
  76784. shadow?: (boolean|ShadowOptionsObject);
  76785. /**
  76786. * (Highcharts, Highstock, Highmaps, Gantt) The name of a symbol to use for
  76787. * the border around the label. Symbols are predefined functions on the
  76788. * Renderer object.
  76789. */
  76790. shape?: string;
  76791. /**
  76792. * (Highcharts, Highstock, Highmaps, Gantt) Styles for the label. The
  76793. * default `color` setting is `"contrast"`, which is a pseudo color that
  76794. * Highcharts picks up and applies the maximum contrast to the underlying
  76795. * point item, for example the bar in a bar chart.
  76796. *
  76797. * The `textOutline` is a pseudo property that applies an outline of the
  76798. * given width with the given color, which by default is the maximum
  76799. * contrast to the text. So a bright text color will result in a black text
  76800. * outline for maximum readability on a mixed background. In some cases,
  76801. * especially with grayscale text, the text outline doesn't work well, in
  76802. * which cases it can be disabled by setting it to `"none"`. When `useHTML`
  76803. * is true, the `textOutline` will not be picked up. In this, case, the same
  76804. * effect can be acheived through the `text-shadow` CSS property.
  76805. *
  76806. * For some series types, where each point has an extent, like for example
  76807. * tree maps, the data label may overflow the point. There are two
  76808. * strategies for handling overflow. By default, the text will wrap to
  76809. * multiple lines. The other strategy is to set `style.textOverflow` to
  76810. * `ellipsis`, which will keep the text on one line plus it will break
  76811. * inside long words.
  76812. */
  76813. style?: CSSObject;
  76814. /**
  76815. * (Highcharts, Highstock, Highmaps, Gantt) Options for a label text which
  76816. * should follow marker's shape. Border and background are disabled for a
  76817. * label that follows a path.
  76818. *
  76819. * **Note:** Only SVG-based renderer supports this option. Setting `useHTML`
  76820. * to true will disable this option.
  76821. */
  76822. textPath?: DataLabelsTextPathOptionsObject;
  76823. /**
  76824. * (Highcharts, Highstock, Highmaps, Gantt) Whether to use HTML to render
  76825. * the labels.
  76826. */
  76827. useHTML?: boolean;
  76828. /**
  76829. * (Highcharts, Highstock, Highmaps, Gantt) The vertical alignment of a data
  76830. * label. Can be one of `top`, `middle` or `bottom`. The default value
  76831. * depends on the data, for instance in a column chart, the label is above
  76832. * positive values and below negative values.
  76833. */
  76834. verticalAlign?: (VerticalAlignValue|null);
  76835. /**
  76836. * (Highcharts, Highstock, Highmaps, Gantt) The x position offset of the
  76837. * label relative to the point in pixels.
  76838. */
  76839. x?: number;
  76840. /**
  76841. * (Highcharts, Highstock, Highmaps, Gantt) The y position offset of the
  76842. * label relative to the point in pixels.
  76843. */
  76844. y?: number;
  76845. /**
  76846. * (Highcharts, Highstock, Highmaps, Gantt) The Z index of the data labels.
  76847. * The default Z index puts it above the series. Use a Z index of 2 to
  76848. * display it behind the series.
  76849. */
  76850. z?: number;
  76851. }
  76852. /**
  76853. * (Highcharts, Highstock) Options for the series data sorting.
  76854. */
  76855. export interface PlotScatter3dDataSortingOptions {
  76856. /**
  76857. * (Highcharts, Highstock) Enable or disable data sorting for the series.
  76858. * Use xAxis.reversed to change the sorting order.
  76859. */
  76860. enabled?: boolean;
  76861. /**
  76862. * (Highcharts, Highstock) Whether to allow matching points by name in an
  76863. * update. If this option is disabled, points will be matched by order.
  76864. */
  76865. matchByName?: boolean;
  76866. /**
  76867. * (Highcharts, Highstock) Determines what data value should be used to sort
  76868. * by.
  76869. */
  76870. sortKey?: string;
  76871. }
  76872. /**
  76873. * (Highcharts, Highstock) Apply a jitter effect for the rendered markers. When
  76874. * plotting discrete values, a little random noise may help telling the points
  76875. * apart. The jitter setting applies a random displacement of up to `n` axis
  76876. * units in either direction. So for example on a horizontal X axis, setting the
  76877. * `jitter.x` to 0.24 will render the point in a random position between 0.24
  76878. * units to the left and 0.24 units to the right of the true axis position. On a
  76879. * category axis, setting it to 0.5 will fill up the bin and make the data
  76880. * appear continuous.
  76881. *
  76882. * When rendered on top of a box plot or a column series, a jitter value of 0.24
  76883. * will correspond to the underlying series' default groupPadding and
  76884. * pointPadding settings.
  76885. */
  76886. export interface PlotScatter3dJitterOptions {
  76887. /**
  76888. * (Highcharts, Highstock) The maximal X offset for the random jitter
  76889. * effect.
  76890. */
  76891. x?: number;
  76892. /**
  76893. * (Highcharts, Highstock) The maximal Y offset for the random jitter
  76894. * effect.
  76895. */
  76896. y?: number;
  76897. }
  76898. /**
  76899. * (Highcharts) A 3D scatter plot uses x, y and z coordinates to display values
  76900. * for three variables for a set of data.
  76901. *
  76902. * In TypeScript the type option must always be set.
  76903. *
  76904. * Configuration options for the series are given in three levels:
  76905. *
  76906. * 1. Options for all series in a chart are defined in the plotOptions.series
  76907. * object.
  76908. *
  76909. * 2. Options for all `scatter3d` series are defined in plotOptions.scatter3d.
  76910. *
  76911. * 3. Options for one single series are given in the series instance array. (see
  76912. * online documentation for example)
  76913. */
  76914. export interface PlotScatter3dOptions {
  76915. /**
  76916. * (Highcharts) Accessibility options for a series.
  76917. */
  76918. accessibility?: SeriesAccessibilityOptionsObject;
  76919. /**
  76920. * (Highmaps) Whether all areas of the map defined in `mapData` should be
  76921. * rendered. If `true`, areas which don't correspond to a data point, are
  76922. * rendered as `null` points. If `false`, those areas are skipped.
  76923. */
  76924. allAreas?: boolean;
  76925. /**
  76926. * (Highcharts) Allow this series' points to be selected by clicking on the
  76927. * graphic (columns, point markers, pie slices, map areas etc).
  76928. *
  76929. * The selected points can be handled by point select and unselect events,
  76930. * or collectively by the getSelectedPoints function.
  76931. *
  76932. * And alternative way of selecting points is through dragging.
  76933. */
  76934. allowPointSelect?: boolean;
  76935. /**
  76936. * (Highcharts) Enable or disable the initial animation when a series is
  76937. * displayed. The animation can also be set as a configuration object.
  76938. * Please note that this option only applies to the initial animation of the
  76939. * series itself. For other animations, see chart.animation and the
  76940. * animation parameter under the API methods. The following properties are
  76941. * supported:
  76942. *
  76943. * - `defer`: The animation delay time in milliseconds.
  76944. *
  76945. * - `duration`: The duration of the animation in milliseconds.
  76946. *
  76947. * - `easing`: Can be a string reference to an easing function set on the
  76948. * `Math` object or a function. See the _Custom easing function_ demo below.
  76949. *
  76950. * Due to poor performance, animation is disabled in old IE browsers for
  76951. * several chart types.
  76952. */
  76953. animation?: (boolean|PlotScatter3dAnimationOptions|Partial<AnimationOptionsObject>);
  76954. /**
  76955. * (Highcharts) For some series, there is a limit that shuts down initial
  76956. * animation by default when the total number of points in the chart is too
  76957. * high. For example, for a column chart and its derivatives, animation does
  76958. * not run if there is more than 250 points totally. To disable this cap,
  76959. * set `animationLimit` to `Infinity`.
  76960. */
  76961. animationLimit?: number;
  76962. /**
  76963. * (Highmaps) The border color of the map areas.
  76964. *
  76965. * In styled mode, the border stroke is given in the `.highcharts-point`
  76966. * class.
  76967. */
  76968. borderColor?: (ColorString|GradientColorObject|PatternObject);
  76969. /**
  76970. * (Highmaps) The border width of each map area.
  76971. *
  76972. * In styled mode, the border stroke width is given in the
  76973. * `.highcharts-point` class.
  76974. */
  76975. borderWidth?: number;
  76976. /**
  76977. * (Highcharts) An additional class name to apply to the series' graphical
  76978. * elements. This option does not replace default class names of the
  76979. * graphical element.
  76980. */
  76981. className?: string;
  76982. /**
  76983. * (Highcharts) Disable this option to allow series rendering in the whole
  76984. * plotting area.
  76985. *
  76986. * **Note:** Clipping should be always enabled when chart.zoomType is set
  76987. */
  76988. clip?: boolean;
  76989. /**
  76990. * (Highcharts) The main color of the series. In line type series it applies
  76991. * to the line and the point markers unless otherwise specified. In bar type
  76992. * series it applies to the bars unless a color is specified per point. The
  76993. * default value is pulled from the `options.colors` array.
  76994. *
  76995. * In styled mode, the color can be defined by the colorIndex option. Also,
  76996. * the series color can be set with the `.highcharts-series`,
  76997. * `.highcharts-color-{n}`, `.highcharts-{type}-series` or
  76998. * `.highcharts-series-{n}` class, or individual classes given by the
  76999. * `className` option.
  77000. */
  77001. color?: (ColorString|GradientColorObject|PatternObject);
  77002. /**
  77003. * (Highcharts, Highstock, Highmaps) When using dual or multiple color axes,
  77004. * this number defines which colorAxis the particular series is connected
  77005. * to. It refers to either the axis id or the index of the axis in the
  77006. * colorAxis array, with 0 being the first. Set this option to false to
  77007. * prevent a series from connecting to the default color axis.
  77008. *
  77009. * Since v7.2.0 the option can also be an axis id or an axis index instead
  77010. * of a boolean flag.
  77011. */
  77012. colorAxis?: (boolean|number|string);
  77013. /**
  77014. * (Highcharts) Styled mode only. A specific color index to use for the
  77015. * series, so its graphic representations are given the class name
  77016. * `highcharts-color-{n}`.
  77017. */
  77018. colorIndex?: number;
  77019. /**
  77020. * (Highcharts, Highstock, Highmaps) Determines what data value should be
  77021. * used to calculate point color if `colorAxis` is used. Requires to set
  77022. * `min` and `max` if some custom point property is used or if approximation
  77023. * for data grouping is set to `'sum'`.
  77024. */
  77025. colorKey?: string;
  77026. /**
  77027. * (Highstock) Compare the values of the series against the first non-null,
  77028. * non- zero value in the visible range. The y axis will show percentage or
  77029. * absolute change depending on whether `compare` is set to `"percent"` or
  77030. * `"value"`. When this is applied to multiple series, it allows comparing
  77031. * the development of the series against each other. Adds a `change` field
  77032. * to every point object.
  77033. */
  77034. compare?: string;
  77035. /**
  77036. * (Highstock) When compare is `percent`, this option dictates whether to
  77037. * use 0 or 100 as the base of comparison.
  77038. */
  77039. compareBase?: (0|100);
  77040. /**
  77041. * (Highstock) Defines if comparison should start from the first point
  77042. * within the visible range or should start from the first point **before**
  77043. * the range.
  77044. *
  77045. * In other words, this flag determines if first point within the visible
  77046. * range will have 0% (`compareStart=true`) or should have been already
  77047. * calculated according to the previous point (`compareStart=false`).
  77048. */
  77049. compareStart?: boolean;
  77050. /**
  77051. * (Highcharts) Polar charts only. Whether to connect the ends of a line
  77052. * series plot across the extremes.
  77053. */
  77054. connectEnds?: boolean;
  77055. /**
  77056. * (Highcharts, Highstock) Whether to connect a graph line across null
  77057. * points, or render a gap between the two points on either side of the
  77058. * null.
  77059. */
  77060. connectNulls?: boolean;
  77061. /**
  77062. * (Gantt) Override Pathfinder connector options for a series. Requires
  77063. * Highcharts Gantt to be loaded.
  77064. */
  77065. connectors?: SeriesConnectorsOptionsObject;
  77066. /**
  77067. * (Highcharts, Highstock, Gantt) When true, each point or column edge is
  77068. * rounded to its nearest pixel in order to render sharp on screen. In some
  77069. * cases, when there are a lot of densely packed columns, this leads to
  77070. * visible difference in column widths or distance between columns. In these
  77071. * cases, setting `crisp` to `false` may look better, even though each
  77072. * column is rendered blurry.
  77073. */
  77074. crisp?: boolean;
  77075. /**
  77076. * (Highcharts) You can set the cursor to "pointer" if you have click events
  77077. * attached to the series, to signal to the user that the points and lines
  77078. * can be clicked.
  77079. *
  77080. * In styled mode, the series cursor can be set with the same classes as
  77081. * listed under series.color.
  77082. */
  77083. cursor?: (string|CursorValue);
  77084. /**
  77085. * (Highcharts) A reserved subspace to store options and values for
  77086. * customized functionality. Here you can add additional data for your own
  77087. * event callbacks and formatter callbacks.
  77088. */
  77089. custom?: Dictionary<any>;
  77090. /**
  77091. * (Highcharts) Name of the dash style to use for the graph, or for some
  77092. * series types the outline of each shape.
  77093. *
  77094. * In styled mode, the stroke dash-array can be set with the same classes as
  77095. * listed under series.color.
  77096. */
  77097. dashStyle?: DashStyleValue;
  77098. /**
  77099. * (Highstock) Data grouping is the concept of sampling the data values into
  77100. * larger blocks in order to ease readability and increase performance of
  77101. * the JavaScript charts. Highstock by default applies data grouping when
  77102. * the points become closer than a certain pixel value, determined by the
  77103. * `groupPixelWidth` option.
  77104. *
  77105. * If data grouping is applied, the grouping information of grouped points
  77106. * can be read from the Point.dataGroup. If point options other than the
  77107. * data itself are set, for example `name` or `color` or custom properties,
  77108. * the grouping logic doesn't know how to group it. In this case the options
  77109. * of the first point instance are copied over to the group point. This can
  77110. * be altered through a custom `approximation` callback function.
  77111. */
  77112. dataGrouping?: DataGroupingOptionsObject;
  77113. /**
  77114. * (Highcharts, Highstock, Highmaps, Gantt) Options for the series data
  77115. * labels, appearing next to each data point.
  77116. *
  77117. * Since v6.2.0, multiple data labels can be applied to each single point by
  77118. * defining them as an array of configs.
  77119. *
  77120. * In styled mode, the data labels can be styled with the
  77121. * `.highcharts-data-label-box` and `.highcharts-data-label` class names
  77122. * (see example).
  77123. */
  77124. dataLabels?: (PlotScatter3dDataLabelsOptions|Array<PlotScatter3dDataLabelsOptions>);
  77125. /**
  77126. * (Highcharts, Highstock) Options for the series data sorting.
  77127. */
  77128. dataSorting?: (DataSortingOptionsObject|PlotScatter3dDataSortingOptions);
  77129. /**
  77130. * (Highcharts) A description of the series to add to the screen reader
  77131. * information about the series.
  77132. */
  77133. description?: string;
  77134. /**
  77135. * (Highcharts) Enable or disable the mouse tracking for a specific series.
  77136. * This includes point tooltips and click events on graphs and points. For
  77137. * large datasets it improves performance.
  77138. */
  77139. enableMouseTracking?: boolean;
  77140. /**
  77141. * (Highcharts) General event handlers for the series items. These event
  77142. * hooks can also be attached to the series at run time using the
  77143. * `Highcharts.addEvent` function.
  77144. */
  77145. events?: SeriesEventsOptionsObject;
  77146. /**
  77147. * (Highcharts) Determines whether the series should look for the nearest
  77148. * point in both dimensions or just the x-dimension when hovering the
  77149. * series. Defaults to `'xy'` for scatter series and `'x'` for most other
  77150. * series. If the data has duplicate x-values, it is recommended to set this
  77151. * to `'xy'` to allow hovering over all points.
  77152. *
  77153. * Applies only to series types using nearest neighbor search (not direct
  77154. * hover) for tooltip.
  77155. */
  77156. findNearestPointBy?: OptionsFindNearestPointByValue;
  77157. /**
  77158. * (Highstock) Defines when to display a gap in the graph, together with the
  77159. * gapUnit option.
  77160. *
  77161. * In case when `dataGrouping` is enabled, points can be grouped into a
  77162. * larger time span. This can make the grouped points to have a greater
  77163. * distance than the absolute value of `gapSize` property, which will result
  77164. * in disappearing graph completely. To prevent this situation the mentioned
  77165. * distance between grouped points is used instead of previously defined
  77166. * `gapSize`.
  77167. *
  77168. * In practice, this option is most often used to visualize gaps in time
  77169. * series. In a stock chart, intraday data is available for daytime hours,
  77170. * while gaps will appear in nights and weekends.
  77171. */
  77172. gapSize?: number;
  77173. /**
  77174. * (Highstock) Together with gapSize, this option defines where to draw gaps
  77175. * in the graph.
  77176. *
  77177. * When the `gapUnit` is `"relative"` (default), a gap size of 5 means that
  77178. * if the distance between two points is greater than 5 times that of the
  77179. * two closest points, the graph will be broken.
  77180. *
  77181. * When the `gapUnit` is `"value"`, the gap is based on absolute axis
  77182. * values, which on a datetime axis is milliseconds. This also applies to
  77183. * the navigator series that inherits gap options from the base series.
  77184. */
  77185. gapUnit?: OptionsGapUnitValue;
  77186. /**
  77187. * (Highcharts, Highstock, Gantt) Whether to use the Y extremes of the total
  77188. * chart width or only the zoomed area when zooming in on parts of the X
  77189. * axis. By default, the Y axis adjusts to the min and max of the visible
  77190. * data. Cartesian series only.
  77191. */
  77192. getExtremesFromAll?: boolean;
  77193. /**
  77194. * (Highcharts) When set to `false` will prevent the series data from being
  77195. * included in any form of data export.
  77196. *
  77197. * Since version 6.0.0 until 7.1.0 the option was existing undocumented as
  77198. * `includeInCSVExport`.
  77199. */
  77200. includeInDataExport?: boolean;
  77201. /**
  77202. * (Highcharts, Highstock) Apply a jitter effect for the rendered markers.
  77203. * When plotting discrete values, a little random noise may help telling the
  77204. * points apart. The jitter setting applies a random displacement of up to
  77205. * `n` axis units in either direction. So for example on a horizontal X
  77206. * axis, setting the `jitter.x` to 0.24 will render the point in a random
  77207. * position between 0.24 units to the left and 0.24 units to the right of
  77208. * the true axis position. On a category axis, setting it to 0.5 will fill
  77209. * up the bin and make the data appear continuous.
  77210. *
  77211. * When rendered on top of a box plot or a column series, a jitter value of
  77212. * 0.24 will correspond to the underlying series' default groupPadding and
  77213. * pointPadding settings.
  77214. */
  77215. jitter?: PlotScatter3dJitterOptions;
  77216. /**
  77217. * (Highmaps) What property to join the `mapData` to the value data. For
  77218. * example, if joinBy is "code", the mapData items with a specific code is
  77219. * merged into the data with the same code. For maps loaded from GeoJSON,
  77220. * the keys may be held in each point's `properties` object.
  77221. *
  77222. * The joinBy option can also be an array of two values, where the first
  77223. * points to a key in the `mapData`, and the second points to another key in
  77224. * the `data`.
  77225. *
  77226. * When joinBy is `null`, the map items are joined by their position in the
  77227. * array, which performs much better in maps with many data points. This is
  77228. * the recommended option if you are printing more than a thousand data
  77229. * points and have a backend that can preprocess the data into a parallel
  77230. * array of the mapData.
  77231. */
  77232. joinBy?: (string|Array<string>);
  77233. /**
  77234. * (Highcharts) An array specifying which option maps to which key in the
  77235. * data point array. This makes it convenient to work with unstructured data
  77236. * arrays from different sources.
  77237. */
  77238. keys?: Array<string>;
  77239. /**
  77240. * (Highcharts, Highstock, Gantt) Series labels are placed as close to the
  77241. * series as possible in a natural way, seeking to avoid other series. The
  77242. * goal of this feature is to make the chart more easily readable, like if a
  77243. * human designer placed the labels in the optimal position.
  77244. *
  77245. * The series labels currently work with series types having a `graph` or an
  77246. * `area`.
  77247. */
  77248. label?: SeriesLabelOptionsObject;
  77249. /**
  77250. * (Highstock) The line marks the last price from all points.
  77251. */
  77252. lastPrice?: SeriesLastPriceOptionsObject;
  77253. /**
  77254. * (Highstock) The line marks the last price from visible range of points.
  77255. */
  77256. lastVisiblePrice?: SeriesLastVisiblePriceOptionsObject;
  77257. /**
  77258. * (Highcharts, Highstock) The SVG value used for the `stroke-linecap` and
  77259. * `stroke-linejoin` of a line graph. Round means that lines are rounded in
  77260. * the ends and bends.
  77261. */
  77262. linecap?: SeriesLinecapValue;
  77263. /**
  77264. * (Highcharts, Highstock) The width of the line connecting the data points.
  77265. */
  77266. lineWidth?: number;
  77267. /**
  77268. * (Highcharts, Highstock, Gantt) The id of another series to link to.
  77269. * Additionally, the value can be ":previous" to link to the previous
  77270. * series. When two series are linked, only the first one appears in the
  77271. * legend. Toggling the visibility of this also toggles the linked series.
  77272. *
  77273. * If master series uses data sorting and linked series does not have its
  77274. * own sorting definition, the linked series will be sorted in the same
  77275. * order as the master one.
  77276. */
  77277. linkedTo?: string;
  77278. /**
  77279. * (Highcharts) Options for the point markers of line-like series.
  77280. * Properties like `fillColor`, `lineColor` and `lineWidth` define the
  77281. * visual appearance of the markers. Other series types, like column series,
  77282. * don't have markers, but have visual options on the series level instead.
  77283. *
  77284. * In styled mode, the markers can be styled with the `.highcharts-point`,
  77285. * `.highcharts-point-hover` and `.highcharts-point-select` class names.
  77286. */
  77287. marker?: PointMarkerOptionsObject;
  77288. /**
  77289. * (Highstock) Options for the corresponding navigator series if
  77290. * `showInNavigator` is `true` for this series. Available options are the
  77291. * same as any series, documented at plotOptions and series.
  77292. *
  77293. * These options are merged with options in navigator.series, and will take
  77294. * precedence if the same option is defined both places.
  77295. */
  77296. navigatorOptions?: PlotSeriesOptions;
  77297. /**
  77298. * (Highcharts) The color for the parts of the graph or points that are
  77299. * below the threshold. Note that `zones` takes precedence over the negative
  77300. * color. Using `negativeColor` is equivalent to applying a zone with value
  77301. * of 0.
  77302. */
  77303. negativeColor?: (ColorString|GradientColorObject|PatternObject);
  77304. /**
  77305. * (Highcharts) Opacity of a series parts: line, fill (e.g. area) and
  77306. * dataLabels.
  77307. */
  77308. opacity?: number;
  77309. /**
  77310. * (Highcharts) Properties for each single point.
  77311. */
  77312. point?: PlotSeriesPointOptions;
  77313. /**
  77314. * (Highcharts) Same as accessibility.pointDescriptionFormatter, but for an
  77315. * individual series. Overrides the chart wide configuration.
  77316. */
  77317. pointDescriptionFormatter?: Function;
  77318. /**
  77319. * (Highcharts, Highstock, Gantt) If no x values are given for the points in
  77320. * a series, `pointInterval` defines the interval of the x values. For
  77321. * example, if a series contains one value every decade starting from year
  77322. * 0, set `pointInterval` to `10`. In true `datetime` axes, the
  77323. * `pointInterval` is set in milliseconds.
  77324. *
  77325. * It can be also be combined with `pointIntervalUnit` to draw irregular
  77326. * time intervals.
  77327. *
  77328. * Please note that this options applies to the _series data_, not the
  77329. * interval of the axis ticks, which is independent.
  77330. */
  77331. pointInterval?: number;
  77332. /**
  77333. * (Highcharts, Highstock, Gantt) On datetime series, this allows for
  77334. * setting the pointInterval to irregular time units, `day`, `month` and
  77335. * `year`. A day is usually the same as 24 hours, but `pointIntervalUnit`
  77336. * also takes the DST crossover into consideration when dealing with local
  77337. * time. Combine this option with `pointInterval` to draw weeks, quarters, 6
  77338. * months, 10 years etc.
  77339. *
  77340. * Please note that this options applies to the _series data_, not the
  77341. * interval of the axis ticks, which is independent.
  77342. */
  77343. pointIntervalUnit?: OptionsPointIntervalUnitValue;
  77344. /**
  77345. * (Highstock) The width of each point on the x axis. For example in a
  77346. * column chart with one value each day, the pointRange would be 1 day (= 24
  77347. * * 3600
  77348. *
  77349. * * 1000 milliseconds). This is normally computed automatically, but this
  77350. * option can be used to override the automatic value.
  77351. */
  77352. pointRange?: number;
  77353. /**
  77354. * (Highcharts, Highstock, Gantt) If no x values are given for the points in
  77355. * a series, pointStart defines on what value to start. For example, if a
  77356. * series contains one yearly value starting from 1945, set pointStart to
  77357. * 1945.
  77358. */
  77359. pointStart?: number;
  77360. /**
  77361. * (Highcharts) Whether to select the series initially. If `showCheckbox` is
  77362. * true, the checkbox next to the series name in the legend will be checked
  77363. * for a selected series.
  77364. */
  77365. selected?: boolean;
  77366. /**
  77367. * (Highcharts) If true, a checkbox is displayed next to the legend item to
  77368. * allow selecting the series. The state of the checkbox is determined by
  77369. * the `selected` option.
  77370. */
  77371. showCheckbox?: boolean;
  77372. /**
  77373. * (Highcharts) Whether to display this particular series or series type in
  77374. * the legend. Standalone series are shown in legend by default, and linked
  77375. * series are not. Since v7.2.0 it is possible to show series that use
  77376. * colorAxis by setting this option to `true`.
  77377. */
  77378. showInLegend?: boolean;
  77379. /**
  77380. * (Highstock) Whether or not to show the series in the navigator. Takes
  77381. * precedence over navigator.baseSeries if defined.
  77382. */
  77383. showInNavigator?: boolean;
  77384. /**
  77385. * (Highcharts) If set to `true`, the accessibility module will skip past
  77386. * the points in this series for keyboard navigation.
  77387. */
  77388. skipKeyboardNavigation?: boolean;
  77389. /**
  77390. * (Highcharts, Highstock) When this is true, the series will not cause the
  77391. * Y axis to cross the zero plane (or threshold option) unless the data
  77392. * actually crosses the plane.
  77393. *
  77394. * For example, if `softThreshold` is `false`, a series of 0, 1, 2, 3 will
  77395. * make the Y axis show negative values according to the `minPadding`
  77396. * option. If `softThreshold` is `true`, the Y axis starts at 0.
  77397. */
  77398. softThreshold?: boolean;
  77399. /**
  77400. * (Highcharts, Highstock) Whether to stack the values of each series on top
  77401. * of each other. Possible values are `undefined` to disable, `"normal"` to
  77402. * stack by value or `"percent"`.
  77403. *
  77404. * When stacking is enabled, data must be sorted in ascending X order.
  77405. *
  77406. * Some stacking options are related to specific series types. In the
  77407. * streamgraph series type, the stacking option is set to `"stream"`. The
  77408. * second one is `"overlap"`, which only applies to waterfall series.
  77409. */
  77410. stacking?: OptionsStackingValue;
  77411. states?: SeriesStatesOptionsObject;
  77412. /**
  77413. * (Highcharts, Highstock) Whether to apply steps to the line. Possible
  77414. * values are `left`, `center` and `right`.
  77415. */
  77416. step?: OptionsStepValue;
  77417. /**
  77418. * (Highcharts, Highstock) Sticky tracking of mouse events. When true, the
  77419. * `mouseOut` event on a series isn't triggered until the mouse moves over
  77420. * another series, or out of the plot area. When false, the `mouseOut` event
  77421. * on a series is triggered when the mouse leaves the area around the
  77422. * series' graph or markers. This also implies the tooltip. When
  77423. * `stickyTracking` is false and `tooltip.shared` is false, the tooltip will
  77424. * be hidden when moving the mouse between series.
  77425. */
  77426. stickyTracking?: boolean;
  77427. /**
  77428. * (Highcharts, Highstock) The threshold, also called zero level or base
  77429. * level. For line type series this is only used in conjunction with
  77430. * negativeColor.
  77431. */
  77432. threshold?: (number|null);
  77433. /**
  77434. * (Highcharts, Highstock) A configuration object for the tooltip rendering
  77435. * of each single series. Properties are inherited from tooltip. Overridable
  77436. * properties are `headerFormat`, `pointFormat`, `yDecimals`, `xDateFormat`,
  77437. * `yPrefix` and `ySuffix`. Unlike other series, in a scatter plot the
  77438. * series.name by default shows in the headerFormat and point.x and point.y
  77439. * in the pointFormat.
  77440. */
  77441. tooltip?: SeriesTooltipOptionsObject;
  77442. /**
  77443. * (Highcharts, Highstock, Gantt) When a series contains a data array that
  77444. * is longer than this, only one dimensional arrays of numbers, or two
  77445. * dimensional arrays with x and y values are allowed. Also, only the first
  77446. * point is tested, and the rest are assumed to be the same format. This
  77447. * saves expensive data checking and indexing in long series. Set it to `0`
  77448. * disable.
  77449. *
  77450. * Note: In boost mode turbo threshold is forced. Only array of numbers or
  77451. * two dimensional arrays are allowed.
  77452. */
  77453. turboThreshold?: number;
  77454. /**
  77455. * (Highcharts) Set the initial visibility of the series.
  77456. */
  77457. visible?: boolean;
  77458. /**
  77459. * (Highmaps) Define the z index of the series.
  77460. */
  77461. zIndex?: number;
  77462. /**
  77463. * (Highcharts, Highstock) Defines the Axis on which the zones are applied.
  77464. */
  77465. zoneAxis?: string;
  77466. /**
  77467. * (Highcharts, Highstock) An array defining zones within a series. Zones
  77468. * can be applied to the X axis, Y axis or Z axis for bubbles, according to
  77469. * the `zoneAxis` option. The zone definitions have to be in ascending order
  77470. * regarding to the value.
  77471. *
  77472. * In styled mode, the color zones are styled with the
  77473. * `.highcharts-zone-{n}` class, or custom classed from the `className`
  77474. * option (view live demo).
  77475. */
  77476. zones?: Array<SeriesZonesOptionsObject>;
  77477. }
  77478. /**
  77479. * (Highcharts, Highstock) Enable or disable the initial animation when a series
  77480. * is displayed. The animation can also be set as a configuration object. Please
  77481. * note that this option only applies to the initial animation of the series
  77482. * itself. For other animations, see chart.animation and the animation parameter
  77483. * under the API methods. The following properties are supported:
  77484. *
  77485. * - `defer`: The animation delay time in milliseconds.
  77486. *
  77487. * - `duration`: The duration of the animation in milliseconds.
  77488. *
  77489. * - `easing`: Can be a string reference to an easing function set on the `Math`
  77490. * object or a function. See the _Custom easing function_ demo below.
  77491. *
  77492. * Due to poor performance, animation is disabled in old IE browsers for several
  77493. * chart types.
  77494. */
  77495. export interface PlotScatterAnimationOptions {
  77496. defer?: number;
  77497. }
  77498. export interface PlotScatterClusterEventsOptions {
  77499. /**
  77500. * (Highcharts, Highmaps) Fires when the cluster point is clicked and
  77501. * `drillToCluster` is enabled. One parameter, `event`, is passed to the
  77502. * function. The default action is to zoom to the cluster points range. This
  77503. * can be prevented by calling `event.preventDefault()`.
  77504. */
  77505. drillToCluster?: MarkerClusterDrillCallbackFunction;
  77506. }
  77507. /**
  77508. * (Highcharts, Highmaps) Options for layout algorithm. Inside there are options
  77509. * to change the type of the algorithm, gridSize, distance or iterations.
  77510. */
  77511. export interface PlotScatterClusterLayoutAlgorithmOptions {
  77512. /**
  77513. * (Highcharts, Highmaps) When `type` is set to `kmeans`, `distance` is a
  77514. * maximum distance between point and cluster center so that this point will
  77515. * be inside the cluster. The distance is either a number defining pixels or
  77516. * a percentage defining a percentage of the plot area width.
  77517. */
  77518. distance?: (number|string);
  77519. /**
  77520. * (Highcharts, Highmaps) When `type` is set to the `grid`, `gridSize` is a
  77521. * size of a grid square element either as a number defining pixels, or a
  77522. * percentage defining a percentage of the plot area width.
  77523. */
  77524. gridSize?: (number|string);
  77525. /**
  77526. * (Highcharts, Highmaps) When `type` is set to `kmeans`, `iterations` are
  77527. * the number of iterations that this algorithm will be repeated to find
  77528. * clusters positions.
  77529. */
  77530. iterations?: number;
  77531. /**
  77532. * (Highcharts, Highmaps) When `type` is set to `undefined` and there are
  77533. * more visible points than the kmeansThreshold the `grid` algorithm is used
  77534. * to find clusters, otherwise `kmeans`. It ensures good performance on
  77535. * large datasets and better clusters arrangement after the zoom.
  77536. */
  77537. kmeansThreshold?: number;
  77538. /**
  77539. * (Highcharts, Highmaps) Type of the algorithm used to combine points into
  77540. * a cluster. There are three available algorithms:
  77541. *
  77542. * 1) `grid` - grid-based clustering technique. Points are assigned to
  77543. * squares of set size depending on their position on the plot area. Points
  77544. * inside the grid square are combined into a cluster. The grid size can be
  77545. * controlled by `gridSize` property (grid size changes at certain zoom
  77546. * levels).
  77547. *
  77548. * 2) `kmeans` - based on K-Means clustering technique. In the first step,
  77549. * points are divided using the grid method (distance property is a grid
  77550. * size) to find the initial amount of clusters. Next, each point is
  77551. * classified by computing the distance between each cluster center and that
  77552. * point. When the closest cluster distance is lower than distance property
  77553. * set by a user the point is added to this cluster otherwise is classified
  77554. * as `noise`. The algorithm is repeated until each cluster center not
  77555. * change its previous position more than one pixel. This technique is more
  77556. * accurate but also more time consuming than the `grid` algorithm,
  77557. * especially for big datasets.
  77558. *
  77559. * 3) `optimizedKmeans` - based on K-Means clustering technique. This
  77560. * algorithm uses k-means algorithm only on the chart initialization or when
  77561. * chart extremes have greater range than on initialization. When a chart is
  77562. * redrawn the algorithm checks only clustered points distance from the
  77563. * cluster center and rebuild it when the point is spaced enough to be
  77564. * outside the cluster. It provides performance improvement and more stable
  77565. * clusters position yet can be used rather on small and sparse datasets.
  77566. *
  77567. * By default, the algorithm depends on visible quantity of points and
  77568. * `kmeansThreshold`. When there are more visible points than the
  77569. * `kmeansThreshold` the `grid` algorithm is used, otherwise `kmeans`.
  77570. *
  77571. * The custom clustering algorithm can be added by assigning a callback
  77572. * function as the type property. This function takes an array of
  77573. * `processedXData`, `processedYData`, `processedXData` indexes and
  77574. * `layoutAlgorithm` options as arguments and should return an object with
  77575. * grouped data.
  77576. *
  77577. * The algorithm should return an object like that: (see online
  77578. * documentation for example)
  77579. *
  77580. * `clusterId` (example above - unique id of a cluster or noise) is an array
  77581. * of points belonging to a cluster. If the array has only one point or
  77582. * fewer points than set in `cluster.minimumClusterSize` it won't be
  77583. * combined into a cluster.
  77584. */
  77585. type?: (string|Function);
  77586. }
  77587. /**
  77588. * (Highcharts, Highmaps) Options for marker clusters, the concept of sampling
  77589. * the data values into larger blocks in order to ease readability and increase
  77590. * performance of the JavaScript charts.
  77591. *
  77592. * Note: marker clusters module is not working with `boost` and
  77593. * `draggable-points` modules.
  77594. *
  77595. * The marker clusters feature requires the marker-clusters.js file to be
  77596. * loaded, found in the modules directory of the download package, or online at
  77597. * code.highcharts.com/modules/marker-clusters.js.
  77598. */
  77599. export interface PlotScatterClusterOptions {
  77600. /**
  77601. * (Highcharts, Highmaps) When set to `false` prevent cluster overlapping -
  77602. * this option works only when `layoutAlgorithm.type = "grid"`.
  77603. */
  77604. allowOverlap?: boolean;
  77605. /**
  77606. * (Highcharts, Highmaps) Options for the cluster marker animation.
  77607. */
  77608. animation?: (boolean|Partial<AnimationOptionsObject>);
  77609. /**
  77610. * (Highcharts, Highmaps) Options for the cluster data labels.
  77611. */
  77612. dataLabels?: DataLabelsOptions;
  77613. /**
  77614. * (Highcharts, Highmaps) Zoom the plot area to the cluster points range
  77615. * when a cluster is clicked.
  77616. */
  77617. drillToCluster?: boolean;
  77618. /**
  77619. * (Highcharts, Highmaps) Whether to enable the marker-clusters module.
  77620. */
  77621. enabled?: boolean;
  77622. events?: PlotScatterClusterEventsOptions;
  77623. /**
  77624. * (Highcharts, Highmaps) Options for layout algorithm. Inside there are
  77625. * options to change the type of the algorithm, gridSize, distance or
  77626. * iterations.
  77627. */
  77628. layoutAlgorithm?: PlotScatterClusterLayoutAlgorithmOptions;
  77629. /**
  77630. * (Highcharts, Highmaps) Options for the cluster marker.
  77631. */
  77632. marker?: PointMarkerOptionsObject;
  77633. /**
  77634. * (Highcharts, Highmaps) The minimum amount of points to be combined into a
  77635. * cluster. This value has to be greater or equal to 2.
  77636. */
  77637. minimumClusterSize?: number;
  77638. states?: PlotScatterClusterStatesOptions;
  77639. /**
  77640. * (Highcharts, Highmaps) An array defining zones within marker clusters.
  77641. *
  77642. * In styled mode, the color zones are styled with the
  77643. * `.highcharts-cluster-zone-{n}` class, or custom classed from the
  77644. * `className` option.
  77645. */
  77646. zones?: Array<PlotScatterClusterZonesOptions>;
  77647. }
  77648. export interface PlotScatterClusterStatesHoverOptions {
  77649. /**
  77650. * (Highcharts, Highmaps) The fill color of the cluster marker in hover
  77651. * state. When `undefined`, the series' or point's fillColor for normal
  77652. * state is used.
  77653. */
  77654. fillColor?: ColorType;
  77655. }
  77656. export interface PlotScatterClusterStatesOptions {
  77657. hover?: PlotScatterClusterStatesHoverOptions;
  77658. }
  77659. /**
  77660. * (Highcharts, Highmaps) An array defining zones within marker clusters.
  77661. *
  77662. * In styled mode, the color zones are styled with the
  77663. * `.highcharts-cluster-zone-{n}` class, or custom classed from the `className`
  77664. * option.
  77665. */
  77666. export interface PlotScatterClusterZonesOptions {
  77667. /**
  77668. * (Highcharts, Highmaps) Styled mode only. A custom class name for the
  77669. * zone.
  77670. */
  77671. className?: string;
  77672. /**
  77673. * (Highcharts, Highmaps) The value where the zone starts.
  77674. */
  77675. from?: number;
  77676. /**
  77677. * (Highcharts, Highmaps) Settings for the cluster marker belonging to the
  77678. * zone.
  77679. */
  77680. marker?: PointMarkerOptionsObject;
  77681. /**
  77682. * (Highcharts, Highmaps) The value where the zone ends.
  77683. */
  77684. to?: number;
  77685. }
  77686. /**
  77687. * (Highcharts, Highstock, Highmaps, Gantt) Enable or disable the initial
  77688. * animation when a series is displayed for the `dataLabels`. The animation can
  77689. * also be set as a configuration object. Please note that this option only
  77690. * applies to the initial animation. For other animations, see chart.animation
  77691. * and the animation parameter under the API methods. The following properties
  77692. * are supported:
  77693. *
  77694. * - `defer`: The animation delay time in milliseconds.
  77695. */
  77696. export interface PlotScatterDataLabelsAnimationOptions {
  77697. /**
  77698. * (Highcharts, Highstock, Highmaps, Gantt) The animation delay time in
  77699. * milliseconds. Set to `0` renders dataLabel immediately. As `undefined`
  77700. * inherits defer time from the series.animation.defer.
  77701. */
  77702. defer?: number;
  77703. }
  77704. /**
  77705. * (Highcharts, Highstock, Highmaps, Gantt) Options for the series data labels,
  77706. * appearing next to each data point.
  77707. *
  77708. * Since v6.2.0, multiple data labels can be applied to each single point by
  77709. * defining them as an array of configs.
  77710. *
  77711. * In styled mode, the data labels can be styled with the
  77712. * `.highcharts-data-label-box` and `.highcharts-data-label` class names (see
  77713. * example).
  77714. */
  77715. export interface PlotScatterDataLabelsOptions {
  77716. /**
  77717. * (Highcharts, Highstock, Highmaps, Gantt) The alignment of the data label
  77718. * compared to the point. If `right`, the right side of the label should be
  77719. * touching the point. For points with an extent, like columns, the
  77720. * alignments also dictates how to align it inside the box, as given with
  77721. * the inside option. Can be one of `left`, `center` or `right`.
  77722. */
  77723. align?: (AlignValue|null);
  77724. /**
  77725. * (Highcharts, Highstock, Highmaps, Gantt) Whether to allow data labels to
  77726. * overlap. To make the labels less sensitive for overlapping, the
  77727. * dataLabels.padding can be set to 0.
  77728. */
  77729. allowOverlap?: boolean;
  77730. /**
  77731. * (Highcharts, Highstock, Highmaps, Gantt) Enable or disable the initial
  77732. * animation when a series is displayed for the `dataLabels`. The animation
  77733. * can also be set as a configuration object. Please note that this option
  77734. * only applies to the initial animation. For other animations, see
  77735. * chart.animation and the animation parameter under the API methods. The
  77736. * following properties are supported:
  77737. *
  77738. * - `defer`: The animation delay time in milliseconds.
  77739. */
  77740. animation?: (boolean|PlotScatterDataLabelsAnimationOptions|Partial<AnimationOptionsObject>);
  77741. /**
  77742. * (Highcharts, Highstock, Highmaps, Gantt) The background color or gradient
  77743. * for the data label.
  77744. */
  77745. backgroundColor?: (ColorString|GradientColorObject|PatternObject);
  77746. /**
  77747. * (Highcharts, Highstock, Highmaps, Gantt) The border color for the data
  77748. * label. Defaults to `undefined`.
  77749. */
  77750. borderColor?: (ColorString|GradientColorObject|PatternObject);
  77751. /**
  77752. * (Highcharts, Highstock, Highmaps, Gantt) The border radius in pixels for
  77753. * the data label.
  77754. */
  77755. borderRadius?: number;
  77756. /**
  77757. * (Highcharts, Highstock, Highmaps, Gantt) The border width in pixels for
  77758. * the data label.
  77759. */
  77760. borderWidth?: number;
  77761. /**
  77762. * (Highcharts, Highstock, Highmaps, Gantt) A class name for the data label.
  77763. * Particularly in styled mode, this can be used to give each series' or
  77764. * point's data label unique styling. In addition to this option, a default
  77765. * color class name is added so that we can give the labels a contrast text
  77766. * shadow.
  77767. */
  77768. className?: string;
  77769. /**
  77770. * (Highcharts, Highstock, Highmaps, Gantt) The text color for the data
  77771. * labels. Defaults to `undefined`. For certain series types, like column or
  77772. * map, the data labels can be drawn inside the points. In this case the
  77773. * data label will be drawn with maximum contrast by default. Additionally,
  77774. * it will be given a `text-outline` style with the opposite color, to
  77775. * further increase the contrast. This can be overridden by setting the
  77776. * `text-outline` style to `none` in the `dataLabels.style` option.
  77777. */
  77778. color?: (ColorString|GradientColorObject|PatternObject);
  77779. /**
  77780. * (Highcharts, Highstock, Highmaps, Gantt) Whether to hide data labels that
  77781. * are outside the plot area. By default, the data label is moved inside the
  77782. * plot area according to the overflow option.
  77783. */
  77784. crop?: boolean;
  77785. /**
  77786. * (Highcharts, Highstock, Gantt) Whether to defer displaying the data
  77787. * labels until the initial series animation has finished. Setting to
  77788. * `false` renders the data label immediately. If set to `true` inherits the
  77789. * defer time set in plotOptions.series.animation.
  77790. */
  77791. defer?: boolean;
  77792. /**
  77793. * (Highcharts, Highstock, Highmaps, Gantt) Enable or disable the data
  77794. * labels.
  77795. */
  77796. enabled?: boolean;
  77797. /**
  77798. * (Highcharts, Highstock, Highmaps, Gantt) A declarative filter to control
  77799. * of which data labels to display. The declarative filter is designed for
  77800. * use when callback functions are not available, like when the chart
  77801. * options require a pure JSON structure or for use with graphical editors.
  77802. * For programmatic control, use the `formatter` instead, and return
  77803. * `undefined` to disable a single data label.
  77804. */
  77805. filter?: DataLabelsFilterOptionsObject;
  77806. /**
  77807. * (Highcharts, Highstock, Highmaps, Gantt) A format string for the data
  77808. * label. Available variables are the same as for `formatter`.
  77809. */
  77810. format?: string;
  77811. /**
  77812. * (Highcharts, Highstock, Highmaps, Gantt) Callback JavaScript function to
  77813. * format the data label. Note that if a `format` is defined, the format
  77814. * takes precedence and the formatter is ignored.
  77815. */
  77816. formatter?: DataLabelsFormatterCallbackFunction;
  77817. /**
  77818. * (Highcharts, Highstock, Highmaps, Gantt) For points with an extent, like
  77819. * columns or map areas, whether to align the data label inside the box or
  77820. * to the actual value point. Defaults to `false` in most cases, `true` in
  77821. * stacked columns.
  77822. */
  77823. inside?: boolean;
  77824. /**
  77825. * (Highcharts, Highstock, Highmaps, Gantt) Format for points with the value
  77826. * of null. Works analogously to format. `nullFormat` can be applied only to
  77827. * series which support displaying null points.
  77828. */
  77829. nullFormat?: (boolean|string);
  77830. /**
  77831. * (Highcharts, Highstock, Highmaps, Gantt) Callback JavaScript function
  77832. * that defines formatting for points with the value of null. Works
  77833. * analogously to formatter. `nullPointFormatter` can be applied only to
  77834. * series which support displaying null points.
  77835. */
  77836. nullFormatter?: DataLabelsFormatterCallbackFunction;
  77837. /**
  77838. * (Highcharts, Highstock, Highmaps, Gantt) How to handle data labels that
  77839. * flow outside the plot area. The default is `"justify"`, which aligns them
  77840. * inside the plot area. For columns and bars, this means it will be moved
  77841. * inside the bar. To display data labels outside the plot area, set `crop`
  77842. * to `false` and `overflow` to `"allow"`.
  77843. */
  77844. overflow?: DataLabelsOverflowValue;
  77845. /**
  77846. * (Highcharts, Highstock, Highmaps, Gantt) When either the `borderWidth` or
  77847. * the `backgroundColor` is set, this is the padding within the box.
  77848. */
  77849. padding?: number;
  77850. /**
  77851. * (Highcharts, Highstock, Highmaps, Gantt) Aligns data labels relative to
  77852. * points. If `center` alignment is not possible, it defaults to `right`.
  77853. */
  77854. position?: AlignValue;
  77855. /**
  77856. * (Highcharts, Highstock, Highmaps, Gantt) Text rotation in degrees. Note
  77857. * that due to a more complex structure, backgrounds, borders and padding
  77858. * will be lost on a rotated data label.
  77859. */
  77860. rotation?: number;
  77861. /**
  77862. * (Highcharts, Highstock, Highmaps, Gantt) The shadow of the box. Works
  77863. * best with `borderWidth` or `backgroundColor`. Since 2.3 the shadow can be
  77864. * an object configuration containing `color`, `offsetX`, `offsetY`,
  77865. * `opacity` and `width`.
  77866. */
  77867. shadow?: (boolean|ShadowOptionsObject);
  77868. /**
  77869. * (Highcharts, Highstock, Highmaps, Gantt) The name of a symbol to use for
  77870. * the border around the label. Symbols are predefined functions on the
  77871. * Renderer object.
  77872. */
  77873. shape?: string;
  77874. /**
  77875. * (Highcharts, Highstock, Highmaps, Gantt) Styles for the label. The
  77876. * default `color` setting is `"contrast"`, which is a pseudo color that
  77877. * Highcharts picks up and applies the maximum contrast to the underlying
  77878. * point item, for example the bar in a bar chart.
  77879. *
  77880. * The `textOutline` is a pseudo property that applies an outline of the
  77881. * given width with the given color, which by default is the maximum
  77882. * contrast to the text. So a bright text color will result in a black text
  77883. * outline for maximum readability on a mixed background. In some cases,
  77884. * especially with grayscale text, the text outline doesn't work well, in
  77885. * which cases it can be disabled by setting it to `"none"`. When `useHTML`
  77886. * is true, the `textOutline` will not be picked up. In this, case, the same
  77887. * effect can be acheived through the `text-shadow` CSS property.
  77888. *
  77889. * For some series types, where each point has an extent, like for example
  77890. * tree maps, the data label may overflow the point. There are two
  77891. * strategies for handling overflow. By default, the text will wrap to
  77892. * multiple lines. The other strategy is to set `style.textOverflow` to
  77893. * `ellipsis`, which will keep the text on one line plus it will break
  77894. * inside long words.
  77895. */
  77896. style?: CSSObject;
  77897. /**
  77898. * (Highcharts, Highstock, Highmaps, Gantt) Options for a label text which
  77899. * should follow marker's shape. Border and background are disabled for a
  77900. * label that follows a path.
  77901. *
  77902. * **Note:** Only SVG-based renderer supports this option. Setting `useHTML`
  77903. * to true will disable this option.
  77904. */
  77905. textPath?: DataLabelsTextPathOptionsObject;
  77906. /**
  77907. * (Highcharts, Highstock, Highmaps, Gantt) Whether to use HTML to render
  77908. * the labels.
  77909. */
  77910. useHTML?: boolean;
  77911. /**
  77912. * (Highcharts, Highstock, Highmaps, Gantt) The vertical alignment of a data
  77913. * label. Can be one of `top`, `middle` or `bottom`. The default value
  77914. * depends on the data, for instance in a column chart, the label is above
  77915. * positive values and below negative values.
  77916. */
  77917. verticalAlign?: (VerticalAlignValue|null);
  77918. /**
  77919. * (Highcharts, Highstock, Highmaps, Gantt) The x position offset of the
  77920. * label relative to the point in pixels.
  77921. */
  77922. x?: number;
  77923. /**
  77924. * (Highcharts, Highstock, Highmaps, Gantt) The y position offset of the
  77925. * label relative to the point in pixels.
  77926. */
  77927. y?: number;
  77928. /**
  77929. * (Highcharts, Highstock, Highmaps, Gantt) The Z index of the data labels.
  77930. * The default Z index puts it above the series. Use a Z index of 2 to
  77931. * display it behind the series.
  77932. */
  77933. z?: number;
  77934. }
  77935. /**
  77936. * (Highcharts, Highstock) Options for the series data sorting.
  77937. */
  77938. export interface PlotScatterDataSortingOptions {
  77939. /**
  77940. * (Highcharts, Highstock) Enable or disable data sorting for the series.
  77941. * Use xAxis.reversed to change the sorting order.
  77942. */
  77943. enabled?: boolean;
  77944. /**
  77945. * (Highcharts, Highstock) Whether to allow matching points by name in an
  77946. * update. If this option is disabled, points will be matched by order.
  77947. */
  77948. matchByName?: boolean;
  77949. /**
  77950. * (Highcharts, Highstock) Determines what data value should be used to sort
  77951. * by.
  77952. */
  77953. sortKey?: string;
  77954. }
  77955. /**
  77956. * (Highcharts, Highstock) Style options for the guide box. The guide box has
  77957. * one state by default, the `default` state.
  77958. */
  77959. export interface PlotScatterDragDropGuideBoxOptions {
  77960. /**
  77961. * (Highcharts, Highstock) Style options for the guide box default state.
  77962. */
  77963. default?: DragDropGuideBoxOptionsObject;
  77964. }
  77965. /**
  77966. * (Highcharts, Highstock) Apply a jitter effect for the rendered markers. When
  77967. * plotting discrete values, a little random noise may help telling the points
  77968. * apart. The jitter setting applies a random displacement of up to `n` axis
  77969. * units in either direction. So for example on a horizontal X axis, setting the
  77970. * `jitter.x` to 0.24 will render the point in a random position between 0.24
  77971. * units to the left and 0.24 units to the right of the true axis position. On a
  77972. * category axis, setting it to 0.5 will fill up the bin and make the data
  77973. * appear continuous.
  77974. *
  77975. * When rendered on top of a box plot or a column series, a jitter value of 0.24
  77976. * will correspond to the underlying series' default groupPadding and
  77977. * pointPadding settings.
  77978. */
  77979. export interface PlotScatterJitterOptions {
  77980. /**
  77981. * (Highcharts, Highstock) The maximal X offset for the random jitter
  77982. * effect.
  77983. */
  77984. x?: number;
  77985. /**
  77986. * (Highcharts, Highstock) The maximal Y offset for the random jitter
  77987. * effect.
  77988. */
  77989. y?: number;
  77990. }
  77991. /**
  77992. * (Highcharts, Highstock) A scatter plot uses cartesian coordinates to display
  77993. * values for two variables for a set of data.
  77994. *
  77995. * In TypeScript the type option must always be set.
  77996. *
  77997. * Configuration options for the series are given in three levels:
  77998. *
  77999. * 1. Options for all series in a chart are defined in the plotOptions.series
  78000. * object.
  78001. *
  78002. * 2. Options for all `scatter` series are defined in plotOptions.scatter.
  78003. *
  78004. * 3. Options for one single series are given in the series instance array. (see
  78005. * online documentation for example)
  78006. */
  78007. export interface PlotScatterOptions {
  78008. /**
  78009. * (Highcharts, Highstock) Accessibility options for a series.
  78010. */
  78011. accessibility?: SeriesAccessibilityOptionsObject;
  78012. /**
  78013. * (Highmaps) Whether all areas of the map defined in `mapData` should be
  78014. * rendered. If `true`, areas which don't correspond to a data point, are
  78015. * rendered as `null` points. If `false`, those areas are skipped.
  78016. */
  78017. allAreas?: boolean;
  78018. /**
  78019. * (Highcharts, Highstock) Allow this series' points to be selected by
  78020. * clicking on the graphic (columns, point markers, pie slices, map areas
  78021. * etc).
  78022. *
  78023. * The selected points can be handled by point select and unselect events,
  78024. * or collectively by the getSelectedPoints function.
  78025. *
  78026. * And alternative way of selecting points is through dragging.
  78027. */
  78028. allowPointSelect?: boolean;
  78029. /**
  78030. * (Highcharts, Highstock) Enable or disable the initial animation when a
  78031. * series is displayed. The animation can also be set as a configuration
  78032. * object. Please note that this option only applies to the initial
  78033. * animation of the series itself. For other animations, see chart.animation
  78034. * and the animation parameter under the API methods. The following
  78035. * properties are supported:
  78036. *
  78037. * - `defer`: The animation delay time in milliseconds.
  78038. *
  78039. * - `duration`: The duration of the animation in milliseconds.
  78040. *
  78041. * - `easing`: Can be a string reference to an easing function set on the
  78042. * `Math` object or a function. See the _Custom easing function_ demo below.
  78043. *
  78044. * Due to poor performance, animation is disabled in old IE browsers for
  78045. * several chart types.
  78046. */
  78047. animation?: (boolean|PlotScatterAnimationOptions|Partial<AnimationOptionsObject>);
  78048. /**
  78049. * (Highcharts, Highstock) For some series, there is a limit that shuts down
  78050. * initial animation by default when the total number of points in the chart
  78051. * is too high. For example, for a column chart and its derivatives,
  78052. * animation does not run if there is more than 250 points totally. To
  78053. * disable this cap, set `animationLimit` to `Infinity`.
  78054. */
  78055. animationLimit?: number;
  78056. /**
  78057. * (Highcharts, Highstock) Sets the color blending in the boost module.
  78058. */
  78059. boostBlending?: OptionsBoostBlendingValue;
  78060. /**
  78061. * (Highcharts, Highstock) Set the point threshold for when a series should
  78062. * enter boost mode.
  78063. *
  78064. * Setting it to e.g. 2000 will cause the series to enter boost mode when
  78065. * there are 2000 or more points in the series.
  78066. *
  78067. * To disable boosting on the series, set the `boostThreshold` to 0. Setting
  78068. * it to 1 will force boosting.
  78069. *
  78070. * Note that the cropThreshold also affects this setting. When zooming in on
  78071. * a series that has fewer points than the `cropThreshold`, all points are
  78072. * rendered although outside the visible plot area, and the `boostThreshold`
  78073. * won't take effect.
  78074. */
  78075. boostThreshold?: number;
  78076. /**
  78077. * (Highmaps) The border color of the map areas.
  78078. *
  78079. * In styled mode, the border stroke is given in the `.highcharts-point`
  78080. * class.
  78081. */
  78082. borderColor?: (ColorString|GradientColorObject|PatternObject);
  78083. /**
  78084. * (Highmaps) The border width of each map area.
  78085. *
  78086. * In styled mode, the border stroke width is given in the
  78087. * `.highcharts-point` class.
  78088. */
  78089. borderWidth?: number;
  78090. /**
  78091. * (Highcharts, Highstock) An additional class name to apply to the series'
  78092. * graphical elements. This option does not replace default class names of
  78093. * the graphical element.
  78094. */
  78095. className?: string;
  78096. /**
  78097. * (Highcharts, Highstock) Disable this option to allow series rendering in
  78098. * the whole plotting area.
  78099. *
  78100. * **Note:** Clipping should be always enabled when chart.zoomType is set
  78101. */
  78102. clip?: boolean;
  78103. /**
  78104. * (Highcharts, Highmaps) Options for marker clusters, the concept of
  78105. * sampling the data values into larger blocks in order to ease readability
  78106. * and increase performance of the JavaScript charts.
  78107. *
  78108. * Note: marker clusters module is not working with `boost` and
  78109. * `draggable-points` modules.
  78110. *
  78111. * The marker clusters feature requires the marker-clusters.js file to be
  78112. * loaded, found in the modules directory of the download package, or online
  78113. * at code.highcharts.com/modules/marker-clusters.js.
  78114. */
  78115. cluster?: PlotScatterClusterOptions;
  78116. /**
  78117. * (Highcharts, Highstock) The main color of the series. In line type series
  78118. * it applies to the line and the point markers unless otherwise specified.
  78119. * In bar type series it applies to the bars unless a color is specified per
  78120. * point. The default value is pulled from the `options.colors` array.
  78121. *
  78122. * In styled mode, the color can be defined by the colorIndex option. Also,
  78123. * the series color can be set with the `.highcharts-series`,
  78124. * `.highcharts-color-{n}`, `.highcharts-{type}-series` or
  78125. * `.highcharts-series-{n}` class, or individual classes given by the
  78126. * `className` option.
  78127. */
  78128. color?: (ColorString|GradientColorObject|PatternObject);
  78129. /**
  78130. * (Highcharts, Highstock, Highmaps) When using dual or multiple color axes,
  78131. * this number defines which colorAxis the particular series is connected
  78132. * to. It refers to either the axis id or the index of the axis in the
  78133. * colorAxis array, with 0 being the first. Set this option to false to
  78134. * prevent a series from connecting to the default color axis.
  78135. *
  78136. * Since v7.2.0 the option can also be an axis id or an axis index instead
  78137. * of a boolean flag.
  78138. */
  78139. colorAxis?: (boolean|number|string);
  78140. /**
  78141. * (Highcharts, Highstock) Styled mode only. A specific color index to use
  78142. * for the series, so its graphic representations are given the class name
  78143. * `highcharts-color-{n}`.
  78144. */
  78145. colorIndex?: number;
  78146. /**
  78147. * (Highcharts, Highstock, Highmaps) Determines what data value should be
  78148. * used to calculate point color if `colorAxis` is used. Requires to set
  78149. * `min` and `max` if some custom point property is used or if approximation
  78150. * for data grouping is set to `'sum'`.
  78151. */
  78152. colorKey?: string;
  78153. /**
  78154. * (Highstock) Compare the values of the series against the first non-null,
  78155. * non- zero value in the visible range. The y axis will show percentage or
  78156. * absolute change depending on whether `compare` is set to `"percent"` or
  78157. * `"value"`. When this is applied to multiple series, it allows comparing
  78158. * the development of the series against each other. Adds a `change` field
  78159. * to every point object.
  78160. */
  78161. compare?: string;
  78162. /**
  78163. * (Highstock) When compare is `percent`, this option dictates whether to
  78164. * use 0 or 100 as the base of comparison.
  78165. */
  78166. compareBase?: (0|100);
  78167. /**
  78168. * (Highstock) Defines if comparison should start from the first point
  78169. * within the visible range or should start from the first point **before**
  78170. * the range.
  78171. *
  78172. * In other words, this flag determines if first point within the visible
  78173. * range will have 0% (`compareStart=true`) or should have been already
  78174. * calculated according to the previous point (`compareStart=false`).
  78175. */
  78176. compareStart?: boolean;
  78177. /**
  78178. * (Highcharts) Polar charts only. Whether to connect the ends of a line
  78179. * series plot across the extremes.
  78180. */
  78181. connectEnds?: boolean;
  78182. /**
  78183. * (Highcharts, Highstock) Whether to connect a graph line across null
  78184. * points, or render a gap between the two points on either side of the
  78185. * null.
  78186. */
  78187. connectNulls?: boolean;
  78188. /**
  78189. * (Gantt) Override Pathfinder connector options for a series. Requires
  78190. * Highcharts Gantt to be loaded.
  78191. */
  78192. connectors?: SeriesConnectorsOptionsObject;
  78193. /**
  78194. * (Highcharts, Highstock, Gantt) When true, each point or column edge is
  78195. * rounded to its nearest pixel in order to render sharp on screen. In some
  78196. * cases, when there are a lot of densely packed columns, this leads to
  78197. * visible difference in column widths or distance between columns. In these
  78198. * cases, setting `crisp` to `false` may look better, even though each
  78199. * column is rendered blurry.
  78200. */
  78201. crisp?: boolean;
  78202. /**
  78203. * (Highcharts, Highstock) You can set the cursor to "pointer" if you have
  78204. * click events attached to the series, to signal to the user that the
  78205. * points and lines can be clicked.
  78206. *
  78207. * In styled mode, the series cursor can be set with the same classes as
  78208. * listed under series.color.
  78209. */
  78210. cursor?: (string|CursorValue);
  78211. /**
  78212. * (Highcharts, Highstock) A reserved subspace to store options and values
  78213. * for customized functionality. Here you can add additional data for your
  78214. * own event callbacks and formatter callbacks.
  78215. */
  78216. custom?: Dictionary<any>;
  78217. /**
  78218. * (Highcharts, Highstock) Name of the dash style to use for the graph, or
  78219. * for some series types the outline of each shape.
  78220. *
  78221. * In styled mode, the stroke dash-array can be set with the same classes as
  78222. * listed under series.color.
  78223. */
  78224. dashStyle?: DashStyleValue;
  78225. /**
  78226. * (Highstock) Data grouping is the concept of sampling the data values into
  78227. * larger blocks in order to ease readability and increase performance of
  78228. * the JavaScript charts. Highstock by default applies data grouping when
  78229. * the points become closer than a certain pixel value, determined by the
  78230. * `groupPixelWidth` option.
  78231. *
  78232. * If data grouping is applied, the grouping information of grouped points
  78233. * can be read from the Point.dataGroup. If point options other than the
  78234. * data itself are set, for example `name` or `color` or custom properties,
  78235. * the grouping logic doesn't know how to group it. In this case the options
  78236. * of the first point instance are copied over to the group point. This can
  78237. * be altered through a custom `approximation` callback function.
  78238. */
  78239. dataGrouping?: DataGroupingOptionsObject;
  78240. /**
  78241. * (Highcharts, Highstock, Highmaps, Gantt) Options for the series data
  78242. * labels, appearing next to each data point.
  78243. *
  78244. * Since v6.2.0, multiple data labels can be applied to each single point by
  78245. * defining them as an array of configs.
  78246. *
  78247. * In styled mode, the data labels can be styled with the
  78248. * `.highcharts-data-label-box` and `.highcharts-data-label` class names
  78249. * (see example).
  78250. */
  78251. dataLabels?: (PlotScatterDataLabelsOptions|Array<PlotScatterDataLabelsOptions>);
  78252. /**
  78253. * (Highcharts, Highstock) Options for the series data sorting.
  78254. */
  78255. dataSorting?: (DataSortingOptionsObject|PlotScatterDataSortingOptions);
  78256. /**
  78257. * (Highcharts, Highstock) A description of the series to add to the screen
  78258. * reader information about the series.
  78259. */
  78260. description?: string;
  78261. /**
  78262. * (Highcharts, Highstock) The draggable-points module allows points to be
  78263. * moved around or modified in the chart. In addition to the options
  78264. * mentioned under the `dragDrop` API structure, the module fires three
  78265. * events, point.dragStart, point.drag and point.drop.
  78266. */
  78267. dragDrop?: SeriesDragDropOptionsObject;
  78268. /**
  78269. * (Highcharts, Highstock) Enable or disable the mouse tracking for a
  78270. * specific series. This includes point tooltips and click events on graphs
  78271. * and points. For large datasets it improves performance.
  78272. */
  78273. enableMouseTracking?: boolean;
  78274. /**
  78275. * (Highcharts, Highstock) General event handlers for the series items.
  78276. * These event hooks can also be attached to the series at run time using
  78277. * the `Highcharts.addEvent` function.
  78278. */
  78279. events?: SeriesEventsOptionsObject;
  78280. /**
  78281. * (Highcharts, Highstock) Determines whether the series should look for the
  78282. * nearest point in both dimensions or just the x-dimension when hovering
  78283. * the series. Defaults to `'xy'` for scatter series and `'x'` for most
  78284. * other series. If the data has duplicate x-values, it is recommended to
  78285. * set this to `'xy'` to allow hovering over all points.
  78286. *
  78287. * Applies only to series types using nearest neighbor search (not direct
  78288. * hover) for tooltip.
  78289. */
  78290. findNearestPointBy?: OptionsFindNearestPointByValue;
  78291. /**
  78292. * (Highstock) Defines when to display a gap in the graph, together with the
  78293. * gapUnit option.
  78294. *
  78295. * In case when `dataGrouping` is enabled, points can be grouped into a
  78296. * larger time span. This can make the grouped points to have a greater
  78297. * distance than the absolute value of `gapSize` property, which will result
  78298. * in disappearing graph completely. To prevent this situation the mentioned
  78299. * distance between grouped points is used instead of previously defined
  78300. * `gapSize`.
  78301. *
  78302. * In practice, this option is most often used to visualize gaps in time
  78303. * series. In a stock chart, intraday data is available for daytime hours,
  78304. * while gaps will appear in nights and weekends.
  78305. */
  78306. gapSize?: number;
  78307. /**
  78308. * (Highstock) Together with gapSize, this option defines where to draw gaps
  78309. * in the graph.
  78310. *
  78311. * When the `gapUnit` is `"relative"` (default), a gap size of 5 means that
  78312. * if the distance between two points is greater than 5 times that of the
  78313. * two closest points, the graph will be broken.
  78314. *
  78315. * When the `gapUnit` is `"value"`, the gap is based on absolute axis
  78316. * values, which on a datetime axis is milliseconds. This also applies to
  78317. * the navigator series that inherits gap options from the base series.
  78318. */
  78319. gapUnit?: OptionsGapUnitValue;
  78320. /**
  78321. * (Highcharts, Highstock, Gantt) Whether to use the Y extremes of the total
  78322. * chart width or only the zoomed area when zooming in on parts of the X
  78323. * axis. By default, the Y axis adjusts to the min and max of the visible
  78324. * data. Cartesian series only.
  78325. */
  78326. getExtremesFromAll?: boolean;
  78327. /**
  78328. * (Highcharts, Highstock) When set to `false` will prevent the series data
  78329. * from being included in any form of data export.
  78330. *
  78331. * Since version 6.0.0 until 7.1.0 the option was existing undocumented as
  78332. * `includeInCSVExport`.
  78333. */
  78334. includeInDataExport?: boolean;
  78335. /**
  78336. * (Highcharts, Highstock) Apply a jitter effect for the rendered markers.
  78337. * When plotting discrete values, a little random noise may help telling the
  78338. * points apart. The jitter setting applies a random displacement of up to
  78339. * `n` axis units in either direction. So for example on a horizontal X
  78340. * axis, setting the `jitter.x` to 0.24 will render the point in a random
  78341. * position between 0.24 units to the left and 0.24 units to the right of
  78342. * the true axis position. On a category axis, setting it to 0.5 will fill
  78343. * up the bin and make the data appear continuous.
  78344. *
  78345. * When rendered on top of a box plot or a column series, a jitter value of
  78346. * 0.24 will correspond to the underlying series' default groupPadding and
  78347. * pointPadding settings.
  78348. */
  78349. jitter?: PlotScatterJitterOptions;
  78350. /**
  78351. * (Highmaps) What property to join the `mapData` to the value data. For
  78352. * example, if joinBy is "code", the mapData items with a specific code is
  78353. * merged into the data with the same code. For maps loaded from GeoJSON,
  78354. * the keys may be held in each point's `properties` object.
  78355. *
  78356. * The joinBy option can also be an array of two values, where the first
  78357. * points to a key in the `mapData`, and the second points to another key in
  78358. * the `data`.
  78359. *
  78360. * When joinBy is `null`, the map items are joined by their position in the
  78361. * array, which performs much better in maps with many data points. This is
  78362. * the recommended option if you are printing more than a thousand data
  78363. * points and have a backend that can preprocess the data into a parallel
  78364. * array of the mapData.
  78365. */
  78366. joinBy?: (string|Array<string>);
  78367. /**
  78368. * (Highcharts, Highstock) An array specifying which option maps to which
  78369. * key in the data point array. This makes it convenient to work with
  78370. * unstructured data arrays from different sources.
  78371. */
  78372. keys?: Array<string>;
  78373. /**
  78374. * (Highcharts, Highstock, Gantt) Series labels are placed as close to the
  78375. * series as possible in a natural way, seeking to avoid other series. The
  78376. * goal of this feature is to make the chart more easily readable, like if a
  78377. * human designer placed the labels in the optimal position.
  78378. *
  78379. * The series labels currently work with series types having a `graph` or an
  78380. * `area`.
  78381. */
  78382. label?: SeriesLabelOptionsObject;
  78383. /**
  78384. * (Highstock) The line marks the last price from all points.
  78385. */
  78386. lastPrice?: SeriesLastPriceOptionsObject;
  78387. /**
  78388. * (Highstock) The line marks the last price from visible range of points.
  78389. */
  78390. lastVisiblePrice?: SeriesLastVisiblePriceOptionsObject;
  78391. /**
  78392. * (Highcharts, Highstock) The SVG value used for the `stroke-linecap` and
  78393. * `stroke-linejoin` of a line graph. Round means that lines are rounded in
  78394. * the ends and bends.
  78395. */
  78396. linecap?: SeriesLinecapValue;
  78397. /**
  78398. * (Highcharts, Highstock) The width of the line connecting the data points.
  78399. */
  78400. lineWidth?: number;
  78401. /**
  78402. * (Highcharts, Highstock, Gantt) The id of another series to link to.
  78403. * Additionally, the value can be ":previous" to link to the previous
  78404. * series. When two series are linked, only the first one appears in the
  78405. * legend. Toggling the visibility of this also toggles the linked series.
  78406. *
  78407. * If master series uses data sorting and linked series does not have its
  78408. * own sorting definition, the linked series will be sorted in the same
  78409. * order as the master one.
  78410. */
  78411. linkedTo?: string;
  78412. /**
  78413. * (Highcharts, Highstock) Options for the point markers of line-like
  78414. * series. Properties like `fillColor`, `lineColor` and `lineWidth` define
  78415. * the visual appearance of the markers. Other series types, like column
  78416. * series, don't have markers, but have visual options on the series level
  78417. * instead.
  78418. *
  78419. * In styled mode, the markers can be styled with the `.highcharts-point`,
  78420. * `.highcharts-point-hover` and `.highcharts-point-select` class names.
  78421. */
  78422. marker?: PointMarkerOptionsObject;
  78423. /**
  78424. * (Highstock) Options for the corresponding navigator series if
  78425. * `showInNavigator` is `true` for this series. Available options are the
  78426. * same as any series, documented at plotOptions and series.
  78427. *
  78428. * These options are merged with options in navigator.series, and will take
  78429. * precedence if the same option is defined both places.
  78430. */
  78431. navigatorOptions?: PlotSeriesOptions;
  78432. /**
  78433. * (Highcharts, Highstock) The color for the parts of the graph or points
  78434. * that are below the threshold. Note that `zones` takes precedence over the
  78435. * negative color. Using `negativeColor` is equivalent to applying a zone
  78436. * with value of 0.
  78437. */
  78438. negativeColor?: (ColorString|GradientColorObject|PatternObject);
  78439. /**
  78440. * (Highcharts, Highstock) Opacity of a series parts: line, fill (e.g. area)
  78441. * and dataLabels.
  78442. */
  78443. opacity?: number;
  78444. /**
  78445. * (Highcharts, Highstock) Properties for each single point.
  78446. */
  78447. point?: PlotSeriesPointOptions;
  78448. /**
  78449. * (Highcharts, Highstock) Same as accessibility.pointDescriptionFormatter,
  78450. * but for an individual series. Overrides the chart wide configuration.
  78451. */
  78452. pointDescriptionFormatter?: Function;
  78453. /**
  78454. * (Highcharts, Highstock, Gantt) If no x values are given for the points in
  78455. * a series, `pointInterval` defines the interval of the x values. For
  78456. * example, if a series contains one value every decade starting from year
  78457. * 0, set `pointInterval` to `10`. In true `datetime` axes, the
  78458. * `pointInterval` is set in milliseconds.
  78459. *
  78460. * It can be also be combined with `pointIntervalUnit` to draw irregular
  78461. * time intervals.
  78462. *
  78463. * Please note that this options applies to the _series data_, not the
  78464. * interval of the axis ticks, which is independent.
  78465. */
  78466. pointInterval?: number;
  78467. /**
  78468. * (Highcharts, Highstock, Gantt) On datetime series, this allows for
  78469. * setting the pointInterval to irregular time units, `day`, `month` and
  78470. * `year`. A day is usually the same as 24 hours, but `pointIntervalUnit`
  78471. * also takes the DST crossover into consideration when dealing with local
  78472. * time. Combine this option with `pointInterval` to draw weeks, quarters, 6
  78473. * months, 10 years etc.
  78474. *
  78475. * Please note that this options applies to the _series data_, not the
  78476. * interval of the axis ticks, which is independent.
  78477. */
  78478. pointIntervalUnit?: OptionsPointIntervalUnitValue;
  78479. /**
  78480. * (Highstock) The width of each point on the x axis. For example in a
  78481. * column chart with one value each day, the pointRange would be 1 day (= 24
  78482. * * 3600
  78483. *
  78484. * * 1000 milliseconds). This is normally computed automatically, but this
  78485. * option can be used to override the automatic value.
  78486. */
  78487. pointRange?: number;
  78488. /**
  78489. * (Highcharts, Highstock, Gantt) If no x values are given for the points in
  78490. * a series, pointStart defines on what value to start. For example, if a
  78491. * series contains one yearly value starting from 1945, set pointStart to
  78492. * 1945.
  78493. */
  78494. pointStart?: number;
  78495. /**
  78496. * (Highcharts, Highstock) Whether to select the series initially. If
  78497. * `showCheckbox` is true, the checkbox next to the series name in the
  78498. * legend will be checked for a selected series.
  78499. */
  78500. selected?: boolean;
  78501. /**
  78502. * (Highcharts, Highstock) If true, a checkbox is displayed next to the
  78503. * legend item to allow selecting the series. The state of the checkbox is
  78504. * determined by the `selected` option.
  78505. */
  78506. showCheckbox?: boolean;
  78507. /**
  78508. * (Highcharts, Highstock) Whether to display this particular series or
  78509. * series type in the legend. Standalone series are shown in legend by
  78510. * default, and linked series are not. Since v7.2.0 it is possible to show
  78511. * series that use colorAxis by setting this option to `true`.
  78512. */
  78513. showInLegend?: boolean;
  78514. /**
  78515. * (Highstock) Whether or not to show the series in the navigator. Takes
  78516. * precedence over navigator.baseSeries if defined.
  78517. */
  78518. showInNavigator?: boolean;
  78519. /**
  78520. * (Highcharts, Highstock) If set to `true`, the accessibility module will
  78521. * skip past the points in this series for keyboard navigation.
  78522. */
  78523. skipKeyboardNavigation?: boolean;
  78524. /**
  78525. * (Highcharts, Highstock) When this is true, the series will not cause the
  78526. * Y axis to cross the zero plane (or threshold option) unless the data
  78527. * actually crosses the plane.
  78528. *
  78529. * For example, if `softThreshold` is `false`, a series of 0, 1, 2, 3 will
  78530. * make the Y axis show negative values according to the `minPadding`
  78531. * option. If `softThreshold` is `true`, the Y axis starts at 0.
  78532. */
  78533. softThreshold?: boolean;
  78534. /**
  78535. * (Highcharts, Highstock) Whether to stack the values of each series on top
  78536. * of each other. Possible values are `undefined` to disable, `"normal"` to
  78537. * stack by value or `"percent"`.
  78538. *
  78539. * When stacking is enabled, data must be sorted in ascending X order.
  78540. *
  78541. * Some stacking options are related to specific series types. In the
  78542. * streamgraph series type, the stacking option is set to `"stream"`. The
  78543. * second one is `"overlap"`, which only applies to waterfall series.
  78544. */
  78545. stacking?: OptionsStackingValue;
  78546. states?: SeriesStatesOptionsObject;
  78547. /**
  78548. * (Highcharts, Highstock) Whether to apply steps to the line. Possible
  78549. * values are `left`, `center` and `right`.
  78550. */
  78551. step?: OptionsStepValue;
  78552. /**
  78553. * (Highcharts, Highstock) Sticky tracking of mouse events. When true, the
  78554. * `mouseOut` event on a series isn't triggered until the mouse moves over
  78555. * another series, or out of the plot area. When false, the `mouseOut` event
  78556. * on a series is triggered when the mouse leaves the area around the
  78557. * series' graph or markers. This also implies the tooltip. When
  78558. * `stickyTracking` is false and `tooltip.shared` is false, the tooltip will
  78559. * be hidden when moving the mouse between series.
  78560. */
  78561. stickyTracking?: boolean;
  78562. /**
  78563. * (Highcharts, Highstock) The threshold, also called zero level or base
  78564. * level. For line type series this is only used in conjunction with
  78565. * negativeColor.
  78566. */
  78567. threshold?: (number|null);
  78568. /**
  78569. * (Highcharts, Highstock) A configuration object for the tooltip rendering
  78570. * of each single series. Properties are inherited from tooltip. Overridable
  78571. * properties are `headerFormat`, `pointFormat`, `yDecimals`, `xDateFormat`,
  78572. * `yPrefix` and `ySuffix`. Unlike other series, in a scatter plot the
  78573. * series.name by default shows in the headerFormat and point.x and point.y
  78574. * in the pointFormat.
  78575. */
  78576. tooltip?: SeriesTooltipOptionsObject;
  78577. /**
  78578. * (Highcharts, Highstock, Gantt) When a series contains a data array that
  78579. * is longer than this, only one dimensional arrays of numbers, or two
  78580. * dimensional arrays with x and y values are allowed. Also, only the first
  78581. * point is tested, and the rest are assumed to be the same format. This
  78582. * saves expensive data checking and indexing in long series. Set it to `0`
  78583. * disable.
  78584. *
  78585. * Note: In boost mode turbo threshold is forced. Only array of numbers or
  78586. * two dimensional arrays are allowed.
  78587. */
  78588. turboThreshold?: number;
  78589. /**
  78590. * (Highcharts, Highstock) Set the initial visibility of the series.
  78591. */
  78592. visible?: boolean;
  78593. /**
  78594. * (Highmaps) Define the z index of the series.
  78595. */
  78596. zIndex?: number;
  78597. /**
  78598. * (Highcharts, Highstock) Defines the Axis on which the zones are applied.
  78599. */
  78600. zoneAxis?: string;
  78601. /**
  78602. * (Highcharts, Highstock) An array defining zones within a series. Zones
  78603. * can be applied to the X axis, Y axis or Z axis for bubbles, according to
  78604. * the `zoneAxis` option. The zone definitions have to be in ascending order
  78605. * regarding to the value.
  78606. *
  78607. * In styled mode, the color zones are styled with the
  78608. * `.highcharts-zone-{n}` class, or custom classed from the `className`
  78609. * option (view live demo).
  78610. */
  78611. zones?: Array<SeriesZonesOptionsObject>;
  78612. }
  78613. /**
  78614. * (Highcharts, Highstock, Highmaps, Gantt) Enable or disable the initial
  78615. * animation when a series is displayed. The animation can also be set as a
  78616. * configuration object. Please note that this option only applies to the
  78617. * initial animation of the series itself. For other animations, see
  78618. * chart.animation and the animation parameter under the API methods. The
  78619. * following properties are supported:
  78620. *
  78621. * - `defer`: The animation delay time in milliseconds.
  78622. *
  78623. * - `duration`: The duration of the animation in milliseconds.
  78624. *
  78625. * - `easing`: Can be a string reference to an easing function set on the `Math`
  78626. * object or a function. See the _Custom easing function_ demo below.
  78627. *
  78628. * Due to poor performance, animation is disabled in old IE browsers for several
  78629. * chart types.
  78630. */
  78631. export interface PlotSeriesAnimationOptions {
  78632. defer?: number;
  78633. }
  78634. /**
  78635. * (Highcharts, Highstock, Highmaps, Gantt) Enable or disable the initial
  78636. * animation when a series is displayed for the `dataLabels`. The animation can
  78637. * also be set as a configuration object. Please note that this option only
  78638. * applies to the initial animation. For other animations, see chart.animation
  78639. * and the animation parameter under the API methods. The following properties
  78640. * are supported:
  78641. *
  78642. * - `defer`: The animation delay time in milliseconds.
  78643. */
  78644. export interface PlotSeriesDataLabelsAnimationOptions {
  78645. /**
  78646. * (Highcharts, Highstock, Highmaps, Gantt) The animation delay time in
  78647. * milliseconds. Set to `0` renders dataLabel immediately. As `undefined`
  78648. * inherits defer time from the series.animation.defer.
  78649. */
  78650. defer?: number;
  78651. }
  78652. /**
  78653. * (Highcharts, Highstock, Highmaps, Gantt) Options for the series data labels,
  78654. * appearing next to each data point.
  78655. *
  78656. * Since v6.2.0, multiple data labels can be applied to each single point by
  78657. * defining them as an array of configs.
  78658. *
  78659. * In styled mode, the data labels can be styled with the
  78660. * `.highcharts-data-label-box` and `.highcharts-data-label` class names (see
  78661. * example).
  78662. */
  78663. export interface PlotSeriesDataLabelsOptions {
  78664. /**
  78665. * (Highcharts, Highstock, Highmaps, Gantt) The alignment of the data label
  78666. * compared to the point. If `right`, the right side of the label should be
  78667. * touching the point. For points with an extent, like columns, the
  78668. * alignments also dictates how to align it inside the box, as given with
  78669. * the inside option. Can be one of `left`, `center` or `right`.
  78670. */
  78671. align?: (AlignValue|null);
  78672. /**
  78673. * (Highcharts, Highstock, Highmaps, Gantt) Whether to allow data labels to
  78674. * overlap. To make the labels less sensitive for overlapping, the
  78675. * dataLabels.padding can be set to 0.
  78676. */
  78677. allowOverlap?: boolean;
  78678. /**
  78679. * (Highcharts, Highstock, Highmaps, Gantt) Enable or disable the initial
  78680. * animation when a series is displayed for the `dataLabels`. The animation
  78681. * can also be set as a configuration object. Please note that this option
  78682. * only applies to the initial animation. For other animations, see
  78683. * chart.animation and the animation parameter under the API methods. The
  78684. * following properties are supported:
  78685. *
  78686. * - `defer`: The animation delay time in milliseconds.
  78687. */
  78688. animation?: (boolean|PlotSeriesDataLabelsAnimationOptions|Partial<AnimationOptionsObject>);
  78689. /**
  78690. * (Highcharts, Highstock, Highmaps, Gantt) The background color or gradient
  78691. * for the data label.
  78692. */
  78693. backgroundColor?: (ColorString|GradientColorObject|PatternObject);
  78694. /**
  78695. * (Highcharts, Highstock, Highmaps, Gantt) The border color for the data
  78696. * label. Defaults to `undefined`.
  78697. */
  78698. borderColor?: (ColorString|GradientColorObject|PatternObject);
  78699. /**
  78700. * (Highcharts, Highstock, Highmaps, Gantt) The border radius in pixels for
  78701. * the data label.
  78702. */
  78703. borderRadius?: number;
  78704. /**
  78705. * (Highcharts, Highstock, Highmaps, Gantt) The border width in pixels for
  78706. * the data label.
  78707. */
  78708. borderWidth?: number;
  78709. /**
  78710. * (Highcharts, Highstock, Highmaps, Gantt) A class name for the data label.
  78711. * Particularly in styled mode, this can be used to give each series' or
  78712. * point's data label unique styling. In addition to this option, a default
  78713. * color class name is added so that we can give the labels a contrast text
  78714. * shadow.
  78715. */
  78716. className?: string;
  78717. /**
  78718. * (Highcharts, Highstock, Highmaps, Gantt) The text color for the data
  78719. * labels. Defaults to `undefined`. For certain series types, like column or
  78720. * map, the data labels can be drawn inside the points. In this case the
  78721. * data label will be drawn with maximum contrast by default. Additionally,
  78722. * it will be given a `text-outline` style with the opposite color, to
  78723. * further increase the contrast. This can be overridden by setting the
  78724. * `text-outline` style to `none` in the `dataLabels.style` option.
  78725. */
  78726. color?: (ColorString|GradientColorObject|PatternObject);
  78727. /**
  78728. * (Highcharts, Highstock, Highmaps, Gantt) Whether to hide data labels that
  78729. * are outside the plot area. By default, the data label is moved inside the
  78730. * plot area according to the overflow option.
  78731. */
  78732. crop?: boolean;
  78733. /**
  78734. * (Highcharts, Highstock, Gantt) Whether to defer displaying the data
  78735. * labels until the initial series animation has finished. Setting to
  78736. * `false` renders the data label immediately. If set to `true` inherits the
  78737. * defer time set in plotOptions.series.animation.
  78738. */
  78739. defer?: boolean;
  78740. /**
  78741. * (Highcharts, Highstock, Highmaps, Gantt) Enable or disable the data
  78742. * labels.
  78743. */
  78744. enabled?: boolean;
  78745. /**
  78746. * (Highcharts, Highstock, Highmaps, Gantt) A declarative filter to control
  78747. * of which data labels to display. The declarative filter is designed for
  78748. * use when callback functions are not available, like when the chart
  78749. * options require a pure JSON structure or for use with graphical editors.
  78750. * For programmatic control, use the `formatter` instead, and return
  78751. * `undefined` to disable a single data label.
  78752. */
  78753. filter?: DataLabelsFilterOptionsObject;
  78754. /**
  78755. * (Highcharts, Highstock, Highmaps, Gantt) A format string for the data
  78756. * label. Available variables are the same as for `formatter`.
  78757. */
  78758. format?: string;
  78759. /**
  78760. * (Highcharts, Highstock, Highmaps, Gantt) Callback JavaScript function to
  78761. * format the data label. Note that if a `format` is defined, the format
  78762. * takes precedence and the formatter is ignored.
  78763. */
  78764. formatter?: DataLabelsFormatterCallbackFunction;
  78765. /**
  78766. * (Highcharts, Highstock, Highmaps, Gantt) For points with an extent, like
  78767. * columns or map areas, whether to align the data label inside the box or
  78768. * to the actual value point. Defaults to `false` in most cases, `true` in
  78769. * stacked columns.
  78770. */
  78771. inside?: boolean;
  78772. /**
  78773. * (Highcharts, Highstock, Highmaps, Gantt) Format for points with the value
  78774. * of null. Works analogously to format. `nullFormat` can be applied only to
  78775. * series which support displaying null points.
  78776. */
  78777. nullFormat?: (boolean|string);
  78778. /**
  78779. * (Highcharts, Highstock, Highmaps, Gantt) Callback JavaScript function
  78780. * that defines formatting for points with the value of null. Works
  78781. * analogously to formatter. `nullPointFormatter` can be applied only to
  78782. * series which support displaying null points.
  78783. */
  78784. nullFormatter?: DataLabelsFormatterCallbackFunction;
  78785. /**
  78786. * (Highcharts, Highstock, Highmaps, Gantt) How to handle data labels that
  78787. * flow outside the plot area. The default is `"justify"`, which aligns them
  78788. * inside the plot area. For columns and bars, this means it will be moved
  78789. * inside the bar. To display data labels outside the plot area, set `crop`
  78790. * to `false` and `overflow` to `"allow"`.
  78791. */
  78792. overflow?: DataLabelsOverflowValue;
  78793. /**
  78794. * (Highcharts, Highstock, Highmaps, Gantt) When either the `borderWidth` or
  78795. * the `backgroundColor` is set, this is the padding within the box.
  78796. */
  78797. padding?: number;
  78798. /**
  78799. * (Highcharts, Highstock, Highmaps, Gantt) Aligns data labels relative to
  78800. * points. If `center` alignment is not possible, it defaults to `right`.
  78801. */
  78802. position?: AlignValue;
  78803. /**
  78804. * (Highcharts, Highstock, Highmaps, Gantt) Text rotation in degrees. Note
  78805. * that due to a more complex structure, backgrounds, borders and padding
  78806. * will be lost on a rotated data label.
  78807. */
  78808. rotation?: number;
  78809. /**
  78810. * (Highcharts, Highstock, Highmaps, Gantt) The shadow of the box. Works
  78811. * best with `borderWidth` or `backgroundColor`. Since 2.3 the shadow can be
  78812. * an object configuration containing `color`, `offsetX`, `offsetY`,
  78813. * `opacity` and `width`.
  78814. */
  78815. shadow?: (boolean|ShadowOptionsObject);
  78816. /**
  78817. * (Highcharts, Highstock, Highmaps, Gantt) The name of a symbol to use for
  78818. * the border around the label. Symbols are predefined functions on the
  78819. * Renderer object.
  78820. */
  78821. shape?: string;
  78822. /**
  78823. * (Highcharts, Highstock, Highmaps, Gantt) Styles for the label. The
  78824. * default `color` setting is `"contrast"`, which is a pseudo color that
  78825. * Highcharts picks up and applies the maximum contrast to the underlying
  78826. * point item, for example the bar in a bar chart.
  78827. *
  78828. * The `textOutline` is a pseudo property that applies an outline of the
  78829. * given width with the given color, which by default is the maximum
  78830. * contrast to the text. So a bright text color will result in a black text
  78831. * outline for maximum readability on a mixed background. In some cases,
  78832. * especially with grayscale text, the text outline doesn't work well, in
  78833. * which cases it can be disabled by setting it to `"none"`. When `useHTML`
  78834. * is true, the `textOutline` will not be picked up. In this, case, the same
  78835. * effect can be acheived through the `text-shadow` CSS property.
  78836. *
  78837. * For some series types, where each point has an extent, like for example
  78838. * tree maps, the data label may overflow the point. There are two
  78839. * strategies for handling overflow. By default, the text will wrap to
  78840. * multiple lines. The other strategy is to set `style.textOverflow` to
  78841. * `ellipsis`, which will keep the text on one line plus it will break
  78842. * inside long words.
  78843. */
  78844. style?: CSSObject;
  78845. /**
  78846. * (Highcharts, Highstock, Highmaps, Gantt) Options for a label text which
  78847. * should follow marker's shape. Border and background are disabled for a
  78848. * label that follows a path.
  78849. *
  78850. * **Note:** Only SVG-based renderer supports this option. Setting `useHTML`
  78851. * to true will disable this option.
  78852. */
  78853. textPath?: DataLabelsTextPathOptionsObject;
  78854. /**
  78855. * (Highcharts, Highstock, Highmaps, Gantt) Whether to use HTML to render
  78856. * the labels.
  78857. */
  78858. useHTML?: boolean;
  78859. /**
  78860. * (Highcharts, Highstock, Highmaps, Gantt) The vertical alignment of a data
  78861. * label. Can be one of `top`, `middle` or `bottom`. The default value
  78862. * depends on the data, for instance in a column chart, the label is above
  78863. * positive values and below negative values.
  78864. */
  78865. verticalAlign?: (VerticalAlignValue|null);
  78866. /**
  78867. * (Highcharts, Highstock, Highmaps, Gantt) The x position offset of the
  78868. * label relative to the point in pixels.
  78869. */
  78870. x?: number;
  78871. /**
  78872. * (Highcharts, Highstock, Highmaps, Gantt) The y position offset of the
  78873. * label relative to the point in pixels.
  78874. */
  78875. y?: number;
  78876. /**
  78877. * (Highcharts, Highstock, Highmaps, Gantt) The Z index of the data labels.
  78878. * The default Z index puts it above the series. Use a Z index of 2 to
  78879. * display it behind the series.
  78880. */
  78881. z?: number;
  78882. }
  78883. /**
  78884. * (Highcharts, Highstock) Options for the series data sorting.
  78885. */
  78886. export interface PlotSeriesDataSortingOptions {
  78887. /**
  78888. * (Highcharts, Highstock) Enable or disable data sorting for the series.
  78889. * Use xAxis.reversed to change the sorting order.
  78890. */
  78891. enabled?: boolean;
  78892. /**
  78893. * (Highcharts, Highstock) Whether to allow matching points by name in an
  78894. * update. If this option is disabled, points will be matched by order.
  78895. */
  78896. matchByName?: boolean;
  78897. /**
  78898. * (Highcharts, Highstock) Determines what data value should be used to sort
  78899. * by.
  78900. */
  78901. sortKey?: string;
  78902. }
  78903. /**
  78904. * (Highcharts, Highstock, Highmaps, Gantt) Style options for the guide box. The
  78905. * guide box has one state by default, the `default` state.
  78906. */
  78907. export interface PlotSeriesDragDropGuideBoxOptions {
  78908. /**
  78909. * (Highcharts, Highstock, Highmaps, Gantt) Style options for the guide box
  78910. * default state.
  78911. */
  78912. default?: DragDropGuideBoxOptionsObject;
  78913. }
  78914. /**
  78915. * (Highcharts, Highstock, Highmaps, Gantt) General options for all series
  78916. * types.
  78917. *
  78918. * In TypeScript the type option must always be set.
  78919. *
  78920. * Configuration options for the series are given in three levels:
  78921. *
  78922. * 1. Options for all series in a chart are defined in the plotOptions.series
  78923. * object.
  78924. *
  78925. * 2. Options for all `line` series are defined in plotOptions.line.
  78926. *
  78927. * 3. Options for one single series are given in the series instance array. (see
  78928. * online documentation for example)
  78929. */
  78930. export interface PlotSeriesOptions {
  78931. /**
  78932. * (Highcharts, Highstock, Highmaps, Gantt) Accessibility options for a
  78933. * series.
  78934. */
  78935. accessibility?: SeriesAccessibilityOptionsObject;
  78936. /**
  78937. * (Highmaps) Whether all areas of the map defined in `mapData` should be
  78938. * rendered. If `true`, areas which don't correspond to a data point, are
  78939. * rendered as `null` points. If `false`, those areas are skipped.
  78940. */
  78941. allAreas?: boolean;
  78942. /**
  78943. * (Highcharts, Highstock, Highmaps, Gantt) Allow this series' points to be
  78944. * selected by clicking on the graphic (columns, point markers, pie slices,
  78945. * map areas etc).
  78946. *
  78947. * The selected points can be handled by point select and unselect events,
  78948. * or collectively by the getSelectedPoints function.
  78949. *
  78950. * And alternative way of selecting points is through dragging.
  78951. */
  78952. allowPointSelect?: boolean;
  78953. /**
  78954. * (Highcharts, Highstock, Highmaps, Gantt) Enable or disable the initial
  78955. * animation when a series is displayed. The animation can also be set as a
  78956. * configuration object. Please note that this option only applies to the
  78957. * initial animation of the series itself. For other animations, see
  78958. * chart.animation and the animation parameter under the API methods. The
  78959. * following properties are supported:
  78960. *
  78961. * - `defer`: The animation delay time in milliseconds.
  78962. *
  78963. * - `duration`: The duration of the animation in milliseconds.
  78964. *
  78965. * - `easing`: Can be a string reference to an easing function set on the
  78966. * `Math` object or a function. See the _Custom easing function_ demo below.
  78967. *
  78968. * Due to poor performance, animation is disabled in old IE browsers for
  78969. * several chart types.
  78970. */
  78971. animation?: (boolean|PlotSeriesAnimationOptions|Partial<AnimationOptionsObject>);
  78972. /**
  78973. * (Highcharts, Highstock, Highmaps, Gantt) For some series, there is a
  78974. * limit that shuts down initial animation by default when the total number
  78975. * of points in the chart is too high. For example, for a column chart and
  78976. * its derivatives, animation does not run if there is more than 250 points
  78977. * totally. To disable this cap, set `animationLimit` to `Infinity`.
  78978. */
  78979. animationLimit?: number;
  78980. /**
  78981. * (Highcharts, Highstock, Highmaps, Gantt) Sets the color blending in the
  78982. * boost module.
  78983. */
  78984. boostBlending?: OptionsBoostBlendingValue;
  78985. /**
  78986. * (Highcharts, Highstock, Highmaps, Gantt) Set the point threshold for when
  78987. * a series should enter boost mode.
  78988. *
  78989. * Setting it to e.g. 2000 will cause the series to enter boost mode when
  78990. * there are 2000 or more points in the series.
  78991. *
  78992. * To disable boosting on the series, set the `boostThreshold` to 0. Setting
  78993. * it to 1 will force boosting.
  78994. *
  78995. * Note that the cropThreshold also affects this setting. When zooming in on
  78996. * a series that has fewer points than the `cropThreshold`, all points are
  78997. * rendered although outside the visible plot area, and the `boostThreshold`
  78998. * won't take effect.
  78999. */
  79000. boostThreshold?: number;
  79001. /**
  79002. * (Highmaps) The border color of the map areas.
  79003. *
  79004. * In styled mode, the border stroke is given in the `.highcharts-point`
  79005. * class.
  79006. */
  79007. borderColor?: (ColorString|GradientColorObject|PatternObject);
  79008. /**
  79009. * (Highmaps) The border width of each map area.
  79010. *
  79011. * In styled mode, the border stroke width is given in the
  79012. * `.highcharts-point` class.
  79013. */
  79014. borderWidth?: number;
  79015. /**
  79016. * (Highcharts, Highstock, Highmaps, Gantt) An additional class name to
  79017. * apply to the series' graphical elements. This option does not replace
  79018. * default class names of the graphical element.
  79019. */
  79020. className?: string;
  79021. /**
  79022. * (Highcharts, Highstock, Highmaps, Gantt) Disable this option to allow
  79023. * series rendering in the whole plotting area.
  79024. *
  79025. * **Note:** Clipping should be always enabled when chart.zoomType is set
  79026. */
  79027. clip?: boolean;
  79028. /**
  79029. * (Highcharts, Highstock, Highmaps, Gantt) The main color of the series. In
  79030. * line type series it applies to the line and the point markers unless
  79031. * otherwise specified. In bar type series it applies to the bars unless a
  79032. * color is specified per point. The default value is pulled from the
  79033. * `options.colors` array.
  79034. *
  79035. * In styled mode, the color can be defined by the colorIndex option. Also,
  79036. * the series color can be set with the `.highcharts-series`,
  79037. * `.highcharts-color-{n}`, `.highcharts-{type}-series` or
  79038. * `.highcharts-series-{n}` class, or individual classes given by the
  79039. * `className` option.
  79040. */
  79041. color?: (ColorString|GradientColorObject|PatternObject);
  79042. /**
  79043. * (Highcharts, Highstock, Highmaps) When using dual or multiple color axes,
  79044. * this number defines which colorAxis the particular series is connected
  79045. * to. It refers to either the axis id or the index of the axis in the
  79046. * colorAxis array, with 0 being the first. Set this option to false to
  79047. * prevent a series from connecting to the default color axis.
  79048. *
  79049. * Since v7.2.0 the option can also be an axis id or an axis index instead
  79050. * of a boolean flag.
  79051. */
  79052. colorAxis?: (boolean|number|string);
  79053. /**
  79054. * (Highcharts, Highstock, Highmaps, Gantt) Styled mode only. A specific
  79055. * color index to use for the series, so its graphic representations are
  79056. * given the class name `highcharts-color-{n}`.
  79057. */
  79058. colorIndex?: number;
  79059. /**
  79060. * (Highcharts, Highstock, Highmaps) Determines what data value should be
  79061. * used to calculate point color if `colorAxis` is used. Requires to set
  79062. * `min` and `max` if some custom point property is used or if approximation
  79063. * for data grouping is set to `'sum'`.
  79064. */
  79065. colorKey?: string;
  79066. /**
  79067. * (Highstock) Compare the values of the series against the first non-null,
  79068. * non- zero value in the visible range. The y axis will show percentage or
  79069. * absolute change depending on whether `compare` is set to `"percent"` or
  79070. * `"value"`. When this is applied to multiple series, it allows comparing
  79071. * the development of the series against each other. Adds a `change` field
  79072. * to every point object.
  79073. */
  79074. compare?: string;
  79075. /**
  79076. * (Highstock) When compare is `percent`, this option dictates whether to
  79077. * use 0 or 100 as the base of comparison.
  79078. */
  79079. compareBase?: (0|100);
  79080. /**
  79081. * (Highstock) Defines if comparison should start from the first point
  79082. * within the visible range or should start from the first point **before**
  79083. * the range.
  79084. *
  79085. * In other words, this flag determines if first point within the visible
  79086. * range will have 0% (`compareStart=true`) or should have been already
  79087. * calculated according to the previous point (`compareStart=false`).
  79088. */
  79089. compareStart?: boolean;
  79090. /**
  79091. * (Highcharts) Polar charts only. Whether to connect the ends of a line
  79092. * series plot across the extremes.
  79093. */
  79094. connectEnds?: boolean;
  79095. /**
  79096. * (Highcharts, Highstock) Whether to connect a graph line across null
  79097. * points, or render a gap between the two points on either side of the
  79098. * null.
  79099. */
  79100. connectNulls?: boolean;
  79101. /**
  79102. * (Gantt) Override Pathfinder connector options for a series. Requires
  79103. * Highcharts Gantt to be loaded.
  79104. */
  79105. connectors?: SeriesConnectorsOptionsObject;
  79106. /**
  79107. * (Highcharts, Highstock, Gantt) When true, each point or column edge is
  79108. * rounded to its nearest pixel in order to render sharp on screen. In some
  79109. * cases, when there are a lot of densely packed columns, this leads to
  79110. * visible difference in column widths or distance between columns. In these
  79111. * cases, setting `crisp` to `false` may look better, even though each
  79112. * column is rendered blurry.
  79113. */
  79114. crisp?: boolean;
  79115. /**
  79116. * (Highcharts, Highstock) When the series contains less points than the
  79117. * crop threshold, all points are drawn, even if the points fall outside the
  79118. * visible plot area at the current zoom. The advantage of drawing all
  79119. * points (including markers and columns), is that animation is performed on
  79120. * updates. On the other hand, when the series contains more points than the
  79121. * crop threshold, the series data is cropped to only contain points that
  79122. * fall within the plot area. The advantage of cropping away invisible
  79123. * points is to increase performance on large series.
  79124. */
  79125. cropThreshold?: number;
  79126. /**
  79127. * (Highcharts, Highstock, Highmaps, Gantt) You can set the cursor to
  79128. * "pointer" if you have click events attached to the series, to signal to
  79129. * the user that the points and lines can be clicked.
  79130. *
  79131. * In styled mode, the series cursor can be set with the same classes as
  79132. * listed under series.color.
  79133. */
  79134. cursor?: (string|CursorValue);
  79135. /**
  79136. * (Highcharts, Highstock, Highmaps, Gantt) A reserved subspace to store
  79137. * options and values for customized functionality. Here you can add
  79138. * additional data for your own event callbacks and formatter callbacks.
  79139. */
  79140. custom?: Dictionary<any>;
  79141. /**
  79142. * (Highcharts, Highstock, Highmaps, Gantt) Name of the dash style to use
  79143. * for the graph, or for some series types the outline of each shape.
  79144. *
  79145. * In styled mode, the stroke dash-array can be set with the same classes as
  79146. * listed under series.color.
  79147. */
  79148. dashStyle?: DashStyleValue;
  79149. /**
  79150. * (Highstock) Data grouping is the concept of sampling the data values into
  79151. * larger blocks in order to ease readability and increase performance of
  79152. * the JavaScript charts. Highstock by default applies data grouping when
  79153. * the points become closer than a certain pixel value, determined by the
  79154. * `groupPixelWidth` option.
  79155. *
  79156. * If data grouping is applied, the grouping information of grouped points
  79157. * can be read from the Point.dataGroup. If point options other than the
  79158. * data itself are set, for example `name` or `color` or custom properties,
  79159. * the grouping logic doesn't know how to group it. In this case the options
  79160. * of the first point instance are copied over to the group point. This can
  79161. * be altered through a custom `approximation` callback function.
  79162. */
  79163. dataGrouping?: DataGroupingOptionsObject;
  79164. /**
  79165. * (Highcharts, Highstock, Highmaps, Gantt) Options for the series data
  79166. * labels, appearing next to each data point.
  79167. *
  79168. * Since v6.2.0, multiple data labels can be applied to each single point by
  79169. * defining them as an array of configs.
  79170. *
  79171. * In styled mode, the data labels can be styled with the
  79172. * `.highcharts-data-label-box` and `.highcharts-data-label` class names
  79173. * (see example).
  79174. */
  79175. dataLabels?: (PlotSeriesDataLabelsOptions|Array<PlotSeriesDataLabelsOptions>);
  79176. /**
  79177. * (Highcharts, Highstock) Options for the series data sorting.
  79178. */
  79179. dataSorting?: (DataSortingOptionsObject|PlotSeriesDataSortingOptions);
  79180. /**
  79181. * (Highcharts, Highstock, Highmaps, Gantt) A description of the series to
  79182. * add to the screen reader information about the series.
  79183. */
  79184. description?: string;
  79185. /**
  79186. * (Highcharts, Highstock, Highmaps, Gantt) The draggable-points module
  79187. * allows points to be moved around or modified in the chart. In addition to
  79188. * the options mentioned under the `dragDrop` API structure, the module
  79189. * fires three events, point.dragStart, point.drag and point.drop.
  79190. */
  79191. dragDrop?: SeriesDragDropOptionsObject;
  79192. /**
  79193. * (Highcharts, Highstock, Highmaps, Gantt) Enable or disable the mouse
  79194. * tracking for a specific series. This includes point tooltips and click
  79195. * events on graphs and points. For large datasets it improves performance.
  79196. */
  79197. enableMouseTracking?: boolean;
  79198. /**
  79199. * (Highcharts, Highstock, Highmaps, Gantt) General event handlers for the
  79200. * series items. These event hooks can also be attached to the series at run
  79201. * time using the `Highcharts.addEvent` function.
  79202. */
  79203. events?: SeriesEventsOptionsObject;
  79204. /**
  79205. * (Highcharts, Highstock, Highmaps, Gantt) Determines whether the series
  79206. * should look for the nearest point in both dimensions or just the
  79207. * x-dimension when hovering the series. Defaults to `'xy'` for scatter
  79208. * series and `'x'` for most other series. If the data has duplicate
  79209. * x-values, it is recommended to set this to `'xy'` to allow hovering over
  79210. * all points.
  79211. *
  79212. * Applies only to series types using nearest neighbor search (not direct
  79213. * hover) for tooltip.
  79214. */
  79215. findNearestPointBy?: OptionsFindNearestPointByValue;
  79216. /**
  79217. * (Highstock) Defines when to display a gap in the graph, together with the
  79218. * gapUnit option.
  79219. *
  79220. * In case when `dataGrouping` is enabled, points can be grouped into a
  79221. * larger time span. This can make the grouped points to have a greater
  79222. * distance than the absolute value of `gapSize` property, which will result
  79223. * in disappearing graph completely. To prevent this situation the mentioned
  79224. * distance between grouped points is used instead of previously defined
  79225. * `gapSize`.
  79226. *
  79227. * In practice, this option is most often used to visualize gaps in time
  79228. * series. In a stock chart, intraday data is available for daytime hours,
  79229. * while gaps will appear in nights and weekends.
  79230. */
  79231. gapSize?: number;
  79232. /**
  79233. * (Highstock) Together with gapSize, this option defines where to draw gaps
  79234. * in the graph.
  79235. *
  79236. * When the `gapUnit` is `"relative"` (default), a gap size of 5 means that
  79237. * if the distance between two points is greater than 5 times that of the
  79238. * two closest points, the graph will be broken.
  79239. *
  79240. * When the `gapUnit` is `"value"`, the gap is based on absolute axis
  79241. * values, which on a datetime axis is milliseconds. This also applies to
  79242. * the navigator series that inherits gap options from the base series.
  79243. */
  79244. gapUnit?: OptionsGapUnitValue;
  79245. /**
  79246. * (Highcharts, Highstock, Gantt) Whether to use the Y extremes of the total
  79247. * chart width or only the zoomed area when zooming in on parts of the X
  79248. * axis. By default, the Y axis adjusts to the min and max of the visible
  79249. * data. Cartesian series only.
  79250. */
  79251. getExtremesFromAll?: boolean;
  79252. /**
  79253. * (Highcharts, Highstock, Highmaps, Gantt) When set to `false` will prevent
  79254. * the series data from being included in any form of data export.
  79255. *
  79256. * Since version 6.0.0 until 7.1.0 the option was existing undocumented as
  79257. * `includeInCSVExport`.
  79258. */
  79259. includeInDataExport?: boolean;
  79260. /**
  79261. * (Highmaps) What property to join the `mapData` to the value data. For
  79262. * example, if joinBy is "code", the mapData items with a specific code is
  79263. * merged into the data with the same code. For maps loaded from GeoJSON,
  79264. * the keys may be held in each point's `properties` object.
  79265. *
  79266. * The joinBy option can also be an array of two values, where the first
  79267. * points to a key in the `mapData`, and the second points to another key in
  79268. * the `data`.
  79269. *
  79270. * When joinBy is `null`, the map items are joined by their position in the
  79271. * array, which performs much better in maps with many data points. This is
  79272. * the recommended option if you are printing more than a thousand data
  79273. * points and have a backend that can preprocess the data into a parallel
  79274. * array of the mapData.
  79275. */
  79276. joinBy?: (string|Array<string>);
  79277. /**
  79278. * (Highcharts, Highstock, Highmaps, Gantt) An array specifying which option
  79279. * maps to which key in the data point array. This makes it convenient to
  79280. * work with unstructured data arrays from different sources.
  79281. */
  79282. keys?: Array<string>;
  79283. /**
  79284. * (Highcharts, Highstock, Gantt) Series labels are placed as close to the
  79285. * series as possible in a natural way, seeking to avoid other series. The
  79286. * goal of this feature is to make the chart more easily readable, like if a
  79287. * human designer placed the labels in the optimal position.
  79288. *
  79289. * The series labels currently work with series types having a `graph` or an
  79290. * `area`.
  79291. */
  79292. label?: SeriesLabelOptionsObject;
  79293. /**
  79294. * (Highstock) The line marks the last price from all points.
  79295. */
  79296. lastPrice?: SeriesLastPriceOptionsObject;
  79297. /**
  79298. * (Highstock) The line marks the last price from visible range of points.
  79299. */
  79300. lastVisiblePrice?: SeriesLastVisiblePriceOptionsObject;
  79301. /**
  79302. * (Highcharts, Highstock) The line cap used for line ends and line joins on
  79303. * the graph.
  79304. */
  79305. linecap?: SeriesLinecapValue;
  79306. /**
  79307. * (Highcharts, Highstock) Pixel width of the graph line.
  79308. */
  79309. lineWidth?: number;
  79310. /**
  79311. * (Highcharts, Highstock, Gantt) The id of another series to link to.
  79312. * Additionally, the value can be ":previous" to link to the previous
  79313. * series. When two series are linked, only the first one appears in the
  79314. * legend. Toggling the visibility of this also toggles the linked series.
  79315. *
  79316. * If master series uses data sorting and linked series does not have its
  79317. * own sorting definition, the linked series will be sorted in the same
  79318. * order as the master one.
  79319. */
  79320. linkedTo?: string;
  79321. /**
  79322. * (Highcharts, Highstock, Highmaps, Gantt) Options for the point markers of
  79323. * line-like series. Properties like `fillColor`, `lineColor` and
  79324. * `lineWidth` define the visual appearance of the markers. Other series
  79325. * types, like column series, don't have markers, but have visual options on
  79326. * the series level instead.
  79327. *
  79328. * In styled mode, the markers can be styled with the `.highcharts-point`,
  79329. * `.highcharts-point-hover` and `.highcharts-point-select` class names.
  79330. */
  79331. marker?: PointMarkerOptionsObject;
  79332. /**
  79333. * (Highstock) Options for the corresponding navigator series if
  79334. * `showInNavigator` is `true` for this series. Available options are the
  79335. * same as any series, documented at plotOptions and series.
  79336. *
  79337. * These options are merged with options in navigator.series, and will take
  79338. * precedence if the same option is defined both places.
  79339. */
  79340. navigatorOptions?: PlotSeriesOptions;
  79341. /**
  79342. * (Highcharts, Highstock, Highmaps, Gantt) The color for the parts of the
  79343. * graph or points that are below the threshold. Note that `zones` takes
  79344. * precedence over the negative color. Using `negativeColor` is equivalent
  79345. * to applying a zone with value of 0.
  79346. */
  79347. negativeColor?: (ColorString|GradientColorObject|PatternObject);
  79348. /**
  79349. * (Highcharts, Highstock, Highmaps, Gantt) Opacity of a series parts: line,
  79350. * fill (e.g. area) and dataLabels.
  79351. */
  79352. opacity?: number;
  79353. /**
  79354. * (Highcharts, Highstock, Highmaps, Gantt) Properties for each single
  79355. * point.
  79356. */
  79357. point?: PlotSeriesPointOptions;
  79358. /**
  79359. * (Highcharts, Highstock, Highmaps, Gantt) Same as
  79360. * accessibility.pointDescriptionFormatter, but for an individual series.
  79361. * Overrides the chart wide configuration.
  79362. */
  79363. pointDescriptionFormatter?: Function;
  79364. /**
  79365. * (Highcharts, Highstock, Gantt) If no x values are given for the points in
  79366. * a series, `pointInterval` defines the interval of the x values. For
  79367. * example, if a series contains one value every decade starting from year
  79368. * 0, set `pointInterval` to `10`. In true `datetime` axes, the
  79369. * `pointInterval` is set in milliseconds.
  79370. *
  79371. * It can be also be combined with `pointIntervalUnit` to draw irregular
  79372. * time intervals.
  79373. *
  79374. * Please note that this options applies to the _series data_, not the
  79375. * interval of the axis ticks, which is independent.
  79376. */
  79377. pointInterval?: number;
  79378. /**
  79379. * (Highcharts, Highstock, Gantt) On datetime series, this allows for
  79380. * setting the pointInterval to irregular time units, `day`, `month` and
  79381. * `year`. A day is usually the same as 24 hours, but `pointIntervalUnit`
  79382. * also takes the DST crossover into consideration when dealing with local
  79383. * time. Combine this option with `pointInterval` to draw weeks, quarters, 6
  79384. * months, 10 years etc.
  79385. *
  79386. * Please note that this options applies to the _series data_, not the
  79387. * interval of the axis ticks, which is independent.
  79388. */
  79389. pointIntervalUnit?: OptionsPointIntervalUnitValue;
  79390. /**
  79391. * (Highcharts, Highstock, Gantt) Possible values: `"on"`, `"between"`,
  79392. * `number`.
  79393. *
  79394. * In a column chart, when pointPlacement is `"on"`, the point will not
  79395. * create any padding of the X axis. In a polar column chart this means that
  79396. * the first column points directly north. If the pointPlacement is
  79397. * `"between"`, the columns will be laid out between ticks. This is useful
  79398. * for example for visualising an amount between two points in time or in a
  79399. * certain sector of a polar chart.
  79400. *
  79401. * Since Highcharts 3.0.2, the point placement can also be numeric, where 0
  79402. * is on the axis value, -0.5 is between this value and the previous, and
  79403. * 0.5 is between this value and the next. Unlike the textual options,
  79404. * numeric point placement options won't affect axis padding.
  79405. *
  79406. * Note that pointPlacement needs a pointRange to work. For column series
  79407. * this is computed, but for line-type series it needs to be set.
  79408. *
  79409. * For the `xrange` series type and gantt charts, if the Y axis is a
  79410. * category axis, the `pointPlacement` applies to the Y axis rather than the
  79411. * (typically datetime) X axis.
  79412. *
  79413. * Defaults to `undefined` in cartesian charts, `"between"` in polar charts.
  79414. */
  79415. pointPlacement?: (number|string);
  79416. /**
  79417. * (Highstock) The width of each point on the x axis. For example in a
  79418. * column chart with one value each day, the pointRange would be 1 day (= 24
  79419. * * 3600
  79420. *
  79421. * * 1000 milliseconds). This is normally computed automatically, but this
  79422. * option can be used to override the automatic value.
  79423. */
  79424. pointRange?: number;
  79425. /**
  79426. * (Highcharts, Highstock, Gantt) If no x values are given for the points in
  79427. * a series, pointStart defines on what value to start. For example, if a
  79428. * series contains one yearly value starting from 1945, set pointStart to
  79429. * 1945.
  79430. */
  79431. pointStart?: number;
  79432. /**
  79433. * (Highcharts, Highstock, Highmaps, Gantt) Whether to select the series
  79434. * initially. If `showCheckbox` is true, the checkbox next to the series
  79435. * name in the legend will be checked for a selected series.
  79436. */
  79437. selected?: boolean;
  79438. /**
  79439. * (Highcharts, Highstock, Highmaps, Gantt) Whether to apply a drop shadow
  79440. * to the graph line. Since 2.3 the shadow can be an object configuration
  79441. * containing `color`, `offsetX`, `offsetY`, `opacity` and `width`.
  79442. */
  79443. shadow?: (boolean|ShadowOptionsObject);
  79444. /**
  79445. * (Highcharts, Highstock, Highmaps, Gantt) If true, a checkbox is displayed
  79446. * next to the legend item to allow selecting the series. The state of the
  79447. * checkbox is determined by the `selected` option.
  79448. */
  79449. showCheckbox?: boolean;
  79450. /**
  79451. * (Highcharts, Highstock, Highmaps, Gantt) Whether to display this
  79452. * particular series or series type in the legend. Standalone series are
  79453. * shown in legend by default, and linked series are not. Since v7.2.0 it is
  79454. * possible to show series that use colorAxis by setting this option to
  79455. * `true`.
  79456. */
  79457. showInLegend?: boolean;
  79458. /**
  79459. * (Highstock) Whether or not to show the series in the navigator. Takes
  79460. * precedence over navigator.baseSeries if defined.
  79461. */
  79462. showInNavigator?: boolean;
  79463. /**
  79464. * (Highcharts, Highstock, Highmaps, Gantt) If set to `true`, the
  79465. * accessibility module will skip past the points in this series for
  79466. * keyboard navigation.
  79467. */
  79468. skipKeyboardNavigation?: boolean;
  79469. /**
  79470. * (Highcharts, Highstock) When this is true, the series will not cause the
  79471. * Y axis to cross the zero plane (or threshold option) unless the data
  79472. * actually crosses the plane.
  79473. *
  79474. * For example, if `softThreshold` is `false`, a series of 0, 1, 2, 3 will
  79475. * make the Y axis show negative values according to the `minPadding`
  79476. * option. If `softThreshold` is `true`, the Y axis starts at 0.
  79477. */
  79478. softThreshold?: boolean;
  79479. /**
  79480. * (Highcharts, Highstock) Whether to stack the values of each series on top
  79481. * of each other. Possible values are `undefined` to disable, `"normal"` to
  79482. * stack by value or `"percent"`.
  79483. *
  79484. * When stacking is enabled, data must be sorted in ascending X order.
  79485. *
  79486. * Some stacking options are related to specific series types. In the
  79487. * streamgraph series type, the stacking option is set to `"stream"`. The
  79488. * second one is `"overlap"`, which only applies to waterfall series.
  79489. */
  79490. stacking?: OptionsStackingValue;
  79491. states?: SeriesStatesOptionsObject;
  79492. /**
  79493. * (Highcharts, Highstock) Whether to apply steps to the line. Possible
  79494. * values are `left`, `center` and `right`.
  79495. */
  79496. step?: OptionsStepValue;
  79497. /**
  79498. * (Highcharts, Highstock, Highmaps, Gantt) Sticky tracking of mouse events.
  79499. * When true, the `mouseOut` event on a series isn't triggered until the
  79500. * mouse moves over another series, or out of the plot area. When false, the
  79501. * `mouseOut` event on a series is triggered when the mouse leaves the area
  79502. * around the series' graph or markers. This also implies the tooltip when
  79503. * not shared. When `stickyTracking` is false and `tooltip.shared` is false,
  79504. * the tooltip will be hidden when moving the mouse between series. Defaults
  79505. * to true for line and area type series, but to false for columns, pies
  79506. * etc.
  79507. *
  79508. * **Note:** The boost module will force this option because of technical
  79509. * limitations.
  79510. */
  79511. stickyTracking?: boolean;
  79512. /**
  79513. * (Highcharts, Highstock) The threshold, also called zero level or base
  79514. * level. For line type series this is only used in conjunction with
  79515. * negativeColor.
  79516. */
  79517. threshold?: (number|null);
  79518. /**
  79519. * (Highcharts, Highstock, Highmaps, Gantt) A configuration object for the
  79520. * tooltip rendering of each single series. Properties are inherited from
  79521. * tooltip, but only the following properties can be defined on a series
  79522. * level.
  79523. */
  79524. tooltip?: SeriesTooltipOptionsObject;
  79525. /**
  79526. * (Highcharts, Highstock, Gantt) When a series contains a data array that
  79527. * is longer than this, only one dimensional arrays of numbers, or two
  79528. * dimensional arrays with x and y values are allowed. Also, only the first
  79529. * point is tested, and the rest are assumed to be the same format. This
  79530. * saves expensive data checking and indexing in long series. Set it to `0`
  79531. * disable.
  79532. *
  79533. * Note: In boost mode turbo threshold is forced. Only array of numbers or
  79534. * two dimensional arrays are allowed.
  79535. */
  79536. turboThreshold?: number;
  79537. /**
  79538. * (Highcharts, Highstock, Highmaps, Gantt) Set the initial visibility of
  79539. * the series.
  79540. */
  79541. visible?: boolean;
  79542. /**
  79543. * (Highmaps) Define the z index of the series.
  79544. */
  79545. zIndex?: number;
  79546. /**
  79547. * (Highcharts, Highstock) Defines the Axis on which the zones are applied.
  79548. */
  79549. zoneAxis?: string;
  79550. /**
  79551. * (Highcharts, Highstock) An array defining zones within a series. Zones
  79552. * can be applied to the X axis, Y axis or Z axis for bubbles, according to
  79553. * the `zoneAxis` option. The zone definitions have to be in ascending order
  79554. * regarding to the value.
  79555. *
  79556. * In styled mode, the color zones are styled with the
  79557. * `.highcharts-zone-{n}` class, or custom classed from the `className`
  79558. * option (view live demo).
  79559. */
  79560. zones?: Array<SeriesZonesOptionsObject>;
  79561. }
  79562. /**
  79563. * (Highstock) Properties for each single point.
  79564. */
  79565. export interface PlotSeriesPointOptions {
  79566. /**
  79567. * (Highstock) Events for each single point.
  79568. */
  79569. events?: PointEventsOptionsObject;
  79570. }
  79571. /**
  79572. * (Highstock) Enable or disable the initial animation when a series is
  79573. * displayed. The animation can also be set as a configuration object. Please
  79574. * note that this option only applies to the initial animation of the series
  79575. * itself. For other animations, see chart.animation and the animation parameter
  79576. * under the API methods. The following properties are supported:
  79577. *
  79578. * - `defer`: The animation delay time in milliseconds.
  79579. *
  79580. * - `duration`: The duration of the animation in milliseconds.
  79581. *
  79582. * - `easing`: Can be a string reference to an easing function set on the `Math`
  79583. * object or a function. See the _Custom easing function_ demo below.
  79584. *
  79585. * Due to poor performance, animation is disabled in old IE browsers for several
  79586. * chart types.
  79587. */
  79588. export interface PlotSlowstochasticAnimationOptions {
  79589. defer?: number;
  79590. }
  79591. /**
  79592. * (Highcharts, Highstock, Highmaps, Gantt) Enable or disable the initial
  79593. * animation when a series is displayed for the `dataLabels`. The animation can
  79594. * also be set as a configuration object. Please note that this option only
  79595. * applies to the initial animation. For other animations, see chart.animation
  79596. * and the animation parameter under the API methods. The following properties
  79597. * are supported:
  79598. *
  79599. * - `defer`: The animation delay time in milliseconds.
  79600. */
  79601. export interface PlotSlowstochasticDataLabelsAnimationOptions {
  79602. /**
  79603. * (Highcharts, Highstock, Highmaps, Gantt) The animation delay time in
  79604. * milliseconds. Set to `0` renders dataLabel immediately. As `undefined`
  79605. * inherits defer time from the series.animation.defer.
  79606. */
  79607. defer?: number;
  79608. }
  79609. /**
  79610. * (Highcharts, Highstock, Highmaps, Gantt) Options for the series data labels,
  79611. * appearing next to each data point.
  79612. *
  79613. * Since v6.2.0, multiple data labels can be applied to each single point by
  79614. * defining them as an array of configs.
  79615. *
  79616. * In styled mode, the data labels can be styled with the
  79617. * `.highcharts-data-label-box` and `.highcharts-data-label` class names (see
  79618. * example).
  79619. */
  79620. export interface PlotSlowstochasticDataLabelsOptions {
  79621. /**
  79622. * (Highcharts, Highstock, Highmaps, Gantt) The alignment of the data label
  79623. * compared to the point. If `right`, the right side of the label should be
  79624. * touching the point. For points with an extent, like columns, the
  79625. * alignments also dictates how to align it inside the box, as given with
  79626. * the inside option. Can be one of `left`, `center` or `right`.
  79627. */
  79628. align?: (AlignValue|null);
  79629. /**
  79630. * (Highcharts, Highstock, Highmaps, Gantt) Whether to allow data labels to
  79631. * overlap. To make the labels less sensitive for overlapping, the
  79632. * dataLabels.padding can be set to 0.
  79633. */
  79634. allowOverlap?: boolean;
  79635. /**
  79636. * (Highcharts, Highstock, Highmaps, Gantt) Enable or disable the initial
  79637. * animation when a series is displayed for the `dataLabels`. The animation
  79638. * can also be set as a configuration object. Please note that this option
  79639. * only applies to the initial animation. For other animations, see
  79640. * chart.animation and the animation parameter under the API methods. The
  79641. * following properties are supported:
  79642. *
  79643. * - `defer`: The animation delay time in milliseconds.
  79644. */
  79645. animation?: (boolean|PlotSlowstochasticDataLabelsAnimationOptions|Partial<AnimationOptionsObject>);
  79646. /**
  79647. * (Highcharts, Highstock, Highmaps, Gantt) The background color or gradient
  79648. * for the data label.
  79649. */
  79650. backgroundColor?: (ColorString|GradientColorObject|PatternObject);
  79651. /**
  79652. * (Highcharts, Highstock, Highmaps, Gantt) The border color for the data
  79653. * label. Defaults to `undefined`.
  79654. */
  79655. borderColor?: (ColorString|GradientColorObject|PatternObject);
  79656. /**
  79657. * (Highcharts, Highstock, Highmaps, Gantt) The border radius in pixels for
  79658. * the data label.
  79659. */
  79660. borderRadius?: number;
  79661. /**
  79662. * (Highcharts, Highstock, Highmaps, Gantt) The border width in pixels for
  79663. * the data label.
  79664. */
  79665. borderWidth?: number;
  79666. /**
  79667. * (Highcharts, Highstock, Highmaps, Gantt) A class name for the data label.
  79668. * Particularly in styled mode, this can be used to give each series' or
  79669. * point's data label unique styling. In addition to this option, a default
  79670. * color class name is added so that we can give the labels a contrast text
  79671. * shadow.
  79672. */
  79673. className?: string;
  79674. /**
  79675. * (Highcharts, Highstock, Highmaps, Gantt) The text color for the data
  79676. * labels. Defaults to `undefined`. For certain series types, like column or
  79677. * map, the data labels can be drawn inside the points. In this case the
  79678. * data label will be drawn with maximum contrast by default. Additionally,
  79679. * it will be given a `text-outline` style with the opposite color, to
  79680. * further increase the contrast. This can be overridden by setting the
  79681. * `text-outline` style to `none` in the `dataLabels.style` option.
  79682. */
  79683. color?: (ColorString|GradientColorObject|PatternObject);
  79684. /**
  79685. * (Highcharts, Highstock, Highmaps, Gantt) Whether to hide data labels that
  79686. * are outside the plot area. By default, the data label is moved inside the
  79687. * plot area according to the overflow option.
  79688. */
  79689. crop?: boolean;
  79690. /**
  79691. * (Highcharts, Highstock, Gantt) Whether to defer displaying the data
  79692. * labels until the initial series animation has finished. Setting to
  79693. * `false` renders the data label immediately. If set to `true` inherits the
  79694. * defer time set in plotOptions.series.animation.
  79695. */
  79696. defer?: boolean;
  79697. /**
  79698. * (Highcharts, Highstock, Highmaps, Gantt) Enable or disable the data
  79699. * labels.
  79700. */
  79701. enabled?: boolean;
  79702. /**
  79703. * (Highcharts, Highstock, Highmaps, Gantt) A declarative filter to control
  79704. * of which data labels to display. The declarative filter is designed for
  79705. * use when callback functions are not available, like when the chart
  79706. * options require a pure JSON structure or for use with graphical editors.
  79707. * For programmatic control, use the `formatter` instead, and return
  79708. * `undefined` to disable a single data label.
  79709. */
  79710. filter?: DataLabelsFilterOptionsObject;
  79711. /**
  79712. * (Highcharts, Highstock, Highmaps, Gantt) A format string for the data
  79713. * label. Available variables are the same as for `formatter`.
  79714. */
  79715. format?: string;
  79716. /**
  79717. * (Highcharts, Highstock, Highmaps, Gantt) Callback JavaScript function to
  79718. * format the data label. Note that if a `format` is defined, the format
  79719. * takes precedence and the formatter is ignored.
  79720. */
  79721. formatter?: DataLabelsFormatterCallbackFunction;
  79722. /**
  79723. * (Highcharts, Highstock, Highmaps, Gantt) For points with an extent, like
  79724. * columns or map areas, whether to align the data label inside the box or
  79725. * to the actual value point. Defaults to `false` in most cases, `true` in
  79726. * stacked columns.
  79727. */
  79728. inside?: boolean;
  79729. /**
  79730. * (Highcharts, Highstock, Highmaps, Gantt) Format for points with the value
  79731. * of null. Works analogously to format. `nullFormat` can be applied only to
  79732. * series which support displaying null points.
  79733. */
  79734. nullFormat?: (boolean|string);
  79735. /**
  79736. * (Highcharts, Highstock, Highmaps, Gantt) Callback JavaScript function
  79737. * that defines formatting for points with the value of null. Works
  79738. * analogously to formatter. `nullPointFormatter` can be applied only to
  79739. * series which support displaying null points.
  79740. */
  79741. nullFormatter?: DataLabelsFormatterCallbackFunction;
  79742. /**
  79743. * (Highcharts, Highstock, Highmaps, Gantt) How to handle data labels that
  79744. * flow outside the plot area. The default is `"justify"`, which aligns them
  79745. * inside the plot area. For columns and bars, this means it will be moved
  79746. * inside the bar. To display data labels outside the plot area, set `crop`
  79747. * to `false` and `overflow` to `"allow"`.
  79748. */
  79749. overflow?: DataLabelsOverflowValue;
  79750. /**
  79751. * (Highcharts, Highstock, Highmaps, Gantt) When either the `borderWidth` or
  79752. * the `backgroundColor` is set, this is the padding within the box.
  79753. */
  79754. padding?: number;
  79755. /**
  79756. * (Highcharts, Highstock, Highmaps, Gantt) Aligns data labels relative to
  79757. * points. If `center` alignment is not possible, it defaults to `right`.
  79758. */
  79759. position?: AlignValue;
  79760. /**
  79761. * (Highcharts, Highstock, Highmaps, Gantt) Text rotation in degrees. Note
  79762. * that due to a more complex structure, backgrounds, borders and padding
  79763. * will be lost on a rotated data label.
  79764. */
  79765. rotation?: number;
  79766. /**
  79767. * (Highcharts, Highstock, Highmaps, Gantt) The shadow of the box. Works
  79768. * best with `borderWidth` or `backgroundColor`. Since 2.3 the shadow can be
  79769. * an object configuration containing `color`, `offsetX`, `offsetY`,
  79770. * `opacity` and `width`.
  79771. */
  79772. shadow?: (boolean|ShadowOptionsObject);
  79773. /**
  79774. * (Highcharts, Highstock, Highmaps, Gantt) The name of a symbol to use for
  79775. * the border around the label. Symbols are predefined functions on the
  79776. * Renderer object.
  79777. */
  79778. shape?: string;
  79779. /**
  79780. * (Highcharts, Highstock, Highmaps, Gantt) Styles for the label. The
  79781. * default `color` setting is `"contrast"`, which is a pseudo color that
  79782. * Highcharts picks up and applies the maximum contrast to the underlying
  79783. * point item, for example the bar in a bar chart.
  79784. *
  79785. * The `textOutline` is a pseudo property that applies an outline of the
  79786. * given width with the given color, which by default is the maximum
  79787. * contrast to the text. So a bright text color will result in a black text
  79788. * outline for maximum readability on a mixed background. In some cases,
  79789. * especially with grayscale text, the text outline doesn't work well, in
  79790. * which cases it can be disabled by setting it to `"none"`. When `useHTML`
  79791. * is true, the `textOutline` will not be picked up. In this, case, the same
  79792. * effect can be acheived through the `text-shadow` CSS property.
  79793. *
  79794. * For some series types, where each point has an extent, like for example
  79795. * tree maps, the data label may overflow the point. There are two
  79796. * strategies for handling overflow. By default, the text will wrap to
  79797. * multiple lines. The other strategy is to set `style.textOverflow` to
  79798. * `ellipsis`, which will keep the text on one line plus it will break
  79799. * inside long words.
  79800. */
  79801. style?: CSSObject;
  79802. /**
  79803. * (Highcharts, Highstock, Highmaps, Gantt) Options for a label text which
  79804. * should follow marker's shape. Border and background are disabled for a
  79805. * label that follows a path.
  79806. *
  79807. * **Note:** Only SVG-based renderer supports this option. Setting `useHTML`
  79808. * to true will disable this option.
  79809. */
  79810. textPath?: DataLabelsTextPathOptionsObject;
  79811. /**
  79812. * (Highcharts, Highstock, Highmaps, Gantt) Whether to use HTML to render
  79813. * the labels.
  79814. */
  79815. useHTML?: boolean;
  79816. /**
  79817. * (Highcharts, Highstock, Highmaps, Gantt) The vertical alignment of a data
  79818. * label. Can be one of `top`, `middle` or `bottom`. The default value
  79819. * depends on the data, for instance in a column chart, the label is above
  79820. * positive values and below negative values.
  79821. */
  79822. verticalAlign?: (VerticalAlignValue|null);
  79823. /**
  79824. * (Highcharts, Highstock, Highmaps, Gantt) The x position offset of the
  79825. * label relative to the point in pixels.
  79826. */
  79827. x?: number;
  79828. /**
  79829. * (Highcharts, Highstock, Highmaps, Gantt) The y position offset of the
  79830. * label relative to the point in pixels.
  79831. */
  79832. y?: number;
  79833. /**
  79834. * (Highcharts, Highstock, Highmaps, Gantt) The Z index of the data labels.
  79835. * The default Z index puts it above the series. Use a Z index of 2 to
  79836. * display it behind the series.
  79837. */
  79838. z?: number;
  79839. }
  79840. /**
  79841. * (Highcharts, Highstock) Options for the series data sorting.
  79842. */
  79843. export interface PlotSlowstochasticDataSortingOptions {
  79844. /**
  79845. * (Highcharts, Highstock) Enable or disable data sorting for the series.
  79846. * Use xAxis.reversed to change the sorting order.
  79847. */
  79848. enabled?: boolean;
  79849. /**
  79850. * (Highcharts, Highstock) Whether to allow matching points by name in an
  79851. * update. If this option is disabled, points will be matched by order.
  79852. */
  79853. matchByName?: boolean;
  79854. /**
  79855. * (Highcharts, Highstock) Determines what data value should be used to sort
  79856. * by.
  79857. */
  79858. sortKey?: string;
  79859. }
  79860. /**
  79861. * (Highstock) Slow Stochastic oscillator. This series requires the `linkedTo`
  79862. * option to be set and should be loaded after `stock/indicators/indicators.js`
  79863. * and `stock/indicators/stochastic.js` files.
  79864. *
  79865. * In TypeScript the type option must always be set.
  79866. *
  79867. * Configuration options for the series are given in three levels:
  79868. *
  79869. * 1. Options for all series in a chart are defined in the plotOptions.series
  79870. * object.
  79871. *
  79872. * 2. Options for all `slowstochastic` series are defined in
  79873. * plotOptions.slowstochastic.
  79874. *
  79875. * 3. Options for one single series are given in the series instance array. (see
  79876. * online documentation for example)
  79877. */
  79878. export interface PlotSlowstochasticOptions {
  79879. /**
  79880. * (Highstock) Accessibility options for a series.
  79881. */
  79882. accessibility?: SeriesAccessibilityOptionsObject;
  79883. /**
  79884. * (Highstock) Allow this series' points to be selected by clicking on the
  79885. * graphic (columns, point markers, pie slices, map areas etc).
  79886. *
  79887. * The selected points can be handled by point select and unselect events,
  79888. * or collectively by the getSelectedPoints function.
  79889. *
  79890. * And alternative way of selecting points is through dragging.
  79891. */
  79892. allowPointSelect?: boolean;
  79893. /**
  79894. * (Highstock) Enable or disable the initial animation when a series is
  79895. * displayed. The animation can also be set as a configuration object.
  79896. * Please note that this option only applies to the initial animation of the
  79897. * series itself. For other animations, see chart.animation and the
  79898. * animation parameter under the API methods. The following properties are
  79899. * supported:
  79900. *
  79901. * - `defer`: The animation delay time in milliseconds.
  79902. *
  79903. * - `duration`: The duration of the animation in milliseconds.
  79904. *
  79905. * - `easing`: Can be a string reference to an easing function set on the
  79906. * `Math` object or a function. See the _Custom easing function_ demo below.
  79907. *
  79908. * Due to poor performance, animation is disabled in old IE browsers for
  79909. * several chart types.
  79910. */
  79911. animation?: (boolean|PlotSlowstochasticAnimationOptions|Partial<AnimationOptionsObject>);
  79912. /**
  79913. * (Highstock) For some series, there is a limit that shuts down initial
  79914. * animation by default when the total number of points in the chart is too
  79915. * high. For example, for a column chart and its derivatives, animation does
  79916. * not run if there is more than 250 points totally. To disable this cap,
  79917. * set `animationLimit` to `Infinity`.
  79918. */
  79919. animationLimit?: number;
  79920. /**
  79921. * (Highstock) Sets the color blending in the boost module.
  79922. */
  79923. boostBlending?: OptionsBoostBlendingValue;
  79924. /**
  79925. * (Highstock) Set the point threshold for when a series should enter boost
  79926. * mode.
  79927. *
  79928. * Setting it to e.g. 2000 will cause the series to enter boost mode when
  79929. * there are 2000 or more points in the series.
  79930. *
  79931. * To disable boosting on the series, set the `boostThreshold` to 0. Setting
  79932. * it to 1 will force boosting.
  79933. *
  79934. * Note that the cropThreshold also affects this setting. When zooming in on
  79935. * a series that has fewer points than the `cropThreshold`, all points are
  79936. * rendered although outside the visible plot area, and the `boostThreshold`
  79937. * won't take effect.
  79938. */
  79939. boostThreshold?: number;
  79940. /**
  79941. * (Highmaps) The border color of the map areas.
  79942. *
  79943. * In styled mode, the border stroke is given in the `.highcharts-point`
  79944. * class.
  79945. */
  79946. borderColor?: (ColorString|GradientColorObject|PatternObject);
  79947. /**
  79948. * (Highmaps) The border width of each map area.
  79949. *
  79950. * In styled mode, the border stroke width is given in the
  79951. * `.highcharts-point` class.
  79952. */
  79953. borderWidth?: number;
  79954. /**
  79955. * (Highstock) An additional class name to apply to the series' graphical
  79956. * elements. This option does not replace default class names of the
  79957. * graphical element.
  79958. */
  79959. className?: string;
  79960. /**
  79961. * (Highstock) Disable this option to allow series rendering in the whole
  79962. * plotting area.
  79963. *
  79964. * **Note:** Clipping should be always enabled when chart.zoomType is set
  79965. */
  79966. clip?: boolean;
  79967. /**
  79968. * (Highstock) The main color of the series. In line type series it applies
  79969. * to the line and the point markers unless otherwise specified. In bar type
  79970. * series it applies to the bars unless a color is specified per point. The
  79971. * default value is pulled from the `options.colors` array.
  79972. *
  79973. * In styled mode, the color can be defined by the colorIndex option. Also,
  79974. * the series color can be set with the `.highcharts-series`,
  79975. * `.highcharts-color-{n}`, `.highcharts-{type}-series` or
  79976. * `.highcharts-series-{n}` class, or individual classes given by the
  79977. * `className` option.
  79978. */
  79979. color?: (ColorString|GradientColorObject|PatternObject);
  79980. /**
  79981. * (Highstock) Styled mode only. A specific color index to use for the
  79982. * series, so its graphic representations are given the class name
  79983. * `highcharts-color-{n}`.
  79984. */
  79985. colorIndex?: number;
  79986. /**
  79987. * (Highcharts, Highstock, Highmaps) Determines what data value should be
  79988. * used to calculate point color if `colorAxis` is used. Requires to set
  79989. * `min` and `max` if some custom point property is used or if approximation
  79990. * for data grouping is set to `'sum'`.
  79991. */
  79992. colorKey?: string;
  79993. /**
  79994. * (Highstock) Compare the values of the series against the first non-null,
  79995. * non- zero value in the visible range. The y axis will show percentage or
  79996. * absolute change depending on whether `compare` is set to `"percent"` or
  79997. * `"value"`. When this is applied to multiple series, it allows comparing
  79998. * the development of the series against each other. Adds a `change` field
  79999. * to every point object.
  80000. */
  80001. compare?: string;
  80002. /**
  80003. * (Highstock) When compare is `percent`, this option dictates whether to
  80004. * use 0 or 100 as the base of comparison.
  80005. */
  80006. compareBase?: (0|100);
  80007. /**
  80008. * (Highstock) Defines if comparison should start from the first point
  80009. * within the visible range or should start from the first point **before**
  80010. * the range.
  80011. *
  80012. * In other words, this flag determines if first point within the visible
  80013. * range will have 0% (`compareStart=true`) or should have been already
  80014. * calculated according to the previous point (`compareStart=false`).
  80015. */
  80016. compareStart?: boolean;
  80017. /**
  80018. * (Highstock) Whether to compare indicator to the main series values or
  80019. * indicator values.
  80020. */
  80021. compareToMain?: boolean;
  80022. /**
  80023. * (Highcharts) Polar charts only. Whether to connect the ends of a line
  80024. * series plot across the extremes.
  80025. */
  80026. connectEnds?: boolean;
  80027. /**
  80028. * (Highcharts, Highstock) Whether to connect a graph line across null
  80029. * points, or render a gap between the two points on either side of the
  80030. * null.
  80031. */
  80032. connectNulls?: boolean;
  80033. /**
  80034. * (Gantt) Override Pathfinder connector options for a series. Requires
  80035. * Highcharts Gantt to be loaded.
  80036. */
  80037. connectors?: SeriesConnectorsOptionsObject;
  80038. /**
  80039. * (Highcharts, Highstock, Gantt) When true, each point or column edge is
  80040. * rounded to its nearest pixel in order to render sharp on screen. In some
  80041. * cases, when there are a lot of densely packed columns, this leads to
  80042. * visible difference in column widths or distance between columns. In these
  80043. * cases, setting `crisp` to `false` may look better, even though each
  80044. * column is rendered blurry.
  80045. */
  80046. crisp?: boolean;
  80047. /**
  80048. * (Highcharts, Highstock) When the series contains less points than the
  80049. * crop threshold, all points are drawn, even if the points fall outside the
  80050. * visible plot area at the current zoom. The advantage of drawing all
  80051. * points (including markers and columns), is that animation is performed on
  80052. * updates. On the other hand, when the series contains more points than the
  80053. * crop threshold, the series data is cropped to only contain points that
  80054. * fall within the plot area. The advantage of cropping away invisible
  80055. * points is to increase performance on large series.
  80056. */
  80057. cropThreshold?: number;
  80058. /**
  80059. * (Highstock) You can set the cursor to "pointer" if you have click events
  80060. * attached to the series, to signal to the user that the points and lines
  80061. * can be clicked.
  80062. *
  80063. * In styled mode, the series cursor can be set with the same classes as
  80064. * listed under series.color.
  80065. */
  80066. cursor?: (string|CursorValue);
  80067. /**
  80068. * (Highstock) A reserved subspace to store options and values for
  80069. * customized functionality. Here you can add additional data for your own
  80070. * event callbacks and formatter callbacks.
  80071. */
  80072. custom?: Dictionary<any>;
  80073. /**
  80074. * (Highstock) Name of the dash style to use for the graph, or for some
  80075. * series types the outline of each shape.
  80076. *
  80077. * In styled mode, the stroke dash-array can be set with the same classes as
  80078. * listed under series.color.
  80079. */
  80080. dashStyle?: DashStyleValue;
  80081. /**
  80082. * (Highstock) Data grouping is the concept of sampling the data values into
  80083. * larger blocks in order to ease readability and increase performance of
  80084. * the JavaScript charts. Highstock by default applies data grouping when
  80085. * the points become closer than a certain pixel value, determined by the
  80086. * `groupPixelWidth` option.
  80087. *
  80088. * If data grouping is applied, the grouping information of grouped points
  80089. * can be read from the Point.dataGroup. If point options other than the
  80090. * data itself are set, for example `name` or `color` or custom properties,
  80091. * the grouping logic doesn't know how to group it. In this case the options
  80092. * of the first point instance are copied over to the group point. This can
  80093. * be altered through a custom `approximation` callback function.
  80094. */
  80095. dataGrouping?: DataGroupingOptionsObject;
  80096. /**
  80097. * (Highcharts, Highstock, Highmaps, Gantt) Options for the series data
  80098. * labels, appearing next to each data point.
  80099. *
  80100. * Since v6.2.0, multiple data labels can be applied to each single point by
  80101. * defining them as an array of configs.
  80102. *
  80103. * In styled mode, the data labels can be styled with the
  80104. * `.highcharts-data-label-box` and `.highcharts-data-label` class names
  80105. * (see example).
  80106. */
  80107. dataLabels?: (PlotSlowstochasticDataLabelsOptions|Array<PlotSlowstochasticDataLabelsOptions>);
  80108. /**
  80109. * (Highcharts, Highstock) Options for the series data sorting.
  80110. */
  80111. dataSorting?: (DataSortingOptionsObject|PlotSlowstochasticDataSortingOptions);
  80112. /**
  80113. * (Highstock) A description of the series to add to the screen reader
  80114. * information about the series.
  80115. */
  80116. description?: string;
  80117. /**
  80118. * (Highstock) Enable or disable the mouse tracking for a specific series.
  80119. * This includes point tooltips and click events on graphs and points. For
  80120. * large datasets it improves performance.
  80121. */
  80122. enableMouseTracking?: boolean;
  80123. /**
  80124. * (Highstock) General event handlers for the series items. These event
  80125. * hooks can also be attached to the series at run time using the
  80126. * `Highcharts.addEvent` function.
  80127. */
  80128. events?: SeriesEventsOptionsObject;
  80129. /**
  80130. * (Highstock) Determines whether the series should look for the nearest
  80131. * point in both dimensions or just the x-dimension when hovering the
  80132. * series. Defaults to `'xy'` for scatter series and `'x'` for most other
  80133. * series. If the data has duplicate x-values, it is recommended to set this
  80134. * to `'xy'` to allow hovering over all points.
  80135. *
  80136. * Applies only to series types using nearest neighbor search (not direct
  80137. * hover) for tooltip.
  80138. */
  80139. findNearestPointBy?: OptionsFindNearestPointByValue;
  80140. /**
  80141. * (Highstock) Defines when to display a gap in the graph, together with the
  80142. * gapUnit option.
  80143. *
  80144. * In case when `dataGrouping` is enabled, points can be grouped into a
  80145. * larger time span. This can make the grouped points to have a greater
  80146. * distance than the absolute value of `gapSize` property, which will result
  80147. * in disappearing graph completely. To prevent this situation the mentioned
  80148. * distance between grouped points is used instead of previously defined
  80149. * `gapSize`.
  80150. *
  80151. * In practice, this option is most often used to visualize gaps in time
  80152. * series. In a stock chart, intraday data is available for daytime hours,
  80153. * while gaps will appear in nights and weekends.
  80154. */
  80155. gapSize?: number;
  80156. /**
  80157. * (Highstock) Together with gapSize, this option defines where to draw gaps
  80158. * in the graph.
  80159. *
  80160. * When the `gapUnit` is `"relative"` (default), a gap size of 5 means that
  80161. * if the distance between two points is greater than 5 times that of the
  80162. * two closest points, the graph will be broken.
  80163. *
  80164. * When the `gapUnit` is `"value"`, the gap is based on absolute axis
  80165. * values, which on a datetime axis is milliseconds. This also applies to
  80166. * the navigator series that inherits gap options from the base series.
  80167. */
  80168. gapUnit?: OptionsGapUnitValue;
  80169. /**
  80170. * (Highcharts, Highstock, Gantt) Whether to use the Y extremes of the total
  80171. * chart width or only the zoomed area when zooming in on parts of the X
  80172. * axis. By default, the Y axis adjusts to the min and max of the visible
  80173. * data. Cartesian series only.
  80174. */
  80175. getExtremesFromAll?: boolean;
  80176. /**
  80177. * (Highstock) When set to `false` will prevent the series data from being
  80178. * included in any form of data export.
  80179. *
  80180. * Since version 6.0.0 until 7.1.0 the option was existing undocumented as
  80181. * `includeInCSVExport`.
  80182. */
  80183. includeInDataExport?: boolean;
  80184. /**
  80185. * (Highcharts, Highstock, Gantt) Series labels are placed as close to the
  80186. * series as possible in a natural way, seeking to avoid other series. The
  80187. * goal of this feature is to make the chart more easily readable, like if a
  80188. * human designer placed the labels in the optimal position.
  80189. *
  80190. * The series labels currently work with series types having a `graph` or an
  80191. * `area`.
  80192. */
  80193. label?: SeriesLabelOptionsObject;
  80194. /**
  80195. * (Highstock) The line marks the last price from all points.
  80196. */
  80197. lastPrice?: SeriesLastPriceOptionsObject;
  80198. /**
  80199. * (Highstock) The line marks the last price from visible range of points.
  80200. */
  80201. lastVisiblePrice?: SeriesLastVisiblePriceOptionsObject;
  80202. /**
  80203. * (Highcharts, Highstock) The SVG value used for the `stroke-linecap` and
  80204. * `stroke-linejoin` of a line graph. Round means that lines are rounded in
  80205. * the ends and bends.
  80206. */
  80207. linecap?: SeriesLinecapValue;
  80208. /**
  80209. * (Highcharts, Highstock) Pixel width of the graph line.
  80210. */
  80211. lineWidth?: number;
  80212. /**
  80213. * (Highcharts, Highstock, Gantt) The main series ID that indicator will be
  80214. * based on. Required for this indicator.
  80215. */
  80216. linkedTo?: string;
  80217. /**
  80218. * (Highstock) Options for the point markers of line-like series. Properties
  80219. * like `fillColor`, `lineColor` and `lineWidth` define the visual
  80220. * appearance of the markers. Other series types, like column series, don't
  80221. * have markers, but have visual options on the series level instead.
  80222. *
  80223. * In styled mode, the markers can be styled with the `.highcharts-point`,
  80224. * `.highcharts-point-hover` and `.highcharts-point-select` class names.
  80225. */
  80226. marker?: PointMarkerOptionsObject;
  80227. /**
  80228. * (Highstock) The name of the series as shown in the legend, tooltip etc.
  80229. * If not set, it will be based on a technical indicator type and default
  80230. * params.
  80231. */
  80232. name?: string;
  80233. /**
  80234. * (Highstock) The color for the parts of the graph or points that are below
  80235. * the threshold. Note that `zones` takes precedence over the negative
  80236. * color. Using `negativeColor` is equivalent to applying a zone with value
  80237. * of 0.
  80238. */
  80239. negativeColor?: (ColorString|GradientColorObject|PatternObject);
  80240. /**
  80241. * (Highstock) Opacity of a series parts: line, fill (e.g. area) and
  80242. * dataLabels.
  80243. */
  80244. opacity?: number;
  80245. /**
  80246. * (Highstock) Paramters used in calculation of regression series' points.
  80247. */
  80248. params?: PlotSlowstochasticParamsOptions;
  80249. /**
  80250. * (Highstock) Properties for each single point.
  80251. */
  80252. point?: PlotSeriesPointOptions;
  80253. /**
  80254. * (Highstock) Same as accessibility.pointDescriptionFormatter, but for an
  80255. * individual series. Overrides the chart wide configuration.
  80256. */
  80257. pointDescriptionFormatter?: Function;
  80258. /**
  80259. * (Highstock) Whether to select the series initially. If `showCheckbox` is
  80260. * true, the checkbox next to the series name in the legend will be checked
  80261. * for a selected series.
  80262. */
  80263. selected?: boolean;
  80264. /**
  80265. * (Highstock) Whether to apply a drop shadow to the graph line. Since 2.3
  80266. * the shadow can be an object configuration containing `color`, `offsetX`,
  80267. * `offsetY`, `opacity` and `width`.
  80268. */
  80269. shadow?: (boolean|ShadowOptionsObject);
  80270. /**
  80271. * (Highstock) If true, a checkbox is displayed next to the legend item to
  80272. * allow selecting the series. The state of the checkbox is determined by
  80273. * the `selected` option.
  80274. */
  80275. showCheckbox?: boolean;
  80276. /**
  80277. * (Highstock) Whether to display this particular series or series type in
  80278. * the legend. Standalone series are shown in legend by default, and linked
  80279. * series are not. Since v7.2.0 it is possible to show series that use
  80280. * colorAxis by setting this option to `true`.
  80281. */
  80282. showInLegend?: boolean;
  80283. /**
  80284. * (Highstock) If set to `true`, the accessibility module will skip past the
  80285. * points in this series for keyboard navigation.
  80286. */
  80287. skipKeyboardNavigation?: boolean;
  80288. /**
  80289. * (Highstock) Smoothed line options.
  80290. */
  80291. smoothedLine?: PlotSlowstochasticSmoothedLineOptions;
  80292. /**
  80293. * (Highcharts, Highstock) When this is true, the series will not cause the
  80294. * Y axis to cross the zero plane (or threshold option) unless the data
  80295. * actually crosses the plane.
  80296. *
  80297. * For example, if `softThreshold` is `false`, a series of 0, 1, 2, 3 will
  80298. * make the Y axis show negative values according to the `minPadding`
  80299. * option. If `softThreshold` is `true`, the Y axis starts at 0.
  80300. */
  80301. softThreshold?: boolean;
  80302. states?: SeriesStatesOptionsObject;
  80303. /**
  80304. * (Highcharts, Highstock) Whether to apply steps to the line. Possible
  80305. * values are `left`, `center` and `right`.
  80306. */
  80307. step?: OptionsStepValue;
  80308. /**
  80309. * (Highstock) Sticky tracking of mouse events. When true, the `mouseOut`
  80310. * event on a series isn't triggered until the mouse moves over another
  80311. * series, or out of the plot area. When false, the `mouseOut` event on a
  80312. * series is triggered when the mouse leaves the area around the series'
  80313. * graph or markers. This also implies the tooltip when not shared. When
  80314. * `stickyTracking` is false and `tooltip.shared` is false, the tooltip will
  80315. * be hidden when moving the mouse between series. Defaults to true for line
  80316. * and area type series, but to false for columns, pies etc.
  80317. *
  80318. * **Note:** The boost module will force this option because of technical
  80319. * limitations.
  80320. */
  80321. stickyTracking?: boolean;
  80322. /**
  80323. * (Highcharts, Highstock) The threshold, also called zero level or base
  80324. * level. For line type series this is only used in conjunction with
  80325. * negativeColor.
  80326. */
  80327. threshold?: (number|null);
  80328. /**
  80329. * (Highstock) A configuration object for the tooltip rendering of each
  80330. * single series. Properties are inherited from tooltip, but only the
  80331. * following properties can be defined on a series level.
  80332. */
  80333. tooltip?: SeriesTooltipOptionsObject;
  80334. /**
  80335. * (Highcharts, Highstock, Gantt) When a series contains a data array that
  80336. * is longer than this, only one dimensional arrays of numbers, or two
  80337. * dimensional arrays with x and y values are allowed. Also, only the first
  80338. * point is tested, and the rest are assumed to be the same format. This
  80339. * saves expensive data checking and indexing in long series. Set it to `0`
  80340. * disable.
  80341. *
  80342. * Note: In boost mode turbo threshold is forced. Only array of numbers or
  80343. * two dimensional arrays are allowed.
  80344. */
  80345. turboThreshold?: number;
  80346. /**
  80347. * (Highstock) Set the initial visibility of the series.
  80348. */
  80349. visible?: boolean;
  80350. /**
  80351. * (Highmaps) Define the z index of the series.
  80352. */
  80353. zIndex?: number;
  80354. /**
  80355. * (Highcharts, Highstock) Defines the Axis on which the zones are applied.
  80356. */
  80357. zoneAxis?: string;
  80358. /**
  80359. * (Highcharts, Highstock) An array defining zones within a series. Zones
  80360. * can be applied to the X axis, Y axis or Z axis for bubbles, according to
  80361. * the `zoneAxis` option. The zone definitions have to be in ascending order
  80362. * regarding to the value.
  80363. *
  80364. * In styled mode, the color zones are styled with the
  80365. * `.highcharts-zone-{n}` class, or custom classed from the `className`
  80366. * option (view live demo).
  80367. */
  80368. zones?: Array<SeriesZonesOptionsObject>;
  80369. }
  80370. /**
  80371. * (Highstock) Paramters used in calculation of regression series' points.
  80372. */
  80373. export interface PlotSlowstochasticParamsOptions {
  80374. /**
  80375. * (Highstock) Periods for Slow Stochastic oscillator: [%K, %D, SMA(%D)].
  80376. */
  80377. periods?: [number, number, number];
  80378. }
  80379. /**
  80380. * (Highstock) Smoothed line options.
  80381. */
  80382. export interface PlotSlowstochasticSmoothedLineOptions {
  80383. /**
  80384. * (Highstock) Styles for a smoothed line.
  80385. */
  80386. styles?: PlotSlowstochasticSmoothedLineStylesOptions;
  80387. }
  80388. /**
  80389. * (Highstock) Styles for a smoothed line.
  80390. */
  80391. export interface PlotSlowstochasticSmoothedLineStylesOptions {
  80392. /**
  80393. * (Highstock) Color of the line. If not set, it's inherited from
  80394. * plotOptions.stochastic.color.
  80395. */
  80396. lineColor?: ColorString;
  80397. /**
  80398. * (Highstock) Pixel width of the line.
  80399. */
  80400. lineWidth?: number;
  80401. }
  80402. /**
  80403. * (Highstock) Enable or disable the initial animation when a series is
  80404. * displayed. The animation can also be set as a configuration object. Please
  80405. * note that this option only applies to the initial animation of the series
  80406. * itself. For other animations, see chart.animation and the animation parameter
  80407. * under the API methods. The following properties are supported:
  80408. *
  80409. * - `defer`: The animation delay time in milliseconds.
  80410. *
  80411. * - `duration`: The duration of the animation in milliseconds.
  80412. *
  80413. * - `easing`: Can be a string reference to an easing function set on the `Math`
  80414. * object or a function. See the _Custom easing function_ demo below.
  80415. *
  80416. * Due to poor performance, animation is disabled in old IE browsers for several
  80417. * chart types.
  80418. */
  80419. export interface PlotSmaAnimationOptions {
  80420. defer?: number;
  80421. }
  80422. /**
  80423. * (Highcharts, Highstock, Highmaps, Gantt) Enable or disable the initial
  80424. * animation when a series is displayed for the `dataLabels`. The animation can
  80425. * also be set as a configuration object. Please note that this option only
  80426. * applies to the initial animation. For other animations, see chart.animation
  80427. * and the animation parameter under the API methods. The following properties
  80428. * are supported:
  80429. *
  80430. * - `defer`: The animation delay time in milliseconds.
  80431. */
  80432. export interface PlotSmaDataLabelsAnimationOptions {
  80433. /**
  80434. * (Highcharts, Highstock, Highmaps, Gantt) The animation delay time in
  80435. * milliseconds. Set to `0` renders dataLabel immediately. As `undefined`
  80436. * inherits defer time from the series.animation.defer.
  80437. */
  80438. defer?: number;
  80439. }
  80440. /**
  80441. * (Highcharts, Highstock, Highmaps, Gantt) Options for the series data labels,
  80442. * appearing next to each data point.
  80443. *
  80444. * Since v6.2.0, multiple data labels can be applied to each single point by
  80445. * defining them as an array of configs.
  80446. *
  80447. * In styled mode, the data labels can be styled with the
  80448. * `.highcharts-data-label-box` and `.highcharts-data-label` class names (see
  80449. * example).
  80450. */
  80451. export interface PlotSmaDataLabelsOptions {
  80452. /**
  80453. * (Highcharts, Highstock, Highmaps, Gantt) The alignment of the data label
  80454. * compared to the point. If `right`, the right side of the label should be
  80455. * touching the point. For points with an extent, like columns, the
  80456. * alignments also dictates how to align it inside the box, as given with
  80457. * the inside option. Can be one of `left`, `center` or `right`.
  80458. */
  80459. align?: (AlignValue|null);
  80460. /**
  80461. * (Highcharts, Highstock, Highmaps, Gantt) Whether to allow data labels to
  80462. * overlap. To make the labels less sensitive for overlapping, the
  80463. * dataLabels.padding can be set to 0.
  80464. */
  80465. allowOverlap?: boolean;
  80466. /**
  80467. * (Highcharts, Highstock, Highmaps, Gantt) Enable or disable the initial
  80468. * animation when a series is displayed for the `dataLabels`. The animation
  80469. * can also be set as a configuration object. Please note that this option
  80470. * only applies to the initial animation. For other animations, see
  80471. * chart.animation and the animation parameter under the API methods. The
  80472. * following properties are supported:
  80473. *
  80474. * - `defer`: The animation delay time in milliseconds.
  80475. */
  80476. animation?: (boolean|PlotSmaDataLabelsAnimationOptions|Partial<AnimationOptionsObject>);
  80477. /**
  80478. * (Highcharts, Highstock, Highmaps, Gantt) The background color or gradient
  80479. * for the data label.
  80480. */
  80481. backgroundColor?: (ColorString|GradientColorObject|PatternObject);
  80482. /**
  80483. * (Highcharts, Highstock, Highmaps, Gantt) The border color for the data
  80484. * label. Defaults to `undefined`.
  80485. */
  80486. borderColor?: (ColorString|GradientColorObject|PatternObject);
  80487. /**
  80488. * (Highcharts, Highstock, Highmaps, Gantt) The border radius in pixels for
  80489. * the data label.
  80490. */
  80491. borderRadius?: number;
  80492. /**
  80493. * (Highcharts, Highstock, Highmaps, Gantt) The border width in pixels for
  80494. * the data label.
  80495. */
  80496. borderWidth?: number;
  80497. /**
  80498. * (Highcharts, Highstock, Highmaps, Gantt) A class name for the data label.
  80499. * Particularly in styled mode, this can be used to give each series' or
  80500. * point's data label unique styling. In addition to this option, a default
  80501. * color class name is added so that we can give the labels a contrast text
  80502. * shadow.
  80503. */
  80504. className?: string;
  80505. /**
  80506. * (Highcharts, Highstock, Highmaps, Gantt) The text color for the data
  80507. * labels. Defaults to `undefined`. For certain series types, like column or
  80508. * map, the data labels can be drawn inside the points. In this case the
  80509. * data label will be drawn with maximum contrast by default. Additionally,
  80510. * it will be given a `text-outline` style with the opposite color, to
  80511. * further increase the contrast. This can be overridden by setting the
  80512. * `text-outline` style to `none` in the `dataLabels.style` option.
  80513. */
  80514. color?: (ColorString|GradientColorObject|PatternObject);
  80515. /**
  80516. * (Highcharts, Highstock, Highmaps, Gantt) Whether to hide data labels that
  80517. * are outside the plot area. By default, the data label is moved inside the
  80518. * plot area according to the overflow option.
  80519. */
  80520. crop?: boolean;
  80521. /**
  80522. * (Highcharts, Highstock, Gantt) Whether to defer displaying the data
  80523. * labels until the initial series animation has finished. Setting to
  80524. * `false` renders the data label immediately. If set to `true` inherits the
  80525. * defer time set in plotOptions.series.animation.
  80526. */
  80527. defer?: boolean;
  80528. /**
  80529. * (Highcharts, Highstock, Highmaps, Gantt) Enable or disable the data
  80530. * labels.
  80531. */
  80532. enabled?: boolean;
  80533. /**
  80534. * (Highcharts, Highstock, Highmaps, Gantt) A declarative filter to control
  80535. * of which data labels to display. The declarative filter is designed for
  80536. * use when callback functions are not available, like when the chart
  80537. * options require a pure JSON structure or for use with graphical editors.
  80538. * For programmatic control, use the `formatter` instead, and return
  80539. * `undefined` to disable a single data label.
  80540. */
  80541. filter?: DataLabelsFilterOptionsObject;
  80542. /**
  80543. * (Highcharts, Highstock, Highmaps, Gantt) A format string for the data
  80544. * label. Available variables are the same as for `formatter`.
  80545. */
  80546. format?: string;
  80547. /**
  80548. * (Highcharts, Highstock, Highmaps, Gantt) Callback JavaScript function to
  80549. * format the data label. Note that if a `format` is defined, the format
  80550. * takes precedence and the formatter is ignored.
  80551. */
  80552. formatter?: DataLabelsFormatterCallbackFunction;
  80553. /**
  80554. * (Highcharts, Highstock, Highmaps, Gantt) For points with an extent, like
  80555. * columns or map areas, whether to align the data label inside the box or
  80556. * to the actual value point. Defaults to `false` in most cases, `true` in
  80557. * stacked columns.
  80558. */
  80559. inside?: boolean;
  80560. /**
  80561. * (Highcharts, Highstock, Highmaps, Gantt) Format for points with the value
  80562. * of null. Works analogously to format. `nullFormat` can be applied only to
  80563. * series which support displaying null points.
  80564. */
  80565. nullFormat?: (boolean|string);
  80566. /**
  80567. * (Highcharts, Highstock, Highmaps, Gantt) Callback JavaScript function
  80568. * that defines formatting for points with the value of null. Works
  80569. * analogously to formatter. `nullPointFormatter` can be applied only to
  80570. * series which support displaying null points.
  80571. */
  80572. nullFormatter?: DataLabelsFormatterCallbackFunction;
  80573. /**
  80574. * (Highcharts, Highstock, Highmaps, Gantt) How to handle data labels that
  80575. * flow outside the plot area. The default is `"justify"`, which aligns them
  80576. * inside the plot area. For columns and bars, this means it will be moved
  80577. * inside the bar. To display data labels outside the plot area, set `crop`
  80578. * to `false` and `overflow` to `"allow"`.
  80579. */
  80580. overflow?: DataLabelsOverflowValue;
  80581. /**
  80582. * (Highcharts, Highstock, Highmaps, Gantt) When either the `borderWidth` or
  80583. * the `backgroundColor` is set, this is the padding within the box.
  80584. */
  80585. padding?: number;
  80586. /**
  80587. * (Highcharts, Highstock, Highmaps, Gantt) Aligns data labels relative to
  80588. * points. If `center` alignment is not possible, it defaults to `right`.
  80589. */
  80590. position?: AlignValue;
  80591. /**
  80592. * (Highcharts, Highstock, Highmaps, Gantt) Text rotation in degrees. Note
  80593. * that due to a more complex structure, backgrounds, borders and padding
  80594. * will be lost on a rotated data label.
  80595. */
  80596. rotation?: number;
  80597. /**
  80598. * (Highcharts, Highstock, Highmaps, Gantt) The shadow of the box. Works
  80599. * best with `borderWidth` or `backgroundColor`. Since 2.3 the shadow can be
  80600. * an object configuration containing `color`, `offsetX`, `offsetY`,
  80601. * `opacity` and `width`.
  80602. */
  80603. shadow?: (boolean|ShadowOptionsObject);
  80604. /**
  80605. * (Highcharts, Highstock, Highmaps, Gantt) The name of a symbol to use for
  80606. * the border around the label. Symbols are predefined functions on the
  80607. * Renderer object.
  80608. */
  80609. shape?: string;
  80610. /**
  80611. * (Highcharts, Highstock, Highmaps, Gantt) Styles for the label. The
  80612. * default `color` setting is `"contrast"`, which is a pseudo color that
  80613. * Highcharts picks up and applies the maximum contrast to the underlying
  80614. * point item, for example the bar in a bar chart.
  80615. *
  80616. * The `textOutline` is a pseudo property that applies an outline of the
  80617. * given width with the given color, which by default is the maximum
  80618. * contrast to the text. So a bright text color will result in a black text
  80619. * outline for maximum readability on a mixed background. In some cases,
  80620. * especially with grayscale text, the text outline doesn't work well, in
  80621. * which cases it can be disabled by setting it to `"none"`. When `useHTML`
  80622. * is true, the `textOutline` will not be picked up. In this, case, the same
  80623. * effect can be acheived through the `text-shadow` CSS property.
  80624. *
  80625. * For some series types, where each point has an extent, like for example
  80626. * tree maps, the data label may overflow the point. There are two
  80627. * strategies for handling overflow. By default, the text will wrap to
  80628. * multiple lines. The other strategy is to set `style.textOverflow` to
  80629. * `ellipsis`, which will keep the text on one line plus it will break
  80630. * inside long words.
  80631. */
  80632. style?: CSSObject;
  80633. /**
  80634. * (Highcharts, Highstock, Highmaps, Gantt) Options for a label text which
  80635. * should follow marker's shape. Border and background are disabled for a
  80636. * label that follows a path.
  80637. *
  80638. * **Note:** Only SVG-based renderer supports this option. Setting `useHTML`
  80639. * to true will disable this option.
  80640. */
  80641. textPath?: DataLabelsTextPathOptionsObject;
  80642. /**
  80643. * (Highcharts, Highstock, Highmaps, Gantt) Whether to use HTML to render
  80644. * the labels.
  80645. */
  80646. useHTML?: boolean;
  80647. /**
  80648. * (Highcharts, Highstock, Highmaps, Gantt) The vertical alignment of a data
  80649. * label. Can be one of `top`, `middle` or `bottom`. The default value
  80650. * depends on the data, for instance in a column chart, the label is above
  80651. * positive values and below negative values.
  80652. */
  80653. verticalAlign?: (VerticalAlignValue|null);
  80654. /**
  80655. * (Highcharts, Highstock, Highmaps, Gantt) The x position offset of the
  80656. * label relative to the point in pixels.
  80657. */
  80658. x?: number;
  80659. /**
  80660. * (Highcharts, Highstock, Highmaps, Gantt) The y position offset of the
  80661. * label relative to the point in pixels.
  80662. */
  80663. y?: number;
  80664. /**
  80665. * (Highcharts, Highstock, Highmaps, Gantt) The Z index of the data labels.
  80666. * The default Z index puts it above the series. Use a Z index of 2 to
  80667. * display it behind the series.
  80668. */
  80669. z?: number;
  80670. }
  80671. /**
  80672. * (Highcharts, Highstock) Options for the series data sorting.
  80673. */
  80674. export interface PlotSmaDataSortingOptions {
  80675. /**
  80676. * (Highcharts, Highstock) Enable or disable data sorting for the series.
  80677. * Use xAxis.reversed to change the sorting order.
  80678. */
  80679. enabled?: boolean;
  80680. /**
  80681. * (Highcharts, Highstock) Whether to allow matching points by name in an
  80682. * update. If this option is disabled, points will be matched by order.
  80683. */
  80684. matchByName?: boolean;
  80685. /**
  80686. * (Highcharts, Highstock) Determines what data value should be used to sort
  80687. * by.
  80688. */
  80689. sortKey?: string;
  80690. }
  80691. /**
  80692. * (Highstock) Simple moving average indicator (SMA). This series requires
  80693. * `linkedTo` option to be set.
  80694. *
  80695. * In TypeScript the type option must always be set.
  80696. *
  80697. * Configuration options for the series are given in three levels:
  80698. *
  80699. * 1. Options for all series in a chart are defined in the plotOptions.series
  80700. * object.
  80701. *
  80702. * 2. Options for all `sma` series are defined in plotOptions.sma.
  80703. *
  80704. * 3. Options for one single series are given in the series instance array. (see
  80705. * online documentation for example)
  80706. */
  80707. export interface PlotSmaOptions {
  80708. /**
  80709. * (Highstock) Accessibility options for a series.
  80710. */
  80711. accessibility?: SeriesAccessibilityOptionsObject;
  80712. /**
  80713. * (Highstock) Allow this series' points to be selected by clicking on the
  80714. * graphic (columns, point markers, pie slices, map areas etc).
  80715. *
  80716. * The selected points can be handled by point select and unselect events,
  80717. * or collectively by the getSelectedPoints function.
  80718. *
  80719. * And alternative way of selecting points is through dragging.
  80720. */
  80721. allowPointSelect?: boolean;
  80722. /**
  80723. * (Highstock) Enable or disable the initial animation when a series is
  80724. * displayed. The animation can also be set as a configuration object.
  80725. * Please note that this option only applies to the initial animation of the
  80726. * series itself. For other animations, see chart.animation and the
  80727. * animation parameter under the API methods. The following properties are
  80728. * supported:
  80729. *
  80730. * - `defer`: The animation delay time in milliseconds.
  80731. *
  80732. * - `duration`: The duration of the animation in milliseconds.
  80733. *
  80734. * - `easing`: Can be a string reference to an easing function set on the
  80735. * `Math` object or a function. See the _Custom easing function_ demo below.
  80736. *
  80737. * Due to poor performance, animation is disabled in old IE browsers for
  80738. * several chart types.
  80739. */
  80740. animation?: (boolean|PlotSmaAnimationOptions|Partial<AnimationOptionsObject>);
  80741. /**
  80742. * (Highstock) For some series, there is a limit that shuts down initial
  80743. * animation by default when the total number of points in the chart is too
  80744. * high. For example, for a column chart and its derivatives, animation does
  80745. * not run if there is more than 250 points totally. To disable this cap,
  80746. * set `animationLimit` to `Infinity`.
  80747. */
  80748. animationLimit?: number;
  80749. /**
  80750. * (Highstock) Sets the color blending in the boost module.
  80751. */
  80752. boostBlending?: OptionsBoostBlendingValue;
  80753. /**
  80754. * (Highstock) Set the point threshold for when a series should enter boost
  80755. * mode.
  80756. *
  80757. * Setting it to e.g. 2000 will cause the series to enter boost mode when
  80758. * there are 2000 or more points in the series.
  80759. *
  80760. * To disable boosting on the series, set the `boostThreshold` to 0. Setting
  80761. * it to 1 will force boosting.
  80762. *
  80763. * Note that the cropThreshold also affects this setting. When zooming in on
  80764. * a series that has fewer points than the `cropThreshold`, all points are
  80765. * rendered although outside the visible plot area, and the `boostThreshold`
  80766. * won't take effect.
  80767. */
  80768. boostThreshold?: number;
  80769. /**
  80770. * (Highmaps) The border color of the map areas.
  80771. *
  80772. * In styled mode, the border stroke is given in the `.highcharts-point`
  80773. * class.
  80774. */
  80775. borderColor?: (ColorString|GradientColorObject|PatternObject);
  80776. /**
  80777. * (Highmaps) The border width of each map area.
  80778. *
  80779. * In styled mode, the border stroke width is given in the
  80780. * `.highcharts-point` class.
  80781. */
  80782. borderWidth?: number;
  80783. /**
  80784. * (Highstock) An additional class name to apply to the series' graphical
  80785. * elements. This option does not replace default class names of the
  80786. * graphical element.
  80787. */
  80788. className?: string;
  80789. /**
  80790. * (Highstock) Disable this option to allow series rendering in the whole
  80791. * plotting area.
  80792. *
  80793. * **Note:** Clipping should be always enabled when chart.zoomType is set
  80794. */
  80795. clip?: boolean;
  80796. /**
  80797. * (Highstock) The main color of the series. In line type series it applies
  80798. * to the line and the point markers unless otherwise specified. In bar type
  80799. * series it applies to the bars unless a color is specified per point. The
  80800. * default value is pulled from the `options.colors` array.
  80801. *
  80802. * In styled mode, the color can be defined by the colorIndex option. Also,
  80803. * the series color can be set with the `.highcharts-series`,
  80804. * `.highcharts-color-{n}`, `.highcharts-{type}-series` or
  80805. * `.highcharts-series-{n}` class, or individual classes given by the
  80806. * `className` option.
  80807. */
  80808. color?: (ColorString|GradientColorObject|PatternObject);
  80809. /**
  80810. * (Highstock) Styled mode only. A specific color index to use for the
  80811. * series, so its graphic representations are given the class name
  80812. * `highcharts-color-{n}`.
  80813. */
  80814. colorIndex?: number;
  80815. /**
  80816. * (Highcharts, Highstock, Highmaps) Determines what data value should be
  80817. * used to calculate point color if `colorAxis` is used. Requires to set
  80818. * `min` and `max` if some custom point property is used or if approximation
  80819. * for data grouping is set to `'sum'`.
  80820. */
  80821. colorKey?: string;
  80822. /**
  80823. * (Highstock) Compare the values of the series against the first non-null,
  80824. * non- zero value in the visible range. The y axis will show percentage or
  80825. * absolute change depending on whether `compare` is set to `"percent"` or
  80826. * `"value"`. When this is applied to multiple series, it allows comparing
  80827. * the development of the series against each other. Adds a `change` field
  80828. * to every point object.
  80829. */
  80830. compare?: string;
  80831. /**
  80832. * (Highstock) When compare is `percent`, this option dictates whether to
  80833. * use 0 or 100 as the base of comparison.
  80834. */
  80835. compareBase?: (0|100);
  80836. /**
  80837. * (Highstock) Defines if comparison should start from the first point
  80838. * within the visible range or should start from the first point **before**
  80839. * the range.
  80840. *
  80841. * In other words, this flag determines if first point within the visible
  80842. * range will have 0% (`compareStart=true`) or should have been already
  80843. * calculated according to the previous point (`compareStart=false`).
  80844. */
  80845. compareStart?: boolean;
  80846. /**
  80847. * (Highstock) Whether to compare indicator to the main series values or
  80848. * indicator values.
  80849. */
  80850. compareToMain?: boolean;
  80851. /**
  80852. * (Highcharts) Polar charts only. Whether to connect the ends of a line
  80853. * series plot across the extremes.
  80854. */
  80855. connectEnds?: boolean;
  80856. /**
  80857. * (Highcharts, Highstock) Whether to connect a graph line across null
  80858. * points, or render a gap between the two points on either side of the
  80859. * null.
  80860. */
  80861. connectNulls?: boolean;
  80862. /**
  80863. * (Gantt) Override Pathfinder connector options for a series. Requires
  80864. * Highcharts Gantt to be loaded.
  80865. */
  80866. connectors?: SeriesConnectorsOptionsObject;
  80867. /**
  80868. * (Highcharts, Highstock, Gantt) When true, each point or column edge is
  80869. * rounded to its nearest pixel in order to render sharp on screen. In some
  80870. * cases, when there are a lot of densely packed columns, this leads to
  80871. * visible difference in column widths or distance between columns. In these
  80872. * cases, setting `crisp` to `false` may look better, even though each
  80873. * column is rendered blurry.
  80874. */
  80875. crisp?: boolean;
  80876. /**
  80877. * (Highcharts, Highstock) When the series contains less points than the
  80878. * crop threshold, all points are drawn, even if the points fall outside the
  80879. * visible plot area at the current zoom. The advantage of drawing all
  80880. * points (including markers and columns), is that animation is performed on
  80881. * updates. On the other hand, when the series contains more points than the
  80882. * crop threshold, the series data is cropped to only contain points that
  80883. * fall within the plot area. The advantage of cropping away invisible
  80884. * points is to increase performance on large series.
  80885. */
  80886. cropThreshold?: number;
  80887. /**
  80888. * (Highstock) You can set the cursor to "pointer" if you have click events
  80889. * attached to the series, to signal to the user that the points and lines
  80890. * can be clicked.
  80891. *
  80892. * In styled mode, the series cursor can be set with the same classes as
  80893. * listed under series.color.
  80894. */
  80895. cursor?: (string|CursorValue);
  80896. /**
  80897. * (Highstock) A reserved subspace to store options and values for
  80898. * customized functionality. Here you can add additional data for your own
  80899. * event callbacks and formatter callbacks.
  80900. */
  80901. custom?: Dictionary<any>;
  80902. /**
  80903. * (Highstock) Name of the dash style to use for the graph, or for some
  80904. * series types the outline of each shape.
  80905. *
  80906. * In styled mode, the stroke dash-array can be set with the same classes as
  80907. * listed under series.color.
  80908. */
  80909. dashStyle?: DashStyleValue;
  80910. /**
  80911. * (Highstock) Data grouping is the concept of sampling the data values into
  80912. * larger blocks in order to ease readability and increase performance of
  80913. * the JavaScript charts. Highstock by default applies data grouping when
  80914. * the points become closer than a certain pixel value, determined by the
  80915. * `groupPixelWidth` option.
  80916. *
  80917. * If data grouping is applied, the grouping information of grouped points
  80918. * can be read from the Point.dataGroup. If point options other than the
  80919. * data itself are set, for example `name` or `color` or custom properties,
  80920. * the grouping logic doesn't know how to group it. In this case the options
  80921. * of the first point instance are copied over to the group point. This can
  80922. * be altered through a custom `approximation` callback function.
  80923. */
  80924. dataGrouping?: DataGroupingOptionsObject;
  80925. /**
  80926. * (Highcharts, Highstock, Highmaps, Gantt) Options for the series data
  80927. * labels, appearing next to each data point.
  80928. *
  80929. * Since v6.2.0, multiple data labels can be applied to each single point by
  80930. * defining them as an array of configs.
  80931. *
  80932. * In styled mode, the data labels can be styled with the
  80933. * `.highcharts-data-label-box` and `.highcharts-data-label` class names
  80934. * (see example).
  80935. */
  80936. dataLabels?: (PlotSmaDataLabelsOptions|Array<PlotSmaDataLabelsOptions>);
  80937. /**
  80938. * (Highcharts, Highstock) Options for the series data sorting.
  80939. */
  80940. dataSorting?: (DataSortingOptionsObject|PlotSmaDataSortingOptions);
  80941. /**
  80942. * (Highstock) A description of the series to add to the screen reader
  80943. * information about the series.
  80944. */
  80945. description?: string;
  80946. /**
  80947. * (Highstock) Enable or disable the mouse tracking for a specific series.
  80948. * This includes point tooltips and click events on graphs and points. For
  80949. * large datasets it improves performance.
  80950. */
  80951. enableMouseTracking?: boolean;
  80952. /**
  80953. * (Highstock) General event handlers for the series items. These event
  80954. * hooks can also be attached to the series at run time using the
  80955. * `Highcharts.addEvent` function.
  80956. */
  80957. events?: SeriesEventsOptionsObject;
  80958. /**
  80959. * (Highstock) Determines whether the series should look for the nearest
  80960. * point in both dimensions or just the x-dimension when hovering the
  80961. * series. Defaults to `'xy'` for scatter series and `'x'` for most other
  80962. * series. If the data has duplicate x-values, it is recommended to set this
  80963. * to `'xy'` to allow hovering over all points.
  80964. *
  80965. * Applies only to series types using nearest neighbor search (not direct
  80966. * hover) for tooltip.
  80967. */
  80968. findNearestPointBy?: OptionsFindNearestPointByValue;
  80969. /**
  80970. * (Highstock) Defines when to display a gap in the graph, together with the
  80971. * gapUnit option.
  80972. *
  80973. * In case when `dataGrouping` is enabled, points can be grouped into a
  80974. * larger time span. This can make the grouped points to have a greater
  80975. * distance than the absolute value of `gapSize` property, which will result
  80976. * in disappearing graph completely. To prevent this situation the mentioned
  80977. * distance between grouped points is used instead of previously defined
  80978. * `gapSize`.
  80979. *
  80980. * In practice, this option is most often used to visualize gaps in time
  80981. * series. In a stock chart, intraday data is available for daytime hours,
  80982. * while gaps will appear in nights and weekends.
  80983. */
  80984. gapSize?: number;
  80985. /**
  80986. * (Highstock) Together with gapSize, this option defines where to draw gaps
  80987. * in the graph.
  80988. *
  80989. * When the `gapUnit` is `"relative"` (default), a gap size of 5 means that
  80990. * if the distance between two points is greater than 5 times that of the
  80991. * two closest points, the graph will be broken.
  80992. *
  80993. * When the `gapUnit` is `"value"`, the gap is based on absolute axis
  80994. * values, which on a datetime axis is milliseconds. This also applies to
  80995. * the navigator series that inherits gap options from the base series.
  80996. */
  80997. gapUnit?: OptionsGapUnitValue;
  80998. /**
  80999. * (Highcharts, Highstock, Gantt) Whether to use the Y extremes of the total
  81000. * chart width or only the zoomed area when zooming in on parts of the X
  81001. * axis. By default, the Y axis adjusts to the min and max of the visible
  81002. * data. Cartesian series only.
  81003. */
  81004. getExtremesFromAll?: boolean;
  81005. /**
  81006. * (Highstock) When set to `false` will prevent the series data from being
  81007. * included in any form of data export.
  81008. *
  81009. * Since version 6.0.0 until 7.1.0 the option was existing undocumented as
  81010. * `includeInCSVExport`.
  81011. */
  81012. includeInDataExport?: boolean;
  81013. /**
  81014. * (Highcharts, Highstock, Gantt) Series labels are placed as close to the
  81015. * series as possible in a natural way, seeking to avoid other series. The
  81016. * goal of this feature is to make the chart more easily readable, like if a
  81017. * human designer placed the labels in the optimal position.
  81018. *
  81019. * The series labels currently work with series types having a `graph` or an
  81020. * `area`.
  81021. */
  81022. label?: SeriesLabelOptionsObject;
  81023. /**
  81024. * (Highstock) The line marks the last price from all points.
  81025. */
  81026. lastPrice?: SeriesLastPriceOptionsObject;
  81027. /**
  81028. * (Highstock) The line marks the last price from visible range of points.
  81029. */
  81030. lastVisiblePrice?: SeriesLastVisiblePriceOptionsObject;
  81031. /**
  81032. * (Highcharts, Highstock) The SVG value used for the `stroke-linecap` and
  81033. * `stroke-linejoin` of a line graph. Round means that lines are rounded in
  81034. * the ends and bends.
  81035. */
  81036. linecap?: SeriesLinecapValue;
  81037. /**
  81038. * (Highcharts, Highstock) Pixel width of the graph line.
  81039. */
  81040. lineWidth?: number;
  81041. /**
  81042. * (Highcharts, Highstock, Gantt) The main series ID that indicator will be
  81043. * based on. Required for this indicator.
  81044. */
  81045. linkedTo?: string;
  81046. /**
  81047. * (Highstock) Options for the point markers of line-like series. Properties
  81048. * like `fillColor`, `lineColor` and `lineWidth` define the visual
  81049. * appearance of the markers. Other series types, like column series, don't
  81050. * have markers, but have visual options on the series level instead.
  81051. *
  81052. * In styled mode, the markers can be styled with the `.highcharts-point`,
  81053. * `.highcharts-point-hover` and `.highcharts-point-select` class names.
  81054. */
  81055. marker?: PointMarkerOptionsObject;
  81056. /**
  81057. * (Highstock) The name of the series as shown in the legend, tooltip etc.
  81058. * If not set, it will be based on a technical indicator type and default
  81059. * params.
  81060. */
  81061. name?: string;
  81062. /**
  81063. * (Highstock) The color for the parts of the graph or points that are below
  81064. * the threshold. Note that `zones` takes precedence over the negative
  81065. * color. Using `negativeColor` is equivalent to applying a zone with value
  81066. * of 0.
  81067. */
  81068. negativeColor?: (ColorString|GradientColorObject|PatternObject);
  81069. /**
  81070. * (Highstock) Opacity of a series parts: line, fill (e.g. area) and
  81071. * dataLabels.
  81072. */
  81073. opacity?: number;
  81074. /**
  81075. * (Highstock) Paramters used in calculation of regression series' points.
  81076. */
  81077. params?: PlotSmaParamsOptions;
  81078. /**
  81079. * (Highstock) Properties for each single point.
  81080. */
  81081. point?: PlotSeriesPointOptions;
  81082. /**
  81083. * (Highstock) Same as accessibility.pointDescriptionFormatter, but for an
  81084. * individual series. Overrides the chart wide configuration.
  81085. */
  81086. pointDescriptionFormatter?: Function;
  81087. /**
  81088. * (Highstock) Whether to select the series initially. If `showCheckbox` is
  81089. * true, the checkbox next to the series name in the legend will be checked
  81090. * for a selected series.
  81091. */
  81092. selected?: boolean;
  81093. /**
  81094. * (Highstock) Whether to apply a drop shadow to the graph line. Since 2.3
  81095. * the shadow can be an object configuration containing `color`, `offsetX`,
  81096. * `offsetY`, `opacity` and `width`.
  81097. */
  81098. shadow?: (boolean|ShadowOptionsObject);
  81099. /**
  81100. * (Highstock) If true, a checkbox is displayed next to the legend item to
  81101. * allow selecting the series. The state of the checkbox is determined by
  81102. * the `selected` option.
  81103. */
  81104. showCheckbox?: boolean;
  81105. /**
  81106. * (Highstock) Whether to display this particular series or series type in
  81107. * the legend. Standalone series are shown in legend by default, and linked
  81108. * series are not. Since v7.2.0 it is possible to show series that use
  81109. * colorAxis by setting this option to `true`.
  81110. */
  81111. showInLegend?: boolean;
  81112. /**
  81113. * (Highstock) If set to `true`, the accessibility module will skip past the
  81114. * points in this series for keyboard navigation.
  81115. */
  81116. skipKeyboardNavigation?: boolean;
  81117. /**
  81118. * (Highcharts, Highstock) When this is true, the series will not cause the
  81119. * Y axis to cross the zero plane (or threshold option) unless the data
  81120. * actually crosses the plane.
  81121. *
  81122. * For example, if `softThreshold` is `false`, a series of 0, 1, 2, 3 will
  81123. * make the Y axis show negative values according to the `minPadding`
  81124. * option. If `softThreshold` is `true`, the Y axis starts at 0.
  81125. */
  81126. softThreshold?: boolean;
  81127. states?: SeriesStatesOptionsObject;
  81128. /**
  81129. * (Highcharts, Highstock) Whether to apply steps to the line. Possible
  81130. * values are `left`, `center` and `right`.
  81131. */
  81132. step?: OptionsStepValue;
  81133. /**
  81134. * (Highstock) Sticky tracking of mouse events. When true, the `mouseOut`
  81135. * event on a series isn't triggered until the mouse moves over another
  81136. * series, or out of the plot area. When false, the `mouseOut` event on a
  81137. * series is triggered when the mouse leaves the area around the series'
  81138. * graph or markers. This also implies the tooltip when not shared. When
  81139. * `stickyTracking` is false and `tooltip.shared` is false, the tooltip will
  81140. * be hidden when moving the mouse between series. Defaults to true for line
  81141. * and area type series, but to false for columns, pies etc.
  81142. *
  81143. * **Note:** The boost module will force this option because of technical
  81144. * limitations.
  81145. */
  81146. stickyTracking?: boolean;
  81147. /**
  81148. * (Highcharts, Highstock) The threshold, also called zero level or base
  81149. * level. For line type series this is only used in conjunction with
  81150. * negativeColor.
  81151. */
  81152. threshold?: (number|null);
  81153. /**
  81154. * (Highstock) A configuration object for the tooltip rendering of each
  81155. * single series. Properties are inherited from tooltip, but only the
  81156. * following properties can be defined on a series level.
  81157. */
  81158. tooltip?: SeriesTooltipOptionsObject;
  81159. /**
  81160. * (Highcharts, Highstock, Gantt) When a series contains a data array that
  81161. * is longer than this, only one dimensional arrays of numbers, or two
  81162. * dimensional arrays with x and y values are allowed. Also, only the first
  81163. * point is tested, and the rest are assumed to be the same format. This
  81164. * saves expensive data checking and indexing in long series. Set it to `0`
  81165. * disable.
  81166. *
  81167. * Note: In boost mode turbo threshold is forced. Only array of numbers or
  81168. * two dimensional arrays are allowed.
  81169. */
  81170. turboThreshold?: number;
  81171. /**
  81172. * (Highstock) Set the initial visibility of the series.
  81173. */
  81174. visible?: boolean;
  81175. /**
  81176. * (Highmaps) Define the z index of the series.
  81177. */
  81178. zIndex?: number;
  81179. /**
  81180. * (Highcharts, Highstock) Defines the Axis on which the zones are applied.
  81181. */
  81182. zoneAxis?: string;
  81183. /**
  81184. * (Highcharts, Highstock) An array defining zones within a series. Zones
  81185. * can be applied to the X axis, Y axis or Z axis for bubbles, according to
  81186. * the `zoneAxis` option. The zone definitions have to be in ascending order
  81187. * regarding to the value.
  81188. *
  81189. * In styled mode, the color zones are styled with the
  81190. * `.highcharts-zone-{n}` class, or custom classed from the `className`
  81191. * option (view live demo).
  81192. */
  81193. zones?: Array<SeriesZonesOptionsObject>;
  81194. }
  81195. /**
  81196. * (Highstock) Paramters used in calculation of regression series' points.
  81197. */
  81198. export interface PlotSmaParamsOptions {
  81199. /**
  81200. * (Highstock) The point index which indicator calculations will base. For
  81201. * example using OHLC data, index=2 means the indicator will be calculated
  81202. * using Low values.
  81203. */
  81204. index?: number;
  81205. /**
  81206. * (Highstock) The base period for indicator calculations. This is the
  81207. * number of data points which are taken into account for the indicator
  81208. * calculations.
  81209. */
  81210. period?: number;
  81211. }
  81212. /**
  81213. * (Highcharts) Enable or disable the initial animation when a series is
  81214. * displayed. The animation can also be set as a configuration object. Please
  81215. * note that this option only applies to the initial animation of the series
  81216. * itself. For other animations, see chart.animation and the animation parameter
  81217. * under the API methods. The following properties are supported:
  81218. *
  81219. * - `defer`: The animation delay time in milliseconds.
  81220. *
  81221. * - `duration`: The duration of the animation in milliseconds.
  81222. *
  81223. * - `easing`: Can be a string reference to an easing function set on the `Math`
  81224. * object or a function. See the _Custom easing function_ demo below.
  81225. *
  81226. * Due to poor performance, animation is disabled in old IE browsers for several
  81227. * chart types.
  81228. */
  81229. export interface PlotSolidgaugeAnimationOptions {
  81230. defer?: number;
  81231. }
  81232. /**
  81233. * (Highcharts) Enable or disable the initial animation when a series is
  81234. * displayed for the `dataLabels`. The animation can also be set as a
  81235. * configuration object. Please note that this option only applies to the
  81236. * initial animation. For other animations, see chart.animation and the
  81237. * animation parameter under the API methods. The following properties are
  81238. * supported:
  81239. *
  81240. * - `defer`: The animation delay time in milliseconds.
  81241. */
  81242. export interface PlotSolidgaugeDataLabelsAnimationOptions {
  81243. /**
  81244. * (Highcharts) The animation delay time in milliseconds. Set to `0` renders
  81245. * dataLabel immediately. As `undefined` inherits defer time from the
  81246. * series.animation.defer.
  81247. */
  81248. defer?: number;
  81249. }
  81250. /**
  81251. * (Highcharts) Data labels for the gauge. For gauges, the data labels are
  81252. * enabled by default and shown in a bordered box below the point.
  81253. */
  81254. export interface PlotSolidgaugeDataLabelsOptions {
  81255. /**
  81256. * (Highcharts) The alignment of the data label compared to the point. If
  81257. * `right`, the right side of the label should be touching the point. For
  81258. * points with an extent, like columns, the alignments also dictates how to
  81259. * align it inside the box, as given with the inside option. Can be one of
  81260. * `left`, `center` or `right`.
  81261. */
  81262. align?: (AlignValue|null);
  81263. /**
  81264. * (Highcharts) Whether to allow data labels to overlap. To make the labels
  81265. * less sensitive for overlapping, the dataLabels.padding can be set to 0.
  81266. */
  81267. allowOverlap?: boolean;
  81268. /**
  81269. * (Highcharts) Enable or disable the initial animation when a series is
  81270. * displayed for the `dataLabels`. The animation can also be set as a
  81271. * configuration object. Please note that this option only applies to the
  81272. * initial animation. For other animations, see chart.animation and the
  81273. * animation parameter under the API methods. The following properties are
  81274. * supported:
  81275. *
  81276. * - `defer`: The animation delay time in milliseconds.
  81277. */
  81278. animation?: (boolean|PlotSolidgaugeDataLabelsAnimationOptions|Partial<AnimationOptionsObject>);
  81279. /**
  81280. * (Highcharts) The background color or gradient for the data label.
  81281. */
  81282. backgroundColor?: (ColorString|GradientColorObject|PatternObject);
  81283. /**
  81284. * (Highcharts) The border color for the data label. Defaults to
  81285. * `undefined`.
  81286. */
  81287. borderColor?: string;
  81288. /**
  81289. * (Highcharts) The border radius in pixels for the data label.
  81290. */
  81291. borderRadius?: number;
  81292. /**
  81293. * (Highcharts) The border width in pixels for the data label.
  81294. */
  81295. borderWidth?: number;
  81296. /**
  81297. * (Highcharts) A class name for the data label. Particularly in styled
  81298. * mode, this can be used to give each series' or point's data label unique
  81299. * styling. In addition to this option, a default color class name is added
  81300. * so that we can give the labels a contrast text shadow.
  81301. */
  81302. className?: string;
  81303. /**
  81304. * (Highcharts) The text color for the data labels. Defaults to `undefined`.
  81305. * For certain series types, like column or map, the data labels can be
  81306. * drawn inside the points. In this case the data label will be drawn with
  81307. * maximum contrast by default. Additionally, it will be given a
  81308. * `text-outline` style with the opposite color, to further increase the
  81309. * contrast. This can be overridden by setting the `text-outline` style to
  81310. * `none` in the `dataLabels.style` option.
  81311. */
  81312. color?: (ColorString|GradientColorObject|PatternObject);
  81313. /**
  81314. * (Highcharts) Whether to hide data labels that are outside the plot area.
  81315. * By default, the data label is moved inside the plot area according to the
  81316. * overflow option.
  81317. */
  81318. crop?: boolean;
  81319. /**
  81320. * (Highcharts, Highstock, Gantt) Whether to defer displaying the data
  81321. * labels until the initial series animation has finished. Setting to
  81322. * `false` renders the data label immediately. If set to `true` inherits the
  81323. * defer time set in plotOptions.series.animation.
  81324. */
  81325. defer?: boolean;
  81326. /**
  81327. * (Highcharts) Enable or disable the data labels.
  81328. */
  81329. enabled?: boolean;
  81330. /**
  81331. * (Highcharts) A declarative filter to control of which data labels to
  81332. * display. The declarative filter is designed for use when callback
  81333. * functions are not available, like when the chart options require a pure
  81334. * JSON structure or for use with graphical editors. For programmatic
  81335. * control, use the `formatter` instead, and return `undefined` to disable a
  81336. * single data label.
  81337. */
  81338. filter?: DataLabelsFilterOptionsObject;
  81339. /**
  81340. * (Highcharts) A format string for the data label. Available variables are
  81341. * the same as for `formatter`.
  81342. */
  81343. format?: string;
  81344. /**
  81345. * (Highcharts) Callback JavaScript function to format the data label. Note
  81346. * that if a `format` is defined, the format takes precedence and the
  81347. * formatter is ignored.
  81348. */
  81349. formatter?: DataLabelsFormatterCallbackFunction;
  81350. /**
  81351. * (Highcharts) For points with an extent, like columns or map areas,
  81352. * whether to align the data label inside the box or to the actual value
  81353. * point. Defaults to `false` in most cases, `true` in stacked columns.
  81354. */
  81355. inside?: boolean;
  81356. /**
  81357. * (Highcharts) Format for points with the value of null. Works analogously
  81358. * to format. `nullFormat` can be applied only to series which support
  81359. * displaying null points.
  81360. */
  81361. nullFormat?: (boolean|string);
  81362. /**
  81363. * (Highcharts) Callback JavaScript function that defines formatting for
  81364. * points with the value of null. Works analogously to formatter.
  81365. * `nullPointFormatter` can be applied only to series which support
  81366. * displaying null points.
  81367. */
  81368. nullFormatter?: DataLabelsFormatterCallbackFunction;
  81369. /**
  81370. * (Highcharts) How to handle data labels that flow outside the plot area.
  81371. * The default is `"justify"`, which aligns them inside the plot area. For
  81372. * columns and bars, this means it will be moved inside the bar. To display
  81373. * data labels outside the plot area, set `crop` to `false` and `overflow`
  81374. * to `"allow"`.
  81375. */
  81376. overflow?: DataLabelsOverflowValue;
  81377. /**
  81378. * (Highcharts) When either the `borderWidth` or the `backgroundColor` is
  81379. * set, this is the padding within the box.
  81380. */
  81381. padding?: number;
  81382. /**
  81383. * (Highcharts) Aligns data labels relative to points. If `center` alignment
  81384. * is not possible, it defaults to `right`.
  81385. */
  81386. position?: AlignValue;
  81387. /**
  81388. * (Highcharts) Text rotation in degrees. Note that due to a more complex
  81389. * structure, backgrounds, borders and padding will be lost on a rotated
  81390. * data label.
  81391. */
  81392. rotation?: number;
  81393. /**
  81394. * (Highcharts) The shadow of the box. Works best with `borderWidth` or
  81395. * `backgroundColor`. Since 2.3 the shadow can be an object configuration
  81396. * containing `color`, `offsetX`, `offsetY`, `opacity` and `width`.
  81397. */
  81398. shadow?: (boolean|ShadowOptionsObject);
  81399. /**
  81400. * (Highcharts) The name of a symbol to use for the border around the label.
  81401. * Symbols are predefined functions on the Renderer object.
  81402. */
  81403. shape?: string;
  81404. /**
  81405. * (Highcharts) Styles for the label. The default `color` setting is
  81406. * `"contrast"`, which is a pseudo color that Highcharts picks up and
  81407. * applies the maximum contrast to the underlying point item, for example
  81408. * the bar in a bar chart.
  81409. *
  81410. * The `textOutline` is a pseudo property that applies an outline of the
  81411. * given width with the given color, which by default is the maximum
  81412. * contrast to the text. So a bright text color will result in a black text
  81413. * outline for maximum readability on a mixed background. In some cases,
  81414. * especially with grayscale text, the text outline doesn't work well, in
  81415. * which cases it can be disabled by setting it to `"none"`. When `useHTML`
  81416. * is true, the `textOutline` will not be picked up. In this, case, the same
  81417. * effect can be acheived through the `text-shadow` CSS property.
  81418. *
  81419. * For some series types, where each point has an extent, like for example
  81420. * tree maps, the data label may overflow the point. There are two
  81421. * strategies for handling overflow. By default, the text will wrap to
  81422. * multiple lines. The other strategy is to set `style.textOverflow` to
  81423. * `ellipsis`, which will keep the text on one line plus it will break
  81424. * inside long words.
  81425. */
  81426. style?: CSSObject;
  81427. /**
  81428. * (Highcharts) Options for a label text which should follow marker's shape.
  81429. * Border and background are disabled for a label that follows a path.
  81430. *
  81431. * **Note:** Only SVG-based renderer supports this option. Setting `useHTML`
  81432. * to true will disable this option.
  81433. */
  81434. textPath?: DataLabelsTextPathOptionsObject;
  81435. /**
  81436. * (Highcharts) Whether to use HTML to render the labels.
  81437. */
  81438. useHTML?: boolean;
  81439. /**
  81440. * (Highcharts) The vertical alignment of a data label. Can be one of `top`,
  81441. * `middle` or `bottom`. The default value depends on the data, for instance
  81442. * in a column chart, the label is above positive values and below negative
  81443. * values.
  81444. */
  81445. verticalAlign?: string;
  81446. /**
  81447. * (Highcharts) The x position offset of the label relative to the point in
  81448. * pixels.
  81449. */
  81450. x?: number;
  81451. /**
  81452. * (Highcharts) The y position offset of the label relative to the point in
  81453. * pixels.
  81454. */
  81455. y?: number;
  81456. /**
  81457. * (Highcharts) The Z index of the data labels. The default Z index puts it
  81458. * above the series. Use a Z index of 2 to display it behind the series.
  81459. */
  81460. z?: number;
  81461. zIndex?: number;
  81462. }
  81463. /**
  81464. * (Highcharts) A solid gauge is a circular gauge where the value is indicated
  81465. * by a filled arc, and the color of the arc may variate with the value.
  81466. *
  81467. * In TypeScript the type option must always be set.
  81468. *
  81469. * Configuration options for the series are given in three levels:
  81470. *
  81471. * 1. Options for all series in a chart are defined in the plotOptions.series
  81472. * object.
  81473. *
  81474. * 2. Options for all `solidgauge` series are defined in plotOptions.solidgauge.
  81475. *
  81476. * 3. Options for one single series are given in the series instance array. (see
  81477. * online documentation for example)
  81478. */
  81479. export interface PlotSolidgaugeOptions {
  81480. /**
  81481. * (Highcharts) Accessibility options for a series.
  81482. */
  81483. accessibility?: SeriesAccessibilityOptionsObject;
  81484. /**
  81485. * (Highmaps) Whether all areas of the map defined in `mapData` should be
  81486. * rendered. If `true`, areas which don't correspond to a data point, are
  81487. * rendered as `null` points. If `false`, those areas are skipped.
  81488. */
  81489. allAreas?: boolean;
  81490. /**
  81491. * (Highcharts) Allow this series' points to be selected by clicking on the
  81492. * graphic (columns, point markers, pie slices, map areas etc).
  81493. *
  81494. * The selected points can be handled by point select and unselect events,
  81495. * or collectively by the getSelectedPoints function.
  81496. *
  81497. * And alternative way of selecting points is through dragging.
  81498. */
  81499. allowPointSelect?: boolean;
  81500. /**
  81501. * (Highcharts) Enable or disable the initial animation when a series is
  81502. * displayed. The animation can also be set as a configuration object.
  81503. * Please note that this option only applies to the initial animation of the
  81504. * series itself. For other animations, see chart.animation and the
  81505. * animation parameter under the API methods. The following properties are
  81506. * supported:
  81507. *
  81508. * - `defer`: The animation delay time in milliseconds.
  81509. *
  81510. * - `duration`: The duration of the animation in milliseconds.
  81511. *
  81512. * - `easing`: Can be a string reference to an easing function set on the
  81513. * `Math` object or a function. See the _Custom easing function_ demo below.
  81514. *
  81515. * Due to poor performance, animation is disabled in old IE browsers for
  81516. * several chart types.
  81517. */
  81518. animation?: (boolean|PlotSolidgaugeAnimationOptions|Partial<AnimationOptionsObject>);
  81519. /**
  81520. * (Highmaps) The border color of the map areas.
  81521. *
  81522. * In styled mode, the border stroke is given in the `.highcharts-point`
  81523. * class.
  81524. */
  81525. borderColor?: (ColorString|GradientColorObject|PatternObject);
  81526. /**
  81527. * (Highmaps) The border width of each map area.
  81528. *
  81529. * In styled mode, the border stroke width is given in the
  81530. * `.highcharts-point` class.
  81531. */
  81532. borderWidth?: number;
  81533. /**
  81534. * (Highcharts) An additional class name to apply to the series' graphical
  81535. * elements. This option does not replace default class names of the
  81536. * graphical element.
  81537. */
  81538. className?: string;
  81539. /**
  81540. * (Highcharts) Disable this option to allow series rendering in the whole
  81541. * plotting area.
  81542. *
  81543. * **Note:** Clipping should be always enabled when chart.zoomType is set
  81544. */
  81545. clip?: boolean;
  81546. /**
  81547. * (Highcharts) The main color of the series. In line type series it applies
  81548. * to the line and the point markers unless otherwise specified. In bar type
  81549. * series it applies to the bars unless a color is specified per point. The
  81550. * default value is pulled from the `options.colors` array.
  81551. *
  81552. * In styled mode, the color can be defined by the colorIndex option. Also,
  81553. * the series color can be set with the `.highcharts-series`,
  81554. * `.highcharts-color-{n}`, `.highcharts-{type}-series` or
  81555. * `.highcharts-series-{n}` class, or individual classes given by the
  81556. * `className` option.
  81557. */
  81558. color?: (ColorString|GradientColorObject|PatternObject);
  81559. /**
  81560. * (Highcharts) Whether to give each point an individual color.
  81561. */
  81562. colorByPoint?: boolean;
  81563. /**
  81564. * (Highcharts) Styled mode only. A specific color index to use for the
  81565. * series, so its graphic representations are given the class name
  81566. * `highcharts-color-{n}`.
  81567. */
  81568. colorIndex?: number;
  81569. /**
  81570. * (Highstock) Compare the values of the series against the first non-null,
  81571. * non- zero value in the visible range. The y axis will show percentage or
  81572. * absolute change depending on whether `compare` is set to `"percent"` or
  81573. * `"value"`. When this is applied to multiple series, it allows comparing
  81574. * the development of the series against each other. Adds a `change` field
  81575. * to every point object.
  81576. */
  81577. compare?: string;
  81578. /**
  81579. * (Highstock) When compare is `percent`, this option dictates whether to
  81580. * use 0 or 100 as the base of comparison.
  81581. */
  81582. compareBase?: (0|100);
  81583. /**
  81584. * (Highstock) Defines if comparison should start from the first point
  81585. * within the visible range or should start from the first point **before**
  81586. * the range.
  81587. *
  81588. * In other words, this flag determines if first point within the visible
  81589. * range will have 0% (`compareStart=true`) or should have been already
  81590. * calculated according to the previous point (`compareStart=false`).
  81591. */
  81592. compareStart?: boolean;
  81593. /**
  81594. * (Gantt) Override Pathfinder connector options for a series. Requires
  81595. * Highcharts Gantt to be loaded.
  81596. */
  81597. connectors?: SeriesConnectorsOptionsObject;
  81598. /**
  81599. * (Highcharts, Highstock, Gantt) When true, each point or column edge is
  81600. * rounded to its nearest pixel in order to render sharp on screen. In some
  81601. * cases, when there are a lot of densely packed columns, this leads to
  81602. * visible difference in column widths or distance between columns. In these
  81603. * cases, setting `crisp` to `false` may look better, even though each
  81604. * column is rendered blurry.
  81605. */
  81606. crisp?: boolean;
  81607. /**
  81608. * (Highcharts) You can set the cursor to "pointer" if you have click events
  81609. * attached to the series, to signal to the user that the points and lines
  81610. * can be clicked.
  81611. *
  81612. * In styled mode, the series cursor can be set with the same classes as
  81613. * listed under series.color.
  81614. */
  81615. cursor?: (string|CursorValue);
  81616. /**
  81617. * (Highcharts) A reserved subspace to store options and values for
  81618. * customized functionality. Here you can add additional data for your own
  81619. * event callbacks and formatter callbacks.
  81620. */
  81621. custom?: Dictionary<any>;
  81622. /**
  81623. * (Highstock) Data grouping is the concept of sampling the data values into
  81624. * larger blocks in order to ease readability and increase performance of
  81625. * the JavaScript charts. Highstock by default applies data grouping when
  81626. * the points become closer than a certain pixel value, determined by the
  81627. * `groupPixelWidth` option.
  81628. *
  81629. * If data grouping is applied, the grouping information of grouped points
  81630. * can be read from the Point.dataGroup. If point options other than the
  81631. * data itself are set, for example `name` or `color` or custom properties,
  81632. * the grouping logic doesn't know how to group it. In this case the options
  81633. * of the first point instance are copied over to the group point. This can
  81634. * be altered through a custom `approximation` callback function.
  81635. */
  81636. dataGrouping?: DataGroupingOptionsObject;
  81637. /**
  81638. * (Highcharts) Data labels for the gauge. For gauges, the data labels are
  81639. * enabled by default and shown in a bordered box below the point.
  81640. */
  81641. dataLabels?: (PlotSolidgaugeDataLabelsOptions|Array<PlotSolidgaugeDataLabelsOptions>);
  81642. /**
  81643. * (Highcharts) A description of the series to add to the screen reader
  81644. * information about the series.
  81645. */
  81646. description?: string;
  81647. /**
  81648. * (Highcharts) Enable or disable the mouse tracking for a specific series.
  81649. * This includes point tooltips and click events on graphs and points. For
  81650. * large datasets it improves performance.
  81651. */
  81652. enableMouseTracking?: boolean;
  81653. /**
  81654. * (Highcharts) General event handlers for the series items. These event
  81655. * hooks can also be attached to the series at run time using the
  81656. * `Highcharts.addEvent` function.
  81657. */
  81658. events?: SeriesEventsOptionsObject;
  81659. /**
  81660. * (Highstock) Defines when to display a gap in the graph, together with the
  81661. * gapUnit option.
  81662. *
  81663. * In case when `dataGrouping` is enabled, points can be grouped into a
  81664. * larger time span. This can make the grouped points to have a greater
  81665. * distance than the absolute value of `gapSize` property, which will result
  81666. * in disappearing graph completely. To prevent this situation the mentioned
  81667. * distance between grouped points is used instead of previously defined
  81668. * `gapSize`.
  81669. *
  81670. * In practice, this option is most often used to visualize gaps in time
  81671. * series. In a stock chart, intraday data is available for daytime hours,
  81672. * while gaps will appear in nights and weekends.
  81673. */
  81674. gapSize?: number;
  81675. /**
  81676. * (Highstock) Together with gapSize, this option defines where to draw gaps
  81677. * in the graph.
  81678. *
  81679. * When the `gapUnit` is `"relative"` (default), a gap size of 5 means that
  81680. * if the distance between two points is greater than 5 times that of the
  81681. * two closest points, the graph will be broken.
  81682. *
  81683. * When the `gapUnit` is `"value"`, the gap is based on absolute axis
  81684. * values, which on a datetime axis is milliseconds. This also applies to
  81685. * the navigator series that inherits gap options from the base series.
  81686. */
  81687. gapUnit?: OptionsGapUnitValue;
  81688. /**
  81689. * (Highcharts) When set to `false` will prevent the series data from being
  81690. * included in any form of data export.
  81691. *
  81692. * Since version 6.0.0 until 7.1.0 the option was existing undocumented as
  81693. * `includeInCSVExport`.
  81694. */
  81695. includeInDataExport?: boolean;
  81696. /**
  81697. * (Highcharts) The inner radius for points in a solid gauge. Can be given
  81698. * as a number (pixels) or percentage string.
  81699. */
  81700. innerRadius?: (number|string);
  81701. /**
  81702. * (Highmaps) What property to join the `mapData` to the value data. For
  81703. * example, if joinBy is "code", the mapData items with a specific code is
  81704. * merged into the data with the same code. For maps loaded from GeoJSON,
  81705. * the keys may be held in each point's `properties` object.
  81706. *
  81707. * The joinBy option can also be an array of two values, where the first
  81708. * points to a key in the `mapData`, and the second points to another key in
  81709. * the `data`.
  81710. *
  81711. * When joinBy is `null`, the map items are joined by their position in the
  81712. * array, which performs much better in maps with many data points. This is
  81713. * the recommended option if you are printing more than a thousand data
  81714. * points and have a backend that can preprocess the data into a parallel
  81715. * array of the mapData.
  81716. */
  81717. joinBy?: (string|Array<string>);
  81718. /**
  81719. * (Highcharts) An array specifying which option maps to which key in the
  81720. * data point array. This makes it convenient to work with unstructured data
  81721. * arrays from different sources.
  81722. */
  81723. keys?: Array<string>;
  81724. /**
  81725. * (Highcharts, Highstock, Gantt) Series labels are placed as close to the
  81726. * series as possible in a natural way, seeking to avoid other series. The
  81727. * goal of this feature is to make the chart more easily readable, like if a
  81728. * human designer placed the labels in the optimal position.
  81729. *
  81730. * The series labels currently work with series types having a `graph` or an
  81731. * `area`.
  81732. */
  81733. label?: SeriesLabelOptionsObject;
  81734. /**
  81735. * (Highstock) The line marks the last price from all points.
  81736. */
  81737. lastPrice?: SeriesLastPriceOptionsObject;
  81738. /**
  81739. * (Highstock) The line marks the last price from visible range of points.
  81740. */
  81741. lastVisiblePrice?: SeriesLastVisiblePriceOptionsObject;
  81742. /**
  81743. * (Highcharts) Whether the strokes of the solid gauge should be `round` or
  81744. * `square`.
  81745. */
  81746. linecap?: OptionsLinecapValue;
  81747. /**
  81748. * (Highcharts, Highstock) Pixel width of the graph line.
  81749. */
  81750. lineWidth?: number;
  81751. /**
  81752. * (Highcharts, Highstock, Gantt) The id of another series to link to.
  81753. * Additionally, the value can be ":previous" to link to the previous
  81754. * series. When two series are linked, only the first one appears in the
  81755. * legend. Toggling the visibility of this also toggles the linked series.
  81756. *
  81757. * If master series uses data sorting and linked series does not have its
  81758. * own sorting definition, the linked series will be sorted in the same
  81759. * order as the master one.
  81760. */
  81761. linkedTo?: string;
  81762. /**
  81763. * (Highstock) Options for the corresponding navigator series if
  81764. * `showInNavigator` is `true` for this series. Available options are the
  81765. * same as any series, documented at plotOptions and series.
  81766. *
  81767. * These options are merged with options in navigator.series, and will take
  81768. * precedence if the same option is defined both places.
  81769. */
  81770. navigatorOptions?: PlotSeriesOptions;
  81771. /**
  81772. * (Highcharts) Opacity of a series parts: line, fill (e.g. area) and
  81773. * dataLabels.
  81774. */
  81775. opacity?: number;
  81776. /**
  81777. * (Highcharts) Allow the gauge to overshoot the end of the perimeter axis
  81778. * by this many degrees. Say if the gauge axis goes from 0 to 60, a value of
  81779. * 100, or 1000, will show 5 degrees beyond the end of the axis when this
  81780. * option is set to 5.
  81781. */
  81782. overshoot?: number;
  81783. /**
  81784. * (Highcharts) Properties for each single point.
  81785. */
  81786. point?: PlotSeriesPointOptions;
  81787. /**
  81788. * (Highcharts) Same as accessibility.pointDescriptionFormatter, but for an
  81789. * individual series. Overrides the chart wide configuration.
  81790. */
  81791. pointDescriptionFormatter?: Function;
  81792. /**
  81793. * (Highcharts, Highstock, Gantt) If no x values are given for the points in
  81794. * a series, `pointInterval` defines the interval of the x values. For
  81795. * example, if a series contains one value every decade starting from year
  81796. * 0, set `pointInterval` to `10`. In true `datetime` axes, the
  81797. * `pointInterval` is set in milliseconds.
  81798. *
  81799. * It can be also be combined with `pointIntervalUnit` to draw irregular
  81800. * time intervals.
  81801. *
  81802. * Please note that this options applies to the _series data_, not the
  81803. * interval of the axis ticks, which is independent.
  81804. */
  81805. pointInterval?: number;
  81806. /**
  81807. * (Highcharts, Highstock, Gantt) On datetime series, this allows for
  81808. * setting the pointInterval to irregular time units, `day`, `month` and
  81809. * `year`. A day is usually the same as 24 hours, but `pointIntervalUnit`
  81810. * also takes the DST crossover into consideration when dealing with local
  81811. * time. Combine this option with `pointInterval` to draw weeks, quarters, 6
  81812. * months, 10 years etc.
  81813. *
  81814. * Please note that this options applies to the _series data_, not the
  81815. * interval of the axis ticks, which is independent.
  81816. */
  81817. pointIntervalUnit?: OptionsPointIntervalUnitValue;
  81818. /**
  81819. * (Highstock) The width of each point on the x axis. For example in a
  81820. * column chart with one value each day, the pointRange would be 1 day (= 24
  81821. * * 3600
  81822. *
  81823. * * 1000 milliseconds). This is normally computed automatically, but this
  81824. * option can be used to override the automatic value.
  81825. */
  81826. pointRange?: number;
  81827. /**
  81828. * (Highcharts, Highstock, Gantt) If no x values are given for the points in
  81829. * a series, pointStart defines on what value to start. For example, if a
  81830. * series contains one yearly value starting from 1945, set pointStart to
  81831. * 1945.
  81832. */
  81833. pointStart?: number;
  81834. /**
  81835. * (Highcharts) The outer radius for points in a solid gauge. Can be given
  81836. * as a number (pixels) or percentage string.
  81837. */
  81838. radius?: (number|string);
  81839. /**
  81840. * (Highcharts) Wether to draw rounded edges on the gauge.
  81841. */
  81842. rounded?: boolean;
  81843. /**
  81844. * (Highcharts) Whether to select the series initially. If `showCheckbox` is
  81845. * true, the checkbox next to the series name in the legend will be checked
  81846. * for a selected series.
  81847. */
  81848. selected?: boolean;
  81849. /**
  81850. * (Highcharts) If true, a checkbox is displayed next to the legend item to
  81851. * allow selecting the series. The state of the checkbox is determined by
  81852. * the `selected` option.
  81853. */
  81854. showCheckbox?: boolean;
  81855. /**
  81856. * (Highcharts) Whether to display this particular series or series type in
  81857. * the legend. Defaults to false for gauge series.
  81858. */
  81859. showInLegend?: boolean;
  81860. /**
  81861. * (Highstock) Whether or not to show the series in the navigator. Takes
  81862. * precedence over navigator.baseSeries if defined.
  81863. */
  81864. showInNavigator?: boolean;
  81865. /**
  81866. * (Highcharts) If set to `true`, the accessibility module will skip past
  81867. * the points in this series for keyboard navigation.
  81868. */
  81869. skipKeyboardNavigation?: boolean;
  81870. /**
  81871. * (Highcharts) Sticky tracking of mouse events. When true, the `mouseOut`
  81872. * event on a series isn't triggered until the mouse moves over another
  81873. * series, or out of the plot area. When false, the `mouseOut` event on a
  81874. * series is triggered when the mouse leaves the area around the series'
  81875. * graph or markers. This also implies the tooltip when not shared. When
  81876. * `stickyTracking` is false and `tooltip.shared` is false, the tooltip will
  81877. * be hidden when moving the mouse between series. Defaults to true for line
  81878. * and area type series, but to false for columns, pies etc.
  81879. *
  81880. * **Note:** The boost module will force this option because of technical
  81881. * limitations.
  81882. */
  81883. stickyTracking?: boolean;
  81884. /**
  81885. * (Highcharts) The threshold or base level for the gauge.
  81886. */
  81887. threshold?: (number|null);
  81888. /**
  81889. * (Highcharts) A configuration object for the tooltip rendering of each
  81890. * single series. Properties are inherited from tooltip, but only the
  81891. * following properties can be defined on a series level.
  81892. */
  81893. tooltip?: SeriesTooltipOptionsObject;
  81894. /**
  81895. * (Highstock) The parameter allows setting line series type and use OHLC
  81896. * indicators. Data in OHLC format is required.
  81897. */
  81898. useOhlcData?: boolean;
  81899. /**
  81900. * (Highcharts) Set the initial visibility of the series.
  81901. */
  81902. visible?: boolean;
  81903. /**
  81904. * (Highmaps) Define the z index of the series.
  81905. */
  81906. zIndex?: number;
  81907. }
  81908. /**
  81909. * (Highcharts, Highstock) Enable or disable the initial animation when a series
  81910. * is displayed. The animation can also be set as a configuration object. Please
  81911. * note that this option only applies to the initial animation of the series
  81912. * itself. For other animations, see chart.animation and the animation parameter
  81913. * under the API methods. The following properties are supported:
  81914. *
  81915. * - `defer`: The animation delay time in milliseconds.
  81916. *
  81917. * - `duration`: The duration of the animation in milliseconds.
  81918. *
  81919. * - `easing`: Can be a string reference to an easing function set on the `Math`
  81920. * object or a function. See the _Custom easing function_ demo below.
  81921. *
  81922. * Due to poor performance, animation is disabled in old IE browsers for several
  81923. * chart types.
  81924. */
  81925. export interface PlotSplineAnimationOptions {
  81926. defer?: number;
  81927. }
  81928. /**
  81929. * (Highcharts, Highstock, Highmaps, Gantt) Enable or disable the initial
  81930. * animation when a series is displayed for the `dataLabels`. The animation can
  81931. * also be set as a configuration object. Please note that this option only
  81932. * applies to the initial animation. For other animations, see chart.animation
  81933. * and the animation parameter under the API methods. The following properties
  81934. * are supported:
  81935. *
  81936. * - `defer`: The animation delay time in milliseconds.
  81937. */
  81938. export interface PlotSplineDataLabelsAnimationOptions {
  81939. /**
  81940. * (Highcharts, Highstock, Highmaps, Gantt) The animation delay time in
  81941. * milliseconds. Set to `0` renders dataLabel immediately. As `undefined`
  81942. * inherits defer time from the series.animation.defer.
  81943. */
  81944. defer?: number;
  81945. }
  81946. /**
  81947. * (Highcharts, Highstock, Highmaps, Gantt) Options for the series data labels,
  81948. * appearing next to each data point.
  81949. *
  81950. * Since v6.2.0, multiple data labels can be applied to each single point by
  81951. * defining them as an array of configs.
  81952. *
  81953. * In styled mode, the data labels can be styled with the
  81954. * `.highcharts-data-label-box` and `.highcharts-data-label` class names (see
  81955. * example).
  81956. */
  81957. export interface PlotSplineDataLabelsOptions {
  81958. /**
  81959. * (Highcharts, Highstock, Highmaps, Gantt) The alignment of the data label
  81960. * compared to the point. If `right`, the right side of the label should be
  81961. * touching the point. For points with an extent, like columns, the
  81962. * alignments also dictates how to align it inside the box, as given with
  81963. * the inside option. Can be one of `left`, `center` or `right`.
  81964. */
  81965. align?: (AlignValue|null);
  81966. /**
  81967. * (Highcharts, Highstock, Highmaps, Gantt) Whether to allow data labels to
  81968. * overlap. To make the labels less sensitive for overlapping, the
  81969. * dataLabels.padding can be set to 0.
  81970. */
  81971. allowOverlap?: boolean;
  81972. /**
  81973. * (Highcharts, Highstock, Highmaps, Gantt) Enable or disable the initial
  81974. * animation when a series is displayed for the `dataLabels`. The animation
  81975. * can also be set as a configuration object. Please note that this option
  81976. * only applies to the initial animation. For other animations, see
  81977. * chart.animation and the animation parameter under the API methods. The
  81978. * following properties are supported:
  81979. *
  81980. * - `defer`: The animation delay time in milliseconds.
  81981. */
  81982. animation?: (boolean|PlotSplineDataLabelsAnimationOptions|Partial<AnimationOptionsObject>);
  81983. /**
  81984. * (Highcharts, Highstock, Highmaps, Gantt) The background color or gradient
  81985. * for the data label.
  81986. */
  81987. backgroundColor?: (ColorString|GradientColorObject|PatternObject);
  81988. /**
  81989. * (Highcharts, Highstock, Highmaps, Gantt) The border color for the data
  81990. * label. Defaults to `undefined`.
  81991. */
  81992. borderColor?: (ColorString|GradientColorObject|PatternObject);
  81993. /**
  81994. * (Highcharts, Highstock, Highmaps, Gantt) The border radius in pixels for
  81995. * the data label.
  81996. */
  81997. borderRadius?: number;
  81998. /**
  81999. * (Highcharts, Highstock, Highmaps, Gantt) The border width in pixels for
  82000. * the data label.
  82001. */
  82002. borderWidth?: number;
  82003. /**
  82004. * (Highcharts, Highstock, Highmaps, Gantt) A class name for the data label.
  82005. * Particularly in styled mode, this can be used to give each series' or
  82006. * point's data label unique styling. In addition to this option, a default
  82007. * color class name is added so that we can give the labels a contrast text
  82008. * shadow.
  82009. */
  82010. className?: string;
  82011. /**
  82012. * (Highcharts, Highstock, Highmaps, Gantt) The text color for the data
  82013. * labels. Defaults to `undefined`. For certain series types, like column or
  82014. * map, the data labels can be drawn inside the points. In this case the
  82015. * data label will be drawn with maximum contrast by default. Additionally,
  82016. * it will be given a `text-outline` style with the opposite color, to
  82017. * further increase the contrast. This can be overridden by setting the
  82018. * `text-outline` style to `none` in the `dataLabels.style` option.
  82019. */
  82020. color?: (ColorString|GradientColorObject|PatternObject);
  82021. /**
  82022. * (Highcharts, Highstock, Highmaps, Gantt) Whether to hide data labels that
  82023. * are outside the plot area. By default, the data label is moved inside the
  82024. * plot area according to the overflow option.
  82025. */
  82026. crop?: boolean;
  82027. /**
  82028. * (Highcharts, Highstock, Gantt) Whether to defer displaying the data
  82029. * labels until the initial series animation has finished. Setting to
  82030. * `false` renders the data label immediately. If set to `true` inherits the
  82031. * defer time set in plotOptions.series.animation.
  82032. */
  82033. defer?: boolean;
  82034. /**
  82035. * (Highcharts, Highstock, Highmaps, Gantt) Enable or disable the data
  82036. * labels.
  82037. */
  82038. enabled?: boolean;
  82039. /**
  82040. * (Highcharts, Highstock, Highmaps, Gantt) A declarative filter to control
  82041. * of which data labels to display. The declarative filter is designed for
  82042. * use when callback functions are not available, like when the chart
  82043. * options require a pure JSON structure or for use with graphical editors.
  82044. * For programmatic control, use the `formatter` instead, and return
  82045. * `undefined` to disable a single data label.
  82046. */
  82047. filter?: DataLabelsFilterOptionsObject;
  82048. /**
  82049. * (Highcharts, Highstock, Highmaps, Gantt) A format string for the data
  82050. * label. Available variables are the same as for `formatter`.
  82051. */
  82052. format?: string;
  82053. /**
  82054. * (Highcharts, Highstock, Highmaps, Gantt) Callback JavaScript function to
  82055. * format the data label. Note that if a `format` is defined, the format
  82056. * takes precedence and the formatter is ignored.
  82057. */
  82058. formatter?: DataLabelsFormatterCallbackFunction;
  82059. /**
  82060. * (Highcharts, Highstock, Highmaps, Gantt) For points with an extent, like
  82061. * columns or map areas, whether to align the data label inside the box or
  82062. * to the actual value point. Defaults to `false` in most cases, `true` in
  82063. * stacked columns.
  82064. */
  82065. inside?: boolean;
  82066. /**
  82067. * (Highcharts, Highstock, Highmaps, Gantt) Format for points with the value
  82068. * of null. Works analogously to format. `nullFormat` can be applied only to
  82069. * series which support displaying null points.
  82070. */
  82071. nullFormat?: (boolean|string);
  82072. /**
  82073. * (Highcharts, Highstock, Highmaps, Gantt) Callback JavaScript function
  82074. * that defines formatting for points with the value of null. Works
  82075. * analogously to formatter. `nullPointFormatter` can be applied only to
  82076. * series which support displaying null points.
  82077. */
  82078. nullFormatter?: DataLabelsFormatterCallbackFunction;
  82079. /**
  82080. * (Highcharts, Highstock, Highmaps, Gantt) How to handle data labels that
  82081. * flow outside the plot area. The default is `"justify"`, which aligns them
  82082. * inside the plot area. For columns and bars, this means it will be moved
  82083. * inside the bar. To display data labels outside the plot area, set `crop`
  82084. * to `false` and `overflow` to `"allow"`.
  82085. */
  82086. overflow?: DataLabelsOverflowValue;
  82087. /**
  82088. * (Highcharts, Highstock, Highmaps, Gantt) When either the `borderWidth` or
  82089. * the `backgroundColor` is set, this is the padding within the box.
  82090. */
  82091. padding?: number;
  82092. /**
  82093. * (Highcharts, Highstock, Highmaps, Gantt) Aligns data labels relative to
  82094. * points. If `center` alignment is not possible, it defaults to `right`.
  82095. */
  82096. position?: AlignValue;
  82097. /**
  82098. * (Highcharts, Highstock, Highmaps, Gantt) Text rotation in degrees. Note
  82099. * that due to a more complex structure, backgrounds, borders and padding
  82100. * will be lost on a rotated data label.
  82101. */
  82102. rotation?: number;
  82103. /**
  82104. * (Highcharts, Highstock, Highmaps, Gantt) The shadow of the box. Works
  82105. * best with `borderWidth` or `backgroundColor`. Since 2.3 the shadow can be
  82106. * an object configuration containing `color`, `offsetX`, `offsetY`,
  82107. * `opacity` and `width`.
  82108. */
  82109. shadow?: (boolean|ShadowOptionsObject);
  82110. /**
  82111. * (Highcharts, Highstock, Highmaps, Gantt) The name of a symbol to use for
  82112. * the border around the label. Symbols are predefined functions on the
  82113. * Renderer object.
  82114. */
  82115. shape?: string;
  82116. /**
  82117. * (Highcharts, Highstock, Highmaps, Gantt) Styles for the label. The
  82118. * default `color` setting is `"contrast"`, which is a pseudo color that
  82119. * Highcharts picks up and applies the maximum contrast to the underlying
  82120. * point item, for example the bar in a bar chart.
  82121. *
  82122. * The `textOutline` is a pseudo property that applies an outline of the
  82123. * given width with the given color, which by default is the maximum
  82124. * contrast to the text. So a bright text color will result in a black text
  82125. * outline for maximum readability on a mixed background. In some cases,
  82126. * especially with grayscale text, the text outline doesn't work well, in
  82127. * which cases it can be disabled by setting it to `"none"`. When `useHTML`
  82128. * is true, the `textOutline` will not be picked up. In this, case, the same
  82129. * effect can be acheived through the `text-shadow` CSS property.
  82130. *
  82131. * For some series types, where each point has an extent, like for example
  82132. * tree maps, the data label may overflow the point. There are two
  82133. * strategies for handling overflow. By default, the text will wrap to
  82134. * multiple lines. The other strategy is to set `style.textOverflow` to
  82135. * `ellipsis`, which will keep the text on one line plus it will break
  82136. * inside long words.
  82137. */
  82138. style?: CSSObject;
  82139. /**
  82140. * (Highcharts, Highstock, Highmaps, Gantt) Options for a label text which
  82141. * should follow marker's shape. Border and background are disabled for a
  82142. * label that follows a path.
  82143. *
  82144. * **Note:** Only SVG-based renderer supports this option. Setting `useHTML`
  82145. * to true will disable this option.
  82146. */
  82147. textPath?: DataLabelsTextPathOptionsObject;
  82148. /**
  82149. * (Highcharts, Highstock, Highmaps, Gantt) Whether to use HTML to render
  82150. * the labels.
  82151. */
  82152. useHTML?: boolean;
  82153. /**
  82154. * (Highcharts, Highstock, Highmaps, Gantt) The vertical alignment of a data
  82155. * label. Can be one of `top`, `middle` or `bottom`. The default value
  82156. * depends on the data, for instance in a column chart, the label is above
  82157. * positive values and below negative values.
  82158. */
  82159. verticalAlign?: (VerticalAlignValue|null);
  82160. /**
  82161. * (Highcharts, Highstock, Highmaps, Gantt) The x position offset of the
  82162. * label relative to the point in pixels.
  82163. */
  82164. x?: number;
  82165. /**
  82166. * (Highcharts, Highstock, Highmaps, Gantt) The y position offset of the
  82167. * label relative to the point in pixels.
  82168. */
  82169. y?: number;
  82170. /**
  82171. * (Highcharts, Highstock, Highmaps, Gantt) The Z index of the data labels.
  82172. * The default Z index puts it above the series. Use a Z index of 2 to
  82173. * display it behind the series.
  82174. */
  82175. z?: number;
  82176. }
  82177. /**
  82178. * (Highcharts, Highstock) Options for the series data sorting.
  82179. */
  82180. export interface PlotSplineDataSortingOptions {
  82181. /**
  82182. * (Highcharts, Highstock) Enable or disable data sorting for the series.
  82183. * Use xAxis.reversed to change the sorting order.
  82184. */
  82185. enabled?: boolean;
  82186. /**
  82187. * (Highcharts, Highstock) Whether to allow matching points by name in an
  82188. * update. If this option is disabled, points will be matched by order.
  82189. */
  82190. matchByName?: boolean;
  82191. /**
  82192. * (Highcharts, Highstock) Determines what data value should be used to sort
  82193. * by.
  82194. */
  82195. sortKey?: string;
  82196. }
  82197. /**
  82198. * (Highcharts, Highstock) Style options for the guide box. The guide box has
  82199. * one state by default, the `default` state.
  82200. */
  82201. export interface PlotSplineDragDropGuideBoxOptions {
  82202. /**
  82203. * (Highcharts, Highstock) Style options for the guide box default state.
  82204. */
  82205. default?: DragDropGuideBoxOptionsObject;
  82206. }
  82207. /**
  82208. * (Highcharts, Highstock) A spline series is a special type of line series,
  82209. * where the segments between the data points are smoothed.
  82210. *
  82211. * In TypeScript the type option must always be set.
  82212. *
  82213. * Configuration options for the series are given in three levels:
  82214. *
  82215. * 1. Options for all series in a chart are defined in the plotOptions.series
  82216. * object.
  82217. *
  82218. * 2. Options for all `spline` series are defined in plotOptions.spline.
  82219. *
  82220. * 3. Options for one single series are given in the series instance array. (see
  82221. * online documentation for example)
  82222. */
  82223. export interface PlotSplineOptions {
  82224. /**
  82225. * (Highcharts, Highstock) Accessibility options for a series.
  82226. */
  82227. accessibility?: SeriesAccessibilityOptionsObject;
  82228. /**
  82229. * (Highmaps) Whether all areas of the map defined in `mapData` should be
  82230. * rendered. If `true`, areas which don't correspond to a data point, are
  82231. * rendered as `null` points. If `false`, those areas are skipped.
  82232. */
  82233. allAreas?: boolean;
  82234. /**
  82235. * (Highcharts, Highstock) Allow this series' points to be selected by
  82236. * clicking on the graphic (columns, point markers, pie slices, map areas
  82237. * etc).
  82238. *
  82239. * The selected points can be handled by point select and unselect events,
  82240. * or collectively by the getSelectedPoints function.
  82241. *
  82242. * And alternative way of selecting points is through dragging.
  82243. */
  82244. allowPointSelect?: boolean;
  82245. /**
  82246. * (Highcharts, Highstock) Enable or disable the initial animation when a
  82247. * series is displayed. The animation can also be set as a configuration
  82248. * object. Please note that this option only applies to the initial
  82249. * animation of the series itself. For other animations, see chart.animation
  82250. * and the animation parameter under the API methods. The following
  82251. * properties are supported:
  82252. *
  82253. * - `defer`: The animation delay time in milliseconds.
  82254. *
  82255. * - `duration`: The duration of the animation in milliseconds.
  82256. *
  82257. * - `easing`: Can be a string reference to an easing function set on the
  82258. * `Math` object or a function. See the _Custom easing function_ demo below.
  82259. *
  82260. * Due to poor performance, animation is disabled in old IE browsers for
  82261. * several chart types.
  82262. */
  82263. animation?: (boolean|PlotSplineAnimationOptions|Partial<AnimationOptionsObject>);
  82264. /**
  82265. * (Highcharts, Highstock) For some series, there is a limit that shuts down
  82266. * initial animation by default when the total number of points in the chart
  82267. * is too high. For example, for a column chart and its derivatives,
  82268. * animation does not run if there is more than 250 points totally. To
  82269. * disable this cap, set `animationLimit` to `Infinity`.
  82270. */
  82271. animationLimit?: number;
  82272. /**
  82273. * (Highmaps) The border color of the map areas.
  82274. *
  82275. * In styled mode, the border stroke is given in the `.highcharts-point`
  82276. * class.
  82277. */
  82278. borderColor?: (ColorString|GradientColorObject|PatternObject);
  82279. /**
  82280. * (Highmaps) The border width of each map area.
  82281. *
  82282. * In styled mode, the border stroke width is given in the
  82283. * `.highcharts-point` class.
  82284. */
  82285. borderWidth?: number;
  82286. /**
  82287. * (Highcharts, Highstock) An additional class name to apply to the series'
  82288. * graphical elements. This option does not replace default class names of
  82289. * the graphical element.
  82290. */
  82291. className?: string;
  82292. /**
  82293. * (Highcharts, Highstock) Disable this option to allow series rendering in
  82294. * the whole plotting area.
  82295. *
  82296. * **Note:** Clipping should be always enabled when chart.zoomType is set
  82297. */
  82298. clip?: boolean;
  82299. /**
  82300. * (Highcharts, Highstock) The main color of the series. In line type series
  82301. * it applies to the line and the point markers unless otherwise specified.
  82302. * In bar type series it applies to the bars unless a color is specified per
  82303. * point. The default value is pulled from the `options.colors` array.
  82304. *
  82305. * In styled mode, the color can be defined by the colorIndex option. Also,
  82306. * the series color can be set with the `.highcharts-series`,
  82307. * `.highcharts-color-{n}`, `.highcharts-{type}-series` or
  82308. * `.highcharts-series-{n}` class, or individual classes given by the
  82309. * `className` option.
  82310. */
  82311. color?: (ColorString|GradientColorObject|PatternObject);
  82312. /**
  82313. * (Highcharts, Highstock, Highmaps) When using dual or multiple color axes,
  82314. * this number defines which colorAxis the particular series is connected
  82315. * to. It refers to either the axis id or the index of the axis in the
  82316. * colorAxis array, with 0 being the first. Set this option to false to
  82317. * prevent a series from connecting to the default color axis.
  82318. *
  82319. * Since v7.2.0 the option can also be an axis id or an axis index instead
  82320. * of a boolean flag.
  82321. */
  82322. colorAxis?: (boolean|number|string);
  82323. /**
  82324. * (Highcharts, Highstock) Styled mode only. A specific color index to use
  82325. * for the series, so its graphic representations are given the class name
  82326. * `highcharts-color-{n}`.
  82327. */
  82328. colorIndex?: number;
  82329. /**
  82330. * (Highcharts, Highstock, Highmaps) Determines what data value should be
  82331. * used to calculate point color if `colorAxis` is used. Requires to set
  82332. * `min` and `max` if some custom point property is used or if approximation
  82333. * for data grouping is set to `'sum'`.
  82334. */
  82335. colorKey?: string;
  82336. /**
  82337. * (Highstock) Compare the values of the series against the first non-null,
  82338. * non- zero value in the visible range. The y axis will show percentage or
  82339. * absolute change depending on whether `compare` is set to `"percent"` or
  82340. * `"value"`. When this is applied to multiple series, it allows comparing
  82341. * the development of the series against each other. Adds a `change` field
  82342. * to every point object.
  82343. */
  82344. compare?: string;
  82345. /**
  82346. * (Highstock) When compare is `percent`, this option dictates whether to
  82347. * use 0 or 100 as the base of comparison.
  82348. */
  82349. compareBase?: (0|100);
  82350. /**
  82351. * (Highstock) Defines if comparison should start from the first point
  82352. * within the visible range or should start from the first point **before**
  82353. * the range.
  82354. *
  82355. * In other words, this flag determines if first point within the visible
  82356. * range will have 0% (`compareStart=true`) or should have been already
  82357. * calculated according to the previous point (`compareStart=false`).
  82358. */
  82359. compareStart?: boolean;
  82360. /**
  82361. * (Highcharts) Polar charts only. Whether to connect the ends of a line
  82362. * series plot across the extremes.
  82363. */
  82364. connectEnds?: boolean;
  82365. /**
  82366. * (Highcharts, Highstock) Whether to connect a graph line across null
  82367. * points, or render a gap between the two points on either side of the
  82368. * null.
  82369. */
  82370. connectNulls?: boolean;
  82371. /**
  82372. * (Gantt) Override Pathfinder connector options for a series. Requires
  82373. * Highcharts Gantt to be loaded.
  82374. */
  82375. connectors?: SeriesConnectorsOptionsObject;
  82376. /**
  82377. * (Highcharts, Highstock, Gantt) When true, each point or column edge is
  82378. * rounded to its nearest pixel in order to render sharp on screen. In some
  82379. * cases, when there are a lot of densely packed columns, this leads to
  82380. * visible difference in column widths or distance between columns. In these
  82381. * cases, setting `crisp` to `false` may look better, even though each
  82382. * column is rendered blurry.
  82383. */
  82384. crisp?: boolean;
  82385. /**
  82386. * (Highcharts, Highstock) When the series contains less points than the
  82387. * crop threshold, all points are drawn, even if the points fall outside the
  82388. * visible plot area at the current zoom. The advantage of drawing all
  82389. * points (including markers and columns), is that animation is performed on
  82390. * updates. On the other hand, when the series contains more points than the
  82391. * crop threshold, the series data is cropped to only contain points that
  82392. * fall within the plot area. The advantage of cropping away invisible
  82393. * points is to increase performance on large series.
  82394. */
  82395. cropThreshold?: number;
  82396. /**
  82397. * (Highcharts, Highstock) You can set the cursor to "pointer" if you have
  82398. * click events attached to the series, to signal to the user that the
  82399. * points and lines can be clicked.
  82400. *
  82401. * In styled mode, the series cursor can be set with the same classes as
  82402. * listed under series.color.
  82403. */
  82404. cursor?: (string|CursorValue);
  82405. /**
  82406. * (Highcharts, Highstock) A reserved subspace to store options and values
  82407. * for customized functionality. Here you can add additional data for your
  82408. * own event callbacks and formatter callbacks.
  82409. */
  82410. custom?: Dictionary<any>;
  82411. /**
  82412. * (Highcharts, Highstock) Name of the dash style to use for the graph, or
  82413. * for some series types the outline of each shape.
  82414. *
  82415. * In styled mode, the stroke dash-array can be set with the same classes as
  82416. * listed under series.color.
  82417. */
  82418. dashStyle?: DashStyleValue;
  82419. /**
  82420. * (Highstock) Data grouping is the concept of sampling the data values into
  82421. * larger blocks in order to ease readability and increase performance of
  82422. * the JavaScript charts. Highstock by default applies data grouping when
  82423. * the points become closer than a certain pixel value, determined by the
  82424. * `groupPixelWidth` option.
  82425. *
  82426. * If data grouping is applied, the grouping information of grouped points
  82427. * can be read from the Point.dataGroup. If point options other than the
  82428. * data itself are set, for example `name` or `color` or custom properties,
  82429. * the grouping logic doesn't know how to group it. In this case the options
  82430. * of the first point instance are copied over to the group point. This can
  82431. * be altered through a custom `approximation` callback function.
  82432. */
  82433. dataGrouping?: DataGroupingOptionsObject;
  82434. /**
  82435. * (Highcharts, Highstock, Highmaps, Gantt) Options for the series data
  82436. * labels, appearing next to each data point.
  82437. *
  82438. * Since v6.2.0, multiple data labels can be applied to each single point by
  82439. * defining them as an array of configs.
  82440. *
  82441. * In styled mode, the data labels can be styled with the
  82442. * `.highcharts-data-label-box` and `.highcharts-data-label` class names
  82443. * (see example).
  82444. */
  82445. dataLabels?: (PlotSplineDataLabelsOptions|Array<PlotSplineDataLabelsOptions>);
  82446. /**
  82447. * (Highcharts, Highstock) Options for the series data sorting.
  82448. */
  82449. dataSorting?: (DataSortingOptionsObject|PlotSplineDataSortingOptions);
  82450. /**
  82451. * (Highcharts, Highstock) A description of the series to add to the screen
  82452. * reader information about the series.
  82453. */
  82454. description?: string;
  82455. /**
  82456. * (Highcharts, Highstock) The draggable-points module allows points to be
  82457. * moved around or modified in the chart. In addition to the options
  82458. * mentioned under the `dragDrop` API structure, the module fires three
  82459. * events, point.dragStart, point.drag and point.drop.
  82460. */
  82461. dragDrop?: SeriesDragDropOptionsObject;
  82462. /**
  82463. * (Highcharts, Highstock) Enable or disable the mouse tracking for a
  82464. * specific series. This includes point tooltips and click events on graphs
  82465. * and points. For large datasets it improves performance.
  82466. */
  82467. enableMouseTracking?: boolean;
  82468. /**
  82469. * (Highcharts, Highstock) General event handlers for the series items.
  82470. * These event hooks can also be attached to the series at run time using
  82471. * the `Highcharts.addEvent` function.
  82472. */
  82473. events?: SeriesEventsOptionsObject;
  82474. /**
  82475. * (Highcharts, Highstock) Determines whether the series should look for the
  82476. * nearest point in both dimensions or just the x-dimension when hovering
  82477. * the series. Defaults to `'xy'` for scatter series and `'x'` for most
  82478. * other series. If the data has duplicate x-values, it is recommended to
  82479. * set this to `'xy'` to allow hovering over all points.
  82480. *
  82481. * Applies only to series types using nearest neighbor search (not direct
  82482. * hover) for tooltip.
  82483. */
  82484. findNearestPointBy?: OptionsFindNearestPointByValue;
  82485. /**
  82486. * (Highstock) Defines when to display a gap in the graph, together with the
  82487. * gapUnit option.
  82488. *
  82489. * In case when `dataGrouping` is enabled, points can be grouped into a
  82490. * larger time span. This can make the grouped points to have a greater
  82491. * distance than the absolute value of `gapSize` property, which will result
  82492. * in disappearing graph completely. To prevent this situation the mentioned
  82493. * distance between grouped points is used instead of previously defined
  82494. * `gapSize`.
  82495. *
  82496. * In practice, this option is most often used to visualize gaps in time
  82497. * series. In a stock chart, intraday data is available for daytime hours,
  82498. * while gaps will appear in nights and weekends.
  82499. */
  82500. gapSize?: number;
  82501. /**
  82502. * (Highstock) Together with gapSize, this option defines where to draw gaps
  82503. * in the graph.
  82504. *
  82505. * When the `gapUnit` is `"relative"` (default), a gap size of 5 means that
  82506. * if the distance between two points is greater than 5 times that of the
  82507. * two closest points, the graph will be broken.
  82508. *
  82509. * When the `gapUnit` is `"value"`, the gap is based on absolute axis
  82510. * values, which on a datetime axis is milliseconds. This also applies to
  82511. * the navigator series that inherits gap options from the base series.
  82512. */
  82513. gapUnit?: OptionsGapUnitValue;
  82514. /**
  82515. * (Highcharts, Highstock, Gantt) Whether to use the Y extremes of the total
  82516. * chart width or only the zoomed area when zooming in on parts of the X
  82517. * axis. By default, the Y axis adjusts to the min and max of the visible
  82518. * data. Cartesian series only.
  82519. */
  82520. getExtremesFromAll?: boolean;
  82521. /**
  82522. * (Highcharts, Highstock) When set to `false` will prevent the series data
  82523. * from being included in any form of data export.
  82524. *
  82525. * Since version 6.0.0 until 7.1.0 the option was existing undocumented as
  82526. * `includeInCSVExport`.
  82527. */
  82528. includeInDataExport?: boolean;
  82529. /**
  82530. * (Highmaps) What property to join the `mapData` to the value data. For
  82531. * example, if joinBy is "code", the mapData items with a specific code is
  82532. * merged into the data with the same code. For maps loaded from GeoJSON,
  82533. * the keys may be held in each point's `properties` object.
  82534. *
  82535. * The joinBy option can also be an array of two values, where the first
  82536. * points to a key in the `mapData`, and the second points to another key in
  82537. * the `data`.
  82538. *
  82539. * When joinBy is `null`, the map items are joined by their position in the
  82540. * array, which performs much better in maps with many data points. This is
  82541. * the recommended option if you are printing more than a thousand data
  82542. * points and have a backend that can preprocess the data into a parallel
  82543. * array of the mapData.
  82544. */
  82545. joinBy?: (string|Array<string>);
  82546. /**
  82547. * (Highcharts, Highstock) An array specifying which option maps to which
  82548. * key in the data point array. This makes it convenient to work with
  82549. * unstructured data arrays from different sources.
  82550. */
  82551. keys?: Array<string>;
  82552. /**
  82553. * (Highcharts, Highstock, Gantt) Series labels are placed as close to the
  82554. * series as possible in a natural way, seeking to avoid other series. The
  82555. * goal of this feature is to make the chart more easily readable, like if a
  82556. * human designer placed the labels in the optimal position.
  82557. *
  82558. * The series labels currently work with series types having a `graph` or an
  82559. * `area`.
  82560. */
  82561. label?: SeriesLabelOptionsObject;
  82562. /**
  82563. * (Highstock) The line marks the last price from all points.
  82564. */
  82565. lastPrice?: SeriesLastPriceOptionsObject;
  82566. /**
  82567. * (Highstock) The line marks the last price from visible range of points.
  82568. */
  82569. lastVisiblePrice?: SeriesLastVisiblePriceOptionsObject;
  82570. /**
  82571. * (Highcharts, Highstock) The line cap used for line ends and line joins on
  82572. * the graph.
  82573. */
  82574. linecap?: SeriesLinecapValue;
  82575. /**
  82576. * (Highcharts, Highstock) Pixel width of the graph line.
  82577. */
  82578. lineWidth?: number;
  82579. /**
  82580. * (Highcharts, Highstock, Gantt) The id of another series to link to.
  82581. * Additionally, the value can be ":previous" to link to the previous
  82582. * series. When two series are linked, only the first one appears in the
  82583. * legend. Toggling the visibility of this also toggles the linked series.
  82584. *
  82585. * If master series uses data sorting and linked series does not have its
  82586. * own sorting definition, the linked series will be sorted in the same
  82587. * order as the master one.
  82588. */
  82589. linkedTo?: string;
  82590. /**
  82591. * (Highcharts, Highstock) Options for the point markers of line-like
  82592. * series. Properties like `fillColor`, `lineColor` and `lineWidth` define
  82593. * the visual appearance of the markers. Other series types, like column
  82594. * series, don't have markers, but have visual options on the series level
  82595. * instead.
  82596. *
  82597. * In styled mode, the markers can be styled with the `.highcharts-point`,
  82598. * `.highcharts-point-hover` and `.highcharts-point-select` class names.
  82599. */
  82600. marker?: PointMarkerOptionsObject;
  82601. /**
  82602. * (Highstock) Options for the corresponding navigator series if
  82603. * `showInNavigator` is `true` for this series. Available options are the
  82604. * same as any series, documented at plotOptions and series.
  82605. *
  82606. * These options are merged with options in navigator.series, and will take
  82607. * precedence if the same option is defined both places.
  82608. */
  82609. navigatorOptions?: PlotSeriesOptions;
  82610. /**
  82611. * (Highcharts, Highstock) The color for the parts of the graph or points
  82612. * that are below the threshold. Note that `zones` takes precedence over the
  82613. * negative color. Using `negativeColor` is equivalent to applying a zone
  82614. * with value of 0.
  82615. */
  82616. negativeColor?: (ColorString|GradientColorObject|PatternObject);
  82617. /**
  82618. * (Highcharts, Highstock) Opacity of a series parts: line, fill (e.g. area)
  82619. * and dataLabels.
  82620. */
  82621. opacity?: number;
  82622. /**
  82623. * (Highcharts, Highstock) Properties for each single point.
  82624. */
  82625. point?: PlotSeriesPointOptions;
  82626. /**
  82627. * (Highcharts, Highstock) Same as accessibility.pointDescriptionFormatter,
  82628. * but for an individual series. Overrides the chart wide configuration.
  82629. */
  82630. pointDescriptionFormatter?: Function;
  82631. /**
  82632. * (Highcharts, Highstock, Gantt) If no x values are given for the points in
  82633. * a series, `pointInterval` defines the interval of the x values. For
  82634. * example, if a series contains one value every decade starting from year
  82635. * 0, set `pointInterval` to `10`. In true `datetime` axes, the
  82636. * `pointInterval` is set in milliseconds.
  82637. *
  82638. * It can be also be combined with `pointIntervalUnit` to draw irregular
  82639. * time intervals.
  82640. *
  82641. * Please note that this options applies to the _series data_, not the
  82642. * interval of the axis ticks, which is independent.
  82643. */
  82644. pointInterval?: number;
  82645. /**
  82646. * (Highcharts, Highstock, Gantt) On datetime series, this allows for
  82647. * setting the pointInterval to irregular time units, `day`, `month` and
  82648. * `year`. A day is usually the same as 24 hours, but `pointIntervalUnit`
  82649. * also takes the DST crossover into consideration when dealing with local
  82650. * time. Combine this option with `pointInterval` to draw weeks, quarters, 6
  82651. * months, 10 years etc.
  82652. *
  82653. * Please note that this options applies to the _series data_, not the
  82654. * interval of the axis ticks, which is independent.
  82655. */
  82656. pointIntervalUnit?: OptionsPointIntervalUnitValue;
  82657. /**
  82658. * (Highcharts, Highstock, Gantt) Possible values: `"on"`, `"between"`,
  82659. * `number`.
  82660. *
  82661. * In a column chart, when pointPlacement is `"on"`, the point will not
  82662. * create any padding of the X axis. In a polar column chart this means that
  82663. * the first column points directly north. If the pointPlacement is
  82664. * `"between"`, the columns will be laid out between ticks. This is useful
  82665. * for example for visualising an amount between two points in time or in a
  82666. * certain sector of a polar chart.
  82667. *
  82668. * Since Highcharts 3.0.2, the point placement can also be numeric, where 0
  82669. * is on the axis value, -0.5 is between this value and the previous, and
  82670. * 0.5 is between this value and the next. Unlike the textual options,
  82671. * numeric point placement options won't affect axis padding.
  82672. *
  82673. * Note that pointPlacement needs a pointRange to work. For column series
  82674. * this is computed, but for line-type series it needs to be set.
  82675. *
  82676. * For the `xrange` series type and gantt charts, if the Y axis is a
  82677. * category axis, the `pointPlacement` applies to the Y axis rather than the
  82678. * (typically datetime) X axis.
  82679. *
  82680. * Defaults to `undefined` in cartesian charts, `"between"` in polar charts.
  82681. */
  82682. pointPlacement?: (number|string);
  82683. /**
  82684. * (Highstock) The width of each point on the x axis. For example in a
  82685. * column chart with one value each day, the pointRange would be 1 day (= 24
  82686. * * 3600
  82687. *
  82688. * * 1000 milliseconds). This is normally computed automatically, but this
  82689. * option can be used to override the automatic value.
  82690. */
  82691. pointRange?: number;
  82692. /**
  82693. * (Highcharts, Highstock, Gantt) If no x values are given for the points in
  82694. * a series, pointStart defines on what value to start. For example, if a
  82695. * series contains one yearly value starting from 1945, set pointStart to
  82696. * 1945.
  82697. */
  82698. pointStart?: number;
  82699. /**
  82700. * (Highcharts, Highstock) Whether to select the series initially. If
  82701. * `showCheckbox` is true, the checkbox next to the series name in the
  82702. * legend will be checked for a selected series.
  82703. */
  82704. selected?: boolean;
  82705. /**
  82706. * (Highcharts, Highstock) Whether to apply a drop shadow to the graph line.
  82707. * Since 2.3 the shadow can be an object configuration containing `color`,
  82708. * `offsetX`, `offsetY`, `opacity` and `width`.
  82709. */
  82710. shadow?: (boolean|ShadowOptionsObject);
  82711. /**
  82712. * (Highcharts, Highstock) If true, a checkbox is displayed next to the
  82713. * legend item to allow selecting the series. The state of the checkbox is
  82714. * determined by the `selected` option.
  82715. */
  82716. showCheckbox?: boolean;
  82717. /**
  82718. * (Highcharts, Highstock) Whether to display this particular series or
  82719. * series type in the legend. Standalone series are shown in legend by
  82720. * default, and linked series are not. Since v7.2.0 it is possible to show
  82721. * series that use colorAxis by setting this option to `true`.
  82722. */
  82723. showInLegend?: boolean;
  82724. /**
  82725. * (Highstock) Whether or not to show the series in the navigator. Takes
  82726. * precedence over navigator.baseSeries if defined.
  82727. */
  82728. showInNavigator?: boolean;
  82729. /**
  82730. * (Highcharts, Highstock) If set to `true`, the accessibility module will
  82731. * skip past the points in this series for keyboard navigation.
  82732. */
  82733. skipKeyboardNavigation?: boolean;
  82734. /**
  82735. * (Highcharts, Highstock) When this is true, the series will not cause the
  82736. * Y axis to cross the zero plane (or threshold option) unless the data
  82737. * actually crosses the plane.
  82738. *
  82739. * For example, if `softThreshold` is `false`, a series of 0, 1, 2, 3 will
  82740. * make the Y axis show negative values according to the `minPadding`
  82741. * option. If `softThreshold` is `true`, the Y axis starts at 0.
  82742. */
  82743. softThreshold?: boolean;
  82744. /**
  82745. * (Highcharts, Highstock) Whether to stack the values of each series on top
  82746. * of each other. Possible values are `undefined` to disable, `"normal"` to
  82747. * stack by value or `"percent"`.
  82748. *
  82749. * When stacking is enabled, data must be sorted in ascending X order.
  82750. *
  82751. * Some stacking options are related to specific series types. In the
  82752. * streamgraph series type, the stacking option is set to `"stream"`. The
  82753. * second one is `"overlap"`, which only applies to waterfall series.
  82754. */
  82755. stacking?: OptionsStackingValue;
  82756. states?: SeriesStatesOptionsObject;
  82757. /**
  82758. * (Highcharts, Highstock) Sticky tracking of mouse events. When true, the
  82759. * `mouseOut` event on a series isn't triggered until the mouse moves over
  82760. * another series, or out of the plot area. When false, the `mouseOut` event
  82761. * on a series is triggered when the mouse leaves the area around the
  82762. * series' graph or markers. This also implies the tooltip when not shared.
  82763. * When `stickyTracking` is false and `tooltip.shared` is false, the tooltip
  82764. * will be hidden when moving the mouse between series. Defaults to true for
  82765. * line and area type series, but to false for columns, pies etc.
  82766. *
  82767. * **Note:** The boost module will force this option because of technical
  82768. * limitations.
  82769. */
  82770. stickyTracking?: boolean;
  82771. /**
  82772. * (Highcharts, Highstock) The threshold, also called zero level or base
  82773. * level. For line type series this is only used in conjunction with
  82774. * negativeColor.
  82775. */
  82776. threshold?: (number|null);
  82777. /**
  82778. * (Highcharts, Highstock) A configuration object for the tooltip rendering
  82779. * of each single series. Properties are inherited from tooltip, but only
  82780. * the following properties can be defined on a series level.
  82781. */
  82782. tooltip?: SeriesTooltipOptionsObject;
  82783. /**
  82784. * (Highcharts, Highstock, Gantt) When a series contains a data array that
  82785. * is longer than this, only one dimensional arrays of numbers, or two
  82786. * dimensional arrays with x and y values are allowed. Also, only the first
  82787. * point is tested, and the rest are assumed to be the same format. This
  82788. * saves expensive data checking and indexing in long series. Set it to `0`
  82789. * disable.
  82790. *
  82791. * Note: In boost mode turbo threshold is forced. Only array of numbers or
  82792. * two dimensional arrays are allowed.
  82793. */
  82794. turboThreshold?: number;
  82795. /**
  82796. * (Highcharts, Highstock) Set the initial visibility of the series.
  82797. */
  82798. visible?: boolean;
  82799. /**
  82800. * (Highmaps) Define the z index of the series.
  82801. */
  82802. zIndex?: number;
  82803. /**
  82804. * (Highcharts, Highstock) Defines the Axis on which the zones are applied.
  82805. */
  82806. zoneAxis?: string;
  82807. /**
  82808. * (Highcharts, Highstock) An array defining zones within a series. Zones
  82809. * can be applied to the X axis, Y axis or Z axis for bubbles, according to
  82810. * the `zoneAxis` option. The zone definitions have to be in ascending order
  82811. * regarding to the value.
  82812. *
  82813. * In styled mode, the color zones are styled with the
  82814. * `.highcharts-zone-{n}` class, or custom classed from the `className`
  82815. * option (view live demo).
  82816. */
  82817. zones?: Array<SeriesZonesOptionsObject>;
  82818. }
  82819. /**
  82820. * (Highstock) Enable or disable the initial animation when a series is
  82821. * displayed. The animation can also be set as a configuration object. Please
  82822. * note that this option only applies to the initial animation of the series
  82823. * itself. For other animations, see chart.animation and the animation parameter
  82824. * under the API methods. The following properties are supported:
  82825. *
  82826. * - `defer`: The animation delay time in milliseconds.
  82827. *
  82828. * - `duration`: The duration of the animation in milliseconds.
  82829. *
  82830. * - `easing`: Can be a string reference to an easing function set on the `Math`
  82831. * object or a function. See the _Custom easing function_ demo below.
  82832. *
  82833. * Due to poor performance, animation is disabled in old IE browsers for several
  82834. * chart types.
  82835. */
  82836. export interface PlotStochasticAnimationOptions {
  82837. defer?: number;
  82838. }
  82839. /**
  82840. * (Highcharts, Highstock, Highmaps, Gantt) Enable or disable the initial
  82841. * animation when a series is displayed for the `dataLabels`. The animation can
  82842. * also be set as a configuration object. Please note that this option only
  82843. * applies to the initial animation. For other animations, see chart.animation
  82844. * and the animation parameter under the API methods. The following properties
  82845. * are supported:
  82846. *
  82847. * - `defer`: The animation delay time in milliseconds.
  82848. */
  82849. export interface PlotStochasticDataLabelsAnimationOptions {
  82850. /**
  82851. * (Highcharts, Highstock, Highmaps, Gantt) The animation delay time in
  82852. * milliseconds. Set to `0` renders dataLabel immediately. As `undefined`
  82853. * inherits defer time from the series.animation.defer.
  82854. */
  82855. defer?: number;
  82856. }
  82857. /**
  82858. * (Highcharts, Highstock, Highmaps, Gantt) Options for the series data labels,
  82859. * appearing next to each data point.
  82860. *
  82861. * Since v6.2.0, multiple data labels can be applied to each single point by
  82862. * defining them as an array of configs.
  82863. *
  82864. * In styled mode, the data labels can be styled with the
  82865. * `.highcharts-data-label-box` and `.highcharts-data-label` class names (see
  82866. * example).
  82867. */
  82868. export interface PlotStochasticDataLabelsOptions {
  82869. /**
  82870. * (Highcharts, Highstock, Highmaps, Gantt) The alignment of the data label
  82871. * compared to the point. If `right`, the right side of the label should be
  82872. * touching the point. For points with an extent, like columns, the
  82873. * alignments also dictates how to align it inside the box, as given with
  82874. * the inside option. Can be one of `left`, `center` or `right`.
  82875. */
  82876. align?: (AlignValue|null);
  82877. /**
  82878. * (Highcharts, Highstock, Highmaps, Gantt) Whether to allow data labels to
  82879. * overlap. To make the labels less sensitive for overlapping, the
  82880. * dataLabels.padding can be set to 0.
  82881. */
  82882. allowOverlap?: boolean;
  82883. /**
  82884. * (Highcharts, Highstock, Highmaps, Gantt) Enable or disable the initial
  82885. * animation when a series is displayed for the `dataLabels`. The animation
  82886. * can also be set as a configuration object. Please note that this option
  82887. * only applies to the initial animation. For other animations, see
  82888. * chart.animation and the animation parameter under the API methods. The
  82889. * following properties are supported:
  82890. *
  82891. * - `defer`: The animation delay time in milliseconds.
  82892. */
  82893. animation?: (boolean|PlotStochasticDataLabelsAnimationOptions|Partial<AnimationOptionsObject>);
  82894. /**
  82895. * (Highcharts, Highstock, Highmaps, Gantt) The background color or gradient
  82896. * for the data label.
  82897. */
  82898. backgroundColor?: (ColorString|GradientColorObject|PatternObject);
  82899. /**
  82900. * (Highcharts, Highstock, Highmaps, Gantt) The border color for the data
  82901. * label. Defaults to `undefined`.
  82902. */
  82903. borderColor?: (ColorString|GradientColorObject|PatternObject);
  82904. /**
  82905. * (Highcharts, Highstock, Highmaps, Gantt) The border radius in pixels for
  82906. * the data label.
  82907. */
  82908. borderRadius?: number;
  82909. /**
  82910. * (Highcharts, Highstock, Highmaps, Gantt) The border width in pixels for
  82911. * the data label.
  82912. */
  82913. borderWidth?: number;
  82914. /**
  82915. * (Highcharts, Highstock, Highmaps, Gantt) A class name for the data label.
  82916. * Particularly in styled mode, this can be used to give each series' or
  82917. * point's data label unique styling. In addition to this option, a default
  82918. * color class name is added so that we can give the labels a contrast text
  82919. * shadow.
  82920. */
  82921. className?: string;
  82922. /**
  82923. * (Highcharts, Highstock, Highmaps, Gantt) The text color for the data
  82924. * labels. Defaults to `undefined`. For certain series types, like column or
  82925. * map, the data labels can be drawn inside the points. In this case the
  82926. * data label will be drawn with maximum contrast by default. Additionally,
  82927. * it will be given a `text-outline` style with the opposite color, to
  82928. * further increase the contrast. This can be overridden by setting the
  82929. * `text-outline` style to `none` in the `dataLabels.style` option.
  82930. */
  82931. color?: (ColorString|GradientColorObject|PatternObject);
  82932. /**
  82933. * (Highcharts, Highstock, Highmaps, Gantt) Whether to hide data labels that
  82934. * are outside the plot area. By default, the data label is moved inside the
  82935. * plot area according to the overflow option.
  82936. */
  82937. crop?: boolean;
  82938. /**
  82939. * (Highcharts, Highstock, Gantt) Whether to defer displaying the data
  82940. * labels until the initial series animation has finished. Setting to
  82941. * `false` renders the data label immediately. If set to `true` inherits the
  82942. * defer time set in plotOptions.series.animation.
  82943. */
  82944. defer?: boolean;
  82945. /**
  82946. * (Highcharts, Highstock, Highmaps, Gantt) Enable or disable the data
  82947. * labels.
  82948. */
  82949. enabled?: boolean;
  82950. /**
  82951. * (Highcharts, Highstock, Highmaps, Gantt) A declarative filter to control
  82952. * of which data labels to display. The declarative filter is designed for
  82953. * use when callback functions are not available, like when the chart
  82954. * options require a pure JSON structure or for use with graphical editors.
  82955. * For programmatic control, use the `formatter` instead, and return
  82956. * `undefined` to disable a single data label.
  82957. */
  82958. filter?: DataLabelsFilterOptionsObject;
  82959. /**
  82960. * (Highcharts, Highstock, Highmaps, Gantt) A format string for the data
  82961. * label. Available variables are the same as for `formatter`.
  82962. */
  82963. format?: string;
  82964. /**
  82965. * (Highcharts, Highstock, Highmaps, Gantt) Callback JavaScript function to
  82966. * format the data label. Note that if a `format` is defined, the format
  82967. * takes precedence and the formatter is ignored.
  82968. */
  82969. formatter?: DataLabelsFormatterCallbackFunction;
  82970. /**
  82971. * (Highcharts, Highstock, Highmaps, Gantt) For points with an extent, like
  82972. * columns or map areas, whether to align the data label inside the box or
  82973. * to the actual value point. Defaults to `false` in most cases, `true` in
  82974. * stacked columns.
  82975. */
  82976. inside?: boolean;
  82977. /**
  82978. * (Highcharts, Highstock, Highmaps, Gantt) Format for points with the value
  82979. * of null. Works analogously to format. `nullFormat` can be applied only to
  82980. * series which support displaying null points.
  82981. */
  82982. nullFormat?: (boolean|string);
  82983. /**
  82984. * (Highcharts, Highstock, Highmaps, Gantt) Callback JavaScript function
  82985. * that defines formatting for points with the value of null. Works
  82986. * analogously to formatter. `nullPointFormatter` can be applied only to
  82987. * series which support displaying null points.
  82988. */
  82989. nullFormatter?: DataLabelsFormatterCallbackFunction;
  82990. /**
  82991. * (Highcharts, Highstock, Highmaps, Gantt) How to handle data labels that
  82992. * flow outside the plot area. The default is `"justify"`, which aligns them
  82993. * inside the plot area. For columns and bars, this means it will be moved
  82994. * inside the bar. To display data labels outside the plot area, set `crop`
  82995. * to `false` and `overflow` to `"allow"`.
  82996. */
  82997. overflow?: DataLabelsOverflowValue;
  82998. /**
  82999. * (Highcharts, Highstock, Highmaps, Gantt) When either the `borderWidth` or
  83000. * the `backgroundColor` is set, this is the padding within the box.
  83001. */
  83002. padding?: number;
  83003. /**
  83004. * (Highcharts, Highstock, Highmaps, Gantt) Aligns data labels relative to
  83005. * points. If `center` alignment is not possible, it defaults to `right`.
  83006. */
  83007. position?: AlignValue;
  83008. /**
  83009. * (Highcharts, Highstock, Highmaps, Gantt) Text rotation in degrees. Note
  83010. * that due to a more complex structure, backgrounds, borders and padding
  83011. * will be lost on a rotated data label.
  83012. */
  83013. rotation?: number;
  83014. /**
  83015. * (Highcharts, Highstock, Highmaps, Gantt) The shadow of the box. Works
  83016. * best with `borderWidth` or `backgroundColor`. Since 2.3 the shadow can be
  83017. * an object configuration containing `color`, `offsetX`, `offsetY`,
  83018. * `opacity` and `width`.
  83019. */
  83020. shadow?: (boolean|ShadowOptionsObject);
  83021. /**
  83022. * (Highcharts, Highstock, Highmaps, Gantt) The name of a symbol to use for
  83023. * the border around the label. Symbols are predefined functions on the
  83024. * Renderer object.
  83025. */
  83026. shape?: string;
  83027. /**
  83028. * (Highcharts, Highstock, Highmaps, Gantt) Styles for the label. The
  83029. * default `color` setting is `"contrast"`, which is a pseudo color that
  83030. * Highcharts picks up and applies the maximum contrast to the underlying
  83031. * point item, for example the bar in a bar chart.
  83032. *
  83033. * The `textOutline` is a pseudo property that applies an outline of the
  83034. * given width with the given color, which by default is the maximum
  83035. * contrast to the text. So a bright text color will result in a black text
  83036. * outline for maximum readability on a mixed background. In some cases,
  83037. * especially with grayscale text, the text outline doesn't work well, in
  83038. * which cases it can be disabled by setting it to `"none"`. When `useHTML`
  83039. * is true, the `textOutline` will not be picked up. In this, case, the same
  83040. * effect can be acheived through the `text-shadow` CSS property.
  83041. *
  83042. * For some series types, where each point has an extent, like for example
  83043. * tree maps, the data label may overflow the point. There are two
  83044. * strategies for handling overflow. By default, the text will wrap to
  83045. * multiple lines. The other strategy is to set `style.textOverflow` to
  83046. * `ellipsis`, which will keep the text on one line plus it will break
  83047. * inside long words.
  83048. */
  83049. style?: CSSObject;
  83050. /**
  83051. * (Highcharts, Highstock, Highmaps, Gantt) Options for a label text which
  83052. * should follow marker's shape. Border and background are disabled for a
  83053. * label that follows a path.
  83054. *
  83055. * **Note:** Only SVG-based renderer supports this option. Setting `useHTML`
  83056. * to true will disable this option.
  83057. */
  83058. textPath?: DataLabelsTextPathOptionsObject;
  83059. /**
  83060. * (Highcharts, Highstock, Highmaps, Gantt) Whether to use HTML to render
  83061. * the labels.
  83062. */
  83063. useHTML?: boolean;
  83064. /**
  83065. * (Highcharts, Highstock, Highmaps, Gantt) The vertical alignment of a data
  83066. * label. Can be one of `top`, `middle` or `bottom`. The default value
  83067. * depends on the data, for instance in a column chart, the label is above
  83068. * positive values and below negative values.
  83069. */
  83070. verticalAlign?: (VerticalAlignValue|null);
  83071. /**
  83072. * (Highcharts, Highstock, Highmaps, Gantt) The x position offset of the
  83073. * label relative to the point in pixels.
  83074. */
  83075. x?: number;
  83076. /**
  83077. * (Highcharts, Highstock, Highmaps, Gantt) The y position offset of the
  83078. * label relative to the point in pixels.
  83079. */
  83080. y?: number;
  83081. /**
  83082. * (Highcharts, Highstock, Highmaps, Gantt) The Z index of the data labels.
  83083. * The default Z index puts it above the series. Use a Z index of 2 to
  83084. * display it behind the series.
  83085. */
  83086. z?: number;
  83087. }
  83088. /**
  83089. * (Highcharts, Highstock) Options for the series data sorting.
  83090. */
  83091. export interface PlotStochasticDataSortingOptions {
  83092. /**
  83093. * (Highcharts, Highstock) Enable or disable data sorting for the series.
  83094. * Use xAxis.reversed to change the sorting order.
  83095. */
  83096. enabled?: boolean;
  83097. /**
  83098. * (Highcharts, Highstock) Whether to allow matching points by name in an
  83099. * update. If this option is disabled, points will be matched by order.
  83100. */
  83101. matchByName?: boolean;
  83102. /**
  83103. * (Highcharts, Highstock) Determines what data value should be used to sort
  83104. * by.
  83105. */
  83106. sortKey?: string;
  83107. }
  83108. /**
  83109. * (Highstock) Stochastic oscillator. This series requires the `linkedTo` option
  83110. * to be set and should be loaded after the `stock/indicators/indicators.js`
  83111. * file.
  83112. *
  83113. * In TypeScript the type option must always be set.
  83114. *
  83115. * Configuration options for the series are given in three levels:
  83116. *
  83117. * 1. Options for all series in a chart are defined in the plotOptions.series
  83118. * object.
  83119. *
  83120. * 2. Options for all `stochastic` series are defined in plotOptions.stochastic.
  83121. *
  83122. * 3. Options for one single series are given in the series instance array. (see
  83123. * online documentation for example)
  83124. */
  83125. export interface PlotStochasticOptions {
  83126. /**
  83127. * (Highstock) Accessibility options for a series.
  83128. */
  83129. accessibility?: SeriesAccessibilityOptionsObject;
  83130. /**
  83131. * (Highstock) Allow this series' points to be selected by clicking on the
  83132. * graphic (columns, point markers, pie slices, map areas etc).
  83133. *
  83134. * The selected points can be handled by point select and unselect events,
  83135. * or collectively by the getSelectedPoints function.
  83136. *
  83137. * And alternative way of selecting points is through dragging.
  83138. */
  83139. allowPointSelect?: boolean;
  83140. /**
  83141. * (Highstock) Enable or disable the initial animation when a series is
  83142. * displayed. The animation can also be set as a configuration object.
  83143. * Please note that this option only applies to the initial animation of the
  83144. * series itself. For other animations, see chart.animation and the
  83145. * animation parameter under the API methods. The following properties are
  83146. * supported:
  83147. *
  83148. * - `defer`: The animation delay time in milliseconds.
  83149. *
  83150. * - `duration`: The duration of the animation in milliseconds.
  83151. *
  83152. * - `easing`: Can be a string reference to an easing function set on the
  83153. * `Math` object or a function. See the _Custom easing function_ demo below.
  83154. *
  83155. * Due to poor performance, animation is disabled in old IE browsers for
  83156. * several chart types.
  83157. */
  83158. animation?: (boolean|PlotStochasticAnimationOptions|Partial<AnimationOptionsObject>);
  83159. /**
  83160. * (Highstock) For some series, there is a limit that shuts down initial
  83161. * animation by default when the total number of points in the chart is too
  83162. * high. For example, for a column chart and its derivatives, animation does
  83163. * not run if there is more than 250 points totally. To disable this cap,
  83164. * set `animationLimit` to `Infinity`.
  83165. */
  83166. animationLimit?: number;
  83167. /**
  83168. * (Highstock) Sets the color blending in the boost module.
  83169. */
  83170. boostBlending?: OptionsBoostBlendingValue;
  83171. /**
  83172. * (Highstock) Set the point threshold for when a series should enter boost
  83173. * mode.
  83174. *
  83175. * Setting it to e.g. 2000 will cause the series to enter boost mode when
  83176. * there are 2000 or more points in the series.
  83177. *
  83178. * To disable boosting on the series, set the `boostThreshold` to 0. Setting
  83179. * it to 1 will force boosting.
  83180. *
  83181. * Note that the cropThreshold also affects this setting. When zooming in on
  83182. * a series that has fewer points than the `cropThreshold`, all points are
  83183. * rendered although outside the visible plot area, and the `boostThreshold`
  83184. * won't take effect.
  83185. */
  83186. boostThreshold?: number;
  83187. /**
  83188. * (Highmaps) The border color of the map areas.
  83189. *
  83190. * In styled mode, the border stroke is given in the `.highcharts-point`
  83191. * class.
  83192. */
  83193. borderColor?: (ColorString|GradientColorObject|PatternObject);
  83194. /**
  83195. * (Highmaps) The border width of each map area.
  83196. *
  83197. * In styled mode, the border stroke width is given in the
  83198. * `.highcharts-point` class.
  83199. */
  83200. borderWidth?: number;
  83201. /**
  83202. * (Highstock) An additional class name to apply to the series' graphical
  83203. * elements. This option does not replace default class names of the
  83204. * graphical element.
  83205. */
  83206. className?: string;
  83207. /**
  83208. * (Highstock) Disable this option to allow series rendering in the whole
  83209. * plotting area.
  83210. *
  83211. * **Note:** Clipping should be always enabled when chart.zoomType is set
  83212. */
  83213. clip?: boolean;
  83214. /**
  83215. * (Highstock) The main color of the series. In line type series it applies
  83216. * to the line and the point markers unless otherwise specified. In bar type
  83217. * series it applies to the bars unless a color is specified per point. The
  83218. * default value is pulled from the `options.colors` array.
  83219. *
  83220. * In styled mode, the color can be defined by the colorIndex option. Also,
  83221. * the series color can be set with the `.highcharts-series`,
  83222. * `.highcharts-color-{n}`, `.highcharts-{type}-series` or
  83223. * `.highcharts-series-{n}` class, or individual classes given by the
  83224. * `className` option.
  83225. */
  83226. color?: (ColorString|GradientColorObject|PatternObject);
  83227. /**
  83228. * (Highstock) Styled mode only. A specific color index to use for the
  83229. * series, so its graphic representations are given the class name
  83230. * `highcharts-color-{n}`.
  83231. */
  83232. colorIndex?: number;
  83233. /**
  83234. * (Highcharts, Highstock, Highmaps) Determines what data value should be
  83235. * used to calculate point color if `colorAxis` is used. Requires to set
  83236. * `min` and `max` if some custom point property is used or if approximation
  83237. * for data grouping is set to `'sum'`.
  83238. */
  83239. colorKey?: string;
  83240. /**
  83241. * (Highstock) Compare the values of the series against the first non-null,
  83242. * non- zero value in the visible range. The y axis will show percentage or
  83243. * absolute change depending on whether `compare` is set to `"percent"` or
  83244. * `"value"`. When this is applied to multiple series, it allows comparing
  83245. * the development of the series against each other. Adds a `change` field
  83246. * to every point object.
  83247. */
  83248. compare?: string;
  83249. /**
  83250. * (Highstock) When compare is `percent`, this option dictates whether to
  83251. * use 0 or 100 as the base of comparison.
  83252. */
  83253. compareBase?: (0|100);
  83254. /**
  83255. * (Highstock) Defines if comparison should start from the first point
  83256. * within the visible range or should start from the first point **before**
  83257. * the range.
  83258. *
  83259. * In other words, this flag determines if first point within the visible
  83260. * range will have 0% (`compareStart=true`) or should have been already
  83261. * calculated according to the previous point (`compareStart=false`).
  83262. */
  83263. compareStart?: boolean;
  83264. /**
  83265. * (Highstock) Whether to compare indicator to the main series values or
  83266. * indicator values.
  83267. */
  83268. compareToMain?: boolean;
  83269. /**
  83270. * (Highcharts) Polar charts only. Whether to connect the ends of a line
  83271. * series plot across the extremes.
  83272. */
  83273. connectEnds?: boolean;
  83274. /**
  83275. * (Highcharts, Highstock) Whether to connect a graph line across null
  83276. * points, or render a gap between the two points on either side of the
  83277. * null.
  83278. */
  83279. connectNulls?: boolean;
  83280. /**
  83281. * (Gantt) Override Pathfinder connector options for a series. Requires
  83282. * Highcharts Gantt to be loaded.
  83283. */
  83284. connectors?: SeriesConnectorsOptionsObject;
  83285. /**
  83286. * (Highcharts, Highstock, Gantt) When true, each point or column edge is
  83287. * rounded to its nearest pixel in order to render sharp on screen. In some
  83288. * cases, when there are a lot of densely packed columns, this leads to
  83289. * visible difference in column widths or distance between columns. In these
  83290. * cases, setting `crisp` to `false` may look better, even though each
  83291. * column is rendered blurry.
  83292. */
  83293. crisp?: boolean;
  83294. /**
  83295. * (Highcharts, Highstock) When the series contains less points than the
  83296. * crop threshold, all points are drawn, even if the points fall outside the
  83297. * visible plot area at the current zoom. The advantage of drawing all
  83298. * points (including markers and columns), is that animation is performed on
  83299. * updates. On the other hand, when the series contains more points than the
  83300. * crop threshold, the series data is cropped to only contain points that
  83301. * fall within the plot area. The advantage of cropping away invisible
  83302. * points is to increase performance on large series.
  83303. */
  83304. cropThreshold?: number;
  83305. /**
  83306. * (Highstock) You can set the cursor to "pointer" if you have click events
  83307. * attached to the series, to signal to the user that the points and lines
  83308. * can be clicked.
  83309. *
  83310. * In styled mode, the series cursor can be set with the same classes as
  83311. * listed under series.color.
  83312. */
  83313. cursor?: (string|CursorValue);
  83314. /**
  83315. * (Highstock) A reserved subspace to store options and values for
  83316. * customized functionality. Here you can add additional data for your own
  83317. * event callbacks and formatter callbacks.
  83318. */
  83319. custom?: Dictionary<any>;
  83320. /**
  83321. * (Highstock) Name of the dash style to use for the graph, or for some
  83322. * series types the outline of each shape.
  83323. *
  83324. * In styled mode, the stroke dash-array can be set with the same classes as
  83325. * listed under series.color.
  83326. */
  83327. dashStyle?: DashStyleValue;
  83328. /**
  83329. * (Highstock) Data grouping is the concept of sampling the data values into
  83330. * larger blocks in order to ease readability and increase performance of
  83331. * the JavaScript charts. Highstock by default applies data grouping when
  83332. * the points become closer than a certain pixel value, determined by the
  83333. * `groupPixelWidth` option.
  83334. *
  83335. * If data grouping is applied, the grouping information of grouped points
  83336. * can be read from the Point.dataGroup. If point options other than the
  83337. * data itself are set, for example `name` or `color` or custom properties,
  83338. * the grouping logic doesn't know how to group it. In this case the options
  83339. * of the first point instance are copied over to the group point. This can
  83340. * be altered through a custom `approximation` callback function.
  83341. */
  83342. dataGrouping?: DataGroupingOptionsObject;
  83343. /**
  83344. * (Highcharts, Highstock, Highmaps, Gantt) Options for the series data
  83345. * labels, appearing next to each data point.
  83346. *
  83347. * Since v6.2.0, multiple data labels can be applied to each single point by
  83348. * defining them as an array of configs.
  83349. *
  83350. * In styled mode, the data labels can be styled with the
  83351. * `.highcharts-data-label-box` and `.highcharts-data-label` class names
  83352. * (see example).
  83353. */
  83354. dataLabels?: (PlotStochasticDataLabelsOptions|Array<PlotStochasticDataLabelsOptions>);
  83355. /**
  83356. * (Highcharts, Highstock) Options for the series data sorting.
  83357. */
  83358. dataSorting?: (DataSortingOptionsObject|PlotStochasticDataSortingOptions);
  83359. /**
  83360. * (Highstock) A description of the series to add to the screen reader
  83361. * information about the series.
  83362. */
  83363. description?: string;
  83364. /**
  83365. * (Highstock) Enable or disable the mouse tracking for a specific series.
  83366. * This includes point tooltips and click events on graphs and points. For
  83367. * large datasets it improves performance.
  83368. */
  83369. enableMouseTracking?: boolean;
  83370. /**
  83371. * (Highstock) General event handlers for the series items. These event
  83372. * hooks can also be attached to the series at run time using the
  83373. * `Highcharts.addEvent` function.
  83374. */
  83375. events?: SeriesEventsOptionsObject;
  83376. /**
  83377. * (Highstock) Determines whether the series should look for the nearest
  83378. * point in both dimensions or just the x-dimension when hovering the
  83379. * series. Defaults to `'xy'` for scatter series and `'x'` for most other
  83380. * series. If the data has duplicate x-values, it is recommended to set this
  83381. * to `'xy'` to allow hovering over all points.
  83382. *
  83383. * Applies only to series types using nearest neighbor search (not direct
  83384. * hover) for tooltip.
  83385. */
  83386. findNearestPointBy?: OptionsFindNearestPointByValue;
  83387. /**
  83388. * (Highstock) Defines when to display a gap in the graph, together with the
  83389. * gapUnit option.
  83390. *
  83391. * In case when `dataGrouping` is enabled, points can be grouped into a
  83392. * larger time span. This can make the grouped points to have a greater
  83393. * distance than the absolute value of `gapSize` property, which will result
  83394. * in disappearing graph completely. To prevent this situation the mentioned
  83395. * distance between grouped points is used instead of previously defined
  83396. * `gapSize`.
  83397. *
  83398. * In practice, this option is most often used to visualize gaps in time
  83399. * series. In a stock chart, intraday data is available for daytime hours,
  83400. * while gaps will appear in nights and weekends.
  83401. */
  83402. gapSize?: number;
  83403. /**
  83404. * (Highstock) Together with gapSize, this option defines where to draw gaps
  83405. * in the graph.
  83406. *
  83407. * When the `gapUnit` is `"relative"` (default), a gap size of 5 means that
  83408. * if the distance between two points is greater than 5 times that of the
  83409. * two closest points, the graph will be broken.
  83410. *
  83411. * When the `gapUnit` is `"value"`, the gap is based on absolute axis
  83412. * values, which on a datetime axis is milliseconds. This also applies to
  83413. * the navigator series that inherits gap options from the base series.
  83414. */
  83415. gapUnit?: OptionsGapUnitValue;
  83416. /**
  83417. * (Highcharts, Highstock, Gantt) Whether to use the Y extremes of the total
  83418. * chart width or only the zoomed area when zooming in on parts of the X
  83419. * axis. By default, the Y axis adjusts to the min and max of the visible
  83420. * data. Cartesian series only.
  83421. */
  83422. getExtremesFromAll?: boolean;
  83423. /**
  83424. * (Highstock) When set to `false` will prevent the series data from being
  83425. * included in any form of data export.
  83426. *
  83427. * Since version 6.0.0 until 7.1.0 the option was existing undocumented as
  83428. * `includeInCSVExport`.
  83429. */
  83430. includeInDataExport?: boolean;
  83431. /**
  83432. * (Highcharts, Highstock, Gantt) Series labels are placed as close to the
  83433. * series as possible in a natural way, seeking to avoid other series. The
  83434. * goal of this feature is to make the chart more easily readable, like if a
  83435. * human designer placed the labels in the optimal position.
  83436. *
  83437. * The series labels currently work with series types having a `graph` or an
  83438. * `area`.
  83439. */
  83440. label?: SeriesLabelOptionsObject;
  83441. /**
  83442. * (Highstock) The line marks the last price from all points.
  83443. */
  83444. lastPrice?: SeriesLastPriceOptionsObject;
  83445. /**
  83446. * (Highstock) The line marks the last price from visible range of points.
  83447. */
  83448. lastVisiblePrice?: SeriesLastVisiblePriceOptionsObject;
  83449. /**
  83450. * (Highcharts, Highstock) The SVG value used for the `stroke-linecap` and
  83451. * `stroke-linejoin` of a line graph. Round means that lines are rounded in
  83452. * the ends and bends.
  83453. */
  83454. linecap?: SeriesLinecapValue;
  83455. /**
  83456. * (Highcharts, Highstock) Pixel width of the graph line.
  83457. */
  83458. lineWidth?: number;
  83459. /**
  83460. * (Highcharts, Highstock, Gantt) The main series ID that indicator will be
  83461. * based on. Required for this indicator.
  83462. */
  83463. linkedTo?: string;
  83464. /**
  83465. * (Highstock) Options for the point markers of line-like series. Properties
  83466. * like `fillColor`, `lineColor` and `lineWidth` define the visual
  83467. * appearance of the markers. Other series types, like column series, don't
  83468. * have markers, but have visual options on the series level instead.
  83469. *
  83470. * In styled mode, the markers can be styled with the `.highcharts-point`,
  83471. * `.highcharts-point-hover` and `.highcharts-point-select` class names.
  83472. */
  83473. marker?: PointMarkerOptionsObject;
  83474. /**
  83475. * (Highstock) The name of the series as shown in the legend, tooltip etc.
  83476. * If not set, it will be based on a technical indicator type and default
  83477. * params.
  83478. */
  83479. name?: string;
  83480. /**
  83481. * (Highstock) The color for the parts of the graph or points that are below
  83482. * the threshold. Note that `zones` takes precedence over the negative
  83483. * color. Using `negativeColor` is equivalent to applying a zone with value
  83484. * of 0.
  83485. */
  83486. negativeColor?: (ColorString|GradientColorObject|PatternObject);
  83487. /**
  83488. * (Highstock) Opacity of a series parts: line, fill (e.g. area) and
  83489. * dataLabels.
  83490. */
  83491. opacity?: number;
  83492. /**
  83493. * (Highstock) Paramters used in calculation of regression series' points.
  83494. */
  83495. params?: PlotStochasticParamsOptions;
  83496. /**
  83497. * (Highstock) Properties for each single point.
  83498. */
  83499. point?: PlotSeriesPointOptions;
  83500. /**
  83501. * (Highstock) Same as accessibility.pointDescriptionFormatter, but for an
  83502. * individual series. Overrides the chart wide configuration.
  83503. */
  83504. pointDescriptionFormatter?: Function;
  83505. /**
  83506. * (Highstock) Whether to select the series initially. If `showCheckbox` is
  83507. * true, the checkbox next to the series name in the legend will be checked
  83508. * for a selected series.
  83509. */
  83510. selected?: boolean;
  83511. /**
  83512. * (Highstock) Whether to apply a drop shadow to the graph line. Since 2.3
  83513. * the shadow can be an object configuration containing `color`, `offsetX`,
  83514. * `offsetY`, `opacity` and `width`.
  83515. */
  83516. shadow?: (boolean|ShadowOptionsObject);
  83517. /**
  83518. * (Highstock) If true, a checkbox is displayed next to the legend item to
  83519. * allow selecting the series. The state of the checkbox is determined by
  83520. * the `selected` option.
  83521. */
  83522. showCheckbox?: boolean;
  83523. /**
  83524. * (Highstock) Whether to display this particular series or series type in
  83525. * the legend. Standalone series are shown in legend by default, and linked
  83526. * series are not. Since v7.2.0 it is possible to show series that use
  83527. * colorAxis by setting this option to `true`.
  83528. */
  83529. showInLegend?: boolean;
  83530. /**
  83531. * (Highstock) If set to `true`, the accessibility module will skip past the
  83532. * points in this series for keyboard navigation.
  83533. */
  83534. skipKeyboardNavigation?: boolean;
  83535. /**
  83536. * (Highstock) Smoothed line options.
  83537. */
  83538. smoothedLine?: PlotStochasticSmoothedLineOptions;
  83539. /**
  83540. * (Highcharts, Highstock) When this is true, the series will not cause the
  83541. * Y axis to cross the zero plane (or threshold option) unless the data
  83542. * actually crosses the plane.
  83543. *
  83544. * For example, if `softThreshold` is `false`, a series of 0, 1, 2, 3 will
  83545. * make the Y axis show negative values according to the `minPadding`
  83546. * option. If `softThreshold` is `true`, the Y axis starts at 0.
  83547. */
  83548. softThreshold?: boolean;
  83549. states?: SeriesStatesOptionsObject;
  83550. /**
  83551. * (Highcharts, Highstock) Whether to apply steps to the line. Possible
  83552. * values are `left`, `center` and `right`.
  83553. */
  83554. step?: OptionsStepValue;
  83555. /**
  83556. * (Highstock) Sticky tracking of mouse events. When true, the `mouseOut`
  83557. * event on a series isn't triggered until the mouse moves over another
  83558. * series, or out of the plot area. When false, the `mouseOut` event on a
  83559. * series is triggered when the mouse leaves the area around the series'
  83560. * graph or markers. This also implies the tooltip when not shared. When
  83561. * `stickyTracking` is false and `tooltip.shared` is false, the tooltip will
  83562. * be hidden when moving the mouse between series. Defaults to true for line
  83563. * and area type series, but to false for columns, pies etc.
  83564. *
  83565. * **Note:** The boost module will force this option because of technical
  83566. * limitations.
  83567. */
  83568. stickyTracking?: boolean;
  83569. /**
  83570. * (Highcharts, Highstock) The threshold, also called zero level or base
  83571. * level. For line type series this is only used in conjunction with
  83572. * negativeColor.
  83573. */
  83574. threshold?: (number|null);
  83575. /**
  83576. * (Highstock) A configuration object for the tooltip rendering of each
  83577. * single series. Properties are inherited from tooltip, but only the
  83578. * following properties can be defined on a series level.
  83579. */
  83580. tooltip?: SeriesTooltipOptionsObject;
  83581. /**
  83582. * (Highcharts, Highstock, Gantt) When a series contains a data array that
  83583. * is longer than this, only one dimensional arrays of numbers, or two
  83584. * dimensional arrays with x and y values are allowed. Also, only the first
  83585. * point is tested, and the rest are assumed to be the same format. This
  83586. * saves expensive data checking and indexing in long series. Set it to `0`
  83587. * disable.
  83588. *
  83589. * Note: In boost mode turbo threshold is forced. Only array of numbers or
  83590. * two dimensional arrays are allowed.
  83591. */
  83592. turboThreshold?: number;
  83593. /**
  83594. * (Highstock) Set the initial visibility of the series.
  83595. */
  83596. visible?: boolean;
  83597. /**
  83598. * (Highmaps) Define the z index of the series.
  83599. */
  83600. zIndex?: number;
  83601. /**
  83602. * (Highcharts, Highstock) Defines the Axis on which the zones are applied.
  83603. */
  83604. zoneAxis?: string;
  83605. /**
  83606. * (Highcharts, Highstock) An array defining zones within a series. Zones
  83607. * can be applied to the X axis, Y axis or Z axis for bubbles, according to
  83608. * the `zoneAxis` option. The zone definitions have to be in ascending order
  83609. * regarding to the value.
  83610. *
  83611. * In styled mode, the color zones are styled with the
  83612. * `.highcharts-zone-{n}` class, or custom classed from the `className`
  83613. * option (view live demo).
  83614. */
  83615. zones?: Array<SeriesZonesOptionsObject>;
  83616. }
  83617. /**
  83618. * (Highstock) Paramters used in calculation of regression series' points.
  83619. */
  83620. export interface PlotStochasticParamsOptions {
  83621. /**
  83622. * (Highstock) Periods for Stochastic oscillator: [%K, %D].
  83623. */
  83624. periods?: [number, number];
  83625. }
  83626. /**
  83627. * (Highstock) Smoothed line options.
  83628. */
  83629. export interface PlotStochasticSmoothedLineOptions {
  83630. /**
  83631. * (Highstock) Styles for a smoothed line.
  83632. */
  83633. styles?: PlotStochasticSmoothedLineStylesOptions;
  83634. }
  83635. /**
  83636. * (Highstock) Styles for a smoothed line.
  83637. */
  83638. export interface PlotStochasticSmoothedLineStylesOptions {
  83639. /**
  83640. * (Highstock) Color of the line. If not set, it's inherited from
  83641. * plotOptions.stochastic.color.
  83642. */
  83643. lineColor?: ColorString;
  83644. /**
  83645. * (Highstock) Pixel width of the line.
  83646. */
  83647. lineWidth?: number;
  83648. }
  83649. /**
  83650. * (Highcharts, Highstock) Enable or disable the initial animation when a series
  83651. * is displayed. The animation can also be set as a configuration object. Please
  83652. * note that this option only applies to the initial animation of the series
  83653. * itself. For other animations, see chart.animation and the animation parameter
  83654. * under the API methods. The following properties are supported:
  83655. *
  83656. * - `defer`: The animation delay time in milliseconds.
  83657. *
  83658. * - `duration`: The duration of the animation in milliseconds.
  83659. *
  83660. * - `easing`: Can be a string reference to an easing function set on the `Math`
  83661. * object or a function. See the _Custom easing function_ demo below.
  83662. *
  83663. * Due to poor performance, animation is disabled in old IE browsers for several
  83664. * chart types.
  83665. */
  83666. export interface PlotStreamgraphAnimationOptions {
  83667. defer?: number;
  83668. }
  83669. /**
  83670. * (Highcharts, Highstock, Highmaps, Gantt) Enable or disable the initial
  83671. * animation when a series is displayed for the `dataLabels`. The animation can
  83672. * also be set as a configuration object. Please note that this option only
  83673. * applies to the initial animation. For other animations, see chart.animation
  83674. * and the animation parameter under the API methods. The following properties
  83675. * are supported:
  83676. *
  83677. * - `defer`: The animation delay time in milliseconds.
  83678. */
  83679. export interface PlotStreamgraphDataLabelsAnimationOptions {
  83680. /**
  83681. * (Highcharts, Highstock, Highmaps, Gantt) The animation delay time in
  83682. * milliseconds. Set to `0` renders dataLabel immediately. As `undefined`
  83683. * inherits defer time from the series.animation.defer.
  83684. */
  83685. defer?: number;
  83686. }
  83687. /**
  83688. * (Highcharts, Highstock, Highmaps, Gantt) Options for the series data labels,
  83689. * appearing next to each data point.
  83690. *
  83691. * Since v6.2.0, multiple data labels can be applied to each single point by
  83692. * defining them as an array of configs.
  83693. *
  83694. * In styled mode, the data labels can be styled with the
  83695. * `.highcharts-data-label-box` and `.highcharts-data-label` class names (see
  83696. * example).
  83697. */
  83698. export interface PlotStreamgraphDataLabelsOptions {
  83699. /**
  83700. * (Highcharts, Highstock, Highmaps, Gantt) The alignment of the data label
  83701. * compared to the point. If `right`, the right side of the label should be
  83702. * touching the point. For points with an extent, like columns, the
  83703. * alignments also dictates how to align it inside the box, as given with
  83704. * the inside option. Can be one of `left`, `center` or `right`.
  83705. */
  83706. align?: (AlignValue|null);
  83707. /**
  83708. * (Highcharts, Highstock, Highmaps, Gantt) Whether to allow data labels to
  83709. * overlap. To make the labels less sensitive for overlapping, the
  83710. * dataLabels.padding can be set to 0.
  83711. */
  83712. allowOverlap?: boolean;
  83713. /**
  83714. * (Highcharts, Highstock, Highmaps, Gantt) Enable or disable the initial
  83715. * animation when a series is displayed for the `dataLabels`. The animation
  83716. * can also be set as a configuration object. Please note that this option
  83717. * only applies to the initial animation. For other animations, see
  83718. * chart.animation and the animation parameter under the API methods. The
  83719. * following properties are supported:
  83720. *
  83721. * - `defer`: The animation delay time in milliseconds.
  83722. */
  83723. animation?: (boolean|PlotStreamgraphDataLabelsAnimationOptions|Partial<AnimationOptionsObject>);
  83724. /**
  83725. * (Highcharts, Highstock, Highmaps, Gantt) The background color or gradient
  83726. * for the data label.
  83727. */
  83728. backgroundColor?: (ColorString|GradientColorObject|PatternObject);
  83729. /**
  83730. * (Highcharts, Highstock, Highmaps, Gantt) The border color for the data
  83731. * label. Defaults to `undefined`.
  83732. */
  83733. borderColor?: (ColorString|GradientColorObject|PatternObject);
  83734. /**
  83735. * (Highcharts, Highstock, Highmaps, Gantt) The border radius in pixels for
  83736. * the data label.
  83737. */
  83738. borderRadius?: number;
  83739. /**
  83740. * (Highcharts, Highstock, Highmaps, Gantt) The border width in pixels for
  83741. * the data label.
  83742. */
  83743. borderWidth?: number;
  83744. /**
  83745. * (Highcharts, Highstock, Highmaps, Gantt) A class name for the data label.
  83746. * Particularly in styled mode, this can be used to give each series' or
  83747. * point's data label unique styling. In addition to this option, a default
  83748. * color class name is added so that we can give the labels a contrast text
  83749. * shadow.
  83750. */
  83751. className?: string;
  83752. /**
  83753. * (Highcharts, Highstock, Highmaps, Gantt) The text color for the data
  83754. * labels. Defaults to `undefined`. For certain series types, like column or
  83755. * map, the data labels can be drawn inside the points. In this case the
  83756. * data label will be drawn with maximum contrast by default. Additionally,
  83757. * it will be given a `text-outline` style with the opposite color, to
  83758. * further increase the contrast. This can be overridden by setting the
  83759. * `text-outline` style to `none` in the `dataLabels.style` option.
  83760. */
  83761. color?: (ColorString|GradientColorObject|PatternObject);
  83762. /**
  83763. * (Highcharts, Highstock, Highmaps, Gantt) Whether to hide data labels that
  83764. * are outside the plot area. By default, the data label is moved inside the
  83765. * plot area according to the overflow option.
  83766. */
  83767. crop?: boolean;
  83768. /**
  83769. * (Highcharts, Highstock, Gantt) Whether to defer displaying the data
  83770. * labels until the initial series animation has finished. Setting to
  83771. * `false` renders the data label immediately. If set to `true` inherits the
  83772. * defer time set in plotOptions.series.animation.
  83773. */
  83774. defer?: boolean;
  83775. /**
  83776. * (Highcharts, Highstock, Highmaps, Gantt) Enable or disable the data
  83777. * labels.
  83778. */
  83779. enabled?: boolean;
  83780. /**
  83781. * (Highcharts, Highstock, Highmaps, Gantt) A declarative filter to control
  83782. * of which data labels to display. The declarative filter is designed for
  83783. * use when callback functions are not available, like when the chart
  83784. * options require a pure JSON structure or for use with graphical editors.
  83785. * For programmatic control, use the `formatter` instead, and return
  83786. * `undefined` to disable a single data label.
  83787. */
  83788. filter?: DataLabelsFilterOptionsObject;
  83789. /**
  83790. * (Highcharts, Highstock, Highmaps, Gantt) A format string for the data
  83791. * label. Available variables are the same as for `formatter`.
  83792. */
  83793. format?: string;
  83794. /**
  83795. * (Highcharts, Highstock, Highmaps, Gantt) Callback JavaScript function to
  83796. * format the data label. Note that if a `format` is defined, the format
  83797. * takes precedence and the formatter is ignored.
  83798. */
  83799. formatter?: DataLabelsFormatterCallbackFunction;
  83800. /**
  83801. * (Highcharts, Highstock, Highmaps, Gantt) For points with an extent, like
  83802. * columns or map areas, whether to align the data label inside the box or
  83803. * to the actual value point. Defaults to `false` in most cases, `true` in
  83804. * stacked columns.
  83805. */
  83806. inside?: boolean;
  83807. /**
  83808. * (Highcharts, Highstock, Highmaps, Gantt) Format for points with the value
  83809. * of null. Works analogously to format. `nullFormat` can be applied only to
  83810. * series which support displaying null points.
  83811. */
  83812. nullFormat?: (boolean|string);
  83813. /**
  83814. * (Highcharts, Highstock, Highmaps, Gantt) Callback JavaScript function
  83815. * that defines formatting for points with the value of null. Works
  83816. * analogously to formatter. `nullPointFormatter` can be applied only to
  83817. * series which support displaying null points.
  83818. */
  83819. nullFormatter?: DataLabelsFormatterCallbackFunction;
  83820. /**
  83821. * (Highcharts, Highstock, Highmaps, Gantt) How to handle data labels that
  83822. * flow outside the plot area. The default is `"justify"`, which aligns them
  83823. * inside the plot area. For columns and bars, this means it will be moved
  83824. * inside the bar. To display data labels outside the plot area, set `crop`
  83825. * to `false` and `overflow` to `"allow"`.
  83826. */
  83827. overflow?: DataLabelsOverflowValue;
  83828. /**
  83829. * (Highcharts, Highstock, Highmaps, Gantt) When either the `borderWidth` or
  83830. * the `backgroundColor` is set, this is the padding within the box.
  83831. */
  83832. padding?: number;
  83833. /**
  83834. * (Highcharts, Highstock, Highmaps, Gantt) Aligns data labels relative to
  83835. * points. If `center` alignment is not possible, it defaults to `right`.
  83836. */
  83837. position?: AlignValue;
  83838. /**
  83839. * (Highcharts, Highstock, Highmaps, Gantt) Text rotation in degrees. Note
  83840. * that due to a more complex structure, backgrounds, borders and padding
  83841. * will be lost on a rotated data label.
  83842. */
  83843. rotation?: number;
  83844. /**
  83845. * (Highcharts, Highstock, Highmaps, Gantt) The shadow of the box. Works
  83846. * best with `borderWidth` or `backgroundColor`. Since 2.3 the shadow can be
  83847. * an object configuration containing `color`, `offsetX`, `offsetY`,
  83848. * `opacity` and `width`.
  83849. */
  83850. shadow?: (boolean|ShadowOptionsObject);
  83851. /**
  83852. * (Highcharts, Highstock, Highmaps, Gantt) The name of a symbol to use for
  83853. * the border around the label. Symbols are predefined functions on the
  83854. * Renderer object.
  83855. */
  83856. shape?: string;
  83857. /**
  83858. * (Highcharts, Highstock, Highmaps, Gantt) Styles for the label. The
  83859. * default `color` setting is `"contrast"`, which is a pseudo color that
  83860. * Highcharts picks up and applies the maximum contrast to the underlying
  83861. * point item, for example the bar in a bar chart.
  83862. *
  83863. * The `textOutline` is a pseudo property that applies an outline of the
  83864. * given width with the given color, which by default is the maximum
  83865. * contrast to the text. So a bright text color will result in a black text
  83866. * outline for maximum readability on a mixed background. In some cases,
  83867. * especially with grayscale text, the text outline doesn't work well, in
  83868. * which cases it can be disabled by setting it to `"none"`. When `useHTML`
  83869. * is true, the `textOutline` will not be picked up. In this, case, the same
  83870. * effect can be acheived through the `text-shadow` CSS property.
  83871. *
  83872. * For some series types, where each point has an extent, like for example
  83873. * tree maps, the data label may overflow the point. There are two
  83874. * strategies for handling overflow. By default, the text will wrap to
  83875. * multiple lines. The other strategy is to set `style.textOverflow` to
  83876. * `ellipsis`, which will keep the text on one line plus it will break
  83877. * inside long words.
  83878. */
  83879. style?: CSSObject;
  83880. /**
  83881. * (Highcharts, Highstock, Highmaps, Gantt) Options for a label text which
  83882. * should follow marker's shape. Border and background are disabled for a
  83883. * label that follows a path.
  83884. *
  83885. * **Note:** Only SVG-based renderer supports this option. Setting `useHTML`
  83886. * to true will disable this option.
  83887. */
  83888. textPath?: DataLabelsTextPathOptionsObject;
  83889. /**
  83890. * (Highcharts, Highstock, Highmaps, Gantt) Whether to use HTML to render
  83891. * the labels.
  83892. */
  83893. useHTML?: boolean;
  83894. /**
  83895. * (Highcharts, Highstock, Highmaps, Gantt) The vertical alignment of a data
  83896. * label. Can be one of `top`, `middle` or `bottom`. The default value
  83897. * depends on the data, for instance in a column chart, the label is above
  83898. * positive values and below negative values.
  83899. */
  83900. verticalAlign?: (VerticalAlignValue|null);
  83901. /**
  83902. * (Highcharts, Highstock, Highmaps, Gantt) The x position offset of the
  83903. * label relative to the point in pixels.
  83904. */
  83905. x?: number;
  83906. /**
  83907. * (Highcharts, Highstock, Highmaps, Gantt) The y position offset of the
  83908. * label relative to the point in pixels.
  83909. */
  83910. y?: number;
  83911. /**
  83912. * (Highcharts, Highstock, Highmaps, Gantt) The Z index of the data labels.
  83913. * The default Z index puts it above the series. Use a Z index of 2 to
  83914. * display it behind the series.
  83915. */
  83916. z?: number;
  83917. }
  83918. /**
  83919. * (Highcharts, Highstock) Options for the series data sorting.
  83920. */
  83921. export interface PlotStreamgraphDataSortingOptions {
  83922. /**
  83923. * (Highcharts, Highstock) Enable or disable data sorting for the series.
  83924. * Use xAxis.reversed to change the sorting order.
  83925. */
  83926. enabled?: boolean;
  83927. /**
  83928. * (Highcharts, Highstock) Whether to allow matching points by name in an
  83929. * update. If this option is disabled, points will be matched by order.
  83930. */
  83931. matchByName?: boolean;
  83932. /**
  83933. * (Highcharts, Highstock) Determines what data value should be used to sort
  83934. * by.
  83935. */
  83936. sortKey?: string;
  83937. }
  83938. /**
  83939. * (Highcharts, Highstock) Style options for the guide box. The guide box has
  83940. * one state by default, the `default` state.
  83941. */
  83942. export interface PlotStreamgraphDragDropGuideBoxOptions {
  83943. /**
  83944. * (Highcharts, Highstock) Style options for the guide box default state.
  83945. */
  83946. default?: DragDropGuideBoxOptionsObject;
  83947. }
  83948. /**
  83949. * (Highcharts, Highstock) A streamgraph is a type of stacked area graph which
  83950. * is displaced around a central axis, resulting in a flowing, organic shape.
  83951. *
  83952. * In TypeScript the type option must always be set.
  83953. *
  83954. * Configuration options for the series are given in three levels:
  83955. *
  83956. * 1. Options for all series in a chart are defined in the plotOptions.series
  83957. * object.
  83958. *
  83959. * 2. Options for all `streamgraph` series are defined in
  83960. * plotOptions.streamgraph.
  83961. *
  83962. * 3. Options for one single series are given in the series instance array. (see
  83963. * online documentation for example)
  83964. */
  83965. export interface PlotStreamgraphOptions {
  83966. /**
  83967. * (Highcharts, Highstock) Accessibility options for a series.
  83968. */
  83969. accessibility?: SeriesAccessibilityOptionsObject;
  83970. /**
  83971. * (Highmaps) Whether all areas of the map defined in `mapData` should be
  83972. * rendered. If `true`, areas which don't correspond to a data point, are
  83973. * rendered as `null` points. If `false`, those areas are skipped.
  83974. */
  83975. allAreas?: boolean;
  83976. /**
  83977. * (Highcharts, Highstock) Allow this series' points to be selected by
  83978. * clicking on the graphic (columns, point markers, pie slices, map areas
  83979. * etc).
  83980. *
  83981. * The selected points can be handled by point select and unselect events,
  83982. * or collectively by the getSelectedPoints function.
  83983. *
  83984. * And alternative way of selecting points is through dragging.
  83985. */
  83986. allowPointSelect?: boolean;
  83987. /**
  83988. * (Highcharts, Highstock) Enable or disable the initial animation when a
  83989. * series is displayed. The animation can also be set as a configuration
  83990. * object. Please note that this option only applies to the initial
  83991. * animation of the series itself. For other animations, see chart.animation
  83992. * and the animation parameter under the API methods. The following
  83993. * properties are supported:
  83994. *
  83995. * - `defer`: The animation delay time in milliseconds.
  83996. *
  83997. * - `duration`: The duration of the animation in milliseconds.
  83998. *
  83999. * - `easing`: Can be a string reference to an easing function set on the
  84000. * `Math` object or a function. See the _Custom easing function_ demo below.
  84001. *
  84002. * Due to poor performance, animation is disabled in old IE browsers for
  84003. * several chart types.
  84004. */
  84005. animation?: (boolean|PlotStreamgraphAnimationOptions|Partial<AnimationOptionsObject>);
  84006. /**
  84007. * (Highcharts, Highstock) For some series, there is a limit that shuts down
  84008. * initial animation by default when the total number of points in the chart
  84009. * is too high. For example, for a column chart and its derivatives,
  84010. * animation does not run if there is more than 250 points totally. To
  84011. * disable this cap, set `animationLimit` to `Infinity`.
  84012. */
  84013. animationLimit?: number;
  84014. /**
  84015. * (Highmaps) The border color of the map areas.
  84016. *
  84017. * In styled mode, the border stroke is given in the `.highcharts-point`
  84018. * class.
  84019. */
  84020. borderColor?: (ColorString|GradientColorObject|PatternObject);
  84021. /**
  84022. * (Highmaps) The border width of each map area.
  84023. *
  84024. * In styled mode, the border stroke width is given in the
  84025. * `.highcharts-point` class.
  84026. */
  84027. borderWidth?: number;
  84028. /**
  84029. * (Highcharts, Highstock) An additional class name to apply to the series'
  84030. * graphical elements. This option does not replace default class names of
  84031. * the graphical element.
  84032. */
  84033. className?: string;
  84034. /**
  84035. * (Highcharts, Highstock) Disable this option to allow series rendering in
  84036. * the whole plotting area.
  84037. *
  84038. * **Note:** Clipping should be always enabled when chart.zoomType is set
  84039. */
  84040. clip?: boolean;
  84041. /**
  84042. * (Highcharts, Highstock) The main color of the series. In line type series
  84043. * it applies to the line and the point markers unless otherwise specified.
  84044. * In bar type series it applies to the bars unless a color is specified per
  84045. * point. The default value is pulled from the `options.colors` array.
  84046. *
  84047. * In styled mode, the color can be defined by the colorIndex option. Also,
  84048. * the series color can be set with the `.highcharts-series`,
  84049. * `.highcharts-color-{n}`, `.highcharts-{type}-series` or
  84050. * `.highcharts-series-{n}` class, or individual classes given by the
  84051. * `className` option.
  84052. */
  84053. color?: (ColorString|GradientColorObject|PatternObject);
  84054. /**
  84055. * (Highcharts, Highstock, Highmaps) When using dual or multiple color axes,
  84056. * this number defines which colorAxis the particular series is connected
  84057. * to. It refers to either the axis id or the index of the axis in the
  84058. * colorAxis array, with 0 being the first. Set this option to false to
  84059. * prevent a series from connecting to the default color axis.
  84060. *
  84061. * Since v7.2.0 the option can also be an axis id or an axis index instead
  84062. * of a boolean flag.
  84063. */
  84064. colorAxis?: (boolean|number|string);
  84065. /**
  84066. * (Highcharts, Highstock) Styled mode only. A specific color index to use
  84067. * for the series, so its graphic representations are given the class name
  84068. * `highcharts-color-{n}`.
  84069. */
  84070. colorIndex?: number;
  84071. /**
  84072. * (Highcharts, Highstock, Highmaps) Determines what data value should be
  84073. * used to calculate point color if `colorAxis` is used. Requires to set
  84074. * `min` and `max` if some custom point property is used or if approximation
  84075. * for data grouping is set to `'sum'`.
  84076. */
  84077. colorKey?: string;
  84078. /**
  84079. * (Highstock) Compare the values of the series against the first non-null,
  84080. * non- zero value in the visible range. The y axis will show percentage or
  84081. * absolute change depending on whether `compare` is set to `"percent"` or
  84082. * `"value"`. When this is applied to multiple series, it allows comparing
  84083. * the development of the series against each other. Adds a `change` field
  84084. * to every point object.
  84085. */
  84086. compare?: string;
  84087. /**
  84088. * (Highstock) When compare is `percent`, this option dictates whether to
  84089. * use 0 or 100 as the base of comparison.
  84090. */
  84091. compareBase?: (0|100);
  84092. /**
  84093. * (Highstock) Defines if comparison should start from the first point
  84094. * within the visible range or should start from the first point **before**
  84095. * the range.
  84096. *
  84097. * In other words, this flag determines if first point within the visible
  84098. * range will have 0% (`compareStart=true`) or should have been already
  84099. * calculated according to the previous point (`compareStart=false`).
  84100. */
  84101. compareStart?: boolean;
  84102. /**
  84103. * (Highcharts) Polar charts only. Whether to connect the ends of a line
  84104. * series plot across the extremes.
  84105. */
  84106. connectEnds?: boolean;
  84107. /**
  84108. * (Highcharts, Highstock) Whether to connect a graph line across null
  84109. * points, or render a gap between the two points on either side of the
  84110. * null.
  84111. */
  84112. connectNulls?: boolean;
  84113. /**
  84114. * (Gantt) Override Pathfinder connector options for a series. Requires
  84115. * Highcharts Gantt to be loaded.
  84116. */
  84117. connectors?: SeriesConnectorsOptionsObject;
  84118. /**
  84119. * (Highcharts, Highstock, Gantt) When true, each point or column edge is
  84120. * rounded to its nearest pixel in order to render sharp on screen. In some
  84121. * cases, when there are a lot of densely packed columns, this leads to
  84122. * visible difference in column widths or distance between columns. In these
  84123. * cases, setting `crisp` to `false` may look better, even though each
  84124. * column is rendered blurry.
  84125. */
  84126. crisp?: boolean;
  84127. /**
  84128. * (Highcharts, Highstock) When the series contains less points than the
  84129. * crop threshold, all points are drawn, even if the points fall outside the
  84130. * visible plot area at the current zoom. The advantage of drawing all
  84131. * points (including markers and columns), is that animation is performed on
  84132. * updates. On the other hand, when the series contains more points than the
  84133. * crop threshold, the series data is cropped to only contain points that
  84134. * fall within the plot area. The advantage of cropping away invisible
  84135. * points is to increase performance on large series.
  84136. */
  84137. cropThreshold?: number;
  84138. /**
  84139. * (Highcharts, Highstock) You can set the cursor to "pointer" if you have
  84140. * click events attached to the series, to signal to the user that the
  84141. * points and lines can be clicked.
  84142. *
  84143. * In styled mode, the series cursor can be set with the same classes as
  84144. * listed under series.color.
  84145. */
  84146. cursor?: (string|CursorValue);
  84147. /**
  84148. * (Highcharts, Highstock) A reserved subspace to store options and values
  84149. * for customized functionality. Here you can add additional data for your
  84150. * own event callbacks and formatter callbacks.
  84151. */
  84152. custom?: Dictionary<any>;
  84153. /**
  84154. * (Highcharts, Highstock) Name of the dash style to use for the graph, or
  84155. * for some series types the outline of each shape.
  84156. *
  84157. * In styled mode, the stroke dash-array can be set with the same classes as
  84158. * listed under series.color.
  84159. */
  84160. dashStyle?: DashStyleValue;
  84161. /**
  84162. * (Highstock) Data grouping is the concept of sampling the data values into
  84163. * larger blocks in order to ease readability and increase performance of
  84164. * the JavaScript charts. Highstock by default applies data grouping when
  84165. * the points become closer than a certain pixel value, determined by the
  84166. * `groupPixelWidth` option.
  84167. *
  84168. * If data grouping is applied, the grouping information of grouped points
  84169. * can be read from the Point.dataGroup. If point options other than the
  84170. * data itself are set, for example `name` or `color` or custom properties,
  84171. * the grouping logic doesn't know how to group it. In this case the options
  84172. * of the first point instance are copied over to the group point. This can
  84173. * be altered through a custom `approximation` callback function.
  84174. */
  84175. dataGrouping?: DataGroupingOptionsObject;
  84176. /**
  84177. * (Highcharts, Highstock, Highmaps, Gantt) Options for the series data
  84178. * labels, appearing next to each data point.
  84179. *
  84180. * Since v6.2.0, multiple data labels can be applied to each single point by
  84181. * defining them as an array of configs.
  84182. *
  84183. * In styled mode, the data labels can be styled with the
  84184. * `.highcharts-data-label-box` and `.highcharts-data-label` class names
  84185. * (see example).
  84186. */
  84187. dataLabels?: (PlotStreamgraphDataLabelsOptions|Array<PlotStreamgraphDataLabelsOptions>);
  84188. /**
  84189. * (Highcharts, Highstock) Options for the series data sorting.
  84190. */
  84191. dataSorting?: (DataSortingOptionsObject|PlotStreamgraphDataSortingOptions);
  84192. /**
  84193. * (Highcharts, Highstock) A description of the series to add to the screen
  84194. * reader information about the series.
  84195. */
  84196. description?: string;
  84197. /**
  84198. * (Highcharts, Highstock) The draggable-points module allows points to be
  84199. * moved around or modified in the chart. In addition to the options
  84200. * mentioned under the `dragDrop` API structure, the module fires three
  84201. * events, point.dragStart, point.drag and point.drop.
  84202. */
  84203. dragDrop?: SeriesDragDropOptionsObject;
  84204. /**
  84205. * (Highcharts, Highstock) Enable or disable the mouse tracking for a
  84206. * specific series. This includes point tooltips and click events on graphs
  84207. * and points. For large datasets it improves performance.
  84208. */
  84209. enableMouseTracking?: boolean;
  84210. /**
  84211. * (Highcharts, Highstock) General event handlers for the series items.
  84212. * These event hooks can also be attached to the series at run time using
  84213. * the `Highcharts.addEvent` function.
  84214. */
  84215. events?: SeriesEventsOptionsObject;
  84216. /**
  84217. * (Highcharts, Highstock) Fill color or gradient for the area. When `null`,
  84218. * the series' `color` is used with the series' `fillOpacity`.
  84219. *
  84220. * In styled mode, the fill color can be set with the `.highcharts-area`
  84221. * class name.
  84222. */
  84223. fillColor?: (ColorString|GradientColorObject|PatternObject);
  84224. /**
  84225. * (Highcharts, Highstock) Fill opacity for the area. When you set an
  84226. * explicit `fillColor`, the `fillOpacity` is not applied. Instead, you
  84227. * should define the opacity in the `fillColor` with an rgba color
  84228. * definition. The `fillOpacity` setting, also the default setting,
  84229. * overrides the alpha component of the `color` setting.
  84230. *
  84231. * In styled mode, the fill opacity can be set with the `.highcharts-area`
  84232. * class name.
  84233. */
  84234. fillOpacity?: number;
  84235. /**
  84236. * (Highcharts, Highstock) Determines whether the series should look for the
  84237. * nearest point in both dimensions or just the x-dimension when hovering
  84238. * the series. Defaults to `'xy'` for scatter series and `'x'` for most
  84239. * other series. If the data has duplicate x-values, it is recommended to
  84240. * set this to `'xy'` to allow hovering over all points.
  84241. *
  84242. * Applies only to series types using nearest neighbor search (not direct
  84243. * hover) for tooltip.
  84244. */
  84245. findNearestPointBy?: OptionsFindNearestPointByValue;
  84246. /**
  84247. * (Highstock) Defines when to display a gap in the graph, together with the
  84248. * gapUnit option.
  84249. *
  84250. * In case when `dataGrouping` is enabled, points can be grouped into a
  84251. * larger time span. This can make the grouped points to have a greater
  84252. * distance than the absolute value of `gapSize` property, which will result
  84253. * in disappearing graph completely. To prevent this situation the mentioned
  84254. * distance between grouped points is used instead of previously defined
  84255. * `gapSize`.
  84256. *
  84257. * In practice, this option is most often used to visualize gaps in time
  84258. * series. In a stock chart, intraday data is available for daytime hours,
  84259. * while gaps will appear in nights and weekends.
  84260. */
  84261. gapSize?: number;
  84262. /**
  84263. * (Highstock) Together with gapSize, this option defines where to draw gaps
  84264. * in the graph.
  84265. *
  84266. * When the `gapUnit` is `"relative"` (default), a gap size of 5 means that
  84267. * if the distance between two points is greater than 5 times that of the
  84268. * two closest points, the graph will be broken.
  84269. *
  84270. * When the `gapUnit` is `"value"`, the gap is based on absolute axis
  84271. * values, which on a datetime axis is milliseconds. This also applies to
  84272. * the navigator series that inherits gap options from the base series.
  84273. */
  84274. gapUnit?: OptionsGapUnitValue;
  84275. /**
  84276. * (Highcharts, Highstock, Gantt) Whether to use the Y extremes of the total
  84277. * chart width or only the zoomed area when zooming in on parts of the X
  84278. * axis. By default, the Y axis adjusts to the min and max of the visible
  84279. * data. Cartesian series only.
  84280. */
  84281. getExtremesFromAll?: boolean;
  84282. /**
  84283. * (Highcharts, Highstock) When set to `false` will prevent the series data
  84284. * from being included in any form of data export.
  84285. *
  84286. * Since version 6.0.0 until 7.1.0 the option was existing undocumented as
  84287. * `includeInCSVExport`.
  84288. */
  84289. includeInDataExport?: boolean;
  84290. /**
  84291. * (Highmaps) What property to join the `mapData` to the value data. For
  84292. * example, if joinBy is "code", the mapData items with a specific code is
  84293. * merged into the data with the same code. For maps loaded from GeoJSON,
  84294. * the keys may be held in each point's `properties` object.
  84295. *
  84296. * The joinBy option can also be an array of two values, where the first
  84297. * points to a key in the `mapData`, and the second points to another key in
  84298. * the `data`.
  84299. *
  84300. * When joinBy is `null`, the map items are joined by their position in the
  84301. * array, which performs much better in maps with many data points. This is
  84302. * the recommended option if you are printing more than a thousand data
  84303. * points and have a backend that can preprocess the data into a parallel
  84304. * array of the mapData.
  84305. */
  84306. joinBy?: (string|Array<string>);
  84307. /**
  84308. * (Highcharts, Highstock) An array specifying which option maps to which
  84309. * key in the data point array. This makes it convenient to work with
  84310. * unstructured data arrays from different sources.
  84311. */
  84312. keys?: Array<string>;
  84313. /**
  84314. * (Highcharts, Highstock, Gantt) Series labels are placed as close to the
  84315. * series as possible in a natural way, seeking to avoid other series. The
  84316. * goal of this feature is to make the chart more easily readable, like if a
  84317. * human designer placed the labels in the optimal position.
  84318. *
  84319. * The series labels currently work with series types having a `graph` or an
  84320. * `area`.
  84321. */
  84322. label?: SeriesLabelOptionsObject;
  84323. /**
  84324. * (Highstock) The line marks the last price from all points.
  84325. */
  84326. lastPrice?: SeriesLastPriceOptionsObject;
  84327. /**
  84328. * (Highstock) The line marks the last price from visible range of points.
  84329. */
  84330. lastVisiblePrice?: SeriesLastVisiblePriceOptionsObject;
  84331. /**
  84332. * (Highcharts, Highstock) The SVG value used for the `stroke-linecap` and
  84333. * `stroke-linejoin` of a line graph. Round means that lines are rounded in
  84334. * the ends and bends.
  84335. */
  84336. linecap?: SeriesLinecapValue;
  84337. /**
  84338. * (Highcharts, Highstock) A separate color for the graph line. By default
  84339. * the line takes the `color` of the series, but the lineColor setting
  84340. * allows setting a separate color for the line without altering the
  84341. * `fillColor`.
  84342. *
  84343. * In styled mode, the line stroke can be set with the `.highcharts-graph`
  84344. * class name.
  84345. */
  84346. lineColor?: (ColorString|GradientColorObject|PatternObject);
  84347. /**
  84348. * (Highcharts, Highstock) Pixel width of the graph line.
  84349. */
  84350. lineWidth?: number;
  84351. /**
  84352. * (Highcharts, Highstock, Gantt) The id of another series to link to.
  84353. * Additionally, the value can be ":previous" to link to the previous
  84354. * series. When two series are linked, only the first one appears in the
  84355. * legend. Toggling the visibility of this also toggles the linked series.
  84356. *
  84357. * If master series uses data sorting and linked series does not have its
  84358. * own sorting definition, the linked series will be sorted in the same
  84359. * order as the master one.
  84360. */
  84361. linkedTo?: string;
  84362. /**
  84363. * (Highcharts, Highstock) Options for the point markers of line-like
  84364. * series. Properties like `fillColor`, `lineColor` and `lineWidth` define
  84365. * the visual appearance of the markers. Other series types, like column
  84366. * series, don't have markers, but have visual options on the series level
  84367. * instead.
  84368. *
  84369. * In styled mode, the markers can be styled with the `.highcharts-point`,
  84370. * `.highcharts-point-hover` and `.highcharts-point-select` class names.
  84371. */
  84372. marker?: PointMarkerOptionsObject;
  84373. /**
  84374. * (Highstock) Options for the corresponding navigator series if
  84375. * `showInNavigator` is `true` for this series. Available options are the
  84376. * same as any series, documented at plotOptions and series.
  84377. *
  84378. * These options are merged with options in navigator.series, and will take
  84379. * precedence if the same option is defined both places.
  84380. */
  84381. navigatorOptions?: PlotSeriesOptions;
  84382. /**
  84383. * (Highcharts, Highstock) The color for the parts of the graph or points
  84384. * that are below the threshold. Note that `zones` takes precedence over the
  84385. * negative color. Using `negativeColor` is equivalent to applying a zone
  84386. * with value of 0.
  84387. */
  84388. negativeColor?: (ColorString|GradientColorObject|PatternObject);
  84389. /**
  84390. * (Highcharts) A separate color for the negative part of the area.
  84391. *
  84392. * In styled mode, a negative color is set with the `.highcharts-negative`
  84393. * class name.
  84394. */
  84395. negativeFillColor?: (ColorString|GradientColorObject|PatternObject);
  84396. /**
  84397. * (Highcharts, Highstock) Opacity of a series parts: line, fill (e.g. area)
  84398. * and dataLabels.
  84399. */
  84400. opacity?: number;
  84401. /**
  84402. * (Highcharts, Highstock) Properties for each single point.
  84403. */
  84404. point?: PlotSeriesPointOptions;
  84405. /**
  84406. * (Highcharts, Highstock) Same as accessibility.pointDescriptionFormatter,
  84407. * but for an individual series. Overrides the chart wide configuration.
  84408. */
  84409. pointDescriptionFormatter?: Function;
  84410. /**
  84411. * (Highcharts, Highstock, Gantt) If no x values are given for the points in
  84412. * a series, `pointInterval` defines the interval of the x values. For
  84413. * example, if a series contains one value every decade starting from year
  84414. * 0, set `pointInterval` to `10`. In true `datetime` axes, the
  84415. * `pointInterval` is set in milliseconds.
  84416. *
  84417. * It can be also be combined with `pointIntervalUnit` to draw irregular
  84418. * time intervals.
  84419. *
  84420. * Please note that this options applies to the _series data_, not the
  84421. * interval of the axis ticks, which is independent.
  84422. */
  84423. pointInterval?: number;
  84424. /**
  84425. * (Highcharts, Highstock, Gantt) On datetime series, this allows for
  84426. * setting the pointInterval to irregular time units, `day`, `month` and
  84427. * `year`. A day is usually the same as 24 hours, but `pointIntervalUnit`
  84428. * also takes the DST crossover into consideration when dealing with local
  84429. * time. Combine this option with `pointInterval` to draw weeks, quarters, 6
  84430. * months, 10 years etc.
  84431. *
  84432. * Please note that this options applies to the _series data_, not the
  84433. * interval of the axis ticks, which is independent.
  84434. */
  84435. pointIntervalUnit?: OptionsPointIntervalUnitValue;
  84436. /**
  84437. * (Highcharts, Highstock, Gantt) Possible values: `"on"`, `"between"`,
  84438. * `number`.
  84439. *
  84440. * In a column chart, when pointPlacement is `"on"`, the point will not
  84441. * create any padding of the X axis. In a polar column chart this means that
  84442. * the first column points directly north. If the pointPlacement is
  84443. * `"between"`, the columns will be laid out between ticks. This is useful
  84444. * for example for visualising an amount between two points in time or in a
  84445. * certain sector of a polar chart.
  84446. *
  84447. * Since Highcharts 3.0.2, the point placement can also be numeric, where 0
  84448. * is on the axis value, -0.5 is between this value and the previous, and
  84449. * 0.5 is between this value and the next. Unlike the textual options,
  84450. * numeric point placement options won't affect axis padding.
  84451. *
  84452. * Note that pointPlacement needs a pointRange to work. For column series
  84453. * this is computed, but for line-type series it needs to be set.
  84454. *
  84455. * For the `xrange` series type and gantt charts, if the Y axis is a
  84456. * category axis, the `pointPlacement` applies to the Y axis rather than the
  84457. * (typically datetime) X axis.
  84458. *
  84459. * Defaults to `undefined` in cartesian charts, `"between"` in polar charts.
  84460. */
  84461. pointPlacement?: (number|string);
  84462. /**
  84463. * (Highstock) The width of each point on the x axis. For example in a
  84464. * column chart with one value each day, the pointRange would be 1 day (= 24
  84465. * * 3600
  84466. *
  84467. * * 1000 milliseconds). This is normally computed automatically, but this
  84468. * option can be used to override the automatic value.
  84469. */
  84470. pointRange?: number;
  84471. /**
  84472. * (Highcharts, Highstock, Gantt) If no x values are given for the points in
  84473. * a series, pointStart defines on what value to start. For example, if a
  84474. * series contains one yearly value starting from 1945, set pointStart to
  84475. * 1945.
  84476. */
  84477. pointStart?: number;
  84478. /**
  84479. * (Highcharts, Highstock) Whether to select the series initially. If
  84480. * `showCheckbox` is true, the checkbox next to the series name in the
  84481. * legend will be checked for a selected series.
  84482. */
  84483. selected?: boolean;
  84484. /**
  84485. * (Highcharts, Highstock) Whether to apply a drop shadow to the graph line.
  84486. * Since 2.3 the shadow can be an object configuration containing `color`,
  84487. * `offsetX`, `offsetY`, `opacity` and `width`.
  84488. */
  84489. shadow?: (boolean|ShadowOptionsObject);
  84490. /**
  84491. * (Highcharts, Highstock) If true, a checkbox is displayed next to the
  84492. * legend item to allow selecting the series. The state of the checkbox is
  84493. * determined by the `selected` option.
  84494. */
  84495. showCheckbox?: boolean;
  84496. /**
  84497. * (Highcharts, Highstock) Whether to display this particular series or
  84498. * series type in the legend. Standalone series are shown in legend by
  84499. * default, and linked series are not. Since v7.2.0 it is possible to show
  84500. * series that use colorAxis by setting this option to `true`.
  84501. */
  84502. showInLegend?: boolean;
  84503. /**
  84504. * (Highstock) Whether or not to show the series in the navigator. Takes
  84505. * precedence over navigator.baseSeries if defined.
  84506. */
  84507. showInNavigator?: boolean;
  84508. /**
  84509. * (Highcharts, Highstock) If set to `true`, the accessibility module will
  84510. * skip past the points in this series for keyboard navigation.
  84511. */
  84512. skipKeyboardNavigation?: boolean;
  84513. /**
  84514. * (Highcharts, Highstock) When this is true, the series will not cause the
  84515. * Y axis to cross the zero plane (or threshold option) unless the data
  84516. * actually crosses the plane.
  84517. *
  84518. * For example, if `softThreshold` is `false`, a series of 0, 1, 2, 3 will
  84519. * make the Y axis show negative values according to the `minPadding`
  84520. * option. If `softThreshold` is `true`, the Y axis starts at 0.
  84521. */
  84522. softThreshold?: boolean;
  84523. /**
  84524. * (Highcharts, Highstock) Whether to stack the values of each series on top
  84525. * of each other. Possible values are `undefined` to disable, `"normal"` to
  84526. * stack by value or `"percent"`.
  84527. *
  84528. * When stacking is enabled, data must be sorted in ascending X order.
  84529. *
  84530. * Some stacking options are related to specific series types. In the
  84531. * streamgraph series type, the stacking option is set to `"stream"`. The
  84532. * second one is `"overlap"`, which only applies to waterfall series.
  84533. */
  84534. stacking?: OptionsStackingValue;
  84535. states?: SeriesStatesOptionsObject;
  84536. /**
  84537. * (Highcharts, Highstock) Sticky tracking of mouse events. When true, the
  84538. * `mouseOut` event on a series isn't triggered until the mouse moves over
  84539. * another series, or out of the plot area. When false, the `mouseOut` event
  84540. * on a series is triggered when the mouse leaves the area around the
  84541. * series' graph or markers. This also implies the tooltip when not shared.
  84542. * When `stickyTracking` is false and `tooltip.shared` is false, the tooltip
  84543. * will be hidden when moving the mouse between series. Defaults to true for
  84544. * line and area type series, but to false for columns, pies etc.
  84545. *
  84546. * **Note:** The boost module will force this option because of technical
  84547. * limitations.
  84548. */
  84549. stickyTracking?: boolean;
  84550. /**
  84551. * (Highcharts, Highstock) The Y axis value to serve as the base for the
  84552. * area, for distinguishing between values above and below a threshold. The
  84553. * area between the graph and the threshold is filled.
  84554. *
  84555. * * If a number is given, the Y axis will scale to the threshold.
  84556. *
  84557. * * If `null`, the scaling behaves like a line series with fill between the
  84558. * graph and the Y axis minimum.
  84559. *
  84560. * * If `Infinity` or `-Infinity`, the area between the graph and the
  84561. * corresponding Y axis extreme is filled (since v6.1.0).
  84562. */
  84563. threshold?: (number|null);
  84564. /**
  84565. * (Highcharts, Highstock) A configuration object for the tooltip rendering
  84566. * of each single series. Properties are inherited from tooltip, but only
  84567. * the following properties can be defined on a series level.
  84568. */
  84569. tooltip?: SeriesTooltipOptionsObject;
  84570. /**
  84571. * (Highcharts, Highstock) Whether the whole area or just the line should
  84572. * respond to mouseover tooltips and other mouse or touch events.
  84573. */
  84574. trackByArea?: boolean;
  84575. /**
  84576. * (Highcharts, Highstock, Gantt) When a series contains a data array that
  84577. * is longer than this, only one dimensional arrays of numbers, or two
  84578. * dimensional arrays with x and y values are allowed. Also, only the first
  84579. * point is tested, and the rest are assumed to be the same format. This
  84580. * saves expensive data checking and indexing in long series. Set it to `0`
  84581. * disable.
  84582. *
  84583. * Note: In boost mode turbo threshold is forced. Only array of numbers or
  84584. * two dimensional arrays are allowed.
  84585. */
  84586. turboThreshold?: number;
  84587. /**
  84588. * (Highcharts, Highstock) Set the initial visibility of the series.
  84589. */
  84590. visible?: boolean;
  84591. /**
  84592. * (Highmaps) Define the z index of the series.
  84593. */
  84594. zIndex?: number;
  84595. /**
  84596. * (Highcharts, Highstock) Defines the Axis on which the zones are applied.
  84597. */
  84598. zoneAxis?: string;
  84599. /**
  84600. * (Highcharts, Highstock) An array defining zones within a series. Zones
  84601. * can be applied to the X axis, Y axis or Z axis for bubbles, according to
  84602. * the `zoneAxis` option. The zone definitions have to be in ascending order
  84603. * regarding to the value.
  84604. *
  84605. * In styled mode, the color zones are styled with the
  84606. * `.highcharts-zone-{n}` class, or custom classed from the `className`
  84607. * option (view live demo).
  84608. */
  84609. zones?: Array<SeriesZonesOptionsObject>;
  84610. }
  84611. /**
  84612. * (Highcharts) Enable or disable the initial animation when a series is
  84613. * displayed. The animation can also be set as a configuration object. Please
  84614. * note that this option only applies to the initial animation of the series
  84615. * itself. For other animations, see chart.animation and the animation parameter
  84616. * under the API methods. The following properties are supported:
  84617. *
  84618. * - `defer`: The animation delay time in milliseconds.
  84619. *
  84620. * - `duration`: The duration of the animation in milliseconds.
  84621. *
  84622. * - `easing`: Can be a string reference to an easing function set on the `Math`
  84623. * object or a function. See the _Custom easing function_ demo below.
  84624. *
  84625. * Due to poor performance, animation is disabled in old IE browsers for several
  84626. * chart types.
  84627. */
  84628. export interface PlotSunburstAnimationOptions {
  84629. defer?: number;
  84630. }
  84631. /**
  84632. * (Highcharts, Highstock, Highmaps, Gantt) Enable or disable the initial
  84633. * animation when a series is displayed for the `dataLabels`. The animation can
  84634. * also be set as a configuration object. Please note that this option only
  84635. * applies to the initial animation. For other animations, see chart.animation
  84636. * and the animation parameter under the API methods. The following properties
  84637. * are supported:
  84638. *
  84639. * - `defer`: The animation delay time in milliseconds.
  84640. */
  84641. export interface PlotSunburstDataLabelsAnimationOptions {
  84642. /**
  84643. * (Highcharts, Highstock, Highmaps, Gantt) The animation delay time in
  84644. * milliseconds. Set to `0` renders dataLabel immediately. As `undefined`
  84645. * inherits defer time from the series.animation.defer.
  84646. */
  84647. defer?: number;
  84648. }
  84649. /**
  84650. * (Highcharts) Can set a `colorVariation` on all points which lies on the same
  84651. * level.
  84652. */
  84653. export interface PlotSunburstLevelsColorVariationOptions {
  84654. /**
  84655. * (Highcharts) The key of a color variation. Currently supports
  84656. * `brightness` only.
  84657. */
  84658. key?: string;
  84659. /**
  84660. * (Highcharts) The ending value of a color variation. The last sibling will
  84661. * receive this value.
  84662. */
  84663. to?: number;
  84664. }
  84665. /**
  84666. * (Highcharts, Highstock, Highmaps, Gantt) Enable or disable the initial
  84667. * animation when a series is displayed for the `dataLabels`. The animation can
  84668. * also be set as a configuration object. Please note that this option only
  84669. * applies to the initial animation. For other animations, see chart.animation
  84670. * and the animation parameter under the API methods. The following properties
  84671. * are supported:
  84672. *
  84673. * - `defer`: The animation delay time in milliseconds.
  84674. */
  84675. export interface PlotSunburstLevelsDataLabelsAnimationOptions {
  84676. /**
  84677. * (Highcharts, Highstock, Highmaps, Gantt) The animation delay time in
  84678. * milliseconds. Set to `0` renders dataLabel immediately. As `undefined`
  84679. * inherits defer time from the series.animation.defer.
  84680. */
  84681. defer?: number;
  84682. }
  84683. /**
  84684. * (Highcharts) Determines the width of the ring per level.
  84685. */
  84686. export interface PlotSunburstLevelSizeOptions {
  84687. /**
  84688. * (Highcharts) How to interpret `levelSize.value`.
  84689. *
  84690. * - `percentage` gives a width relative to result of outer radius minus
  84691. * inner radius.
  84692. *
  84693. * - `pixels` gives the ring a fixed width in pixels.
  84694. *
  84695. * - `weight` takes the remaining width after percentage and pixels, and
  84696. * distributes it accross all "weighted" levels. The value relative to the
  84697. * sum of all weights determines the width.
  84698. */
  84699. unit?: OptionsUnitValue;
  84700. /**
  84701. * (Highcharts) The value used for calculating the width of the ring. Its'
  84702. * affect is determined by `levelSize.unit`.
  84703. */
  84704. value?: number;
  84705. }
  84706. /**
  84707. * (Highcharts) Set options on specific levels. Takes precedence over series
  84708. * options, but not point options.
  84709. */
  84710. export interface PlotSunburstLevelsOptions {
  84711. /**
  84712. * (Highcharts) Can set a `borderColor` on all points which lies on the same
  84713. * level.
  84714. */
  84715. borderColor?: ColorString;
  84716. /**
  84717. * (Highcharts) Can set a `borderDashStyle` on all points which lies on the
  84718. * same level.
  84719. */
  84720. borderDashStyle?: DashStyleValue;
  84721. /**
  84722. * (Highcharts) Can set a `borderWidth` on all points which lies on the same
  84723. * level.
  84724. */
  84725. borderWidth?: number;
  84726. /**
  84727. * (Highcharts) Can set a `color` on all points which lies on the same
  84728. * level.
  84729. */
  84730. color?: (ColorString|GradientColorObject|PatternObject);
  84731. /**
  84732. * (Highcharts) Can set a `colorVariation` on all points which lies on the
  84733. * same level.
  84734. */
  84735. colorVariation?: PlotSunburstLevelsColorVariationOptions;
  84736. /**
  84737. * (Highcharts, Highstock, Highmaps, Gantt) Can set `dataLabels` on all
  84738. * points which lies on the same level.
  84739. */
  84740. dataLabels?: (SeriesSunburstDataLabelsOptionsObject|Array<SeriesSunburstDataLabelsOptionsObject>);
  84741. /**
  84742. * (Highcharts) Decides which level takes effect from the options set in the
  84743. * levels object.
  84744. */
  84745. level?: number;
  84746. /**
  84747. * (Highcharts) Can set a `levelSize` on all points which lies on the same
  84748. * level.
  84749. */
  84750. levelSize?: object;
  84751. /**
  84752. * (Highcharts) Can set a `rotation` on all points which lies on the same
  84753. * level.
  84754. */
  84755. rotation?: number;
  84756. /**
  84757. * (Highcharts) Can set a `rotationMode` on all points which lies on the
  84758. * same level.
  84759. */
  84760. rotationMode?: string;
  84761. }
  84762. /**
  84763. * (Highcharts) A Sunburst displays hierarchical data, where a level in the
  84764. * hierarchy is represented by a circle. The center represents the root node of
  84765. * the tree. The visualization bears a resemblance to both treemap and pie
  84766. * charts.
  84767. *
  84768. * In TypeScript the type option must always be set.
  84769. *
  84770. * Configuration options for the series are given in three levels:
  84771. *
  84772. * 1. Options for all series in a chart are defined in the plotOptions.series
  84773. * object.
  84774. *
  84775. * 2. Options for all `sunburst` series are defined in plotOptions.sunburst.
  84776. *
  84777. * 3. Options for one single series are given in the series instance array. (see
  84778. * online documentation for example)
  84779. */
  84780. export interface PlotSunburstOptions {
  84781. /**
  84782. * (Highcharts) Accessibility options for a series.
  84783. */
  84784. accessibility?: SeriesAccessibilityOptionsObject;
  84785. /**
  84786. * (Highcharts) Allow this series' points to be selected by clicking on the
  84787. * graphic (columns, point markers, pie slices, map areas etc).
  84788. *
  84789. * The selected points can be handled by point select and unselect events,
  84790. * or collectively by the getSelectedPoints function.
  84791. *
  84792. * And alternative way of selecting points is through dragging.
  84793. */
  84794. allowPointSelect?: boolean;
  84795. /**
  84796. * (Highcharts) When enabled the user can click on a point which is a parent
  84797. * and zoom in on its children.
  84798. */
  84799. allowTraversingTree?: boolean;
  84800. /**
  84801. * (Highcharts) Enable or disable the initial animation when a series is
  84802. * displayed. The animation can also be set as a configuration object.
  84803. * Please note that this option only applies to the initial animation of the
  84804. * series itself. For other animations, see chart.animation and the
  84805. * animation parameter under the API methods. The following properties are
  84806. * supported:
  84807. *
  84808. * - `defer`: The animation delay time in milliseconds.
  84809. *
  84810. * - `duration`: The duration of the animation in milliseconds.
  84811. *
  84812. * - `easing`: Can be a string reference to an easing function set on the
  84813. * `Math` object or a function. See the _Custom easing function_ demo below.
  84814. *
  84815. * Due to poor performance, animation is disabled in old IE browsers for
  84816. * several chart types.
  84817. */
  84818. animation?: (boolean|PlotSunburstAnimationOptions|Partial<AnimationOptionsObject>);
  84819. /**
  84820. * (Highcharts) The color of the border surrounding each slice. When `null`,
  84821. * the border takes the same color as the slice fill. This can be used
  84822. * together with a `borderWidth` to fill drawing gaps created by
  84823. * antialiazing artefacts in borderless pies.
  84824. *
  84825. * In styled mode, the border stroke is given in the `.highcharts-point`
  84826. * class.
  84827. */
  84828. borderColor?: (ColorString|GradientColorObject|PatternObject);
  84829. /**
  84830. * (Highcharts) The width of the border surrounding each slice.
  84831. *
  84832. * When setting the border width to 0, there may be small gaps between the
  84833. * slices due to SVG antialiasing artefacts. To work around this, keep the
  84834. * border width at 0.5 or 1, but set the `borderColor` to `null` instead.
  84835. *
  84836. * In styled mode, the border stroke width is given in the
  84837. * `.highcharts-point` class.
  84838. */
  84839. borderWidth?: number;
  84840. /**
  84841. * (Highcharts) The center of the sunburst chart relative to the plot area.
  84842. * Can be percentages or pixel values.
  84843. */
  84844. center?: Array<(number|string)>;
  84845. /**
  84846. * (Highcharts) An additional class name to apply to the series' graphical
  84847. * elements. This option does not replace default class names of the
  84848. * graphical element.
  84849. */
  84850. className?: string;
  84851. /**
  84852. * (Highcharts) The color of the pie series. A pie series is represented as
  84853. * an empty circle if the total sum of its values is 0. Use this property to
  84854. * define the color of its border.
  84855. *
  84856. * In styled mode, the color can be defined by the colorIndex option. Also,
  84857. * the series color can be set with the `.highcharts-series`,
  84858. * `.highcharts-color-{n}`, `.highcharts-{type}-series` or
  84859. * `.highcharts-series-{n}` class, or individual classes given by the
  84860. * `className` option.
  84861. */
  84862. color?: (ColorString|GradientColorObject|PatternObject);
  84863. colorByPoint?: boolean;
  84864. /**
  84865. * (Highcharts) Styled mode only. A specific color index to use for the
  84866. * series, so its graphic representations are given the class name
  84867. * `highcharts-color-{n}`.
  84868. */
  84869. colorIndex?: number;
  84870. /**
  84871. * (Highcharts) A series specific or series type specific color set to use
  84872. * instead of the global colors.
  84873. */
  84874. colors?: Array<(ColorString|GradientColorObject|PatternObject)>;
  84875. /**
  84876. * (Highstock) Defines if comparison should start from the first point
  84877. * within the visible range or should start from the first point **before**
  84878. * the range.
  84879. *
  84880. * In other words, this flag determines if first point within the visible
  84881. * range will have 0% (`compareStart=true`) or should have been already
  84882. * calculated according to the previous point (`compareStart=false`).
  84883. */
  84884. compareStart?: boolean;
  84885. /**
  84886. * (Gantt) Override Pathfinder connector options for a series. Requires
  84887. * Highcharts Gantt to be loaded.
  84888. */
  84889. connectors?: SeriesConnectorsOptionsObject;
  84890. /**
  84891. * (Highcharts, Highstock, Gantt) When true, each point or column edge is
  84892. * rounded to its nearest pixel in order to render sharp on screen. In some
  84893. * cases, when there are a lot of densely packed columns, this leads to
  84894. * visible difference in column widths or distance between columns. In these
  84895. * cases, setting `crisp` to `false` may look better, even though each
  84896. * column is rendered blurry.
  84897. */
  84898. crisp?: boolean;
  84899. /**
  84900. * (Highcharts) You can set the cursor to "pointer" if you have click events
  84901. * attached to the series, to signal to the user that the points and lines
  84902. * can be clicked.
  84903. *
  84904. * In styled mode, the series cursor can be set with the same classes as
  84905. * listed under series.color.
  84906. */
  84907. cursor?: (string|CursorValue);
  84908. /**
  84909. * (Highcharts) A reserved subspace to store options and values for
  84910. * customized functionality. Here you can add additional data for your own
  84911. * event callbacks and formatter callbacks.
  84912. */
  84913. custom?: Dictionary<any>;
  84914. /**
  84915. * (Highcharts, Highstock, Highmaps, Gantt) Options for the series data
  84916. * labels, appearing next to each data point.
  84917. *
  84918. * Since v6.2.0, multiple data labels can be applied to each single point by
  84919. * defining them as an array of configs.
  84920. *
  84921. * In styled mode, the data labels can be styled with the
  84922. * `.highcharts-data-label-box` and `.highcharts-data-label` class names
  84923. * (see example).
  84924. */
  84925. dataLabels?: (SeriesSunburstDataLabelsOptionsObject|Array<SeriesSunburstDataLabelsOptionsObject>);
  84926. /**
  84927. * (Highcharts) A description of the series to add to the screen reader
  84928. * information about the series.
  84929. */
  84930. description?: string;
  84931. /**
  84932. * (Highcharts) Enable or disable the mouse tracking for a specific series.
  84933. * This includes point tooltips and click events on graphs and points. For
  84934. * large datasets it improves performance.
  84935. */
  84936. enableMouseTracking?: boolean;
  84937. /**
  84938. * (Highcharts) General event handlers for the series items. These event
  84939. * hooks can also be attached to the series at run time using the
  84940. * `Highcharts.addEvent` function.
  84941. */
  84942. events?: SeriesEventsOptionsObject;
  84943. /**
  84944. * (Highcharts) If the total sum of the pie's values is 0, the series is
  84945. * represented as an empty circle . The `fillColor` option defines the color
  84946. * of that circle. Use pie.borderWidth to set the border thickness.
  84947. */
  84948. fillColor?: (ColorString|GradientColorObject|PatternObject);
  84949. /**
  84950. * (Highcharts) When set to `false` will prevent the series data from being
  84951. * included in any form of data export.
  84952. *
  84953. * Since version 6.0.0 until 7.1.0 the option was existing undocumented as
  84954. * `includeInCSVExport`.
  84955. */
  84956. includeInDataExport?: boolean;
  84957. /**
  84958. * (Highcharts) An array specifying which option maps to which key in the
  84959. * data point array. This makes it convenient to work with unstructured data
  84960. * arrays from different sources.
  84961. */
  84962. keys?: Array<string>;
  84963. /**
  84964. * (Highstock) The line marks the last price from all points.
  84965. */
  84966. lastPrice?: SeriesLastPriceOptionsObject;
  84967. /**
  84968. * (Highstock) The line marks the last price from visible range of points.
  84969. */
  84970. lastVisiblePrice?: SeriesLastVisiblePriceOptionsObject;
  84971. /**
  84972. * (Highcharts) Used together with the levels and `allowDrillToNode`
  84973. * options. When set to false the first level visible when drilling is
  84974. * considered to be level one. Otherwise the level will be the same as the
  84975. * tree structure.
  84976. */
  84977. levelIsConstant?: boolean;
  84978. /**
  84979. * (Highcharts) Set options on specific levels. Takes precedence over series
  84980. * options, but not point options.
  84981. */
  84982. levels?: Array<PlotSunburstLevelsOptions>;
  84983. /**
  84984. * (Highcharts) Determines the width of the ring per level.
  84985. */
  84986. levelSize?: PlotSunburstLevelSizeOptions;
  84987. /**
  84988. * (Highcharts, Highstock, Gantt) The id of another series to link to.
  84989. * Additionally, the value can be ":previous" to link to the previous
  84990. * series. When two series are linked, only the first one appears in the
  84991. * legend. Toggling the visibility of this also toggles the linked series.
  84992. *
  84993. * If master series uses data sorting and linked series does not have its
  84994. * own sorting definition, the linked series will be sorted in the same
  84995. * order as the master one.
  84996. */
  84997. linkedTo?: string;
  84998. /**
  84999. * (Highcharts) Opacity of a series parts: line, fill (e.g. area) and
  85000. * dataLabels.
  85001. */
  85002. opacity?: number;
  85003. /**
  85004. * (Highcharts) Properties for each single point.
  85005. */
  85006. point?: PlotSeriesPointOptions;
  85007. /**
  85008. * (Highcharts) Same as accessibility.pointDescriptionFormatter, but for an
  85009. * individual series. Overrides the chart wide configuration.
  85010. */
  85011. pointDescriptionFormatter?: Function;
  85012. /**
  85013. * (Highcharts) Which point to use as a root in the visualization.
  85014. */
  85015. rootId?: string;
  85016. /**
  85017. * (Highcharts) Whether to select the series initially. If `showCheckbox` is
  85018. * true, the checkbox next to the series name in the legend will be checked
  85019. * for a selected series.
  85020. */
  85021. selected?: boolean;
  85022. /**
  85023. * (Highcharts) Whether to apply a drop shadow to the graph line. Since 2.3
  85024. * the shadow can be an object configuration containing `color`, `offsetX`,
  85025. * `offsetY`, `opacity` and `width`.
  85026. */
  85027. shadow?: (boolean|ShadowOptionsObject);
  85028. /**
  85029. * (Highcharts) If true, a checkbox is displayed next to the legend item to
  85030. * allow selecting the series. The state of the checkbox is determined by
  85031. * the `selected` option.
  85032. */
  85033. showCheckbox?: boolean;
  85034. /**
  85035. * (Highcharts) Whether to display this particular series or series type in
  85036. * the legend. Since 2.1, pies are not shown in the legend by default.
  85037. */
  85038. showInLegend?: boolean;
  85039. /**
  85040. * (Highstock) Whether or not to show the series in the navigator. Takes
  85041. * precedence over navigator.baseSeries if defined.
  85042. */
  85043. showInNavigator?: boolean;
  85044. /**
  85045. * (Highcharts) The diameter of the pie relative to the plot area. Can be a
  85046. * percentage or pixel value. Pixel values are given as integers. The
  85047. * default behaviour (as of 3.0) is to scale to the plot area and give room
  85048. * for data labels within the plot area. slicedOffset is also included in
  85049. * the default size calculation. As a consequence, the size of the pie may
  85050. * vary when points are updated and data labels more around. In that case it
  85051. * is best to set a fixed value, for example `"75%"`.
  85052. */
  85053. size?: (number|string|null);
  85054. /**
  85055. * (Highcharts) If set to `true`, the accessibility module will skip past
  85056. * the points in this series for keyboard navigation.
  85057. */
  85058. skipKeyboardNavigation?: boolean;
  85059. /**
  85060. * (Highcharts) If a point is sliced, moved out from the center, how many
  85061. * pixels should it be moved?.
  85062. */
  85063. slicedOffset?: number;
  85064. /**
  85065. * (Highcharts) The start angle of the pie slices in degrees where 0 is top
  85066. * and 90 right.
  85067. */
  85068. startAngle?: number;
  85069. states?: SeriesStatesOptionsObject;
  85070. /**
  85071. * (Highcharts) Sticky tracking of mouse events. When true, the `mouseOut`
  85072. * event on a series isn't triggered until the mouse moves over another
  85073. * series, or out of the plot area. When false, the `mouseOut` event on a
  85074. * series is triggered when the mouse leaves the area around the series'
  85075. * graph or markers. This also implies the tooltip. When `stickyTracking` is
  85076. * false and `tooltip.shared` is false, the tooltip will be hidden when
  85077. * moving the mouse between series.
  85078. */
  85079. stickyTracking?: boolean;
  85080. /**
  85081. * (Highcharts) A configuration object for the tooltip rendering of each
  85082. * single series. Properties are inherited from tooltip, but only the
  85083. * following properties can be defined on a series level.
  85084. */
  85085. tooltip?: SeriesTooltipOptionsObject;
  85086. /**
  85087. * (Highcharts) Options for the button appearing when traversing down in a
  85088. * treemap.
  85089. */
  85090. traverseUpButton?: PlotSunburstTraverseUpButtonOptions;
  85091. /**
  85092. * (Highstock) The parameter allows setting line series type and use OHLC
  85093. * indicators. Data in OHLC format is required.
  85094. */
  85095. useOhlcData?: boolean;
  85096. /**
  85097. * (Highcharts) Set the initial visibility of the series.
  85098. */
  85099. visible?: boolean;
  85100. /**
  85101. * (Highmaps) Define the z index of the series.
  85102. */
  85103. zIndex?: number;
  85104. }
  85105. /**
  85106. * (Highcharts) Options for the button appearing when traversing down in a
  85107. * treemap.
  85108. */
  85109. export interface PlotSunburstTraverseUpButtonOptions {
  85110. /**
  85111. * (Highcharts) The position of the button.
  85112. */
  85113. position?: PlotSunburstTraverseUpButtonPositionOptions;
  85114. }
  85115. /**
  85116. * (Highcharts) The position of the button.
  85117. */
  85118. export interface PlotSunburstTraverseUpButtonPositionOptions {
  85119. /**
  85120. * (Highcharts) Horizontal alignment of the button.
  85121. */
  85122. align?: AlignValue;
  85123. /**
  85124. * (Highcharts) Vertical alignment of the button.
  85125. */
  85126. verticalAlign?: VerticalAlignValue;
  85127. /**
  85128. * (Highcharts) Horizontal offset of the button.
  85129. */
  85130. x?: number;
  85131. /**
  85132. * (Highcharts) Vertical offset of the button.
  85133. */
  85134. y?: number;
  85135. }
  85136. /**
  85137. * (Highstock) Enable or disable the initial animation when a series is
  85138. * displayed. The animation can also be set as a configuration object. Please
  85139. * note that this option only applies to the initial animation of the series
  85140. * itself. For other animations, see chart.animation and the animation parameter
  85141. * under the API methods. The following properties are supported:
  85142. *
  85143. * - `defer`: The animation delay time in milliseconds.
  85144. *
  85145. * - `duration`: The duration of the animation in milliseconds.
  85146. *
  85147. * - `easing`: Can be a string reference to an easing function set on the `Math`
  85148. * object or a function. See the _Custom easing function_ demo below.
  85149. *
  85150. * Due to poor performance, animation is disabled in old IE browsers for several
  85151. * chart types.
  85152. */
  85153. export interface PlotSupertrendAnimationOptions {
  85154. defer?: number;
  85155. }
  85156. /**
  85157. * (Highstock) The styles for the Supertrend line that intersect main series.
  85158. */
  85159. export interface PlotSupertrendChangeTrendLineOptions {
  85160. styles?: PlotSupertrendChangeTrendLineStylesOptions;
  85161. }
  85162. export interface PlotSupertrendChangeTrendLineStylesOptions {
  85163. /**
  85164. * (Highstock) The dash or dot style of the grid lines. For possible values,
  85165. * see this demonstration.
  85166. */
  85167. dashStyle?: DashStyleValue;
  85168. /**
  85169. * (Highstock) Color of the line.
  85170. */
  85171. lineColor?: ColorString;
  85172. /**
  85173. * (Highstock) Pixel width of the line.
  85174. */
  85175. lineWidth?: number;
  85176. }
  85177. /**
  85178. * (Highcharts, Highstock, Highmaps, Gantt) Enable or disable the initial
  85179. * animation when a series is displayed for the `dataLabels`. The animation can
  85180. * also be set as a configuration object. Please note that this option only
  85181. * applies to the initial animation. For other animations, see chart.animation
  85182. * and the animation parameter under the API methods. The following properties
  85183. * are supported:
  85184. *
  85185. * - `defer`: The animation delay time in milliseconds.
  85186. */
  85187. export interface PlotSupertrendDataLabelsAnimationOptions {
  85188. /**
  85189. * (Highcharts, Highstock, Highmaps, Gantt) The animation delay time in
  85190. * milliseconds. Set to `0` renders dataLabel immediately. As `undefined`
  85191. * inherits defer time from the series.animation.defer.
  85192. */
  85193. defer?: number;
  85194. }
  85195. /**
  85196. * (Highcharts, Highstock, Highmaps, Gantt) Options for the series data labels,
  85197. * appearing next to each data point.
  85198. *
  85199. * Since v6.2.0, multiple data labels can be applied to each single point by
  85200. * defining them as an array of configs.
  85201. *
  85202. * In styled mode, the data labels can be styled with the
  85203. * `.highcharts-data-label-box` and `.highcharts-data-label` class names (see
  85204. * example).
  85205. */
  85206. export interface PlotSupertrendDataLabelsOptions {
  85207. /**
  85208. * (Highcharts, Highstock, Highmaps, Gantt) The alignment of the data label
  85209. * compared to the point. If `right`, the right side of the label should be
  85210. * touching the point. For points with an extent, like columns, the
  85211. * alignments also dictates how to align it inside the box, as given with
  85212. * the inside option. Can be one of `left`, `center` or `right`.
  85213. */
  85214. align?: (AlignValue|null);
  85215. /**
  85216. * (Highcharts, Highstock, Highmaps, Gantt) Whether to allow data labels to
  85217. * overlap. To make the labels less sensitive for overlapping, the
  85218. * dataLabels.padding can be set to 0.
  85219. */
  85220. allowOverlap?: boolean;
  85221. /**
  85222. * (Highcharts, Highstock, Highmaps, Gantt) Enable or disable the initial
  85223. * animation when a series is displayed for the `dataLabels`. The animation
  85224. * can also be set as a configuration object. Please note that this option
  85225. * only applies to the initial animation. For other animations, see
  85226. * chart.animation and the animation parameter under the API methods. The
  85227. * following properties are supported:
  85228. *
  85229. * - `defer`: The animation delay time in milliseconds.
  85230. */
  85231. animation?: (boolean|PlotSupertrendDataLabelsAnimationOptions|Partial<AnimationOptionsObject>);
  85232. /**
  85233. * (Highcharts, Highstock, Highmaps, Gantt) The background color or gradient
  85234. * for the data label.
  85235. */
  85236. backgroundColor?: (ColorString|GradientColorObject|PatternObject);
  85237. /**
  85238. * (Highcharts, Highstock, Highmaps, Gantt) The border color for the data
  85239. * label. Defaults to `undefined`.
  85240. */
  85241. borderColor?: (ColorString|GradientColorObject|PatternObject);
  85242. /**
  85243. * (Highcharts, Highstock, Highmaps, Gantt) The border radius in pixels for
  85244. * the data label.
  85245. */
  85246. borderRadius?: number;
  85247. /**
  85248. * (Highcharts, Highstock, Highmaps, Gantt) The border width in pixels for
  85249. * the data label.
  85250. */
  85251. borderWidth?: number;
  85252. /**
  85253. * (Highcharts, Highstock, Highmaps, Gantt) A class name for the data label.
  85254. * Particularly in styled mode, this can be used to give each series' or
  85255. * point's data label unique styling. In addition to this option, a default
  85256. * color class name is added so that we can give the labels a contrast text
  85257. * shadow.
  85258. */
  85259. className?: string;
  85260. /**
  85261. * (Highcharts, Highstock, Highmaps, Gantt) The text color for the data
  85262. * labels. Defaults to `undefined`. For certain series types, like column or
  85263. * map, the data labels can be drawn inside the points. In this case the
  85264. * data label will be drawn with maximum contrast by default. Additionally,
  85265. * it will be given a `text-outline` style with the opposite color, to
  85266. * further increase the contrast. This can be overridden by setting the
  85267. * `text-outline` style to `none` in the `dataLabels.style` option.
  85268. */
  85269. color?: (ColorString|GradientColorObject|PatternObject);
  85270. /**
  85271. * (Highcharts, Highstock, Highmaps, Gantt) Whether to hide data labels that
  85272. * are outside the plot area. By default, the data label is moved inside the
  85273. * plot area according to the overflow option.
  85274. */
  85275. crop?: boolean;
  85276. /**
  85277. * (Highcharts, Highstock, Gantt) Whether to defer displaying the data
  85278. * labels until the initial series animation has finished. Setting to
  85279. * `false` renders the data label immediately. If set to `true` inherits the
  85280. * defer time set in plotOptions.series.animation.
  85281. */
  85282. defer?: boolean;
  85283. /**
  85284. * (Highcharts, Highstock, Highmaps, Gantt) Enable or disable the data
  85285. * labels.
  85286. */
  85287. enabled?: boolean;
  85288. /**
  85289. * (Highcharts, Highstock, Highmaps, Gantt) A declarative filter to control
  85290. * of which data labels to display. The declarative filter is designed for
  85291. * use when callback functions are not available, like when the chart
  85292. * options require a pure JSON structure or for use with graphical editors.
  85293. * For programmatic control, use the `formatter` instead, and return
  85294. * `undefined` to disable a single data label.
  85295. */
  85296. filter?: DataLabelsFilterOptionsObject;
  85297. /**
  85298. * (Highcharts, Highstock, Highmaps, Gantt) A format string for the data
  85299. * label. Available variables are the same as for `formatter`.
  85300. */
  85301. format?: string;
  85302. /**
  85303. * (Highcharts, Highstock, Highmaps, Gantt) Callback JavaScript function to
  85304. * format the data label. Note that if a `format` is defined, the format
  85305. * takes precedence and the formatter is ignored.
  85306. */
  85307. formatter?: DataLabelsFormatterCallbackFunction;
  85308. /**
  85309. * (Highcharts, Highstock, Highmaps, Gantt) For points with an extent, like
  85310. * columns or map areas, whether to align the data label inside the box or
  85311. * to the actual value point. Defaults to `false` in most cases, `true` in
  85312. * stacked columns.
  85313. */
  85314. inside?: boolean;
  85315. /**
  85316. * (Highcharts, Highstock, Highmaps, Gantt) Format for points with the value
  85317. * of null. Works analogously to format. `nullFormat` can be applied only to
  85318. * series which support displaying null points.
  85319. */
  85320. nullFormat?: (boolean|string);
  85321. /**
  85322. * (Highcharts, Highstock, Highmaps, Gantt) Callback JavaScript function
  85323. * that defines formatting for points with the value of null. Works
  85324. * analogously to formatter. `nullPointFormatter` can be applied only to
  85325. * series which support displaying null points.
  85326. */
  85327. nullFormatter?: DataLabelsFormatterCallbackFunction;
  85328. /**
  85329. * (Highcharts, Highstock, Highmaps, Gantt) How to handle data labels that
  85330. * flow outside the plot area. The default is `"justify"`, which aligns them
  85331. * inside the plot area. For columns and bars, this means it will be moved
  85332. * inside the bar. To display data labels outside the plot area, set `crop`
  85333. * to `false` and `overflow` to `"allow"`.
  85334. */
  85335. overflow?: DataLabelsOverflowValue;
  85336. /**
  85337. * (Highcharts, Highstock, Highmaps, Gantt) When either the `borderWidth` or
  85338. * the `backgroundColor` is set, this is the padding within the box.
  85339. */
  85340. padding?: number;
  85341. /**
  85342. * (Highcharts, Highstock, Highmaps, Gantt) Aligns data labels relative to
  85343. * points. If `center` alignment is not possible, it defaults to `right`.
  85344. */
  85345. position?: AlignValue;
  85346. /**
  85347. * (Highcharts, Highstock, Highmaps, Gantt) Text rotation in degrees. Note
  85348. * that due to a more complex structure, backgrounds, borders and padding
  85349. * will be lost on a rotated data label.
  85350. */
  85351. rotation?: number;
  85352. /**
  85353. * (Highcharts, Highstock, Highmaps, Gantt) The shadow of the box. Works
  85354. * best with `borderWidth` or `backgroundColor`. Since 2.3 the shadow can be
  85355. * an object configuration containing `color`, `offsetX`, `offsetY`,
  85356. * `opacity` and `width`.
  85357. */
  85358. shadow?: (boolean|ShadowOptionsObject);
  85359. /**
  85360. * (Highcharts, Highstock, Highmaps, Gantt) The name of a symbol to use for
  85361. * the border around the label. Symbols are predefined functions on the
  85362. * Renderer object.
  85363. */
  85364. shape?: string;
  85365. /**
  85366. * (Highcharts, Highstock, Highmaps, Gantt) Styles for the label. The
  85367. * default `color` setting is `"contrast"`, which is a pseudo color that
  85368. * Highcharts picks up and applies the maximum contrast to the underlying
  85369. * point item, for example the bar in a bar chart.
  85370. *
  85371. * The `textOutline` is a pseudo property that applies an outline of the
  85372. * given width with the given color, which by default is the maximum
  85373. * contrast to the text. So a bright text color will result in a black text
  85374. * outline for maximum readability on a mixed background. In some cases,
  85375. * especially with grayscale text, the text outline doesn't work well, in
  85376. * which cases it can be disabled by setting it to `"none"`. When `useHTML`
  85377. * is true, the `textOutline` will not be picked up. In this, case, the same
  85378. * effect can be acheived through the `text-shadow` CSS property.
  85379. *
  85380. * For some series types, where each point has an extent, like for example
  85381. * tree maps, the data label may overflow the point. There are two
  85382. * strategies for handling overflow. By default, the text will wrap to
  85383. * multiple lines. The other strategy is to set `style.textOverflow` to
  85384. * `ellipsis`, which will keep the text on one line plus it will break
  85385. * inside long words.
  85386. */
  85387. style?: CSSObject;
  85388. /**
  85389. * (Highcharts, Highstock, Highmaps, Gantt) Options for a label text which
  85390. * should follow marker's shape. Border and background are disabled for a
  85391. * label that follows a path.
  85392. *
  85393. * **Note:** Only SVG-based renderer supports this option. Setting `useHTML`
  85394. * to true will disable this option.
  85395. */
  85396. textPath?: DataLabelsTextPathOptionsObject;
  85397. /**
  85398. * (Highcharts, Highstock, Highmaps, Gantt) Whether to use HTML to render
  85399. * the labels.
  85400. */
  85401. useHTML?: boolean;
  85402. /**
  85403. * (Highcharts, Highstock, Highmaps, Gantt) The vertical alignment of a data
  85404. * label. Can be one of `top`, `middle` or `bottom`. The default value
  85405. * depends on the data, for instance in a column chart, the label is above
  85406. * positive values and below negative values.
  85407. */
  85408. verticalAlign?: (VerticalAlignValue|null);
  85409. /**
  85410. * (Highcharts, Highstock, Highmaps, Gantt) The x position offset of the
  85411. * label relative to the point in pixels.
  85412. */
  85413. x?: number;
  85414. /**
  85415. * (Highcharts, Highstock, Highmaps, Gantt) The y position offset of the
  85416. * label relative to the point in pixels.
  85417. */
  85418. y?: number;
  85419. /**
  85420. * (Highcharts, Highstock, Highmaps, Gantt) The Z index of the data labels.
  85421. * The default Z index puts it above the series. Use a Z index of 2 to
  85422. * display it behind the series.
  85423. */
  85424. z?: number;
  85425. }
  85426. /**
  85427. * (Highcharts, Highstock) Options for the series data sorting.
  85428. */
  85429. export interface PlotSupertrendDataSortingOptions {
  85430. /**
  85431. * (Highcharts, Highstock) Enable or disable data sorting for the series.
  85432. * Use xAxis.reversed to change the sorting order.
  85433. */
  85434. enabled?: boolean;
  85435. /**
  85436. * (Highcharts, Highstock) Whether to allow matching points by name in an
  85437. * update. If this option is disabled, points will be matched by order.
  85438. */
  85439. matchByName?: boolean;
  85440. /**
  85441. * (Highcharts, Highstock) Determines what data value should be used to sort
  85442. * by.
  85443. */
  85444. sortKey?: string;
  85445. }
  85446. /**
  85447. * (Highstock) Supertrend indicator. This series requires the `linkedTo` option
  85448. * to be set and should be loaded after the `stock/indicators/indicators.js` and
  85449. * `stock/indicators/sma.js`.
  85450. *
  85451. * In TypeScript the type option must always be set.
  85452. *
  85453. * Configuration options for the series are given in three levels:
  85454. *
  85455. * 1. Options for all series in a chart are defined in the plotOptions.series
  85456. * object.
  85457. *
  85458. * 2. Options for all `supertrend` series are defined in plotOptions.supertrend.
  85459. *
  85460. * 3. Options for one single series are given in the series instance array. (see
  85461. * online documentation for example)
  85462. */
  85463. export interface PlotSupertrendOptions {
  85464. /**
  85465. * (Highstock) Accessibility options for a series.
  85466. */
  85467. accessibility?: SeriesAccessibilityOptionsObject;
  85468. /**
  85469. * (Highstock) Allow this series' points to be selected by clicking on the
  85470. * graphic (columns, point markers, pie slices, map areas etc).
  85471. *
  85472. * The selected points can be handled by point select and unselect events,
  85473. * or collectively by the getSelectedPoints function.
  85474. *
  85475. * And alternative way of selecting points is through dragging.
  85476. */
  85477. allowPointSelect?: boolean;
  85478. /**
  85479. * (Highstock) Enable or disable the initial animation when a series is
  85480. * displayed. The animation can also be set as a configuration object.
  85481. * Please note that this option only applies to the initial animation of the
  85482. * series itself. For other animations, see chart.animation and the
  85483. * animation parameter under the API methods. The following properties are
  85484. * supported:
  85485. *
  85486. * - `defer`: The animation delay time in milliseconds.
  85487. *
  85488. * - `duration`: The duration of the animation in milliseconds.
  85489. *
  85490. * - `easing`: Can be a string reference to an easing function set on the
  85491. * `Math` object or a function. See the _Custom easing function_ demo below.
  85492. *
  85493. * Due to poor performance, animation is disabled in old IE browsers for
  85494. * several chart types.
  85495. */
  85496. animation?: (boolean|PlotSupertrendAnimationOptions|Partial<AnimationOptionsObject>);
  85497. /**
  85498. * (Highstock) For some series, there is a limit that shuts down initial
  85499. * animation by default when the total number of points in the chart is too
  85500. * high. For example, for a column chart and its derivatives, animation does
  85501. * not run if there is more than 250 points totally. To disable this cap,
  85502. * set `animationLimit` to `Infinity`.
  85503. */
  85504. animationLimit?: number;
  85505. /**
  85506. * (Highstock) Sets the color blending in the boost module.
  85507. */
  85508. boostBlending?: OptionsBoostBlendingValue;
  85509. /**
  85510. * (Highstock) Set the point threshold for when a series should enter boost
  85511. * mode.
  85512. *
  85513. * Setting it to e.g. 2000 will cause the series to enter boost mode when
  85514. * there are 2000 or more points in the series.
  85515. *
  85516. * To disable boosting on the series, set the `boostThreshold` to 0. Setting
  85517. * it to 1 will force boosting.
  85518. *
  85519. * Note that the cropThreshold also affects this setting. When zooming in on
  85520. * a series that has fewer points than the `cropThreshold`, all points are
  85521. * rendered although outside the visible plot area, and the `boostThreshold`
  85522. * won't take effect.
  85523. */
  85524. boostThreshold?: number;
  85525. /**
  85526. * (Highmaps) The border color of the map areas.
  85527. *
  85528. * In styled mode, the border stroke is given in the `.highcharts-point`
  85529. * class.
  85530. */
  85531. borderColor?: (ColorString|GradientColorObject|PatternObject);
  85532. /**
  85533. * (Highmaps) The border width of each map area.
  85534. *
  85535. * In styled mode, the border stroke width is given in the
  85536. * `.highcharts-point` class.
  85537. */
  85538. borderWidth?: number;
  85539. /**
  85540. * (Highstock) The styles for the Supertrend line that intersect main
  85541. * series.
  85542. */
  85543. changeTrendLine?: PlotSupertrendChangeTrendLineOptions;
  85544. /**
  85545. * (Highstock) An additional class name to apply to the series' graphical
  85546. * elements. This option does not replace default class names of the
  85547. * graphical element.
  85548. */
  85549. className?: string;
  85550. /**
  85551. * (Highstock) Disable this option to allow series rendering in the whole
  85552. * plotting area.
  85553. *
  85554. * **Note:** Clipping should be always enabled when chart.zoomType is set
  85555. */
  85556. clip?: boolean;
  85557. /**
  85558. * (Highstock) The main color of the series. In line type series it applies
  85559. * to the line and the point markers unless otherwise specified. In bar type
  85560. * series it applies to the bars unless a color is specified per point. The
  85561. * default value is pulled from the `options.colors` array.
  85562. *
  85563. * In styled mode, the color can be defined by the colorIndex option. Also,
  85564. * the series color can be set with the `.highcharts-series`,
  85565. * `.highcharts-color-{n}`, `.highcharts-{type}-series` or
  85566. * `.highcharts-series-{n}` class, or individual classes given by the
  85567. * `className` option.
  85568. */
  85569. color?: (ColorString|GradientColorObject|PatternObject);
  85570. /**
  85571. * (Highstock) Styled mode only. A specific color index to use for the
  85572. * series, so its graphic representations are given the class name
  85573. * `highcharts-color-{n}`.
  85574. */
  85575. colorIndex?: number;
  85576. /**
  85577. * (Highcharts, Highstock, Highmaps) Determines what data value should be
  85578. * used to calculate point color if `colorAxis` is used. Requires to set
  85579. * `min` and `max` if some custom point property is used or if approximation
  85580. * for data grouping is set to `'sum'`.
  85581. */
  85582. colorKey?: string;
  85583. /**
  85584. * (Highstock) Compare the values of the series against the first non-null,
  85585. * non- zero value in the visible range. The y axis will show percentage or
  85586. * absolute change depending on whether `compare` is set to `"percent"` or
  85587. * `"value"`. When this is applied to multiple series, it allows comparing
  85588. * the development of the series against each other. Adds a `change` field
  85589. * to every point object.
  85590. */
  85591. compare?: string;
  85592. /**
  85593. * (Highstock) When compare is `percent`, this option dictates whether to
  85594. * use 0 or 100 as the base of comparison.
  85595. */
  85596. compareBase?: (0|100);
  85597. /**
  85598. * (Highstock) Defines if comparison should start from the first point
  85599. * within the visible range or should start from the first point **before**
  85600. * the range.
  85601. *
  85602. * In other words, this flag determines if first point within the visible
  85603. * range will have 0% (`compareStart=true`) or should have been already
  85604. * calculated according to the previous point (`compareStart=false`).
  85605. */
  85606. compareStart?: boolean;
  85607. /**
  85608. * (Highstock) Whether to compare indicator to the main series values or
  85609. * indicator values.
  85610. */
  85611. compareToMain?: boolean;
  85612. /**
  85613. * (Highcharts) Polar charts only. Whether to connect the ends of a line
  85614. * series plot across the extremes.
  85615. */
  85616. connectEnds?: boolean;
  85617. /**
  85618. * (Highcharts, Highstock) Whether to connect a graph line across null
  85619. * points, or render a gap between the two points on either side of the
  85620. * null.
  85621. */
  85622. connectNulls?: boolean;
  85623. /**
  85624. * (Gantt) Override Pathfinder connector options for a series. Requires
  85625. * Highcharts Gantt to be loaded.
  85626. */
  85627. connectors?: SeriesConnectorsOptionsObject;
  85628. /**
  85629. * (Highcharts, Highstock, Gantt) When true, each point or column edge is
  85630. * rounded to its nearest pixel in order to render sharp on screen. In some
  85631. * cases, when there are a lot of densely packed columns, this leads to
  85632. * visible difference in column widths or distance between columns. In these
  85633. * cases, setting `crisp` to `false` may look better, even though each
  85634. * column is rendered blurry.
  85635. */
  85636. crisp?: boolean;
  85637. /**
  85638. * (Highstock) You can set the cursor to "pointer" if you have click events
  85639. * attached to the series, to signal to the user that the points and lines
  85640. * can be clicked.
  85641. *
  85642. * In styled mode, the series cursor can be set with the same classes as
  85643. * listed under series.color.
  85644. */
  85645. cursor?: (string|CursorValue);
  85646. /**
  85647. * (Highstock) A reserved subspace to store options and values for
  85648. * customized functionality. Here you can add additional data for your own
  85649. * event callbacks and formatter callbacks.
  85650. */
  85651. custom?: Dictionary<any>;
  85652. /**
  85653. * (Highstock) Name of the dash style to use for the graph, or for some
  85654. * series types the outline of each shape.
  85655. *
  85656. * In styled mode, the stroke dash-array can be set with the same classes as
  85657. * listed under series.color.
  85658. */
  85659. dashStyle?: DashStyleValue;
  85660. /**
  85661. * (Highstock) Data grouping is the concept of sampling the data values into
  85662. * larger blocks in order to ease readability and increase performance of
  85663. * the JavaScript charts. Highstock by default applies data grouping when
  85664. * the points become closer than a certain pixel value, determined by the
  85665. * `groupPixelWidth` option.
  85666. *
  85667. * If data grouping is applied, the grouping information of grouped points
  85668. * can be read from the Point.dataGroup. If point options other than the
  85669. * data itself are set, for example `name` or `color` or custom properties,
  85670. * the grouping logic doesn't know how to group it. In this case the options
  85671. * of the first point instance are copied over to the group point. This can
  85672. * be altered through a custom `approximation` callback function.
  85673. */
  85674. dataGrouping?: DataGroupingOptionsObject;
  85675. /**
  85676. * (Highcharts, Highstock, Highmaps, Gantt) Options for the series data
  85677. * labels, appearing next to each data point.
  85678. *
  85679. * Since v6.2.0, multiple data labels can be applied to each single point by
  85680. * defining them as an array of configs.
  85681. *
  85682. * In styled mode, the data labels can be styled with the
  85683. * `.highcharts-data-label-box` and `.highcharts-data-label` class names
  85684. * (see example).
  85685. */
  85686. dataLabels?: (PlotSupertrendDataLabelsOptions|Array<PlotSupertrendDataLabelsOptions>);
  85687. /**
  85688. * (Highcharts, Highstock) Options for the series data sorting.
  85689. */
  85690. dataSorting?: (DataSortingOptionsObject|PlotSupertrendDataSortingOptions);
  85691. /**
  85692. * (Highstock) A description of the series to add to the screen reader
  85693. * information about the series.
  85694. */
  85695. description?: string;
  85696. /**
  85697. * (Highstock) Enable or disable the mouse tracking for a specific series.
  85698. * This includes point tooltips and click events on graphs and points. For
  85699. * large datasets it improves performance.
  85700. */
  85701. enableMouseTracking?: boolean;
  85702. /**
  85703. * (Highstock) General event handlers for the series items. These event
  85704. * hooks can also be attached to the series at run time using the
  85705. * `Highcharts.addEvent` function.
  85706. */
  85707. events?: SeriesEventsOptionsObject;
  85708. /**
  85709. * (Highstock) Color of the Supertrend series line that is above the main
  85710. * series.
  85711. */
  85712. fallingTrendColor?: (ColorString|GradientColorObject|PatternObject);
  85713. /**
  85714. * (Highstock) Determines whether the series should look for the nearest
  85715. * point in both dimensions or just the x-dimension when hovering the
  85716. * series. Defaults to `'xy'` for scatter series and `'x'` for most other
  85717. * series. If the data has duplicate x-values, it is recommended to set this
  85718. * to `'xy'` to allow hovering over all points.
  85719. *
  85720. * Applies only to series types using nearest neighbor search (not direct
  85721. * hover) for tooltip.
  85722. */
  85723. findNearestPointBy?: OptionsFindNearestPointByValue;
  85724. /**
  85725. * (Highstock) Defines when to display a gap in the graph, together with the
  85726. * gapUnit option.
  85727. *
  85728. * In case when `dataGrouping` is enabled, points can be grouped into a
  85729. * larger time span. This can make the grouped points to have a greater
  85730. * distance than the absolute value of `gapSize` property, which will result
  85731. * in disappearing graph completely. To prevent this situation the mentioned
  85732. * distance between grouped points is used instead of previously defined
  85733. * `gapSize`.
  85734. *
  85735. * In practice, this option is most often used to visualize gaps in time
  85736. * series. In a stock chart, intraday data is available for daytime hours,
  85737. * while gaps will appear in nights and weekends.
  85738. */
  85739. gapSize?: number;
  85740. /**
  85741. * (Highstock) Together with gapSize, this option defines where to draw gaps
  85742. * in the graph.
  85743. *
  85744. * When the `gapUnit` is `"relative"` (default), a gap size of 5 means that
  85745. * if the distance between two points is greater than 5 times that of the
  85746. * two closest points, the graph will be broken.
  85747. *
  85748. * When the `gapUnit` is `"value"`, the gap is based on absolute axis
  85749. * values, which on a datetime axis is milliseconds. This also applies to
  85750. * the navigator series that inherits gap options from the base series.
  85751. */
  85752. gapUnit?: OptionsGapUnitValue;
  85753. /**
  85754. * (Highcharts, Highstock, Gantt) Whether to use the Y extremes of the total
  85755. * chart width or only the zoomed area when zooming in on parts of the X
  85756. * axis. By default, the Y axis adjusts to the min and max of the visible
  85757. * data. Cartesian series only.
  85758. */
  85759. getExtremesFromAll?: boolean;
  85760. /**
  85761. * (Highstock) When set to `false` will prevent the series data from being
  85762. * included in any form of data export.
  85763. *
  85764. * Since version 6.0.0 until 7.1.0 the option was existing undocumented as
  85765. * `includeInCSVExport`.
  85766. */
  85767. includeInDataExport?: boolean;
  85768. /**
  85769. * (Highcharts, Highstock, Gantt) Series labels are placed as close to the
  85770. * series as possible in a natural way, seeking to avoid other series. The
  85771. * goal of this feature is to make the chart more easily readable, like if a
  85772. * human designer placed the labels in the optimal position.
  85773. *
  85774. * The series labels currently work with series types having a `graph` or an
  85775. * `area`.
  85776. */
  85777. label?: SeriesLabelOptionsObject;
  85778. /**
  85779. * (Highstock) The line marks the last price from all points.
  85780. */
  85781. lastPrice?: SeriesLastPriceOptionsObject;
  85782. /**
  85783. * (Highstock) The line marks the last price from visible range of points.
  85784. */
  85785. lastVisiblePrice?: SeriesLastVisiblePriceOptionsObject;
  85786. /**
  85787. * (Highcharts, Highstock) The SVG value used for the `stroke-linecap` and
  85788. * `stroke-linejoin` of a line graph. Round means that lines are rounded in
  85789. * the ends and bends.
  85790. */
  85791. linecap?: SeriesLinecapValue;
  85792. /**
  85793. * (Highcharts, Highstock) Pixel width of the graph line.
  85794. */
  85795. lineWidth?: number;
  85796. /**
  85797. * (Highcharts, Highstock, Gantt) The main series ID that indicator will be
  85798. * based on. Required for this indicator.
  85799. */
  85800. linkedTo?: string;
  85801. /**
  85802. * (Highstock) Options for the point markers of line-like series. Properties
  85803. * like `fillColor`, `lineColor` and `lineWidth` define the visual
  85804. * appearance of the markers. Other series types, like column series, don't
  85805. * have markers, but have visual options on the series level instead.
  85806. *
  85807. * In styled mode, the markers can be styled with the `.highcharts-point`,
  85808. * `.highcharts-point-hover` and `.highcharts-point-select` class names.
  85809. */
  85810. marker?: PointMarkerOptionsObject;
  85811. /**
  85812. * (Highstock) The name of the series as shown in the legend, tooltip etc.
  85813. * If not set, it will be based on a technical indicator type and default
  85814. * params.
  85815. */
  85816. name?: string;
  85817. /**
  85818. * (Highstock) Opacity of a series parts: line, fill (e.g. area) and
  85819. * dataLabels.
  85820. */
  85821. opacity?: number;
  85822. /**
  85823. * (Highstock) Paramters used in calculation of Supertrend indicator series
  85824. * points.
  85825. */
  85826. params?: PlotSupertrendParamsOptions;
  85827. /**
  85828. * (Highstock) Properties for each single point.
  85829. */
  85830. point?: PlotSeriesPointOptions;
  85831. /**
  85832. * (Highstock) Same as accessibility.pointDescriptionFormatter, but for an
  85833. * individual series. Overrides the chart wide configuration.
  85834. */
  85835. pointDescriptionFormatter?: Function;
  85836. /**
  85837. * (Highstock) Color of the Supertrend series line that is beneath the main
  85838. * series.
  85839. */
  85840. risingTrendColor?: (ColorString|GradientColorObject|PatternObject);
  85841. /**
  85842. * (Highstock) Whether to select the series initially. If `showCheckbox` is
  85843. * true, the checkbox next to the series name in the legend will be checked
  85844. * for a selected series.
  85845. */
  85846. selected?: boolean;
  85847. /**
  85848. * (Highstock) Whether to apply a drop shadow to the graph line. Since 2.3
  85849. * the shadow can be an object configuration containing `color`, `offsetX`,
  85850. * `offsetY`, `opacity` and `width`.
  85851. */
  85852. shadow?: (boolean|ShadowOptionsObject);
  85853. /**
  85854. * (Highstock) If true, a checkbox is displayed next to the legend item to
  85855. * allow selecting the series. The state of the checkbox is determined by
  85856. * the `selected` option.
  85857. */
  85858. showCheckbox?: boolean;
  85859. /**
  85860. * (Highstock) Whether to display this particular series or series type in
  85861. * the legend. Standalone series are shown in legend by default, and linked
  85862. * series are not. Since v7.2.0 it is possible to show series that use
  85863. * colorAxis by setting this option to `true`.
  85864. */
  85865. showInLegend?: boolean;
  85866. /**
  85867. * (Highstock) If set to `true`, the accessibility module will skip past the
  85868. * points in this series for keyboard navigation.
  85869. */
  85870. skipKeyboardNavigation?: boolean;
  85871. /**
  85872. * (Highcharts, Highstock) When this is true, the series will not cause the
  85873. * Y axis to cross the zero plane (or threshold option) unless the data
  85874. * actually crosses the plane.
  85875. *
  85876. * For example, if `softThreshold` is `false`, a series of 0, 1, 2, 3 will
  85877. * make the Y axis show negative values according to the `minPadding`
  85878. * option. If `softThreshold` is `true`, the Y axis starts at 0.
  85879. */
  85880. softThreshold?: boolean;
  85881. states?: SeriesStatesOptionsObject;
  85882. /**
  85883. * (Highcharts, Highstock) Whether to apply steps to the line. Possible
  85884. * values are `left`, `center` and `right`.
  85885. */
  85886. step?: OptionsStepValue;
  85887. /**
  85888. * (Highstock) Sticky tracking of mouse events. When true, the `mouseOut`
  85889. * event on a series isn't triggered until the mouse moves over another
  85890. * series, or out of the plot area. When false, the `mouseOut` event on a
  85891. * series is triggered when the mouse leaves the area around the series'
  85892. * graph or markers. This also implies the tooltip when not shared. When
  85893. * `stickyTracking` is false and `tooltip.shared` is false, the tooltip will
  85894. * be hidden when moving the mouse between series. Defaults to true for line
  85895. * and area type series, but to false for columns, pies etc.
  85896. *
  85897. * **Note:** The boost module will force this option because of technical
  85898. * limitations.
  85899. */
  85900. stickyTracking?: boolean;
  85901. /**
  85902. * (Highstock) A configuration object for the tooltip rendering of each
  85903. * single series. Properties are inherited from tooltip, but only the
  85904. * following properties can be defined on a series level.
  85905. */
  85906. tooltip?: SeriesTooltipOptionsObject;
  85907. /**
  85908. * (Highcharts, Highstock, Gantt) When a series contains a data array that
  85909. * is longer than this, only one dimensional arrays of numbers, or two
  85910. * dimensional arrays with x and y values are allowed. Also, only the first
  85911. * point is tested, and the rest are assumed to be the same format. This
  85912. * saves expensive data checking and indexing in long series. Set it to `0`
  85913. * disable.
  85914. *
  85915. * Note: In boost mode turbo threshold is forced. Only array of numbers or
  85916. * two dimensional arrays are allowed.
  85917. */
  85918. turboThreshold?: number;
  85919. /**
  85920. * (Highstock) Set the initial visibility of the series.
  85921. */
  85922. visible?: boolean;
  85923. /**
  85924. * (Highmaps) Define the z index of the series.
  85925. */
  85926. zIndex?: number;
  85927. /**
  85928. * (Highcharts, Highstock) Defines the Axis on which the zones are applied.
  85929. */
  85930. zoneAxis?: string;
  85931. /**
  85932. * (Highcharts, Highstock) An array defining zones within a series. Zones
  85933. * can be applied to the X axis, Y axis or Z axis for bubbles, according to
  85934. * the `zoneAxis` option. The zone definitions have to be in ascending order
  85935. * regarding to the value.
  85936. *
  85937. * In styled mode, the color zones are styled with the
  85938. * `.highcharts-zone-{n}` class, or custom classed from the `className`
  85939. * option (view live demo).
  85940. */
  85941. zones?: Array<SeriesZonesOptionsObject>;
  85942. }
  85943. /**
  85944. * (Highstock) Paramters used in calculation of Supertrend indicator series
  85945. * points.
  85946. */
  85947. export interface PlotSupertrendParamsOptions {
  85948. /**
  85949. * (Highstock) Multiplier for Supertrend Indicator.
  85950. */
  85951. multiplier?: number;
  85952. /**
  85953. * (Highstock) The base period for indicator Supertrend Indicator
  85954. * calculations. This is the number of data points which are taken into
  85955. * account for the indicator calculations.
  85956. */
  85957. period?: number;
  85958. }
  85959. /**
  85960. * (Highstock) Enable or disable the initial animation when a series is
  85961. * displayed. The animation can also be set as a configuration object. Please
  85962. * note that this option only applies to the initial animation of the series
  85963. * itself. For other animations, see chart.animation and the animation parameter
  85964. * under the API methods. The following properties are supported:
  85965. *
  85966. * - `defer`: The animation delay time in milliseconds.
  85967. *
  85968. * - `duration`: The duration of the animation in milliseconds.
  85969. *
  85970. * - `easing`: Can be a string reference to an easing function set on the `Math`
  85971. * object or a function. See the _Custom easing function_ demo below.
  85972. *
  85973. * Due to poor performance, animation is disabled in old IE browsers for several
  85974. * chart types.
  85975. */
  85976. export interface PlotTemaAnimationOptions {
  85977. defer?: number;
  85978. }
  85979. /**
  85980. * (Highcharts, Highstock, Highmaps, Gantt) Enable or disable the initial
  85981. * animation when a series is displayed for the `dataLabels`. The animation can
  85982. * also be set as a configuration object. Please note that this option only
  85983. * applies to the initial animation. For other animations, see chart.animation
  85984. * and the animation parameter under the API methods. The following properties
  85985. * are supported:
  85986. *
  85987. * - `defer`: The animation delay time in milliseconds.
  85988. */
  85989. export interface PlotTemaDataLabelsAnimationOptions {
  85990. /**
  85991. * (Highcharts, Highstock, Highmaps, Gantt) The animation delay time in
  85992. * milliseconds. Set to `0` renders dataLabel immediately. As `undefined`
  85993. * inherits defer time from the series.animation.defer.
  85994. */
  85995. defer?: number;
  85996. }
  85997. /**
  85998. * (Highcharts, Highstock, Highmaps, Gantt) Options for the series data labels,
  85999. * appearing next to each data point.
  86000. *
  86001. * Since v6.2.0, multiple data labels can be applied to each single point by
  86002. * defining them as an array of configs.
  86003. *
  86004. * In styled mode, the data labels can be styled with the
  86005. * `.highcharts-data-label-box` and `.highcharts-data-label` class names (see
  86006. * example).
  86007. */
  86008. export interface PlotTemaDataLabelsOptions {
  86009. /**
  86010. * (Highcharts, Highstock, Highmaps, Gantt) The alignment of the data label
  86011. * compared to the point. If `right`, the right side of the label should be
  86012. * touching the point. For points with an extent, like columns, the
  86013. * alignments also dictates how to align it inside the box, as given with
  86014. * the inside option. Can be one of `left`, `center` or `right`.
  86015. */
  86016. align?: (AlignValue|null);
  86017. /**
  86018. * (Highcharts, Highstock, Highmaps, Gantt) Whether to allow data labels to
  86019. * overlap. To make the labels less sensitive for overlapping, the
  86020. * dataLabels.padding can be set to 0.
  86021. */
  86022. allowOverlap?: boolean;
  86023. /**
  86024. * (Highcharts, Highstock, Highmaps, Gantt) Enable or disable the initial
  86025. * animation when a series is displayed for the `dataLabels`. The animation
  86026. * can also be set as a configuration object. Please note that this option
  86027. * only applies to the initial animation. For other animations, see
  86028. * chart.animation and the animation parameter under the API methods. The
  86029. * following properties are supported:
  86030. *
  86031. * - `defer`: The animation delay time in milliseconds.
  86032. */
  86033. animation?: (boolean|PlotTemaDataLabelsAnimationOptions|Partial<AnimationOptionsObject>);
  86034. /**
  86035. * (Highcharts, Highstock, Highmaps, Gantt) The background color or gradient
  86036. * for the data label.
  86037. */
  86038. backgroundColor?: (ColorString|GradientColorObject|PatternObject);
  86039. /**
  86040. * (Highcharts, Highstock, Highmaps, Gantt) The border color for the data
  86041. * label. Defaults to `undefined`.
  86042. */
  86043. borderColor?: (ColorString|GradientColorObject|PatternObject);
  86044. /**
  86045. * (Highcharts, Highstock, Highmaps, Gantt) The border radius in pixels for
  86046. * the data label.
  86047. */
  86048. borderRadius?: number;
  86049. /**
  86050. * (Highcharts, Highstock, Highmaps, Gantt) The border width in pixels for
  86051. * the data label.
  86052. */
  86053. borderWidth?: number;
  86054. /**
  86055. * (Highcharts, Highstock, Highmaps, Gantt) A class name for the data label.
  86056. * Particularly in styled mode, this can be used to give each series' or
  86057. * point's data label unique styling. In addition to this option, a default
  86058. * color class name is added so that we can give the labels a contrast text
  86059. * shadow.
  86060. */
  86061. className?: string;
  86062. /**
  86063. * (Highcharts, Highstock, Highmaps, Gantt) The text color for the data
  86064. * labels. Defaults to `undefined`. For certain series types, like column or
  86065. * map, the data labels can be drawn inside the points. In this case the
  86066. * data label will be drawn with maximum contrast by default. Additionally,
  86067. * it will be given a `text-outline` style with the opposite color, to
  86068. * further increase the contrast. This can be overridden by setting the
  86069. * `text-outline` style to `none` in the `dataLabels.style` option.
  86070. */
  86071. color?: (ColorString|GradientColorObject|PatternObject);
  86072. /**
  86073. * (Highcharts, Highstock, Highmaps, Gantt) Whether to hide data labels that
  86074. * are outside the plot area. By default, the data label is moved inside the
  86075. * plot area according to the overflow option.
  86076. */
  86077. crop?: boolean;
  86078. /**
  86079. * (Highcharts, Highstock, Gantt) Whether to defer displaying the data
  86080. * labels until the initial series animation has finished. Setting to
  86081. * `false` renders the data label immediately. If set to `true` inherits the
  86082. * defer time set in plotOptions.series.animation.
  86083. */
  86084. defer?: boolean;
  86085. /**
  86086. * (Highcharts, Highstock, Highmaps, Gantt) Enable or disable the data
  86087. * labels.
  86088. */
  86089. enabled?: boolean;
  86090. /**
  86091. * (Highcharts, Highstock, Highmaps, Gantt) A declarative filter to control
  86092. * of which data labels to display. The declarative filter is designed for
  86093. * use when callback functions are not available, like when the chart
  86094. * options require a pure JSON structure or for use with graphical editors.
  86095. * For programmatic control, use the `formatter` instead, and return
  86096. * `undefined` to disable a single data label.
  86097. */
  86098. filter?: DataLabelsFilterOptionsObject;
  86099. /**
  86100. * (Highcharts, Highstock, Highmaps, Gantt) A format string for the data
  86101. * label. Available variables are the same as for `formatter`.
  86102. */
  86103. format?: string;
  86104. /**
  86105. * (Highcharts, Highstock, Highmaps, Gantt) Callback JavaScript function to
  86106. * format the data label. Note that if a `format` is defined, the format
  86107. * takes precedence and the formatter is ignored.
  86108. */
  86109. formatter?: DataLabelsFormatterCallbackFunction;
  86110. /**
  86111. * (Highcharts, Highstock, Highmaps, Gantt) For points with an extent, like
  86112. * columns or map areas, whether to align the data label inside the box or
  86113. * to the actual value point. Defaults to `false` in most cases, `true` in
  86114. * stacked columns.
  86115. */
  86116. inside?: boolean;
  86117. /**
  86118. * (Highcharts, Highstock, Highmaps, Gantt) Format for points with the value
  86119. * of null. Works analogously to format. `nullFormat` can be applied only to
  86120. * series which support displaying null points.
  86121. */
  86122. nullFormat?: (boolean|string);
  86123. /**
  86124. * (Highcharts, Highstock, Highmaps, Gantt) Callback JavaScript function
  86125. * that defines formatting for points with the value of null. Works
  86126. * analogously to formatter. `nullPointFormatter` can be applied only to
  86127. * series which support displaying null points.
  86128. */
  86129. nullFormatter?: DataLabelsFormatterCallbackFunction;
  86130. /**
  86131. * (Highcharts, Highstock, Highmaps, Gantt) How to handle data labels that
  86132. * flow outside the plot area. The default is `"justify"`, which aligns them
  86133. * inside the plot area. For columns and bars, this means it will be moved
  86134. * inside the bar. To display data labels outside the plot area, set `crop`
  86135. * to `false` and `overflow` to `"allow"`.
  86136. */
  86137. overflow?: DataLabelsOverflowValue;
  86138. /**
  86139. * (Highcharts, Highstock, Highmaps, Gantt) When either the `borderWidth` or
  86140. * the `backgroundColor` is set, this is the padding within the box.
  86141. */
  86142. padding?: number;
  86143. /**
  86144. * (Highcharts, Highstock, Highmaps, Gantt) Aligns data labels relative to
  86145. * points. If `center` alignment is not possible, it defaults to `right`.
  86146. */
  86147. position?: AlignValue;
  86148. /**
  86149. * (Highcharts, Highstock, Highmaps, Gantt) Text rotation in degrees. Note
  86150. * that due to a more complex structure, backgrounds, borders and padding
  86151. * will be lost on a rotated data label.
  86152. */
  86153. rotation?: number;
  86154. /**
  86155. * (Highcharts, Highstock, Highmaps, Gantt) The shadow of the box. Works
  86156. * best with `borderWidth` or `backgroundColor`. Since 2.3 the shadow can be
  86157. * an object configuration containing `color`, `offsetX`, `offsetY`,
  86158. * `opacity` and `width`.
  86159. */
  86160. shadow?: (boolean|ShadowOptionsObject);
  86161. /**
  86162. * (Highcharts, Highstock, Highmaps, Gantt) The name of a symbol to use for
  86163. * the border around the label. Symbols are predefined functions on the
  86164. * Renderer object.
  86165. */
  86166. shape?: string;
  86167. /**
  86168. * (Highcharts, Highstock, Highmaps, Gantt) Styles for the label. The
  86169. * default `color` setting is `"contrast"`, which is a pseudo color that
  86170. * Highcharts picks up and applies the maximum contrast to the underlying
  86171. * point item, for example the bar in a bar chart.
  86172. *
  86173. * The `textOutline` is a pseudo property that applies an outline of the
  86174. * given width with the given color, which by default is the maximum
  86175. * contrast to the text. So a bright text color will result in a black text
  86176. * outline for maximum readability on a mixed background. In some cases,
  86177. * especially with grayscale text, the text outline doesn't work well, in
  86178. * which cases it can be disabled by setting it to `"none"`. When `useHTML`
  86179. * is true, the `textOutline` will not be picked up. In this, case, the same
  86180. * effect can be acheived through the `text-shadow` CSS property.
  86181. *
  86182. * For some series types, where each point has an extent, like for example
  86183. * tree maps, the data label may overflow the point. There are two
  86184. * strategies for handling overflow. By default, the text will wrap to
  86185. * multiple lines. The other strategy is to set `style.textOverflow` to
  86186. * `ellipsis`, which will keep the text on one line plus it will break
  86187. * inside long words.
  86188. */
  86189. style?: CSSObject;
  86190. /**
  86191. * (Highcharts, Highstock, Highmaps, Gantt) Options for a label text which
  86192. * should follow marker's shape. Border and background are disabled for a
  86193. * label that follows a path.
  86194. *
  86195. * **Note:** Only SVG-based renderer supports this option. Setting `useHTML`
  86196. * to true will disable this option.
  86197. */
  86198. textPath?: DataLabelsTextPathOptionsObject;
  86199. /**
  86200. * (Highcharts, Highstock, Highmaps, Gantt) Whether to use HTML to render
  86201. * the labels.
  86202. */
  86203. useHTML?: boolean;
  86204. /**
  86205. * (Highcharts, Highstock, Highmaps, Gantt) The vertical alignment of a data
  86206. * label. Can be one of `top`, `middle` or `bottom`. The default value
  86207. * depends on the data, for instance in a column chart, the label is above
  86208. * positive values and below negative values.
  86209. */
  86210. verticalAlign?: (VerticalAlignValue|null);
  86211. /**
  86212. * (Highcharts, Highstock, Highmaps, Gantt) The x position offset of the
  86213. * label relative to the point in pixels.
  86214. */
  86215. x?: number;
  86216. /**
  86217. * (Highcharts, Highstock, Highmaps, Gantt) The y position offset of the
  86218. * label relative to the point in pixels.
  86219. */
  86220. y?: number;
  86221. /**
  86222. * (Highcharts, Highstock, Highmaps, Gantt) The Z index of the data labels.
  86223. * The default Z index puts it above the series. Use a Z index of 2 to
  86224. * display it behind the series.
  86225. */
  86226. z?: number;
  86227. }
  86228. /**
  86229. * (Highcharts, Highstock) Options for the series data sorting.
  86230. */
  86231. export interface PlotTemaDataSortingOptions {
  86232. /**
  86233. * (Highcharts, Highstock) Enable or disable data sorting for the series.
  86234. * Use xAxis.reversed to change the sorting order.
  86235. */
  86236. enabled?: boolean;
  86237. /**
  86238. * (Highcharts, Highstock) Whether to allow matching points by name in an
  86239. * update. If this option is disabled, points will be matched by order.
  86240. */
  86241. matchByName?: boolean;
  86242. /**
  86243. * (Highcharts, Highstock) Determines what data value should be used to sort
  86244. * by.
  86245. */
  86246. sortKey?: string;
  86247. }
  86248. /**
  86249. * (Highstock) Triple exponential moving average (TEMA) indicator. This series
  86250. * requires `linkedTo` option to be set and should be loaded after the
  86251. * `stock/indicators/indicators.js` and `stock/indicators/ema.js`.
  86252. *
  86253. * In TypeScript the type option must always be set.
  86254. *
  86255. * Configuration options for the series are given in three levels:
  86256. *
  86257. * 1. Options for all series in a chart are defined in the plotOptions.series
  86258. * object.
  86259. *
  86260. * 2. Options for all `tema` series are defined in plotOptions.tema.
  86261. *
  86262. * 3. Options for one single series are given in the series instance array. (see
  86263. * online documentation for example)
  86264. */
  86265. export interface PlotTemaOptions {
  86266. /**
  86267. * (Highstock) Accessibility options for a series.
  86268. */
  86269. accessibility?: SeriesAccessibilityOptionsObject;
  86270. /**
  86271. * (Highstock) Allow this series' points to be selected by clicking on the
  86272. * graphic (columns, point markers, pie slices, map areas etc).
  86273. *
  86274. * The selected points can be handled by point select and unselect events,
  86275. * or collectively by the getSelectedPoints function.
  86276. *
  86277. * And alternative way of selecting points is through dragging.
  86278. */
  86279. allowPointSelect?: boolean;
  86280. /**
  86281. * (Highstock) Enable or disable the initial animation when a series is
  86282. * displayed. The animation can also be set as a configuration object.
  86283. * Please note that this option only applies to the initial animation of the
  86284. * series itself. For other animations, see chart.animation and the
  86285. * animation parameter under the API methods. The following properties are
  86286. * supported:
  86287. *
  86288. * - `defer`: The animation delay time in milliseconds.
  86289. *
  86290. * - `duration`: The duration of the animation in milliseconds.
  86291. *
  86292. * - `easing`: Can be a string reference to an easing function set on the
  86293. * `Math` object or a function. See the _Custom easing function_ demo below.
  86294. *
  86295. * Due to poor performance, animation is disabled in old IE browsers for
  86296. * several chart types.
  86297. */
  86298. animation?: (boolean|PlotTemaAnimationOptions|Partial<AnimationOptionsObject>);
  86299. /**
  86300. * (Highstock) For some series, there is a limit that shuts down initial
  86301. * animation by default when the total number of points in the chart is too
  86302. * high. For example, for a column chart and its derivatives, animation does
  86303. * not run if there is more than 250 points totally. To disable this cap,
  86304. * set `animationLimit` to `Infinity`.
  86305. */
  86306. animationLimit?: number;
  86307. /**
  86308. * (Highstock) Sets the color blending in the boost module.
  86309. */
  86310. boostBlending?: OptionsBoostBlendingValue;
  86311. /**
  86312. * (Highstock) Set the point threshold for when a series should enter boost
  86313. * mode.
  86314. *
  86315. * Setting it to e.g. 2000 will cause the series to enter boost mode when
  86316. * there are 2000 or more points in the series.
  86317. *
  86318. * To disable boosting on the series, set the `boostThreshold` to 0. Setting
  86319. * it to 1 will force boosting.
  86320. *
  86321. * Note that the cropThreshold also affects this setting. When zooming in on
  86322. * a series that has fewer points than the `cropThreshold`, all points are
  86323. * rendered although outside the visible plot area, and the `boostThreshold`
  86324. * won't take effect.
  86325. */
  86326. boostThreshold?: number;
  86327. /**
  86328. * (Highmaps) The border color of the map areas.
  86329. *
  86330. * In styled mode, the border stroke is given in the `.highcharts-point`
  86331. * class.
  86332. */
  86333. borderColor?: (ColorString|GradientColorObject|PatternObject);
  86334. /**
  86335. * (Highmaps) The border width of each map area.
  86336. *
  86337. * In styled mode, the border stroke width is given in the
  86338. * `.highcharts-point` class.
  86339. */
  86340. borderWidth?: number;
  86341. /**
  86342. * (Highstock) An additional class name to apply to the series' graphical
  86343. * elements. This option does not replace default class names of the
  86344. * graphical element.
  86345. */
  86346. className?: string;
  86347. /**
  86348. * (Highstock) Disable this option to allow series rendering in the whole
  86349. * plotting area.
  86350. *
  86351. * **Note:** Clipping should be always enabled when chart.zoomType is set
  86352. */
  86353. clip?: boolean;
  86354. /**
  86355. * (Highstock) The main color of the series. In line type series it applies
  86356. * to the line and the point markers unless otherwise specified. In bar type
  86357. * series it applies to the bars unless a color is specified per point. The
  86358. * default value is pulled from the `options.colors` array.
  86359. *
  86360. * In styled mode, the color can be defined by the colorIndex option. Also,
  86361. * the series color can be set with the `.highcharts-series`,
  86362. * `.highcharts-color-{n}`, `.highcharts-{type}-series` or
  86363. * `.highcharts-series-{n}` class, or individual classes given by the
  86364. * `className` option.
  86365. */
  86366. color?: (ColorString|GradientColorObject|PatternObject);
  86367. /**
  86368. * (Highstock) Styled mode only. A specific color index to use for the
  86369. * series, so its graphic representations are given the class name
  86370. * `highcharts-color-{n}`.
  86371. */
  86372. colorIndex?: number;
  86373. /**
  86374. * (Highcharts, Highstock, Highmaps) Determines what data value should be
  86375. * used to calculate point color if `colorAxis` is used. Requires to set
  86376. * `min` and `max` if some custom point property is used or if approximation
  86377. * for data grouping is set to `'sum'`.
  86378. */
  86379. colorKey?: string;
  86380. /**
  86381. * (Highstock) Defines if comparison should start from the first point
  86382. * within the visible range or should start from the first point **before**
  86383. * the range.
  86384. *
  86385. * In other words, this flag determines if first point within the visible
  86386. * range will have 0% (`compareStart=true`) or should have been already
  86387. * calculated according to the previous point (`compareStart=false`).
  86388. */
  86389. compareStart?: boolean;
  86390. /**
  86391. * (Highstock) Whether to compare indicator to the main series values or
  86392. * indicator values.
  86393. */
  86394. compareToMain?: boolean;
  86395. /**
  86396. * (Highcharts) Polar charts only. Whether to connect the ends of a line
  86397. * series plot across the extremes.
  86398. */
  86399. connectEnds?: boolean;
  86400. /**
  86401. * (Highcharts, Highstock) Whether to connect a graph line across null
  86402. * points, or render a gap between the two points on either side of the
  86403. * null.
  86404. */
  86405. connectNulls?: boolean;
  86406. /**
  86407. * (Gantt) Override Pathfinder connector options for a series. Requires
  86408. * Highcharts Gantt to be loaded.
  86409. */
  86410. connectors?: SeriesConnectorsOptionsObject;
  86411. /**
  86412. * (Highcharts, Highstock, Gantt) When true, each point or column edge is
  86413. * rounded to its nearest pixel in order to render sharp on screen. In some
  86414. * cases, when there are a lot of densely packed columns, this leads to
  86415. * visible difference in column widths or distance between columns. In these
  86416. * cases, setting `crisp` to `false` may look better, even though each
  86417. * column is rendered blurry.
  86418. */
  86419. crisp?: boolean;
  86420. /**
  86421. * (Highcharts, Highstock) When the series contains less points than the
  86422. * crop threshold, all points are drawn, even if the points fall outside the
  86423. * visible plot area at the current zoom. The advantage of drawing all
  86424. * points (including markers and columns), is that animation is performed on
  86425. * updates. On the other hand, when the series contains more points than the
  86426. * crop threshold, the series data is cropped to only contain points that
  86427. * fall within the plot area. The advantage of cropping away invisible
  86428. * points is to increase performance on large series.
  86429. */
  86430. cropThreshold?: number;
  86431. /**
  86432. * (Highstock) You can set the cursor to "pointer" if you have click events
  86433. * attached to the series, to signal to the user that the points and lines
  86434. * can be clicked.
  86435. *
  86436. * In styled mode, the series cursor can be set with the same classes as
  86437. * listed under series.color.
  86438. */
  86439. cursor?: (string|CursorValue);
  86440. /**
  86441. * (Highstock) A reserved subspace to store options and values for
  86442. * customized functionality. Here you can add additional data for your own
  86443. * event callbacks and formatter callbacks.
  86444. */
  86445. custom?: Dictionary<any>;
  86446. /**
  86447. * (Highstock) Name of the dash style to use for the graph, or for some
  86448. * series types the outline of each shape.
  86449. *
  86450. * In styled mode, the stroke dash-array can be set with the same classes as
  86451. * listed under series.color.
  86452. */
  86453. dashStyle?: DashStyleValue;
  86454. /**
  86455. * (Highstock) Data grouping is the concept of sampling the data values into
  86456. * larger blocks in order to ease readability and increase performance of
  86457. * the JavaScript charts. Highstock by default applies data grouping when
  86458. * the points become closer than a certain pixel value, determined by the
  86459. * `groupPixelWidth` option.
  86460. *
  86461. * If data grouping is applied, the grouping information of grouped points
  86462. * can be read from the Point.dataGroup. If point options other than the
  86463. * data itself are set, for example `name` or `color` or custom properties,
  86464. * the grouping logic doesn't know how to group it. In this case the options
  86465. * of the first point instance are copied over to the group point. This can
  86466. * be altered through a custom `approximation` callback function.
  86467. */
  86468. dataGrouping?: DataGroupingOptionsObject;
  86469. /**
  86470. * (Highcharts, Highstock, Highmaps, Gantt) Options for the series data
  86471. * labels, appearing next to each data point.
  86472. *
  86473. * Since v6.2.0, multiple data labels can be applied to each single point by
  86474. * defining them as an array of configs.
  86475. *
  86476. * In styled mode, the data labels can be styled with the
  86477. * `.highcharts-data-label-box` and `.highcharts-data-label` class names
  86478. * (see example).
  86479. */
  86480. dataLabels?: (PlotTemaDataLabelsOptions|Array<PlotTemaDataLabelsOptions>);
  86481. /**
  86482. * (Highcharts, Highstock) Options for the series data sorting.
  86483. */
  86484. dataSorting?: (DataSortingOptionsObject|PlotTemaDataSortingOptions);
  86485. /**
  86486. * (Highstock) A description of the series to add to the screen reader
  86487. * information about the series.
  86488. */
  86489. description?: string;
  86490. /**
  86491. * (Highstock) Enable or disable the mouse tracking for a specific series.
  86492. * This includes point tooltips and click events on graphs and points. For
  86493. * large datasets it improves performance.
  86494. */
  86495. enableMouseTracking?: boolean;
  86496. /**
  86497. * (Highstock) General event handlers for the series items. These event
  86498. * hooks can also be attached to the series at run time using the
  86499. * `Highcharts.addEvent` function.
  86500. */
  86501. events?: SeriesEventsOptionsObject;
  86502. /**
  86503. * (Highstock) Determines whether the series should look for the nearest
  86504. * point in both dimensions or just the x-dimension when hovering the
  86505. * series. Defaults to `'xy'` for scatter series and `'x'` for most other
  86506. * series. If the data has duplicate x-values, it is recommended to set this
  86507. * to `'xy'` to allow hovering over all points.
  86508. *
  86509. * Applies only to series types using nearest neighbor search (not direct
  86510. * hover) for tooltip.
  86511. */
  86512. findNearestPointBy?: OptionsFindNearestPointByValue;
  86513. /**
  86514. * (Highstock) Defines when to display a gap in the graph, together with the
  86515. * gapUnit option.
  86516. *
  86517. * In case when `dataGrouping` is enabled, points can be grouped into a
  86518. * larger time span. This can make the grouped points to have a greater
  86519. * distance than the absolute value of `gapSize` property, which will result
  86520. * in disappearing graph completely. To prevent this situation the mentioned
  86521. * distance between grouped points is used instead of previously defined
  86522. * `gapSize`.
  86523. *
  86524. * In practice, this option is most often used to visualize gaps in time
  86525. * series. In a stock chart, intraday data is available for daytime hours,
  86526. * while gaps will appear in nights and weekends.
  86527. */
  86528. gapSize?: number;
  86529. /**
  86530. * (Highstock) Together with gapSize, this option defines where to draw gaps
  86531. * in the graph.
  86532. *
  86533. * When the `gapUnit` is `"relative"` (default), a gap size of 5 means that
  86534. * if the distance between two points is greater than 5 times that of the
  86535. * two closest points, the graph will be broken.
  86536. *
  86537. * When the `gapUnit` is `"value"`, the gap is based on absolute axis
  86538. * values, which on a datetime axis is milliseconds. This also applies to
  86539. * the navigator series that inherits gap options from the base series.
  86540. */
  86541. gapUnit?: OptionsGapUnitValue;
  86542. /**
  86543. * (Highcharts, Highstock, Gantt) Whether to use the Y extremes of the total
  86544. * chart width or only the zoomed area when zooming in on parts of the X
  86545. * axis. By default, the Y axis adjusts to the min and max of the visible
  86546. * data. Cartesian series only.
  86547. */
  86548. getExtremesFromAll?: boolean;
  86549. /**
  86550. * (Highstock) When set to `false` will prevent the series data from being
  86551. * included in any form of data export.
  86552. *
  86553. * Since version 6.0.0 until 7.1.0 the option was existing undocumented as
  86554. * `includeInCSVExport`.
  86555. */
  86556. includeInDataExport?: boolean;
  86557. /**
  86558. * (Highcharts, Highstock, Gantt) Series labels are placed as close to the
  86559. * series as possible in a natural way, seeking to avoid other series. The
  86560. * goal of this feature is to make the chart more easily readable, like if a
  86561. * human designer placed the labels in the optimal position.
  86562. *
  86563. * The series labels currently work with series types having a `graph` or an
  86564. * `area`.
  86565. */
  86566. label?: SeriesLabelOptionsObject;
  86567. /**
  86568. * (Highstock) The line marks the last price from all points.
  86569. */
  86570. lastPrice?: SeriesLastPriceOptionsObject;
  86571. /**
  86572. * (Highstock) The line marks the last price from visible range of points.
  86573. */
  86574. lastVisiblePrice?: SeriesLastVisiblePriceOptionsObject;
  86575. /**
  86576. * (Highcharts, Highstock) The SVG value used for the `stroke-linecap` and
  86577. * `stroke-linejoin` of a line graph. Round means that lines are rounded in
  86578. * the ends and bends.
  86579. */
  86580. linecap?: SeriesLinecapValue;
  86581. /**
  86582. * (Highcharts, Highstock) Pixel width of the graph line.
  86583. */
  86584. lineWidth?: number;
  86585. /**
  86586. * (Highcharts, Highstock, Gantt) The main series ID that indicator will be
  86587. * based on. Required for this indicator.
  86588. */
  86589. linkedTo?: string;
  86590. /**
  86591. * (Highstock) Options for the point markers of line-like series. Properties
  86592. * like `fillColor`, `lineColor` and `lineWidth` define the visual
  86593. * appearance of the markers. Other series types, like column series, don't
  86594. * have markers, but have visual options on the series level instead.
  86595. *
  86596. * In styled mode, the markers can be styled with the `.highcharts-point`,
  86597. * `.highcharts-point-hover` and `.highcharts-point-select` class names.
  86598. */
  86599. marker?: PointMarkerOptionsObject;
  86600. /**
  86601. * (Highstock) The name of the series as shown in the legend, tooltip etc.
  86602. * If not set, it will be based on a technical indicator type and default
  86603. * params.
  86604. */
  86605. name?: string;
  86606. /**
  86607. * (Highstock) The color for the parts of the graph or points that are below
  86608. * the threshold. Note that `zones` takes precedence over the negative
  86609. * color. Using `negativeColor` is equivalent to applying a zone with value
  86610. * of 0.
  86611. */
  86612. negativeColor?: (ColorString|GradientColorObject|PatternObject);
  86613. /**
  86614. * (Highstock) Opacity of a series parts: line, fill (e.g. area) and
  86615. * dataLabels.
  86616. */
  86617. opacity?: number;
  86618. /**
  86619. * (Highstock) Paramters used in calculation of regression series' points.
  86620. */
  86621. params?: PlotTemaParamsOptions;
  86622. /**
  86623. * (Highstock) Properties for each single point.
  86624. */
  86625. point?: PlotSeriesPointOptions;
  86626. /**
  86627. * (Highstock) Same as accessibility.pointDescriptionFormatter, but for an
  86628. * individual series. Overrides the chart wide configuration.
  86629. */
  86630. pointDescriptionFormatter?: Function;
  86631. /**
  86632. * (Highstock) Whether to select the series initially. If `showCheckbox` is
  86633. * true, the checkbox next to the series name in the legend will be checked
  86634. * for a selected series.
  86635. */
  86636. selected?: boolean;
  86637. /**
  86638. * (Highstock) Whether to apply a drop shadow to the graph line. Since 2.3
  86639. * the shadow can be an object configuration containing `color`, `offsetX`,
  86640. * `offsetY`, `opacity` and `width`.
  86641. */
  86642. shadow?: (boolean|ShadowOptionsObject);
  86643. /**
  86644. * (Highstock) If true, a checkbox is displayed next to the legend item to
  86645. * allow selecting the series. The state of the checkbox is determined by
  86646. * the `selected` option.
  86647. */
  86648. showCheckbox?: boolean;
  86649. /**
  86650. * (Highstock) Whether to display this particular series or series type in
  86651. * the legend. Standalone series are shown in legend by default, and linked
  86652. * series are not. Since v7.2.0 it is possible to show series that use
  86653. * colorAxis by setting this option to `true`.
  86654. */
  86655. showInLegend?: boolean;
  86656. /**
  86657. * (Highstock) If set to `true`, the accessibility module will skip past the
  86658. * points in this series for keyboard navigation.
  86659. */
  86660. skipKeyboardNavigation?: boolean;
  86661. /**
  86662. * (Highcharts, Highstock) When this is true, the series will not cause the
  86663. * Y axis to cross the zero plane (or threshold option) unless the data
  86664. * actually crosses the plane.
  86665. *
  86666. * For example, if `softThreshold` is `false`, a series of 0, 1, 2, 3 will
  86667. * make the Y axis show negative values according to the `minPadding`
  86668. * option. If `softThreshold` is `true`, the Y axis starts at 0.
  86669. */
  86670. softThreshold?: boolean;
  86671. states?: SeriesStatesOptionsObject;
  86672. /**
  86673. * (Highcharts, Highstock) Whether to apply steps to the line. Possible
  86674. * values are `left`, `center` and `right`.
  86675. */
  86676. step?: OptionsStepValue;
  86677. /**
  86678. * (Highstock) Sticky tracking of mouse events. When true, the `mouseOut`
  86679. * event on a series isn't triggered until the mouse moves over another
  86680. * series, or out of the plot area. When false, the `mouseOut` event on a
  86681. * series is triggered when the mouse leaves the area around the series'
  86682. * graph or markers. This also implies the tooltip when not shared. When
  86683. * `stickyTracking` is false and `tooltip.shared` is false, the tooltip will
  86684. * be hidden when moving the mouse between series. Defaults to true for line
  86685. * and area type series, but to false for columns, pies etc.
  86686. *
  86687. * **Note:** The boost module will force this option because of technical
  86688. * limitations.
  86689. */
  86690. stickyTracking?: boolean;
  86691. /**
  86692. * (Highcharts, Highstock) The threshold, also called zero level or base
  86693. * level. For line type series this is only used in conjunction with
  86694. * negativeColor.
  86695. */
  86696. threshold?: (number|null);
  86697. /**
  86698. * (Highstock) A configuration object for the tooltip rendering of each
  86699. * single series. Properties are inherited from tooltip, but only the
  86700. * following properties can be defined on a series level.
  86701. */
  86702. tooltip?: SeriesTooltipOptionsObject;
  86703. /**
  86704. * (Highcharts, Highstock, Gantt) When a series contains a data array that
  86705. * is longer than this, only one dimensional arrays of numbers, or two
  86706. * dimensional arrays with x and y values are allowed. Also, only the first
  86707. * point is tested, and the rest are assumed to be the same format. This
  86708. * saves expensive data checking and indexing in long series. Set it to `0`
  86709. * disable.
  86710. *
  86711. * Note: In boost mode turbo threshold is forced. Only array of numbers or
  86712. * two dimensional arrays are allowed.
  86713. */
  86714. turboThreshold?: number;
  86715. /**
  86716. * (Highstock) Set the initial visibility of the series.
  86717. */
  86718. visible?: boolean;
  86719. /**
  86720. * (Highmaps) Define the z index of the series.
  86721. */
  86722. zIndex?: number;
  86723. /**
  86724. * (Highcharts, Highstock) Defines the Axis on which the zones are applied.
  86725. */
  86726. zoneAxis?: string;
  86727. /**
  86728. * (Highcharts, Highstock) An array defining zones within a series. Zones
  86729. * can be applied to the X axis, Y axis or Z axis for bubbles, according to
  86730. * the `zoneAxis` option. The zone definitions have to be in ascending order
  86731. * regarding to the value.
  86732. *
  86733. * In styled mode, the color zones are styled with the
  86734. * `.highcharts-zone-{n}` class, or custom classed from the `className`
  86735. * option (view live demo).
  86736. */
  86737. zones?: Array<SeriesZonesOptionsObject>;
  86738. }
  86739. /**
  86740. * (Highstock) Paramters used in calculation of regression series' points.
  86741. */
  86742. export interface PlotTemaParamsOptions {
  86743. /**
  86744. * (Highstock) The point index which indicator calculations will base. For
  86745. * example using OHLC data, index=2 means the indicator will be calculated
  86746. * using Low values.
  86747. *
  86748. * By default index value used to be set to 0. Since Highstock 7 by default
  86749. * index is set to 3 which means that the ema indicator will be calculated
  86750. * using Close values.
  86751. */
  86752. index?: number;
  86753. /**
  86754. * (Highstock) The base period for indicator calculations. This is the
  86755. * number of data points which are taken into account for the indicator
  86756. * calculations.
  86757. */
  86758. period?: number;
  86759. }
  86760. /**
  86761. * (Highcharts, Highmaps) Animation is disabled by default on the heatmap
  86762. * series.
  86763. */
  86764. export interface PlotTilemapAnimationOptions {
  86765. defer?: number;
  86766. }
  86767. /**
  86768. * (Highcharts, Highstock, Highmaps, Gantt) Enable or disable the initial
  86769. * animation when a series is displayed for the `dataLabels`. The animation can
  86770. * also be set as a configuration object. Please note that this option only
  86771. * applies to the initial animation. For other animations, see chart.animation
  86772. * and the animation parameter under the API methods. The following properties
  86773. * are supported:
  86774. *
  86775. * - `defer`: The animation delay time in milliseconds.
  86776. */
  86777. export interface PlotTilemapDataLabelsAnimationOptions {
  86778. /**
  86779. * (Highcharts, Highstock, Highmaps, Gantt) The animation delay time in
  86780. * milliseconds. Set to `0` renders dataLabel immediately. As `undefined`
  86781. * inherits defer time from the series.animation.defer.
  86782. */
  86783. defer?: number;
  86784. }
  86785. /**
  86786. * (Highcharts, Highstock, Highmaps, Gantt) Options for the series data labels,
  86787. * appearing next to each data point.
  86788. *
  86789. * Since v6.2.0, multiple data labels can be applied to each single point by
  86790. * defining them as an array of configs.
  86791. *
  86792. * In styled mode, the data labels can be styled with the
  86793. * `.highcharts-data-label-box` and `.highcharts-data-label` class names (see
  86794. * example).
  86795. */
  86796. export interface PlotTilemapDataLabelsOptions {
  86797. /**
  86798. * (Highcharts, Highstock, Highmaps, Gantt) The alignment of the data label
  86799. * compared to the point. If `right`, the right side of the label should be
  86800. * touching the point. For points with an extent, like columns, the
  86801. * alignments also dictates how to align it inside the box, as given with
  86802. * the inside option. Can be one of `left`, `center` or `right`.
  86803. */
  86804. align?: (AlignValue|null);
  86805. /**
  86806. * (Highcharts, Highstock, Highmaps, Gantt) Whether to allow data labels to
  86807. * overlap. To make the labels less sensitive for overlapping, the
  86808. * dataLabels.padding can be set to 0.
  86809. */
  86810. allowOverlap?: boolean;
  86811. /**
  86812. * (Highcharts, Highstock, Highmaps, Gantt) Enable or disable the initial
  86813. * animation when a series is displayed for the `dataLabels`. The animation
  86814. * can also be set as a configuration object. Please note that this option
  86815. * only applies to the initial animation. For other animations, see
  86816. * chart.animation and the animation parameter under the API methods. The
  86817. * following properties are supported:
  86818. *
  86819. * - `defer`: The animation delay time in milliseconds.
  86820. */
  86821. animation?: (boolean|PlotTilemapDataLabelsAnimationOptions|Partial<AnimationOptionsObject>);
  86822. /**
  86823. * (Highcharts, Highstock, Highmaps, Gantt) The background color or gradient
  86824. * for the data label.
  86825. */
  86826. backgroundColor?: (ColorString|GradientColorObject|PatternObject);
  86827. /**
  86828. * (Highcharts, Highstock, Highmaps, Gantt) The border color for the data
  86829. * label. Defaults to `undefined`.
  86830. */
  86831. borderColor?: (ColorString|GradientColorObject|PatternObject);
  86832. /**
  86833. * (Highcharts, Highstock, Highmaps, Gantt) The border radius in pixels for
  86834. * the data label.
  86835. */
  86836. borderRadius?: number;
  86837. /**
  86838. * (Highcharts, Highstock, Highmaps, Gantt) The border width in pixels for
  86839. * the data label.
  86840. */
  86841. borderWidth?: number;
  86842. /**
  86843. * (Highcharts, Highstock, Highmaps, Gantt) A class name for the data label.
  86844. * Particularly in styled mode, this can be used to give each series' or
  86845. * point's data label unique styling. In addition to this option, a default
  86846. * color class name is added so that we can give the labels a contrast text
  86847. * shadow.
  86848. */
  86849. className?: string;
  86850. /**
  86851. * (Highcharts, Highstock, Highmaps, Gantt) The text color for the data
  86852. * labels. Defaults to `undefined`. For certain series types, like column or
  86853. * map, the data labels can be drawn inside the points. In this case the
  86854. * data label will be drawn with maximum contrast by default. Additionally,
  86855. * it will be given a `text-outline` style with the opposite color, to
  86856. * further increase the contrast. This can be overridden by setting the
  86857. * `text-outline` style to `none` in the `dataLabels.style` option.
  86858. */
  86859. color?: (ColorString|GradientColorObject|PatternObject);
  86860. /**
  86861. * (Highcharts, Highstock, Highmaps, Gantt) Whether to hide data labels that
  86862. * are outside the plot area. By default, the data label is moved inside the
  86863. * plot area according to the overflow option.
  86864. */
  86865. crop?: boolean;
  86866. /**
  86867. * (Highcharts, Highstock, Gantt) Whether to defer displaying the data
  86868. * labels until the initial series animation has finished. Setting to
  86869. * `false` renders the data label immediately. If set to `true` inherits the
  86870. * defer time set in plotOptions.series.animation.
  86871. */
  86872. defer?: boolean;
  86873. /**
  86874. * (Highcharts, Highstock, Highmaps, Gantt) Enable or disable the data
  86875. * labels.
  86876. */
  86877. enabled?: boolean;
  86878. /**
  86879. * (Highcharts, Highstock, Highmaps, Gantt) A declarative filter to control
  86880. * of which data labels to display. The declarative filter is designed for
  86881. * use when callback functions are not available, like when the chart
  86882. * options require a pure JSON structure or for use with graphical editors.
  86883. * For programmatic control, use the `formatter` instead, and return
  86884. * `undefined` to disable a single data label.
  86885. */
  86886. filter?: DataLabelsFilterOptionsObject;
  86887. /**
  86888. * (Highcharts, Highstock, Highmaps, Gantt) A format string for the data
  86889. * label. Available variables are the same as for `formatter`.
  86890. */
  86891. format?: string;
  86892. /**
  86893. * (Highcharts, Highstock, Highmaps, Gantt) Callback JavaScript function to
  86894. * format the data label. Note that if a `format` is defined, the format
  86895. * takes precedence and the formatter is ignored.
  86896. */
  86897. formatter?: DataLabelsFormatterCallbackFunction;
  86898. /**
  86899. * (Highcharts, Highstock, Highmaps, Gantt) For points with an extent, like
  86900. * columns or map areas, whether to align the data label inside the box or
  86901. * to the actual value point. Defaults to `false` in most cases, `true` in
  86902. * stacked columns.
  86903. */
  86904. inside?: boolean;
  86905. /**
  86906. * (Highcharts, Highstock, Highmaps, Gantt) Format for points with the value
  86907. * of null. Works analogously to format. `nullFormat` can be applied only to
  86908. * series which support displaying null points.
  86909. */
  86910. nullFormat?: (boolean|string);
  86911. /**
  86912. * (Highcharts, Highstock, Highmaps, Gantt) Callback JavaScript function
  86913. * that defines formatting for points with the value of null. Works
  86914. * analogously to formatter. `nullPointFormatter` can be applied only to
  86915. * series which support displaying null points.
  86916. */
  86917. nullFormatter?: DataLabelsFormatterCallbackFunction;
  86918. /**
  86919. * (Highcharts, Highstock, Highmaps, Gantt) How to handle data labels that
  86920. * flow outside the plot area. The default is `"justify"`, which aligns them
  86921. * inside the plot area. For columns and bars, this means it will be moved
  86922. * inside the bar. To display data labels outside the plot area, set `crop`
  86923. * to `false` and `overflow` to `"allow"`.
  86924. */
  86925. overflow?: boolean;
  86926. /**
  86927. * (Highcharts, Highstock, Highmaps, Gantt) When either the `borderWidth` or
  86928. * the `backgroundColor` is set, this is the padding within the box.
  86929. */
  86930. padding?: number;
  86931. /**
  86932. * (Highcharts, Highstock, Highmaps, Gantt) Aligns data labels relative to
  86933. * points. If `center` alignment is not possible, it defaults to `right`.
  86934. */
  86935. position?: AlignValue;
  86936. /**
  86937. * (Highcharts, Highstock, Highmaps, Gantt) Text rotation in degrees. Note
  86938. * that due to a more complex structure, backgrounds, borders and padding
  86939. * will be lost on a rotated data label.
  86940. */
  86941. rotation?: number;
  86942. /**
  86943. * (Highcharts, Highstock, Highmaps, Gantt) The shadow of the box. Works
  86944. * best with `borderWidth` or `backgroundColor`. Since 2.3 the shadow can be
  86945. * an object configuration containing `color`, `offsetX`, `offsetY`,
  86946. * `opacity` and `width`.
  86947. */
  86948. shadow?: (boolean|ShadowOptionsObject);
  86949. /**
  86950. * (Highcharts, Highstock, Highmaps, Gantt) The name of a symbol to use for
  86951. * the border around the label. Symbols are predefined functions on the
  86952. * Renderer object.
  86953. */
  86954. shape?: string;
  86955. /**
  86956. * (Highcharts, Highstock, Highmaps, Gantt) Styles for the label. The
  86957. * default `color` setting is `"contrast"`, which is a pseudo color that
  86958. * Highcharts picks up and applies the maximum contrast to the underlying
  86959. * point item, for example the bar in a bar chart.
  86960. *
  86961. * The `textOutline` is a pseudo property that applies an outline of the
  86962. * given width with the given color, which by default is the maximum
  86963. * contrast to the text. So a bright text color will result in a black text
  86964. * outline for maximum readability on a mixed background. In some cases,
  86965. * especially with grayscale text, the text outline doesn't work well, in
  86966. * which cases it can be disabled by setting it to `"none"`. When `useHTML`
  86967. * is true, the `textOutline` will not be picked up. In this, case, the same
  86968. * effect can be acheived through the `text-shadow` CSS property.
  86969. *
  86970. * For some series types, where each point has an extent, like for example
  86971. * tree maps, the data label may overflow the point. There are two
  86972. * strategies for handling overflow. By default, the text will wrap to
  86973. * multiple lines. The other strategy is to set `style.textOverflow` to
  86974. * `ellipsis`, which will keep the text on one line plus it will break
  86975. * inside long words.
  86976. */
  86977. style?: CSSObject;
  86978. /**
  86979. * (Highcharts, Highstock, Highmaps, Gantt) Options for a label text which
  86980. * should follow marker's shape. Border and background are disabled for a
  86981. * label that follows a path.
  86982. *
  86983. * **Note:** Only SVG-based renderer supports this option. Setting `useHTML`
  86984. * to true will disable this option.
  86985. */
  86986. textPath?: DataLabelsTextPathOptionsObject;
  86987. /**
  86988. * (Highcharts, Highstock, Highmaps, Gantt) Whether to use HTML to render
  86989. * the labels.
  86990. */
  86991. useHTML?: boolean;
  86992. /**
  86993. * (Highcharts, Highstock, Highmaps, Gantt) The vertical alignment of a data
  86994. * label. Can be one of `top`, `middle` or `bottom`. The default value
  86995. * depends on the data, for instance in a column chart, the label is above
  86996. * positive values and below negative values.
  86997. */
  86998. verticalAlign?: string;
  86999. /**
  87000. * (Highcharts, Highstock, Highmaps, Gantt) The x position offset of the
  87001. * label relative to the point in pixels.
  87002. */
  87003. x?: number;
  87004. /**
  87005. * (Highcharts, Highstock, Highmaps, Gantt) The y position offset of the
  87006. * label relative to the point in pixels.
  87007. */
  87008. y?: number;
  87009. /**
  87010. * (Highcharts, Highstock, Highmaps, Gantt) The Z index of the data labels.
  87011. * The default Z index puts it above the series. Use a Z index of 2 to
  87012. * display it behind the series.
  87013. */
  87014. z?: number;
  87015. }
  87016. /**
  87017. * (Highcharts, Highmaps) Style options for the guide box. The guide box has one
  87018. * state by default, the `default` state.
  87019. */
  87020. export interface PlotTilemapDragDropGuideBoxOptions {
  87021. /**
  87022. * (Highcharts, Highmaps) Style options for the guide box default state.
  87023. */
  87024. default?: DragDropGuideBoxOptionsObject;
  87025. }
  87026. /**
  87027. * (Highcharts, Highmaps) A tilemap series is a type of heatmap where the tile
  87028. * shapes are configurable.
  87029. *
  87030. * In TypeScript the type option must always be set.
  87031. *
  87032. * Configuration options for the series are given in three levels:
  87033. *
  87034. * 1. Options for all series in a chart are defined in the plotOptions.series
  87035. * object.
  87036. *
  87037. * 2. Options for all `tilemap` series are defined in plotOptions.tilemap.
  87038. *
  87039. * 3. Options for one single series are given in the series instance array. (see
  87040. * online documentation for example)
  87041. */
  87042. export interface PlotTilemapOptions {
  87043. /**
  87044. * (Highcharts, Highmaps) Accessibility options for a series.
  87045. */
  87046. accessibility?: SeriesAccessibilityOptionsObject;
  87047. /**
  87048. * (Highcharts, Highmaps) Allow this series' points to be selected by
  87049. * clicking on the graphic (columns, point markers, pie slices, map areas
  87050. * etc).
  87051. *
  87052. * The selected points can be handled by point select and unselect events,
  87053. * or collectively by the getSelectedPoints function.
  87054. *
  87055. * And alternative way of selecting points is through dragging.
  87056. */
  87057. allowPointSelect?: boolean;
  87058. /**
  87059. * (Highcharts, Highmaps) Animation is disabled by default on the heatmap
  87060. * series.
  87061. */
  87062. animation?: (boolean|PlotTilemapAnimationOptions);
  87063. /**
  87064. * (Highmaps) The border color of the map areas.
  87065. *
  87066. * In styled mode, the border stroke is given in the `.highcharts-point`
  87067. * class.
  87068. */
  87069. borderColor?: (ColorString|GradientColorObject|PatternObject);
  87070. /**
  87071. * (Highmaps) The border width for each heat map item.
  87072. */
  87073. borderWidth?: number;
  87074. /**
  87075. * (Highcharts, Highmaps) An additional class name to apply to the series'
  87076. * graphical elements. This option does not replace default class names of
  87077. * the graphical element.
  87078. */
  87079. className?: string;
  87080. /**
  87081. * (Highcharts, Highmaps) Disable this option to allow series rendering in
  87082. * the whole plotting area.
  87083. *
  87084. * **Note:** Clipping should be always enabled when chart.zoomType is set
  87085. */
  87086. clip?: boolean;
  87087. /**
  87088. * (Highcharts) The main color of the series. In heat maps this color is
  87089. * rarely used, as we mostly use the color to denote the value of each
  87090. * point. Unless options are set in the colorAxis, the default value is
  87091. * pulled from the options.colors array.
  87092. */
  87093. color?: (ColorString|GradientColorObject|PatternObject);
  87094. /**
  87095. * (Highcharts, Highstock, Highmaps) When using dual or multiple color axes,
  87096. * this number defines which colorAxis the particular series is connected
  87097. * to. It refers to either the axis id or the index of the axis in the
  87098. * colorAxis array, with 0 being the first. Set this option to false to
  87099. * prevent a series from connecting to the default color axis.
  87100. *
  87101. * Since v7.2.0 the option can also be an axis id or an axis index instead
  87102. * of a boolean flag.
  87103. */
  87104. colorAxis?: (boolean|number|string);
  87105. /**
  87106. * (Highcharts, Highmaps) Styled mode only. A specific color index to use
  87107. * for the series, so its graphic representations are given the class name
  87108. * `highcharts-color-{n}`.
  87109. */
  87110. colorIndex?: number;
  87111. /**
  87112. * (Highcharts, Highstock, Highmaps) Determines what data value should be
  87113. * used to calculate point color if `colorAxis` is used. Requires to set
  87114. * `min` and `max` if some custom point property is used or if approximation
  87115. * for data grouping is set to `'sum'`.
  87116. */
  87117. colorKey?: string;
  87118. /**
  87119. * (Highcharts, Highmaps) The column size - how many X axis units each
  87120. * column in the tilemap should span. Works as in Heatmaps.
  87121. */
  87122. colsize?: number;
  87123. /**
  87124. * (Highstock) Compare the values of the series against the first non-null,
  87125. * non- zero value in the visible range. The y axis will show percentage or
  87126. * absolute change depending on whether `compare` is set to `"percent"` or
  87127. * `"value"`. When this is applied to multiple series, it allows comparing
  87128. * the development of the series against each other. Adds a `change` field
  87129. * to every point object.
  87130. */
  87131. compare?: string;
  87132. /**
  87133. * (Highstock) When compare is `percent`, this option dictates whether to
  87134. * use 0 or 100 as the base of comparison.
  87135. */
  87136. compareBase?: (0|100);
  87137. /**
  87138. * (Highstock) Defines if comparison should start from the first point
  87139. * within the visible range or should start from the first point **before**
  87140. * the range.
  87141. *
  87142. * In other words, this flag determines if first point within the visible
  87143. * range will have 0% (`compareStart=true`) or should have been already
  87144. * calculated according to the previous point (`compareStart=false`).
  87145. */
  87146. compareStart?: boolean;
  87147. /**
  87148. * (Gantt) Override Pathfinder connector options for a series. Requires
  87149. * Highcharts Gantt to be loaded.
  87150. */
  87151. connectors?: SeriesConnectorsOptionsObject;
  87152. /**
  87153. * (Highcharts, Highstock, Gantt) When true, each point or column edge is
  87154. * rounded to its nearest pixel in order to render sharp on screen. In some
  87155. * cases, when there are a lot of densely packed columns, this leads to
  87156. * visible difference in column widths or distance between columns. In these
  87157. * cases, setting `crisp` to `false` may look better, even though each
  87158. * column is rendered blurry.
  87159. */
  87160. crisp?: boolean;
  87161. /**
  87162. * (Highcharts, Highmaps) You can set the cursor to "pointer" if you have
  87163. * click events attached to the series, to signal to the user that the
  87164. * points and lines can be clicked.
  87165. *
  87166. * In styled mode, the series cursor can be set with the same classes as
  87167. * listed under series.color.
  87168. */
  87169. cursor?: (string|CursorValue);
  87170. /**
  87171. * (Highcharts, Highmaps) A reserved subspace to store options and values
  87172. * for customized functionality. Here you can add additional data for your
  87173. * own event callbacks and formatter callbacks.
  87174. */
  87175. custom?: Dictionary<any>;
  87176. /**
  87177. * (Highstock) Data grouping is the concept of sampling the data values into
  87178. * larger blocks in order to ease readability and increase performance of
  87179. * the JavaScript charts. Highstock by default applies data grouping when
  87180. * the points become closer than a certain pixel value, determined by the
  87181. * `groupPixelWidth` option.
  87182. *
  87183. * If data grouping is applied, the grouping information of grouped points
  87184. * can be read from the Point.dataGroup. If point options other than the
  87185. * data itself are set, for example `name` or `color` or custom properties,
  87186. * the grouping logic doesn't know how to group it. In this case the options
  87187. * of the first point instance are copied over to the group point. This can
  87188. * be altered through a custom `approximation` callback function.
  87189. */
  87190. dataGrouping?: DataGroupingOptionsObject;
  87191. /**
  87192. * (Highcharts, Highstock, Highmaps, Gantt) Options for the series data
  87193. * labels, appearing next to each data point.
  87194. *
  87195. * Since v6.2.0, multiple data labels can be applied to each single point by
  87196. * defining them as an array of configs.
  87197. *
  87198. * In styled mode, the data labels can be styled with the
  87199. * `.highcharts-data-label-box` and `.highcharts-data-label` class names
  87200. * (see example).
  87201. */
  87202. dataLabels?: (PlotTilemapDataLabelsOptions|Array<PlotTilemapDataLabelsOptions>);
  87203. /**
  87204. * (Highcharts, Highmaps) A description of the series to add to the screen
  87205. * reader information about the series.
  87206. */
  87207. description?: string;
  87208. /**
  87209. * (Highcharts, Highmaps) The draggable-points module allows points to be
  87210. * moved around or modified in the chart. In addition to the options
  87211. * mentioned under the `dragDrop` API structure, the module fires three
  87212. * events, point.dragStart, point.drag and point.drop.
  87213. */
  87214. dragDrop?: SeriesDragDropOptionsObject;
  87215. /**
  87216. * (Highcharts, Highmaps) Enable or disable the mouse tracking for a
  87217. * specific series. This includes point tooltips and click events on graphs
  87218. * and points. For large datasets it improves performance.
  87219. */
  87220. enableMouseTracking?: boolean;
  87221. /**
  87222. * (Highcharts, Highmaps) General event handlers for the series items. These
  87223. * event hooks can also be attached to the series at run time using the
  87224. * `Highcharts.addEvent` function.
  87225. */
  87226. events?: SeriesEventsOptionsObject;
  87227. /**
  87228. * (Highstock) Defines when to display a gap in the graph, together with the
  87229. * gapUnit option.
  87230. *
  87231. * In case when `dataGrouping` is enabled, points can be grouped into a
  87232. * larger time span. This can make the grouped points to have a greater
  87233. * distance than the absolute value of `gapSize` property, which will result
  87234. * in disappearing graph completely. To prevent this situation the mentioned
  87235. * distance between grouped points is used instead of previously defined
  87236. * `gapSize`.
  87237. *
  87238. * In practice, this option is most often used to visualize gaps in time
  87239. * series. In a stock chart, intraday data is available for daytime hours,
  87240. * while gaps will appear in nights and weekends.
  87241. */
  87242. gapSize?: number;
  87243. /**
  87244. * (Highstock) Together with gapSize, this option defines where to draw gaps
  87245. * in the graph.
  87246. *
  87247. * When the `gapUnit` is `"relative"` (default), a gap size of 5 means that
  87248. * if the distance between two points is greater than 5 times that of the
  87249. * two closest points, the graph will be broken.
  87250. *
  87251. * When the `gapUnit` is `"value"`, the gap is based on absolute axis
  87252. * values, which on a datetime axis is milliseconds. This also applies to
  87253. * the navigator series that inherits gap options from the base series.
  87254. */
  87255. gapUnit?: OptionsGapUnitValue;
  87256. /**
  87257. * (Highcharts, Highmaps) When set to `false` will prevent the series data
  87258. * from being included in any form of data export.
  87259. *
  87260. * Since version 6.0.0 until 7.1.0 the option was existing undocumented as
  87261. * `includeInCSVExport`.
  87262. */
  87263. includeInDataExport?: boolean;
  87264. /**
  87265. * (Highcharts, Highmaps) An array specifying which option maps to which key
  87266. * in the data point array. This makes it convenient to work with
  87267. * unstructured data arrays from different sources.
  87268. */
  87269. keys?: Array<string>;
  87270. /**
  87271. * (Highcharts, Highstock, Gantt) Series labels are placed as close to the
  87272. * series as possible in a natural way, seeking to avoid other series. The
  87273. * goal of this feature is to make the chart more easily readable, like if a
  87274. * human designer placed the labels in the optimal position.
  87275. *
  87276. * The series labels currently work with series types having a `graph` or an
  87277. * `area`.
  87278. */
  87279. label?: SeriesLabelOptionsObject;
  87280. /**
  87281. * (Highstock) The line marks the last price from all points.
  87282. */
  87283. lastPrice?: SeriesLastPriceOptionsObject;
  87284. /**
  87285. * (Highstock) The line marks the last price from visible range of points.
  87286. */
  87287. lastVisiblePrice?: SeriesLastVisiblePriceOptionsObject;
  87288. /**
  87289. * (Highcharts, Highstock, Gantt) The id of another series to link to.
  87290. * Additionally, the value can be ":previous" to link to the previous
  87291. * series. When two series are linked, only the first one appears in the
  87292. * legend. Toggling the visibility of this also toggles the linked series.
  87293. *
  87294. * If master series uses data sorting and linked series does not have its
  87295. * own sorting definition, the linked series will be sorted in the same
  87296. * order as the master one.
  87297. */
  87298. linkedTo?: string;
  87299. marker?: any;
  87300. /**
  87301. * (Highstock) Options for the corresponding navigator series if
  87302. * `showInNavigator` is `true` for this series. Available options are the
  87303. * same as any series, documented at plotOptions and series.
  87304. *
  87305. * These options are merged with options in navigator.series, and will take
  87306. * precedence if the same option is defined both places.
  87307. */
  87308. navigatorOptions?: PlotSeriesOptions;
  87309. /**
  87310. * (Highcharts, Highmaps) The color for the parts of the graph or points
  87311. * that are below the threshold. Note that `zones` takes precedence over the
  87312. * negative color. Using `negativeColor` is equivalent to applying a zone
  87313. * with value of 0.
  87314. */
  87315. negativeColor?: (ColorString|GradientColorObject|PatternObject);
  87316. /**
  87317. * (Highcharts, Highmaps) The color applied to null points. In styled mode,
  87318. * a general CSS class is applied instead.
  87319. */
  87320. nullColor?: (ColorString|GradientColorObject|PatternObject);
  87321. /**
  87322. * (Highcharts, Highmaps) Opacity of a series parts: line, fill (e.g. area)
  87323. * and dataLabels.
  87324. */
  87325. opacity?: number;
  87326. /**
  87327. * (Highcharts, Highmaps) Properties for each single point.
  87328. */
  87329. point?: PlotSeriesPointOptions;
  87330. /**
  87331. * (Highcharts, Highmaps) Same as accessibility.pointDescriptionFormatter,
  87332. * but for an individual series. Overrides the chart wide configuration.
  87333. */
  87334. pointDescriptionFormatter?: Function;
  87335. /**
  87336. * (Highcharts, Highmaps) The padding between points in the tilemap.
  87337. */
  87338. pointPadding?: number;
  87339. /**
  87340. * (Highcharts, Highmaps) The row size - how many Y axis units each tilemap
  87341. * row should span. Analogous to colsize.
  87342. */
  87343. rowsize?: number;
  87344. /**
  87345. * (Highcharts, Highmaps) Whether to select the series initially. If
  87346. * `showCheckbox` is true, the checkbox next to the series name in the
  87347. * legend will be checked for a selected series.
  87348. */
  87349. selected?: boolean;
  87350. /**
  87351. * (Highcharts, Highmaps) If true, a checkbox is displayed next to the
  87352. * legend item to allow selecting the series. The state of the checkbox is
  87353. * determined by the `selected` option.
  87354. */
  87355. showCheckbox?: boolean;
  87356. /**
  87357. * (Highcharts, Highmaps) Whether to display this particular series or
  87358. * series type in the legend. Standalone series are shown in legend by
  87359. * default, and linked series are not. Since v7.2.0 it is possible to show
  87360. * series that use colorAxis by setting this option to `true`.
  87361. */
  87362. showInLegend?: boolean;
  87363. /**
  87364. * (Highstock) Whether or not to show the series in the navigator. Takes
  87365. * precedence over navigator.baseSeries if defined.
  87366. */
  87367. showInNavigator?: boolean;
  87368. /**
  87369. * (Highcharts, Highmaps) If set to `true`, the accessibility module will
  87370. * skip past the points in this series for keyboard navigation.
  87371. */
  87372. skipKeyboardNavigation?: boolean;
  87373. states?: SeriesStatesOptionsObject;
  87374. /**
  87375. * (Highcharts, Highstock) Sticky tracking of mouse events. When true, the
  87376. * `mouseOut` event on a series isn't triggered until the mouse moves over
  87377. * another series, or out of the plot area. When false, the `mouseOut` event
  87378. * on a series is triggered when the mouse leaves the area around the
  87379. * series' graph or markers. This also implies the tooltip. When
  87380. * `stickyTracking` is false and `tooltip.shared` is false, the tooltip will
  87381. * be hidden when moving the mouse between series.
  87382. */
  87383. stickyTracking?: boolean;
  87384. /**
  87385. * (Highcharts, Highmaps) The shape of the tiles in the tilemap. Possible
  87386. * values are `hexagon`, `circle`, `diamond`, and `square`.
  87387. */
  87388. tileShape?: TilemapShapeValue;
  87389. /**
  87390. * (Highcharts, Highstock) A configuration object for the tooltip rendering
  87391. * of each single series. Properties are inherited from tooltip. Overridable
  87392. * properties are `headerFormat`, `pointFormat`, `yDecimals`, `xDateFormat`,
  87393. * `yPrefix` and `ySuffix`. Unlike other series, in a scatter plot the
  87394. * series.name by default shows in the headerFormat and point.x and point.y
  87395. * in the pointFormat.
  87396. */
  87397. tooltip?: SeriesTooltipOptionsObject;
  87398. /**
  87399. * (Highcharts, Highstock, Gantt) When a series contains a data array that
  87400. * is longer than this, only one dimensional arrays of numbers, or two
  87401. * dimensional arrays with x and y values are allowed. Also, only the first
  87402. * point is tested, and the rest are assumed to be the same format. This
  87403. * saves expensive data checking and indexing in long series. Set it to `0`
  87404. * disable.
  87405. *
  87406. * Note: In boost mode turbo threshold is forced. Only array of numbers or
  87407. * two dimensional arrays are allowed.
  87408. */
  87409. turboThreshold?: number;
  87410. /**
  87411. * (Highcharts, Highmaps) Set the initial visibility of the series.
  87412. */
  87413. visible?: boolean;
  87414. /**
  87415. * (Highmaps) Define the z index of the series.
  87416. */
  87417. zIndex?: number;
  87418. /**
  87419. * (Highcharts, Highstock) Defines the Axis on which the zones are applied.
  87420. */
  87421. zoneAxis?: string;
  87422. /**
  87423. * (Highcharts, Highstock) An array defining zones within a series. Zones
  87424. * can be applied to the X axis, Y axis or Z axis for bubbles, according to
  87425. * the `zoneAxis` option. The zone definitions have to be in ascending order
  87426. * regarding to the value.
  87427. *
  87428. * In styled mode, the color zones are styled with the
  87429. * `.highcharts-zone-{n}` class, or custom classed from the `className`
  87430. * option (view live demo).
  87431. */
  87432. zones?: Array<SeriesZonesOptionsObject>;
  87433. }
  87434. /**
  87435. * (Highcharts, Highstock) A collection of SVG attributes to override the
  87436. * appearance of the halo, for example `fill`, `stroke` and `stroke-width`.
  87437. */
  87438. export interface PlotTilemapStatesHoverHaloAttributesOptions {
  87439. zIndex?: number;
  87440. }
  87441. /**
  87442. * (Highcharts) Enable or disable the initial animation when a series is
  87443. * displayed. The animation can also be set as a configuration object. Please
  87444. * note that this option only applies to the initial animation of the series
  87445. * itself. For other animations, see chart.animation and the animation parameter
  87446. * under the API methods. The following properties are supported:
  87447. *
  87448. * - `defer`: The animation delay time in milliseconds.
  87449. *
  87450. * - `duration`: The duration of the animation in milliseconds.
  87451. *
  87452. * - `easing`: Can be a string reference to an easing function set on the `Math`
  87453. * object or a function. See the _Custom easing function_ demo below.
  87454. *
  87455. * Due to poor performance, animation is disabled in old IE browsers for several
  87456. * chart types.
  87457. */
  87458. export interface PlotTimelineAnimationOptions {
  87459. defer?: number;
  87460. }
  87461. /**
  87462. * (Highcharts, Highstock, Highmaps, Gantt) Enable or disable the initial
  87463. * animation when a series is displayed for the `dataLabels`. The animation can
  87464. * also be set as a configuration object. Please note that this option only
  87465. * applies to the initial animation. For other animations, see chart.animation
  87466. * and the animation parameter under the API methods. The following properties
  87467. * are supported:
  87468. *
  87469. * - `defer`: The animation delay time in milliseconds.
  87470. */
  87471. export interface PlotTimelineDataLabelsAnimationOptions {
  87472. /**
  87473. * (Highcharts, Highstock, Highmaps, Gantt) The animation delay time in
  87474. * milliseconds. Set to `0` renders dataLabel immediately. As `undefined`
  87475. * inherits defer time from the series.animation.defer.
  87476. */
  87477. defer?: number;
  87478. }
  87479. /**
  87480. * (Highcharts) Style options for the guide box. The guide box has one state by
  87481. * default, the `default` state.
  87482. */
  87483. export interface PlotTimelineDragDropGuideBoxOptions {
  87484. /**
  87485. * (Highcharts) Style options for the guide box default state.
  87486. */
  87487. default?: DragDropGuideBoxOptionsObject;
  87488. }
  87489. /**
  87490. * (Highcharts) The timeline series presents given events along a drawn line.
  87491. *
  87492. * In TypeScript the type option must always be set.
  87493. *
  87494. * Configuration options for the series are given in three levels:
  87495. *
  87496. * 1. Options for all series in a chart are defined in the plotOptions.series
  87497. * object.
  87498. *
  87499. * 2. Options for all `timeline` series are defined in plotOptions.timeline.
  87500. *
  87501. * 3. Options for one single series are given in the series instance array. (see
  87502. * online documentation for example)
  87503. */
  87504. export interface PlotTimelineOptions {
  87505. /**
  87506. * (Highcharts) Accessibility options for a series.
  87507. */
  87508. accessibility?: SeriesAccessibilityOptionsObject;
  87509. /**
  87510. * (Highmaps) Whether all areas of the map defined in `mapData` should be
  87511. * rendered. If `true`, areas which don't correspond to a data point, are
  87512. * rendered as `null` points. If `false`, those areas are skipped.
  87513. */
  87514. allAreas?: boolean;
  87515. /**
  87516. * (Highcharts) Allow this series' points to be selected by clicking on the
  87517. * graphic (columns, point markers, pie slices, map areas etc).
  87518. *
  87519. * The selected points can be handled by point select and unselect events,
  87520. * or collectively by the getSelectedPoints function.
  87521. *
  87522. * And alternative way of selecting points is through dragging.
  87523. */
  87524. allowPointSelect?: boolean;
  87525. /**
  87526. * (Highcharts) Enable or disable the initial animation when a series is
  87527. * displayed. The animation can also be set as a configuration object.
  87528. * Please note that this option only applies to the initial animation of the
  87529. * series itself. For other animations, see chart.animation and the
  87530. * animation parameter under the API methods. The following properties are
  87531. * supported:
  87532. *
  87533. * - `defer`: The animation delay time in milliseconds.
  87534. *
  87535. * - `duration`: The duration of the animation in milliseconds.
  87536. *
  87537. * - `easing`: Can be a string reference to an easing function set on the
  87538. * `Math` object or a function. See the _Custom easing function_ demo below.
  87539. *
  87540. * Due to poor performance, animation is disabled in old IE browsers for
  87541. * several chart types.
  87542. */
  87543. animation?: (boolean|PlotTimelineAnimationOptions|Partial<AnimationOptionsObject>);
  87544. /**
  87545. * (Highmaps) The border color of the map areas.
  87546. *
  87547. * In styled mode, the border stroke is given in the `.highcharts-point`
  87548. * class.
  87549. */
  87550. borderColor?: (ColorString|GradientColorObject|PatternObject);
  87551. /**
  87552. * (Highmaps) The border width of each map area.
  87553. *
  87554. * In styled mode, the border stroke width is given in the
  87555. * `.highcharts-point` class.
  87556. */
  87557. borderWidth?: number;
  87558. /**
  87559. * (Highcharts) An additional class name to apply to the series' graphical
  87560. * elements. This option does not replace default class names of the
  87561. * graphical element.
  87562. */
  87563. className?: string;
  87564. /**
  87565. * (Highcharts) Disable this option to allow series rendering in the whole
  87566. * plotting area.
  87567. *
  87568. * **Note:** Clipping should be always enabled when chart.zoomType is set
  87569. */
  87570. clip?: boolean;
  87571. /**
  87572. * (Highcharts) The main color of the series. In line type series it applies
  87573. * to the line and the point markers unless otherwise specified. In bar type
  87574. * series it applies to the bars unless a color is specified per point. The
  87575. * default value is pulled from the `options.colors` array.
  87576. *
  87577. * In styled mode, the color can be defined by the colorIndex option. Also,
  87578. * the series color can be set with the `.highcharts-series`,
  87579. * `.highcharts-color-{n}`, `.highcharts-{type}-series` or
  87580. * `.highcharts-series-{n}` class, or individual classes given by the
  87581. * `className` option.
  87582. */
  87583. color?: (ColorString|GradientColorObject|PatternObject);
  87584. /**
  87585. * (Highcharts, Highstock, Highmaps) When using dual or multiple color axes,
  87586. * this number defines which colorAxis the particular series is connected
  87587. * to. It refers to either the axis id or the index of the axis in the
  87588. * colorAxis array, with 0 being the first. Set this option to false to
  87589. * prevent a series from connecting to the default color axis.
  87590. *
  87591. * Since v7.2.0 the option can also be an axis id or an axis index instead
  87592. * of a boolean flag.
  87593. */
  87594. colorAxis?: (boolean|number|string);
  87595. colorByPoint?: boolean;
  87596. /**
  87597. * (Highcharts) Styled mode only. A specific color index to use for the
  87598. * series, so its graphic representations are given the class name
  87599. * `highcharts-color-{n}`.
  87600. */
  87601. colorIndex?: number;
  87602. /**
  87603. * (Highcharts, Highstock, Highmaps) Determines what data value should be
  87604. * used to calculate point color if `colorAxis` is used. Requires to set
  87605. * `min` and `max` if some custom point property is used or if approximation
  87606. * for data grouping is set to `'sum'`.
  87607. */
  87608. colorKey?: string;
  87609. /**
  87610. * (Highstock) Compare the values of the series against the first non-null,
  87611. * non- zero value in the visible range. The y axis will show percentage or
  87612. * absolute change depending on whether `compare` is set to `"percent"` or
  87613. * `"value"`. When this is applied to multiple series, it allows comparing
  87614. * the development of the series against each other. Adds a `change` field
  87615. * to every point object.
  87616. */
  87617. compare?: string;
  87618. /**
  87619. * (Highstock) When compare is `percent`, this option dictates whether to
  87620. * use 0 or 100 as the base of comparison.
  87621. */
  87622. compareBase?: (0|100);
  87623. /**
  87624. * (Highstock) Defines if comparison should start from the first point
  87625. * within the visible range or should start from the first point **before**
  87626. * the range.
  87627. *
  87628. * In other words, this flag determines if first point within the visible
  87629. * range will have 0% (`compareStart=true`) or should have been already
  87630. * calculated according to the previous point (`compareStart=false`).
  87631. */
  87632. compareStart?: boolean;
  87633. /**
  87634. * (Gantt) Override Pathfinder connector options for a series. Requires
  87635. * Highcharts Gantt to be loaded.
  87636. */
  87637. connectors?: SeriesConnectorsOptionsObject;
  87638. /**
  87639. * (Highcharts, Highstock, Gantt) When true, each point or column edge is
  87640. * rounded to its nearest pixel in order to render sharp on screen. In some
  87641. * cases, when there are a lot of densely packed columns, this leads to
  87642. * visible difference in column widths or distance between columns. In these
  87643. * cases, setting `crisp` to `false` may look better, even though each
  87644. * column is rendered blurry.
  87645. */
  87646. crisp?: boolean;
  87647. /**
  87648. * (Highcharts) You can set the cursor to "pointer" if you have click events
  87649. * attached to the series, to signal to the user that the points and lines
  87650. * can be clicked.
  87651. *
  87652. * In styled mode, the series cursor can be set with the same classes as
  87653. * listed under series.color.
  87654. */
  87655. cursor?: (string|CursorValue);
  87656. /**
  87657. * (Highcharts) A reserved subspace to store options and values for
  87658. * customized functionality. Here you can add additional data for your own
  87659. * event callbacks and formatter callbacks.
  87660. */
  87661. custom?: Dictionary<any>;
  87662. /**
  87663. * (Highstock) Data grouping is the concept of sampling the data values into
  87664. * larger blocks in order to ease readability and increase performance of
  87665. * the JavaScript charts. Highstock by default applies data grouping when
  87666. * the points become closer than a certain pixel value, determined by the
  87667. * `groupPixelWidth` option.
  87668. *
  87669. * If data grouping is applied, the grouping information of grouped points
  87670. * can be read from the Point.dataGroup. If point options other than the
  87671. * data itself are set, for example `name` or `color` or custom properties,
  87672. * the grouping logic doesn't know how to group it. In this case the options
  87673. * of the first point instance are copied over to the group point. This can
  87674. * be altered through a custom `approximation` callback function.
  87675. */
  87676. dataGrouping?: DataGroupingOptionsObject;
  87677. /**
  87678. * (Highcharts, Highstock, Highmaps, Gantt) Options for the series data
  87679. * labels, appearing next to each data point.
  87680. *
  87681. * Since v6.2.0, multiple data labels can be applied to each single point by
  87682. * defining them as an array of configs.
  87683. *
  87684. * In styled mode, the data labels can be styled with the
  87685. * `.highcharts-data-label-box` and `.highcharts-data-label` class names
  87686. * (see example).
  87687. */
  87688. dataLabels?: (TimelineDataLabelsOptionsObject|Array<TimelineDataLabelsOptionsObject>);
  87689. /**
  87690. * (Highcharts) A description of the series to add to the screen reader
  87691. * information about the series.
  87692. */
  87693. description?: string;
  87694. /**
  87695. * (Highcharts) The draggable-points module allows points to be moved around
  87696. * or modified in the chart. In addition to the options mentioned under the
  87697. * `dragDrop` API structure, the module fires three events, point.dragStart,
  87698. * point.drag and point.drop.
  87699. */
  87700. dragDrop?: SeriesDragDropOptionsObject;
  87701. /**
  87702. * (Highcharts) Enable or disable the mouse tracking for a specific series.
  87703. * This includes point tooltips and click events on graphs and points. For
  87704. * large datasets it improves performance.
  87705. */
  87706. enableMouseTracking?: boolean;
  87707. /**
  87708. * (Highcharts) General event handlers for the series items. These event
  87709. * hooks can also be attached to the series at run time using the
  87710. * `Highcharts.addEvent` function.
  87711. */
  87712. events?: SeriesEventsOptionsObject;
  87713. /**
  87714. * (Highstock) Defines when to display a gap in the graph, together with the
  87715. * gapUnit option.
  87716. *
  87717. * In case when `dataGrouping` is enabled, points can be grouped into a
  87718. * larger time span. This can make the grouped points to have a greater
  87719. * distance than the absolute value of `gapSize` property, which will result
  87720. * in disappearing graph completely. To prevent this situation the mentioned
  87721. * distance between grouped points is used instead of previously defined
  87722. * `gapSize`.
  87723. *
  87724. * In practice, this option is most often used to visualize gaps in time
  87725. * series. In a stock chart, intraday data is available for daytime hours,
  87726. * while gaps will appear in nights and weekends.
  87727. */
  87728. gapSize?: number;
  87729. /**
  87730. * (Highstock) Together with gapSize, this option defines where to draw gaps
  87731. * in the graph.
  87732. *
  87733. * When the `gapUnit` is `"relative"` (default), a gap size of 5 means that
  87734. * if the distance between two points is greater than 5 times that of the
  87735. * two closest points, the graph will be broken.
  87736. *
  87737. * When the `gapUnit` is `"value"`, the gap is based on absolute axis
  87738. * values, which on a datetime axis is milliseconds. This also applies to
  87739. * the navigator series that inherits gap options from the base series.
  87740. */
  87741. gapUnit?: OptionsGapUnitValue;
  87742. ignoreHiddenPoint?: boolean;
  87743. /**
  87744. * (Highcharts) When set to `false` will prevent the series data from being
  87745. * included in any form of data export.
  87746. *
  87747. * Since version 6.0.0 until 7.1.0 the option was existing undocumented as
  87748. * `includeInCSVExport`.
  87749. */
  87750. includeInDataExport?: boolean;
  87751. /**
  87752. * (Highmaps) What property to join the `mapData` to the value data. For
  87753. * example, if joinBy is "code", the mapData items with a specific code is
  87754. * merged into the data with the same code. For maps loaded from GeoJSON,
  87755. * the keys may be held in each point's `properties` object.
  87756. *
  87757. * The joinBy option can also be an array of two values, where the first
  87758. * points to a key in the `mapData`, and the second points to another key in
  87759. * the `data`.
  87760. *
  87761. * When joinBy is `null`, the map items are joined by their position in the
  87762. * array, which performs much better in maps with many data points. This is
  87763. * the recommended option if you are printing more than a thousand data
  87764. * points and have a backend that can preprocess the data into a parallel
  87765. * array of the mapData.
  87766. */
  87767. joinBy?: (string|Array<string>);
  87768. /**
  87769. * (Highcharts) An array specifying which option maps to which key in the
  87770. * data point array. This makes it convenient to work with unstructured data
  87771. * arrays from different sources.
  87772. */
  87773. keys?: Array<string>;
  87774. /**
  87775. * (Highcharts, Highstock, Gantt) Series labels are placed as close to the
  87776. * series as possible in a natural way, seeking to avoid other series. The
  87777. * goal of this feature is to make the chart more easily readable, like if a
  87778. * human designer placed the labels in the optimal position.
  87779. *
  87780. * The series labels currently work with series types having a `graph` or an
  87781. * `area`.
  87782. */
  87783. label?: SeriesLabelOptionsObject;
  87784. /**
  87785. * (Highstock) The line marks the last price from all points.
  87786. */
  87787. lastPrice?: SeriesLastPriceOptionsObject;
  87788. /**
  87789. * (Highstock) The line marks the last price from visible range of points.
  87790. */
  87791. lastVisiblePrice?: SeriesLastVisiblePriceOptionsObject;
  87792. /**
  87793. * (Highcharts, Highstock) The SVG value used for the `stroke-linecap` and
  87794. * `stroke-linejoin` of a line graph. Round means that lines are rounded in
  87795. * the ends and bends.
  87796. */
  87797. linecap?: SeriesLinecapValue;
  87798. lineWidth?: number;
  87799. /**
  87800. * (Highcharts, Highstock, Gantt) The id of another series to link to.
  87801. * Additionally, the value can be ":previous" to link to the previous
  87802. * series. When two series are linked, only the first one appears in the
  87803. * legend. Toggling the visibility of this also toggles the linked series.
  87804. *
  87805. * If master series uses data sorting and linked series does not have its
  87806. * own sorting definition, the linked series will be sorted in the same
  87807. * order as the master one.
  87808. */
  87809. linkedTo?: string;
  87810. /**
  87811. * (Highcharts) Options for the point markers of line-like series.
  87812. * Properties like `fillColor`, `lineColor` and `lineWidth` define the
  87813. * visual appearance of the markers. Other series types, like column series,
  87814. * don't have markers, but have visual options on the series level instead.
  87815. *
  87816. * In styled mode, the markers can be styled with the `.highcharts-point`,
  87817. * `.highcharts-point-hover` and `.highcharts-point-select` class names.
  87818. */
  87819. marker?: PointMarkerOptionsObject;
  87820. /**
  87821. * (Highstock) Options for the corresponding navigator series if
  87822. * `showInNavigator` is `true` for this series. Available options are the
  87823. * same as any series, documented at plotOptions and series.
  87824. *
  87825. * These options are merged with options in navigator.series, and will take
  87826. * precedence if the same option is defined both places.
  87827. */
  87828. navigatorOptions?: PlotSeriesOptions;
  87829. /**
  87830. * (Highcharts) Opacity of a series parts: line, fill (e.g. area) and
  87831. * dataLabels.
  87832. */
  87833. opacity?: number;
  87834. /**
  87835. * (Highcharts) Properties for each single point.
  87836. */
  87837. point?: PlotSeriesPointOptions;
  87838. /**
  87839. * (Highcharts) Same as accessibility.pointDescriptionFormatter, but for an
  87840. * individual series. Overrides the chart wide configuration.
  87841. */
  87842. pointDescriptionFormatter?: Function;
  87843. /**
  87844. * (Highstock) The width of each point on the x axis. For example in a
  87845. * column chart with one value each day, the pointRange would be 1 day (= 24
  87846. * * 3600
  87847. *
  87848. * * 1000 milliseconds). This is normally computed automatically, but this
  87849. * option can be used to override the automatic value.
  87850. */
  87851. pointRange?: number;
  87852. /**
  87853. * (Highcharts) Whether to select the series initially. If `showCheckbox` is
  87854. * true, the checkbox next to the series name in the legend will be checked
  87855. * for a selected series.
  87856. */
  87857. selected?: boolean;
  87858. /**
  87859. * (Highcharts) Whether to apply a drop shadow to the graph line. Since 2.3
  87860. * the shadow can be an object configuration containing `color`, `offsetX`,
  87861. * `offsetY`, `opacity` and `width`.
  87862. */
  87863. shadow?: (boolean|ShadowOptionsObject);
  87864. /**
  87865. * (Highcharts) If true, a checkbox is displayed next to the legend item to
  87866. * allow selecting the series. The state of the checkbox is determined by
  87867. * the `selected` option.
  87868. */
  87869. showCheckbox?: boolean;
  87870. /**
  87871. * (Highcharts) Whether to display this particular series or series type in
  87872. * the legend. Standalone series are shown in legend by default, and linked
  87873. * series are not. Since v7.2.0 it is possible to show series that use
  87874. * colorAxis by setting this option to `true`.
  87875. */
  87876. showInLegend?: boolean;
  87877. /**
  87878. * (Highstock) Whether or not to show the series in the navigator. Takes
  87879. * precedence over navigator.baseSeries if defined.
  87880. */
  87881. showInNavigator?: boolean;
  87882. /**
  87883. * (Highcharts) If set to `true`, the accessibility module will skip past
  87884. * the points in this series for keyboard navigation.
  87885. */
  87886. skipKeyboardNavigation?: boolean;
  87887. states?: SeriesStatesOptionsObject;
  87888. /**
  87889. * (Highcharts) Sticky tracking of mouse events. When true, the `mouseOut`
  87890. * event on a series isn't triggered until the mouse moves over another
  87891. * series, or out of the plot area. When false, the `mouseOut` event on a
  87892. * series is triggered when the mouse leaves the area around the series'
  87893. * graph or markers. This also implies the tooltip when not shared. When
  87894. * `stickyTracking` is false and `tooltip.shared` is false, the tooltip will
  87895. * be hidden when moving the mouse between series. Defaults to true for line
  87896. * and area type series, but to false for columns, pies etc.
  87897. *
  87898. * **Note:** The boost module will force this option because of technical
  87899. * limitations.
  87900. */
  87901. stickyTracking?: boolean;
  87902. /**
  87903. * (Highcharts) A configuration object for the tooltip rendering of each
  87904. * single series. Properties are inherited from tooltip, but only the
  87905. * following properties can be defined on a series level.
  87906. */
  87907. tooltip?: SeriesTooltipOptionsObject;
  87908. /**
  87909. * (Highstock) The parameter allows setting line series type and use OHLC
  87910. * indicators. Data in OHLC format is required.
  87911. */
  87912. useOhlcData?: boolean;
  87913. /**
  87914. * (Highcharts) Set the initial visibility of the series.
  87915. */
  87916. visible?: boolean;
  87917. /**
  87918. * (Highmaps) Define the z index of the series.
  87919. */
  87920. zIndex?: number;
  87921. }
  87922. /**
  87923. * (Highcharts) Enable or disable the initial animation when a series is
  87924. * displayed. The animation can also be set as a configuration object. Please
  87925. * note that this option only applies to the initial animation of the series
  87926. * itself. For other animations, see chart.animation and the animation parameter
  87927. * under the API methods. The following properties are supported:
  87928. *
  87929. * - `defer`: The animation delay time in milliseconds.
  87930. *
  87931. * - `duration`: The duration of the animation in milliseconds.
  87932. *
  87933. * - `easing`: Can be a string reference to an easing function set on the `Math`
  87934. * object or a function. See the _Custom easing function_ demo below.
  87935. *
  87936. * Due to poor performance, animation is disabled in old IE browsers for several
  87937. * chart types.
  87938. */
  87939. export interface PlotTreemapAnimationOptions {
  87940. defer?: number;
  87941. }
  87942. export interface PlotTreemapClusterEventsOptions {
  87943. /**
  87944. * (Highcharts, Highmaps) Fires when the cluster point is clicked and
  87945. * `drillToCluster` is enabled. One parameter, `event`, is passed to the
  87946. * function. The default action is to zoom to the cluster points range. This
  87947. * can be prevented by calling `event.preventDefault()`.
  87948. */
  87949. drillToCluster?: MarkerClusterDrillCallbackFunction;
  87950. }
  87951. /**
  87952. * (Highcharts, Highmaps) Options for layout algorithm. Inside there are options
  87953. * to change the type of the algorithm, gridSize, distance or iterations.
  87954. */
  87955. export interface PlotTreemapClusterLayoutAlgorithmOptions {
  87956. /**
  87957. * (Highcharts, Highmaps) When `type` is set to `kmeans`, `distance` is a
  87958. * maximum distance between point and cluster center so that this point will
  87959. * be inside the cluster. The distance is either a number defining pixels or
  87960. * a percentage defining a percentage of the plot area width.
  87961. */
  87962. distance?: (number|string);
  87963. /**
  87964. * (Highcharts, Highmaps) When `type` is set to the `grid`, `gridSize` is a
  87965. * size of a grid square element either as a number defining pixels, or a
  87966. * percentage defining a percentage of the plot area width.
  87967. */
  87968. gridSize?: (number|string);
  87969. /**
  87970. * (Highcharts, Highmaps) When `type` is set to `kmeans`, `iterations` are
  87971. * the number of iterations that this algorithm will be repeated to find
  87972. * clusters positions.
  87973. */
  87974. iterations?: number;
  87975. /**
  87976. * (Highcharts, Highmaps) When `type` is set to `undefined` and there are
  87977. * more visible points than the kmeansThreshold the `grid` algorithm is used
  87978. * to find clusters, otherwise `kmeans`. It ensures good performance on
  87979. * large datasets and better clusters arrangement after the zoom.
  87980. */
  87981. kmeansThreshold?: number;
  87982. /**
  87983. * (Highcharts, Highmaps) Type of the algorithm used to combine points into
  87984. * a cluster. There are three available algorithms:
  87985. *
  87986. * 1) `grid` - grid-based clustering technique. Points are assigned to
  87987. * squares of set size depending on their position on the plot area. Points
  87988. * inside the grid square are combined into a cluster. The grid size can be
  87989. * controlled by `gridSize` property (grid size changes at certain zoom
  87990. * levels).
  87991. *
  87992. * 2) `kmeans` - based on K-Means clustering technique. In the first step,
  87993. * points are divided using the grid method (distance property is a grid
  87994. * size) to find the initial amount of clusters. Next, each point is
  87995. * classified by computing the distance between each cluster center and that
  87996. * point. When the closest cluster distance is lower than distance property
  87997. * set by a user the point is added to this cluster otherwise is classified
  87998. * as `noise`. The algorithm is repeated until each cluster center not
  87999. * change its previous position more than one pixel. This technique is more
  88000. * accurate but also more time consuming than the `grid` algorithm,
  88001. * especially for big datasets.
  88002. *
  88003. * 3) `optimizedKmeans` - based on K-Means clustering technique. This
  88004. * algorithm uses k-means algorithm only on the chart initialization or when
  88005. * chart extremes have greater range than on initialization. When a chart is
  88006. * redrawn the algorithm checks only clustered points distance from the
  88007. * cluster center and rebuild it when the point is spaced enough to be
  88008. * outside the cluster. It provides performance improvement and more stable
  88009. * clusters position yet can be used rather on small and sparse datasets.
  88010. *
  88011. * By default, the algorithm depends on visible quantity of points and
  88012. * `kmeansThreshold`. When there are more visible points than the
  88013. * `kmeansThreshold` the `grid` algorithm is used, otherwise `kmeans`.
  88014. *
  88015. * The custom clustering algorithm can be added by assigning a callback
  88016. * function as the type property. This function takes an array of
  88017. * `processedXData`, `processedYData`, `processedXData` indexes and
  88018. * `layoutAlgorithm` options as arguments and should return an object with
  88019. * grouped data.
  88020. *
  88021. * The algorithm should return an object like that: (see online
  88022. * documentation for example)
  88023. *
  88024. * `clusterId` (example above - unique id of a cluster or noise) is an array
  88025. * of points belonging to a cluster. If the array has only one point or
  88026. * fewer points than set in `cluster.minimumClusterSize` it won't be
  88027. * combined into a cluster.
  88028. */
  88029. type?: (string|Function);
  88030. }
  88031. /**
  88032. * (Highcharts, Highmaps) Options for marker clusters, the concept of sampling
  88033. * the data values into larger blocks in order to ease readability and increase
  88034. * performance of the JavaScript charts.
  88035. *
  88036. * Note: marker clusters module is not working with `boost` and
  88037. * `draggable-points` modules.
  88038. *
  88039. * The marker clusters feature requires the marker-clusters.js file to be
  88040. * loaded, found in the modules directory of the download package, or online at
  88041. * code.highcharts.com/modules/marker-clusters.js.
  88042. */
  88043. export interface PlotTreemapClusterOptions {
  88044. /**
  88045. * (Highcharts, Highmaps) When set to `false` prevent cluster overlapping -
  88046. * this option works only when `layoutAlgorithm.type = "grid"`.
  88047. */
  88048. allowOverlap?: boolean;
  88049. /**
  88050. * (Highcharts, Highmaps) Options for the cluster marker animation.
  88051. */
  88052. animation?: (boolean|Partial<AnimationOptionsObject>);
  88053. /**
  88054. * (Highcharts, Highmaps) Options for the cluster data labels.
  88055. */
  88056. dataLabels?: DataLabelsOptions;
  88057. /**
  88058. * (Highcharts, Highmaps) Zoom the plot area to the cluster points range
  88059. * when a cluster is clicked.
  88060. */
  88061. drillToCluster?: boolean;
  88062. /**
  88063. * (Highcharts, Highmaps) Whether to enable the marker-clusters module.
  88064. */
  88065. enabled?: boolean;
  88066. events?: PlotTreemapClusterEventsOptions;
  88067. /**
  88068. * (Highcharts, Highmaps) Options for layout algorithm. Inside there are
  88069. * options to change the type of the algorithm, gridSize, distance or
  88070. * iterations.
  88071. */
  88072. layoutAlgorithm?: PlotTreemapClusterLayoutAlgorithmOptions;
  88073. /**
  88074. * (Highcharts, Highmaps) Options for the cluster marker.
  88075. */
  88076. marker?: PointMarkerOptionsObject;
  88077. /**
  88078. * (Highcharts, Highmaps) The minimum amount of points to be combined into a
  88079. * cluster. This value has to be greater or equal to 2.
  88080. */
  88081. minimumClusterSize?: number;
  88082. states?: PlotTreemapClusterStatesOptions;
  88083. /**
  88084. * (Highcharts, Highmaps) An array defining zones within marker clusters.
  88085. *
  88086. * In styled mode, the color zones are styled with the
  88087. * `.highcharts-cluster-zone-{n}` class, or custom classed from the
  88088. * `className` option.
  88089. */
  88090. zones?: Array<PlotTreemapClusterZonesOptions>;
  88091. }
  88092. export interface PlotTreemapClusterStatesHoverOptions {
  88093. /**
  88094. * (Highcharts, Highmaps) The fill color of the cluster marker in hover
  88095. * state. When `undefined`, the series' or point's fillColor for normal
  88096. * state is used.
  88097. */
  88098. fillColor?: ColorType;
  88099. }
  88100. export interface PlotTreemapClusterStatesOptions {
  88101. hover?: PlotTreemapClusterStatesHoverOptions;
  88102. }
  88103. /**
  88104. * (Highcharts, Highmaps) An array defining zones within marker clusters.
  88105. *
  88106. * In styled mode, the color zones are styled with the
  88107. * `.highcharts-cluster-zone-{n}` class, or custom classed from the `className`
  88108. * option.
  88109. */
  88110. export interface PlotTreemapClusterZonesOptions {
  88111. /**
  88112. * (Highcharts, Highmaps) Styled mode only. A custom class name for the
  88113. * zone.
  88114. */
  88115. className?: string;
  88116. /**
  88117. * (Highcharts, Highmaps) The value where the zone starts.
  88118. */
  88119. from?: number;
  88120. /**
  88121. * (Highcharts, Highmaps) Settings for the cluster marker belonging to the
  88122. * zone.
  88123. */
  88124. marker?: PointMarkerOptionsObject;
  88125. /**
  88126. * (Highcharts, Highmaps) The value where the zone ends.
  88127. */
  88128. to?: number;
  88129. }
  88130. /**
  88131. * (Highcharts, Highstock, Highmaps, Gantt) Enable or disable the initial
  88132. * animation when a series is displayed for the `dataLabels`. The animation can
  88133. * also be set as a configuration object. Please note that this option only
  88134. * applies to the initial animation. For other animations, see chart.animation
  88135. * and the animation parameter under the API methods. The following properties
  88136. * are supported:
  88137. *
  88138. * - `defer`: The animation delay time in milliseconds.
  88139. */
  88140. export interface PlotTreemapDataLabelsAnimationOptions {
  88141. /**
  88142. * (Highcharts, Highstock, Highmaps, Gantt) The animation delay time in
  88143. * milliseconds. Set to `0` renders dataLabel immediately. As `undefined`
  88144. * inherits defer time from the series.animation.defer.
  88145. */
  88146. defer?: number;
  88147. }
  88148. /**
  88149. * (Highcharts, Highstock, Highmaps, Gantt) Options for the series data labels,
  88150. * appearing next to each data point.
  88151. *
  88152. * Since v6.2.0, multiple data labels can be applied to each single point by
  88153. * defining them as an array of configs.
  88154. *
  88155. * In styled mode, the data labels can be styled with the
  88156. * `.highcharts-data-label-box` and `.highcharts-data-label` class names (see
  88157. * example).
  88158. */
  88159. export interface PlotTreemapDataLabelsOptions {
  88160. /**
  88161. * (Highcharts, Highstock, Highmaps, Gantt) The alignment of the data label
  88162. * compared to the point. If `right`, the right side of the label should be
  88163. * touching the point. For points with an extent, like columns, the
  88164. * alignments also dictates how to align it inside the box, as given with
  88165. * the inside option. Can be one of `left`, `center` or `right`.
  88166. */
  88167. align?: (AlignValue|null);
  88168. /**
  88169. * (Highcharts, Highstock, Highmaps, Gantt) Whether to allow data labels to
  88170. * overlap. To make the labels less sensitive for overlapping, the
  88171. * dataLabels.padding can be set to 0.
  88172. */
  88173. allowOverlap?: boolean;
  88174. /**
  88175. * (Highcharts, Highstock, Highmaps, Gantt) Enable or disable the initial
  88176. * animation when a series is displayed for the `dataLabels`. The animation
  88177. * can also be set as a configuration object. Please note that this option
  88178. * only applies to the initial animation. For other animations, see
  88179. * chart.animation and the animation parameter under the API methods. The
  88180. * following properties are supported:
  88181. *
  88182. * - `defer`: The animation delay time in milliseconds.
  88183. */
  88184. animation?: (boolean|PlotTreemapDataLabelsAnimationOptions|Partial<AnimationOptionsObject>);
  88185. /**
  88186. * (Highcharts, Highstock, Highmaps, Gantt) The background color or gradient
  88187. * for the data label.
  88188. */
  88189. backgroundColor?: (ColorString|GradientColorObject|PatternObject);
  88190. /**
  88191. * (Highcharts, Highstock, Highmaps, Gantt) The border color for the data
  88192. * label. Defaults to `undefined`.
  88193. */
  88194. borderColor?: (ColorString|GradientColorObject|PatternObject);
  88195. /**
  88196. * (Highcharts, Highstock, Highmaps, Gantt) The border radius in pixels for
  88197. * the data label.
  88198. */
  88199. borderRadius?: number;
  88200. /**
  88201. * (Highcharts, Highstock, Highmaps, Gantt) The border width in pixels for
  88202. * the data label.
  88203. */
  88204. borderWidth?: number;
  88205. /**
  88206. * (Highcharts, Highstock, Highmaps, Gantt) A class name for the data label.
  88207. * Particularly in styled mode, this can be used to give each series' or
  88208. * point's data label unique styling. In addition to this option, a default
  88209. * color class name is added so that we can give the labels a contrast text
  88210. * shadow.
  88211. */
  88212. className?: string;
  88213. /**
  88214. * (Highcharts, Highstock, Highmaps, Gantt) The text color for the data
  88215. * labels. Defaults to `undefined`. For certain series types, like column or
  88216. * map, the data labels can be drawn inside the points. In this case the
  88217. * data label will be drawn with maximum contrast by default. Additionally,
  88218. * it will be given a `text-outline` style with the opposite color, to
  88219. * further increase the contrast. This can be overridden by setting the
  88220. * `text-outline` style to `none` in the `dataLabels.style` option.
  88221. */
  88222. color?: (ColorString|GradientColorObject|PatternObject);
  88223. /**
  88224. * (Highcharts, Highstock, Highmaps, Gantt) Whether to hide data labels that
  88225. * are outside the plot area. By default, the data label is moved inside the
  88226. * plot area according to the overflow option.
  88227. */
  88228. crop?: boolean;
  88229. /**
  88230. * (Highcharts, Highstock, Gantt) Whether to defer displaying the data
  88231. * labels until the initial series animation has finished. Setting to
  88232. * `false` renders the data label immediately. If set to `true` inherits the
  88233. * defer time set in plotOptions.series.animation.
  88234. */
  88235. defer?: boolean;
  88236. /**
  88237. * (Highcharts, Highstock, Highmaps, Gantt) Enable or disable the data
  88238. * labels.
  88239. */
  88240. enabled?: boolean;
  88241. /**
  88242. * (Highcharts, Highstock, Highmaps, Gantt) A declarative filter to control
  88243. * of which data labels to display. The declarative filter is designed for
  88244. * use when callback functions are not available, like when the chart
  88245. * options require a pure JSON structure or for use with graphical editors.
  88246. * For programmatic control, use the `formatter` instead, and return
  88247. * `undefined` to disable a single data label.
  88248. */
  88249. filter?: DataLabelsFilterOptionsObject;
  88250. /**
  88251. * (Highcharts, Highstock, Highmaps, Gantt) A format string for the data
  88252. * label. Available variables are the same as for `formatter`.
  88253. */
  88254. format?: string;
  88255. /**
  88256. * (Highcharts, Highstock, Highmaps, Gantt) Callback JavaScript function to
  88257. * format the data label. Note that if a `format` is defined, the format
  88258. * takes precedence and the formatter is ignored.
  88259. */
  88260. formatter?: DataLabelsFormatterCallbackFunction;
  88261. /**
  88262. * (Highcharts, Highstock, Highmaps, Gantt) For points with an extent, like
  88263. * columns or map areas, whether to align the data label inside the box or
  88264. * to the actual value point. Defaults to `false` in most cases, `true` in
  88265. * stacked columns.
  88266. */
  88267. inside?: boolean;
  88268. /**
  88269. * (Highcharts, Highstock, Highmaps, Gantt) Format for points with the value
  88270. * of null. Works analogously to format. `nullFormat` can be applied only to
  88271. * series which support displaying null points.
  88272. */
  88273. nullFormat?: (boolean|string);
  88274. /**
  88275. * (Highcharts, Highstock, Highmaps, Gantt) Callback JavaScript function
  88276. * that defines formatting for points with the value of null. Works
  88277. * analogously to formatter. `nullPointFormatter` can be applied only to
  88278. * series which support displaying null points.
  88279. */
  88280. nullFormatter?: DataLabelsFormatterCallbackFunction;
  88281. /**
  88282. * (Highcharts, Highstock, Highmaps, Gantt) How to handle data labels that
  88283. * flow outside the plot area. The default is `"justify"`, which aligns them
  88284. * inside the plot area. For columns and bars, this means it will be moved
  88285. * inside the bar. To display data labels outside the plot area, set `crop`
  88286. * to `false` and `overflow` to `"allow"`.
  88287. */
  88288. overflow?: DataLabelsOverflowValue;
  88289. /**
  88290. * (Highcharts, Highstock, Highmaps, Gantt) When either the `borderWidth` or
  88291. * the `backgroundColor` is set, this is the padding within the box.
  88292. */
  88293. padding?: number;
  88294. /**
  88295. * (Highcharts, Highstock, Highmaps, Gantt) Aligns data labels relative to
  88296. * points. If `center` alignment is not possible, it defaults to `right`.
  88297. */
  88298. position?: AlignValue;
  88299. /**
  88300. * (Highcharts, Highstock, Highmaps, Gantt) Text rotation in degrees. Note
  88301. * that due to a more complex structure, backgrounds, borders and padding
  88302. * will be lost on a rotated data label.
  88303. */
  88304. rotation?: number;
  88305. /**
  88306. * (Highcharts, Highstock, Highmaps, Gantt) The shadow of the box. Works
  88307. * best with `borderWidth` or `backgroundColor`. Since 2.3 the shadow can be
  88308. * an object configuration containing `color`, `offsetX`, `offsetY`,
  88309. * `opacity` and `width`.
  88310. */
  88311. shadow?: (boolean|ShadowOptionsObject);
  88312. /**
  88313. * (Highcharts, Highstock, Highmaps, Gantt) The name of a symbol to use for
  88314. * the border around the label. Symbols are predefined functions on the
  88315. * Renderer object.
  88316. */
  88317. shape?: string;
  88318. /**
  88319. * (Highcharts, Highstock, Highmaps, Gantt) Styles for the label. The
  88320. * default `color` setting is `"contrast"`, which is a pseudo color that
  88321. * Highcharts picks up and applies the maximum contrast to the underlying
  88322. * point item, for example the bar in a bar chart.
  88323. *
  88324. * The `textOutline` is a pseudo property that applies an outline of the
  88325. * given width with the given color, which by default is the maximum
  88326. * contrast to the text. So a bright text color will result in a black text
  88327. * outline for maximum readability on a mixed background. In some cases,
  88328. * especially with grayscale text, the text outline doesn't work well, in
  88329. * which cases it can be disabled by setting it to `"none"`. When `useHTML`
  88330. * is true, the `textOutline` will not be picked up. In this, case, the same
  88331. * effect can be acheived through the `text-shadow` CSS property.
  88332. *
  88333. * For some series types, where each point has an extent, like for example
  88334. * tree maps, the data label may overflow the point. There are two
  88335. * strategies for handling overflow. By default, the text will wrap to
  88336. * multiple lines. The other strategy is to set `style.textOverflow` to
  88337. * `ellipsis`, which will keep the text on one line plus it will break
  88338. * inside long words.
  88339. */
  88340. style?: CSSObject;
  88341. /**
  88342. * (Highcharts, Highstock, Highmaps, Gantt) Options for a label text which
  88343. * should follow marker's shape. Border and background are disabled for a
  88344. * label that follows a path.
  88345. *
  88346. * **Note:** Only SVG-based renderer supports this option. Setting `useHTML`
  88347. * to true will disable this option.
  88348. */
  88349. textPath?: DataLabelsTextPathOptionsObject;
  88350. /**
  88351. * (Highcharts, Highstock, Highmaps, Gantt) Whether to use HTML to render
  88352. * the labels.
  88353. */
  88354. useHTML?: boolean;
  88355. /**
  88356. * (Highcharts, Highstock, Highmaps, Gantt) The vertical alignment of a data
  88357. * label. Can be one of `top`, `middle` or `bottom`. The default value
  88358. * depends on the data, for instance in a column chart, the label is above
  88359. * positive values and below negative values.
  88360. */
  88361. verticalAlign?: string;
  88362. /**
  88363. * (Highcharts, Highstock, Highmaps, Gantt) The x position offset of the
  88364. * label relative to the point in pixels.
  88365. */
  88366. x?: number;
  88367. /**
  88368. * (Highcharts, Highstock, Highmaps, Gantt) The y position offset of the
  88369. * label relative to the point in pixels.
  88370. */
  88371. y?: number;
  88372. /**
  88373. * (Highcharts, Highstock, Highmaps, Gantt) The Z index of the data labels.
  88374. * The default Z index puts it above the series. Use a Z index of 2 to
  88375. * display it behind the series.
  88376. */
  88377. z?: number;
  88378. }
  88379. /**
  88380. * (Highcharts) A configuration object to define how the color of a child varies
  88381. * from the parent's color. The variation is distributed among the children of
  88382. * node. For example when setting brightness, the brightness change will range
  88383. * from the parent's original brightness on the first child, to the amount set
  88384. * in the `to` setting on the last node. This allows a gradient-like color
  88385. * scheme that sets children out from each other while highlighting the grouping
  88386. * on treemaps and sectors on sunburst charts.
  88387. */
  88388. export interface PlotTreemapLevelsColorVariationOptions {
  88389. /**
  88390. * (Highcharts) The key of a color variation. Currently supports
  88391. * `brightness` only.
  88392. */
  88393. key?: "brightness";
  88394. /**
  88395. * (Highcharts) The ending value of a color variation. The last sibling will
  88396. * receive this value.
  88397. */
  88398. to?: number;
  88399. }
  88400. /**
  88401. * (Highcharts) Enable or disable the initial animation when a series is
  88402. * displayed for the `dataLabels`. The animation can also be set as a
  88403. * configuration object. Please note that this option only applies to the
  88404. * initial animation. For other animations, see chart.animation and the
  88405. * animation parameter under the API methods. The following properties are
  88406. * supported:
  88407. *
  88408. * - `defer`: The animation delay time in milliseconds.
  88409. */
  88410. export interface PlotTreemapLevelsDataLabelsAnimationOptions {
  88411. /**
  88412. * (Highcharts) The animation delay time in milliseconds. Set to `0` renders
  88413. * dataLabel immediately. As `undefined` inherits defer time from the
  88414. * series.animation.defer.
  88415. */
  88416. defer?: number;
  88417. }
  88418. /**
  88419. * (Highcharts) Can set the options of dataLabels on each point which lies on
  88420. * the level. plotOptions.treemap.dataLabels for possible values.
  88421. */
  88422. export interface PlotTreemapLevelsDataLabelsOptions {
  88423. /**
  88424. * (Highcharts) The alignment of the data label compared to the point. If
  88425. * `right`, the right side of the label should be touching the point. For
  88426. * points with an extent, like columns, the alignments also dictates how to
  88427. * align it inside the box, as given with the inside option. Can be one of
  88428. * `left`, `center` or `right`.
  88429. */
  88430. align?: (AlignValue|null);
  88431. /**
  88432. * (Highcharts) Whether to allow data labels to overlap. To make the labels
  88433. * less sensitive for overlapping, the dataLabels.padding can be set to 0.
  88434. */
  88435. allowOverlap?: boolean;
  88436. /**
  88437. * (Highcharts) Enable or disable the initial animation when a series is
  88438. * displayed for the `dataLabels`. The animation can also be set as a
  88439. * configuration object. Please note that this option only applies to the
  88440. * initial animation. For other animations, see chart.animation and the
  88441. * animation parameter under the API methods. The following properties are
  88442. * supported:
  88443. *
  88444. * - `defer`: The animation delay time in milliseconds.
  88445. */
  88446. animation?: (boolean|PlotTreemapLevelsDataLabelsAnimationOptions|Partial<AnimationOptionsObject>);
  88447. /**
  88448. * (Highcharts) The background color or gradient for the data label.
  88449. */
  88450. backgroundColor?: (ColorString|GradientColorObject|PatternObject);
  88451. /**
  88452. * (Highcharts) The border color for the data label. Defaults to
  88453. * `undefined`.
  88454. */
  88455. borderColor?: (ColorString|GradientColorObject|PatternObject);
  88456. /**
  88457. * (Highcharts) The border radius in pixels for the data label.
  88458. */
  88459. borderRadius?: number;
  88460. /**
  88461. * (Highcharts) The border width in pixels for the data label.
  88462. */
  88463. borderWidth?: number;
  88464. /**
  88465. * (Highcharts) A class name for the data label. Particularly in styled
  88466. * mode, this can be used to give each series' or point's data label unique
  88467. * styling. In addition to this option, a default color class name is added
  88468. * so that we can give the labels a contrast text shadow.
  88469. */
  88470. className?: string;
  88471. /**
  88472. * (Highcharts) The text color for the data labels. Defaults to `undefined`.
  88473. * For certain series types, like column or map, the data labels can be
  88474. * drawn inside the points. In this case the data label will be drawn with
  88475. * maximum contrast by default. Additionally, it will be given a
  88476. * `text-outline` style with the opposite color, to further increase the
  88477. * contrast. This can be overridden by setting the `text-outline` style to
  88478. * `none` in the `dataLabels.style` option.
  88479. */
  88480. color?: (ColorString|GradientColorObject|PatternObject);
  88481. /**
  88482. * (Highcharts) Whether to hide data labels that are outside the plot area.
  88483. * By default, the data label is moved inside the plot area according to the
  88484. * overflow option.
  88485. */
  88486. crop?: boolean;
  88487. /**
  88488. * (Highcharts, Highstock, Gantt) Whether to defer displaying the data
  88489. * labels until the initial series animation has finished. Setting to
  88490. * `false` renders the data label immediately. If set to `true` inherits the
  88491. * defer time set in plotOptions.series.animation.
  88492. */
  88493. defer?: boolean;
  88494. /**
  88495. * (Highcharts) Enable or disable the data labels.
  88496. */
  88497. enabled?: boolean;
  88498. /**
  88499. * (Highcharts) A declarative filter to control of which data labels to
  88500. * display. The declarative filter is designed for use when callback
  88501. * functions are not available, like when the chart options require a pure
  88502. * JSON structure or for use with graphical editors. For programmatic
  88503. * control, use the `formatter` instead, and return `undefined` to disable a
  88504. * single data label.
  88505. */
  88506. filter?: DataLabelsFilterOptionsObject;
  88507. /**
  88508. * (Highcharts) A format string for the data label. Available variables are
  88509. * the same as for `formatter`.
  88510. */
  88511. format?: string;
  88512. /**
  88513. * (Highcharts) Callback JavaScript function to format the data label. Note
  88514. * that if a `format` is defined, the format takes precedence and the
  88515. * formatter is ignored.
  88516. */
  88517. formatter?: DataLabelsFormatterCallbackFunction;
  88518. /**
  88519. * (Highcharts) For points with an extent, like columns or map areas,
  88520. * whether to align the data label inside the box or to the actual value
  88521. * point. Defaults to `false` in most cases, `true` in stacked columns.
  88522. */
  88523. inside?: boolean;
  88524. /**
  88525. * (Highcharts) Format for points with the value of null. Works analogously
  88526. * to format. `nullFormat` can be applied only to series which support
  88527. * displaying null points.
  88528. */
  88529. nullFormat?: (boolean|string);
  88530. /**
  88531. * (Highcharts) Callback JavaScript function that defines formatting for
  88532. * points with the value of null. Works analogously to formatter.
  88533. * `nullPointFormatter` can be applied only to series which support
  88534. * displaying null points.
  88535. */
  88536. nullFormatter?: DataLabelsFormatterCallbackFunction;
  88537. /**
  88538. * (Highcharts) How to handle data labels that flow outside the plot area.
  88539. * The default is `"justify"`, which aligns them inside the plot area. For
  88540. * columns and bars, this means it will be moved inside the bar. To display
  88541. * data labels outside the plot area, set `crop` to `false` and `overflow`
  88542. * to `"allow"`.
  88543. */
  88544. overflow?: DataLabelsOverflowValue;
  88545. /**
  88546. * (Highcharts) When either the `borderWidth` or the `backgroundColor` is
  88547. * set, this is the padding within the box.
  88548. */
  88549. padding?: number;
  88550. /**
  88551. * (Highcharts) Aligns data labels relative to points. If `center` alignment
  88552. * is not possible, it defaults to `right`.
  88553. */
  88554. position?: AlignValue;
  88555. /**
  88556. * (Highcharts) Text rotation in degrees. Note that due to a more complex
  88557. * structure, backgrounds, borders and padding will be lost on a rotated
  88558. * data label.
  88559. */
  88560. rotation?: number;
  88561. /**
  88562. * (Highcharts) The shadow of the box. Works best with `borderWidth` or
  88563. * `backgroundColor`. Since 2.3 the shadow can be an object configuration
  88564. * containing `color`, `offsetX`, `offsetY`, `opacity` and `width`.
  88565. */
  88566. shadow?: (boolean|ShadowOptionsObject);
  88567. /**
  88568. * (Highcharts) The name of a symbol to use for the border around the label.
  88569. * Symbols are predefined functions on the Renderer object.
  88570. */
  88571. shape?: string;
  88572. /**
  88573. * (Highcharts) Styles for the label. The default `color` setting is
  88574. * `"contrast"`, which is a pseudo color that Highcharts picks up and
  88575. * applies the maximum contrast to the underlying point item, for example
  88576. * the bar in a bar chart.
  88577. *
  88578. * The `textOutline` is a pseudo property that applies an outline of the
  88579. * given width with the given color, which by default is the maximum
  88580. * contrast to the text. So a bright text color will result in a black text
  88581. * outline for maximum readability on a mixed background. In some cases,
  88582. * especially with grayscale text, the text outline doesn't work well, in
  88583. * which cases it can be disabled by setting it to `"none"`. When `useHTML`
  88584. * is true, the `textOutline` will not be picked up. In this, case, the same
  88585. * effect can be acheived through the `text-shadow` CSS property.
  88586. *
  88587. * For some series types, where each point has an extent, like for example
  88588. * tree maps, the data label may overflow the point. There are two
  88589. * strategies for handling overflow. By default, the text will wrap to
  88590. * multiple lines. The other strategy is to set `style.textOverflow` to
  88591. * `ellipsis`, which will keep the text on one line plus it will break
  88592. * inside long words.
  88593. */
  88594. style?: CSSObject;
  88595. /**
  88596. * (Highcharts) Options for a label text which should follow marker's shape.
  88597. * Border and background are disabled for a label that follows a path.
  88598. *
  88599. * **Note:** Only SVG-based renderer supports this option. Setting `useHTML`
  88600. * to true will disable this option.
  88601. */
  88602. textPath?: DataLabelsTextPathOptionsObject;
  88603. /**
  88604. * (Highcharts) Whether to use HTML to render the labels.
  88605. */
  88606. useHTML?: boolean;
  88607. /**
  88608. * (Highcharts) The vertical alignment of a data label. Can be one of `top`,
  88609. * `middle` or `bottom`. The default value depends on the data, for instance
  88610. * in a column chart, the label is above positive values and below negative
  88611. * values.
  88612. */
  88613. verticalAlign?: string;
  88614. /**
  88615. * (Highcharts) The x position offset of the label relative to the point in
  88616. * pixels.
  88617. */
  88618. x?: number;
  88619. /**
  88620. * (Highcharts) The y position offset of the label relative to the point in
  88621. * pixels.
  88622. */
  88623. y?: number;
  88624. /**
  88625. * (Highcharts) The Z index of the data labels. The default Z index puts it
  88626. * above the series. Use a Z index of 2 to display it behind the series.
  88627. */
  88628. z?: number;
  88629. }
  88630. /**
  88631. * (Highcharts) Set options on specific levels. Takes precedence over series
  88632. * options, but not point options.
  88633. */
  88634. export interface PlotTreemapLevelsOptions {
  88635. /**
  88636. * (Highcharts) Can set a `borderColor` on all points which lies on the same
  88637. * level.
  88638. */
  88639. borderColor?: ColorString;
  88640. /**
  88641. * (Highcharts) Set the dash style of the border of all the point which lies
  88642. * on the level. See plotOptions.scatter.dashStyle for possible options.
  88643. */
  88644. borderDashStyle?: DashStyleValue;
  88645. /**
  88646. * (Highcharts) Can set the borderWidth on all points which lies on the same
  88647. * level.
  88648. */
  88649. borderWidth?: number;
  88650. /**
  88651. * (Highcharts) Can set a color on all points which lies on the same level.
  88652. */
  88653. color?: (ColorString|GradientColorObject|PatternObject);
  88654. /**
  88655. * (Highcharts) A configuration object to define how the color of a child
  88656. * varies from the parent's color. The variation is distributed among the
  88657. * children of node. For example when setting brightness, the brightness
  88658. * change will range from the parent's original brightness on the first
  88659. * child, to the amount set in the `to` setting on the last node. This
  88660. * allows a gradient-like color scheme that sets children out from each
  88661. * other while highlighting the grouping on treemaps and sectors on sunburst
  88662. * charts.
  88663. */
  88664. colorVariation?: PlotTreemapLevelsColorVariationOptions;
  88665. /**
  88666. * (Highcharts) Can set the options of dataLabels on each point which lies
  88667. * on the level. plotOptions.treemap.dataLabels for possible values.
  88668. */
  88669. dataLabels?: (PlotTreemapLevelsDataLabelsOptions|Array<PlotTreemapLevelsDataLabelsOptions>);
  88670. /**
  88671. * (Highcharts) Can set the layoutAlgorithm option on a specific level.
  88672. */
  88673. layoutAlgorithm?: OptionsLayoutAlgorithmValue;
  88674. /**
  88675. * (Highcharts) Can set the layoutStartingDirection option on a specific
  88676. * level.
  88677. */
  88678. layoutStartingDirection?: OptionsLayoutStartingDirectionValue;
  88679. /**
  88680. * (Highcharts) Decides which level takes effect from the options set in the
  88681. * levels object.
  88682. */
  88683. level?: number;
  88684. }
  88685. /**
  88686. * (Highcharts) A treemap displays hierarchical data using nested rectangles.
  88687. * The data can be laid out in varying ways depending on options.
  88688. *
  88689. * In TypeScript the type option must always be set.
  88690. *
  88691. * Configuration options for the series are given in three levels:
  88692. *
  88693. * 1. Options for all series in a chart are defined in the plotOptions.series
  88694. * object.
  88695. *
  88696. * 2. Options for all `treemap` series are defined in plotOptions.treemap.
  88697. *
  88698. * 3. Options for one single series are given in the series instance array. (see
  88699. * online documentation for example)
  88700. */
  88701. export interface PlotTreemapOptions {
  88702. /**
  88703. * (Highcharts) Accessibility options for a series.
  88704. */
  88705. accessibility?: SeriesAccessibilityOptionsObject;
  88706. /**
  88707. * (Highmaps) Whether all areas of the map defined in `mapData` should be
  88708. * rendered. If `true`, areas which don't correspond to a data point, are
  88709. * rendered as `null` points. If `false`, those areas are skipped.
  88710. */
  88711. allAreas?: boolean;
  88712. /**
  88713. * (Highcharts) Allow this series' points to be selected by clicking on the
  88714. * graphic (columns, point markers, pie slices, map areas etc).
  88715. *
  88716. * The selected points can be handled by point select and unselect events,
  88717. * or collectively by the getSelectedPoints function.
  88718. *
  88719. * And alternative way of selecting points is through dragging.
  88720. */
  88721. allowPointSelect?: boolean;
  88722. /**
  88723. * (Highcharts) When enabled the user can click on a point which is a parent
  88724. * and zoom in on its children.
  88725. */
  88726. allowTraversingTree?: boolean;
  88727. /**
  88728. * (Highcharts) Enabling this option will make the treemap alternate the
  88729. * drawing direction between vertical and horizontal. The next levels
  88730. * starting direction will always be the opposite of the previous.
  88731. */
  88732. alternateStartingDirection?: boolean;
  88733. /**
  88734. * (Highcharts) Enable or disable the initial animation when a series is
  88735. * displayed. The animation can also be set as a configuration object.
  88736. * Please note that this option only applies to the initial animation of the
  88737. * series itself. For other animations, see chart.animation and the
  88738. * animation parameter under the API methods. The following properties are
  88739. * supported:
  88740. *
  88741. * - `defer`: The animation delay time in milliseconds.
  88742. *
  88743. * - `duration`: The duration of the animation in milliseconds.
  88744. *
  88745. * - `easing`: Can be a string reference to an easing function set on the
  88746. * `Math` object or a function. See the _Custom easing function_ demo below.
  88747. *
  88748. * Due to poor performance, animation is disabled in old IE browsers for
  88749. * several chart types.
  88750. */
  88751. animation?: (boolean|PlotTreemapAnimationOptions|Partial<AnimationOptionsObject>);
  88752. /**
  88753. * (Highcharts) For some series, there is a limit that shuts down initial
  88754. * animation by default when the total number of points in the chart is too
  88755. * high. For example, for a column chart and its derivatives, animation does
  88756. * not run if there is more than 250 points totally. To disable this cap,
  88757. * set `animationLimit` to `Infinity`.
  88758. */
  88759. animationLimit?: number;
  88760. /**
  88761. * (Highcharts) Sets the color blending in the boost module.
  88762. */
  88763. boostBlending?: OptionsBoostBlendingValue;
  88764. /**
  88765. * (Highcharts) Set the point threshold for when a series should enter boost
  88766. * mode.
  88767. *
  88768. * Setting it to e.g. 2000 will cause the series to enter boost mode when
  88769. * there are 2000 or more points in the series.
  88770. *
  88771. * To disable boosting on the series, set the `boostThreshold` to 0. Setting
  88772. * it to 1 will force boosting.
  88773. *
  88774. * Note that the cropThreshold also affects this setting. When zooming in on
  88775. * a series that has fewer points than the `cropThreshold`, all points are
  88776. * rendered although outside the visible plot area, and the `boostThreshold`
  88777. * won't take effect.
  88778. */
  88779. boostThreshold?: number;
  88780. /**
  88781. * (Highmaps) The color of the border surrounding each tree map item.
  88782. */
  88783. borderColor?: ColorString;
  88784. /**
  88785. * (Highmaps) The width of the border surrounding each tree map item.
  88786. */
  88787. borderWidth?: number;
  88788. /**
  88789. * (Highcharts) An additional class name to apply to the series' graphical
  88790. * elements. This option does not replace default class names of the
  88791. * graphical element.
  88792. */
  88793. className?: string;
  88794. /**
  88795. * (Highcharts) Disable this option to allow series rendering in the whole
  88796. * plotting area.
  88797. *
  88798. * **Note:** Clipping should be always enabled when chart.zoomType is set
  88799. */
  88800. clip?: boolean;
  88801. /**
  88802. * (Highcharts, Highmaps) Options for marker clusters, the concept of
  88803. * sampling the data values into larger blocks in order to ease readability
  88804. * and increase performance of the JavaScript charts.
  88805. *
  88806. * Note: marker clusters module is not working with `boost` and
  88807. * `draggable-points` modules.
  88808. *
  88809. * The marker clusters feature requires the marker-clusters.js file to be
  88810. * loaded, found in the modules directory of the download package, or online
  88811. * at code.highcharts.com/modules/marker-clusters.js.
  88812. */
  88813. cluster?: PlotTreemapClusterOptions;
  88814. /**
  88815. * (Highcharts) The main color of the series. In line type series it applies
  88816. * to the line and the point markers unless otherwise specified. In bar type
  88817. * series it applies to the bars unless a color is specified per point. The
  88818. * default value is pulled from the `options.colors` array.
  88819. *
  88820. * In styled mode, the color can be defined by the colorIndex option. Also,
  88821. * the series color can be set with the `.highcharts-series`,
  88822. * `.highcharts-color-{n}`, `.highcharts-{type}-series` or
  88823. * `.highcharts-series-{n}` class, or individual classes given by the
  88824. * `className` option.
  88825. */
  88826. color?: (ColorString|GradientColorObject|PatternObject);
  88827. /**
  88828. * (Highcharts, Highstock, Highmaps) When using dual or multiple color axes,
  88829. * this number defines which colorAxis the particular series is connected
  88830. * to. It refers to either the axis id or the index of the axis in the
  88831. * colorAxis array, with 0 being the first. Set this option to false to
  88832. * prevent a series from connecting to the default color axis.
  88833. *
  88834. * Since v7.2.0 the option can also be an axis id or an axis index instead
  88835. * of a boolean flag.
  88836. */
  88837. colorAxis?: (boolean|number|string);
  88838. /**
  88839. * (Highcharts) When using automatic point colors pulled from the
  88840. * `options.colors` collection, this option determines whether the chart
  88841. * should receive one color per series or one color per point.
  88842. */
  88843. colorByPoint?: object;
  88844. /**
  88845. * (Highcharts) Styled mode only. A specific color index to use for the
  88846. * series, so its graphic representations are given the class name
  88847. * `highcharts-color-{n}`.
  88848. */
  88849. colorIndex?: number;
  88850. /**
  88851. * (Highcharts, Highstock, Highmaps) Determines what data value should be
  88852. * used to calculate point color if `colorAxis` is used. Requires to set
  88853. * `min` and `max` if some custom point property is used or if approximation
  88854. * for data grouping is set to `'sum'`.
  88855. */
  88856. colorKey?: string;
  88857. /**
  88858. * (Highcharts) A series specific or series type specific color set to apply
  88859. * instead of the global colors when colorByPoint is true.
  88860. */
  88861. colors?: Array<(ColorString|GradientColorObject|PatternObject)>;
  88862. /**
  88863. * (Highstock) Compare the values of the series against the first non-null,
  88864. * non- zero value in the visible range. The y axis will show percentage or
  88865. * absolute change depending on whether `compare` is set to `"percent"` or
  88866. * `"value"`. When this is applied to multiple series, it allows comparing
  88867. * the development of the series against each other. Adds a `change` field
  88868. * to every point object.
  88869. */
  88870. compare?: string;
  88871. /**
  88872. * (Highstock) When compare is `percent`, this option dictates whether to
  88873. * use 0 or 100 as the base of comparison.
  88874. */
  88875. compareBase?: (0|100);
  88876. /**
  88877. * (Highstock) Defines if comparison should start from the first point
  88878. * within the visible range or should start from the first point **before**
  88879. * the range.
  88880. *
  88881. * In other words, this flag determines if first point within the visible
  88882. * range will have 0% (`compareStart=true`) or should have been already
  88883. * calculated according to the previous point (`compareStart=false`).
  88884. */
  88885. compareStart?: boolean;
  88886. /**
  88887. * (Highcharts) Polar charts only. Whether to connect the ends of a line
  88888. * series plot across the extremes.
  88889. */
  88890. connectEnds?: boolean;
  88891. /**
  88892. * (Highcharts, Highstock) Whether to connect a graph line across null
  88893. * points, or render a gap between the two points on either side of the
  88894. * null.
  88895. */
  88896. connectNulls?: boolean;
  88897. /**
  88898. * (Gantt) Override Pathfinder connector options for a series. Requires
  88899. * Highcharts Gantt to be loaded.
  88900. */
  88901. connectors?: SeriesConnectorsOptionsObject;
  88902. /**
  88903. * (Highcharts, Highstock, Gantt) When true, each point or column edge is
  88904. * rounded to its nearest pixel in order to render sharp on screen. In some
  88905. * cases, when there are a lot of densely packed columns, this leads to
  88906. * visible difference in column widths or distance between columns. In these
  88907. * cases, setting `crisp` to `false` may look better, even though each
  88908. * column is rendered blurry.
  88909. */
  88910. crisp?: boolean;
  88911. /**
  88912. * (Highcharts) When the series contains less points than the crop
  88913. * threshold, all points are drawn, event if the points fall outside the
  88914. * visible plot area at the current zoom. The advantage of drawing all
  88915. * points (including markers and columns), is that animation is performed on
  88916. * updates. On the other hand, when the series contains more points than the
  88917. * crop threshold, the series data is cropped to only contain points that
  88918. * fall within the plot area. The advantage of cropping away invisible
  88919. * points is to increase performance on large series.
  88920. */
  88921. cropThreshold?: number;
  88922. /**
  88923. * (Highcharts) You can set the cursor to "pointer" if you have click events
  88924. * attached to the series, to signal to the user that the points and lines
  88925. * can be clicked.
  88926. *
  88927. * In styled mode, the series cursor can be set with the same classes as
  88928. * listed under series.color.
  88929. */
  88930. cursor?: (string|CursorValue);
  88931. /**
  88932. * (Highcharts) A reserved subspace to store options and values for
  88933. * customized functionality. Here you can add additional data for your own
  88934. * event callbacks and formatter callbacks.
  88935. */
  88936. custom?: Dictionary<any>;
  88937. /**
  88938. * (Highcharts) Name of the dash style to use for the graph, or for some
  88939. * series types the outline of each shape.
  88940. *
  88941. * In styled mode, the stroke dash-array can be set with the same classes as
  88942. * listed under series.color.
  88943. */
  88944. dashStyle?: DashStyleValue;
  88945. /**
  88946. * (Highstock) Data grouping is the concept of sampling the data values into
  88947. * larger blocks in order to ease readability and increase performance of
  88948. * the JavaScript charts. Highstock by default applies data grouping when
  88949. * the points become closer than a certain pixel value, determined by the
  88950. * `groupPixelWidth` option.
  88951. *
  88952. * If data grouping is applied, the grouping information of grouped points
  88953. * can be read from the Point.dataGroup. If point options other than the
  88954. * data itself are set, for example `name` or `color` or custom properties,
  88955. * the grouping logic doesn't know how to group it. In this case the options
  88956. * of the first point instance are copied over to the group point. This can
  88957. * be altered through a custom `approximation` callback function.
  88958. */
  88959. dataGrouping?: DataGroupingOptionsObject;
  88960. /**
  88961. * (Highcharts, Highstock, Highmaps, Gantt) Options for the series data
  88962. * labels, appearing next to each data point.
  88963. *
  88964. * Since v6.2.0, multiple data labels can be applied to each single point by
  88965. * defining them as an array of configs.
  88966. *
  88967. * In styled mode, the data labels can be styled with the
  88968. * `.highcharts-data-label-box` and `.highcharts-data-label` class names
  88969. * (see example).
  88970. */
  88971. dataLabels?: (PlotTreemapDataLabelsOptions|Array<PlotTreemapDataLabelsOptions>);
  88972. /**
  88973. * (Highcharts) A description of the series to add to the screen reader
  88974. * information about the series.
  88975. */
  88976. description?: string;
  88977. /**
  88978. * (Highcharts) Enable or disable the mouse tracking for a specific series.
  88979. * This includes point tooltips and click events on graphs and points. For
  88980. * large datasets it improves performance.
  88981. */
  88982. enableMouseTracking?: boolean;
  88983. /**
  88984. * (Highcharts) General event handlers for the series items. These event
  88985. * hooks can also be attached to the series at run time using the
  88986. * `Highcharts.addEvent` function.
  88987. */
  88988. events?: SeriesEventsOptionsObject;
  88989. /**
  88990. * (Highcharts) Determines whether the series should look for the nearest
  88991. * point in both dimensions or just the x-dimension when hovering the
  88992. * series. Defaults to `'xy'` for scatter series and `'x'` for most other
  88993. * series. If the data has duplicate x-values, it is recommended to set this
  88994. * to `'xy'` to allow hovering over all points.
  88995. *
  88996. * Applies only to series types using nearest neighbor search (not direct
  88997. * hover) for tooltip.
  88998. */
  88999. findNearestPointBy?: OptionsFindNearestPointByValue;
  89000. /**
  89001. * (Highstock) Defines when to display a gap in the graph, together with the
  89002. * gapUnit option.
  89003. *
  89004. * In case when `dataGrouping` is enabled, points can be grouped into a
  89005. * larger time span. This can make the grouped points to have a greater
  89006. * distance than the absolute value of `gapSize` property, which will result
  89007. * in disappearing graph completely. To prevent this situation the mentioned
  89008. * distance between grouped points is used instead of previously defined
  89009. * `gapSize`.
  89010. *
  89011. * In practice, this option is most often used to visualize gaps in time
  89012. * series. In a stock chart, intraday data is available for daytime hours,
  89013. * while gaps will appear in nights and weekends.
  89014. */
  89015. gapSize?: number;
  89016. /**
  89017. * (Highstock) Together with gapSize, this option defines where to draw gaps
  89018. * in the graph.
  89019. *
  89020. * When the `gapUnit` is `"relative"` (default), a gap size of 5 means that
  89021. * if the distance between two points is greater than 5 times that of the
  89022. * two closest points, the graph will be broken.
  89023. *
  89024. * When the `gapUnit` is `"value"`, the gap is based on absolute axis
  89025. * values, which on a datetime axis is milliseconds. This also applies to
  89026. * the navigator series that inherits gap options from the base series.
  89027. */
  89028. gapUnit?: OptionsGapUnitValue;
  89029. /**
  89030. * (Highcharts, Highstock, Gantt) Whether to use the Y extremes of the total
  89031. * chart width or only the zoomed area when zooming in on parts of the X
  89032. * axis. By default, the Y axis adjusts to the min and max of the visible
  89033. * data. Cartesian series only.
  89034. */
  89035. getExtremesFromAll?: boolean;
  89036. /**
  89037. * (Highcharts) Whether to ignore hidden points when the layout algorithm
  89038. * runs. If `false`, hidden points will leave open spaces.
  89039. */
  89040. ignoreHiddenPoint?: boolean;
  89041. /**
  89042. * (Highcharts) When set to `false` will prevent the series data from being
  89043. * included in any form of data export.
  89044. *
  89045. * Since version 6.0.0 until 7.1.0 the option was existing undocumented as
  89046. * `includeInCSVExport`.
  89047. */
  89048. includeInDataExport?: boolean;
  89049. /**
  89050. * (Highcharts) This option decides if the user can interact with the parent
  89051. * nodes or just the leaf nodes. When this option is undefined, it will be
  89052. * true by default. However when allowTraversingTree is true, then it will
  89053. * be false by default.
  89054. */
  89055. interactByLeaf?: boolean;
  89056. /**
  89057. * (Highmaps) What property to join the `mapData` to the value data. For
  89058. * example, if joinBy is "code", the mapData items with a specific code is
  89059. * merged into the data with the same code. For maps loaded from GeoJSON,
  89060. * the keys may be held in each point's `properties` object.
  89061. *
  89062. * The joinBy option can also be an array of two values, where the first
  89063. * points to a key in the `mapData`, and the second points to another key in
  89064. * the `data`.
  89065. *
  89066. * When joinBy is `null`, the map items are joined by their position in the
  89067. * array, which performs much better in maps with many data points. This is
  89068. * the recommended option if you are printing more than a thousand data
  89069. * points and have a backend that can preprocess the data into a parallel
  89070. * array of the mapData.
  89071. */
  89072. joinBy?: (string|Array<string>);
  89073. /**
  89074. * (Highcharts) An array specifying which option maps to which key in the
  89075. * data point array. This makes it convenient to work with unstructured data
  89076. * arrays from different sources.
  89077. */
  89078. keys?: Array<string>;
  89079. /**
  89080. * (Highcharts, Highstock, Gantt) Series labels are placed as close to the
  89081. * series as possible in a natural way, seeking to avoid other series. The
  89082. * goal of this feature is to make the chart more easily readable, like if a
  89083. * human designer placed the labels in the optimal position.
  89084. *
  89085. * The series labels currently work with series types having a `graph` or an
  89086. * `area`.
  89087. */
  89088. label?: SeriesLabelOptionsObject;
  89089. /**
  89090. * (Highstock) The line marks the last price from all points.
  89091. */
  89092. lastPrice?: SeriesLastPriceOptionsObject;
  89093. /**
  89094. * (Highstock) The line marks the last price from visible range of points.
  89095. */
  89096. lastVisiblePrice?: SeriesLastVisiblePriceOptionsObject;
  89097. /**
  89098. * (Highcharts) This option decides which algorithm is used for setting
  89099. * position and dimensions of the points.
  89100. */
  89101. layoutAlgorithm?: OptionsLayoutAlgorithmValue;
  89102. /**
  89103. * (Highcharts) Defines which direction the layout algorithm will start
  89104. * drawing.
  89105. */
  89106. layoutStartingDirection?: OptionsLayoutStartingDirectionValue;
  89107. /**
  89108. * (Highcharts) Used together with the levels and allowTraversingTree
  89109. * options. When set to false the first level visible to be level one, which
  89110. * is dynamic when traversing the tree. Otherwise the level will be the same
  89111. * as the tree structure.
  89112. */
  89113. levelIsConstant?: boolean;
  89114. /**
  89115. * (Highcharts) Set options on specific levels. Takes precedence over series
  89116. * options, but not point options.
  89117. */
  89118. levels?: Array<PlotTreemapLevelsOptions>;
  89119. /**
  89120. * (Highcharts, Highstock) The SVG value used for the `stroke-linecap` and
  89121. * `stroke-linejoin` of a line graph. Round means that lines are rounded in
  89122. * the ends and bends.
  89123. */
  89124. linecap?: SeriesLinecapValue;
  89125. /**
  89126. * (Highcharts, Highstock) The width of the line connecting the data points.
  89127. */
  89128. lineWidth?: number;
  89129. /**
  89130. * (Highcharts, Highstock, Gantt) The id of another series to link to.
  89131. * Additionally, the value can be ":previous" to link to the previous
  89132. * series. When two series are linked, only the first one appears in the
  89133. * legend. Toggling the visibility of this also toggles the linked series.
  89134. *
  89135. * If master series uses data sorting and linked series does not have its
  89136. * own sorting definition, the linked series will be sorted in the same
  89137. * order as the master one.
  89138. */
  89139. linkedTo?: string;
  89140. /**
  89141. * (Highstock) Options for the corresponding navigator series if
  89142. * `showInNavigator` is `true` for this series. Available options are the
  89143. * same as any series, documented at plotOptions and series.
  89144. *
  89145. * These options are merged with options in navigator.series, and will take
  89146. * precedence if the same option is defined both places.
  89147. */
  89148. navigatorOptions?: PlotSeriesOptions;
  89149. /**
  89150. * (Highcharts) The color for the parts of the graph or points that are
  89151. * below the threshold. Note that `zones` takes precedence over the negative
  89152. * color. Using `negativeColor` is equivalent to applying a zone with value
  89153. * of 0.
  89154. */
  89155. negativeColor?: (ColorString|GradientColorObject|PatternObject);
  89156. /**
  89157. * (Highcharts) The opacity of a point in treemap. When a point has
  89158. * children, the visibility of the children is determined by the opacity.
  89159. */
  89160. opacity?: number;
  89161. /**
  89162. * (Highcharts) Properties for each single point.
  89163. */
  89164. point?: PlotSeriesPointOptions;
  89165. /**
  89166. * (Highcharts) Same as accessibility.pointDescriptionFormatter, but for an
  89167. * individual series. Overrides the chart wide configuration.
  89168. */
  89169. pointDescriptionFormatter?: Function;
  89170. /**
  89171. * (Highcharts, Highstock, Gantt) If no x values are given for the points in
  89172. * a series, `pointInterval` defines the interval of the x values. For
  89173. * example, if a series contains one value every decade starting from year
  89174. * 0, set `pointInterval` to `10`. In true `datetime` axes, the
  89175. * `pointInterval` is set in milliseconds.
  89176. *
  89177. * It can be also be combined with `pointIntervalUnit` to draw irregular
  89178. * time intervals.
  89179. *
  89180. * Please note that this options applies to the _series data_, not the
  89181. * interval of the axis ticks, which is independent.
  89182. */
  89183. pointInterval?: number;
  89184. /**
  89185. * (Highcharts, Highstock, Gantt) On datetime series, this allows for
  89186. * setting the pointInterval to irregular time units, `day`, `month` and
  89187. * `year`. A day is usually the same as 24 hours, but `pointIntervalUnit`
  89188. * also takes the DST crossover into consideration when dealing with local
  89189. * time. Combine this option with `pointInterval` to draw weeks, quarters, 6
  89190. * months, 10 years etc.
  89191. *
  89192. * Please note that this options applies to the _series data_, not the
  89193. * interval of the axis ticks, which is independent.
  89194. */
  89195. pointIntervalUnit?: OptionsPointIntervalUnitValue;
  89196. /**
  89197. * (Highstock) The width of each point on the x axis. For example in a
  89198. * column chart with one value each day, the pointRange would be 1 day (= 24
  89199. * * 3600
  89200. *
  89201. * * 1000 milliseconds). This is normally computed automatically, but this
  89202. * option can be used to override the automatic value.
  89203. */
  89204. pointRange?: number;
  89205. /**
  89206. * (Highcharts, Highstock, Gantt) If no x values are given for the points in
  89207. * a series, pointStart defines on what value to start. For example, if a
  89208. * series contains one yearly value starting from 1945, set pointStart to
  89209. * 1945.
  89210. */
  89211. pointStart?: number;
  89212. /**
  89213. * (Highcharts) Whether to select the series initially. If `showCheckbox` is
  89214. * true, the checkbox next to the series name in the legend will be checked
  89215. * for a selected series.
  89216. */
  89217. selected?: boolean;
  89218. /**
  89219. * (Highcharts) If true, a checkbox is displayed next to the legend item to
  89220. * allow selecting the series. The state of the checkbox is determined by
  89221. * the `selected` option.
  89222. */
  89223. showCheckbox?: boolean;
  89224. /**
  89225. * (Highcharts) Whether to display this series type or specific series item
  89226. * in the legend.
  89227. */
  89228. showInLegend?: boolean;
  89229. /**
  89230. * (Highstock) Whether or not to show the series in the navigator. Takes
  89231. * precedence over navigator.baseSeries if defined.
  89232. */
  89233. showInNavigator?: boolean;
  89234. /**
  89235. * (Highcharts) If set to `true`, the accessibility module will skip past
  89236. * the points in this series for keyboard navigation.
  89237. */
  89238. skipKeyboardNavigation?: boolean;
  89239. /**
  89240. * (Highcharts, Highstock) When this is true, the series will not cause the
  89241. * Y axis to cross the zero plane (or threshold option) unless the data
  89242. * actually crosses the plane.
  89243. *
  89244. * For example, if `softThreshold` is `false`, a series of 0, 1, 2, 3 will
  89245. * make the Y axis show negative values according to the `minPadding`
  89246. * option. If `softThreshold` is `true`, the Y axis starts at 0.
  89247. */
  89248. softThreshold?: boolean;
  89249. /**
  89250. * (Highcharts) The sort index of the point inside the treemap level.
  89251. */
  89252. sortIndex?: number;
  89253. /**
  89254. * (Highcharts, Highstock) Whether to stack the values of each series on top
  89255. * of each other. Possible values are `undefined` to disable, `"normal"` to
  89256. * stack by value or `"percent"`.
  89257. *
  89258. * When stacking is enabled, data must be sorted in ascending X order.
  89259. *
  89260. * Some stacking options are related to specific series types. In the
  89261. * streamgraph series type, the stacking option is set to `"stream"`. The
  89262. * second one is `"overlap"`, which only applies to waterfall series.
  89263. */
  89264. stacking?: OptionsStackingValue;
  89265. /**
  89266. * (Highcharts) A wrapper object for all the series options in specific
  89267. * states.
  89268. */
  89269. states?: SeriesStatesOptionsObject;
  89270. /**
  89271. * (Highcharts, Highstock) Whether to apply steps to the line. Possible
  89272. * values are `left`, `center` and `right`.
  89273. */
  89274. step?: OptionsStepValue;
  89275. /**
  89276. * (Highcharts, Highstock) Sticky tracking of mouse events. When true, the
  89277. * `mouseOut` event on a series isn't triggered until the mouse moves over
  89278. * another series, or out of the plot area. When false, the `mouseOut` event
  89279. * on a series is triggered when the mouse leaves the area around the
  89280. * series' graph or markers. This also implies the tooltip. When
  89281. * `stickyTracking` is false and `tooltip.shared` is false, the tooltip will
  89282. * be hidden when moving the mouse between series.
  89283. */
  89284. stickyTracking?: boolean;
  89285. /**
  89286. * (Highcharts, Highstock) The threshold, also called zero level or base
  89287. * level. For line type series this is only used in conjunction with
  89288. * negativeColor.
  89289. */
  89290. threshold?: (number|null);
  89291. /**
  89292. * (Highcharts, Highstock) A configuration object for the tooltip rendering
  89293. * of each single series. Properties are inherited from tooltip. Overridable
  89294. * properties are `headerFormat`, `pointFormat`, `yDecimals`, `xDateFormat`,
  89295. * `yPrefix` and `ySuffix`. Unlike other series, in a scatter plot the
  89296. * series.name by default shows in the headerFormat and point.x and point.y
  89297. * in the pointFormat.
  89298. */
  89299. tooltip?: SeriesTooltipOptionsObject;
  89300. /**
  89301. * (Highcharts) Options for the button appearing when traversing down in a
  89302. * treemap.
  89303. */
  89304. traverseUpButton?: PlotTreemapTraverseUpButtonOptions;
  89305. /**
  89306. * (Highcharts, Highstock, Gantt) When a series contains a data array that
  89307. * is longer than this, only one dimensional arrays of numbers, or two
  89308. * dimensional arrays with x and y values are allowed. Also, only the first
  89309. * point is tested, and the rest are assumed to be the same format. This
  89310. * saves expensive data checking and indexing in long series. Set it to `0`
  89311. * disable.
  89312. *
  89313. * Note: In boost mode turbo threshold is forced. Only array of numbers or
  89314. * two dimensional arrays are allowed.
  89315. */
  89316. turboThreshold?: number;
  89317. /**
  89318. * (Highcharts) Set the initial visibility of the series.
  89319. */
  89320. visible?: boolean;
  89321. /**
  89322. * (Highmaps) Define the z index of the series.
  89323. */
  89324. zIndex?: number;
  89325. /**
  89326. * (Highcharts, Highstock) Defines the Axis on which the zones are applied.
  89327. */
  89328. zoneAxis?: string;
  89329. /**
  89330. * (Highcharts, Highstock) An array defining zones within a series. Zones
  89331. * can be applied to the X axis, Y axis or Z axis for bubbles, according to
  89332. * the `zoneAxis` option. The zone definitions have to be in ascending order
  89333. * regarding to the value.
  89334. *
  89335. * In styled mode, the color zones are styled with the
  89336. * `.highcharts-zone-{n}` class, or custom classed from the `className`
  89337. * option (view live demo).
  89338. */
  89339. zones?: Array<SeriesZonesOptionsObject>;
  89340. }
  89341. /**
  89342. * (Highcharts) Options for the button appearing when traversing down in a
  89343. * treemap.
  89344. */
  89345. export interface PlotTreemapTraverseUpButtonOptions {
  89346. /**
  89347. * (Highcharts) The position of the button.
  89348. */
  89349. position?: PlotTreemapTraverseUpButtonPositionOptions;
  89350. }
  89351. /**
  89352. * (Highcharts) The position of the button.
  89353. */
  89354. export interface PlotTreemapTraverseUpButtonPositionOptions {
  89355. /**
  89356. * (Highcharts) Horizontal alignment of the button.
  89357. */
  89358. align?: AlignValue;
  89359. /**
  89360. * (Highcharts) Vertical alignment of the button.
  89361. */
  89362. verticalAlign?: VerticalAlignValue;
  89363. /**
  89364. * (Highcharts) Horizontal offset of the button.
  89365. */
  89366. x?: number;
  89367. /**
  89368. * (Highcharts) Vertical offset of the button.
  89369. */
  89370. y?: number;
  89371. }
  89372. /**
  89373. * (Highstock) Enable or disable the initial animation when a series is
  89374. * displayed. The animation can also be set as a configuration object. Please
  89375. * note that this option only applies to the initial animation of the series
  89376. * itself. For other animations, see chart.animation and the animation parameter
  89377. * under the API methods. The following properties are supported:
  89378. *
  89379. * - `defer`: The animation delay time in milliseconds.
  89380. *
  89381. * - `duration`: The duration of the animation in milliseconds.
  89382. *
  89383. * - `easing`: Can be a string reference to an easing function set on the `Math`
  89384. * object or a function. See the _Custom easing function_ demo below.
  89385. *
  89386. * Due to poor performance, animation is disabled in old IE browsers for several
  89387. * chart types.
  89388. */
  89389. export interface PlotTrendlineAnimationOptions {
  89390. defer?: number;
  89391. }
  89392. /**
  89393. * (Highcharts, Highstock, Highmaps, Gantt) Enable or disable the initial
  89394. * animation when a series is displayed for the `dataLabels`. The animation can
  89395. * also be set as a configuration object. Please note that this option only
  89396. * applies to the initial animation. For other animations, see chart.animation
  89397. * and the animation parameter under the API methods. The following properties
  89398. * are supported:
  89399. *
  89400. * - `defer`: The animation delay time in milliseconds.
  89401. */
  89402. export interface PlotTrendlineDataLabelsAnimationOptions {
  89403. /**
  89404. * (Highcharts, Highstock, Highmaps, Gantt) The animation delay time in
  89405. * milliseconds. Set to `0` renders dataLabel immediately. As `undefined`
  89406. * inherits defer time from the series.animation.defer.
  89407. */
  89408. defer?: number;
  89409. }
  89410. /**
  89411. * (Highcharts, Highstock, Highmaps, Gantt) Options for the series data labels,
  89412. * appearing next to each data point.
  89413. *
  89414. * Since v6.2.0, multiple data labels can be applied to each single point by
  89415. * defining them as an array of configs.
  89416. *
  89417. * In styled mode, the data labels can be styled with the
  89418. * `.highcharts-data-label-box` and `.highcharts-data-label` class names (see
  89419. * example).
  89420. */
  89421. export interface PlotTrendlineDataLabelsOptions {
  89422. /**
  89423. * (Highcharts, Highstock, Highmaps, Gantt) The alignment of the data label
  89424. * compared to the point. If `right`, the right side of the label should be
  89425. * touching the point. For points with an extent, like columns, the
  89426. * alignments also dictates how to align it inside the box, as given with
  89427. * the inside option. Can be one of `left`, `center` or `right`.
  89428. */
  89429. align?: (AlignValue|null);
  89430. /**
  89431. * (Highcharts, Highstock, Highmaps, Gantt) Whether to allow data labels to
  89432. * overlap. To make the labels less sensitive for overlapping, the
  89433. * dataLabels.padding can be set to 0.
  89434. */
  89435. allowOverlap?: boolean;
  89436. /**
  89437. * (Highcharts, Highstock, Highmaps, Gantt) Enable or disable the initial
  89438. * animation when a series is displayed for the `dataLabels`. The animation
  89439. * can also be set as a configuration object. Please note that this option
  89440. * only applies to the initial animation. For other animations, see
  89441. * chart.animation and the animation parameter under the API methods. The
  89442. * following properties are supported:
  89443. *
  89444. * - `defer`: The animation delay time in milliseconds.
  89445. */
  89446. animation?: (boolean|PlotTrendlineDataLabelsAnimationOptions|Partial<AnimationOptionsObject>);
  89447. /**
  89448. * (Highcharts, Highstock, Highmaps, Gantt) The background color or gradient
  89449. * for the data label.
  89450. */
  89451. backgroundColor?: (ColorString|GradientColorObject|PatternObject);
  89452. /**
  89453. * (Highcharts, Highstock, Highmaps, Gantt) The border color for the data
  89454. * label. Defaults to `undefined`.
  89455. */
  89456. borderColor?: (ColorString|GradientColorObject|PatternObject);
  89457. /**
  89458. * (Highcharts, Highstock, Highmaps, Gantt) The border radius in pixels for
  89459. * the data label.
  89460. */
  89461. borderRadius?: number;
  89462. /**
  89463. * (Highcharts, Highstock, Highmaps, Gantt) The border width in pixels for
  89464. * the data label.
  89465. */
  89466. borderWidth?: number;
  89467. /**
  89468. * (Highcharts, Highstock, Highmaps, Gantt) A class name for the data label.
  89469. * Particularly in styled mode, this can be used to give each series' or
  89470. * point's data label unique styling. In addition to this option, a default
  89471. * color class name is added so that we can give the labels a contrast text
  89472. * shadow.
  89473. */
  89474. className?: string;
  89475. /**
  89476. * (Highcharts, Highstock, Highmaps, Gantt) The text color for the data
  89477. * labels. Defaults to `undefined`. For certain series types, like column or
  89478. * map, the data labels can be drawn inside the points. In this case the
  89479. * data label will be drawn with maximum contrast by default. Additionally,
  89480. * it will be given a `text-outline` style with the opposite color, to
  89481. * further increase the contrast. This can be overridden by setting the
  89482. * `text-outline` style to `none` in the `dataLabels.style` option.
  89483. */
  89484. color?: (ColorString|GradientColorObject|PatternObject);
  89485. /**
  89486. * (Highcharts, Highstock, Highmaps, Gantt) Whether to hide data labels that
  89487. * are outside the plot area. By default, the data label is moved inside the
  89488. * plot area according to the overflow option.
  89489. */
  89490. crop?: boolean;
  89491. /**
  89492. * (Highcharts, Highstock, Gantt) Whether to defer displaying the data
  89493. * labels until the initial series animation has finished. Setting to
  89494. * `false` renders the data label immediately. If set to `true` inherits the
  89495. * defer time set in plotOptions.series.animation.
  89496. */
  89497. defer?: boolean;
  89498. /**
  89499. * (Highcharts, Highstock, Highmaps, Gantt) Enable or disable the data
  89500. * labels.
  89501. */
  89502. enabled?: boolean;
  89503. /**
  89504. * (Highcharts, Highstock, Highmaps, Gantt) A declarative filter to control
  89505. * of which data labels to display. The declarative filter is designed for
  89506. * use when callback functions are not available, like when the chart
  89507. * options require a pure JSON structure or for use with graphical editors.
  89508. * For programmatic control, use the `formatter` instead, and return
  89509. * `undefined` to disable a single data label.
  89510. */
  89511. filter?: DataLabelsFilterOptionsObject;
  89512. /**
  89513. * (Highcharts, Highstock, Highmaps, Gantt) A format string for the data
  89514. * label. Available variables are the same as for `formatter`.
  89515. */
  89516. format?: string;
  89517. /**
  89518. * (Highcharts, Highstock, Highmaps, Gantt) Callback JavaScript function to
  89519. * format the data label. Note that if a `format` is defined, the format
  89520. * takes precedence and the formatter is ignored.
  89521. */
  89522. formatter?: DataLabelsFormatterCallbackFunction;
  89523. /**
  89524. * (Highcharts, Highstock, Highmaps, Gantt) For points with an extent, like
  89525. * columns or map areas, whether to align the data label inside the box or
  89526. * to the actual value point. Defaults to `false` in most cases, `true` in
  89527. * stacked columns.
  89528. */
  89529. inside?: boolean;
  89530. /**
  89531. * (Highcharts, Highstock, Highmaps, Gantt) Format for points with the value
  89532. * of null. Works analogously to format. `nullFormat` can be applied only to
  89533. * series which support displaying null points.
  89534. */
  89535. nullFormat?: (boolean|string);
  89536. /**
  89537. * (Highcharts, Highstock, Highmaps, Gantt) Callback JavaScript function
  89538. * that defines formatting for points with the value of null. Works
  89539. * analogously to formatter. `nullPointFormatter` can be applied only to
  89540. * series which support displaying null points.
  89541. */
  89542. nullFormatter?: DataLabelsFormatterCallbackFunction;
  89543. /**
  89544. * (Highcharts, Highstock, Highmaps, Gantt) How to handle data labels that
  89545. * flow outside the plot area. The default is `"justify"`, which aligns them
  89546. * inside the plot area. For columns and bars, this means it will be moved
  89547. * inside the bar. To display data labels outside the plot area, set `crop`
  89548. * to `false` and `overflow` to `"allow"`.
  89549. */
  89550. overflow?: DataLabelsOverflowValue;
  89551. /**
  89552. * (Highcharts, Highstock, Highmaps, Gantt) When either the `borderWidth` or
  89553. * the `backgroundColor` is set, this is the padding within the box.
  89554. */
  89555. padding?: number;
  89556. /**
  89557. * (Highcharts, Highstock, Highmaps, Gantt) Aligns data labels relative to
  89558. * points. If `center` alignment is not possible, it defaults to `right`.
  89559. */
  89560. position?: AlignValue;
  89561. /**
  89562. * (Highcharts, Highstock, Highmaps, Gantt) Text rotation in degrees. Note
  89563. * that due to a more complex structure, backgrounds, borders and padding
  89564. * will be lost on a rotated data label.
  89565. */
  89566. rotation?: number;
  89567. /**
  89568. * (Highcharts, Highstock, Highmaps, Gantt) The shadow of the box. Works
  89569. * best with `borderWidth` or `backgroundColor`. Since 2.3 the shadow can be
  89570. * an object configuration containing `color`, `offsetX`, `offsetY`,
  89571. * `opacity` and `width`.
  89572. */
  89573. shadow?: (boolean|ShadowOptionsObject);
  89574. /**
  89575. * (Highcharts, Highstock, Highmaps, Gantt) The name of a symbol to use for
  89576. * the border around the label. Symbols are predefined functions on the
  89577. * Renderer object.
  89578. */
  89579. shape?: string;
  89580. /**
  89581. * (Highcharts, Highstock, Highmaps, Gantt) Styles for the label. The
  89582. * default `color` setting is `"contrast"`, which is a pseudo color that
  89583. * Highcharts picks up and applies the maximum contrast to the underlying
  89584. * point item, for example the bar in a bar chart.
  89585. *
  89586. * The `textOutline` is a pseudo property that applies an outline of the
  89587. * given width with the given color, which by default is the maximum
  89588. * contrast to the text. So a bright text color will result in a black text
  89589. * outline for maximum readability on a mixed background. In some cases,
  89590. * especially with grayscale text, the text outline doesn't work well, in
  89591. * which cases it can be disabled by setting it to `"none"`. When `useHTML`
  89592. * is true, the `textOutline` will not be picked up. In this, case, the same
  89593. * effect can be acheived through the `text-shadow` CSS property.
  89594. *
  89595. * For some series types, where each point has an extent, like for example
  89596. * tree maps, the data label may overflow the point. There are two
  89597. * strategies for handling overflow. By default, the text will wrap to
  89598. * multiple lines. The other strategy is to set `style.textOverflow` to
  89599. * `ellipsis`, which will keep the text on one line plus it will break
  89600. * inside long words.
  89601. */
  89602. style?: CSSObject;
  89603. /**
  89604. * (Highcharts, Highstock, Highmaps, Gantt) Options for a label text which
  89605. * should follow marker's shape. Border and background are disabled for a
  89606. * label that follows a path.
  89607. *
  89608. * **Note:** Only SVG-based renderer supports this option. Setting `useHTML`
  89609. * to true will disable this option.
  89610. */
  89611. textPath?: DataLabelsTextPathOptionsObject;
  89612. /**
  89613. * (Highcharts, Highstock, Highmaps, Gantt) Whether to use HTML to render
  89614. * the labels.
  89615. */
  89616. useHTML?: boolean;
  89617. /**
  89618. * (Highcharts, Highstock, Highmaps, Gantt) The vertical alignment of a data
  89619. * label. Can be one of `top`, `middle` or `bottom`. The default value
  89620. * depends on the data, for instance in a column chart, the label is above
  89621. * positive values and below negative values.
  89622. */
  89623. verticalAlign?: (VerticalAlignValue|null);
  89624. /**
  89625. * (Highcharts, Highstock, Highmaps, Gantt) The x position offset of the
  89626. * label relative to the point in pixels.
  89627. */
  89628. x?: number;
  89629. /**
  89630. * (Highcharts, Highstock, Highmaps, Gantt) The y position offset of the
  89631. * label relative to the point in pixels.
  89632. */
  89633. y?: number;
  89634. /**
  89635. * (Highcharts, Highstock, Highmaps, Gantt) The Z index of the data labels.
  89636. * The default Z index puts it above the series. Use a Z index of 2 to
  89637. * display it behind the series.
  89638. */
  89639. z?: number;
  89640. }
  89641. /**
  89642. * (Highcharts, Highstock) Options for the series data sorting.
  89643. */
  89644. export interface PlotTrendlineDataSortingOptions {
  89645. /**
  89646. * (Highcharts, Highstock) Enable or disable data sorting for the series.
  89647. * Use xAxis.reversed to change the sorting order.
  89648. */
  89649. enabled?: boolean;
  89650. /**
  89651. * (Highcharts, Highstock) Whether to allow matching points by name in an
  89652. * update. If this option is disabled, points will be matched by order.
  89653. */
  89654. matchByName?: boolean;
  89655. /**
  89656. * (Highcharts, Highstock) Determines what data value should be used to sort
  89657. * by.
  89658. */
  89659. sortKey?: string;
  89660. }
  89661. /**
  89662. * (Highstock) Trendline (linear regression) fits a straight line to the
  89663. * selected data using a method called the Sum Of Least Squares. This series
  89664. * requires the `linkedTo` option to be set.
  89665. *
  89666. * In TypeScript the type option must always be set.
  89667. *
  89668. * Configuration options for the series are given in three levels:
  89669. *
  89670. * 1. Options for all series in a chart are defined in the plotOptions.series
  89671. * object.
  89672. *
  89673. * 2. Options for all `trendline` series are defined in plotOptions.trendline.
  89674. *
  89675. * 3. Options for one single series are given in the series instance array. (see
  89676. * online documentation for example)
  89677. */
  89678. export interface PlotTrendlineOptions {
  89679. /**
  89680. * (Highstock) Accessibility options for a series.
  89681. */
  89682. accessibility?: SeriesAccessibilityOptionsObject;
  89683. /**
  89684. * (Highstock) Allow this series' points to be selected by clicking on the
  89685. * graphic (columns, point markers, pie slices, map areas etc).
  89686. *
  89687. * The selected points can be handled by point select and unselect events,
  89688. * or collectively by the getSelectedPoints function.
  89689. *
  89690. * And alternative way of selecting points is through dragging.
  89691. */
  89692. allowPointSelect?: boolean;
  89693. /**
  89694. * (Highstock) Enable or disable the initial animation when a series is
  89695. * displayed. The animation can also be set as a configuration object.
  89696. * Please note that this option only applies to the initial animation of the
  89697. * series itself. For other animations, see chart.animation and the
  89698. * animation parameter under the API methods. The following properties are
  89699. * supported:
  89700. *
  89701. * - `defer`: The animation delay time in milliseconds.
  89702. *
  89703. * - `duration`: The duration of the animation in milliseconds.
  89704. *
  89705. * - `easing`: Can be a string reference to an easing function set on the
  89706. * `Math` object or a function. See the _Custom easing function_ demo below.
  89707. *
  89708. * Due to poor performance, animation is disabled in old IE browsers for
  89709. * several chart types.
  89710. */
  89711. animation?: (boolean|PlotTrendlineAnimationOptions|Partial<AnimationOptionsObject>);
  89712. /**
  89713. * (Highstock) For some series, there is a limit that shuts down initial
  89714. * animation by default when the total number of points in the chart is too
  89715. * high. For example, for a column chart and its derivatives, animation does
  89716. * not run if there is more than 250 points totally. To disable this cap,
  89717. * set `animationLimit` to `Infinity`.
  89718. */
  89719. animationLimit?: number;
  89720. /**
  89721. * (Highstock) Sets the color blending in the boost module.
  89722. */
  89723. boostBlending?: OptionsBoostBlendingValue;
  89724. /**
  89725. * (Highstock) Set the point threshold for when a series should enter boost
  89726. * mode.
  89727. *
  89728. * Setting it to e.g. 2000 will cause the series to enter boost mode when
  89729. * there are 2000 or more points in the series.
  89730. *
  89731. * To disable boosting on the series, set the `boostThreshold` to 0. Setting
  89732. * it to 1 will force boosting.
  89733. *
  89734. * Note that the cropThreshold also affects this setting. When zooming in on
  89735. * a series that has fewer points than the `cropThreshold`, all points are
  89736. * rendered although outside the visible plot area, and the `boostThreshold`
  89737. * won't take effect.
  89738. */
  89739. boostThreshold?: number;
  89740. /**
  89741. * (Highmaps) The border color of the map areas.
  89742. *
  89743. * In styled mode, the border stroke is given in the `.highcharts-point`
  89744. * class.
  89745. */
  89746. borderColor?: (ColorString|GradientColorObject|PatternObject);
  89747. /**
  89748. * (Highmaps) The border width of each map area.
  89749. *
  89750. * In styled mode, the border stroke width is given in the
  89751. * `.highcharts-point` class.
  89752. */
  89753. borderWidth?: number;
  89754. /**
  89755. * (Highstock) An additional class name to apply to the series' graphical
  89756. * elements. This option does not replace default class names of the
  89757. * graphical element.
  89758. */
  89759. className?: string;
  89760. /**
  89761. * (Highstock) Disable this option to allow series rendering in the whole
  89762. * plotting area.
  89763. *
  89764. * **Note:** Clipping should be always enabled when chart.zoomType is set
  89765. */
  89766. clip?: boolean;
  89767. /**
  89768. * (Highstock) The main color of the series. In line type series it applies
  89769. * to the line and the point markers unless otherwise specified. In bar type
  89770. * series it applies to the bars unless a color is specified per point. The
  89771. * default value is pulled from the `options.colors` array.
  89772. *
  89773. * In styled mode, the color can be defined by the colorIndex option. Also,
  89774. * the series color can be set with the `.highcharts-series`,
  89775. * `.highcharts-color-{n}`, `.highcharts-{type}-series` or
  89776. * `.highcharts-series-{n}` class, or individual classes given by the
  89777. * `className` option.
  89778. */
  89779. color?: (ColorString|GradientColorObject|PatternObject);
  89780. /**
  89781. * (Highstock) Styled mode only. A specific color index to use for the
  89782. * series, so its graphic representations are given the class name
  89783. * `highcharts-color-{n}`.
  89784. */
  89785. colorIndex?: number;
  89786. /**
  89787. * (Highcharts, Highstock, Highmaps) Determines what data value should be
  89788. * used to calculate point color if `colorAxis` is used. Requires to set
  89789. * `min` and `max` if some custom point property is used or if approximation
  89790. * for data grouping is set to `'sum'`.
  89791. */
  89792. colorKey?: string;
  89793. /**
  89794. * (Highstock) Compare the values of the series against the first non-null,
  89795. * non- zero value in the visible range. The y axis will show percentage or
  89796. * absolute change depending on whether `compare` is set to `"percent"` or
  89797. * `"value"`. When this is applied to multiple series, it allows comparing
  89798. * the development of the series against each other. Adds a `change` field
  89799. * to every point object.
  89800. */
  89801. compare?: string;
  89802. /**
  89803. * (Highstock) When compare is `percent`, this option dictates whether to
  89804. * use 0 or 100 as the base of comparison.
  89805. */
  89806. compareBase?: (0|100);
  89807. /**
  89808. * (Highstock) Defines if comparison should start from the first point
  89809. * within the visible range or should start from the first point **before**
  89810. * the range.
  89811. *
  89812. * In other words, this flag determines if first point within the visible
  89813. * range will have 0% (`compareStart=true`) or should have been already
  89814. * calculated according to the previous point (`compareStart=false`).
  89815. */
  89816. compareStart?: boolean;
  89817. /**
  89818. * (Highstock) Whether to compare indicator to the main series values or
  89819. * indicator values.
  89820. */
  89821. compareToMain?: boolean;
  89822. /**
  89823. * (Highcharts) Polar charts only. Whether to connect the ends of a line
  89824. * series plot across the extremes.
  89825. */
  89826. connectEnds?: boolean;
  89827. /**
  89828. * (Highcharts, Highstock) Whether to connect a graph line across null
  89829. * points, or render a gap between the two points on either side of the
  89830. * null.
  89831. */
  89832. connectNulls?: boolean;
  89833. /**
  89834. * (Gantt) Override Pathfinder connector options for a series. Requires
  89835. * Highcharts Gantt to be loaded.
  89836. */
  89837. connectors?: SeriesConnectorsOptionsObject;
  89838. /**
  89839. * (Highcharts, Highstock, Gantt) When true, each point or column edge is
  89840. * rounded to its nearest pixel in order to render sharp on screen. In some
  89841. * cases, when there are a lot of densely packed columns, this leads to
  89842. * visible difference in column widths or distance between columns. In these
  89843. * cases, setting `crisp` to `false` may look better, even though each
  89844. * column is rendered blurry.
  89845. */
  89846. crisp?: boolean;
  89847. /**
  89848. * (Highcharts, Highstock) When the series contains less points than the
  89849. * crop threshold, all points are drawn, even if the points fall outside the
  89850. * visible plot area at the current zoom. The advantage of drawing all
  89851. * points (including markers and columns), is that animation is performed on
  89852. * updates. On the other hand, when the series contains more points than the
  89853. * crop threshold, the series data is cropped to only contain points that
  89854. * fall within the plot area. The advantage of cropping away invisible
  89855. * points is to increase performance on large series.
  89856. */
  89857. cropThreshold?: number;
  89858. /**
  89859. * (Highstock) You can set the cursor to "pointer" if you have click events
  89860. * attached to the series, to signal to the user that the points and lines
  89861. * can be clicked.
  89862. *
  89863. * In styled mode, the series cursor can be set with the same classes as
  89864. * listed under series.color.
  89865. */
  89866. cursor?: (string|CursorValue);
  89867. /**
  89868. * (Highstock) A reserved subspace to store options and values for
  89869. * customized functionality. Here you can add additional data for your own
  89870. * event callbacks and formatter callbacks.
  89871. */
  89872. custom?: Dictionary<any>;
  89873. /**
  89874. * (Highstock) Name of the dash style to use for the graph, or for some
  89875. * series types the outline of each shape.
  89876. *
  89877. * In styled mode, the stroke dash-array can be set with the same classes as
  89878. * listed under series.color.
  89879. */
  89880. dashStyle?: DashStyleValue;
  89881. /**
  89882. * (Highstock) Data grouping is the concept of sampling the data values into
  89883. * larger blocks in order to ease readability and increase performance of
  89884. * the JavaScript charts. Highstock by default applies data grouping when
  89885. * the points become closer than a certain pixel value, determined by the
  89886. * `groupPixelWidth` option.
  89887. *
  89888. * If data grouping is applied, the grouping information of grouped points
  89889. * can be read from the Point.dataGroup. If point options other than the
  89890. * data itself are set, for example `name` or `color` or custom properties,
  89891. * the grouping logic doesn't know how to group it. In this case the options
  89892. * of the first point instance are copied over to the group point. This can
  89893. * be altered through a custom `approximation` callback function.
  89894. */
  89895. dataGrouping?: DataGroupingOptionsObject;
  89896. /**
  89897. * (Highcharts, Highstock, Highmaps, Gantt) Options for the series data
  89898. * labels, appearing next to each data point.
  89899. *
  89900. * Since v6.2.0, multiple data labels can be applied to each single point by
  89901. * defining them as an array of configs.
  89902. *
  89903. * In styled mode, the data labels can be styled with the
  89904. * `.highcharts-data-label-box` and `.highcharts-data-label` class names
  89905. * (see example).
  89906. */
  89907. dataLabels?: (PlotTrendlineDataLabelsOptions|Array<PlotTrendlineDataLabelsOptions>);
  89908. /**
  89909. * (Highcharts, Highstock) Options for the series data sorting.
  89910. */
  89911. dataSorting?: (DataSortingOptionsObject|PlotTrendlineDataSortingOptions);
  89912. /**
  89913. * (Highstock) A description of the series to add to the screen reader
  89914. * information about the series.
  89915. */
  89916. description?: string;
  89917. /**
  89918. * (Highstock) Enable or disable the mouse tracking for a specific series.
  89919. * This includes point tooltips and click events on graphs and points. For
  89920. * large datasets it improves performance.
  89921. */
  89922. enableMouseTracking?: boolean;
  89923. /**
  89924. * (Highstock) General event handlers for the series items. These event
  89925. * hooks can also be attached to the series at run time using the
  89926. * `Highcharts.addEvent` function.
  89927. */
  89928. events?: SeriesEventsOptionsObject;
  89929. /**
  89930. * (Highstock) Determines whether the series should look for the nearest
  89931. * point in both dimensions or just the x-dimension when hovering the
  89932. * series. Defaults to `'xy'` for scatter series and `'x'` for most other
  89933. * series. If the data has duplicate x-values, it is recommended to set this
  89934. * to `'xy'` to allow hovering over all points.
  89935. *
  89936. * Applies only to series types using nearest neighbor search (not direct
  89937. * hover) for tooltip.
  89938. */
  89939. findNearestPointBy?: OptionsFindNearestPointByValue;
  89940. /**
  89941. * (Highstock) Defines when to display a gap in the graph, together with the
  89942. * gapUnit option.
  89943. *
  89944. * In case when `dataGrouping` is enabled, points can be grouped into a
  89945. * larger time span. This can make the grouped points to have a greater
  89946. * distance than the absolute value of `gapSize` property, which will result
  89947. * in disappearing graph completely. To prevent this situation the mentioned
  89948. * distance between grouped points is used instead of previously defined
  89949. * `gapSize`.
  89950. *
  89951. * In practice, this option is most often used to visualize gaps in time
  89952. * series. In a stock chart, intraday data is available for daytime hours,
  89953. * while gaps will appear in nights and weekends.
  89954. */
  89955. gapSize?: number;
  89956. /**
  89957. * (Highstock) Together with gapSize, this option defines where to draw gaps
  89958. * in the graph.
  89959. *
  89960. * When the `gapUnit` is `"relative"` (default), a gap size of 5 means that
  89961. * if the distance between two points is greater than 5 times that of the
  89962. * two closest points, the graph will be broken.
  89963. *
  89964. * When the `gapUnit` is `"value"`, the gap is based on absolute axis
  89965. * values, which on a datetime axis is milliseconds. This also applies to
  89966. * the navigator series that inherits gap options from the base series.
  89967. */
  89968. gapUnit?: OptionsGapUnitValue;
  89969. /**
  89970. * (Highcharts, Highstock, Gantt) Whether to use the Y extremes of the total
  89971. * chart width or only the zoomed area when zooming in on parts of the X
  89972. * axis. By default, the Y axis adjusts to the min and max of the visible
  89973. * data. Cartesian series only.
  89974. */
  89975. getExtremesFromAll?: boolean;
  89976. /**
  89977. * (Highstock) When set to `false` will prevent the series data from being
  89978. * included in any form of data export.
  89979. *
  89980. * Since version 6.0.0 until 7.1.0 the option was existing undocumented as
  89981. * `includeInCSVExport`.
  89982. */
  89983. includeInDataExport?: boolean;
  89984. /**
  89985. * (Highcharts, Highstock, Gantt) Series labels are placed as close to the
  89986. * series as possible in a natural way, seeking to avoid other series. The
  89987. * goal of this feature is to make the chart more easily readable, like if a
  89988. * human designer placed the labels in the optimal position.
  89989. *
  89990. * The series labels currently work with series types having a `graph` or an
  89991. * `area`.
  89992. */
  89993. label?: SeriesLabelOptionsObject;
  89994. /**
  89995. * (Highstock) The line marks the last price from all points.
  89996. */
  89997. lastPrice?: SeriesLastPriceOptionsObject;
  89998. /**
  89999. * (Highstock) The line marks the last price from visible range of points.
  90000. */
  90001. lastVisiblePrice?: SeriesLastVisiblePriceOptionsObject;
  90002. /**
  90003. * (Highcharts, Highstock) The SVG value used for the `stroke-linecap` and
  90004. * `stroke-linejoin` of a line graph. Round means that lines are rounded in
  90005. * the ends and bends.
  90006. */
  90007. linecap?: SeriesLinecapValue;
  90008. /**
  90009. * (Highcharts, Highstock) Pixel width of the graph line.
  90010. */
  90011. lineWidth?: number;
  90012. /**
  90013. * (Highcharts, Highstock, Gantt) The main series ID that indicator will be
  90014. * based on. Required for this indicator.
  90015. */
  90016. linkedTo?: string;
  90017. /**
  90018. * (Highstock) Options for the point markers of line-like series. Properties
  90019. * like `fillColor`, `lineColor` and `lineWidth` define the visual
  90020. * appearance of the markers. Other series types, like column series, don't
  90021. * have markers, but have visual options on the series level instead.
  90022. *
  90023. * In styled mode, the markers can be styled with the `.highcharts-point`,
  90024. * `.highcharts-point-hover` and `.highcharts-point-select` class names.
  90025. */
  90026. marker?: PointMarkerOptionsObject;
  90027. /**
  90028. * (Highstock) The name of the series as shown in the legend, tooltip etc.
  90029. * If not set, it will be based on a technical indicator type and default
  90030. * params.
  90031. */
  90032. name?: string;
  90033. /**
  90034. * (Highstock) The color for the parts of the graph or points that are below
  90035. * the threshold. Note that `zones` takes precedence over the negative
  90036. * color. Using `negativeColor` is equivalent to applying a zone with value
  90037. * of 0.
  90038. */
  90039. negativeColor?: (ColorString|GradientColorObject|PatternObject);
  90040. /**
  90041. * (Highstock) Opacity of a series parts: line, fill (e.g. area) and
  90042. * dataLabels.
  90043. */
  90044. opacity?: number;
  90045. /**
  90046. * (Highstock) Paramters used in calculation of regression series' points.
  90047. */
  90048. params?: PlotTrendlineParamsOptions;
  90049. /**
  90050. * (Highstock) Properties for each single point.
  90051. */
  90052. point?: PlotSeriesPointOptions;
  90053. /**
  90054. * (Highstock) Same as accessibility.pointDescriptionFormatter, but for an
  90055. * individual series. Overrides the chart wide configuration.
  90056. */
  90057. pointDescriptionFormatter?: Function;
  90058. /**
  90059. * (Highstock) Whether to select the series initially. If `showCheckbox` is
  90060. * true, the checkbox next to the series name in the legend will be checked
  90061. * for a selected series.
  90062. */
  90063. selected?: boolean;
  90064. /**
  90065. * (Highstock) Whether to apply a drop shadow to the graph line. Since 2.3
  90066. * the shadow can be an object configuration containing `color`, `offsetX`,
  90067. * `offsetY`, `opacity` and `width`.
  90068. */
  90069. shadow?: (boolean|ShadowOptionsObject);
  90070. /**
  90071. * (Highstock) If true, a checkbox is displayed next to the legend item to
  90072. * allow selecting the series. The state of the checkbox is determined by
  90073. * the `selected` option.
  90074. */
  90075. showCheckbox?: boolean;
  90076. /**
  90077. * (Highstock) Whether to display this particular series or series type in
  90078. * the legend. Standalone series are shown in legend by default, and linked
  90079. * series are not. Since v7.2.0 it is possible to show series that use
  90080. * colorAxis by setting this option to `true`.
  90081. */
  90082. showInLegend?: boolean;
  90083. /**
  90084. * (Highstock) If set to `true`, the accessibility module will skip past the
  90085. * points in this series for keyboard navigation.
  90086. */
  90087. skipKeyboardNavigation?: boolean;
  90088. /**
  90089. * (Highcharts, Highstock) When this is true, the series will not cause the
  90090. * Y axis to cross the zero plane (or threshold option) unless the data
  90091. * actually crosses the plane.
  90092. *
  90093. * For example, if `softThreshold` is `false`, a series of 0, 1, 2, 3 will
  90094. * make the Y axis show negative values according to the `minPadding`
  90095. * option. If `softThreshold` is `true`, the Y axis starts at 0.
  90096. */
  90097. softThreshold?: boolean;
  90098. states?: SeriesStatesOptionsObject;
  90099. /**
  90100. * (Highcharts, Highstock) Whether to apply steps to the line. Possible
  90101. * values are `left`, `center` and `right`.
  90102. */
  90103. step?: OptionsStepValue;
  90104. /**
  90105. * (Highstock) Sticky tracking of mouse events. When true, the `mouseOut`
  90106. * event on a series isn't triggered until the mouse moves over another
  90107. * series, or out of the plot area. When false, the `mouseOut` event on a
  90108. * series is triggered when the mouse leaves the area around the series'
  90109. * graph or markers. This also implies the tooltip when not shared. When
  90110. * `stickyTracking` is false and `tooltip.shared` is false, the tooltip will
  90111. * be hidden when moving the mouse between series. Defaults to true for line
  90112. * and area type series, but to false for columns, pies etc.
  90113. *
  90114. * **Note:** The boost module will force this option because of technical
  90115. * limitations.
  90116. */
  90117. stickyTracking?: boolean;
  90118. /**
  90119. * (Highcharts, Highstock) The threshold, also called zero level or base
  90120. * level. For line type series this is only used in conjunction with
  90121. * negativeColor.
  90122. */
  90123. threshold?: (number|null);
  90124. /**
  90125. * (Highstock) A configuration object for the tooltip rendering of each
  90126. * single series. Properties are inherited from tooltip, but only the
  90127. * following properties can be defined on a series level.
  90128. */
  90129. tooltip?: SeriesTooltipOptionsObject;
  90130. /**
  90131. * (Highcharts, Highstock, Gantt) When a series contains a data array that
  90132. * is longer than this, only one dimensional arrays of numbers, or two
  90133. * dimensional arrays with x and y values are allowed. Also, only the first
  90134. * point is tested, and the rest are assumed to be the same format. This
  90135. * saves expensive data checking and indexing in long series. Set it to `0`
  90136. * disable.
  90137. *
  90138. * Note: In boost mode turbo threshold is forced. Only array of numbers or
  90139. * two dimensional arrays are allowed.
  90140. */
  90141. turboThreshold?: number;
  90142. /**
  90143. * (Highstock) Set the initial visibility of the series.
  90144. */
  90145. visible?: boolean;
  90146. /**
  90147. * (Highmaps) Define the z index of the series.
  90148. */
  90149. zIndex?: number;
  90150. /**
  90151. * (Highcharts, Highstock) Defines the Axis on which the zones are applied.
  90152. */
  90153. zoneAxis?: string;
  90154. /**
  90155. * (Highcharts, Highstock) An array defining zones within a series. Zones
  90156. * can be applied to the X axis, Y axis or Z axis for bubbles, according to
  90157. * the `zoneAxis` option. The zone definitions have to be in ascending order
  90158. * regarding to the value.
  90159. *
  90160. * In styled mode, the color zones are styled with the
  90161. * `.highcharts-zone-{n}` class, or custom classed from the `className`
  90162. * option (view live demo).
  90163. */
  90164. zones?: Array<SeriesZonesOptionsObject>;
  90165. }
  90166. /**
  90167. * (Highstock) Paramters used in calculation of regression series' points.
  90168. */
  90169. export interface PlotTrendlineParamsOptions {
  90170. /**
  90171. * (Highstock) The point index which indicator calculations will base. For
  90172. * example using OHLC data, index=2 means the indicator will be calculated
  90173. * using Low values.
  90174. */
  90175. index?: (number|string);
  90176. }
  90177. /**
  90178. * (Highstock) Enable or disable the initial animation when a series is
  90179. * displayed. The animation can also be set as a configuration object. Please
  90180. * note that this option only applies to the initial animation of the series
  90181. * itself. For other animations, see chart.animation and the animation parameter
  90182. * under the API methods. The following properties are supported:
  90183. *
  90184. * - `defer`: The animation delay time in milliseconds.
  90185. *
  90186. * - `duration`: The duration of the animation in milliseconds.
  90187. *
  90188. * - `easing`: Can be a string reference to an easing function set on the `Math`
  90189. * object or a function. See the _Custom easing function_ demo below.
  90190. *
  90191. * Due to poor performance, animation is disabled in old IE browsers for several
  90192. * chart types.
  90193. */
  90194. export interface PlotTrixAnimationOptions {
  90195. defer?: number;
  90196. }
  90197. /**
  90198. * (Highcharts, Highstock, Highmaps, Gantt) Enable or disable the initial
  90199. * animation when a series is displayed for the `dataLabels`. The animation can
  90200. * also be set as a configuration object. Please note that this option only
  90201. * applies to the initial animation. For other animations, see chart.animation
  90202. * and the animation parameter under the API methods. The following properties
  90203. * are supported:
  90204. *
  90205. * - `defer`: The animation delay time in milliseconds.
  90206. */
  90207. export interface PlotTrixDataLabelsAnimationOptions {
  90208. /**
  90209. * (Highcharts, Highstock, Highmaps, Gantt) The animation delay time in
  90210. * milliseconds. Set to `0` renders dataLabel immediately. As `undefined`
  90211. * inherits defer time from the series.animation.defer.
  90212. */
  90213. defer?: number;
  90214. }
  90215. /**
  90216. * (Highcharts, Highstock, Highmaps, Gantt) Options for the series data labels,
  90217. * appearing next to each data point.
  90218. *
  90219. * Since v6.2.0, multiple data labels can be applied to each single point by
  90220. * defining them as an array of configs.
  90221. *
  90222. * In styled mode, the data labels can be styled with the
  90223. * `.highcharts-data-label-box` and `.highcharts-data-label` class names (see
  90224. * example).
  90225. */
  90226. export interface PlotTrixDataLabelsOptions {
  90227. /**
  90228. * (Highcharts, Highstock, Highmaps, Gantt) The alignment of the data label
  90229. * compared to the point. If `right`, the right side of the label should be
  90230. * touching the point. For points with an extent, like columns, the
  90231. * alignments also dictates how to align it inside the box, as given with
  90232. * the inside option. Can be one of `left`, `center` or `right`.
  90233. */
  90234. align?: (AlignValue|null);
  90235. /**
  90236. * (Highcharts, Highstock, Highmaps, Gantt) Whether to allow data labels to
  90237. * overlap. To make the labels less sensitive for overlapping, the
  90238. * dataLabels.padding can be set to 0.
  90239. */
  90240. allowOverlap?: boolean;
  90241. /**
  90242. * (Highcharts, Highstock, Highmaps, Gantt) Enable or disable the initial
  90243. * animation when a series is displayed for the `dataLabels`. The animation
  90244. * can also be set as a configuration object. Please note that this option
  90245. * only applies to the initial animation. For other animations, see
  90246. * chart.animation and the animation parameter under the API methods. The
  90247. * following properties are supported:
  90248. *
  90249. * - `defer`: The animation delay time in milliseconds.
  90250. */
  90251. animation?: (boolean|PlotTrixDataLabelsAnimationOptions|Partial<AnimationOptionsObject>);
  90252. /**
  90253. * (Highcharts, Highstock, Highmaps, Gantt) The background color or gradient
  90254. * for the data label.
  90255. */
  90256. backgroundColor?: (ColorString|GradientColorObject|PatternObject);
  90257. /**
  90258. * (Highcharts, Highstock, Highmaps, Gantt) The border color for the data
  90259. * label. Defaults to `undefined`.
  90260. */
  90261. borderColor?: (ColorString|GradientColorObject|PatternObject);
  90262. /**
  90263. * (Highcharts, Highstock, Highmaps, Gantt) The border radius in pixels for
  90264. * the data label.
  90265. */
  90266. borderRadius?: number;
  90267. /**
  90268. * (Highcharts, Highstock, Highmaps, Gantt) The border width in pixels for
  90269. * the data label.
  90270. */
  90271. borderWidth?: number;
  90272. /**
  90273. * (Highcharts, Highstock, Highmaps, Gantt) A class name for the data label.
  90274. * Particularly in styled mode, this can be used to give each series' or
  90275. * point's data label unique styling. In addition to this option, a default
  90276. * color class name is added so that we can give the labels a contrast text
  90277. * shadow.
  90278. */
  90279. className?: string;
  90280. /**
  90281. * (Highcharts, Highstock, Highmaps, Gantt) The text color for the data
  90282. * labels. Defaults to `undefined`. For certain series types, like column or
  90283. * map, the data labels can be drawn inside the points. In this case the
  90284. * data label will be drawn with maximum contrast by default. Additionally,
  90285. * it will be given a `text-outline` style with the opposite color, to
  90286. * further increase the contrast. This can be overridden by setting the
  90287. * `text-outline` style to `none` in the `dataLabels.style` option.
  90288. */
  90289. color?: (ColorString|GradientColorObject|PatternObject);
  90290. /**
  90291. * (Highcharts, Highstock, Highmaps, Gantt) Whether to hide data labels that
  90292. * are outside the plot area. By default, the data label is moved inside the
  90293. * plot area according to the overflow option.
  90294. */
  90295. crop?: boolean;
  90296. /**
  90297. * (Highcharts, Highstock, Gantt) Whether to defer displaying the data
  90298. * labels until the initial series animation has finished. Setting to
  90299. * `false` renders the data label immediately. If set to `true` inherits the
  90300. * defer time set in plotOptions.series.animation.
  90301. */
  90302. defer?: boolean;
  90303. /**
  90304. * (Highcharts, Highstock, Highmaps, Gantt) Enable or disable the data
  90305. * labels.
  90306. */
  90307. enabled?: boolean;
  90308. /**
  90309. * (Highcharts, Highstock, Highmaps, Gantt) A declarative filter to control
  90310. * of which data labels to display. The declarative filter is designed for
  90311. * use when callback functions are not available, like when the chart
  90312. * options require a pure JSON structure or for use with graphical editors.
  90313. * For programmatic control, use the `formatter` instead, and return
  90314. * `undefined` to disable a single data label.
  90315. */
  90316. filter?: DataLabelsFilterOptionsObject;
  90317. /**
  90318. * (Highcharts, Highstock, Highmaps, Gantt) A format string for the data
  90319. * label. Available variables are the same as for `formatter`.
  90320. */
  90321. format?: string;
  90322. /**
  90323. * (Highcharts, Highstock, Highmaps, Gantt) Callback JavaScript function to
  90324. * format the data label. Note that if a `format` is defined, the format
  90325. * takes precedence and the formatter is ignored.
  90326. */
  90327. formatter?: DataLabelsFormatterCallbackFunction;
  90328. /**
  90329. * (Highcharts, Highstock, Highmaps, Gantt) For points with an extent, like
  90330. * columns or map areas, whether to align the data label inside the box or
  90331. * to the actual value point. Defaults to `false` in most cases, `true` in
  90332. * stacked columns.
  90333. */
  90334. inside?: boolean;
  90335. /**
  90336. * (Highcharts, Highstock, Highmaps, Gantt) Format for points with the value
  90337. * of null. Works analogously to format. `nullFormat` can be applied only to
  90338. * series which support displaying null points.
  90339. */
  90340. nullFormat?: (boolean|string);
  90341. /**
  90342. * (Highcharts, Highstock, Highmaps, Gantt) Callback JavaScript function
  90343. * that defines formatting for points with the value of null. Works
  90344. * analogously to formatter. `nullPointFormatter` can be applied only to
  90345. * series which support displaying null points.
  90346. */
  90347. nullFormatter?: DataLabelsFormatterCallbackFunction;
  90348. /**
  90349. * (Highcharts, Highstock, Highmaps, Gantt) How to handle data labels that
  90350. * flow outside the plot area. The default is `"justify"`, which aligns them
  90351. * inside the plot area. For columns and bars, this means it will be moved
  90352. * inside the bar. To display data labels outside the plot area, set `crop`
  90353. * to `false` and `overflow` to `"allow"`.
  90354. */
  90355. overflow?: DataLabelsOverflowValue;
  90356. /**
  90357. * (Highcharts, Highstock, Highmaps, Gantt) When either the `borderWidth` or
  90358. * the `backgroundColor` is set, this is the padding within the box.
  90359. */
  90360. padding?: number;
  90361. /**
  90362. * (Highcharts, Highstock, Highmaps, Gantt) Aligns data labels relative to
  90363. * points. If `center` alignment is not possible, it defaults to `right`.
  90364. */
  90365. position?: AlignValue;
  90366. /**
  90367. * (Highcharts, Highstock, Highmaps, Gantt) Text rotation in degrees. Note
  90368. * that due to a more complex structure, backgrounds, borders and padding
  90369. * will be lost on a rotated data label.
  90370. */
  90371. rotation?: number;
  90372. /**
  90373. * (Highcharts, Highstock, Highmaps, Gantt) The shadow of the box. Works
  90374. * best with `borderWidth` or `backgroundColor`. Since 2.3 the shadow can be
  90375. * an object configuration containing `color`, `offsetX`, `offsetY`,
  90376. * `opacity` and `width`.
  90377. */
  90378. shadow?: (boolean|ShadowOptionsObject);
  90379. /**
  90380. * (Highcharts, Highstock, Highmaps, Gantt) The name of a symbol to use for
  90381. * the border around the label. Symbols are predefined functions on the
  90382. * Renderer object.
  90383. */
  90384. shape?: string;
  90385. /**
  90386. * (Highcharts, Highstock, Highmaps, Gantt) Styles for the label. The
  90387. * default `color` setting is `"contrast"`, which is a pseudo color that
  90388. * Highcharts picks up and applies the maximum contrast to the underlying
  90389. * point item, for example the bar in a bar chart.
  90390. *
  90391. * The `textOutline` is a pseudo property that applies an outline of the
  90392. * given width with the given color, which by default is the maximum
  90393. * contrast to the text. So a bright text color will result in a black text
  90394. * outline for maximum readability on a mixed background. In some cases,
  90395. * especially with grayscale text, the text outline doesn't work well, in
  90396. * which cases it can be disabled by setting it to `"none"`. When `useHTML`
  90397. * is true, the `textOutline` will not be picked up. In this, case, the same
  90398. * effect can be acheived through the `text-shadow` CSS property.
  90399. *
  90400. * For some series types, where each point has an extent, like for example
  90401. * tree maps, the data label may overflow the point. There are two
  90402. * strategies for handling overflow. By default, the text will wrap to
  90403. * multiple lines. The other strategy is to set `style.textOverflow` to
  90404. * `ellipsis`, which will keep the text on one line plus it will break
  90405. * inside long words.
  90406. */
  90407. style?: CSSObject;
  90408. /**
  90409. * (Highcharts, Highstock, Highmaps, Gantt) Options for a label text which
  90410. * should follow marker's shape. Border and background are disabled for a
  90411. * label that follows a path.
  90412. *
  90413. * **Note:** Only SVG-based renderer supports this option. Setting `useHTML`
  90414. * to true will disable this option.
  90415. */
  90416. textPath?: DataLabelsTextPathOptionsObject;
  90417. /**
  90418. * (Highcharts, Highstock, Highmaps, Gantt) Whether to use HTML to render
  90419. * the labels.
  90420. */
  90421. useHTML?: boolean;
  90422. /**
  90423. * (Highcharts, Highstock, Highmaps, Gantt) The vertical alignment of a data
  90424. * label. Can be one of `top`, `middle` or `bottom`. The default value
  90425. * depends on the data, for instance in a column chart, the label is above
  90426. * positive values and below negative values.
  90427. */
  90428. verticalAlign?: (VerticalAlignValue|null);
  90429. /**
  90430. * (Highcharts, Highstock, Highmaps, Gantt) The x position offset of the
  90431. * label relative to the point in pixels.
  90432. */
  90433. x?: number;
  90434. /**
  90435. * (Highcharts, Highstock, Highmaps, Gantt) The y position offset of the
  90436. * label relative to the point in pixels.
  90437. */
  90438. y?: number;
  90439. /**
  90440. * (Highcharts, Highstock, Highmaps, Gantt) The Z index of the data labels.
  90441. * The default Z index puts it above the series. Use a Z index of 2 to
  90442. * display it behind the series.
  90443. */
  90444. z?: number;
  90445. }
  90446. /**
  90447. * (Highcharts, Highstock) Options for the series data sorting.
  90448. */
  90449. export interface PlotTrixDataSortingOptions {
  90450. /**
  90451. * (Highcharts, Highstock) Enable or disable data sorting for the series.
  90452. * Use xAxis.reversed to change the sorting order.
  90453. */
  90454. enabled?: boolean;
  90455. /**
  90456. * (Highcharts, Highstock) Whether to allow matching points by name in an
  90457. * update. If this option is disabled, points will be matched by order.
  90458. */
  90459. matchByName?: boolean;
  90460. /**
  90461. * (Highcharts, Highstock) Determines what data value should be used to sort
  90462. * by.
  90463. */
  90464. sortKey?: string;
  90465. }
  90466. /**
  90467. * (Highstock) Triple exponential average (TRIX) oscillator. This series
  90468. * requires `linkedTo` option to be set.
  90469. *
  90470. * Requires https://code.highcharts.com/stock/indicators/ema.js and
  90471. * https://code.highcharts.com/stock/indicators/tema.js.
  90472. *
  90473. * In TypeScript the type option must always be set.
  90474. *
  90475. * Configuration options for the series are given in three levels:
  90476. *
  90477. * 1. Options for all series in a chart are defined in the plotOptions.series
  90478. * object.
  90479. *
  90480. * 2. Options for all `trix` series are defined in plotOptions.trix.
  90481. *
  90482. * 3. Options for one single series are given in the series instance array. (see
  90483. * online documentation for example)
  90484. */
  90485. export interface PlotTrixOptions {
  90486. /**
  90487. * (Highstock) Accessibility options for a series.
  90488. */
  90489. accessibility?: SeriesAccessibilityOptionsObject;
  90490. /**
  90491. * (Highstock) Allow this series' points to be selected by clicking on the
  90492. * graphic (columns, point markers, pie slices, map areas etc).
  90493. *
  90494. * The selected points can be handled by point select and unselect events,
  90495. * or collectively by the getSelectedPoints function.
  90496. *
  90497. * And alternative way of selecting points is through dragging.
  90498. */
  90499. allowPointSelect?: boolean;
  90500. /**
  90501. * (Highstock) Enable or disable the initial animation when a series is
  90502. * displayed. The animation can also be set as a configuration object.
  90503. * Please note that this option only applies to the initial animation of the
  90504. * series itself. For other animations, see chart.animation and the
  90505. * animation parameter under the API methods. The following properties are
  90506. * supported:
  90507. *
  90508. * - `defer`: The animation delay time in milliseconds.
  90509. *
  90510. * - `duration`: The duration of the animation in milliseconds.
  90511. *
  90512. * - `easing`: Can be a string reference to an easing function set on the
  90513. * `Math` object or a function. See the _Custom easing function_ demo below.
  90514. *
  90515. * Due to poor performance, animation is disabled in old IE browsers for
  90516. * several chart types.
  90517. */
  90518. animation?: (boolean|PlotTrixAnimationOptions|Partial<AnimationOptionsObject>);
  90519. /**
  90520. * (Highstock) For some series, there is a limit that shuts down initial
  90521. * animation by default when the total number of points in the chart is too
  90522. * high. For example, for a column chart and its derivatives, animation does
  90523. * not run if there is more than 250 points totally. To disable this cap,
  90524. * set `animationLimit` to `Infinity`.
  90525. */
  90526. animationLimit?: number;
  90527. /**
  90528. * (Highstock) Sets the color blending in the boost module.
  90529. */
  90530. boostBlending?: OptionsBoostBlendingValue;
  90531. /**
  90532. * (Highstock) Set the point threshold for when a series should enter boost
  90533. * mode.
  90534. *
  90535. * Setting it to e.g. 2000 will cause the series to enter boost mode when
  90536. * there are 2000 or more points in the series.
  90537. *
  90538. * To disable boosting on the series, set the `boostThreshold` to 0. Setting
  90539. * it to 1 will force boosting.
  90540. *
  90541. * Note that the cropThreshold also affects this setting. When zooming in on
  90542. * a series that has fewer points than the `cropThreshold`, all points are
  90543. * rendered although outside the visible plot area, and the `boostThreshold`
  90544. * won't take effect.
  90545. */
  90546. boostThreshold?: number;
  90547. /**
  90548. * (Highmaps) The border color of the map areas.
  90549. *
  90550. * In styled mode, the border stroke is given in the `.highcharts-point`
  90551. * class.
  90552. */
  90553. borderColor?: (ColorString|GradientColorObject|PatternObject);
  90554. /**
  90555. * (Highmaps) The border width of each map area.
  90556. *
  90557. * In styled mode, the border stroke width is given in the
  90558. * `.highcharts-point` class.
  90559. */
  90560. borderWidth?: number;
  90561. /**
  90562. * (Highstock) An additional class name to apply to the series' graphical
  90563. * elements. This option does not replace default class names of the
  90564. * graphical element.
  90565. */
  90566. className?: string;
  90567. /**
  90568. * (Highstock) Disable this option to allow series rendering in the whole
  90569. * plotting area.
  90570. *
  90571. * **Note:** Clipping should be always enabled when chart.zoomType is set
  90572. */
  90573. clip?: boolean;
  90574. /**
  90575. * (Highstock) The main color of the series. In line type series it applies
  90576. * to the line and the point markers unless otherwise specified. In bar type
  90577. * series it applies to the bars unless a color is specified per point. The
  90578. * default value is pulled from the `options.colors` array.
  90579. *
  90580. * In styled mode, the color can be defined by the colorIndex option. Also,
  90581. * the series color can be set with the `.highcharts-series`,
  90582. * `.highcharts-color-{n}`, `.highcharts-{type}-series` or
  90583. * `.highcharts-series-{n}` class, or individual classes given by the
  90584. * `className` option.
  90585. */
  90586. color?: (ColorString|GradientColorObject|PatternObject);
  90587. /**
  90588. * (Highstock) Styled mode only. A specific color index to use for the
  90589. * series, so its graphic representations are given the class name
  90590. * `highcharts-color-{n}`.
  90591. */
  90592. colorIndex?: number;
  90593. /**
  90594. * (Highcharts, Highstock, Highmaps) Determines what data value should be
  90595. * used to calculate point color if `colorAxis` is used. Requires to set
  90596. * `min` and `max` if some custom point property is used or if approximation
  90597. * for data grouping is set to `'sum'`.
  90598. */
  90599. colorKey?: string;
  90600. /**
  90601. * (Highstock) Defines if comparison should start from the first point
  90602. * within the visible range or should start from the first point **before**
  90603. * the range.
  90604. *
  90605. * In other words, this flag determines if first point within the visible
  90606. * range will have 0% (`compareStart=true`) or should have been already
  90607. * calculated according to the previous point (`compareStart=false`).
  90608. */
  90609. compareStart?: boolean;
  90610. /**
  90611. * (Highstock) Whether to compare indicator to the main series values or
  90612. * indicator values.
  90613. */
  90614. compareToMain?: boolean;
  90615. /**
  90616. * (Highcharts) Polar charts only. Whether to connect the ends of a line
  90617. * series plot across the extremes.
  90618. */
  90619. connectEnds?: boolean;
  90620. /**
  90621. * (Highcharts, Highstock) Whether to connect a graph line across null
  90622. * points, or render a gap between the two points on either side of the
  90623. * null.
  90624. */
  90625. connectNulls?: boolean;
  90626. /**
  90627. * (Gantt) Override Pathfinder connector options for a series. Requires
  90628. * Highcharts Gantt to be loaded.
  90629. */
  90630. connectors?: SeriesConnectorsOptionsObject;
  90631. /**
  90632. * (Highcharts, Highstock, Gantt) When true, each point or column edge is
  90633. * rounded to its nearest pixel in order to render sharp on screen. In some
  90634. * cases, when there are a lot of densely packed columns, this leads to
  90635. * visible difference in column widths or distance between columns. In these
  90636. * cases, setting `crisp` to `false` may look better, even though each
  90637. * column is rendered blurry.
  90638. */
  90639. crisp?: boolean;
  90640. /**
  90641. * (Highcharts, Highstock) When the series contains less points than the
  90642. * crop threshold, all points are drawn, even if the points fall outside the
  90643. * visible plot area at the current zoom. The advantage of drawing all
  90644. * points (including markers and columns), is that animation is performed on
  90645. * updates. On the other hand, when the series contains more points than the
  90646. * crop threshold, the series data is cropped to only contain points that
  90647. * fall within the plot area. The advantage of cropping away invisible
  90648. * points is to increase performance on large series.
  90649. */
  90650. cropThreshold?: number;
  90651. /**
  90652. * (Highstock) You can set the cursor to "pointer" if you have click events
  90653. * attached to the series, to signal to the user that the points and lines
  90654. * can be clicked.
  90655. *
  90656. * In styled mode, the series cursor can be set with the same classes as
  90657. * listed under series.color.
  90658. */
  90659. cursor?: (string|CursorValue);
  90660. /**
  90661. * (Highstock) A reserved subspace to store options and values for
  90662. * customized functionality. Here you can add additional data for your own
  90663. * event callbacks and formatter callbacks.
  90664. */
  90665. custom?: Dictionary<any>;
  90666. /**
  90667. * (Highstock) Name of the dash style to use for the graph, or for some
  90668. * series types the outline of each shape.
  90669. *
  90670. * In styled mode, the stroke dash-array can be set with the same classes as
  90671. * listed under series.color.
  90672. */
  90673. dashStyle?: DashStyleValue;
  90674. /**
  90675. * (Highstock) Data grouping is the concept of sampling the data values into
  90676. * larger blocks in order to ease readability and increase performance of
  90677. * the JavaScript charts. Highstock by default applies data grouping when
  90678. * the points become closer than a certain pixel value, determined by the
  90679. * `groupPixelWidth` option.
  90680. *
  90681. * If data grouping is applied, the grouping information of grouped points
  90682. * can be read from the Point.dataGroup. If point options other than the
  90683. * data itself are set, for example `name` or `color` or custom properties,
  90684. * the grouping logic doesn't know how to group it. In this case the options
  90685. * of the first point instance are copied over to the group point. This can
  90686. * be altered through a custom `approximation` callback function.
  90687. */
  90688. dataGrouping?: DataGroupingOptionsObject;
  90689. /**
  90690. * (Highcharts, Highstock, Highmaps, Gantt) Options for the series data
  90691. * labels, appearing next to each data point.
  90692. *
  90693. * Since v6.2.0, multiple data labels can be applied to each single point by
  90694. * defining them as an array of configs.
  90695. *
  90696. * In styled mode, the data labels can be styled with the
  90697. * `.highcharts-data-label-box` and `.highcharts-data-label` class names
  90698. * (see example).
  90699. */
  90700. dataLabels?: (PlotTrixDataLabelsOptions|Array<PlotTrixDataLabelsOptions>);
  90701. /**
  90702. * (Highcharts, Highstock) Options for the series data sorting.
  90703. */
  90704. dataSorting?: (DataSortingOptionsObject|PlotTrixDataSortingOptions);
  90705. /**
  90706. * (Highstock) A description of the series to add to the screen reader
  90707. * information about the series.
  90708. */
  90709. description?: string;
  90710. /**
  90711. * (Highstock) Enable or disable the mouse tracking for a specific series.
  90712. * This includes point tooltips and click events on graphs and points. For
  90713. * large datasets it improves performance.
  90714. */
  90715. enableMouseTracking?: boolean;
  90716. /**
  90717. * (Highstock) General event handlers for the series items. These event
  90718. * hooks can also be attached to the series at run time using the
  90719. * `Highcharts.addEvent` function.
  90720. */
  90721. events?: SeriesEventsOptionsObject;
  90722. /**
  90723. * (Highstock) Determines whether the series should look for the nearest
  90724. * point in both dimensions or just the x-dimension when hovering the
  90725. * series. Defaults to `'xy'` for scatter series and `'x'` for most other
  90726. * series. If the data has duplicate x-values, it is recommended to set this
  90727. * to `'xy'` to allow hovering over all points.
  90728. *
  90729. * Applies only to series types using nearest neighbor search (not direct
  90730. * hover) for tooltip.
  90731. */
  90732. findNearestPointBy?: OptionsFindNearestPointByValue;
  90733. /**
  90734. * (Highstock) Defines when to display a gap in the graph, together with the
  90735. * gapUnit option.
  90736. *
  90737. * In case when `dataGrouping` is enabled, points can be grouped into a
  90738. * larger time span. This can make the grouped points to have a greater
  90739. * distance than the absolute value of `gapSize` property, which will result
  90740. * in disappearing graph completely. To prevent this situation the mentioned
  90741. * distance between grouped points is used instead of previously defined
  90742. * `gapSize`.
  90743. *
  90744. * In practice, this option is most often used to visualize gaps in time
  90745. * series. In a stock chart, intraday data is available for daytime hours,
  90746. * while gaps will appear in nights and weekends.
  90747. */
  90748. gapSize?: number;
  90749. /**
  90750. * (Highstock) Together with gapSize, this option defines where to draw gaps
  90751. * in the graph.
  90752. *
  90753. * When the `gapUnit` is `"relative"` (default), a gap size of 5 means that
  90754. * if the distance between two points is greater than 5 times that of the
  90755. * two closest points, the graph will be broken.
  90756. *
  90757. * When the `gapUnit` is `"value"`, the gap is based on absolute axis
  90758. * values, which on a datetime axis is milliseconds. This also applies to
  90759. * the navigator series that inherits gap options from the base series.
  90760. */
  90761. gapUnit?: OptionsGapUnitValue;
  90762. /**
  90763. * (Highcharts, Highstock, Gantt) Whether to use the Y extremes of the total
  90764. * chart width or only the zoomed area when zooming in on parts of the X
  90765. * axis. By default, the Y axis adjusts to the min and max of the visible
  90766. * data. Cartesian series only.
  90767. */
  90768. getExtremesFromAll?: boolean;
  90769. /**
  90770. * (Highstock) When set to `false` will prevent the series data from being
  90771. * included in any form of data export.
  90772. *
  90773. * Since version 6.0.0 until 7.1.0 the option was existing undocumented as
  90774. * `includeInCSVExport`.
  90775. */
  90776. includeInDataExport?: boolean;
  90777. /**
  90778. * (Highcharts, Highstock, Gantt) Series labels are placed as close to the
  90779. * series as possible in a natural way, seeking to avoid other series. The
  90780. * goal of this feature is to make the chart more easily readable, like if a
  90781. * human designer placed the labels in the optimal position.
  90782. *
  90783. * The series labels currently work with series types having a `graph` or an
  90784. * `area`.
  90785. */
  90786. label?: SeriesLabelOptionsObject;
  90787. /**
  90788. * (Highstock) The line marks the last price from all points.
  90789. */
  90790. lastPrice?: SeriesLastPriceOptionsObject;
  90791. /**
  90792. * (Highstock) The line marks the last price from visible range of points.
  90793. */
  90794. lastVisiblePrice?: SeriesLastVisiblePriceOptionsObject;
  90795. /**
  90796. * (Highcharts, Highstock) The SVG value used for the `stroke-linecap` and
  90797. * `stroke-linejoin` of a line graph. Round means that lines are rounded in
  90798. * the ends and bends.
  90799. */
  90800. linecap?: SeriesLinecapValue;
  90801. /**
  90802. * (Highcharts, Highstock) Pixel width of the graph line.
  90803. */
  90804. lineWidth?: number;
  90805. /**
  90806. * (Highcharts, Highstock, Gantt) The main series ID that indicator will be
  90807. * based on. Required for this indicator.
  90808. */
  90809. linkedTo?: string;
  90810. /**
  90811. * (Highstock) Options for the point markers of line-like series. Properties
  90812. * like `fillColor`, `lineColor` and `lineWidth` define the visual
  90813. * appearance of the markers. Other series types, like column series, don't
  90814. * have markers, but have visual options on the series level instead.
  90815. *
  90816. * In styled mode, the markers can be styled with the `.highcharts-point`,
  90817. * `.highcharts-point-hover` and `.highcharts-point-select` class names.
  90818. */
  90819. marker?: PointMarkerOptionsObject;
  90820. /**
  90821. * (Highstock) The name of the series as shown in the legend, tooltip etc.
  90822. * If not set, it will be based on a technical indicator type and default
  90823. * params.
  90824. */
  90825. name?: string;
  90826. /**
  90827. * (Highstock) The color for the parts of the graph or points that are below
  90828. * the threshold. Note that `zones` takes precedence over the negative
  90829. * color. Using `negativeColor` is equivalent to applying a zone with value
  90830. * of 0.
  90831. */
  90832. negativeColor?: (ColorString|GradientColorObject|PatternObject);
  90833. /**
  90834. * (Highstock) Opacity of a series parts: line, fill (e.g. area) and
  90835. * dataLabels.
  90836. */
  90837. opacity?: number;
  90838. /**
  90839. * (Highstock) Paramters used in calculation of regression series' points.
  90840. */
  90841. params?: PlotTrixParamsOptions;
  90842. /**
  90843. * (Highstock) Properties for each single point.
  90844. */
  90845. point?: PlotSeriesPointOptions;
  90846. /**
  90847. * (Highstock) Same as accessibility.pointDescriptionFormatter, but for an
  90848. * individual series. Overrides the chart wide configuration.
  90849. */
  90850. pointDescriptionFormatter?: Function;
  90851. /**
  90852. * (Highstock) Whether to select the series initially. If `showCheckbox` is
  90853. * true, the checkbox next to the series name in the legend will be checked
  90854. * for a selected series.
  90855. */
  90856. selected?: boolean;
  90857. /**
  90858. * (Highstock) Whether to apply a drop shadow to the graph line. Since 2.3
  90859. * the shadow can be an object configuration containing `color`, `offsetX`,
  90860. * `offsetY`, `opacity` and `width`.
  90861. */
  90862. shadow?: (boolean|ShadowOptionsObject);
  90863. /**
  90864. * (Highstock) If true, a checkbox is displayed next to the legend item to
  90865. * allow selecting the series. The state of the checkbox is determined by
  90866. * the `selected` option.
  90867. */
  90868. showCheckbox?: boolean;
  90869. /**
  90870. * (Highstock) Whether to display this particular series or series type in
  90871. * the legend. Standalone series are shown in legend by default, and linked
  90872. * series are not. Since v7.2.0 it is possible to show series that use
  90873. * colorAxis by setting this option to `true`.
  90874. */
  90875. showInLegend?: boolean;
  90876. /**
  90877. * (Highstock) If set to `true`, the accessibility module will skip past the
  90878. * points in this series for keyboard navigation.
  90879. */
  90880. skipKeyboardNavigation?: boolean;
  90881. /**
  90882. * (Highcharts, Highstock) When this is true, the series will not cause the
  90883. * Y axis to cross the zero plane (or threshold option) unless the data
  90884. * actually crosses the plane.
  90885. *
  90886. * For example, if `softThreshold` is `false`, a series of 0, 1, 2, 3 will
  90887. * make the Y axis show negative values according to the `minPadding`
  90888. * option. If `softThreshold` is `true`, the Y axis starts at 0.
  90889. */
  90890. softThreshold?: boolean;
  90891. states?: SeriesStatesOptionsObject;
  90892. /**
  90893. * (Highcharts, Highstock) Whether to apply steps to the line. Possible
  90894. * values are `left`, `center` and `right`.
  90895. */
  90896. step?: OptionsStepValue;
  90897. /**
  90898. * (Highstock) Sticky tracking of mouse events. When true, the `mouseOut`
  90899. * event on a series isn't triggered until the mouse moves over another
  90900. * series, or out of the plot area. When false, the `mouseOut` event on a
  90901. * series is triggered when the mouse leaves the area around the series'
  90902. * graph or markers. This also implies the tooltip when not shared. When
  90903. * `stickyTracking` is false and `tooltip.shared` is false, the tooltip will
  90904. * be hidden when moving the mouse between series. Defaults to true for line
  90905. * and area type series, but to false for columns, pies etc.
  90906. *
  90907. * **Note:** The boost module will force this option because of technical
  90908. * limitations.
  90909. */
  90910. stickyTracking?: boolean;
  90911. /**
  90912. * (Highcharts, Highstock) The threshold, also called zero level or base
  90913. * level. For line type series this is only used in conjunction with
  90914. * negativeColor.
  90915. */
  90916. threshold?: (number|null);
  90917. /**
  90918. * (Highstock) A configuration object for the tooltip rendering of each
  90919. * single series. Properties are inherited from tooltip, but only the
  90920. * following properties can be defined on a series level.
  90921. */
  90922. tooltip?: SeriesTooltipOptionsObject;
  90923. /**
  90924. * (Highcharts, Highstock, Gantt) When a series contains a data array that
  90925. * is longer than this, only one dimensional arrays of numbers, or two
  90926. * dimensional arrays with x and y values are allowed. Also, only the first
  90927. * point is tested, and the rest are assumed to be the same format. This
  90928. * saves expensive data checking and indexing in long series. Set it to `0`
  90929. * disable.
  90930. *
  90931. * Note: In boost mode turbo threshold is forced. Only array of numbers or
  90932. * two dimensional arrays are allowed.
  90933. */
  90934. turboThreshold?: number;
  90935. /**
  90936. * (Highstock) Set the initial visibility of the series.
  90937. */
  90938. visible?: boolean;
  90939. /**
  90940. * (Highmaps) Define the z index of the series.
  90941. */
  90942. zIndex?: number;
  90943. /**
  90944. * (Highcharts, Highstock) Defines the Axis on which the zones are applied.
  90945. */
  90946. zoneAxis?: string;
  90947. /**
  90948. * (Highcharts, Highstock) An array defining zones within a series. Zones
  90949. * can be applied to the X axis, Y axis or Z axis for bubbles, according to
  90950. * the `zoneAxis` option. The zone definitions have to be in ascending order
  90951. * regarding to the value.
  90952. *
  90953. * In styled mode, the color zones are styled with the
  90954. * `.highcharts-zone-{n}` class, or custom classed from the `className`
  90955. * option (view live demo).
  90956. */
  90957. zones?: Array<SeriesZonesOptionsObject>;
  90958. }
  90959. /**
  90960. * (Highstock) Paramters used in calculation of regression series' points.
  90961. */
  90962. export interface PlotTrixParamsOptions {
  90963. /**
  90964. * (Highstock) The point index which indicator calculations will base. For
  90965. * example using OHLC data, index=2 means the indicator will be calculated
  90966. * using Low values.
  90967. *
  90968. * By default index value used to be set to 0. Since Highstock 7 by default
  90969. * index is set to 3 which means that the ema indicator will be calculated
  90970. * using Close values.
  90971. */
  90972. index?: number;
  90973. /**
  90974. * (Highstock) The base period for indicator calculations. This is the
  90975. * number of data points which are taken into account for the indicator
  90976. * calculations.
  90977. */
  90978. period?: number;
  90979. }
  90980. /**
  90981. * (Highcharts) Enable or disable the initial animation when a series is
  90982. * displayed. The animation can also be set as a configuration object. Please
  90983. * note that this option only applies to the initial animation of the series
  90984. * itself. For other animations, see chart.animation and the animation parameter
  90985. * under the API methods. The following properties are supported:
  90986. *
  90987. * - `defer`: The animation delay time in milliseconds.
  90988. *
  90989. * - `duration`: The duration of the animation in milliseconds.
  90990. *
  90991. * - `easing`: Can be a string reference to an easing function set on the `Math`
  90992. * object or a function. See the _Custom easing function_ demo below.
  90993. *
  90994. * Due to poor performance, animation is disabled in old IE browsers for several
  90995. * chart types.
  90996. */
  90997. export interface PlotVariablepieAnimationOptions {
  90998. defer?: number;
  90999. }
  91000. /**
  91001. * (Highcharts, Highstock, Highmaps, Gantt) Enable or disable the initial
  91002. * animation when a series is displayed for the `dataLabels`. The animation can
  91003. * also be set as a configuration object. Please note that this option only
  91004. * applies to the initial animation. For other animations, see chart.animation
  91005. * and the animation parameter under the API methods. The following properties
  91006. * are supported:
  91007. *
  91008. * - `defer`: The animation delay time in milliseconds.
  91009. */
  91010. export interface PlotVariablepieDataLabelsAnimationOptions {
  91011. /**
  91012. * (Highcharts, Highstock, Highmaps, Gantt) The animation delay time in
  91013. * milliseconds. Set to `0` renders dataLabel immediately. As `undefined`
  91014. * inherits defer time from the series.animation.defer.
  91015. */
  91016. defer?: number;
  91017. }
  91018. /**
  91019. * (Highcharts) A variable pie series is a two dimensional series type, where
  91020. * each point renders an Y and Z value. Each point is drawn as a pie slice where
  91021. * the size (arc) of the slice relates to the Y value and the radius of pie
  91022. * slice relates to the Z value.
  91023. *
  91024. * In TypeScript the type option must always be set.
  91025. *
  91026. * Configuration options for the series are given in three levels:
  91027. *
  91028. * 1. Options for all series in a chart are defined in the plotOptions.series
  91029. * object.
  91030. *
  91031. * 2. Options for all `variablepie` series are defined in
  91032. * plotOptions.variablepie.
  91033. *
  91034. * 3. Options for one single series are given in the series instance array. (see
  91035. * online documentation for example)
  91036. */
  91037. export interface PlotVariablepieOptions {
  91038. /**
  91039. * (Highcharts) Accessibility options for a series.
  91040. */
  91041. accessibility?: SeriesAccessibilityOptionsObject;
  91042. /**
  91043. * (Highmaps) Whether all areas of the map defined in `mapData` should be
  91044. * rendered. If `true`, areas which don't correspond to a data point, are
  91045. * rendered as `null` points. If `false`, those areas are skipped.
  91046. */
  91047. allAreas?: boolean;
  91048. /**
  91049. * (Highcharts) Allow this series' points to be selected by clicking on the
  91050. * graphic (columns, point markers, pie slices, map areas etc).
  91051. *
  91052. * The selected points can be handled by point select and unselect events,
  91053. * or collectively by the getSelectedPoints function.
  91054. *
  91055. * And alternative way of selecting points is through dragging.
  91056. */
  91057. allowPointSelect?: boolean;
  91058. /**
  91059. * (Highcharts) Enable or disable the initial animation when a series is
  91060. * displayed. The animation can also be set as a configuration object.
  91061. * Please note that this option only applies to the initial animation of the
  91062. * series itself. For other animations, see chart.animation and the
  91063. * animation parameter under the API methods. The following properties are
  91064. * supported:
  91065. *
  91066. * - `defer`: The animation delay time in milliseconds.
  91067. *
  91068. * - `duration`: The duration of the animation in milliseconds.
  91069. *
  91070. * - `easing`: Can be a string reference to an easing function set on the
  91071. * `Math` object or a function. See the _Custom easing function_ demo below.
  91072. *
  91073. * Due to poor performance, animation is disabled in old IE browsers for
  91074. * several chart types.
  91075. */
  91076. animation?: (boolean|PlotVariablepieAnimationOptions|Partial<AnimationOptionsObject>);
  91077. /**
  91078. * (Highcharts) The color of the border surrounding each slice. When `null`,
  91079. * the border takes the same color as the slice fill. This can be used
  91080. * together with a `borderWidth` to fill drawing gaps created by
  91081. * antialiazing artefacts in borderless pies.
  91082. *
  91083. * In styled mode, the border stroke is given in the `.highcharts-point`
  91084. * class.
  91085. */
  91086. borderColor?: (ColorString|GradientColorObject|PatternObject);
  91087. /**
  91088. * (Highcharts) The width of the border surrounding each slice.
  91089. *
  91090. * When setting the border width to 0, there may be small gaps between the
  91091. * slices due to SVG antialiasing artefacts. To work around this, keep the
  91092. * border width at 0.5 or 1, but set the `borderColor` to `null` instead.
  91093. *
  91094. * In styled mode, the border stroke width is given in the
  91095. * `.highcharts-point` class.
  91096. */
  91097. borderWidth?: number;
  91098. /**
  91099. * (Highcharts) The center of the pie chart relative to the plot area. Can
  91100. * be percentages or pixel values. The default behaviour (as of 3.0) is to
  91101. * center the pie so that all slices and data labels are within the plot
  91102. * area. As a consequence, the pie may actually jump around in a chart with
  91103. * dynamic values, as the data labels move. In that case, the center should
  91104. * be explicitly set, for example to `["50%", "50%"]`.
  91105. */
  91106. center?: [(number|string|null), (number|string|null)];
  91107. /**
  91108. * (Highcharts) An additional class name to apply to the series' graphical
  91109. * elements. This option does not replace default class names of the
  91110. * graphical element.
  91111. */
  91112. className?: string;
  91113. /**
  91114. * (Highcharts) Disable this option to allow series rendering in the whole
  91115. * plotting area.
  91116. *
  91117. * **Note:** Clipping should be always enabled when chart.zoomType is set
  91118. */
  91119. clip?: boolean;
  91120. /**
  91121. * (Highcharts) The color of the pie series. A pie series is represented as
  91122. * an empty circle if the total sum of its values is 0. Use this property to
  91123. * define the color of its border.
  91124. *
  91125. * In styled mode, the color can be defined by the colorIndex option. Also,
  91126. * the series color can be set with the `.highcharts-series`,
  91127. * `.highcharts-color-{n}`, `.highcharts-{type}-series` or
  91128. * `.highcharts-series-{n}` class, or individual classes given by the
  91129. * `className` option.
  91130. */
  91131. color?: (ColorString|GradientColorObject|PatternObject);
  91132. /**
  91133. * (Highcharts, Highstock, Highmaps) When using dual or multiple color axes,
  91134. * this number defines which colorAxis the particular series is connected
  91135. * to. It refers to either the axis id or the index of the axis in the
  91136. * colorAxis array, with 0 being the first. Set this option to false to
  91137. * prevent a series from connecting to the default color axis.
  91138. *
  91139. * Since v7.2.0 the option can also be an axis id or an axis index instead
  91140. * of a boolean flag.
  91141. */
  91142. colorAxis?: (boolean|number|string);
  91143. /**
  91144. * (Highcharts) Styled mode only. A specific color index to use for the
  91145. * series, so its graphic representations are given the class name
  91146. * `highcharts-color-{n}`.
  91147. */
  91148. colorIndex?: number;
  91149. /**
  91150. * (Highcharts, Highstock, Highmaps) Determines what data value should be
  91151. * used to calculate point color if `colorAxis` is used. Requires to set
  91152. * `min` and `max` if some custom point property is used or if approximation
  91153. * for data grouping is set to `'sum'`.
  91154. */
  91155. colorKey?: string;
  91156. /**
  91157. * (Highcharts) A series specific or series type specific color set to use
  91158. * instead of the global colors.
  91159. */
  91160. colors?: Array<(ColorString|GradientColorObject|PatternObject)>;
  91161. /**
  91162. * (Highstock) Compare the values of the series against the first non-null,
  91163. * non- zero value in the visible range. The y axis will show percentage or
  91164. * absolute change depending on whether `compare` is set to `"percent"` or
  91165. * `"value"`. When this is applied to multiple series, it allows comparing
  91166. * the development of the series against each other. Adds a `change` field
  91167. * to every point object.
  91168. */
  91169. compare?: string;
  91170. /**
  91171. * (Highstock) When compare is `percent`, this option dictates whether to
  91172. * use 0 or 100 as the base of comparison.
  91173. */
  91174. compareBase?: (0|100);
  91175. /**
  91176. * (Highstock) Defines if comparison should start from the first point
  91177. * within the visible range or should start from the first point **before**
  91178. * the range.
  91179. *
  91180. * In other words, this flag determines if first point within the visible
  91181. * range will have 0% (`compareStart=true`) or should have been already
  91182. * calculated according to the previous point (`compareStart=false`).
  91183. */
  91184. compareStart?: boolean;
  91185. /**
  91186. * (Gantt) Override Pathfinder connector options for a series. Requires
  91187. * Highcharts Gantt to be loaded.
  91188. */
  91189. connectors?: SeriesConnectorsOptionsObject;
  91190. /**
  91191. * (Highcharts, Highstock, Gantt) When true, each point or column edge is
  91192. * rounded to its nearest pixel in order to render sharp on screen. In some
  91193. * cases, when there are a lot of densely packed columns, this leads to
  91194. * visible difference in column widths or distance between columns. In these
  91195. * cases, setting `crisp` to `false` may look better, even though each
  91196. * column is rendered blurry.
  91197. */
  91198. crisp?: boolean;
  91199. /**
  91200. * (Highcharts) You can set the cursor to "pointer" if you have click events
  91201. * attached to the series, to signal to the user that the points and lines
  91202. * can be clicked.
  91203. *
  91204. * In styled mode, the series cursor can be set with the same classes as
  91205. * listed under series.color.
  91206. */
  91207. cursor?: (string|CursorValue);
  91208. /**
  91209. * (Highcharts) A reserved subspace to store options and values for
  91210. * customized functionality. Here you can add additional data for your own
  91211. * event callbacks and formatter callbacks.
  91212. */
  91213. custom?: Dictionary<any>;
  91214. /**
  91215. * (Highstock) Data grouping is the concept of sampling the data values into
  91216. * larger blocks in order to ease readability and increase performance of
  91217. * the JavaScript charts. Highstock by default applies data grouping when
  91218. * the points become closer than a certain pixel value, determined by the
  91219. * `groupPixelWidth` option.
  91220. *
  91221. * If data grouping is applied, the grouping information of grouped points
  91222. * can be read from the Point.dataGroup. If point options other than the
  91223. * data itself are set, for example `name` or `color` or custom properties,
  91224. * the grouping logic doesn't know how to group it. In this case the options
  91225. * of the first point instance are copied over to the group point. This can
  91226. * be altered through a custom `approximation` callback function.
  91227. */
  91228. dataGrouping?: DataGroupingOptionsObject;
  91229. /**
  91230. * (Highcharts, Highstock, Highmaps, Gantt) Options for the series data
  91231. * labels, appearing next to each data point.
  91232. *
  91233. * Since v6.2.0, multiple data labels can be applied to each single point by
  91234. * defining them as an array of configs.
  91235. *
  91236. * In styled mode, the data labels can be styled with the
  91237. * `.highcharts-data-label-box` and `.highcharts-data-label` class names
  91238. * (see example).
  91239. */
  91240. dataLabels?: (SeriesPieDataLabelsOptionsObject|Array<SeriesPieDataLabelsOptionsObject>);
  91241. /**
  91242. * (Highcharts) The thickness of a 3D pie.
  91243. */
  91244. depth?: number;
  91245. /**
  91246. * (Highcharts) A description of the series to add to the screen reader
  91247. * information about the series.
  91248. */
  91249. description?: string;
  91250. /**
  91251. * (Highcharts) Enable or disable the mouse tracking for a specific series.
  91252. * This includes point tooltips and click events on graphs and points. For
  91253. * large datasets it improves performance.
  91254. */
  91255. enableMouseTracking?: boolean;
  91256. /**
  91257. * (Highcharts) The end angle of the pie in degrees where 0 is top and 90 is
  91258. * right. Defaults to `startAngle` plus 360.
  91259. */
  91260. endAngle?: number;
  91261. /**
  91262. * (Highcharts) General event handlers for the series items. These event
  91263. * hooks can also be attached to the series at run time using the
  91264. * `Highcharts.addEvent` function.
  91265. */
  91266. events?: SeriesEventsOptionsObject;
  91267. /**
  91268. * (Highcharts) If the total sum of the pie's values is 0, the series is
  91269. * represented as an empty circle . The `fillColor` option defines the color
  91270. * of that circle. Use pie.borderWidth to set the border thickness.
  91271. */
  91272. fillColor?: (ColorString|GradientColorObject|PatternObject);
  91273. /**
  91274. * (Highstock) Defines when to display a gap in the graph, together with the
  91275. * gapUnit option.
  91276. *
  91277. * In case when `dataGrouping` is enabled, points can be grouped into a
  91278. * larger time span. This can make the grouped points to have a greater
  91279. * distance than the absolute value of `gapSize` property, which will result
  91280. * in disappearing graph completely. To prevent this situation the mentioned
  91281. * distance between grouped points is used instead of previously defined
  91282. * `gapSize`.
  91283. *
  91284. * In practice, this option is most often used to visualize gaps in time
  91285. * series. In a stock chart, intraday data is available for daytime hours,
  91286. * while gaps will appear in nights and weekends.
  91287. */
  91288. gapSize?: number;
  91289. /**
  91290. * (Highstock) Together with gapSize, this option defines where to draw gaps
  91291. * in the graph.
  91292. *
  91293. * When the `gapUnit` is `"relative"` (default), a gap size of 5 means that
  91294. * if the distance between two points is greater than 5 times that of the
  91295. * two closest points, the graph will be broken.
  91296. *
  91297. * When the `gapUnit` is `"value"`, the gap is based on absolute axis
  91298. * values, which on a datetime axis is milliseconds. This also applies to
  91299. * the navigator series that inherits gap options from the base series.
  91300. */
  91301. gapUnit?: OptionsGapUnitValue;
  91302. /**
  91303. * (Highcharts) Equivalent to chart.ignoreHiddenSeries, this option tells
  91304. * whether the series shall be redrawn as if the hidden point were `null`.
  91305. *
  91306. * The default value changed from `false` to `true` with Highcharts 3.0.
  91307. */
  91308. ignoreHiddenPoint?: boolean;
  91309. /**
  91310. * (Highcharts) When set to `false` will prevent the series data from being
  91311. * included in any form of data export.
  91312. *
  91313. * Since version 6.0.0 until 7.1.0 the option was existing undocumented as
  91314. * `includeInCSVExport`.
  91315. */
  91316. includeInDataExport?: boolean;
  91317. /**
  91318. * (Highcharts) The size of the inner diameter for the pie. A size greater
  91319. * than 0 renders a donut chart. Can be a percentage or pixel value.
  91320. * Percentages are relative to the pie size. Pixel values are given as
  91321. * integers.
  91322. *
  91323. * Note: in Highcharts < 4.1.2, the percentage was relative to the plot
  91324. * area, not the pie size.
  91325. */
  91326. innerSize?: (number|string);
  91327. /**
  91328. * (Highmaps) What property to join the `mapData` to the value data. For
  91329. * example, if joinBy is "code", the mapData items with a specific code is
  91330. * merged into the data with the same code. For maps loaded from GeoJSON,
  91331. * the keys may be held in each point's `properties` object.
  91332. *
  91333. * The joinBy option can also be an array of two values, where the first
  91334. * points to a key in the `mapData`, and the second points to another key in
  91335. * the `data`.
  91336. *
  91337. * When joinBy is `null`, the map items are joined by their position in the
  91338. * array, which performs much better in maps with many data points. This is
  91339. * the recommended option if you are printing more than a thousand data
  91340. * points and have a backend that can preprocess the data into a parallel
  91341. * array of the mapData.
  91342. */
  91343. joinBy?: (string|Array<string>);
  91344. /**
  91345. * (Highcharts) An array specifying which option maps to which key in the
  91346. * data point array. This makes it convenient to work with unstructured data
  91347. * arrays from different sources.
  91348. */
  91349. keys?: Array<string>;
  91350. /**
  91351. * (Highstock) The line marks the last price from all points.
  91352. */
  91353. lastPrice?: SeriesLastPriceOptionsObject;
  91354. /**
  91355. * (Highstock) The line marks the last price from visible range of points.
  91356. */
  91357. lastVisiblePrice?: SeriesLastVisiblePriceOptionsObject;
  91358. /**
  91359. * (Highcharts, Highstock) The SVG value used for the `stroke-linecap` and
  91360. * `stroke-linejoin` of a line graph. Round means that lines are rounded in
  91361. * the ends and bends.
  91362. */
  91363. linecap?: SeriesLinecapValue;
  91364. /**
  91365. * (Highcharts, Highstock, Gantt) The id of another series to link to.
  91366. * Additionally, the value can be ":previous" to link to the previous
  91367. * series. When two series are linked, only the first one appears in the
  91368. * legend. Toggling the visibility of this also toggles the linked series.
  91369. *
  91370. * If master series uses data sorting and linked series does not have its
  91371. * own sorting definition, the linked series will be sorted in the same
  91372. * order as the master one.
  91373. */
  91374. linkedTo?: string;
  91375. /**
  91376. * (Highcharts) The maximum size of the points' radius related to chart's
  91377. * `plotArea`. If a number is set, it applies in pixels.
  91378. */
  91379. maxPointSize?: (number|string);
  91380. /**
  91381. * (Highcharts) The minimum size of the points' radius related to chart's
  91382. * `plotArea`. If a number is set, it applies in pixels.
  91383. */
  91384. minPointSize?: (number|string);
  91385. /**
  91386. * (Highcharts) The minimum size for a pie in response to auto margins. The
  91387. * pie will try to shrink to make room for data labels in side the plot
  91388. * area, but only to this size.
  91389. */
  91390. minSize?: (number|string);
  91391. /**
  91392. * (Highstock) Options for the corresponding navigator series if
  91393. * `showInNavigator` is `true` for this series. Available options are the
  91394. * same as any series, documented at plotOptions and series.
  91395. *
  91396. * These options are merged with options in navigator.series, and will take
  91397. * precedence if the same option is defined both places.
  91398. */
  91399. navigatorOptions?: PlotSeriesOptions;
  91400. /**
  91401. * (Highcharts) Opacity of a series parts: line, fill (e.g. area) and
  91402. * dataLabels.
  91403. */
  91404. opacity?: number;
  91405. /**
  91406. * (Highcharts) Properties for each single point.
  91407. */
  91408. point?: PlotSeriesPointOptions;
  91409. /**
  91410. * (Highcharts) Same as accessibility.pointDescriptionFormatter, but for an
  91411. * individual series. Overrides the chart wide configuration.
  91412. */
  91413. pointDescriptionFormatter?: Function;
  91414. /**
  91415. * (Highstock) The width of each point on the x axis. For example in a
  91416. * column chart with one value each day, the pointRange would be 1 day (= 24
  91417. * * 3600
  91418. *
  91419. * * 1000 milliseconds). This is normally computed automatically, but this
  91420. * option can be used to override the automatic value.
  91421. */
  91422. pointRange?: number;
  91423. /**
  91424. * (Highcharts) Whether to select the series initially. If `showCheckbox` is
  91425. * true, the checkbox next to the series name in the legend will be checked
  91426. * for a selected series.
  91427. */
  91428. selected?: boolean;
  91429. /**
  91430. * (Highcharts) Whether to apply a drop shadow to the graph line. Since 2.3
  91431. * the shadow can be an object configuration containing `color`, `offsetX`,
  91432. * `offsetY`, `opacity` and `width`.
  91433. */
  91434. shadow?: (boolean|ShadowOptionsObject);
  91435. /**
  91436. * (Highcharts) If true, a checkbox is displayed next to the legend item to
  91437. * allow selecting the series. The state of the checkbox is determined by
  91438. * the `selected` option.
  91439. */
  91440. showCheckbox?: boolean;
  91441. /**
  91442. * (Highcharts) Whether to display this particular series or series type in
  91443. * the legend. Since 2.1, pies are not shown in the legend by default.
  91444. */
  91445. showInLegend?: boolean;
  91446. /**
  91447. * (Highstock) Whether or not to show the series in the navigator. Takes
  91448. * precedence over navigator.baseSeries if defined.
  91449. */
  91450. showInNavigator?: boolean;
  91451. /**
  91452. * (Highcharts) The diameter of the pie relative to the plot area. Can be a
  91453. * percentage or pixel value. Pixel values are given as integers. The
  91454. * default behaviour (as of 3.0) is to scale to the plot area and give room
  91455. * for data labels within the plot area. slicedOffset is also included in
  91456. * the default size calculation. As a consequence, the size of the pie may
  91457. * vary when points are updated and data labels more around. In that case it
  91458. * is best to set a fixed value, for example `"75%"`.
  91459. */
  91460. size?: (number|string|null);
  91461. /**
  91462. * (Highcharts) Whether the pie slice's value should be represented by the
  91463. * area or the radius of the slice. Can be either `area` or `radius`. The
  91464. * default, `area`, corresponds best to the human perception of the size of
  91465. * each pie slice.
  91466. */
  91467. sizeBy?: VariablePieSizeByValue;
  91468. /**
  91469. * (Highcharts) If set to `true`, the accessibility module will skip past
  91470. * the points in this series for keyboard navigation.
  91471. */
  91472. skipKeyboardNavigation?: boolean;
  91473. /**
  91474. * (Highcharts) If a point is sliced, moved out from the center, how many
  91475. * pixels should it be moved?.
  91476. */
  91477. slicedOffset?: number;
  91478. /**
  91479. * (Highcharts) The start angle of the pie slices in degrees where 0 is top
  91480. * and 90 right.
  91481. */
  91482. startAngle?: number;
  91483. states?: SeriesStatesOptionsObject;
  91484. /**
  91485. * (Highcharts) Sticky tracking of mouse events. When true, the `mouseOut`
  91486. * event on a series isn't triggered until the mouse moves over another
  91487. * series, or out of the plot area. When false, the `mouseOut` event on a
  91488. * series is triggered when the mouse leaves the area around the series'
  91489. * graph or markers. This also implies the tooltip. When `stickyTracking` is
  91490. * false and `tooltip.shared` is false, the tooltip will be hidden when
  91491. * moving the mouse between series.
  91492. */
  91493. stickyTracking?: boolean;
  91494. /**
  91495. * (Highcharts) A configuration object for the tooltip rendering of each
  91496. * single series. Properties are inherited from tooltip, but only the
  91497. * following properties can be defined on a series level.
  91498. */
  91499. tooltip?: SeriesTooltipOptionsObject;
  91500. /**
  91501. * (Highstock) The parameter allows setting line series type and use OHLC
  91502. * indicators. Data in OHLC format is required.
  91503. */
  91504. useOhlcData?: boolean;
  91505. /**
  91506. * (Highcharts) Set the initial visibility of the series.
  91507. */
  91508. visible?: boolean;
  91509. /**
  91510. * (Highmaps) Define the z index of the series.
  91511. */
  91512. zIndex?: number;
  91513. /**
  91514. * (Highcharts) The maximum possible z value for the point's radius
  91515. * calculation. If the point's Z value is bigger than zMax, the slice will
  91516. * be drawn according to the zMax value
  91517. */
  91518. zMax?: number;
  91519. /**
  91520. * (Highcharts) The minimum possible z value for the point's radius
  91521. * calculation. If the point's Z value is smaller than zMin, the slice will
  91522. * be drawn according to the zMin value.
  91523. */
  91524. zMin?: number;
  91525. }
  91526. /**
  91527. * (Highcharts) Enable or disable the initial animation when a series is
  91528. * displayed. The animation can also be set as a configuration object. Please
  91529. * note that this option only applies to the initial animation of the series
  91530. * itself. For other animations, see chart.animation and the animation parameter
  91531. * under the API methods. The following properties are supported:
  91532. *
  91533. * - `defer`: The animation delay time in milliseconds.
  91534. *
  91535. * - `duration`: The duration of the animation in milliseconds.
  91536. *
  91537. * - `easing`: Can be a string reference to an easing function set on the `Math`
  91538. * object or a function. See the _Custom easing function_ demo below.
  91539. *
  91540. * Due to poor performance, animation is disabled in old IE browsers for several
  91541. * chart types.
  91542. */
  91543. export interface PlotVariwideAnimationOptions {
  91544. defer?: number;
  91545. }
  91546. /**
  91547. * (Highcharts, Highstock, Highmaps, Gantt) Enable or disable the initial
  91548. * animation when a series is displayed for the `dataLabels`. The animation can
  91549. * also be set as a configuration object. Please note that this option only
  91550. * applies to the initial animation. For other animations, see chart.animation
  91551. * and the animation parameter under the API methods. The following properties
  91552. * are supported:
  91553. *
  91554. * - `defer`: The animation delay time in milliseconds.
  91555. */
  91556. export interface PlotVariwideDataLabelsAnimationOptions {
  91557. /**
  91558. * (Highcharts, Highstock, Highmaps, Gantt) The animation delay time in
  91559. * milliseconds. Set to `0` renders dataLabel immediately. As `undefined`
  91560. * inherits defer time from the series.animation.defer.
  91561. */
  91562. defer?: number;
  91563. }
  91564. /**
  91565. * (Highcharts, Highstock, Highmaps, Gantt) Options for the series data labels,
  91566. * appearing next to each data point.
  91567. *
  91568. * Since v6.2.0, multiple data labels can be applied to each single point by
  91569. * defining them as an array of configs.
  91570. *
  91571. * In styled mode, the data labels can be styled with the
  91572. * `.highcharts-data-label-box` and `.highcharts-data-label` class names (see
  91573. * example).
  91574. */
  91575. export interface PlotVariwideDataLabelsOptions {
  91576. /**
  91577. * (Highcharts, Highstock, Highmaps, Gantt) The alignment of the data label
  91578. * compared to the point. If `right`, the right side of the label should be
  91579. * touching the point. For points with an extent, like columns, the
  91580. * alignments also dictates how to align it inside the box, as given with
  91581. * the inside option. Can be one of `left`, `center` or `right`.
  91582. */
  91583. align?: string;
  91584. /**
  91585. * (Highcharts, Highstock, Highmaps, Gantt) Whether to allow data labels to
  91586. * overlap. To make the labels less sensitive for overlapping, the
  91587. * dataLabels.padding can be set to 0.
  91588. */
  91589. allowOverlap?: boolean;
  91590. /**
  91591. * (Highcharts, Highstock, Highmaps, Gantt) Enable or disable the initial
  91592. * animation when a series is displayed for the `dataLabels`. The animation
  91593. * can also be set as a configuration object. Please note that this option
  91594. * only applies to the initial animation. For other animations, see
  91595. * chart.animation and the animation parameter under the API methods. The
  91596. * following properties are supported:
  91597. *
  91598. * - `defer`: The animation delay time in milliseconds.
  91599. */
  91600. animation?: (boolean|PlotVariwideDataLabelsAnimationOptions|Partial<AnimationOptionsObject>);
  91601. /**
  91602. * (Highcharts, Highstock, Highmaps, Gantt) The background color or gradient
  91603. * for the data label.
  91604. */
  91605. backgroundColor?: (ColorString|GradientColorObject|PatternObject);
  91606. /**
  91607. * (Highcharts, Highstock, Highmaps, Gantt) The border color for the data
  91608. * label. Defaults to `undefined`.
  91609. */
  91610. borderColor?: (ColorString|GradientColorObject|PatternObject);
  91611. /**
  91612. * (Highcharts, Highstock, Highmaps, Gantt) The border radius in pixels for
  91613. * the data label.
  91614. */
  91615. borderRadius?: number;
  91616. /**
  91617. * (Highcharts, Highstock, Highmaps, Gantt) The border width in pixels for
  91618. * the data label.
  91619. */
  91620. borderWidth?: number;
  91621. /**
  91622. * (Highcharts, Highstock, Highmaps, Gantt) A class name for the data label.
  91623. * Particularly in styled mode, this can be used to give each series' or
  91624. * point's data label unique styling. In addition to this option, a default
  91625. * color class name is added so that we can give the labels a contrast text
  91626. * shadow.
  91627. */
  91628. className?: string;
  91629. /**
  91630. * (Highcharts, Highstock, Highmaps, Gantt) The text color for the data
  91631. * labels. Defaults to `undefined`. For certain series types, like column or
  91632. * map, the data labels can be drawn inside the points. In this case the
  91633. * data label will be drawn with maximum contrast by default. Additionally,
  91634. * it will be given a `text-outline` style with the opposite color, to
  91635. * further increase the contrast. This can be overridden by setting the
  91636. * `text-outline` style to `none` in the `dataLabels.style` option.
  91637. */
  91638. color?: (ColorString|GradientColorObject|PatternObject);
  91639. /**
  91640. * (Highcharts, Highstock, Highmaps, Gantt) Whether to hide data labels that
  91641. * are outside the plot area. By default, the data label is moved inside the
  91642. * plot area according to the overflow option.
  91643. */
  91644. crop?: boolean;
  91645. /**
  91646. * (Highcharts, Highstock, Gantt) Whether to defer displaying the data
  91647. * labels until the initial series animation has finished. Setting to
  91648. * `false` renders the data label immediately. If set to `true` inherits the
  91649. * defer time set in plotOptions.series.animation.
  91650. */
  91651. defer?: boolean;
  91652. /**
  91653. * (Highcharts, Highstock, Highmaps, Gantt) Enable or disable the data
  91654. * labels.
  91655. */
  91656. enabled?: boolean;
  91657. /**
  91658. * (Highcharts, Highstock, Highmaps, Gantt) A declarative filter to control
  91659. * of which data labels to display. The declarative filter is designed for
  91660. * use when callback functions are not available, like when the chart
  91661. * options require a pure JSON structure or for use with graphical editors.
  91662. * For programmatic control, use the `formatter` instead, and return
  91663. * `undefined` to disable a single data label.
  91664. */
  91665. filter?: DataLabelsFilterOptionsObject;
  91666. /**
  91667. * (Highcharts, Highstock, Highmaps, Gantt) A format string for the data
  91668. * label. Available variables are the same as for `formatter`.
  91669. */
  91670. format?: string;
  91671. /**
  91672. * (Highcharts, Highstock, Highmaps, Gantt) Callback JavaScript function to
  91673. * format the data label. Note that if a `format` is defined, the format
  91674. * takes precedence and the formatter is ignored.
  91675. */
  91676. formatter?: DataLabelsFormatterCallbackFunction;
  91677. /**
  91678. * (Highcharts, Highstock, Highmaps, Gantt) For points with an extent, like
  91679. * columns or map areas, whether to align the data label inside the box or
  91680. * to the actual value point. Defaults to `false` in most cases, `true` in
  91681. * stacked columns.
  91682. */
  91683. inside?: boolean;
  91684. /**
  91685. * (Highcharts, Highstock, Highmaps, Gantt) Format for points with the value
  91686. * of null. Works analogously to format. `nullFormat` can be applied only to
  91687. * series which support displaying null points.
  91688. */
  91689. nullFormat?: (boolean|string);
  91690. /**
  91691. * (Highcharts, Highstock, Highmaps, Gantt) Callback JavaScript function
  91692. * that defines formatting for points with the value of null. Works
  91693. * analogously to formatter. `nullPointFormatter` can be applied only to
  91694. * series which support displaying null points.
  91695. */
  91696. nullFormatter?: DataLabelsFormatterCallbackFunction;
  91697. /**
  91698. * (Highcharts, Highstock, Highmaps, Gantt) How to handle data labels that
  91699. * flow outside the plot area. The default is `"justify"`, which aligns them
  91700. * inside the plot area. For columns and bars, this means it will be moved
  91701. * inside the bar. To display data labels outside the plot area, set `crop`
  91702. * to `false` and `overflow` to `"allow"`.
  91703. */
  91704. overflow?: DataLabelsOverflowValue;
  91705. /**
  91706. * (Highcharts, Highstock, Highmaps, Gantt) When either the `borderWidth` or
  91707. * the `backgroundColor` is set, this is the padding within the box.
  91708. */
  91709. padding?: number;
  91710. /**
  91711. * (Highcharts, Highstock, Highmaps, Gantt) Aligns data labels relative to
  91712. * points. If `center` alignment is not possible, it defaults to `right`.
  91713. */
  91714. position?: AlignValue;
  91715. /**
  91716. * (Highcharts, Highstock, Highmaps, Gantt) Text rotation in degrees. Note
  91717. * that due to a more complex structure, backgrounds, borders and padding
  91718. * will be lost on a rotated data label.
  91719. */
  91720. rotation?: number;
  91721. /**
  91722. * (Highcharts, Highstock, Highmaps, Gantt) The shadow of the box. Works
  91723. * best with `borderWidth` or `backgroundColor`. Since 2.3 the shadow can be
  91724. * an object configuration containing `color`, `offsetX`, `offsetY`,
  91725. * `opacity` and `width`.
  91726. */
  91727. shadow?: (boolean|ShadowOptionsObject);
  91728. /**
  91729. * (Highcharts, Highstock, Highmaps, Gantt) The name of a symbol to use for
  91730. * the border around the label. Symbols are predefined functions on the
  91731. * Renderer object.
  91732. */
  91733. shape?: string;
  91734. /**
  91735. * (Highcharts, Highstock, Highmaps, Gantt) Styles for the label. The
  91736. * default `color` setting is `"contrast"`, which is a pseudo color that
  91737. * Highcharts picks up and applies the maximum contrast to the underlying
  91738. * point item, for example the bar in a bar chart.
  91739. *
  91740. * The `textOutline` is a pseudo property that applies an outline of the
  91741. * given width with the given color, which by default is the maximum
  91742. * contrast to the text. So a bright text color will result in a black text
  91743. * outline for maximum readability on a mixed background. In some cases,
  91744. * especially with grayscale text, the text outline doesn't work well, in
  91745. * which cases it can be disabled by setting it to `"none"`. When `useHTML`
  91746. * is true, the `textOutline` will not be picked up. In this, case, the same
  91747. * effect can be acheived through the `text-shadow` CSS property.
  91748. *
  91749. * For some series types, where each point has an extent, like for example
  91750. * tree maps, the data label may overflow the point. There are two
  91751. * strategies for handling overflow. By default, the text will wrap to
  91752. * multiple lines. The other strategy is to set `style.textOverflow` to
  91753. * `ellipsis`, which will keep the text on one line plus it will break
  91754. * inside long words.
  91755. */
  91756. style?: CSSObject;
  91757. /**
  91758. * (Highcharts, Highstock, Highmaps, Gantt) Options for a label text which
  91759. * should follow marker's shape. Border and background are disabled for a
  91760. * label that follows a path.
  91761. *
  91762. * **Note:** Only SVG-based renderer supports this option. Setting `useHTML`
  91763. * to true will disable this option.
  91764. */
  91765. textPath?: DataLabelsTextPathOptionsObject;
  91766. /**
  91767. * (Highcharts, Highstock, Highmaps, Gantt) Whether to use HTML to render
  91768. * the labels.
  91769. */
  91770. useHTML?: boolean;
  91771. /**
  91772. * (Highcharts, Highstock, Highmaps, Gantt) The vertical alignment of a data
  91773. * label. Can be one of `top`, `middle` or `bottom`. The default value
  91774. * depends on the data, for instance in a column chart, the label is above
  91775. * positive values and below negative values.
  91776. */
  91777. verticalAlign?: string;
  91778. /**
  91779. * (Highcharts, Highstock, Highmaps, Gantt) The x position offset of the
  91780. * label relative to the point in pixels.
  91781. */
  91782. x?: number;
  91783. /**
  91784. * (Highcharts, Highstock, Highmaps, Gantt) The y position offset of the
  91785. * label relative to the point in pixels.
  91786. */
  91787. y?: number;
  91788. /**
  91789. * (Highcharts, Highstock, Highmaps, Gantt) The Z index of the data labels.
  91790. * The default Z index puts it above the series. Use a Z index of 2 to
  91791. * display it behind the series.
  91792. */
  91793. z?: number;
  91794. }
  91795. /**
  91796. * (Highcharts, Highstock) Options for the series data sorting.
  91797. */
  91798. export interface PlotVariwideDataSortingOptions {
  91799. /**
  91800. * (Highcharts, Highstock) Enable or disable data sorting for the series.
  91801. * Use xAxis.reversed to change the sorting order.
  91802. */
  91803. enabled?: boolean;
  91804. /**
  91805. * (Highcharts, Highstock) Whether to allow matching points by name in an
  91806. * update. If this option is disabled, points will be matched by order.
  91807. */
  91808. matchByName?: boolean;
  91809. /**
  91810. * (Highcharts, Highstock) Determines what data value should be used to sort
  91811. * by.
  91812. */
  91813. sortKey?: string;
  91814. }
  91815. /**
  91816. * (Highcharts) Style options for the guide box. The guide box has one state by
  91817. * default, the `default` state.
  91818. */
  91819. export interface PlotVariwideDragDropGuideBoxOptions {
  91820. /**
  91821. * (Highcharts) Style options for the guide box default state.
  91822. */
  91823. default?: DragDropGuideBoxOptionsObject;
  91824. }
  91825. /**
  91826. * (Highcharts) A variwide chart (related to marimekko chart) is a column chart
  91827. * with a variable width expressing a third dimension.
  91828. *
  91829. * In TypeScript the type option must always be set.
  91830. *
  91831. * Configuration options for the series are given in three levels:
  91832. *
  91833. * 1. Options for all series in a chart are defined in the plotOptions.series
  91834. * object.
  91835. *
  91836. * 2. Options for all `variwide` series are defined in plotOptions.variwide.
  91837. *
  91838. * 3. Options for one single series are given in the series instance array. (see
  91839. * online documentation for example)
  91840. */
  91841. export interface PlotVariwideOptions {
  91842. /**
  91843. * (Highcharts) Accessibility options for a series.
  91844. */
  91845. accessibility?: SeriesAccessibilityOptionsObject;
  91846. /**
  91847. * (Highmaps) Whether all areas of the map defined in `mapData` should be
  91848. * rendered. If `true`, areas which don't correspond to a data point, are
  91849. * rendered as `null` points. If `false`, those areas are skipped.
  91850. */
  91851. allAreas?: boolean;
  91852. /**
  91853. * (Highcharts) Allow this series' points to be selected by clicking on the
  91854. * graphic (columns, point markers, pie slices, map areas etc).
  91855. *
  91856. * The selected points can be handled by point select and unselect events,
  91857. * or collectively by the getSelectedPoints function.
  91858. *
  91859. * And alternative way of selecting points is through dragging.
  91860. */
  91861. allowPointSelect?: boolean;
  91862. /**
  91863. * (Highcharts) Enable or disable the initial animation when a series is
  91864. * displayed. The animation can also be set as a configuration object.
  91865. * Please note that this option only applies to the initial animation of the
  91866. * series itself. For other animations, see chart.animation and the
  91867. * animation parameter under the API methods. The following properties are
  91868. * supported:
  91869. *
  91870. * - `defer`: The animation delay time in milliseconds.
  91871. *
  91872. * - `duration`: The duration of the animation in milliseconds.
  91873. *
  91874. * - `easing`: Can be a string reference to an easing function set on the
  91875. * `Math` object or a function. See the _Custom easing function_ demo below.
  91876. *
  91877. * Due to poor performance, animation is disabled in old IE browsers for
  91878. * several chart types.
  91879. */
  91880. animation?: (boolean|PlotVariwideAnimationOptions|Partial<AnimationOptionsObject>);
  91881. /**
  91882. * (Highcharts) For some series, there is a limit that shuts down initial
  91883. * animation by default when the total number of points in the chart is too
  91884. * high. For example, for a column chart and its derivatives, animation does
  91885. * not run if there is more than 250 points totally. To disable this cap,
  91886. * set `animationLimit` to `Infinity`.
  91887. */
  91888. animationLimit?: number;
  91889. /**
  91890. * (Highcharts, Highstock, Gantt) The color of the border surrounding each
  91891. * column or bar.
  91892. *
  91893. * In styled mode, the border stroke can be set with the `.highcharts-point`
  91894. * rule.
  91895. */
  91896. borderColor?: (ColorString|GradientColorObject|PatternObject);
  91897. /**
  91898. * (Highcharts, Highstock, Gantt) The corner radius of the border
  91899. * surrounding each column or bar.
  91900. */
  91901. borderRadius?: number;
  91902. /**
  91903. * (Highcharts, Highstock, Gantt) The width of the border surrounding each
  91904. * column or bar. Defaults to `1` when there is room for a border, but to
  91905. * `0` when the columns are so dense that a border would cover the next
  91906. * column.
  91907. *
  91908. * In styled mode, the stroke width can be set with the `.highcharts-point`
  91909. * rule.
  91910. */
  91911. borderWidth?: number;
  91912. /**
  91913. * (Highcharts, Highstock, Gantt) When `true`, the columns will center in
  91914. * the category, ignoring null or missing points. When `false`, space will
  91915. * be reserved for null or missing points.
  91916. */
  91917. centerInCategory?: boolean;
  91918. /**
  91919. * (Highcharts) An additional class name to apply to the series' graphical
  91920. * elements. This option does not replace default class names of the
  91921. * graphical element.
  91922. */
  91923. className?: string;
  91924. /**
  91925. * (Highcharts) Disable this option to allow series rendering in the whole
  91926. * plotting area.
  91927. *
  91928. * **Note:** Clipping should be always enabled when chart.zoomType is set
  91929. */
  91930. clip?: boolean;
  91931. /**
  91932. * (Highcharts) The main color of the series. In line type series it applies
  91933. * to the line and the point markers unless otherwise specified. In bar type
  91934. * series it applies to the bars unless a color is specified per point. The
  91935. * default value is pulled from the `options.colors` array.
  91936. *
  91937. * In styled mode, the color can be defined by the colorIndex option. Also,
  91938. * the series color can be set with the `.highcharts-series`,
  91939. * `.highcharts-color-{n}`, `.highcharts-{type}-series` or
  91940. * `.highcharts-series-{n}` class, or individual classes given by the
  91941. * `className` option.
  91942. */
  91943. color?: (ColorString|GradientColorObject|PatternObject);
  91944. /**
  91945. * (Highcharts, Highstock, Highmaps) When using dual or multiple color axes,
  91946. * this number defines which colorAxis the particular series is connected
  91947. * to. It refers to either the axis id or the index of the axis in the
  91948. * colorAxis array, with 0 being the first. Set this option to false to
  91949. * prevent a series from connecting to the default color axis.
  91950. *
  91951. * Since v7.2.0 the option can also be an axis id or an axis index instead
  91952. * of a boolean flag.
  91953. */
  91954. colorAxis?: (boolean|number|string);
  91955. /**
  91956. * (Highcharts, Highstock, Gantt) When using automatic point colors pulled
  91957. * from the global colors or series-specific plotOptions.column.colors
  91958. * collections, this option determines whether the chart should receive one
  91959. * color per series or one color per point.
  91960. *
  91961. * In styled mode, the `colors` or `series.colors` arrays are not supported,
  91962. * and instead this option gives the points individual color class names on
  91963. * the form `highcharts-color-{n}`.
  91964. */
  91965. colorByPoint?: boolean;
  91966. /**
  91967. * (Highcharts) Styled mode only. A specific color index to use for the
  91968. * series, so its graphic representations are given the class name
  91969. * `highcharts-color-{n}`.
  91970. */
  91971. colorIndex?: number;
  91972. /**
  91973. * (Highcharts, Highstock, Highmaps) Determines what data value should be
  91974. * used to calculate point color if `colorAxis` is used. Requires to set
  91975. * `min` and `max` if some custom point property is used or if approximation
  91976. * for data grouping is set to `'sum'`.
  91977. */
  91978. colorKey?: string;
  91979. /**
  91980. * (Highcharts, Highstock, Gantt) A series specific or series type specific
  91981. * color set to apply instead of the global colors when colorByPoint is
  91982. * true.
  91983. */
  91984. colors?: Array<(ColorString|GradientColorObject|PatternObject)>;
  91985. /**
  91986. * (Highstock) Compare the values of the series against the first non-null,
  91987. * non- zero value in the visible range. The y axis will show percentage or
  91988. * absolute change depending on whether `compare` is set to `"percent"` or
  91989. * `"value"`. When this is applied to multiple series, it allows comparing
  91990. * the development of the series against each other. Adds a `change` field
  91991. * to every point object.
  91992. */
  91993. compare?: string;
  91994. /**
  91995. * (Highstock) When compare is `percent`, this option dictates whether to
  91996. * use 0 or 100 as the base of comparison.
  91997. */
  91998. compareBase?: (0|100);
  91999. /**
  92000. * (Highstock) Defines if comparison should start from the first point
  92001. * within the visible range or should start from the first point **before**
  92002. * the range.
  92003. *
  92004. * In other words, this flag determines if first point within the visible
  92005. * range will have 0% (`compareStart=true`) or should have been already
  92006. * calculated according to the previous point (`compareStart=false`).
  92007. */
  92008. compareStart?: boolean;
  92009. /**
  92010. * (Gantt) Override Pathfinder connector options for a series. Requires
  92011. * Highcharts Gantt to be loaded.
  92012. */
  92013. connectors?: SeriesConnectorsOptionsObject;
  92014. /**
  92015. * (Highcharts, Highstock, Gantt) When the series contains less points than
  92016. * the crop threshold, all points are drawn, event if the points fall
  92017. * outside the visible plot area at the current zoom. The advantage of
  92018. * drawing all points (including markers and columns), is that animation is
  92019. * performed on updates. On the other hand, when the series contains more
  92020. * points than the crop threshold, the series data is cropped to only
  92021. * contain points that fall within the plot area. The advantage of cropping
  92022. * away invisible points is to increase performance on large series.
  92023. */
  92024. cropThreshold?: number;
  92025. /**
  92026. * (Highcharts) You can set the cursor to "pointer" if you have click events
  92027. * attached to the series, to signal to the user that the points and lines
  92028. * can be clicked.
  92029. *
  92030. * In styled mode, the series cursor can be set with the same classes as
  92031. * listed under series.color.
  92032. */
  92033. cursor?: (string|CursorValue);
  92034. /**
  92035. * (Highcharts) A reserved subspace to store options and values for
  92036. * customized functionality. Here you can add additional data for your own
  92037. * event callbacks and formatter callbacks.
  92038. */
  92039. custom?: Dictionary<any>;
  92040. /**
  92041. * (Highcharts) Name of the dash style to use for the graph, or for some
  92042. * series types the outline of each shape.
  92043. *
  92044. * In styled mode, the stroke dash-array can be set with the same classes as
  92045. * listed under series.color.
  92046. */
  92047. dashStyle?: DashStyleValue;
  92048. /**
  92049. * (Highstock) Data grouping is the concept of sampling the data values into
  92050. * larger blocks in order to ease readability and increase performance of
  92051. * the JavaScript charts. Highstock by default applies data grouping when
  92052. * the points become closer than a certain pixel value, determined by the
  92053. * `groupPixelWidth` option.
  92054. *
  92055. * If data grouping is applied, the grouping information of grouped points
  92056. * can be read from the Point.dataGroup. If point options other than the
  92057. * data itself are set, for example `name` or `color` or custom properties,
  92058. * the grouping logic doesn't know how to group it. In this case the options
  92059. * of the first point instance are copied over to the group point. This can
  92060. * be altered through a custom `approximation` callback function.
  92061. */
  92062. dataGrouping?: DataGroupingOptionsObject;
  92063. /**
  92064. * (Highcharts, Highstock, Highmaps, Gantt) Options for the series data
  92065. * labels, appearing next to each data point.
  92066. *
  92067. * Since v6.2.0, multiple data labels can be applied to each single point by
  92068. * defining them as an array of configs.
  92069. *
  92070. * In styled mode, the data labels can be styled with the
  92071. * `.highcharts-data-label-box` and `.highcharts-data-label` class names
  92072. * (see example).
  92073. */
  92074. dataLabels?: (PlotVariwideDataLabelsOptions|Array<PlotVariwideDataLabelsOptions>);
  92075. /**
  92076. * (Highcharts, Highstock) Options for the series data sorting.
  92077. */
  92078. dataSorting?: (DataSortingOptionsObject|PlotVariwideDataSortingOptions);
  92079. /**
  92080. * (Highcharts) A description of the series to add to the screen reader
  92081. * information about the series.
  92082. */
  92083. description?: string;
  92084. /**
  92085. * (Highcharts) The draggable-points module allows points to be moved around
  92086. * or modified in the chart. In addition to the options mentioned under the
  92087. * `dragDrop` API structure, the module fires three events, point.dragStart,
  92088. * point.drag and point.drop.
  92089. */
  92090. dragDrop?: SeriesDragDropOptionsObject;
  92091. /**
  92092. * (Highcharts) Enable or disable the mouse tracking for a specific series.
  92093. * This includes point tooltips and click events on graphs and points. For
  92094. * large datasets it improves performance.
  92095. */
  92096. enableMouseTracking?: boolean;
  92097. /**
  92098. * (Highcharts) General event handlers for the series items. These event
  92099. * hooks can also be attached to the series at run time using the
  92100. * `Highcharts.addEvent` function.
  92101. */
  92102. events?: SeriesEventsOptionsObject;
  92103. /**
  92104. * (Highcharts) Determines whether the series should look for the nearest
  92105. * point in both dimensions or just the x-dimension when hovering the
  92106. * series. Defaults to `'xy'` for scatter series and `'x'` for most other
  92107. * series. If the data has duplicate x-values, it is recommended to set this
  92108. * to `'xy'` to allow hovering over all points.
  92109. *
  92110. * Applies only to series types using nearest neighbor search (not direct
  92111. * hover) for tooltip.
  92112. */
  92113. findNearestPointBy?: OptionsFindNearestPointByValue;
  92114. /**
  92115. * (Highcharts, Highstock, Gantt) Whether to use the Y extremes of the total
  92116. * chart width or only the zoomed area when zooming in on parts of the X
  92117. * axis. By default, the Y axis adjusts to the min and max of the visible
  92118. * data. Cartesian series only.
  92119. */
  92120. getExtremesFromAll?: boolean;
  92121. /**
  92122. * (Highcharts, Highstock, Gantt) Whether to group non-stacked columns or to
  92123. * let them render independent of each other. Non-grouped columns will be
  92124. * laid out individually and overlap each other.
  92125. */
  92126. grouping?: boolean;
  92127. /**
  92128. * (Highcharts, Highstock, Gantt) In a variwide chart, the group padding is
  92129. * 0 in order to express the horizontal stacking of items.
  92130. */
  92131. groupPadding?: number;
  92132. /**
  92133. * (Highcharts) When set to `false` will prevent the series data from being
  92134. * included in any form of data export.
  92135. *
  92136. * Since version 6.0.0 until 7.1.0 the option was existing undocumented as
  92137. * `includeInCSVExport`.
  92138. */
  92139. includeInDataExport?: boolean;
  92140. /**
  92141. * (Highmaps) What property to join the `mapData` to the value data. For
  92142. * example, if joinBy is "code", the mapData items with a specific code is
  92143. * merged into the data with the same code. For maps loaded from GeoJSON,
  92144. * the keys may be held in each point's `properties` object.
  92145. *
  92146. * The joinBy option can also be an array of two values, where the first
  92147. * points to a key in the `mapData`, and the second points to another key in
  92148. * the `data`.
  92149. *
  92150. * When joinBy is `null`, the map items are joined by their position in the
  92151. * array, which performs much better in maps with many data points. This is
  92152. * the recommended option if you are printing more than a thousand data
  92153. * points and have a backend that can preprocess the data into a parallel
  92154. * array of the mapData.
  92155. */
  92156. joinBy?: (string|Array<string>);
  92157. /**
  92158. * (Highcharts) An array specifying which option maps to which key in the
  92159. * data point array. This makes it convenient to work with unstructured data
  92160. * arrays from different sources.
  92161. */
  92162. keys?: Array<string>;
  92163. /**
  92164. * (Highcharts, Highstock, Gantt) Series labels are placed as close to the
  92165. * series as possible in a natural way, seeking to avoid other series. The
  92166. * goal of this feature is to make the chart more easily readable, like if a
  92167. * human designer placed the labels in the optimal position.
  92168. *
  92169. * The series labels currently work with series types having a `graph` or an
  92170. * `area`.
  92171. */
  92172. label?: SeriesLabelOptionsObject;
  92173. /**
  92174. * (Highstock) The line marks the last price from all points.
  92175. */
  92176. lastPrice?: SeriesLastPriceOptionsObject;
  92177. /**
  92178. * (Highstock) The line marks the last price from visible range of points.
  92179. */
  92180. lastVisiblePrice?: SeriesLastVisiblePriceOptionsObject;
  92181. /**
  92182. * (Highcharts, Highstock, Gantt) The id of another series to link to.
  92183. * Additionally, the value can be ":previous" to link to the previous
  92184. * series. When two series are linked, only the first one appears in the
  92185. * legend. Toggling the visibility of this also toggles the linked series.
  92186. *
  92187. * If master series uses data sorting and linked series does not have its
  92188. * own sorting definition, the linked series will be sorted in the same
  92189. * order as the master one.
  92190. */
  92191. linkedTo?: string;
  92192. /**
  92193. * (Highcharts, Highstock, Gantt) The maximum allowed pixel width for a
  92194. * column, translated to the height of a bar in a bar chart. This prevents
  92195. * the columns from becoming too wide when there is a small number of points
  92196. * in the chart.
  92197. */
  92198. maxPointWidth?: number;
  92199. /**
  92200. * (Highcharts, Highstock, Gantt) The minimal height for a column or width
  92201. * for a bar. By default, 0 values are not shown. To visualize a 0 (or close
  92202. * to zero) point, set the minimal point length to a pixel value like 3\. In
  92203. * stacked column charts, minPointLength might not be respected for tightly
  92204. * packed values.
  92205. */
  92206. minPointLength?: number;
  92207. /**
  92208. * (Highstock) Options for the corresponding navigator series if
  92209. * `showInNavigator` is `true` for this series. Available options are the
  92210. * same as any series, documented at plotOptions and series.
  92211. *
  92212. * These options are merged with options in navigator.series, and will take
  92213. * precedence if the same option is defined both places.
  92214. */
  92215. navigatorOptions?: PlotSeriesOptions;
  92216. /**
  92217. * (Highcharts) The color for the parts of the graph or points that are
  92218. * below the threshold. Note that `zones` takes precedence over the negative
  92219. * color. Using `negativeColor` is equivalent to applying a zone with value
  92220. * of 0.
  92221. */
  92222. negativeColor?: (ColorString|GradientColorObject|PatternObject);
  92223. /**
  92224. * (Highcharts) Opacity of a series parts: line, fill (e.g. area) and
  92225. * dataLabels.
  92226. */
  92227. opacity?: number;
  92228. /**
  92229. * (Highcharts) Properties for each single point.
  92230. */
  92231. point?: PlotSeriesPointOptions;
  92232. /**
  92233. * (Highcharts) Same as accessibility.pointDescriptionFormatter, but for an
  92234. * individual series. Overrides the chart wide configuration.
  92235. */
  92236. pointDescriptionFormatter?: Function;
  92237. /**
  92238. * (Highcharts, Highstock, Gantt) If no x values are given for the points in
  92239. * a series, `pointInterval` defines the interval of the x values. For
  92240. * example, if a series contains one value every decade starting from year
  92241. * 0, set `pointInterval` to `10`. In true `datetime` axes, the
  92242. * `pointInterval` is set in milliseconds.
  92243. *
  92244. * It can be also be combined with `pointIntervalUnit` to draw irregular
  92245. * time intervals.
  92246. *
  92247. * Please note that this options applies to the _series data_, not the
  92248. * interval of the axis ticks, which is independent.
  92249. */
  92250. pointInterval?: number;
  92251. /**
  92252. * (Highcharts, Highstock, Gantt) On datetime series, this allows for
  92253. * setting the pointInterval to irregular time units, `day`, `month` and
  92254. * `year`. A day is usually the same as 24 hours, but `pointIntervalUnit`
  92255. * also takes the DST crossover into consideration when dealing with local
  92256. * time. Combine this option with `pointInterval` to draw weeks, quarters, 6
  92257. * months, 10 years etc.
  92258. *
  92259. * Please note that this options applies to the _series data_, not the
  92260. * interval of the axis ticks, which is independent.
  92261. */
  92262. pointIntervalUnit?: OptionsPointIntervalUnitValue;
  92263. /**
  92264. * (Highcharts, Highstock, Gantt) In a variwide chart, the point padding is
  92265. * 0 in order to express the horizontal stacking of items.
  92266. */
  92267. pointPadding?: number;
  92268. /**
  92269. * (Highcharts, Highstock, Gantt) Possible values: `"on"`, `"between"`,
  92270. * `number`.
  92271. *
  92272. * In a column chart, when pointPlacement is `"on"`, the point will not
  92273. * create any padding of the X axis. In a polar column chart this means that
  92274. * the first column points directly north. If the pointPlacement is
  92275. * `"between"`, the columns will be laid out between ticks. This is useful
  92276. * for example for visualising an amount between two points in time or in a
  92277. * certain sector of a polar chart.
  92278. *
  92279. * Since Highcharts 3.0.2, the point placement can also be numeric, where 0
  92280. * is on the axis value, -0.5 is between this value and the previous, and
  92281. * 0.5 is between this value and the next. Unlike the textual options,
  92282. * numeric point placement options won't affect axis padding.
  92283. *
  92284. * Note that pointPlacement needs a pointRange to work. For column series
  92285. * this is computed, but for line-type series it needs to be set.
  92286. *
  92287. * For the `xrange` series type and gantt charts, if the Y axis is a
  92288. * category axis, the `pointPlacement` applies to the Y axis rather than the
  92289. * (typically datetime) X axis.
  92290. *
  92291. * Defaults to `undefined` in cartesian charts, `"between"` in polar charts.
  92292. */
  92293. pointPlacement?: (number|string);
  92294. /**
  92295. * (Highcharts, Highstock, Gantt) The X axis range that each point is valid
  92296. * for. This determines the width of the column. On a categorized axis, the
  92297. * range will be 1 by default (one category unit). On linear and datetime
  92298. * axes, the range will be computed as the distance between the two closest
  92299. * data points.
  92300. *
  92301. * The default `null` means it is computed automatically, but this option
  92302. * can be used to override the automatic value.
  92303. *
  92304. * This option is set by default to 1 if data sorting is enabled.
  92305. */
  92306. pointRange?: (number|null);
  92307. /**
  92308. * (Highcharts, Highstock, Gantt) If no x values are given for the points in
  92309. * a series, pointStart defines on what value to start. For example, if a
  92310. * series contains one yearly value starting from 1945, set pointStart to
  92311. * 1945.
  92312. */
  92313. pointStart?: number;
  92314. /**
  92315. * (Highcharts, Highstock, Gantt) A pixel value specifying a fixed width for
  92316. * each column or bar point. When set to `undefined`, the width is
  92317. * calculated from the `pointPadding` and `groupPadding`. The width effects
  92318. * the dimension that is not based on the point value. For column series it
  92319. * is the hoizontal length and for bar series it is the vertical length.
  92320. */
  92321. pointWidth?: number;
  92322. /**
  92323. * (Highcharts) Whether to select the series initially. If `showCheckbox` is
  92324. * true, the checkbox next to the series name in the legend will be checked
  92325. * for a selected series.
  92326. */
  92327. selected?: boolean;
  92328. /**
  92329. * (Highcharts) Whether to apply a drop shadow to the graph line. Since 2.3
  92330. * the shadow can be an object configuration containing `color`, `offsetX`,
  92331. * `offsetY`, `opacity` and `width`.
  92332. */
  92333. shadow?: (boolean|ShadowOptionsObject);
  92334. /**
  92335. * (Highcharts) If true, a checkbox is displayed next to the legend item to
  92336. * allow selecting the series. The state of the checkbox is determined by
  92337. * the `selected` option.
  92338. */
  92339. showCheckbox?: boolean;
  92340. /**
  92341. * (Highcharts) Whether to display this particular series or series type in
  92342. * the legend. Standalone series are shown in legend by default, and linked
  92343. * series are not. Since v7.2.0 it is possible to show series that use
  92344. * colorAxis by setting this option to `true`.
  92345. */
  92346. showInLegend?: boolean;
  92347. /**
  92348. * (Highstock) Whether or not to show the series in the navigator. Takes
  92349. * precedence over navigator.baseSeries if defined.
  92350. */
  92351. showInNavigator?: boolean;
  92352. /**
  92353. * (Highcharts) If set to `true`, the accessibility module will skip past
  92354. * the points in this series for keyboard navigation.
  92355. */
  92356. skipKeyboardNavigation?: boolean;
  92357. /**
  92358. * (Highcharts, Highstock) When this is true, the series will not cause the
  92359. * Y axis to cross the zero plane (or threshold option) unless the data
  92360. * actually crosses the plane.
  92361. *
  92362. * For example, if `softThreshold` is `false`, a series of 0, 1, 2, 3 will
  92363. * make the Y axis show negative values according to the `minPadding`
  92364. * option. If `softThreshold` is `true`, the Y axis starts at 0.
  92365. */
  92366. softThreshold?: boolean;
  92367. /**
  92368. * (Highcharts, Highstock) Whether to stack the values of each series on top
  92369. * of each other. Possible values are `undefined` to disable, `"normal"` to
  92370. * stack by value or `"percent"`.
  92371. *
  92372. * When stacking is enabled, data must be sorted in ascending X order.
  92373. *
  92374. * Some stacking options are related to specific series types. In the
  92375. * streamgraph series type, the stacking option is set to `"stream"`. The
  92376. * second one is `"overlap"`, which only applies to waterfall series.
  92377. */
  92378. stacking?: OptionsStackingValue;
  92379. states?: SeriesStatesOptionsObject;
  92380. /**
  92381. * (Highcharts) Sticky tracking of mouse events. When true, the `mouseOut`
  92382. * event on a series isn't triggered until the mouse moves over another
  92383. * series, or out of the plot area. When false, the `mouseOut` event on a
  92384. * series is triggered when the mouse leaves the area around the series'
  92385. * graph or markers. This also implies the tooltip when not shared. When
  92386. * `stickyTracking` is false and `tooltip.shared` is false, the tooltip will
  92387. * be hidden when moving the mouse between series. Defaults to true for line
  92388. * and area type series, but to false for columns, pies etc.
  92389. *
  92390. * **Note:** The boost module will force this option because of technical
  92391. * limitations.
  92392. */
  92393. stickyTracking?: boolean;
  92394. /**
  92395. * (Highcharts) The Y axis value to serve as the base for the columns, for
  92396. * distinguishing between values above and below a threshold. If `null`, the
  92397. * columns extend from the padding Y axis minimum.
  92398. */
  92399. threshold?: (number|null);
  92400. /**
  92401. * (Highcharts) A configuration object for the tooltip rendering of each
  92402. * single series. Properties are inherited from tooltip, but only the
  92403. * following properties can be defined on a series level.
  92404. */
  92405. tooltip?: SeriesTooltipOptionsObject;
  92406. /**
  92407. * (Highcharts, Highstock, Gantt) When a series contains a data array that
  92408. * is longer than this, only one dimensional arrays of numbers, or two
  92409. * dimensional arrays with x and y values are allowed. Also, only the first
  92410. * point is tested, and the rest are assumed to be the same format. This
  92411. * saves expensive data checking and indexing in long series. Set it to `0`
  92412. * disable.
  92413. *
  92414. * Note: In boost mode turbo threshold is forced. Only array of numbers or
  92415. * two dimensional arrays are allowed.
  92416. */
  92417. turboThreshold?: number;
  92418. /**
  92419. * (Highcharts) Set the initial visibility of the series.
  92420. */
  92421. visible?: boolean;
  92422. /**
  92423. * (Highmaps) Define the z index of the series.
  92424. */
  92425. zIndex?: number;
  92426. /**
  92427. * (Highcharts, Highstock) Defines the Axis on which the zones are applied.
  92428. */
  92429. zoneAxis?: string;
  92430. /**
  92431. * (Highcharts, Highstock) An array defining zones within a series. Zones
  92432. * can be applied to the X axis, Y axis or Z axis for bubbles, according to
  92433. * the `zoneAxis` option. The zone definitions have to be in ascending order
  92434. * regarding to the value.
  92435. *
  92436. * In styled mode, the color zones are styled with the
  92437. * `.highcharts-zone-{n}` class, or custom classed from the `className`
  92438. * option (view live demo).
  92439. */
  92440. zones?: Array<SeriesZonesOptionsObject>;
  92441. }
  92442. /**
  92443. * (Highstock) Enable or disable the initial animation when a series is
  92444. * displayed. The animation can also be set as a configuration object. Please
  92445. * note that this option only applies to the initial animation of the series
  92446. * itself. For other animations, see chart.animation and the animation parameter
  92447. * under the API methods. The following properties are supported:
  92448. *
  92449. * - `defer`: The animation delay time in milliseconds.
  92450. *
  92451. * - `duration`: The duration of the animation in milliseconds.
  92452. *
  92453. * - `easing`: Can be a string reference to an easing function set on the `Math`
  92454. * object or a function. See the _Custom easing function_ demo below.
  92455. *
  92456. * Due to poor performance, animation is disabled in old IE browsers for several
  92457. * chart types.
  92458. */
  92459. export interface PlotVbpAnimationOptions {
  92460. defer?: number;
  92461. }
  92462. /**
  92463. * (Highcharts, Highstock, Highmaps, Gantt) Enable or disable the initial
  92464. * animation when a series is displayed for the `dataLabels`. The animation can
  92465. * also be set as a configuration object. Please note that this option only
  92466. * applies to the initial animation. For other animations, see chart.animation
  92467. * and the animation parameter under the API methods. The following properties
  92468. * are supported:
  92469. *
  92470. * - `defer`: The animation delay time in milliseconds.
  92471. */
  92472. export interface PlotVbpDataLabelsAnimationOptions {
  92473. /**
  92474. * (Highcharts, Highstock, Highmaps, Gantt) The animation delay time in
  92475. * milliseconds. Set to `0` renders dataLabel immediately. As `undefined`
  92476. * inherits defer time from the series.animation.defer.
  92477. */
  92478. defer?: number;
  92479. }
  92480. /**
  92481. * (Highcharts, Highstock, Highmaps, Gantt) Options for the series data labels,
  92482. * appearing next to each data point.
  92483. *
  92484. * Since v6.2.0, multiple data labels can be applied to each single point by
  92485. * defining them as an array of configs.
  92486. *
  92487. * In styled mode, the data labels can be styled with the
  92488. * `.highcharts-data-label-box` and `.highcharts-data-label` class names (see
  92489. * example).
  92490. */
  92491. export interface PlotVbpDataLabelsOptions {
  92492. /**
  92493. * (Highcharts, Highstock, Highmaps, Gantt) The alignment of the data label
  92494. * compared to the point. If `right`, the right side of the label should be
  92495. * touching the point. For points with an extent, like columns, the
  92496. * alignments also dictates how to align it inside the box, as given with
  92497. * the inside option. Can be one of `left`, `center` or `right`.
  92498. */
  92499. align?: (AlignValue|null);
  92500. /**
  92501. * (Highcharts, Highstock, Highmaps, Gantt) Whether to allow data labels to
  92502. * overlap. To make the labels less sensitive for overlapping, the
  92503. * dataLabels.padding can be set to 0.
  92504. */
  92505. allowOverlap?: boolean;
  92506. /**
  92507. * (Highcharts, Highstock, Highmaps, Gantt) Enable or disable the initial
  92508. * animation when a series is displayed for the `dataLabels`. The animation
  92509. * can also be set as a configuration object. Please note that this option
  92510. * only applies to the initial animation. For other animations, see
  92511. * chart.animation and the animation parameter under the API methods. The
  92512. * following properties are supported:
  92513. *
  92514. * - `defer`: The animation delay time in milliseconds.
  92515. */
  92516. animation?: (boolean|PlotVbpDataLabelsAnimationOptions|Partial<AnimationOptionsObject>);
  92517. /**
  92518. * (Highcharts, Highstock, Highmaps, Gantt) The background color or gradient
  92519. * for the data label.
  92520. */
  92521. backgroundColor?: (ColorString|GradientColorObject|PatternObject);
  92522. /**
  92523. * (Highcharts, Highstock, Highmaps, Gantt) The border color for the data
  92524. * label. Defaults to `undefined`.
  92525. */
  92526. borderColor?: (ColorString|GradientColorObject|PatternObject);
  92527. /**
  92528. * (Highcharts, Highstock, Highmaps, Gantt) The border radius in pixels for
  92529. * the data label.
  92530. */
  92531. borderRadius?: number;
  92532. /**
  92533. * (Highcharts, Highstock, Highmaps, Gantt) The border width in pixels for
  92534. * the data label.
  92535. */
  92536. borderWidth?: number;
  92537. /**
  92538. * (Highcharts, Highstock, Highmaps, Gantt) A class name for the data label.
  92539. * Particularly in styled mode, this can be used to give each series' or
  92540. * point's data label unique styling. In addition to this option, a default
  92541. * color class name is added so that we can give the labels a contrast text
  92542. * shadow.
  92543. */
  92544. className?: string;
  92545. /**
  92546. * (Highcharts, Highstock, Highmaps, Gantt) The text color for the data
  92547. * labels. Defaults to `undefined`. For certain series types, like column or
  92548. * map, the data labels can be drawn inside the points. In this case the
  92549. * data label will be drawn with maximum contrast by default. Additionally,
  92550. * it will be given a `text-outline` style with the opposite color, to
  92551. * further increase the contrast. This can be overridden by setting the
  92552. * `text-outline` style to `none` in the `dataLabels.style` option.
  92553. */
  92554. color?: (ColorString|GradientColorObject|PatternObject);
  92555. /**
  92556. * (Highcharts, Highstock, Highmaps, Gantt) Whether to hide data labels that
  92557. * are outside the plot area. By default, the data label is moved inside the
  92558. * plot area according to the overflow option.
  92559. */
  92560. crop?: boolean;
  92561. /**
  92562. * (Highcharts, Highstock, Gantt) Whether to defer displaying the data
  92563. * labels until the initial series animation has finished. Setting to
  92564. * `false` renders the data label immediately. If set to `true` inherits the
  92565. * defer time set in plotOptions.series.animation.
  92566. */
  92567. defer?: boolean;
  92568. /**
  92569. * (Highcharts, Highstock, Highmaps, Gantt) Enable or disable the data
  92570. * labels.
  92571. */
  92572. enabled?: boolean;
  92573. /**
  92574. * (Highcharts, Highstock, Highmaps, Gantt) A declarative filter to control
  92575. * of which data labels to display. The declarative filter is designed for
  92576. * use when callback functions are not available, like when the chart
  92577. * options require a pure JSON structure or for use with graphical editors.
  92578. * For programmatic control, use the `formatter` instead, and return
  92579. * `undefined` to disable a single data label.
  92580. */
  92581. filter?: DataLabelsFilterOptionsObject;
  92582. /**
  92583. * (Highcharts, Highstock, Highmaps, Gantt) A format string for the data
  92584. * label. Available variables are the same as for `formatter`.
  92585. */
  92586. format?: string;
  92587. /**
  92588. * (Highcharts, Highstock, Highmaps, Gantt) Callback JavaScript function to
  92589. * format the data label. Note that if a `format` is defined, the format
  92590. * takes precedence and the formatter is ignored.
  92591. */
  92592. formatter?: DataLabelsFormatterCallbackFunction;
  92593. /**
  92594. * (Highcharts, Highstock, Highmaps, Gantt) For points with an extent, like
  92595. * columns or map areas, whether to align the data label inside the box or
  92596. * to the actual value point. Defaults to `false` in most cases, `true` in
  92597. * stacked columns.
  92598. */
  92599. inside?: boolean;
  92600. /**
  92601. * (Highcharts, Highstock, Highmaps, Gantt) Format for points with the value
  92602. * of null. Works analogously to format. `nullFormat` can be applied only to
  92603. * series which support displaying null points.
  92604. */
  92605. nullFormat?: (boolean|string);
  92606. /**
  92607. * (Highcharts, Highstock, Highmaps, Gantt) Callback JavaScript function
  92608. * that defines formatting for points with the value of null. Works
  92609. * analogously to formatter. `nullPointFormatter` can be applied only to
  92610. * series which support displaying null points.
  92611. */
  92612. nullFormatter?: DataLabelsFormatterCallbackFunction;
  92613. /**
  92614. * (Highcharts, Highstock, Highmaps, Gantt) How to handle data labels that
  92615. * flow outside the plot area. The default is `"justify"`, which aligns them
  92616. * inside the plot area. For columns and bars, this means it will be moved
  92617. * inside the bar. To display data labels outside the plot area, set `crop`
  92618. * to `false` and `overflow` to `"allow"`.
  92619. */
  92620. overflow?: DataLabelsOverflowValue;
  92621. /**
  92622. * (Highcharts, Highstock, Highmaps, Gantt) When either the `borderWidth` or
  92623. * the `backgroundColor` is set, this is the padding within the box.
  92624. */
  92625. padding?: number;
  92626. /**
  92627. * (Highcharts, Highstock, Highmaps, Gantt) Aligns data labels relative to
  92628. * points. If `center` alignment is not possible, it defaults to `right`.
  92629. */
  92630. position?: AlignValue;
  92631. /**
  92632. * (Highcharts, Highstock, Highmaps, Gantt) Text rotation in degrees. Note
  92633. * that due to a more complex structure, backgrounds, borders and padding
  92634. * will be lost on a rotated data label.
  92635. */
  92636. rotation?: number;
  92637. /**
  92638. * (Highcharts, Highstock, Highmaps, Gantt) The shadow of the box. Works
  92639. * best with `borderWidth` or `backgroundColor`. Since 2.3 the shadow can be
  92640. * an object configuration containing `color`, `offsetX`, `offsetY`,
  92641. * `opacity` and `width`.
  92642. */
  92643. shadow?: (boolean|ShadowOptionsObject);
  92644. /**
  92645. * (Highcharts, Highstock, Highmaps, Gantt) The name of a symbol to use for
  92646. * the border around the label. Symbols are predefined functions on the
  92647. * Renderer object.
  92648. */
  92649. shape?: string;
  92650. /**
  92651. * (Highcharts, Highstock, Highmaps, Gantt) Styles for the label. The
  92652. * default `color` setting is `"contrast"`, which is a pseudo color that
  92653. * Highcharts picks up and applies the maximum contrast to the underlying
  92654. * point item, for example the bar in a bar chart.
  92655. *
  92656. * The `textOutline` is a pseudo property that applies an outline of the
  92657. * given width with the given color, which by default is the maximum
  92658. * contrast to the text. So a bright text color will result in a black text
  92659. * outline for maximum readability on a mixed background. In some cases,
  92660. * especially with grayscale text, the text outline doesn't work well, in
  92661. * which cases it can be disabled by setting it to `"none"`. When `useHTML`
  92662. * is true, the `textOutline` will not be picked up. In this, case, the same
  92663. * effect can be acheived through the `text-shadow` CSS property.
  92664. *
  92665. * For some series types, where each point has an extent, like for example
  92666. * tree maps, the data label may overflow the point. There are two
  92667. * strategies for handling overflow. By default, the text will wrap to
  92668. * multiple lines. The other strategy is to set `style.textOverflow` to
  92669. * `ellipsis`, which will keep the text on one line plus it will break
  92670. * inside long words.
  92671. */
  92672. style?: CSSObject;
  92673. /**
  92674. * (Highcharts, Highstock, Highmaps, Gantt) Options for a label text which
  92675. * should follow marker's shape. Border and background are disabled for a
  92676. * label that follows a path.
  92677. *
  92678. * **Note:** Only SVG-based renderer supports this option. Setting `useHTML`
  92679. * to true will disable this option.
  92680. */
  92681. textPath?: DataLabelsTextPathOptionsObject;
  92682. /**
  92683. * (Highcharts, Highstock, Highmaps, Gantt) Whether to use HTML to render
  92684. * the labels.
  92685. */
  92686. useHTML?: boolean;
  92687. /**
  92688. * (Highcharts, Highstock, Highmaps, Gantt) The vertical alignment of a data
  92689. * label. Can be one of `top`, `middle` or `bottom`. The default value
  92690. * depends on the data, for instance in a column chart, the label is above
  92691. * positive values and below negative values.
  92692. */
  92693. verticalAlign?: string;
  92694. /**
  92695. * (Highcharts, Highstock, Highmaps, Gantt) The x position offset of the
  92696. * label relative to the point in pixels.
  92697. */
  92698. x?: number;
  92699. /**
  92700. * (Highcharts, Highstock, Highmaps, Gantt) The y position offset of the
  92701. * label relative to the point in pixels.
  92702. */
  92703. y?: number;
  92704. /**
  92705. * (Highcharts, Highstock, Highmaps, Gantt) The Z index of the data labels.
  92706. * The default Z index puts it above the series. Use a Z index of 2 to
  92707. * display it behind the series.
  92708. */
  92709. z?: number;
  92710. }
  92711. /**
  92712. * (Highcharts, Highstock) Options for the series data sorting.
  92713. */
  92714. export interface PlotVbpDataSortingOptions {
  92715. /**
  92716. * (Highcharts, Highstock) Enable or disable data sorting for the series.
  92717. * Use xAxis.reversed to change the sorting order.
  92718. */
  92719. enabled?: boolean;
  92720. /**
  92721. * (Highcharts, Highstock) Whether to allow matching points by name in an
  92722. * update. If this option is disabled, points will be matched by order.
  92723. */
  92724. matchByName?: boolean;
  92725. /**
  92726. * (Highcharts, Highstock) Determines what data value should be used to sort
  92727. * by.
  92728. */
  92729. sortKey?: string;
  92730. }
  92731. /**
  92732. * (Highstock) Volume By Price indicator.
  92733. *
  92734. * This series requires `linkedTo` option to be set.
  92735. *
  92736. * In TypeScript the type option must always be set.
  92737. *
  92738. * Configuration options for the series are given in three levels:
  92739. *
  92740. * 1. Options for all series in a chart are defined in the plotOptions.series
  92741. * object.
  92742. *
  92743. * 2. Options for all `vbp` series are defined in plotOptions.vbp.
  92744. *
  92745. * 3. Options for one single series are given in the series instance array. (see
  92746. * online documentation for example)
  92747. */
  92748. export interface PlotVbpOptions {
  92749. /**
  92750. * (Highstock) Accessibility options for a series.
  92751. */
  92752. accessibility?: SeriesAccessibilityOptionsObject;
  92753. /**
  92754. * (Highstock) Allow this series' points to be selected by clicking on the
  92755. * graphic (columns, point markers, pie slices, map areas etc).
  92756. *
  92757. * The selected points can be handled by point select and unselect events,
  92758. * or collectively by the getSelectedPoints function.
  92759. *
  92760. * And alternative way of selecting points is through dragging.
  92761. */
  92762. allowPointSelect?: boolean;
  92763. /**
  92764. * (Highstock) Enable or disable the initial animation when a series is
  92765. * displayed. The animation can also be set as a configuration object.
  92766. * Please note that this option only applies to the initial animation of the
  92767. * series itself. For other animations, see chart.animation and the
  92768. * animation parameter under the API methods. The following properties are
  92769. * supported:
  92770. *
  92771. * - `defer`: The animation delay time in milliseconds.
  92772. *
  92773. * - `duration`: The duration of the animation in milliseconds.
  92774. *
  92775. * - `easing`: Can be a string reference to an easing function set on the
  92776. * `Math` object or a function. See the _Custom easing function_ demo below.
  92777. *
  92778. * Due to poor performance, animation is disabled in old IE browsers for
  92779. * several chart types.
  92780. */
  92781. animation?: (boolean|PlotVbpAnimationOptions|Partial<AnimationOptionsObject>);
  92782. /**
  92783. * (Highstock) For some series, there is a limit that shuts down initial
  92784. * animation by default when the total number of points in the chart is too
  92785. * high. For example, for a column chart and its derivatives, animation does
  92786. * not run if there is more than 250 points totally. To disable this cap,
  92787. * set `animationLimit` to `Infinity`.
  92788. */
  92789. animationLimit?: number;
  92790. /**
  92791. * (Highstock) Sets the color blending in the boost module.
  92792. */
  92793. boostBlending?: OptionsBoostBlendingValue;
  92794. /**
  92795. * (Highstock) Set the point threshold for when a series should enter boost
  92796. * mode.
  92797. *
  92798. * Setting it to e.g. 2000 will cause the series to enter boost mode when
  92799. * there are 2000 or more points in the series.
  92800. *
  92801. * To disable boosting on the series, set the `boostThreshold` to 0. Setting
  92802. * it to 1 will force boosting.
  92803. *
  92804. * Note that the cropThreshold also affects this setting. When zooming in on
  92805. * a series that has fewer points than the `cropThreshold`, all points are
  92806. * rendered although outside the visible plot area, and the `boostThreshold`
  92807. * won't take effect.
  92808. */
  92809. boostThreshold?: number;
  92810. /**
  92811. * (Highmaps) The border color of the map areas.
  92812. *
  92813. * In styled mode, the border stroke is given in the `.highcharts-point`
  92814. * class.
  92815. */
  92816. borderColor?: (ColorString|GradientColorObject|PatternObject);
  92817. /**
  92818. * (Highmaps) The border width of each map area.
  92819. *
  92820. * In styled mode, the border stroke width is given in the
  92821. * `.highcharts-point` class.
  92822. */
  92823. borderWidth?: number;
  92824. /**
  92825. * (Highstock) An additional class name to apply to the series' graphical
  92826. * elements. This option does not replace default class names of the
  92827. * graphical element.
  92828. */
  92829. className?: string;
  92830. /**
  92831. * (Highstock) Disable this option to allow series rendering in the whole
  92832. * plotting area.
  92833. *
  92834. * **Note:** Clipping should be always enabled when chart.zoomType is set
  92835. */
  92836. clip?: boolean;
  92837. /**
  92838. * (Highstock) The main color of the series. In line type series it applies
  92839. * to the line and the point markers unless otherwise specified. In bar type
  92840. * series it applies to the bars unless a color is specified per point. The
  92841. * default value is pulled from the `options.colors` array.
  92842. *
  92843. * In styled mode, the color can be defined by the colorIndex option. Also,
  92844. * the series color can be set with the `.highcharts-series`,
  92845. * `.highcharts-color-{n}`, `.highcharts-{type}-series` or
  92846. * `.highcharts-series-{n}` class, or individual classes given by the
  92847. * `className` option.
  92848. */
  92849. color?: (ColorString|GradientColorObject|PatternObject);
  92850. /**
  92851. * (Highstock) Styled mode only. A specific color index to use for the
  92852. * series, so its graphic representations are given the class name
  92853. * `highcharts-color-{n}`.
  92854. */
  92855. colorIndex?: number;
  92856. /**
  92857. * (Highcharts, Highstock, Highmaps) Determines what data value should be
  92858. * used to calculate point color if `colorAxis` is used. Requires to set
  92859. * `min` and `max` if some custom point property is used or if approximation
  92860. * for data grouping is set to `'sum'`.
  92861. */
  92862. colorKey?: string;
  92863. /**
  92864. * (Highstock) Compare the values of the series against the first non-null,
  92865. * non- zero value in the visible range. The y axis will show percentage or
  92866. * absolute change depending on whether `compare` is set to `"percent"` or
  92867. * `"value"`. When this is applied to multiple series, it allows comparing
  92868. * the development of the series against each other. Adds a `change` field
  92869. * to every point object.
  92870. */
  92871. compare?: string;
  92872. /**
  92873. * (Highstock) When compare is `percent`, this option dictates whether to
  92874. * use 0 or 100 as the base of comparison.
  92875. */
  92876. compareBase?: (0|100);
  92877. /**
  92878. * (Highstock) Defines if comparison should start from the first point
  92879. * within the visible range or should start from the first point **before**
  92880. * the range.
  92881. *
  92882. * In other words, this flag determines if first point within the visible
  92883. * range will have 0% (`compareStart=true`) or should have been already
  92884. * calculated according to the previous point (`compareStart=false`).
  92885. */
  92886. compareStart?: boolean;
  92887. /**
  92888. * (Highstock) Whether to compare indicator to the main series values or
  92889. * indicator values.
  92890. */
  92891. compareToMain?: boolean;
  92892. /**
  92893. * (Highcharts) Polar charts only. Whether to connect the ends of a line
  92894. * series plot across the extremes.
  92895. */
  92896. connectEnds?: boolean;
  92897. /**
  92898. * (Highcharts, Highstock) Whether to connect a graph line across null
  92899. * points, or render a gap between the two points on either side of the
  92900. * null.
  92901. */
  92902. connectNulls?: boolean;
  92903. /**
  92904. * (Gantt) Override Pathfinder connector options for a series. Requires
  92905. * Highcharts Gantt to be loaded.
  92906. */
  92907. connectors?: SeriesConnectorsOptionsObject;
  92908. /**
  92909. * (Highcharts, Highstock, Gantt) When true, each point or column edge is
  92910. * rounded to its nearest pixel in order to render sharp on screen. In some
  92911. * cases, when there are a lot of densely packed columns, this leads to
  92912. * visible difference in column widths or distance between columns. In these
  92913. * cases, setting `crisp` to `false` may look better, even though each
  92914. * column is rendered blurry.
  92915. */
  92916. crisp?: boolean;
  92917. /**
  92918. * (Highcharts, Highstock) When the series contains less points than the
  92919. * crop threshold, all points are drawn, even if the points fall outside the
  92920. * visible plot area at the current zoom. The advantage of drawing all
  92921. * points (including markers and columns), is that animation is performed on
  92922. * updates. On the other hand, when the series contains more points than the
  92923. * crop threshold, the series data is cropped to only contain points that
  92924. * fall within the plot area. The advantage of cropping away invisible
  92925. * points is to increase performance on large series.
  92926. */
  92927. cropThreshold?: number;
  92928. /**
  92929. * (Highstock) You can set the cursor to "pointer" if you have click events
  92930. * attached to the series, to signal to the user that the points and lines
  92931. * can be clicked.
  92932. *
  92933. * In styled mode, the series cursor can be set with the same classes as
  92934. * listed under series.color.
  92935. */
  92936. cursor?: (string|CursorValue);
  92937. /**
  92938. * (Highstock) A reserved subspace to store options and values for
  92939. * customized functionality. Here you can add additional data for your own
  92940. * event callbacks and formatter callbacks.
  92941. */
  92942. custom?: Dictionary<any>;
  92943. /**
  92944. * (Highstock) Name of the dash style to use for the graph, or for some
  92945. * series types the outline of each shape.
  92946. *
  92947. * In styled mode, the stroke dash-array can be set with the same classes as
  92948. * listed under series.color.
  92949. */
  92950. dashStyle?: DashStyleValue;
  92951. /**
  92952. * (Highstock) Data grouping is the concept of sampling the data values into
  92953. * larger blocks in order to ease readability and increase performance of
  92954. * the JavaScript charts. Highstock by default applies data grouping when
  92955. * the points become closer than a certain pixel value, determined by the
  92956. * `groupPixelWidth` option.
  92957. *
  92958. * If data grouping is applied, the grouping information of grouped points
  92959. * can be read from the Point.dataGroup. If point options other than the
  92960. * data itself are set, for example `name` or `color` or custom properties,
  92961. * the grouping logic doesn't know how to group it. In this case the options
  92962. * of the first point instance are copied over to the group point. This can
  92963. * be altered through a custom `approximation` callback function.
  92964. */
  92965. dataGrouping?: DataGroupingOptionsObject;
  92966. /**
  92967. * (Highcharts, Highstock, Highmaps, Gantt) Options for the series data
  92968. * labels, appearing next to each data point.
  92969. *
  92970. * Since v6.2.0, multiple data labels can be applied to each single point by
  92971. * defining them as an array of configs.
  92972. *
  92973. * In styled mode, the data labels can be styled with the
  92974. * `.highcharts-data-label-box` and `.highcharts-data-label` class names
  92975. * (see example).
  92976. */
  92977. dataLabels?: (PlotVbpDataLabelsOptions|Array<PlotVbpDataLabelsOptions>);
  92978. /**
  92979. * (Highcharts, Highstock) Options for the series data sorting.
  92980. */
  92981. dataSorting?: (DataSortingOptionsObject|PlotVbpDataSortingOptions);
  92982. /**
  92983. * (Highstock) A description of the series to add to the screen reader
  92984. * information about the series.
  92985. */
  92986. description?: string;
  92987. /**
  92988. * (Highstock) Enable or disable the mouse tracking for a specific series.
  92989. * This includes point tooltips and click events on graphs and points. For
  92990. * large datasets it improves performance.
  92991. */
  92992. enableMouseTracking?: boolean;
  92993. /**
  92994. * (Highstock) General event handlers for the series items. These event
  92995. * hooks can also be attached to the series at run time using the
  92996. * `Highcharts.addEvent` function.
  92997. */
  92998. events?: SeriesEventsOptionsObject;
  92999. /**
  93000. * (Highstock) Determines whether the series should look for the nearest
  93001. * point in both dimensions or just the x-dimension when hovering the
  93002. * series. Defaults to `'xy'` for scatter series and `'x'` for most other
  93003. * series. If the data has duplicate x-values, it is recommended to set this
  93004. * to `'xy'` to allow hovering over all points.
  93005. *
  93006. * Applies only to series types using nearest neighbor search (not direct
  93007. * hover) for tooltip.
  93008. */
  93009. findNearestPointBy?: OptionsFindNearestPointByValue;
  93010. /**
  93011. * (Highstock) Defines when to display a gap in the graph, together with the
  93012. * gapUnit option.
  93013. *
  93014. * In case when `dataGrouping` is enabled, points can be grouped into a
  93015. * larger time span. This can make the grouped points to have a greater
  93016. * distance than the absolute value of `gapSize` property, which will result
  93017. * in disappearing graph completely. To prevent this situation the mentioned
  93018. * distance between grouped points is used instead of previously defined
  93019. * `gapSize`.
  93020. *
  93021. * In practice, this option is most often used to visualize gaps in time
  93022. * series. In a stock chart, intraday data is available for daytime hours,
  93023. * while gaps will appear in nights and weekends.
  93024. */
  93025. gapSize?: number;
  93026. /**
  93027. * (Highstock) Together with gapSize, this option defines where to draw gaps
  93028. * in the graph.
  93029. *
  93030. * When the `gapUnit` is `"relative"` (default), a gap size of 5 means that
  93031. * if the distance between two points is greater than 5 times that of the
  93032. * two closest points, the graph will be broken.
  93033. *
  93034. * When the `gapUnit` is `"value"`, the gap is based on absolute axis
  93035. * values, which on a datetime axis is milliseconds. This also applies to
  93036. * the navigator series that inherits gap options from the base series.
  93037. */
  93038. gapUnit?: OptionsGapUnitValue;
  93039. /**
  93040. * (Highcharts, Highstock, Gantt) Whether to use the Y extremes of the total
  93041. * chart width or only the zoomed area when zooming in on parts of the X
  93042. * axis. By default, the Y axis adjusts to the min and max of the visible
  93043. * data. Cartesian series only.
  93044. */
  93045. getExtremesFromAll?: boolean;
  93046. /**
  93047. * (Highstock) When set to `false` will prevent the series data from being
  93048. * included in any form of data export.
  93049. *
  93050. * Since version 6.0.0 until 7.1.0 the option was existing undocumented as
  93051. * `includeInCSVExport`.
  93052. */
  93053. includeInDataExport?: boolean;
  93054. /**
  93055. * (Highcharts, Highstock, Gantt) Series labels are placed as close to the
  93056. * series as possible in a natural way, seeking to avoid other series. The
  93057. * goal of this feature is to make the chart more easily readable, like if a
  93058. * human designer placed the labels in the optimal position.
  93059. *
  93060. * The series labels currently work with series types having a `graph` or an
  93061. * `area`.
  93062. */
  93063. label?: SeriesLabelOptionsObject;
  93064. /**
  93065. * (Highstock) The line marks the last price from all points.
  93066. */
  93067. lastPrice?: SeriesLastPriceOptionsObject;
  93068. /**
  93069. * (Highstock) The line marks the last price from visible range of points.
  93070. */
  93071. lastVisiblePrice?: SeriesLastVisiblePriceOptionsObject;
  93072. /**
  93073. * (Highcharts, Highstock) The SVG value used for the `stroke-linecap` and
  93074. * `stroke-linejoin` of a line graph. Round means that lines are rounded in
  93075. * the ends and bends.
  93076. */
  93077. linecap?: SeriesLinecapValue;
  93078. /**
  93079. * (Highcharts, Highstock) Pixel width of the graph line.
  93080. */
  93081. lineWidth?: number;
  93082. /**
  93083. * (Highcharts, Highstock, Gantt) The main series ID that indicator will be
  93084. * based on. Required for this indicator.
  93085. */
  93086. linkedTo?: string;
  93087. /**
  93088. * (Highstock) Options for the point markers of line-like series. Properties
  93089. * like `fillColor`, `lineColor` and `lineWidth` define the visual
  93090. * appearance of the markers. Other series types, like column series, don't
  93091. * have markers, but have visual options on the series level instead.
  93092. *
  93093. * In styled mode, the markers can be styled with the `.highcharts-point`,
  93094. * `.highcharts-point-hover` and `.highcharts-point-select` class names.
  93095. */
  93096. marker?: PointMarkerOptionsObject;
  93097. /**
  93098. * (Highstock) The name of the series as shown in the legend, tooltip etc.
  93099. * If not set, it will be based on a technical indicator type and default
  93100. * params.
  93101. */
  93102. name?: string;
  93103. /**
  93104. * (Highstock) The color for the parts of the graph or points that are below
  93105. * the threshold. Note that `zones` takes precedence over the negative
  93106. * color. Using `negativeColor` is equivalent to applying a zone with value
  93107. * of 0.
  93108. */
  93109. negativeColor?: (ColorString|GradientColorObject|PatternObject);
  93110. /**
  93111. * (Highstock) Opacity of a series parts: line, fill (e.g. area) and
  93112. * dataLabels.
  93113. */
  93114. opacity?: number;
  93115. /**
  93116. * (Highstock) Paramters used in calculation of regression series' points.
  93117. */
  93118. params?: PlotVbpParamsOptions;
  93119. /**
  93120. * (Highstock) Properties for each single point.
  93121. */
  93122. point?: PlotSeriesPointOptions;
  93123. /**
  93124. * (Highstock) Same as accessibility.pointDescriptionFormatter, but for an
  93125. * individual series. Overrides the chart wide configuration.
  93126. */
  93127. pointDescriptionFormatter?: Function;
  93128. pointPadding?: number;
  93129. /**
  93130. * (Highstock) Whether to select the series initially. If `showCheckbox` is
  93131. * true, the checkbox next to the series name in the legend will be checked
  93132. * for a selected series.
  93133. */
  93134. selected?: boolean;
  93135. /**
  93136. * (Highstock) Whether to apply a drop shadow to the graph line. Since 2.3
  93137. * the shadow can be an object configuration containing `color`, `offsetX`,
  93138. * `offsetY`, `opacity` and `width`.
  93139. */
  93140. shadow?: (boolean|ShadowOptionsObject);
  93141. /**
  93142. * (Highstock) If true, a checkbox is displayed next to the legend item to
  93143. * allow selecting the series. The state of the checkbox is determined by
  93144. * the `selected` option.
  93145. */
  93146. showCheckbox?: boolean;
  93147. /**
  93148. * (Highstock) Whether to display this particular series or series type in
  93149. * the legend. Standalone series are shown in legend by default, and linked
  93150. * series are not. Since v7.2.0 it is possible to show series that use
  93151. * colorAxis by setting this option to `true`.
  93152. */
  93153. showInLegend?: boolean;
  93154. /**
  93155. * (Highstock) If set to `true`, the accessibility module will skip past the
  93156. * points in this series for keyboard navigation.
  93157. */
  93158. skipKeyboardNavigation?: boolean;
  93159. /**
  93160. * (Highcharts, Highstock) When this is true, the series will not cause the
  93161. * Y axis to cross the zero plane (or threshold option) unless the data
  93162. * actually crosses the plane.
  93163. *
  93164. * For example, if `softThreshold` is `false`, a series of 0, 1, 2, 3 will
  93165. * make the Y axis show negative values according to the `minPadding`
  93166. * option. If `softThreshold` is `true`, the Y axis starts at 0.
  93167. */
  93168. softThreshold?: boolean;
  93169. states?: SeriesStatesOptionsObject;
  93170. /**
  93171. * (Highcharts, Highstock) Whether to apply steps to the line. Possible
  93172. * values are `left`, `center` and `right`.
  93173. */
  93174. step?: OptionsStepValue;
  93175. /**
  93176. * (Highstock) Sticky tracking of mouse events. When true, the `mouseOut`
  93177. * event on a series isn't triggered until the mouse moves over another
  93178. * series, or out of the plot area. When false, the `mouseOut` event on a
  93179. * series is triggered when the mouse leaves the area around the series'
  93180. * graph or markers. This also implies the tooltip when not shared. When
  93181. * `stickyTracking` is false and `tooltip.shared` is false, the tooltip will
  93182. * be hidden when moving the mouse between series. Defaults to true for line
  93183. * and area type series, but to false for columns, pies etc.
  93184. *
  93185. * **Note:** The boost module will force this option because of technical
  93186. * limitations.
  93187. */
  93188. stickyTracking?: boolean;
  93189. /**
  93190. * (Highcharts, Highstock) The threshold, also called zero level or base
  93191. * level. For line type series this is only used in conjunction with
  93192. * negativeColor.
  93193. */
  93194. threshold?: (number|null);
  93195. /**
  93196. * (Highstock) A configuration object for the tooltip rendering of each
  93197. * single series. Properties are inherited from tooltip, but only the
  93198. * following properties can be defined on a series level.
  93199. */
  93200. tooltip?: SeriesTooltipOptionsObject;
  93201. /**
  93202. * (Highcharts, Highstock, Gantt) When a series contains a data array that
  93203. * is longer than this, only one dimensional arrays of numbers, or two
  93204. * dimensional arrays with x and y values are allowed. Also, only the first
  93205. * point is tested, and the rest are assumed to be the same format. This
  93206. * saves expensive data checking and indexing in long series. Set it to `0`
  93207. * disable.
  93208. *
  93209. * Note: In boost mode turbo threshold is forced. Only array of numbers or
  93210. * two dimensional arrays are allowed.
  93211. */
  93212. turboThreshold?: number;
  93213. /**
  93214. * (Highstock) Set the initial visibility of the series.
  93215. */
  93216. visible?: boolean;
  93217. /**
  93218. * (Highstock) The styles for bars when volume is divided into
  93219. * positive/negative.
  93220. */
  93221. volumeDivision?: PlotVbpVolumeDivisionOptions;
  93222. /**
  93223. * (Highmaps) Define the z index of the series.
  93224. */
  93225. zIndex?: number;
  93226. /**
  93227. * (Highcharts, Highstock) Defines the Axis on which the zones are applied.
  93228. */
  93229. zoneAxis?: string;
  93230. /**
  93231. * (Highstock) The styles for lines which determine price zones.
  93232. */
  93233. zoneLines?: PlotVbpZoneLinesOptions;
  93234. /**
  93235. * (Highcharts, Highstock) An array defining zones within a series. Zones
  93236. * can be applied to the X axis, Y axis or Z axis for bubbles, according to
  93237. * the `zoneAxis` option. The zone definitions have to be in ascending order
  93238. * regarding to the value.
  93239. *
  93240. * In styled mode, the color zones are styled with the
  93241. * `.highcharts-zone-{n}` class, or custom classed from the `className`
  93242. * option (view live demo).
  93243. */
  93244. zones?: Array<SeriesZonesOptionsObject>;
  93245. }
  93246. /**
  93247. * (Highstock) Paramters used in calculation of regression series' points.
  93248. */
  93249. export interface PlotVbpParamsOptions {
  93250. /**
  93251. * (Highstock) The number of price zones.
  93252. */
  93253. ranges?: number;
  93254. /**
  93255. * (Highstock) The id of volume series which is mandatory. For example using
  93256. * OHLC data, volumeSeriesID='volume' means the indicator will be calculated
  93257. * using OHLC and volume values.
  93258. */
  93259. volumeSeriesID?: string;
  93260. }
  93261. /**
  93262. * (Highstock) The styles for bars when volume is divided into
  93263. * positive/negative.
  93264. */
  93265. export interface PlotVbpVolumeDivisionOptions {
  93266. /**
  93267. * (Highstock) Option to control if volume is divided.
  93268. */
  93269. enabled?: boolean;
  93270. styles?: PlotVbpVolumeDivisionStylesOptions;
  93271. }
  93272. export interface PlotVbpVolumeDivisionStylesOptions {
  93273. /**
  93274. * (Highstock) Color of negative volume bars.
  93275. */
  93276. negativeColor?: ColorString;
  93277. /**
  93278. * (Highstock) Color of positive volume bars.
  93279. */
  93280. positiveColor?: ColorString;
  93281. }
  93282. /**
  93283. * (Highstock) The styles for lines which determine price zones.
  93284. */
  93285. export interface PlotVbpZoneLinesOptions {
  93286. /**
  93287. * (Highstock) Enable/disable zone lines.
  93288. */
  93289. enabled?: boolean;
  93290. /**
  93291. * (Highstock) Specify the style of zone lines.
  93292. */
  93293. styles?: CSSObject;
  93294. }
  93295. /**
  93296. * (Highcharts, Highstock) Enable or disable the initial animation when a series
  93297. * is displayed. The animation can also be set as a configuration object. Please
  93298. * note that this option only applies to the initial animation of the series
  93299. * itself. For other animations, see chart.animation and the animation parameter
  93300. * under the API methods. The following properties are supported:
  93301. *
  93302. * - `defer`: The animation delay time in milliseconds.
  93303. *
  93304. * - `duration`: The duration of the animation in milliseconds.
  93305. *
  93306. * - `easing`: Can be a string reference to an easing function set on the `Math`
  93307. * object or a function. See the _Custom easing function_ demo below.
  93308. *
  93309. * Due to poor performance, animation is disabled in old IE browsers for several
  93310. * chart types.
  93311. */
  93312. export interface PlotVectorAnimationOptions {
  93313. defer?: number;
  93314. }
  93315. export interface PlotVectorClusterEventsOptions {
  93316. /**
  93317. * (Highcharts, Highmaps) Fires when the cluster point is clicked and
  93318. * `drillToCluster` is enabled. One parameter, `event`, is passed to the
  93319. * function. The default action is to zoom to the cluster points range. This
  93320. * can be prevented by calling `event.preventDefault()`.
  93321. */
  93322. drillToCluster?: MarkerClusterDrillCallbackFunction;
  93323. }
  93324. /**
  93325. * (Highcharts, Highmaps) Options for layout algorithm. Inside there are options
  93326. * to change the type of the algorithm, gridSize, distance or iterations.
  93327. */
  93328. export interface PlotVectorClusterLayoutAlgorithmOptions {
  93329. /**
  93330. * (Highcharts, Highmaps) When `type` is set to `kmeans`, `distance` is a
  93331. * maximum distance between point and cluster center so that this point will
  93332. * be inside the cluster. The distance is either a number defining pixels or
  93333. * a percentage defining a percentage of the plot area width.
  93334. */
  93335. distance?: (number|string);
  93336. /**
  93337. * (Highcharts, Highmaps) When `type` is set to the `grid`, `gridSize` is a
  93338. * size of a grid square element either as a number defining pixels, or a
  93339. * percentage defining a percentage of the plot area width.
  93340. */
  93341. gridSize?: (number|string);
  93342. /**
  93343. * (Highcharts, Highmaps) When `type` is set to `kmeans`, `iterations` are
  93344. * the number of iterations that this algorithm will be repeated to find
  93345. * clusters positions.
  93346. */
  93347. iterations?: number;
  93348. /**
  93349. * (Highcharts, Highmaps) When `type` is set to `undefined` and there are
  93350. * more visible points than the kmeansThreshold the `grid` algorithm is used
  93351. * to find clusters, otherwise `kmeans`. It ensures good performance on
  93352. * large datasets and better clusters arrangement after the zoom.
  93353. */
  93354. kmeansThreshold?: number;
  93355. /**
  93356. * (Highcharts, Highmaps) Type of the algorithm used to combine points into
  93357. * a cluster. There are three available algorithms:
  93358. *
  93359. * 1) `grid` - grid-based clustering technique. Points are assigned to
  93360. * squares of set size depending on their position on the plot area. Points
  93361. * inside the grid square are combined into a cluster. The grid size can be
  93362. * controlled by `gridSize` property (grid size changes at certain zoom
  93363. * levels).
  93364. *
  93365. * 2) `kmeans` - based on K-Means clustering technique. In the first step,
  93366. * points are divided using the grid method (distance property is a grid
  93367. * size) to find the initial amount of clusters. Next, each point is
  93368. * classified by computing the distance between each cluster center and that
  93369. * point. When the closest cluster distance is lower than distance property
  93370. * set by a user the point is added to this cluster otherwise is classified
  93371. * as `noise`. The algorithm is repeated until each cluster center not
  93372. * change its previous position more than one pixel. This technique is more
  93373. * accurate but also more time consuming than the `grid` algorithm,
  93374. * especially for big datasets.
  93375. *
  93376. * 3) `optimizedKmeans` - based on K-Means clustering technique. This
  93377. * algorithm uses k-means algorithm only on the chart initialization or when
  93378. * chart extremes have greater range than on initialization. When a chart is
  93379. * redrawn the algorithm checks only clustered points distance from the
  93380. * cluster center and rebuild it when the point is spaced enough to be
  93381. * outside the cluster. It provides performance improvement and more stable
  93382. * clusters position yet can be used rather on small and sparse datasets.
  93383. *
  93384. * By default, the algorithm depends on visible quantity of points and
  93385. * `kmeansThreshold`. When there are more visible points than the
  93386. * `kmeansThreshold` the `grid` algorithm is used, otherwise `kmeans`.
  93387. *
  93388. * The custom clustering algorithm can be added by assigning a callback
  93389. * function as the type property. This function takes an array of
  93390. * `processedXData`, `processedYData`, `processedXData` indexes and
  93391. * `layoutAlgorithm` options as arguments and should return an object with
  93392. * grouped data.
  93393. *
  93394. * The algorithm should return an object like that: (see online
  93395. * documentation for example)
  93396. *
  93397. * `clusterId` (example above - unique id of a cluster or noise) is an array
  93398. * of points belonging to a cluster. If the array has only one point or
  93399. * fewer points than set in `cluster.minimumClusterSize` it won't be
  93400. * combined into a cluster.
  93401. */
  93402. type?: (string|Function);
  93403. }
  93404. /**
  93405. * (Highcharts, Highmaps) Options for marker clusters, the concept of sampling
  93406. * the data values into larger blocks in order to ease readability and increase
  93407. * performance of the JavaScript charts.
  93408. *
  93409. * Note: marker clusters module is not working with `boost` and
  93410. * `draggable-points` modules.
  93411. *
  93412. * The marker clusters feature requires the marker-clusters.js file to be
  93413. * loaded, found in the modules directory of the download package, or online at
  93414. * code.highcharts.com/modules/marker-clusters.js.
  93415. */
  93416. export interface PlotVectorClusterOptions {
  93417. /**
  93418. * (Highcharts, Highmaps) When set to `false` prevent cluster overlapping -
  93419. * this option works only when `layoutAlgorithm.type = "grid"`.
  93420. */
  93421. allowOverlap?: boolean;
  93422. /**
  93423. * (Highcharts, Highmaps) Options for the cluster marker animation.
  93424. */
  93425. animation?: (boolean|Partial<AnimationOptionsObject>);
  93426. /**
  93427. * (Highcharts, Highmaps) Options for the cluster data labels.
  93428. */
  93429. dataLabels?: DataLabelsOptions;
  93430. /**
  93431. * (Highcharts, Highmaps) Zoom the plot area to the cluster points range
  93432. * when a cluster is clicked.
  93433. */
  93434. drillToCluster?: boolean;
  93435. /**
  93436. * (Highcharts, Highmaps) Whether to enable the marker-clusters module.
  93437. */
  93438. enabled?: boolean;
  93439. events?: PlotVectorClusterEventsOptions;
  93440. /**
  93441. * (Highcharts, Highmaps) Options for layout algorithm. Inside there are
  93442. * options to change the type of the algorithm, gridSize, distance or
  93443. * iterations.
  93444. */
  93445. layoutAlgorithm?: PlotVectorClusterLayoutAlgorithmOptions;
  93446. /**
  93447. * (Highcharts, Highmaps) Options for the cluster marker.
  93448. */
  93449. marker?: PointMarkerOptionsObject;
  93450. /**
  93451. * (Highcharts, Highmaps) The minimum amount of points to be combined into a
  93452. * cluster. This value has to be greater or equal to 2.
  93453. */
  93454. minimumClusterSize?: number;
  93455. states?: PlotVectorClusterStatesOptions;
  93456. /**
  93457. * (Highcharts, Highmaps) An array defining zones within marker clusters.
  93458. *
  93459. * In styled mode, the color zones are styled with the
  93460. * `.highcharts-cluster-zone-{n}` class, or custom classed from the
  93461. * `className` option.
  93462. */
  93463. zones?: Array<PlotVectorClusterZonesOptions>;
  93464. }
  93465. export interface PlotVectorClusterStatesHoverOptions {
  93466. /**
  93467. * (Highcharts, Highmaps) The fill color of the cluster marker in hover
  93468. * state. When `undefined`, the series' or point's fillColor for normal
  93469. * state is used.
  93470. */
  93471. fillColor?: ColorType;
  93472. }
  93473. export interface PlotVectorClusterStatesOptions {
  93474. hover?: PlotVectorClusterStatesHoverOptions;
  93475. }
  93476. /**
  93477. * (Highcharts, Highmaps) An array defining zones within marker clusters.
  93478. *
  93479. * In styled mode, the color zones are styled with the
  93480. * `.highcharts-cluster-zone-{n}` class, or custom classed from the `className`
  93481. * option.
  93482. */
  93483. export interface PlotVectorClusterZonesOptions {
  93484. /**
  93485. * (Highcharts, Highmaps) Styled mode only. A custom class name for the
  93486. * zone.
  93487. */
  93488. className?: string;
  93489. /**
  93490. * (Highcharts, Highmaps) The value where the zone starts.
  93491. */
  93492. from?: number;
  93493. /**
  93494. * (Highcharts, Highmaps) Settings for the cluster marker belonging to the
  93495. * zone.
  93496. */
  93497. marker?: PointMarkerOptionsObject;
  93498. /**
  93499. * (Highcharts, Highmaps) The value where the zone ends.
  93500. */
  93501. to?: number;
  93502. }
  93503. /**
  93504. * (Highcharts, Highstock, Highmaps, Gantt) Enable or disable the initial
  93505. * animation when a series is displayed for the `dataLabels`. The animation can
  93506. * also be set as a configuration object. Please note that this option only
  93507. * applies to the initial animation. For other animations, see chart.animation
  93508. * and the animation parameter under the API methods. The following properties
  93509. * are supported:
  93510. *
  93511. * - `defer`: The animation delay time in milliseconds.
  93512. */
  93513. export interface PlotVectorDataLabelsAnimationOptions {
  93514. /**
  93515. * (Highcharts, Highstock, Highmaps, Gantt) The animation delay time in
  93516. * milliseconds. Set to `0` renders dataLabel immediately. As `undefined`
  93517. * inherits defer time from the series.animation.defer.
  93518. */
  93519. defer?: number;
  93520. }
  93521. /**
  93522. * (Highcharts, Highstock, Highmaps, Gantt) Options for the series data labels,
  93523. * appearing next to each data point.
  93524. *
  93525. * Since v6.2.0, multiple data labels can be applied to each single point by
  93526. * defining them as an array of configs.
  93527. *
  93528. * In styled mode, the data labels can be styled with the
  93529. * `.highcharts-data-label-box` and `.highcharts-data-label` class names (see
  93530. * example).
  93531. */
  93532. export interface PlotVectorDataLabelsOptions {
  93533. /**
  93534. * (Highcharts, Highstock, Highmaps, Gantt) The alignment of the data label
  93535. * compared to the point. If `right`, the right side of the label should be
  93536. * touching the point. For points with an extent, like columns, the
  93537. * alignments also dictates how to align it inside the box, as given with
  93538. * the inside option. Can be one of `left`, `center` or `right`.
  93539. */
  93540. align?: (AlignValue|null);
  93541. /**
  93542. * (Highcharts, Highstock, Highmaps, Gantt) Whether to allow data labels to
  93543. * overlap. To make the labels less sensitive for overlapping, the
  93544. * dataLabels.padding can be set to 0.
  93545. */
  93546. allowOverlap?: boolean;
  93547. /**
  93548. * (Highcharts, Highstock, Highmaps, Gantt) Enable or disable the initial
  93549. * animation when a series is displayed for the `dataLabels`. The animation
  93550. * can also be set as a configuration object. Please note that this option
  93551. * only applies to the initial animation. For other animations, see
  93552. * chart.animation and the animation parameter under the API methods. The
  93553. * following properties are supported:
  93554. *
  93555. * - `defer`: The animation delay time in milliseconds.
  93556. */
  93557. animation?: (boolean|PlotVectorDataLabelsAnimationOptions|Partial<AnimationOptionsObject>);
  93558. /**
  93559. * (Highcharts, Highstock, Highmaps, Gantt) The background color or gradient
  93560. * for the data label.
  93561. */
  93562. backgroundColor?: (ColorString|GradientColorObject|PatternObject);
  93563. /**
  93564. * (Highcharts, Highstock, Highmaps, Gantt) The border color for the data
  93565. * label. Defaults to `undefined`.
  93566. */
  93567. borderColor?: (ColorString|GradientColorObject|PatternObject);
  93568. /**
  93569. * (Highcharts, Highstock, Highmaps, Gantt) The border radius in pixels for
  93570. * the data label.
  93571. */
  93572. borderRadius?: number;
  93573. /**
  93574. * (Highcharts, Highstock, Highmaps, Gantt) The border width in pixels for
  93575. * the data label.
  93576. */
  93577. borderWidth?: number;
  93578. /**
  93579. * (Highcharts, Highstock, Highmaps, Gantt) A class name for the data label.
  93580. * Particularly in styled mode, this can be used to give each series' or
  93581. * point's data label unique styling. In addition to this option, a default
  93582. * color class name is added so that we can give the labels a contrast text
  93583. * shadow.
  93584. */
  93585. className?: string;
  93586. /**
  93587. * (Highcharts, Highstock, Highmaps, Gantt) The text color for the data
  93588. * labels. Defaults to `undefined`. For certain series types, like column or
  93589. * map, the data labels can be drawn inside the points. In this case the
  93590. * data label will be drawn with maximum contrast by default. Additionally,
  93591. * it will be given a `text-outline` style with the opposite color, to
  93592. * further increase the contrast. This can be overridden by setting the
  93593. * `text-outline` style to `none` in the `dataLabels.style` option.
  93594. */
  93595. color?: (ColorString|GradientColorObject|PatternObject);
  93596. /**
  93597. * (Highcharts, Highstock, Highmaps, Gantt) Whether to hide data labels that
  93598. * are outside the plot area. By default, the data label is moved inside the
  93599. * plot area according to the overflow option.
  93600. */
  93601. crop?: boolean;
  93602. /**
  93603. * (Highcharts, Highstock, Gantt) Whether to defer displaying the data
  93604. * labels until the initial series animation has finished. Setting to
  93605. * `false` renders the data label immediately. If set to `true` inherits the
  93606. * defer time set in plotOptions.series.animation.
  93607. */
  93608. defer?: boolean;
  93609. /**
  93610. * (Highcharts, Highstock, Highmaps, Gantt) Enable or disable the data
  93611. * labels.
  93612. */
  93613. enabled?: boolean;
  93614. /**
  93615. * (Highcharts, Highstock, Highmaps, Gantt) A declarative filter to control
  93616. * of which data labels to display. The declarative filter is designed for
  93617. * use when callback functions are not available, like when the chart
  93618. * options require a pure JSON structure or for use with graphical editors.
  93619. * For programmatic control, use the `formatter` instead, and return
  93620. * `undefined` to disable a single data label.
  93621. */
  93622. filter?: DataLabelsFilterOptionsObject;
  93623. /**
  93624. * (Highcharts, Highstock, Highmaps, Gantt) A format string for the data
  93625. * label. Available variables are the same as for `formatter`.
  93626. */
  93627. format?: string;
  93628. /**
  93629. * (Highcharts, Highstock, Highmaps, Gantt) Callback JavaScript function to
  93630. * format the data label. Note that if a `format` is defined, the format
  93631. * takes precedence and the formatter is ignored.
  93632. */
  93633. formatter?: DataLabelsFormatterCallbackFunction;
  93634. /**
  93635. * (Highcharts, Highstock, Highmaps, Gantt) For points with an extent, like
  93636. * columns or map areas, whether to align the data label inside the box or
  93637. * to the actual value point. Defaults to `false` in most cases, `true` in
  93638. * stacked columns.
  93639. */
  93640. inside?: boolean;
  93641. /**
  93642. * (Highcharts, Highstock, Highmaps, Gantt) Format for points with the value
  93643. * of null. Works analogously to format. `nullFormat` can be applied only to
  93644. * series which support displaying null points.
  93645. */
  93646. nullFormat?: (boolean|string);
  93647. /**
  93648. * (Highcharts, Highstock, Highmaps, Gantt) Callback JavaScript function
  93649. * that defines formatting for points with the value of null. Works
  93650. * analogously to formatter. `nullPointFormatter` can be applied only to
  93651. * series which support displaying null points.
  93652. */
  93653. nullFormatter?: DataLabelsFormatterCallbackFunction;
  93654. /**
  93655. * (Highcharts, Highstock, Highmaps, Gantt) How to handle data labels that
  93656. * flow outside the plot area. The default is `"justify"`, which aligns them
  93657. * inside the plot area. For columns and bars, this means it will be moved
  93658. * inside the bar. To display data labels outside the plot area, set `crop`
  93659. * to `false` and `overflow` to `"allow"`.
  93660. */
  93661. overflow?: DataLabelsOverflowValue;
  93662. /**
  93663. * (Highcharts, Highstock, Highmaps, Gantt) When either the `borderWidth` or
  93664. * the `backgroundColor` is set, this is the padding within the box.
  93665. */
  93666. padding?: number;
  93667. /**
  93668. * (Highcharts, Highstock, Highmaps, Gantt) Aligns data labels relative to
  93669. * points. If `center` alignment is not possible, it defaults to `right`.
  93670. */
  93671. position?: AlignValue;
  93672. /**
  93673. * (Highcharts, Highstock, Highmaps, Gantt) Text rotation in degrees. Note
  93674. * that due to a more complex structure, backgrounds, borders and padding
  93675. * will be lost on a rotated data label.
  93676. */
  93677. rotation?: number;
  93678. /**
  93679. * (Highcharts, Highstock, Highmaps, Gantt) The shadow of the box. Works
  93680. * best with `borderWidth` or `backgroundColor`. Since 2.3 the shadow can be
  93681. * an object configuration containing `color`, `offsetX`, `offsetY`,
  93682. * `opacity` and `width`.
  93683. */
  93684. shadow?: (boolean|ShadowOptionsObject);
  93685. /**
  93686. * (Highcharts, Highstock, Highmaps, Gantt) The name of a symbol to use for
  93687. * the border around the label. Symbols are predefined functions on the
  93688. * Renderer object.
  93689. */
  93690. shape?: string;
  93691. /**
  93692. * (Highcharts, Highstock, Highmaps, Gantt) Styles for the label. The
  93693. * default `color` setting is `"contrast"`, which is a pseudo color that
  93694. * Highcharts picks up and applies the maximum contrast to the underlying
  93695. * point item, for example the bar in a bar chart.
  93696. *
  93697. * The `textOutline` is a pseudo property that applies an outline of the
  93698. * given width with the given color, which by default is the maximum
  93699. * contrast to the text. So a bright text color will result in a black text
  93700. * outline for maximum readability on a mixed background. In some cases,
  93701. * especially with grayscale text, the text outline doesn't work well, in
  93702. * which cases it can be disabled by setting it to `"none"`. When `useHTML`
  93703. * is true, the `textOutline` will not be picked up. In this, case, the same
  93704. * effect can be acheived through the `text-shadow` CSS property.
  93705. *
  93706. * For some series types, where each point has an extent, like for example
  93707. * tree maps, the data label may overflow the point. There are two
  93708. * strategies for handling overflow. By default, the text will wrap to
  93709. * multiple lines. The other strategy is to set `style.textOverflow` to
  93710. * `ellipsis`, which will keep the text on one line plus it will break
  93711. * inside long words.
  93712. */
  93713. style?: CSSObject;
  93714. /**
  93715. * (Highcharts, Highstock, Highmaps, Gantt) Options for a label text which
  93716. * should follow marker's shape. Border and background are disabled for a
  93717. * label that follows a path.
  93718. *
  93719. * **Note:** Only SVG-based renderer supports this option. Setting `useHTML`
  93720. * to true will disable this option.
  93721. */
  93722. textPath?: DataLabelsTextPathOptionsObject;
  93723. /**
  93724. * (Highcharts, Highstock, Highmaps, Gantt) Whether to use HTML to render
  93725. * the labels.
  93726. */
  93727. useHTML?: boolean;
  93728. /**
  93729. * (Highcharts, Highstock, Highmaps, Gantt) The vertical alignment of a data
  93730. * label. Can be one of `top`, `middle` or `bottom`. The default value
  93731. * depends on the data, for instance in a column chart, the label is above
  93732. * positive values and below negative values.
  93733. */
  93734. verticalAlign?: (VerticalAlignValue|null);
  93735. /**
  93736. * (Highcharts, Highstock, Highmaps, Gantt) The x position offset of the
  93737. * label relative to the point in pixels.
  93738. */
  93739. x?: number;
  93740. /**
  93741. * (Highcharts, Highstock, Highmaps, Gantt) The y position offset of the
  93742. * label relative to the point in pixels.
  93743. */
  93744. y?: number;
  93745. /**
  93746. * (Highcharts, Highstock, Highmaps, Gantt) The Z index of the data labels.
  93747. * The default Z index puts it above the series. Use a Z index of 2 to
  93748. * display it behind the series.
  93749. */
  93750. z?: number;
  93751. }
  93752. /**
  93753. * (Highcharts, Highstock) Options for the series data sorting.
  93754. */
  93755. export interface PlotVectorDataSortingOptions {
  93756. /**
  93757. * (Highcharts, Highstock) Enable or disable data sorting for the series.
  93758. * Use xAxis.reversed to change the sorting order.
  93759. */
  93760. enabled?: boolean;
  93761. /**
  93762. * (Highcharts, Highstock) Whether to allow matching points by name in an
  93763. * update. If this option is disabled, points will be matched by order.
  93764. */
  93765. matchByName?: boolean;
  93766. /**
  93767. * (Highcharts, Highstock) Determines what data value should be used to sort
  93768. * by.
  93769. */
  93770. sortKey?: string;
  93771. }
  93772. /**
  93773. * (Highcharts, Highstock) A vector plot is a type of cartesian chart where each
  93774. * point has an X and Y position, a length and a direction. Vectors are drawn as
  93775. * arrows.
  93776. *
  93777. * In TypeScript the type option must always be set.
  93778. *
  93779. * Configuration options for the series are given in three levels:
  93780. *
  93781. * 1. Options for all series in a chart are defined in the plotOptions.series
  93782. * object.
  93783. *
  93784. * 2. Options for all `vector` series are defined in plotOptions.vector.
  93785. *
  93786. * 3. Options for one single series are given in the series instance array. (see
  93787. * online documentation for example)
  93788. */
  93789. export interface PlotVectorOptions {
  93790. /**
  93791. * (Highcharts, Highstock) Accessibility options for a series.
  93792. */
  93793. accessibility?: SeriesAccessibilityOptionsObject;
  93794. /**
  93795. * (Highmaps) Whether all areas of the map defined in `mapData` should be
  93796. * rendered. If `true`, areas which don't correspond to a data point, are
  93797. * rendered as `null` points. If `false`, those areas are skipped.
  93798. */
  93799. allAreas?: boolean;
  93800. /**
  93801. * (Highcharts, Highstock) Allow this series' points to be selected by
  93802. * clicking on the graphic (columns, point markers, pie slices, map areas
  93803. * etc).
  93804. *
  93805. * The selected points can be handled by point select and unselect events,
  93806. * or collectively by the getSelectedPoints function.
  93807. *
  93808. * And alternative way of selecting points is through dragging.
  93809. */
  93810. allowPointSelect?: boolean;
  93811. /**
  93812. * (Highcharts, Highstock) Enable or disable the initial animation when a
  93813. * series is displayed. The animation can also be set as a configuration
  93814. * object. Please note that this option only applies to the initial
  93815. * animation of the series itself. For other animations, see chart.animation
  93816. * and the animation parameter under the API methods. The following
  93817. * properties are supported:
  93818. *
  93819. * - `defer`: The animation delay time in milliseconds.
  93820. *
  93821. * - `duration`: The duration of the animation in milliseconds.
  93822. *
  93823. * - `easing`: Can be a string reference to an easing function set on the
  93824. * `Math` object or a function. See the _Custom easing function_ demo below.
  93825. *
  93826. * Due to poor performance, animation is disabled in old IE browsers for
  93827. * several chart types.
  93828. */
  93829. animation?: (boolean|PlotVectorAnimationOptions|Partial<AnimationOptionsObject>);
  93830. /**
  93831. * (Highcharts, Highstock) For some series, there is a limit that shuts down
  93832. * initial animation by default when the total number of points in the chart
  93833. * is too high. For example, for a column chart and its derivatives,
  93834. * animation does not run if there is more than 250 points totally. To
  93835. * disable this cap, set `animationLimit` to `Infinity`.
  93836. */
  93837. animationLimit?: number;
  93838. /**
  93839. * (Highmaps) The border color of the map areas.
  93840. *
  93841. * In styled mode, the border stroke is given in the `.highcharts-point`
  93842. * class.
  93843. */
  93844. borderColor?: (ColorString|GradientColorObject|PatternObject);
  93845. /**
  93846. * (Highmaps) The border width of each map area.
  93847. *
  93848. * In styled mode, the border stroke width is given in the
  93849. * `.highcharts-point` class.
  93850. */
  93851. borderWidth?: number;
  93852. /**
  93853. * (Highcharts, Highstock) An additional class name to apply to the series'
  93854. * graphical elements. This option does not replace default class names of
  93855. * the graphical element.
  93856. */
  93857. className?: string;
  93858. /**
  93859. * (Highcharts, Highstock) Disable this option to allow series rendering in
  93860. * the whole plotting area.
  93861. *
  93862. * **Note:** Clipping should be always enabled when chart.zoomType is set
  93863. */
  93864. clip?: boolean;
  93865. /**
  93866. * (Highcharts, Highmaps) Options for marker clusters, the concept of
  93867. * sampling the data values into larger blocks in order to ease readability
  93868. * and increase performance of the JavaScript charts.
  93869. *
  93870. * Note: marker clusters module is not working with `boost` and
  93871. * `draggable-points` modules.
  93872. *
  93873. * The marker clusters feature requires the marker-clusters.js file to be
  93874. * loaded, found in the modules directory of the download package, or online
  93875. * at code.highcharts.com/modules/marker-clusters.js.
  93876. */
  93877. cluster?: PlotVectorClusterOptions;
  93878. /**
  93879. * (Highcharts, Highstock) The main color of the series. In line type series
  93880. * it applies to the line and the point markers unless otherwise specified.
  93881. * In bar type series it applies to the bars unless a color is specified per
  93882. * point. The default value is pulled from the `options.colors` array.
  93883. *
  93884. * In styled mode, the color can be defined by the colorIndex option. Also,
  93885. * the series color can be set with the `.highcharts-series`,
  93886. * `.highcharts-color-{n}`, `.highcharts-{type}-series` or
  93887. * `.highcharts-series-{n}` class, or individual classes given by the
  93888. * `className` option.
  93889. */
  93890. color?: (ColorString|GradientColorObject|PatternObject);
  93891. /**
  93892. * (Highcharts, Highstock, Highmaps) When using dual or multiple color axes,
  93893. * this number defines which colorAxis the particular series is connected
  93894. * to. It refers to either the axis id or the index of the axis in the
  93895. * colorAxis array, with 0 being the first. Set this option to false to
  93896. * prevent a series from connecting to the default color axis.
  93897. *
  93898. * Since v7.2.0 the option can also be an axis id or an axis index instead
  93899. * of a boolean flag.
  93900. */
  93901. colorAxis?: (boolean|number|string);
  93902. /**
  93903. * (Highcharts, Highstock) Styled mode only. A specific color index to use
  93904. * for the series, so its graphic representations are given the class name
  93905. * `highcharts-color-{n}`.
  93906. */
  93907. colorIndex?: number;
  93908. /**
  93909. * (Highcharts, Highstock, Highmaps) Determines what data value should be
  93910. * used to calculate point color if `colorAxis` is used. Requires to set
  93911. * `min` and `max` if some custom point property is used or if approximation
  93912. * for data grouping is set to `'sum'`.
  93913. */
  93914. colorKey?: string;
  93915. /**
  93916. * (Highstock) Compare the values of the series against the first non-null,
  93917. * non- zero value in the visible range. The y axis will show percentage or
  93918. * absolute change depending on whether `compare` is set to `"percent"` or
  93919. * `"value"`. When this is applied to multiple series, it allows comparing
  93920. * the development of the series against each other. Adds a `change` field
  93921. * to every point object.
  93922. */
  93923. compare?: string;
  93924. /**
  93925. * (Highstock) When compare is `percent`, this option dictates whether to
  93926. * use 0 or 100 as the base of comparison.
  93927. */
  93928. compareBase?: (0|100);
  93929. /**
  93930. * (Highstock) Defines if comparison should start from the first point
  93931. * within the visible range or should start from the first point **before**
  93932. * the range.
  93933. *
  93934. * In other words, this flag determines if first point within the visible
  93935. * range will have 0% (`compareStart=true`) or should have been already
  93936. * calculated according to the previous point (`compareStart=false`).
  93937. */
  93938. compareStart?: boolean;
  93939. /**
  93940. * (Gantt) Override Pathfinder connector options for a series. Requires
  93941. * Highcharts Gantt to be loaded.
  93942. */
  93943. connectors?: SeriesConnectorsOptionsObject;
  93944. /**
  93945. * (Highcharts, Highstock, Gantt) When true, each point or column edge is
  93946. * rounded to its nearest pixel in order to render sharp on screen. In some
  93947. * cases, when there are a lot of densely packed columns, this leads to
  93948. * visible difference in column widths or distance between columns. In these
  93949. * cases, setting `crisp` to `false` may look better, even though each
  93950. * column is rendered blurry.
  93951. */
  93952. crisp?: boolean;
  93953. /**
  93954. * (Highcharts, Highstock) You can set the cursor to "pointer" if you have
  93955. * click events attached to the series, to signal to the user that the
  93956. * points and lines can be clicked.
  93957. *
  93958. * In styled mode, the series cursor can be set with the same classes as
  93959. * listed under series.color.
  93960. */
  93961. cursor?: (string|CursorValue);
  93962. /**
  93963. * (Highcharts, Highstock) A reserved subspace to store options and values
  93964. * for customized functionality. Here you can add additional data for your
  93965. * own event callbacks and formatter callbacks.
  93966. */
  93967. custom?: Dictionary<any>;
  93968. /**
  93969. * (Highcharts, Highstock, Highmaps, Gantt) Options for the series data
  93970. * labels, appearing next to each data point.
  93971. *
  93972. * Since v6.2.0, multiple data labels can be applied to each single point by
  93973. * defining them as an array of configs.
  93974. *
  93975. * In styled mode, the data labels can be styled with the
  93976. * `.highcharts-data-label-box` and `.highcharts-data-label` class names
  93977. * (see example).
  93978. */
  93979. dataLabels?: (PlotVectorDataLabelsOptions|Array<PlotVectorDataLabelsOptions>);
  93980. /**
  93981. * (Highcharts, Highstock) Options for the series data sorting.
  93982. */
  93983. dataSorting?: (DataSortingOptionsObject|PlotVectorDataSortingOptions);
  93984. /**
  93985. * (Highcharts, Highstock) A description of the series to add to the screen
  93986. * reader information about the series.
  93987. */
  93988. description?: string;
  93989. /**
  93990. * (Highcharts, Highstock) Enable or disable the mouse tracking for a
  93991. * specific series. This includes point tooltips and click events on graphs
  93992. * and points. For large datasets it improves performance.
  93993. */
  93994. enableMouseTracking?: boolean;
  93995. /**
  93996. * (Highcharts, Highstock) General event handlers for the series items.
  93997. * These event hooks can also be attached to the series at run time using
  93998. * the `Highcharts.addEvent` function.
  93999. */
  94000. events?: SeriesEventsOptionsObject;
  94001. /**
  94002. * (Highcharts, Highstock) Determines whether the series should look for the
  94003. * nearest point in both dimensions or just the x-dimension when hovering
  94004. * the series. Defaults to `'xy'` for scatter series and `'x'` for most
  94005. * other series. If the data has duplicate x-values, it is recommended to
  94006. * set this to `'xy'` to allow hovering over all points.
  94007. *
  94008. * Applies only to series types using nearest neighbor search (not direct
  94009. * hover) for tooltip.
  94010. */
  94011. findNearestPointBy?: OptionsFindNearestPointByValue;
  94012. /**
  94013. * (Highcharts, Highstock, Gantt) Whether to use the Y extremes of the total
  94014. * chart width or only the zoomed area when zooming in on parts of the X
  94015. * axis. By default, the Y axis adjusts to the min and max of the visible
  94016. * data. Cartesian series only.
  94017. */
  94018. getExtremesFromAll?: boolean;
  94019. /**
  94020. * (Highcharts, Highstock) When set to `false` will prevent the series data
  94021. * from being included in any form of data export.
  94022. *
  94023. * Since version 6.0.0 until 7.1.0 the option was existing undocumented as
  94024. * `includeInCSVExport`.
  94025. */
  94026. includeInDataExport?: boolean;
  94027. /**
  94028. * (Highmaps) What property to join the `mapData` to the value data. For
  94029. * example, if joinBy is "code", the mapData items with a specific code is
  94030. * merged into the data with the same code. For maps loaded from GeoJSON,
  94031. * the keys may be held in each point's `properties` object.
  94032. *
  94033. * The joinBy option can also be an array of two values, where the first
  94034. * points to a key in the `mapData`, and the second points to another key in
  94035. * the `data`.
  94036. *
  94037. * When joinBy is `null`, the map items are joined by their position in the
  94038. * array, which performs much better in maps with many data points. This is
  94039. * the recommended option if you are printing more than a thousand data
  94040. * points and have a backend that can preprocess the data into a parallel
  94041. * array of the mapData.
  94042. */
  94043. joinBy?: (string|Array<string>);
  94044. /**
  94045. * (Highcharts, Highstock) An array specifying which option maps to which
  94046. * key in the data point array. This makes it convenient to work with
  94047. * unstructured data arrays from different sources.
  94048. */
  94049. keys?: Array<string>;
  94050. /**
  94051. * (Highcharts, Highstock, Gantt) Series labels are placed as close to the
  94052. * series as possible in a natural way, seeking to avoid other series. The
  94053. * goal of this feature is to make the chart more easily readable, like if a
  94054. * human designer placed the labels in the optimal position.
  94055. *
  94056. * The series labels currently work with series types having a `graph` or an
  94057. * `area`.
  94058. */
  94059. label?: SeriesLabelOptionsObject;
  94060. /**
  94061. * (Highstock) The line marks the last price from all points.
  94062. */
  94063. lastPrice?: SeriesLastPriceOptionsObject;
  94064. /**
  94065. * (Highstock) The line marks the last price from visible range of points.
  94066. */
  94067. lastVisiblePrice?: SeriesLastVisiblePriceOptionsObject;
  94068. /**
  94069. * (Highcharts, Highstock) The line width for each vector arrow.
  94070. */
  94071. lineWidth?: number;
  94072. /**
  94073. * (Highcharts, Highstock, Gantt) The id of another series to link to.
  94074. * Additionally, the value can be ":previous" to link to the previous
  94075. * series. When two series are linked, only the first one appears in the
  94076. * legend. Toggling the visibility of this also toggles the linked series.
  94077. *
  94078. * If master series uses data sorting and linked series does not have its
  94079. * own sorting definition, the linked series will be sorted in the same
  94080. * order as the master one.
  94081. */
  94082. linkedTo?: string;
  94083. /**
  94084. * (Highstock) Options for the corresponding navigator series if
  94085. * `showInNavigator` is `true` for this series. Available options are the
  94086. * same as any series, documented at plotOptions and series.
  94087. *
  94088. * These options are merged with options in navigator.series, and will take
  94089. * precedence if the same option is defined both places.
  94090. */
  94091. navigatorOptions?: PlotSeriesOptions;
  94092. /**
  94093. * (Highcharts, Highstock) The color for the parts of the graph or points
  94094. * that are below the threshold. Note that `zones` takes precedence over the
  94095. * negative color. Using `negativeColor` is equivalent to applying a zone
  94096. * with value of 0.
  94097. */
  94098. negativeColor?: (ColorString|GradientColorObject|PatternObject);
  94099. /**
  94100. * (Highcharts, Highstock) Opacity of a series parts: line, fill (e.g. area)
  94101. * and dataLabels.
  94102. */
  94103. opacity?: number;
  94104. /**
  94105. * (Highcharts, Highstock) Properties for each single point.
  94106. */
  94107. point?: PlotSeriesPointOptions;
  94108. /**
  94109. * (Highcharts, Highstock) Same as accessibility.pointDescriptionFormatter,
  94110. * but for an individual series. Overrides the chart wide configuration.
  94111. */
  94112. pointDescriptionFormatter?: Function;
  94113. /**
  94114. * (Highcharts, Highstock, Gantt) If no x values are given for the points in
  94115. * a series, `pointInterval` defines the interval of the x values. For
  94116. * example, if a series contains one value every decade starting from year
  94117. * 0, set `pointInterval` to `10`. In true `datetime` axes, the
  94118. * `pointInterval` is set in milliseconds.
  94119. *
  94120. * It can be also be combined with `pointIntervalUnit` to draw irregular
  94121. * time intervals.
  94122. *
  94123. * Please note that this options applies to the _series data_, not the
  94124. * interval of the axis ticks, which is independent.
  94125. */
  94126. pointInterval?: number;
  94127. /**
  94128. * (Highcharts, Highstock, Gantt) On datetime series, this allows for
  94129. * setting the pointInterval to irregular time units, `day`, `month` and
  94130. * `year`. A day is usually the same as 24 hours, but `pointIntervalUnit`
  94131. * also takes the DST crossover into consideration when dealing with local
  94132. * time. Combine this option with `pointInterval` to draw weeks, quarters, 6
  94133. * months, 10 years etc.
  94134. *
  94135. * Please note that this options applies to the _series data_, not the
  94136. * interval of the axis ticks, which is independent.
  94137. */
  94138. pointIntervalUnit?: OptionsPointIntervalUnitValue;
  94139. /**
  94140. * (Highstock) The width of each point on the x axis. For example in a
  94141. * column chart with one value each day, the pointRange would be 1 day (= 24
  94142. * * 3600
  94143. *
  94144. * * 1000 milliseconds). This is normally computed automatically, but this
  94145. * option can be used to override the automatic value.
  94146. */
  94147. pointRange?: number;
  94148. /**
  94149. * (Highcharts, Highstock, Gantt) If no x values are given for the points in
  94150. * a series, pointStart defines on what value to start. For example, if a
  94151. * series contains one yearly value starting from 1945, set pointStart to
  94152. * 1945.
  94153. */
  94154. pointStart?: number;
  94155. /**
  94156. * (Highcharts, Highstock) What part of the vector it should be rotated
  94157. * around. Can be one of `start`, `center` and `end`. When `start`, the
  94158. * vectors will start from the given [x, y] position, and when `end` the
  94159. * vectors will end in the [x, y] position.
  94160. */
  94161. rotationOrigin?: OptionsRotationOriginValue;
  94162. /**
  94163. * (Highcharts, Highstock) Whether to select the series initially. If
  94164. * `showCheckbox` is true, the checkbox next to the series name in the
  94165. * legend will be checked for a selected series.
  94166. */
  94167. selected?: boolean;
  94168. /**
  94169. * (Highcharts, Highstock) If true, a checkbox is displayed next to the
  94170. * legend item to allow selecting the series. The state of the checkbox is
  94171. * determined by the `selected` option.
  94172. */
  94173. showCheckbox?: boolean;
  94174. /**
  94175. * (Highcharts, Highstock) Whether to display this particular series or
  94176. * series type in the legend. Standalone series are shown in legend by
  94177. * default, and linked series are not. Since v7.2.0 it is possible to show
  94178. * series that use colorAxis by setting this option to `true`.
  94179. */
  94180. showInLegend?: boolean;
  94181. /**
  94182. * (Highstock) Whether or not to show the series in the navigator. Takes
  94183. * precedence over navigator.baseSeries if defined.
  94184. */
  94185. showInNavigator?: boolean;
  94186. /**
  94187. * (Highcharts, Highstock) If set to `true`, the accessibility module will
  94188. * skip past the points in this series for keyboard navigation.
  94189. */
  94190. skipKeyboardNavigation?: boolean;
  94191. /**
  94192. * (Highcharts, Highstock) When this is true, the series will not cause the
  94193. * Y axis to cross the zero plane (or threshold option) unless the data
  94194. * actually crosses the plane.
  94195. *
  94196. * For example, if `softThreshold` is `false`, a series of 0, 1, 2, 3 will
  94197. * make the Y axis show negative values according to the `minPadding`
  94198. * option. If `softThreshold` is `true`, the Y axis starts at 0.
  94199. */
  94200. softThreshold?: boolean;
  94201. states?: SeriesStatesOptionsObject;
  94202. /**
  94203. * (Highcharts, Highstock) Sticky tracking of mouse events. When true, the
  94204. * `mouseOut` event on a series isn't triggered until the mouse moves over
  94205. * another series, or out of the plot area. When false, the `mouseOut` event
  94206. * on a series is triggered when the mouse leaves the area around the
  94207. * series' graph or markers. This also implies the tooltip. When
  94208. * `stickyTracking` is false and `tooltip.shared` is false, the tooltip will
  94209. * be hidden when moving the mouse between series.
  94210. */
  94211. stickyTracking?: boolean;
  94212. /**
  94213. * (Highcharts, Highstock) The threshold, also called zero level or base
  94214. * level. For line type series this is only used in conjunction with
  94215. * negativeColor.
  94216. */
  94217. threshold?: (number|null);
  94218. /**
  94219. * (Highcharts, Highstock) A configuration object for the tooltip rendering
  94220. * of each single series. Properties are inherited from tooltip. Overridable
  94221. * properties are `headerFormat`, `pointFormat`, `yDecimals`, `xDateFormat`,
  94222. * `yPrefix` and `ySuffix`. Unlike other series, in a scatter plot the
  94223. * series.name by default shows in the headerFormat and point.x and point.y
  94224. * in the pointFormat.
  94225. */
  94226. tooltip?: SeriesTooltipOptionsObject;
  94227. /**
  94228. * (Highcharts, Highstock, Gantt) When a series contains a data array that
  94229. * is longer than this, only one dimensional arrays of numbers, or two
  94230. * dimensional arrays with x and y values are allowed. Also, only the first
  94231. * point is tested, and the rest are assumed to be the same format. This
  94232. * saves expensive data checking and indexing in long series. Set it to `0`
  94233. * disable.
  94234. *
  94235. * Note: In boost mode turbo threshold is forced. Only array of numbers or
  94236. * two dimensional arrays are allowed.
  94237. */
  94238. turboThreshold?: number;
  94239. /**
  94240. * (Highcharts, Highstock) Maximum length of the arrows in the vector plot.
  94241. * The individual arrow length is computed between 0 and this value.
  94242. */
  94243. vectorLength?: number;
  94244. /**
  94245. * (Highcharts, Highstock) Set the initial visibility of the series.
  94246. */
  94247. visible?: boolean;
  94248. /**
  94249. * (Highmaps) Define the z index of the series.
  94250. */
  94251. zIndex?: number;
  94252. /**
  94253. * (Highcharts, Highstock) Defines the Axis on which the zones are applied.
  94254. */
  94255. zoneAxis?: string;
  94256. /**
  94257. * (Highcharts, Highstock) An array defining zones within a series. Zones
  94258. * can be applied to the X axis, Y axis or Z axis for bubbles, according to
  94259. * the `zoneAxis` option. The zone definitions have to be in ascending order
  94260. * regarding to the value.
  94261. *
  94262. * In styled mode, the color zones are styled with the
  94263. * `.highcharts-zone-{n}` class, or custom classed from the `className`
  94264. * option (view live demo).
  94265. */
  94266. zones?: Array<SeriesZonesOptionsObject>;
  94267. }
  94268. /**
  94269. * (Highcharts) Enable or disable the initial animation when a series is
  94270. * displayed. The animation can also be set as a configuration object. Please
  94271. * note that this option only applies to the initial animation of the series
  94272. * itself. For other animations, see chart.animation and the animation parameter
  94273. * under the API methods. The following properties are supported:
  94274. *
  94275. * - `defer`: The animation delay time in milliseconds.
  94276. *
  94277. * - `duration`: The duration of the animation in milliseconds.
  94278. *
  94279. * - `easing`: Can be a string reference to an easing function set on the `Math`
  94280. * object or a function. See the _Custom easing function_ demo below.
  94281. *
  94282. * Due to poor performance, animation is disabled in old IE browsers for several
  94283. * chart types.
  94284. */
  94285. export interface PlotVennAnimationOptions {
  94286. defer?: number;
  94287. }
  94288. export interface PlotVennClusterEventsOptions {
  94289. /**
  94290. * (Highcharts, Highmaps) Fires when the cluster point is clicked and
  94291. * `drillToCluster` is enabled. One parameter, `event`, is passed to the
  94292. * function. The default action is to zoom to the cluster points range. This
  94293. * can be prevented by calling `event.preventDefault()`.
  94294. */
  94295. drillToCluster?: MarkerClusterDrillCallbackFunction;
  94296. }
  94297. /**
  94298. * (Highcharts, Highmaps) Options for layout algorithm. Inside there are options
  94299. * to change the type of the algorithm, gridSize, distance or iterations.
  94300. */
  94301. export interface PlotVennClusterLayoutAlgorithmOptions {
  94302. /**
  94303. * (Highcharts, Highmaps) When `type` is set to `kmeans`, `distance` is a
  94304. * maximum distance between point and cluster center so that this point will
  94305. * be inside the cluster. The distance is either a number defining pixels or
  94306. * a percentage defining a percentage of the plot area width.
  94307. */
  94308. distance?: (number|string);
  94309. /**
  94310. * (Highcharts, Highmaps) When `type` is set to the `grid`, `gridSize` is a
  94311. * size of a grid square element either as a number defining pixels, or a
  94312. * percentage defining a percentage of the plot area width.
  94313. */
  94314. gridSize?: (number|string);
  94315. /**
  94316. * (Highcharts, Highmaps) When `type` is set to `kmeans`, `iterations` are
  94317. * the number of iterations that this algorithm will be repeated to find
  94318. * clusters positions.
  94319. */
  94320. iterations?: number;
  94321. /**
  94322. * (Highcharts, Highmaps) When `type` is set to `undefined` and there are
  94323. * more visible points than the kmeansThreshold the `grid` algorithm is used
  94324. * to find clusters, otherwise `kmeans`. It ensures good performance on
  94325. * large datasets and better clusters arrangement after the zoom.
  94326. */
  94327. kmeansThreshold?: number;
  94328. /**
  94329. * (Highcharts, Highmaps) Type of the algorithm used to combine points into
  94330. * a cluster. There are three available algorithms:
  94331. *
  94332. * 1) `grid` - grid-based clustering technique. Points are assigned to
  94333. * squares of set size depending on their position on the plot area. Points
  94334. * inside the grid square are combined into a cluster. The grid size can be
  94335. * controlled by `gridSize` property (grid size changes at certain zoom
  94336. * levels).
  94337. *
  94338. * 2) `kmeans` - based on K-Means clustering technique. In the first step,
  94339. * points are divided using the grid method (distance property is a grid
  94340. * size) to find the initial amount of clusters. Next, each point is
  94341. * classified by computing the distance between each cluster center and that
  94342. * point. When the closest cluster distance is lower than distance property
  94343. * set by a user the point is added to this cluster otherwise is classified
  94344. * as `noise`. The algorithm is repeated until each cluster center not
  94345. * change its previous position more than one pixel. This technique is more
  94346. * accurate but also more time consuming than the `grid` algorithm,
  94347. * especially for big datasets.
  94348. *
  94349. * 3) `optimizedKmeans` - based on K-Means clustering technique. This
  94350. * algorithm uses k-means algorithm only on the chart initialization or when
  94351. * chart extremes have greater range than on initialization. When a chart is
  94352. * redrawn the algorithm checks only clustered points distance from the
  94353. * cluster center and rebuild it when the point is spaced enough to be
  94354. * outside the cluster. It provides performance improvement and more stable
  94355. * clusters position yet can be used rather on small and sparse datasets.
  94356. *
  94357. * By default, the algorithm depends on visible quantity of points and
  94358. * `kmeansThreshold`. When there are more visible points than the
  94359. * `kmeansThreshold` the `grid` algorithm is used, otherwise `kmeans`.
  94360. *
  94361. * The custom clustering algorithm can be added by assigning a callback
  94362. * function as the type property. This function takes an array of
  94363. * `processedXData`, `processedYData`, `processedXData` indexes and
  94364. * `layoutAlgorithm` options as arguments and should return an object with
  94365. * grouped data.
  94366. *
  94367. * The algorithm should return an object like that: (see online
  94368. * documentation for example)
  94369. *
  94370. * `clusterId` (example above - unique id of a cluster or noise) is an array
  94371. * of points belonging to a cluster. If the array has only one point or
  94372. * fewer points than set in `cluster.minimumClusterSize` it won't be
  94373. * combined into a cluster.
  94374. */
  94375. type?: (string|Function);
  94376. }
  94377. /**
  94378. * (Highcharts, Highmaps) Options for marker clusters, the concept of sampling
  94379. * the data values into larger blocks in order to ease readability and increase
  94380. * performance of the JavaScript charts.
  94381. *
  94382. * Note: marker clusters module is not working with `boost` and
  94383. * `draggable-points` modules.
  94384. *
  94385. * The marker clusters feature requires the marker-clusters.js file to be
  94386. * loaded, found in the modules directory of the download package, or online at
  94387. * code.highcharts.com/modules/marker-clusters.js.
  94388. */
  94389. export interface PlotVennClusterOptions {
  94390. /**
  94391. * (Highcharts, Highmaps) When set to `false` prevent cluster overlapping -
  94392. * this option works only when `layoutAlgorithm.type = "grid"`.
  94393. */
  94394. allowOverlap?: boolean;
  94395. /**
  94396. * (Highcharts, Highmaps) Options for the cluster marker animation.
  94397. */
  94398. animation?: (boolean|Partial<AnimationOptionsObject>);
  94399. /**
  94400. * (Highcharts, Highmaps) Options for the cluster data labels.
  94401. */
  94402. dataLabels?: DataLabelsOptions;
  94403. /**
  94404. * (Highcharts, Highmaps) Zoom the plot area to the cluster points range
  94405. * when a cluster is clicked.
  94406. */
  94407. drillToCluster?: boolean;
  94408. /**
  94409. * (Highcharts, Highmaps) Whether to enable the marker-clusters module.
  94410. */
  94411. enabled?: boolean;
  94412. events?: PlotVennClusterEventsOptions;
  94413. /**
  94414. * (Highcharts, Highmaps) Options for layout algorithm. Inside there are
  94415. * options to change the type of the algorithm, gridSize, distance or
  94416. * iterations.
  94417. */
  94418. layoutAlgorithm?: PlotVennClusterLayoutAlgorithmOptions;
  94419. /**
  94420. * (Highcharts, Highmaps) Options for the cluster marker.
  94421. */
  94422. marker?: PointMarkerOptionsObject;
  94423. /**
  94424. * (Highcharts, Highmaps) The minimum amount of points to be combined into a
  94425. * cluster. This value has to be greater or equal to 2.
  94426. */
  94427. minimumClusterSize?: number;
  94428. states?: PlotVennClusterStatesOptions;
  94429. /**
  94430. * (Highcharts, Highmaps) An array defining zones within marker clusters.
  94431. *
  94432. * In styled mode, the color zones are styled with the
  94433. * `.highcharts-cluster-zone-{n}` class, or custom classed from the
  94434. * `className` option.
  94435. */
  94436. zones?: Array<PlotVennClusterZonesOptions>;
  94437. }
  94438. export interface PlotVennClusterStatesHoverOptions {
  94439. /**
  94440. * (Highcharts, Highmaps) The fill color of the cluster marker in hover
  94441. * state. When `undefined`, the series' or point's fillColor for normal
  94442. * state is used.
  94443. */
  94444. fillColor?: ColorType;
  94445. }
  94446. export interface PlotVennClusterStatesOptions {
  94447. hover?: PlotVennClusterStatesHoverOptions;
  94448. }
  94449. /**
  94450. * (Highcharts, Highmaps) An array defining zones within marker clusters.
  94451. *
  94452. * In styled mode, the color zones are styled with the
  94453. * `.highcharts-cluster-zone-{n}` class, or custom classed from the `className`
  94454. * option.
  94455. */
  94456. export interface PlotVennClusterZonesOptions {
  94457. /**
  94458. * (Highcharts, Highmaps) Styled mode only. A custom class name for the
  94459. * zone.
  94460. */
  94461. className?: string;
  94462. /**
  94463. * (Highcharts, Highmaps) The value where the zone starts.
  94464. */
  94465. from?: number;
  94466. /**
  94467. * (Highcharts, Highmaps) Settings for the cluster marker belonging to the
  94468. * zone.
  94469. */
  94470. marker?: PointMarkerOptionsObject;
  94471. /**
  94472. * (Highcharts, Highmaps) The value where the zone ends.
  94473. */
  94474. to?: number;
  94475. }
  94476. /**
  94477. * (Highcharts, Highstock, Highmaps, Gantt) Enable or disable the initial
  94478. * animation when a series is displayed for the `dataLabels`. The animation can
  94479. * also be set as a configuration object. Please note that this option only
  94480. * applies to the initial animation. For other animations, see chart.animation
  94481. * and the animation parameter under the API methods. The following properties
  94482. * are supported:
  94483. *
  94484. * - `defer`: The animation delay time in milliseconds.
  94485. */
  94486. export interface PlotVennDataLabelsAnimationOptions {
  94487. /**
  94488. * (Highcharts, Highstock, Highmaps, Gantt) The animation delay time in
  94489. * milliseconds. Set to `0` renders dataLabel immediately. As `undefined`
  94490. * inherits defer time from the series.animation.defer.
  94491. */
  94492. defer?: number;
  94493. }
  94494. /**
  94495. * (Highcharts, Highstock, Highmaps, Gantt) Options for the series data labels,
  94496. * appearing next to each data point.
  94497. *
  94498. * Since v6.2.0, multiple data labels can be applied to each single point by
  94499. * defining them as an array of configs.
  94500. *
  94501. * In styled mode, the data labels can be styled with the
  94502. * `.highcharts-data-label-box` and `.highcharts-data-label` class names (see
  94503. * example).
  94504. */
  94505. export interface PlotVennDataLabelsOptions {
  94506. /**
  94507. * (Highcharts, Highstock, Highmaps, Gantt) The alignment of the data label
  94508. * compared to the point. If `right`, the right side of the label should be
  94509. * touching the point. For points with an extent, like columns, the
  94510. * alignments also dictates how to align it inside the box, as given with
  94511. * the inside option. Can be one of `left`, `center` or `right`.
  94512. */
  94513. align?: (AlignValue|null);
  94514. /**
  94515. * (Highcharts, Highstock, Highmaps, Gantt) Whether to allow data labels to
  94516. * overlap. To make the labels less sensitive for overlapping, the
  94517. * dataLabels.padding can be set to 0.
  94518. */
  94519. allowOverlap?: boolean;
  94520. /**
  94521. * (Highcharts, Highstock, Highmaps, Gantt) Enable or disable the initial
  94522. * animation when a series is displayed for the `dataLabels`. The animation
  94523. * can also be set as a configuration object. Please note that this option
  94524. * only applies to the initial animation. For other animations, see
  94525. * chart.animation and the animation parameter under the API methods. The
  94526. * following properties are supported:
  94527. *
  94528. * - `defer`: The animation delay time in milliseconds.
  94529. */
  94530. animation?: (boolean|PlotVennDataLabelsAnimationOptions|Partial<AnimationOptionsObject>);
  94531. /**
  94532. * (Highcharts, Highstock, Highmaps, Gantt) The background color or gradient
  94533. * for the data label.
  94534. */
  94535. backgroundColor?: (ColorString|GradientColorObject|PatternObject);
  94536. /**
  94537. * (Highcharts, Highstock, Highmaps, Gantt) The border color for the data
  94538. * label. Defaults to `undefined`.
  94539. */
  94540. borderColor?: (ColorString|GradientColorObject|PatternObject);
  94541. /**
  94542. * (Highcharts, Highstock, Highmaps, Gantt) The border radius in pixels for
  94543. * the data label.
  94544. */
  94545. borderRadius?: number;
  94546. /**
  94547. * (Highcharts, Highstock, Highmaps, Gantt) The border width in pixels for
  94548. * the data label.
  94549. */
  94550. borderWidth?: number;
  94551. /**
  94552. * (Highcharts, Highstock, Highmaps, Gantt) A class name for the data label.
  94553. * Particularly in styled mode, this can be used to give each series' or
  94554. * point's data label unique styling. In addition to this option, a default
  94555. * color class name is added so that we can give the labels a contrast text
  94556. * shadow.
  94557. */
  94558. className?: string;
  94559. /**
  94560. * (Highcharts, Highstock, Highmaps, Gantt) The text color for the data
  94561. * labels. Defaults to `undefined`. For certain series types, like column or
  94562. * map, the data labels can be drawn inside the points. In this case the
  94563. * data label will be drawn with maximum contrast by default. Additionally,
  94564. * it will be given a `text-outline` style with the opposite color, to
  94565. * further increase the contrast. This can be overridden by setting the
  94566. * `text-outline` style to `none` in the `dataLabels.style` option.
  94567. */
  94568. color?: (ColorString|GradientColorObject|PatternObject);
  94569. /**
  94570. * (Highcharts, Highstock, Highmaps, Gantt) Whether to hide data labels that
  94571. * are outside the plot area. By default, the data label is moved inside the
  94572. * plot area according to the overflow option.
  94573. */
  94574. crop?: boolean;
  94575. /**
  94576. * (Highcharts, Highstock, Gantt) Whether to defer displaying the data
  94577. * labels until the initial series animation has finished. Setting to
  94578. * `false` renders the data label immediately. If set to `true` inherits the
  94579. * defer time set in plotOptions.series.animation.
  94580. */
  94581. defer?: boolean;
  94582. /**
  94583. * (Highcharts, Highstock, Highmaps, Gantt) Enable or disable the data
  94584. * labels.
  94585. */
  94586. enabled?: boolean;
  94587. /**
  94588. * (Highcharts, Highstock, Highmaps, Gantt) A declarative filter to control
  94589. * of which data labels to display. The declarative filter is designed for
  94590. * use when callback functions are not available, like when the chart
  94591. * options require a pure JSON structure or for use with graphical editors.
  94592. * For programmatic control, use the `formatter` instead, and return
  94593. * `undefined` to disable a single data label.
  94594. */
  94595. filter?: DataLabelsFilterOptionsObject;
  94596. /**
  94597. * (Highcharts, Highstock, Highmaps, Gantt) A format string for the data
  94598. * label. Available variables are the same as for `formatter`.
  94599. */
  94600. format?: string;
  94601. /**
  94602. * (Highcharts, Highstock, Highmaps, Gantt) Callback JavaScript function to
  94603. * format the data label. Note that if a `format` is defined, the format
  94604. * takes precedence and the formatter is ignored.
  94605. */
  94606. formatter?: DataLabelsFormatterCallbackFunction;
  94607. /**
  94608. * (Highcharts, Highstock, Highmaps, Gantt) For points with an extent, like
  94609. * columns or map areas, whether to align the data label inside the box or
  94610. * to the actual value point. Defaults to `false` in most cases, `true` in
  94611. * stacked columns.
  94612. */
  94613. inside?: boolean;
  94614. /**
  94615. * (Highcharts, Highstock, Highmaps, Gantt) Format for points with the value
  94616. * of null. Works analogously to format. `nullFormat` can be applied only to
  94617. * series which support displaying null points.
  94618. */
  94619. nullFormat?: (boolean|string);
  94620. /**
  94621. * (Highcharts, Highstock, Highmaps, Gantt) Callback JavaScript function
  94622. * that defines formatting for points with the value of null. Works
  94623. * analogously to formatter. `nullPointFormatter` can be applied only to
  94624. * series which support displaying null points.
  94625. */
  94626. nullFormatter?: DataLabelsFormatterCallbackFunction;
  94627. /**
  94628. * (Highcharts, Highstock, Highmaps, Gantt) How to handle data labels that
  94629. * flow outside the plot area. The default is `"justify"`, which aligns them
  94630. * inside the plot area. For columns and bars, this means it will be moved
  94631. * inside the bar. To display data labels outside the plot area, set `crop`
  94632. * to `false` and `overflow` to `"allow"`.
  94633. */
  94634. overflow?: DataLabelsOverflowValue;
  94635. /**
  94636. * (Highcharts, Highstock, Highmaps, Gantt) When either the `borderWidth` or
  94637. * the `backgroundColor` is set, this is the padding within the box.
  94638. */
  94639. padding?: number;
  94640. /**
  94641. * (Highcharts, Highstock, Highmaps, Gantt) Aligns data labels relative to
  94642. * points. If `center` alignment is not possible, it defaults to `right`.
  94643. */
  94644. position?: AlignValue;
  94645. /**
  94646. * (Highcharts, Highstock, Highmaps, Gantt) Text rotation in degrees. Note
  94647. * that due to a more complex structure, backgrounds, borders and padding
  94648. * will be lost on a rotated data label.
  94649. */
  94650. rotation?: number;
  94651. /**
  94652. * (Highcharts, Highstock, Highmaps, Gantt) The shadow of the box. Works
  94653. * best with `borderWidth` or `backgroundColor`. Since 2.3 the shadow can be
  94654. * an object configuration containing `color`, `offsetX`, `offsetY`,
  94655. * `opacity` and `width`.
  94656. */
  94657. shadow?: (boolean|ShadowOptionsObject);
  94658. /**
  94659. * (Highcharts, Highstock, Highmaps, Gantt) The name of a symbol to use for
  94660. * the border around the label. Symbols are predefined functions on the
  94661. * Renderer object.
  94662. */
  94663. shape?: string;
  94664. /**
  94665. * (Highcharts, Highstock, Highmaps, Gantt) Styles for the label. The
  94666. * default `color` setting is `"contrast"`, which is a pseudo color that
  94667. * Highcharts picks up and applies the maximum contrast to the underlying
  94668. * point item, for example the bar in a bar chart.
  94669. *
  94670. * The `textOutline` is a pseudo property that applies an outline of the
  94671. * given width with the given color, which by default is the maximum
  94672. * contrast to the text. So a bright text color will result in a black text
  94673. * outline for maximum readability on a mixed background. In some cases,
  94674. * especially with grayscale text, the text outline doesn't work well, in
  94675. * which cases it can be disabled by setting it to `"none"`. When `useHTML`
  94676. * is true, the `textOutline` will not be picked up. In this, case, the same
  94677. * effect can be acheived through the `text-shadow` CSS property.
  94678. *
  94679. * For some series types, where each point has an extent, like for example
  94680. * tree maps, the data label may overflow the point. There are two
  94681. * strategies for handling overflow. By default, the text will wrap to
  94682. * multiple lines. The other strategy is to set `style.textOverflow` to
  94683. * `ellipsis`, which will keep the text on one line plus it will break
  94684. * inside long words.
  94685. */
  94686. style?: CSSObject;
  94687. /**
  94688. * (Highcharts, Highstock, Highmaps, Gantt) Options for a label text which
  94689. * should follow marker's shape. Border and background are disabled for a
  94690. * label that follows a path.
  94691. *
  94692. * **Note:** Only SVG-based renderer supports this option. Setting `useHTML`
  94693. * to true will disable this option.
  94694. */
  94695. textPath?: DataLabelsTextPathOptionsObject;
  94696. /**
  94697. * (Highcharts, Highstock, Highmaps, Gantt) Whether to use HTML to render
  94698. * the labels.
  94699. */
  94700. useHTML?: boolean;
  94701. /**
  94702. * (Highcharts, Highstock, Highmaps, Gantt) The vertical alignment of a data
  94703. * label. Can be one of `top`, `middle` or `bottom`. The default value
  94704. * depends on the data, for instance in a column chart, the label is above
  94705. * positive values and below negative values.
  94706. */
  94707. verticalAlign?: string;
  94708. /**
  94709. * (Highcharts, Highstock, Highmaps, Gantt) The x position offset of the
  94710. * label relative to the point in pixels.
  94711. */
  94712. x?: number;
  94713. /**
  94714. * (Highcharts, Highstock, Highmaps, Gantt) The y position offset of the
  94715. * label relative to the point in pixels.
  94716. */
  94717. y?: number;
  94718. /**
  94719. * (Highcharts, Highstock, Highmaps, Gantt) The Z index of the data labels.
  94720. * The default Z index puts it above the series. Use a Z index of 2 to
  94721. * display it behind the series.
  94722. */
  94723. z?: number;
  94724. }
  94725. /**
  94726. * (Highcharts) A Venn diagram displays all possible logical relations between a
  94727. * collection of different sets. The sets are represented by circles, and the
  94728. * relation between the sets are displayed by the overlap or lack of overlap
  94729. * between them. The venn diagram is a special case of Euler diagrams, which can
  94730. * also be displayed by this series type.
  94731. *
  94732. * In TypeScript the type option must always be set.
  94733. *
  94734. * Configuration options for the series are given in three levels:
  94735. *
  94736. * 1. Options for all series in a chart are defined in the plotOptions.series
  94737. * object.
  94738. *
  94739. * 2. Options for all `venn` series are defined in plotOptions.venn.
  94740. *
  94741. * 3. Options for one single series are given in the series instance array. (see
  94742. * online documentation for example)
  94743. */
  94744. export interface PlotVennOptions {
  94745. /**
  94746. * (Highcharts) Accessibility options for a series.
  94747. */
  94748. accessibility?: SeriesAccessibilityOptionsObject;
  94749. /**
  94750. * (Highmaps) Whether all areas of the map defined in `mapData` should be
  94751. * rendered. If `true`, areas which don't correspond to a data point, are
  94752. * rendered as `null` points. If `false`, those areas are skipped.
  94753. */
  94754. allAreas?: boolean;
  94755. /**
  94756. * (Highcharts) Allow this series' points to be selected by clicking on the
  94757. * graphic (columns, point markers, pie slices, map areas etc).
  94758. *
  94759. * The selected points can be handled by point select and unselect events,
  94760. * or collectively by the getSelectedPoints function.
  94761. *
  94762. * And alternative way of selecting points is through dragging.
  94763. */
  94764. allowPointSelect?: boolean;
  94765. /**
  94766. * (Highcharts) Enable or disable the initial animation when a series is
  94767. * displayed. The animation can also be set as a configuration object.
  94768. * Please note that this option only applies to the initial animation of the
  94769. * series itself. For other animations, see chart.animation and the
  94770. * animation parameter under the API methods. The following properties are
  94771. * supported:
  94772. *
  94773. * - `defer`: The animation delay time in milliseconds.
  94774. *
  94775. * - `duration`: The duration of the animation in milliseconds.
  94776. *
  94777. * - `easing`: Can be a string reference to an easing function set on the
  94778. * `Math` object or a function. See the _Custom easing function_ demo below.
  94779. *
  94780. * Due to poor performance, animation is disabled in old IE browsers for
  94781. * several chart types.
  94782. */
  94783. animation?: (boolean|PlotVennAnimationOptions|Partial<AnimationOptionsObject>);
  94784. /**
  94785. * (Highcharts) For some series, there is a limit that shuts down initial
  94786. * animation by default when the total number of points in the chart is too
  94787. * high. For example, for a column chart and its derivatives, animation does
  94788. * not run if there is more than 250 points totally. To disable this cap,
  94789. * set `animationLimit` to `Infinity`.
  94790. */
  94791. animationLimit?: number;
  94792. /**
  94793. * (Highmaps) The border color of the map areas.
  94794. *
  94795. * In styled mode, the border stroke is given in the `.highcharts-point`
  94796. * class.
  94797. */
  94798. borderColor?: string;
  94799. borderDashStyle?: string;
  94800. /**
  94801. * (Highmaps) The border width of each map area.
  94802. *
  94803. * In styled mode, the border stroke width is given in the
  94804. * `.highcharts-point` class.
  94805. */
  94806. borderWidth?: number;
  94807. brighten?: number;
  94808. /**
  94809. * (Highcharts) An additional class name to apply to the series' graphical
  94810. * elements. This option does not replace default class names of the
  94811. * graphical element.
  94812. */
  94813. className?: string;
  94814. /**
  94815. * (Highcharts) Disable this option to allow series rendering in the whole
  94816. * plotting area.
  94817. *
  94818. * **Note:** Clipping should be always enabled when chart.zoomType is set
  94819. */
  94820. clip?: boolean;
  94821. /**
  94822. * (Highcharts, Highmaps) Options for marker clusters, the concept of
  94823. * sampling the data values into larger blocks in order to ease readability
  94824. * and increase performance of the JavaScript charts.
  94825. *
  94826. * Note: marker clusters module is not working with `boost` and
  94827. * `draggable-points` modules.
  94828. *
  94829. * The marker clusters feature requires the marker-clusters.js file to be
  94830. * loaded, found in the modules directory of the download package, or online
  94831. * at code.highcharts.com/modules/marker-clusters.js.
  94832. */
  94833. cluster?: PlotVennClusterOptions;
  94834. /**
  94835. * (Highcharts) The main color of the series. In line type series it applies
  94836. * to the line and the point markers unless otherwise specified. In bar type
  94837. * series it applies to the bars unless a color is specified per point. The
  94838. * default value is pulled from the `options.colors` array.
  94839. *
  94840. * In styled mode, the color can be defined by the colorIndex option. Also,
  94841. * the series color can be set with the `.highcharts-series`,
  94842. * `.highcharts-color-{n}`, `.highcharts-{type}-series` or
  94843. * `.highcharts-series-{n}` class, or individual classes given by the
  94844. * `className` option.
  94845. */
  94846. color?: (ColorString|GradientColorObject|PatternObject);
  94847. /**
  94848. * (Highcharts, Highstock, Highmaps) When using dual or multiple color axes,
  94849. * this number defines which colorAxis the particular series is connected
  94850. * to. It refers to either the axis id or the index of the axis in the
  94851. * colorAxis array, with 0 being the first. Set this option to false to
  94852. * prevent a series from connecting to the default color axis.
  94853. *
  94854. * Since v7.2.0 the option can also be an axis id or an axis index instead
  94855. * of a boolean flag.
  94856. */
  94857. colorAxis?: (boolean|number|string);
  94858. colorByPoint?: boolean;
  94859. /**
  94860. * (Highcharts) Styled mode only. A specific color index to use for the
  94861. * series, so its graphic representations are given the class name
  94862. * `highcharts-color-{n}`.
  94863. */
  94864. colorIndex?: number;
  94865. /**
  94866. * (Highcharts, Highstock, Highmaps) Determines what data value should be
  94867. * used to calculate point color if `colorAxis` is used. Requires to set
  94868. * `min` and `max` if some custom point property is used or if approximation
  94869. * for data grouping is set to `'sum'`.
  94870. */
  94871. colorKey?: string;
  94872. /**
  94873. * (Highstock) Compare the values of the series against the first non-null,
  94874. * non- zero value in the visible range. The y axis will show percentage or
  94875. * absolute change depending on whether `compare` is set to `"percent"` or
  94876. * `"value"`. When this is applied to multiple series, it allows comparing
  94877. * the development of the series against each other. Adds a `change` field
  94878. * to every point object.
  94879. */
  94880. compare?: string;
  94881. /**
  94882. * (Highstock) When compare is `percent`, this option dictates whether to
  94883. * use 0 or 100 as the base of comparison.
  94884. */
  94885. compareBase?: (0|100);
  94886. /**
  94887. * (Highstock) Defines if comparison should start from the first point
  94888. * within the visible range or should start from the first point **before**
  94889. * the range.
  94890. *
  94891. * In other words, this flag determines if first point within the visible
  94892. * range will have 0% (`compareStart=true`) or should have been already
  94893. * calculated according to the previous point (`compareStart=false`).
  94894. */
  94895. compareStart?: boolean;
  94896. /**
  94897. * (Gantt) Override Pathfinder connector options for a series. Requires
  94898. * Highcharts Gantt to be loaded.
  94899. */
  94900. connectors?: SeriesConnectorsOptionsObject;
  94901. /**
  94902. * (Highcharts, Highstock, Gantt) When true, each point or column edge is
  94903. * rounded to its nearest pixel in order to render sharp on screen. In some
  94904. * cases, when there are a lot of densely packed columns, this leads to
  94905. * visible difference in column widths or distance between columns. In these
  94906. * cases, setting `crisp` to `false` may look better, even though each
  94907. * column is rendered blurry.
  94908. */
  94909. crisp?: boolean;
  94910. /**
  94911. * (Highcharts) You can set the cursor to "pointer" if you have click events
  94912. * attached to the series, to signal to the user that the points and lines
  94913. * can be clicked.
  94914. *
  94915. * In styled mode, the series cursor can be set with the same classes as
  94916. * listed under series.color.
  94917. */
  94918. cursor?: (string|CursorValue);
  94919. /**
  94920. * (Highcharts) A reserved subspace to store options and values for
  94921. * customized functionality. Here you can add additional data for your own
  94922. * event callbacks and formatter callbacks.
  94923. */
  94924. custom?: Dictionary<any>;
  94925. /**
  94926. * (Highcharts) Name of the dash style to use for the graph, or for some
  94927. * series types the outline of each shape.
  94928. *
  94929. * In styled mode, the stroke dash-array can be set with the same classes as
  94930. * listed under series.color.
  94931. */
  94932. dashStyle?: DashStyleValue;
  94933. /**
  94934. * (Highstock) Data grouping is the concept of sampling the data values into
  94935. * larger blocks in order to ease readability and increase performance of
  94936. * the JavaScript charts. Highstock by default applies data grouping when
  94937. * the points become closer than a certain pixel value, determined by the
  94938. * `groupPixelWidth` option.
  94939. *
  94940. * If data grouping is applied, the grouping information of grouped points
  94941. * can be read from the Point.dataGroup. If point options other than the
  94942. * data itself are set, for example `name` or `color` or custom properties,
  94943. * the grouping logic doesn't know how to group it. In this case the options
  94944. * of the first point instance are copied over to the group point. This can
  94945. * be altered through a custom `approximation` callback function.
  94946. */
  94947. dataGrouping?: DataGroupingOptionsObject;
  94948. /**
  94949. * (Highcharts, Highstock, Highmaps, Gantt) Options for the series data
  94950. * labels, appearing next to each data point.
  94951. *
  94952. * Since v6.2.0, multiple data labels can be applied to each single point by
  94953. * defining them as an array of configs.
  94954. *
  94955. * In styled mode, the data labels can be styled with the
  94956. * `.highcharts-data-label-box` and `.highcharts-data-label` class names
  94957. * (see example).
  94958. */
  94959. dataLabels?: (PlotVennDataLabelsOptions|Array<PlotVennDataLabelsOptions>);
  94960. /**
  94961. * (Highcharts) A description of the series to add to the screen reader
  94962. * information about the series.
  94963. */
  94964. description?: string;
  94965. /**
  94966. * (Highcharts) Enable or disable the mouse tracking for a specific series.
  94967. * This includes point tooltips and click events on graphs and points. For
  94968. * large datasets it improves performance.
  94969. */
  94970. enableMouseTracking?: boolean;
  94971. /**
  94972. * (Highcharts) General event handlers for the series items. These event
  94973. * hooks can also be attached to the series at run time using the
  94974. * `Highcharts.addEvent` function.
  94975. */
  94976. events?: SeriesEventsOptionsObject;
  94977. /**
  94978. * (Highstock) Defines when to display a gap in the graph, together with the
  94979. * gapUnit option.
  94980. *
  94981. * In case when `dataGrouping` is enabled, points can be grouped into a
  94982. * larger time span. This can make the grouped points to have a greater
  94983. * distance than the absolute value of `gapSize` property, which will result
  94984. * in disappearing graph completely. To prevent this situation the mentioned
  94985. * distance between grouped points is used instead of previously defined
  94986. * `gapSize`.
  94987. *
  94988. * In practice, this option is most often used to visualize gaps in time
  94989. * series. In a stock chart, intraday data is available for daytime hours,
  94990. * while gaps will appear in nights and weekends.
  94991. */
  94992. gapSize?: number;
  94993. /**
  94994. * (Highstock) Together with gapSize, this option defines where to draw gaps
  94995. * in the graph.
  94996. *
  94997. * When the `gapUnit` is `"relative"` (default), a gap size of 5 means that
  94998. * if the distance between two points is greater than 5 times that of the
  94999. * two closest points, the graph will be broken.
  95000. *
  95001. * When the `gapUnit` is `"value"`, the gap is based on absolute axis
  95002. * values, which on a datetime axis is milliseconds. This also applies to
  95003. * the navigator series that inherits gap options from the base series.
  95004. */
  95005. gapUnit?: OptionsGapUnitValue;
  95006. /**
  95007. * (Highcharts) When set to `false` will prevent the series data from being
  95008. * included in any form of data export.
  95009. *
  95010. * Since version 6.0.0 until 7.1.0 the option was existing undocumented as
  95011. * `includeInCSVExport`.
  95012. */
  95013. includeInDataExport?: boolean;
  95014. /**
  95015. * (Highmaps) What property to join the `mapData` to the value data. For
  95016. * example, if joinBy is "code", the mapData items with a specific code is
  95017. * merged into the data with the same code. For maps loaded from GeoJSON,
  95018. * the keys may be held in each point's `properties` object.
  95019. *
  95020. * The joinBy option can also be an array of two values, where the first
  95021. * points to a key in the `mapData`, and the second points to another key in
  95022. * the `data`.
  95023. *
  95024. * When joinBy is `null`, the map items are joined by their position in the
  95025. * array, which performs much better in maps with many data points. This is
  95026. * the recommended option if you are printing more than a thousand data
  95027. * points and have a backend that can preprocess the data into a parallel
  95028. * array of the mapData.
  95029. */
  95030. joinBy?: (string|Array<string>);
  95031. /**
  95032. * (Highcharts) An array specifying which option maps to which key in the
  95033. * data point array. This makes it convenient to work with unstructured data
  95034. * arrays from different sources.
  95035. */
  95036. keys?: Array<string>;
  95037. /**
  95038. * (Highstock) The line marks the last price from all points.
  95039. */
  95040. lastPrice?: SeriesLastPriceOptionsObject;
  95041. /**
  95042. * (Highstock) The line marks the last price from visible range of points.
  95043. */
  95044. lastVisiblePrice?: SeriesLastVisiblePriceOptionsObject;
  95045. marker?: boolean;
  95046. /**
  95047. * (Highstock) Options for the corresponding navigator series if
  95048. * `showInNavigator` is `true` for this series. Available options are the
  95049. * same as any series, documented at plotOptions and series.
  95050. *
  95051. * These options are merged with options in navigator.series, and will take
  95052. * precedence if the same option is defined both places.
  95053. */
  95054. navigatorOptions?: PlotSeriesOptions;
  95055. /**
  95056. * (Highcharts) Opacity of a series parts: line, fill (e.g. area) and
  95057. * dataLabels.
  95058. */
  95059. opacity?: number;
  95060. /**
  95061. * (Highcharts) Properties for each single point.
  95062. */
  95063. point?: PlotSeriesPointOptions;
  95064. /**
  95065. * (Highcharts) Same as accessibility.pointDescriptionFormatter, but for an
  95066. * individual series. Overrides the chart wide configuration.
  95067. */
  95068. pointDescriptionFormatter?: Function;
  95069. /**
  95070. * (Highstock) The width of each point on the x axis. For example in a
  95071. * column chart with one value each day, the pointRange would be 1 day (= 24
  95072. * * 3600
  95073. *
  95074. * * 1000 milliseconds). This is normally computed automatically, but this
  95075. * option can be used to override the automatic value.
  95076. */
  95077. pointRange?: number;
  95078. /**
  95079. * (Highcharts) Whether to select the series initially. If `showCheckbox` is
  95080. * true, the checkbox next to the series name in the legend will be checked
  95081. * for a selected series.
  95082. */
  95083. selected?: boolean;
  95084. /**
  95085. * (Highcharts) If true, a checkbox is displayed next to the legend item to
  95086. * allow selecting the series. The state of the checkbox is determined by
  95087. * the `selected` option.
  95088. */
  95089. showCheckbox?: boolean;
  95090. /**
  95091. * (Highcharts) Whether to display this particular series or series type in
  95092. * the legend. Standalone series are shown in legend by default, and linked
  95093. * series are not. Since v7.2.0 it is possible to show series that use
  95094. * colorAxis by setting this option to `true`.
  95095. */
  95096. showInLegend?: boolean;
  95097. /**
  95098. * (Highstock) Whether or not to show the series in the navigator. Takes
  95099. * precedence over navigator.baseSeries if defined.
  95100. */
  95101. showInNavigator?: boolean;
  95102. /**
  95103. * (Highcharts) If set to `true`, the accessibility module will skip past
  95104. * the points in this series for keyboard navigation.
  95105. */
  95106. skipKeyboardNavigation?: boolean;
  95107. states?: SeriesStatesOptionsObject;
  95108. /**
  95109. * (Highcharts, Highstock) Whether to apply steps to the line. Possible
  95110. * values are `left`, `center` and `right`.
  95111. */
  95112. step?: OptionsStepValue;
  95113. /**
  95114. * (Highcharts, Highstock) Sticky tracking of mouse events. When true, the
  95115. * `mouseOut` event on a series isn't triggered until the mouse moves over
  95116. * another series, or out of the plot area. When false, the `mouseOut` event
  95117. * on a series is triggered when the mouse leaves the area around the
  95118. * series' graph or markers. This also implies the tooltip. When
  95119. * `stickyTracking` is false and `tooltip.shared` is false, the tooltip will
  95120. * be hidden when moving the mouse between series.
  95121. */
  95122. stickyTracking?: boolean;
  95123. /**
  95124. * (Highcharts, Highstock) A configuration object for the tooltip rendering
  95125. * of each single series. Properties are inherited from tooltip. Overridable
  95126. * properties are `headerFormat`, `pointFormat`, `yDecimals`, `xDateFormat`,
  95127. * `yPrefix` and `ySuffix`. Unlike other series, in a scatter plot the
  95128. * series.name by default shows in the headerFormat and point.x and point.y
  95129. * in the pointFormat.
  95130. */
  95131. tooltip?: SeriesTooltipOptionsObject;
  95132. /**
  95133. * (Highcharts, Highstock, Gantt) When a series contains a data array that
  95134. * is longer than this, only one dimensional arrays of numbers, or two
  95135. * dimensional arrays with x and y values are allowed. Also, only the first
  95136. * point is tested, and the rest are assumed to be the same format. This
  95137. * saves expensive data checking and indexing in long series. Set it to `0`
  95138. * disable.
  95139. *
  95140. * Note: In boost mode turbo threshold is forced. Only array of numbers or
  95141. * two dimensional arrays are allowed.
  95142. */
  95143. turboThreshold?: number;
  95144. /**
  95145. * (Highcharts) Set the initial visibility of the series.
  95146. */
  95147. visible?: boolean;
  95148. /**
  95149. * (Highmaps) Define the z index of the series.
  95150. */
  95151. zIndex?: number;
  95152. }
  95153. /**
  95154. * (Highstock) Enable or disable the initial animation when a series is
  95155. * displayed. The animation can also be set as a configuration object. Please
  95156. * note that this option only applies to the initial animation of the series
  95157. * itself. For other animations, see chart.animation and the animation parameter
  95158. * under the API methods. The following properties are supported:
  95159. *
  95160. * - `defer`: The animation delay time in milliseconds.
  95161. *
  95162. * - `duration`: The duration of the animation in milliseconds.
  95163. *
  95164. * - `easing`: Can be a string reference to an easing function set on the `Math`
  95165. * object or a function. See the _Custom easing function_ demo below.
  95166. *
  95167. * Due to poor performance, animation is disabled in old IE browsers for several
  95168. * chart types.
  95169. */
  95170. export interface PlotVwapAnimationOptions {
  95171. defer?: number;
  95172. }
  95173. /**
  95174. * (Highcharts, Highstock, Highmaps, Gantt) Enable or disable the initial
  95175. * animation when a series is displayed for the `dataLabels`. The animation can
  95176. * also be set as a configuration object. Please note that this option only
  95177. * applies to the initial animation. For other animations, see chart.animation
  95178. * and the animation parameter under the API methods. The following properties
  95179. * are supported:
  95180. *
  95181. * - `defer`: The animation delay time in milliseconds.
  95182. */
  95183. export interface PlotVwapDataLabelsAnimationOptions {
  95184. /**
  95185. * (Highcharts, Highstock, Highmaps, Gantt) The animation delay time in
  95186. * milliseconds. Set to `0` renders dataLabel immediately. As `undefined`
  95187. * inherits defer time from the series.animation.defer.
  95188. */
  95189. defer?: number;
  95190. }
  95191. /**
  95192. * (Highcharts, Highstock, Highmaps, Gantt) Options for the series data labels,
  95193. * appearing next to each data point.
  95194. *
  95195. * Since v6.2.0, multiple data labels can be applied to each single point by
  95196. * defining them as an array of configs.
  95197. *
  95198. * In styled mode, the data labels can be styled with the
  95199. * `.highcharts-data-label-box` and `.highcharts-data-label` class names (see
  95200. * example).
  95201. */
  95202. export interface PlotVwapDataLabelsOptions {
  95203. /**
  95204. * (Highcharts, Highstock, Highmaps, Gantt) The alignment of the data label
  95205. * compared to the point. If `right`, the right side of the label should be
  95206. * touching the point. For points with an extent, like columns, the
  95207. * alignments also dictates how to align it inside the box, as given with
  95208. * the inside option. Can be one of `left`, `center` or `right`.
  95209. */
  95210. align?: (AlignValue|null);
  95211. /**
  95212. * (Highcharts, Highstock, Highmaps, Gantt) Whether to allow data labels to
  95213. * overlap. To make the labels less sensitive for overlapping, the
  95214. * dataLabels.padding can be set to 0.
  95215. */
  95216. allowOverlap?: boolean;
  95217. /**
  95218. * (Highcharts, Highstock, Highmaps, Gantt) Enable or disable the initial
  95219. * animation when a series is displayed for the `dataLabels`. The animation
  95220. * can also be set as a configuration object. Please note that this option
  95221. * only applies to the initial animation. For other animations, see
  95222. * chart.animation and the animation parameter under the API methods. The
  95223. * following properties are supported:
  95224. *
  95225. * - `defer`: The animation delay time in milliseconds.
  95226. */
  95227. animation?: (boolean|PlotVwapDataLabelsAnimationOptions|Partial<AnimationOptionsObject>);
  95228. /**
  95229. * (Highcharts, Highstock, Highmaps, Gantt) The background color or gradient
  95230. * for the data label.
  95231. */
  95232. backgroundColor?: (ColorString|GradientColorObject|PatternObject);
  95233. /**
  95234. * (Highcharts, Highstock, Highmaps, Gantt) The border color for the data
  95235. * label. Defaults to `undefined`.
  95236. */
  95237. borderColor?: (ColorString|GradientColorObject|PatternObject);
  95238. /**
  95239. * (Highcharts, Highstock, Highmaps, Gantt) The border radius in pixels for
  95240. * the data label.
  95241. */
  95242. borderRadius?: number;
  95243. /**
  95244. * (Highcharts, Highstock, Highmaps, Gantt) The border width in pixels for
  95245. * the data label.
  95246. */
  95247. borderWidth?: number;
  95248. /**
  95249. * (Highcharts, Highstock, Highmaps, Gantt) A class name for the data label.
  95250. * Particularly in styled mode, this can be used to give each series' or
  95251. * point's data label unique styling. In addition to this option, a default
  95252. * color class name is added so that we can give the labels a contrast text
  95253. * shadow.
  95254. */
  95255. className?: string;
  95256. /**
  95257. * (Highcharts, Highstock, Highmaps, Gantt) The text color for the data
  95258. * labels. Defaults to `undefined`. For certain series types, like column or
  95259. * map, the data labels can be drawn inside the points. In this case the
  95260. * data label will be drawn with maximum contrast by default. Additionally,
  95261. * it will be given a `text-outline` style with the opposite color, to
  95262. * further increase the contrast. This can be overridden by setting the
  95263. * `text-outline` style to `none` in the `dataLabels.style` option.
  95264. */
  95265. color?: (ColorString|GradientColorObject|PatternObject);
  95266. /**
  95267. * (Highcharts, Highstock, Highmaps, Gantt) Whether to hide data labels that
  95268. * are outside the plot area. By default, the data label is moved inside the
  95269. * plot area according to the overflow option.
  95270. */
  95271. crop?: boolean;
  95272. /**
  95273. * (Highcharts, Highstock, Gantt) Whether to defer displaying the data
  95274. * labels until the initial series animation has finished. Setting to
  95275. * `false` renders the data label immediately. If set to `true` inherits the
  95276. * defer time set in plotOptions.series.animation.
  95277. */
  95278. defer?: boolean;
  95279. /**
  95280. * (Highcharts, Highstock, Highmaps, Gantt) Enable or disable the data
  95281. * labels.
  95282. */
  95283. enabled?: boolean;
  95284. /**
  95285. * (Highcharts, Highstock, Highmaps, Gantt) A declarative filter to control
  95286. * of which data labels to display. The declarative filter is designed for
  95287. * use when callback functions are not available, like when the chart
  95288. * options require a pure JSON structure or for use with graphical editors.
  95289. * For programmatic control, use the `formatter` instead, and return
  95290. * `undefined` to disable a single data label.
  95291. */
  95292. filter?: DataLabelsFilterOptionsObject;
  95293. /**
  95294. * (Highcharts, Highstock, Highmaps, Gantt) A format string for the data
  95295. * label. Available variables are the same as for `formatter`.
  95296. */
  95297. format?: string;
  95298. /**
  95299. * (Highcharts, Highstock, Highmaps, Gantt) Callback JavaScript function to
  95300. * format the data label. Note that if a `format` is defined, the format
  95301. * takes precedence and the formatter is ignored.
  95302. */
  95303. formatter?: DataLabelsFormatterCallbackFunction;
  95304. /**
  95305. * (Highcharts, Highstock, Highmaps, Gantt) For points with an extent, like
  95306. * columns or map areas, whether to align the data label inside the box or
  95307. * to the actual value point. Defaults to `false` in most cases, `true` in
  95308. * stacked columns.
  95309. */
  95310. inside?: boolean;
  95311. /**
  95312. * (Highcharts, Highstock, Highmaps, Gantt) Format for points with the value
  95313. * of null. Works analogously to format. `nullFormat` can be applied only to
  95314. * series which support displaying null points.
  95315. */
  95316. nullFormat?: (boolean|string);
  95317. /**
  95318. * (Highcharts, Highstock, Highmaps, Gantt) Callback JavaScript function
  95319. * that defines formatting for points with the value of null. Works
  95320. * analogously to formatter. `nullPointFormatter` can be applied only to
  95321. * series which support displaying null points.
  95322. */
  95323. nullFormatter?: DataLabelsFormatterCallbackFunction;
  95324. /**
  95325. * (Highcharts, Highstock, Highmaps, Gantt) How to handle data labels that
  95326. * flow outside the plot area. The default is `"justify"`, which aligns them
  95327. * inside the plot area. For columns and bars, this means it will be moved
  95328. * inside the bar. To display data labels outside the plot area, set `crop`
  95329. * to `false` and `overflow` to `"allow"`.
  95330. */
  95331. overflow?: DataLabelsOverflowValue;
  95332. /**
  95333. * (Highcharts, Highstock, Highmaps, Gantt) When either the `borderWidth` or
  95334. * the `backgroundColor` is set, this is the padding within the box.
  95335. */
  95336. padding?: number;
  95337. /**
  95338. * (Highcharts, Highstock, Highmaps, Gantt) Aligns data labels relative to
  95339. * points. If `center` alignment is not possible, it defaults to `right`.
  95340. */
  95341. position?: AlignValue;
  95342. /**
  95343. * (Highcharts, Highstock, Highmaps, Gantt) Text rotation in degrees. Note
  95344. * that due to a more complex structure, backgrounds, borders and padding
  95345. * will be lost on a rotated data label.
  95346. */
  95347. rotation?: number;
  95348. /**
  95349. * (Highcharts, Highstock, Highmaps, Gantt) The shadow of the box. Works
  95350. * best with `borderWidth` or `backgroundColor`. Since 2.3 the shadow can be
  95351. * an object configuration containing `color`, `offsetX`, `offsetY`,
  95352. * `opacity` and `width`.
  95353. */
  95354. shadow?: (boolean|ShadowOptionsObject);
  95355. /**
  95356. * (Highcharts, Highstock, Highmaps, Gantt) The name of a symbol to use for
  95357. * the border around the label. Symbols are predefined functions on the
  95358. * Renderer object.
  95359. */
  95360. shape?: string;
  95361. /**
  95362. * (Highcharts, Highstock, Highmaps, Gantt) Styles for the label. The
  95363. * default `color` setting is `"contrast"`, which is a pseudo color that
  95364. * Highcharts picks up and applies the maximum contrast to the underlying
  95365. * point item, for example the bar in a bar chart.
  95366. *
  95367. * The `textOutline` is a pseudo property that applies an outline of the
  95368. * given width with the given color, which by default is the maximum
  95369. * contrast to the text. So a bright text color will result in a black text
  95370. * outline for maximum readability on a mixed background. In some cases,
  95371. * especially with grayscale text, the text outline doesn't work well, in
  95372. * which cases it can be disabled by setting it to `"none"`. When `useHTML`
  95373. * is true, the `textOutline` will not be picked up. In this, case, the same
  95374. * effect can be acheived through the `text-shadow` CSS property.
  95375. *
  95376. * For some series types, where each point has an extent, like for example
  95377. * tree maps, the data label may overflow the point. There are two
  95378. * strategies for handling overflow. By default, the text will wrap to
  95379. * multiple lines. The other strategy is to set `style.textOverflow` to
  95380. * `ellipsis`, which will keep the text on one line plus it will break
  95381. * inside long words.
  95382. */
  95383. style?: CSSObject;
  95384. /**
  95385. * (Highcharts, Highstock, Highmaps, Gantt) Options for a label text which
  95386. * should follow marker's shape. Border and background are disabled for a
  95387. * label that follows a path.
  95388. *
  95389. * **Note:** Only SVG-based renderer supports this option. Setting `useHTML`
  95390. * to true will disable this option.
  95391. */
  95392. textPath?: DataLabelsTextPathOptionsObject;
  95393. /**
  95394. * (Highcharts, Highstock, Highmaps, Gantt) Whether to use HTML to render
  95395. * the labels.
  95396. */
  95397. useHTML?: boolean;
  95398. /**
  95399. * (Highcharts, Highstock, Highmaps, Gantt) The vertical alignment of a data
  95400. * label. Can be one of `top`, `middle` or `bottom`. The default value
  95401. * depends on the data, for instance in a column chart, the label is above
  95402. * positive values and below negative values.
  95403. */
  95404. verticalAlign?: (VerticalAlignValue|null);
  95405. /**
  95406. * (Highcharts, Highstock, Highmaps, Gantt) The x position offset of the
  95407. * label relative to the point in pixels.
  95408. */
  95409. x?: number;
  95410. /**
  95411. * (Highcharts, Highstock, Highmaps, Gantt) The y position offset of the
  95412. * label relative to the point in pixels.
  95413. */
  95414. y?: number;
  95415. /**
  95416. * (Highcharts, Highstock, Highmaps, Gantt) The Z index of the data labels.
  95417. * The default Z index puts it above the series. Use a Z index of 2 to
  95418. * display it behind the series.
  95419. */
  95420. z?: number;
  95421. }
  95422. /**
  95423. * (Highcharts, Highstock) Options for the series data sorting.
  95424. */
  95425. export interface PlotVwapDataSortingOptions {
  95426. /**
  95427. * (Highcharts, Highstock) Enable or disable data sorting for the series.
  95428. * Use xAxis.reversed to change the sorting order.
  95429. */
  95430. enabled?: boolean;
  95431. /**
  95432. * (Highcharts, Highstock) Whether to allow matching points by name in an
  95433. * update. If this option is disabled, points will be matched by order.
  95434. */
  95435. matchByName?: boolean;
  95436. /**
  95437. * (Highcharts, Highstock) Determines what data value should be used to sort
  95438. * by.
  95439. */
  95440. sortKey?: string;
  95441. }
  95442. /**
  95443. * (Highstock) Volume Weighted Average Price indicator.
  95444. *
  95445. * This series requires `linkedTo` option to be set.
  95446. *
  95447. * In TypeScript the type option must always be set.
  95448. *
  95449. * Configuration options for the series are given in three levels:
  95450. *
  95451. * 1. Options for all series in a chart are defined in the plotOptions.series
  95452. * object.
  95453. *
  95454. * 2. Options for all `vwap` series are defined in plotOptions.vwap.
  95455. *
  95456. * 3. Options for one single series are given in the series instance array. (see
  95457. * online documentation for example)
  95458. */
  95459. export interface PlotVwapOptions {
  95460. /**
  95461. * (Highstock) Accessibility options for a series.
  95462. */
  95463. accessibility?: SeriesAccessibilityOptionsObject;
  95464. /**
  95465. * (Highstock) Allow this series' points to be selected by clicking on the
  95466. * graphic (columns, point markers, pie slices, map areas etc).
  95467. *
  95468. * The selected points can be handled by point select and unselect events,
  95469. * or collectively by the getSelectedPoints function.
  95470. *
  95471. * And alternative way of selecting points is through dragging.
  95472. */
  95473. allowPointSelect?: boolean;
  95474. /**
  95475. * (Highstock) Enable or disable the initial animation when a series is
  95476. * displayed. The animation can also be set as a configuration object.
  95477. * Please note that this option only applies to the initial animation of the
  95478. * series itself. For other animations, see chart.animation and the
  95479. * animation parameter under the API methods. The following properties are
  95480. * supported:
  95481. *
  95482. * - `defer`: The animation delay time in milliseconds.
  95483. *
  95484. * - `duration`: The duration of the animation in milliseconds.
  95485. *
  95486. * - `easing`: Can be a string reference to an easing function set on the
  95487. * `Math` object or a function. See the _Custom easing function_ demo below.
  95488. *
  95489. * Due to poor performance, animation is disabled in old IE browsers for
  95490. * several chart types.
  95491. */
  95492. animation?: (boolean|PlotVwapAnimationOptions|Partial<AnimationOptionsObject>);
  95493. /**
  95494. * (Highstock) For some series, there is a limit that shuts down initial
  95495. * animation by default when the total number of points in the chart is too
  95496. * high. For example, for a column chart and its derivatives, animation does
  95497. * not run if there is more than 250 points totally. To disable this cap,
  95498. * set `animationLimit` to `Infinity`.
  95499. */
  95500. animationLimit?: number;
  95501. /**
  95502. * (Highstock) Sets the color blending in the boost module.
  95503. */
  95504. boostBlending?: OptionsBoostBlendingValue;
  95505. /**
  95506. * (Highstock) Set the point threshold for when a series should enter boost
  95507. * mode.
  95508. *
  95509. * Setting it to e.g. 2000 will cause the series to enter boost mode when
  95510. * there are 2000 or more points in the series.
  95511. *
  95512. * To disable boosting on the series, set the `boostThreshold` to 0. Setting
  95513. * it to 1 will force boosting.
  95514. *
  95515. * Note that the cropThreshold also affects this setting. When zooming in on
  95516. * a series that has fewer points than the `cropThreshold`, all points are
  95517. * rendered although outside the visible plot area, and the `boostThreshold`
  95518. * won't take effect.
  95519. */
  95520. boostThreshold?: number;
  95521. /**
  95522. * (Highmaps) The border color of the map areas.
  95523. *
  95524. * In styled mode, the border stroke is given in the `.highcharts-point`
  95525. * class.
  95526. */
  95527. borderColor?: (ColorString|GradientColorObject|PatternObject);
  95528. /**
  95529. * (Highmaps) The border width of each map area.
  95530. *
  95531. * In styled mode, the border stroke width is given in the
  95532. * `.highcharts-point` class.
  95533. */
  95534. borderWidth?: number;
  95535. /**
  95536. * (Highstock) An additional class name to apply to the series' graphical
  95537. * elements. This option does not replace default class names of the
  95538. * graphical element.
  95539. */
  95540. className?: string;
  95541. /**
  95542. * (Highstock) Disable this option to allow series rendering in the whole
  95543. * plotting area.
  95544. *
  95545. * **Note:** Clipping should be always enabled when chart.zoomType is set
  95546. */
  95547. clip?: boolean;
  95548. /**
  95549. * (Highstock) The main color of the series. In line type series it applies
  95550. * to the line and the point markers unless otherwise specified. In bar type
  95551. * series it applies to the bars unless a color is specified per point. The
  95552. * default value is pulled from the `options.colors` array.
  95553. *
  95554. * In styled mode, the color can be defined by the colorIndex option. Also,
  95555. * the series color can be set with the `.highcharts-series`,
  95556. * `.highcharts-color-{n}`, `.highcharts-{type}-series` or
  95557. * `.highcharts-series-{n}` class, or individual classes given by the
  95558. * `className` option.
  95559. */
  95560. color?: (ColorString|GradientColorObject|PatternObject);
  95561. /**
  95562. * (Highstock) Styled mode only. A specific color index to use for the
  95563. * series, so its graphic representations are given the class name
  95564. * `highcharts-color-{n}`.
  95565. */
  95566. colorIndex?: number;
  95567. /**
  95568. * (Highcharts, Highstock, Highmaps) Determines what data value should be
  95569. * used to calculate point color if `colorAxis` is used. Requires to set
  95570. * `min` and `max` if some custom point property is used or if approximation
  95571. * for data grouping is set to `'sum'`.
  95572. */
  95573. colorKey?: string;
  95574. /**
  95575. * (Highstock) Compare the values of the series against the first non-null,
  95576. * non- zero value in the visible range. The y axis will show percentage or
  95577. * absolute change depending on whether `compare` is set to `"percent"` or
  95578. * `"value"`. When this is applied to multiple series, it allows comparing
  95579. * the development of the series against each other. Adds a `change` field
  95580. * to every point object.
  95581. */
  95582. compare?: string;
  95583. /**
  95584. * (Highstock) When compare is `percent`, this option dictates whether to
  95585. * use 0 or 100 as the base of comparison.
  95586. */
  95587. compareBase?: (0|100);
  95588. /**
  95589. * (Highstock) Defines if comparison should start from the first point
  95590. * within the visible range or should start from the first point **before**
  95591. * the range.
  95592. *
  95593. * In other words, this flag determines if first point within the visible
  95594. * range will have 0% (`compareStart=true`) or should have been already
  95595. * calculated according to the previous point (`compareStart=false`).
  95596. */
  95597. compareStart?: boolean;
  95598. /**
  95599. * (Highstock) Whether to compare indicator to the main series values or
  95600. * indicator values.
  95601. */
  95602. compareToMain?: boolean;
  95603. /**
  95604. * (Highcharts) Polar charts only. Whether to connect the ends of a line
  95605. * series plot across the extremes.
  95606. */
  95607. connectEnds?: boolean;
  95608. /**
  95609. * (Highcharts, Highstock) Whether to connect a graph line across null
  95610. * points, or render a gap between the two points on either side of the
  95611. * null.
  95612. */
  95613. connectNulls?: boolean;
  95614. /**
  95615. * (Gantt) Override Pathfinder connector options for a series. Requires
  95616. * Highcharts Gantt to be loaded.
  95617. */
  95618. connectors?: SeriesConnectorsOptionsObject;
  95619. /**
  95620. * (Highcharts, Highstock, Gantt) When true, each point or column edge is
  95621. * rounded to its nearest pixel in order to render sharp on screen. In some
  95622. * cases, when there are a lot of densely packed columns, this leads to
  95623. * visible difference in column widths or distance between columns. In these
  95624. * cases, setting `crisp` to `false` may look better, even though each
  95625. * column is rendered blurry.
  95626. */
  95627. crisp?: boolean;
  95628. /**
  95629. * (Highcharts, Highstock) When the series contains less points than the
  95630. * crop threshold, all points are drawn, even if the points fall outside the
  95631. * visible plot area at the current zoom. The advantage of drawing all
  95632. * points (including markers and columns), is that animation is performed on
  95633. * updates. On the other hand, when the series contains more points than the
  95634. * crop threshold, the series data is cropped to only contain points that
  95635. * fall within the plot area. The advantage of cropping away invisible
  95636. * points is to increase performance on large series.
  95637. */
  95638. cropThreshold?: number;
  95639. /**
  95640. * (Highstock) You can set the cursor to "pointer" if you have click events
  95641. * attached to the series, to signal to the user that the points and lines
  95642. * can be clicked.
  95643. *
  95644. * In styled mode, the series cursor can be set with the same classes as
  95645. * listed under series.color.
  95646. */
  95647. cursor?: (string|CursorValue);
  95648. /**
  95649. * (Highstock) A reserved subspace to store options and values for
  95650. * customized functionality. Here you can add additional data for your own
  95651. * event callbacks and formatter callbacks.
  95652. */
  95653. custom?: Dictionary<any>;
  95654. /**
  95655. * (Highstock) Name of the dash style to use for the graph, or for some
  95656. * series types the outline of each shape.
  95657. *
  95658. * In styled mode, the stroke dash-array can be set with the same classes as
  95659. * listed under series.color.
  95660. */
  95661. dashStyle?: DashStyleValue;
  95662. /**
  95663. * (Highstock) Data grouping is the concept of sampling the data values into
  95664. * larger blocks in order to ease readability and increase performance of
  95665. * the JavaScript charts. Highstock by default applies data grouping when
  95666. * the points become closer than a certain pixel value, determined by the
  95667. * `groupPixelWidth` option.
  95668. *
  95669. * If data grouping is applied, the grouping information of grouped points
  95670. * can be read from the Point.dataGroup. If point options other than the
  95671. * data itself are set, for example `name` or `color` or custom properties,
  95672. * the grouping logic doesn't know how to group it. In this case the options
  95673. * of the first point instance are copied over to the group point. This can
  95674. * be altered through a custom `approximation` callback function.
  95675. */
  95676. dataGrouping?: DataGroupingOptionsObject;
  95677. /**
  95678. * (Highcharts, Highstock, Highmaps, Gantt) Options for the series data
  95679. * labels, appearing next to each data point.
  95680. *
  95681. * Since v6.2.0, multiple data labels can be applied to each single point by
  95682. * defining them as an array of configs.
  95683. *
  95684. * In styled mode, the data labels can be styled with the
  95685. * `.highcharts-data-label-box` and `.highcharts-data-label` class names
  95686. * (see example).
  95687. */
  95688. dataLabels?: (PlotVwapDataLabelsOptions|Array<PlotVwapDataLabelsOptions>);
  95689. /**
  95690. * (Highcharts, Highstock) Options for the series data sorting.
  95691. */
  95692. dataSorting?: (DataSortingOptionsObject|PlotVwapDataSortingOptions);
  95693. /**
  95694. * (Highstock) A description of the series to add to the screen reader
  95695. * information about the series.
  95696. */
  95697. description?: string;
  95698. /**
  95699. * (Highstock) Enable or disable the mouse tracking for a specific series.
  95700. * This includes point tooltips and click events on graphs and points. For
  95701. * large datasets it improves performance.
  95702. */
  95703. enableMouseTracking?: boolean;
  95704. /**
  95705. * (Highstock) General event handlers for the series items. These event
  95706. * hooks can also be attached to the series at run time using the
  95707. * `Highcharts.addEvent` function.
  95708. */
  95709. events?: SeriesEventsOptionsObject;
  95710. /**
  95711. * (Highstock) Determines whether the series should look for the nearest
  95712. * point in both dimensions or just the x-dimension when hovering the
  95713. * series. Defaults to `'xy'` for scatter series and `'x'` for most other
  95714. * series. If the data has duplicate x-values, it is recommended to set this
  95715. * to `'xy'` to allow hovering over all points.
  95716. *
  95717. * Applies only to series types using nearest neighbor search (not direct
  95718. * hover) for tooltip.
  95719. */
  95720. findNearestPointBy?: OptionsFindNearestPointByValue;
  95721. /**
  95722. * (Highstock) Defines when to display a gap in the graph, together with the
  95723. * gapUnit option.
  95724. *
  95725. * In case when `dataGrouping` is enabled, points can be grouped into a
  95726. * larger time span. This can make the grouped points to have a greater
  95727. * distance than the absolute value of `gapSize` property, which will result
  95728. * in disappearing graph completely. To prevent this situation the mentioned
  95729. * distance between grouped points is used instead of previously defined
  95730. * `gapSize`.
  95731. *
  95732. * In practice, this option is most often used to visualize gaps in time
  95733. * series. In a stock chart, intraday data is available for daytime hours,
  95734. * while gaps will appear in nights and weekends.
  95735. */
  95736. gapSize?: number;
  95737. /**
  95738. * (Highstock) Together with gapSize, this option defines where to draw gaps
  95739. * in the graph.
  95740. *
  95741. * When the `gapUnit` is `"relative"` (default), a gap size of 5 means that
  95742. * if the distance between two points is greater than 5 times that of the
  95743. * two closest points, the graph will be broken.
  95744. *
  95745. * When the `gapUnit` is `"value"`, the gap is based on absolute axis
  95746. * values, which on a datetime axis is milliseconds. This also applies to
  95747. * the navigator series that inherits gap options from the base series.
  95748. */
  95749. gapUnit?: OptionsGapUnitValue;
  95750. /**
  95751. * (Highcharts, Highstock, Gantt) Whether to use the Y extremes of the total
  95752. * chart width or only the zoomed area when zooming in on parts of the X
  95753. * axis. By default, the Y axis adjusts to the min and max of the visible
  95754. * data. Cartesian series only.
  95755. */
  95756. getExtremesFromAll?: boolean;
  95757. /**
  95758. * (Highstock) When set to `false` will prevent the series data from being
  95759. * included in any form of data export.
  95760. *
  95761. * Since version 6.0.0 until 7.1.0 the option was existing undocumented as
  95762. * `includeInCSVExport`.
  95763. */
  95764. includeInDataExport?: boolean;
  95765. /**
  95766. * (Highcharts, Highstock, Gantt) Series labels are placed as close to the
  95767. * series as possible in a natural way, seeking to avoid other series. The
  95768. * goal of this feature is to make the chart more easily readable, like if a
  95769. * human designer placed the labels in the optimal position.
  95770. *
  95771. * The series labels currently work with series types having a `graph` or an
  95772. * `area`.
  95773. */
  95774. label?: SeriesLabelOptionsObject;
  95775. /**
  95776. * (Highstock) The line marks the last price from all points.
  95777. */
  95778. lastPrice?: SeriesLastPriceOptionsObject;
  95779. /**
  95780. * (Highstock) The line marks the last price from visible range of points.
  95781. */
  95782. lastVisiblePrice?: SeriesLastVisiblePriceOptionsObject;
  95783. /**
  95784. * (Highcharts, Highstock) The SVG value used for the `stroke-linecap` and
  95785. * `stroke-linejoin` of a line graph. Round means that lines are rounded in
  95786. * the ends and bends.
  95787. */
  95788. linecap?: SeriesLinecapValue;
  95789. /**
  95790. * (Highcharts, Highstock) Pixel width of the graph line.
  95791. */
  95792. lineWidth?: number;
  95793. /**
  95794. * (Highcharts, Highstock, Gantt) The main series ID that indicator will be
  95795. * based on. Required for this indicator.
  95796. */
  95797. linkedTo?: string;
  95798. /**
  95799. * (Highstock) Options for the point markers of line-like series. Properties
  95800. * like `fillColor`, `lineColor` and `lineWidth` define the visual
  95801. * appearance of the markers. Other series types, like column series, don't
  95802. * have markers, but have visual options on the series level instead.
  95803. *
  95804. * In styled mode, the markers can be styled with the `.highcharts-point`,
  95805. * `.highcharts-point-hover` and `.highcharts-point-select` class names.
  95806. */
  95807. marker?: PointMarkerOptionsObject;
  95808. /**
  95809. * (Highstock) The name of the series as shown in the legend, tooltip etc.
  95810. * If not set, it will be based on a technical indicator type and default
  95811. * params.
  95812. */
  95813. name?: string;
  95814. /**
  95815. * (Highstock) The color for the parts of the graph or points that are below
  95816. * the threshold. Note that `zones` takes precedence over the negative
  95817. * color. Using `negativeColor` is equivalent to applying a zone with value
  95818. * of 0.
  95819. */
  95820. negativeColor?: (ColorString|GradientColorObject|PatternObject);
  95821. /**
  95822. * (Highstock) Opacity of a series parts: line, fill (e.g. area) and
  95823. * dataLabels.
  95824. */
  95825. opacity?: number;
  95826. /**
  95827. * (Highstock) Paramters used in calculation of regression series' points.
  95828. */
  95829. params?: PlotVwapParamsOptions;
  95830. /**
  95831. * (Highstock) Properties for each single point.
  95832. */
  95833. point?: PlotSeriesPointOptions;
  95834. /**
  95835. * (Highstock) Same as accessibility.pointDescriptionFormatter, but for an
  95836. * individual series. Overrides the chart wide configuration.
  95837. */
  95838. pointDescriptionFormatter?: Function;
  95839. /**
  95840. * (Highstock) Whether to select the series initially. If `showCheckbox` is
  95841. * true, the checkbox next to the series name in the legend will be checked
  95842. * for a selected series.
  95843. */
  95844. selected?: boolean;
  95845. /**
  95846. * (Highstock) Whether to apply a drop shadow to the graph line. Since 2.3
  95847. * the shadow can be an object configuration containing `color`, `offsetX`,
  95848. * `offsetY`, `opacity` and `width`.
  95849. */
  95850. shadow?: (boolean|ShadowOptionsObject);
  95851. /**
  95852. * (Highstock) If true, a checkbox is displayed next to the legend item to
  95853. * allow selecting the series. The state of the checkbox is determined by
  95854. * the `selected` option.
  95855. */
  95856. showCheckbox?: boolean;
  95857. /**
  95858. * (Highstock) Whether to display this particular series or series type in
  95859. * the legend. Standalone series are shown in legend by default, and linked
  95860. * series are not. Since v7.2.0 it is possible to show series that use
  95861. * colorAxis by setting this option to `true`.
  95862. */
  95863. showInLegend?: boolean;
  95864. /**
  95865. * (Highstock) If set to `true`, the accessibility module will skip past the
  95866. * points in this series for keyboard navigation.
  95867. */
  95868. skipKeyboardNavigation?: boolean;
  95869. /**
  95870. * (Highcharts, Highstock) When this is true, the series will not cause the
  95871. * Y axis to cross the zero plane (or threshold option) unless the data
  95872. * actually crosses the plane.
  95873. *
  95874. * For example, if `softThreshold` is `false`, a series of 0, 1, 2, 3 will
  95875. * make the Y axis show negative values according to the `minPadding`
  95876. * option. If `softThreshold` is `true`, the Y axis starts at 0.
  95877. */
  95878. softThreshold?: boolean;
  95879. states?: SeriesStatesOptionsObject;
  95880. /**
  95881. * (Highcharts, Highstock) Whether to apply steps to the line. Possible
  95882. * values are `left`, `center` and `right`.
  95883. */
  95884. step?: OptionsStepValue;
  95885. /**
  95886. * (Highstock) Sticky tracking of mouse events. When true, the `mouseOut`
  95887. * event on a series isn't triggered until the mouse moves over another
  95888. * series, or out of the plot area. When false, the `mouseOut` event on a
  95889. * series is triggered when the mouse leaves the area around the series'
  95890. * graph or markers. This also implies the tooltip when not shared. When
  95891. * `stickyTracking` is false and `tooltip.shared` is false, the tooltip will
  95892. * be hidden when moving the mouse between series. Defaults to true for line
  95893. * and area type series, but to false for columns, pies etc.
  95894. *
  95895. * **Note:** The boost module will force this option because of technical
  95896. * limitations.
  95897. */
  95898. stickyTracking?: boolean;
  95899. /**
  95900. * (Highcharts, Highstock) The threshold, also called zero level or base
  95901. * level. For line type series this is only used in conjunction with
  95902. * negativeColor.
  95903. */
  95904. threshold?: (number|null);
  95905. /**
  95906. * (Highstock) A configuration object for the tooltip rendering of each
  95907. * single series. Properties are inherited from tooltip, but only the
  95908. * following properties can be defined on a series level.
  95909. */
  95910. tooltip?: SeriesTooltipOptionsObject;
  95911. /**
  95912. * (Highcharts, Highstock, Gantt) When a series contains a data array that
  95913. * is longer than this, only one dimensional arrays of numbers, or two
  95914. * dimensional arrays with x and y values are allowed. Also, only the first
  95915. * point is tested, and the rest are assumed to be the same format. This
  95916. * saves expensive data checking and indexing in long series. Set it to `0`
  95917. * disable.
  95918. *
  95919. * Note: In boost mode turbo threshold is forced. Only array of numbers or
  95920. * two dimensional arrays are allowed.
  95921. */
  95922. turboThreshold?: number;
  95923. /**
  95924. * (Highstock) Set the initial visibility of the series.
  95925. */
  95926. visible?: boolean;
  95927. /**
  95928. * (Highmaps) Define the z index of the series.
  95929. */
  95930. zIndex?: number;
  95931. /**
  95932. * (Highcharts, Highstock) Defines the Axis on which the zones are applied.
  95933. */
  95934. zoneAxis?: string;
  95935. /**
  95936. * (Highcharts, Highstock) An array defining zones within a series. Zones
  95937. * can be applied to the X axis, Y axis or Z axis for bubbles, according to
  95938. * the `zoneAxis` option. The zone definitions have to be in ascending order
  95939. * regarding to the value.
  95940. *
  95941. * In styled mode, the color zones are styled with the
  95942. * `.highcharts-zone-{n}` class, or custom classed from the `className`
  95943. * option (view live demo).
  95944. */
  95945. zones?: Array<SeriesZonesOptionsObject>;
  95946. }
  95947. /**
  95948. * (Highstock) Paramters used in calculation of regression series' points.
  95949. */
  95950. export interface PlotVwapParamsOptions {
  95951. /**
  95952. * (Highstock) The base period for indicator calculations. This is the
  95953. * number of data points which are taken into account for the indicator
  95954. * calculations.
  95955. */
  95956. period?: number;
  95957. /**
  95958. * (Highstock) The id of volume series which is mandatory. For example using
  95959. * OHLC data, volumeSeriesID='volume' means the indicator will be calculated
  95960. * using OHLC and volume values.
  95961. */
  95962. volumeSeriesID?: string;
  95963. }
  95964. /**
  95965. * (Highcharts) Enable or disable the initial animation when a series is
  95966. * displayed. The animation can also be set as a configuration object. Please
  95967. * note that this option only applies to the initial animation of the series
  95968. * itself. For other animations, see chart.animation and the animation parameter
  95969. * under the API methods. The following properties are supported:
  95970. *
  95971. * - `defer`: The animation delay time in milliseconds.
  95972. *
  95973. * - `duration`: The duration of the animation in milliseconds.
  95974. *
  95975. * - `easing`: Can be a string reference to an easing function set on the `Math`
  95976. * object or a function. See the _Custom easing function_ demo below.
  95977. *
  95978. * Due to poor performance, animation is disabled in old IE browsers for several
  95979. * chart types.
  95980. */
  95981. export interface PlotWaterfallAnimationOptions {
  95982. defer?: number;
  95983. }
  95984. /**
  95985. * (Highcharts, Highstock, Highmaps, Gantt) Enable or disable the initial
  95986. * animation when a series is displayed for the `dataLabels`. The animation can
  95987. * also be set as a configuration object. Please note that this option only
  95988. * applies to the initial animation. For other animations, see chart.animation
  95989. * and the animation parameter under the API methods. The following properties
  95990. * are supported:
  95991. *
  95992. * - `defer`: The animation delay time in milliseconds.
  95993. */
  95994. export interface PlotWaterfallDataLabelsAnimationOptions {
  95995. /**
  95996. * (Highcharts, Highstock, Highmaps, Gantt) The animation delay time in
  95997. * milliseconds. Set to `0` renders dataLabel immediately. As `undefined`
  95998. * inherits defer time from the series.animation.defer.
  95999. */
  96000. defer?: number;
  96001. }
  96002. /**
  96003. * (Highcharts, Highstock, Highmaps, Gantt) Options for the series data labels,
  96004. * appearing next to each data point.
  96005. *
  96006. * Since v6.2.0, multiple data labels can be applied to each single point by
  96007. * defining them as an array of configs.
  96008. *
  96009. * In styled mode, the data labels can be styled with the
  96010. * `.highcharts-data-label-box` and `.highcharts-data-label` class names (see
  96011. * example).
  96012. */
  96013. export interface PlotWaterfallDataLabelsOptions {
  96014. /**
  96015. * (Highcharts, Highstock, Highmaps, Gantt) The alignment of the data label
  96016. * compared to the point. If `right`, the right side of the label should be
  96017. * touching the point. For points with an extent, like columns, the
  96018. * alignments also dictates how to align it inside the box, as given with
  96019. * the inside option. Can be one of `left`, `center` or `right`.
  96020. */
  96021. align?: string;
  96022. /**
  96023. * (Highcharts, Highstock, Highmaps, Gantt) Whether to allow data labels to
  96024. * overlap. To make the labels less sensitive for overlapping, the
  96025. * dataLabels.padding can be set to 0.
  96026. */
  96027. allowOverlap?: boolean;
  96028. /**
  96029. * (Highcharts, Highstock, Highmaps, Gantt) Enable or disable the initial
  96030. * animation when a series is displayed for the `dataLabels`. The animation
  96031. * can also be set as a configuration object. Please note that this option
  96032. * only applies to the initial animation. For other animations, see
  96033. * chart.animation and the animation parameter under the API methods. The
  96034. * following properties are supported:
  96035. *
  96036. * - `defer`: The animation delay time in milliseconds.
  96037. */
  96038. animation?: (boolean|PlotWaterfallDataLabelsAnimationOptions|Partial<AnimationOptionsObject>);
  96039. /**
  96040. * (Highcharts, Highstock, Highmaps, Gantt) The background color or gradient
  96041. * for the data label.
  96042. */
  96043. backgroundColor?: (ColorString|GradientColorObject|PatternObject);
  96044. /**
  96045. * (Highcharts, Highstock, Highmaps, Gantt) The border color for the data
  96046. * label. Defaults to `undefined`.
  96047. */
  96048. borderColor?: (ColorString|GradientColorObject|PatternObject);
  96049. /**
  96050. * (Highcharts, Highstock, Highmaps, Gantt) The border radius in pixels for
  96051. * the data label.
  96052. */
  96053. borderRadius?: number;
  96054. /**
  96055. * (Highcharts, Highstock, Highmaps, Gantt) The border width in pixels for
  96056. * the data label.
  96057. */
  96058. borderWidth?: number;
  96059. /**
  96060. * (Highcharts, Highstock, Highmaps, Gantt) A class name for the data label.
  96061. * Particularly in styled mode, this can be used to give each series' or
  96062. * point's data label unique styling. In addition to this option, a default
  96063. * color class name is added so that we can give the labels a contrast text
  96064. * shadow.
  96065. */
  96066. className?: string;
  96067. /**
  96068. * (Highcharts, Highstock, Highmaps, Gantt) The text color for the data
  96069. * labels. Defaults to `undefined`. For certain series types, like column or
  96070. * map, the data labels can be drawn inside the points. In this case the
  96071. * data label will be drawn with maximum contrast by default. Additionally,
  96072. * it will be given a `text-outline` style with the opposite color, to
  96073. * further increase the contrast. This can be overridden by setting the
  96074. * `text-outline` style to `none` in the `dataLabels.style` option.
  96075. */
  96076. color?: (ColorString|GradientColorObject|PatternObject);
  96077. /**
  96078. * (Highcharts, Highstock, Highmaps, Gantt) Whether to hide data labels that
  96079. * are outside the plot area. By default, the data label is moved inside the
  96080. * plot area according to the overflow option.
  96081. */
  96082. crop?: boolean;
  96083. /**
  96084. * (Highcharts, Highstock, Gantt) Whether to defer displaying the data
  96085. * labels until the initial series animation has finished. Setting to
  96086. * `false` renders the data label immediately. If set to `true` inherits the
  96087. * defer time set in plotOptions.series.animation.
  96088. */
  96089. defer?: boolean;
  96090. /**
  96091. * (Highcharts, Highstock, Highmaps, Gantt) Enable or disable the data
  96092. * labels.
  96093. */
  96094. enabled?: boolean;
  96095. /**
  96096. * (Highcharts, Highstock, Highmaps, Gantt) A declarative filter to control
  96097. * of which data labels to display. The declarative filter is designed for
  96098. * use when callback functions are not available, like when the chart
  96099. * options require a pure JSON structure or for use with graphical editors.
  96100. * For programmatic control, use the `formatter` instead, and return
  96101. * `undefined` to disable a single data label.
  96102. */
  96103. filter?: DataLabelsFilterOptionsObject;
  96104. /**
  96105. * (Highcharts, Highstock, Highmaps, Gantt) A format string for the data
  96106. * label. Available variables are the same as for `formatter`.
  96107. */
  96108. format?: string;
  96109. /**
  96110. * (Highcharts, Highstock, Highmaps, Gantt) Callback JavaScript function to
  96111. * format the data label. Note that if a `format` is defined, the format
  96112. * takes precedence and the formatter is ignored.
  96113. */
  96114. formatter?: DataLabelsFormatterCallbackFunction;
  96115. /**
  96116. * (Highcharts, Highstock, Highmaps, Gantt) For points with an extent, like
  96117. * columns or map areas, whether to align the data label inside the box or
  96118. * to the actual value point. Defaults to `false` in most cases, `true` in
  96119. * stacked columns.
  96120. */
  96121. inside?: boolean;
  96122. /**
  96123. * (Highcharts, Highstock, Highmaps, Gantt) Format for points with the value
  96124. * of null. Works analogously to format. `nullFormat` can be applied only to
  96125. * series which support displaying null points.
  96126. */
  96127. nullFormat?: (boolean|string);
  96128. /**
  96129. * (Highcharts, Highstock, Highmaps, Gantt) Callback JavaScript function
  96130. * that defines formatting for points with the value of null. Works
  96131. * analogously to formatter. `nullPointFormatter` can be applied only to
  96132. * series which support displaying null points.
  96133. */
  96134. nullFormatter?: DataLabelsFormatterCallbackFunction;
  96135. /**
  96136. * (Highcharts, Highstock, Highmaps, Gantt) How to handle data labels that
  96137. * flow outside the plot area. The default is `"justify"`, which aligns them
  96138. * inside the plot area. For columns and bars, this means it will be moved
  96139. * inside the bar. To display data labels outside the plot area, set `crop`
  96140. * to `false` and `overflow` to `"allow"`.
  96141. */
  96142. overflow?: DataLabelsOverflowValue;
  96143. /**
  96144. * (Highcharts, Highstock, Highmaps, Gantt) When either the `borderWidth` or
  96145. * the `backgroundColor` is set, this is the padding within the box.
  96146. */
  96147. padding?: number;
  96148. /**
  96149. * (Highcharts, Highstock, Highmaps, Gantt) Aligns data labels relative to
  96150. * points. If `center` alignment is not possible, it defaults to `right`.
  96151. */
  96152. position?: AlignValue;
  96153. /**
  96154. * (Highcharts, Highstock, Highmaps, Gantt) Text rotation in degrees. Note
  96155. * that due to a more complex structure, backgrounds, borders and padding
  96156. * will be lost on a rotated data label.
  96157. */
  96158. rotation?: number;
  96159. /**
  96160. * (Highcharts, Highstock, Highmaps, Gantt) The shadow of the box. Works
  96161. * best with `borderWidth` or `backgroundColor`. Since 2.3 the shadow can be
  96162. * an object configuration containing `color`, `offsetX`, `offsetY`,
  96163. * `opacity` and `width`.
  96164. */
  96165. shadow?: (boolean|ShadowOptionsObject);
  96166. /**
  96167. * (Highcharts, Highstock, Highmaps, Gantt) The name of a symbol to use for
  96168. * the border around the label. Symbols are predefined functions on the
  96169. * Renderer object.
  96170. */
  96171. shape?: string;
  96172. /**
  96173. * (Highcharts, Highstock, Highmaps, Gantt) Styles for the label. The
  96174. * default `color` setting is `"contrast"`, which is a pseudo color that
  96175. * Highcharts picks up and applies the maximum contrast to the underlying
  96176. * point item, for example the bar in a bar chart.
  96177. *
  96178. * The `textOutline` is a pseudo property that applies an outline of the
  96179. * given width with the given color, which by default is the maximum
  96180. * contrast to the text. So a bright text color will result in a black text
  96181. * outline for maximum readability on a mixed background. In some cases,
  96182. * especially with grayscale text, the text outline doesn't work well, in
  96183. * which cases it can be disabled by setting it to `"none"`. When `useHTML`
  96184. * is true, the `textOutline` will not be picked up. In this, case, the same
  96185. * effect can be acheived through the `text-shadow` CSS property.
  96186. *
  96187. * For some series types, where each point has an extent, like for example
  96188. * tree maps, the data label may overflow the point. There are two
  96189. * strategies for handling overflow. By default, the text will wrap to
  96190. * multiple lines. The other strategy is to set `style.textOverflow` to
  96191. * `ellipsis`, which will keep the text on one line plus it will break
  96192. * inside long words.
  96193. */
  96194. style?: CSSObject;
  96195. /**
  96196. * (Highcharts, Highstock, Highmaps, Gantt) Options for a label text which
  96197. * should follow marker's shape. Border and background are disabled for a
  96198. * label that follows a path.
  96199. *
  96200. * **Note:** Only SVG-based renderer supports this option. Setting `useHTML`
  96201. * to true will disable this option.
  96202. */
  96203. textPath?: DataLabelsTextPathOptionsObject;
  96204. /**
  96205. * (Highcharts, Highstock, Highmaps, Gantt) Whether to use HTML to render
  96206. * the labels.
  96207. */
  96208. useHTML?: boolean;
  96209. /**
  96210. * (Highcharts, Highstock, Highmaps, Gantt) The vertical alignment of a data
  96211. * label. Can be one of `top`, `middle` or `bottom`. The default value
  96212. * depends on the data, for instance in a column chart, the label is above
  96213. * positive values and below negative values.
  96214. */
  96215. verticalAlign?: string;
  96216. /**
  96217. * (Highcharts, Highstock, Highmaps, Gantt) The x position offset of the
  96218. * label relative to the point in pixels.
  96219. */
  96220. x?: number;
  96221. /**
  96222. * (Highcharts, Highstock, Highmaps, Gantt) The y position offset of the
  96223. * label relative to the point in pixels.
  96224. */
  96225. y?: number;
  96226. /**
  96227. * (Highcharts, Highstock, Highmaps, Gantt) The Z index of the data labels.
  96228. * The default Z index puts it above the series. Use a Z index of 2 to
  96229. * display it behind the series.
  96230. */
  96231. z?: number;
  96232. }
  96233. /**
  96234. * (Highcharts, Highstock) Options for the series data sorting.
  96235. */
  96236. export interface PlotWaterfallDataSortingOptions {
  96237. /**
  96238. * (Highcharts, Highstock) Enable or disable data sorting for the series.
  96239. * Use xAxis.reversed to change the sorting order.
  96240. */
  96241. enabled?: boolean;
  96242. /**
  96243. * (Highcharts, Highstock) Whether to allow matching points by name in an
  96244. * update. If this option is disabled, points will be matched by order.
  96245. */
  96246. matchByName?: boolean;
  96247. /**
  96248. * (Highcharts, Highstock) Determines what data value should be used to sort
  96249. * by.
  96250. */
  96251. sortKey?: string;
  96252. }
  96253. /**
  96254. * (Highcharts) Style options for the guide box. The guide box has one state by
  96255. * default, the `default` state.
  96256. */
  96257. export interface PlotWaterfallDragDropGuideBoxOptions {
  96258. /**
  96259. * (Highcharts) Style options for the guide box default state.
  96260. */
  96261. default?: DragDropGuideBoxOptionsObject;
  96262. }
  96263. /**
  96264. * (Highcharts) A waterfall chart displays sequentially introduced positive or
  96265. * negative values in cumulative columns.
  96266. *
  96267. * In TypeScript the type option must always be set.
  96268. *
  96269. * Configuration options for the series are given in three levels:
  96270. *
  96271. * 1. Options for all series in a chart are defined in the plotOptions.series
  96272. * object.
  96273. *
  96274. * 2. Options for all `waterfall` series are defined in plotOptions.waterfall.
  96275. *
  96276. * 3. Options for one single series are given in the series instance array. (see
  96277. * online documentation for example)
  96278. */
  96279. export interface PlotWaterfallOptions {
  96280. /**
  96281. * (Highcharts) Accessibility options for a series.
  96282. */
  96283. accessibility?: SeriesAccessibilityOptionsObject;
  96284. /**
  96285. * (Highmaps) Whether all areas of the map defined in `mapData` should be
  96286. * rendered. If `true`, areas which don't correspond to a data point, are
  96287. * rendered as `null` points. If `false`, those areas are skipped.
  96288. */
  96289. allAreas?: boolean;
  96290. /**
  96291. * (Highcharts) Allow this series' points to be selected by clicking on the
  96292. * graphic (columns, point markers, pie slices, map areas etc).
  96293. *
  96294. * The selected points can be handled by point select and unselect events,
  96295. * or collectively by the getSelectedPoints function.
  96296. *
  96297. * And alternative way of selecting points is through dragging.
  96298. */
  96299. allowPointSelect?: boolean;
  96300. /**
  96301. * (Highcharts) Enable or disable the initial animation when a series is
  96302. * displayed. The animation can also be set as a configuration object.
  96303. * Please note that this option only applies to the initial animation of the
  96304. * series itself. For other animations, see chart.animation and the
  96305. * animation parameter under the API methods. The following properties are
  96306. * supported:
  96307. *
  96308. * - `defer`: The animation delay time in milliseconds.
  96309. *
  96310. * - `duration`: The duration of the animation in milliseconds.
  96311. *
  96312. * - `easing`: Can be a string reference to an easing function set on the
  96313. * `Math` object or a function. See the _Custom easing function_ demo below.
  96314. *
  96315. * Due to poor performance, animation is disabled in old IE browsers for
  96316. * several chart types.
  96317. */
  96318. animation?: (boolean|PlotWaterfallAnimationOptions|Partial<AnimationOptionsObject>);
  96319. /**
  96320. * (Highcharts) For some series, there is a limit that shuts down initial
  96321. * animation by default when the total number of points in the chart is too
  96322. * high. For example, for a column chart and its derivatives, animation does
  96323. * not run if there is more than 250 points totally. To disable this cap,
  96324. * set `animationLimit` to `Infinity`.
  96325. */
  96326. animationLimit?: number;
  96327. /**
  96328. * (Highcharts) The color of the border of each waterfall column.
  96329. *
  96330. * In styled mode, the border stroke can be set with the `.highcharts-point`
  96331. * class.
  96332. */
  96333. borderColor?: (ColorString|GradientColorObject|PatternObject);
  96334. /**
  96335. * (Highcharts, Highstock, Gantt) The corner radius of the border
  96336. * surrounding each column or bar.
  96337. */
  96338. borderRadius?: number;
  96339. /**
  96340. * (Highcharts, Highstock, Gantt) The width of the border surrounding each
  96341. * column or bar. Defaults to `1` when there is room for a border, but to
  96342. * `0` when the columns are so dense that a border would cover the next
  96343. * column.
  96344. *
  96345. * In styled mode, the stroke width can be set with the `.highcharts-point`
  96346. * rule.
  96347. */
  96348. borderWidth?: number;
  96349. /**
  96350. * (Highcharts, Highstock, Gantt) When `true`, the columns will center in
  96351. * the category, ignoring null or missing points. When `false`, space will
  96352. * be reserved for null or missing points.
  96353. */
  96354. centerInCategory?: boolean;
  96355. /**
  96356. * (Highcharts) An additional class name to apply to the series' graphical
  96357. * elements. This option does not replace default class names of the
  96358. * graphical element.
  96359. */
  96360. className?: string;
  96361. /**
  96362. * (Highcharts) Disable this option to allow series rendering in the whole
  96363. * plotting area.
  96364. *
  96365. * **Note:** Clipping should be always enabled when chart.zoomType is set
  96366. */
  96367. clip?: boolean;
  96368. /**
  96369. * (Highcharts) The main color of the series. In line type series it applies
  96370. * to the line and the point markers unless otherwise specified. In bar type
  96371. * series it applies to the bars unless a color is specified per point. The
  96372. * default value is pulled from the `options.colors` array.
  96373. *
  96374. * In styled mode, the color can be defined by the colorIndex option. Also,
  96375. * the series color can be set with the `.highcharts-series`,
  96376. * `.highcharts-color-{n}`, `.highcharts-{type}-series` or
  96377. * `.highcharts-series-{n}` class, or individual classes given by the
  96378. * `className` option.
  96379. */
  96380. color?: (ColorString|GradientColorObject|PatternObject);
  96381. /**
  96382. * (Highcharts, Highstock, Highmaps) When using dual or multiple color axes,
  96383. * this number defines which colorAxis the particular series is connected
  96384. * to. It refers to either the axis id or the index of the axis in the
  96385. * colorAxis array, with 0 being the first. Set this option to false to
  96386. * prevent a series from connecting to the default color axis.
  96387. *
  96388. * Since v7.2.0 the option can also be an axis id or an axis index instead
  96389. * of a boolean flag.
  96390. */
  96391. colorAxis?: (boolean|number|string);
  96392. /**
  96393. * (Highcharts, Highstock, Gantt) When using automatic point colors pulled
  96394. * from the global colors or series-specific plotOptions.column.colors
  96395. * collections, this option determines whether the chart should receive one
  96396. * color per series or one color per point.
  96397. *
  96398. * In styled mode, the `colors` or `series.colors` arrays are not supported,
  96399. * and instead this option gives the points individual color class names on
  96400. * the form `highcharts-color-{n}`.
  96401. */
  96402. colorByPoint?: boolean;
  96403. /**
  96404. * (Highcharts) Styled mode only. A specific color index to use for the
  96405. * series, so its graphic representations are given the class name
  96406. * `highcharts-color-{n}`.
  96407. */
  96408. colorIndex?: number;
  96409. /**
  96410. * (Highcharts, Highstock, Highmaps) Determines what data value should be
  96411. * used to calculate point color if `colorAxis` is used. Requires to set
  96412. * `min` and `max` if some custom point property is used or if approximation
  96413. * for data grouping is set to `'sum'`.
  96414. */
  96415. colorKey?: string;
  96416. /**
  96417. * (Highcharts, Highstock, Gantt) A series specific or series type specific
  96418. * color set to apply instead of the global colors when colorByPoint is
  96419. * true.
  96420. */
  96421. colors?: Array<(ColorString|GradientColorObject|PatternObject)>;
  96422. /**
  96423. * (Highstock) Compare the values of the series against the first non-null,
  96424. * non- zero value in the visible range. The y axis will show percentage or
  96425. * absolute change depending on whether `compare` is set to `"percent"` or
  96426. * `"value"`. When this is applied to multiple series, it allows comparing
  96427. * the development of the series against each other. Adds a `change` field
  96428. * to every point object.
  96429. */
  96430. compare?: string;
  96431. /**
  96432. * (Highstock) When compare is `percent`, this option dictates whether to
  96433. * use 0 or 100 as the base of comparison.
  96434. */
  96435. compareBase?: (0|100);
  96436. /**
  96437. * (Highstock) Defines if comparison should start from the first point
  96438. * within the visible range or should start from the first point **before**
  96439. * the range.
  96440. *
  96441. * In other words, this flag determines if first point within the visible
  96442. * range will have 0% (`compareStart=true`) or should have been already
  96443. * calculated according to the previous point (`compareStart=false`).
  96444. */
  96445. compareStart?: boolean;
  96446. /**
  96447. * (Gantt) Override Pathfinder connector options for a series. Requires
  96448. * Highcharts Gantt to be loaded.
  96449. */
  96450. connectors?: SeriesConnectorsOptionsObject;
  96451. /**
  96452. * (Highcharts, Highstock, Gantt) When true, each point or column edge is
  96453. * rounded to its nearest pixel in order to render sharp on screen. In some
  96454. * cases, when there are a lot of densely packed columns, this leads to
  96455. * visible difference in column widths or distance between columns. In these
  96456. * cases, setting `crisp` to `false` may look better, even though each
  96457. * column is rendered blurry.
  96458. */
  96459. crisp?: boolean;
  96460. /**
  96461. * (Highcharts, Highstock, Gantt) When the series contains less points than
  96462. * the crop threshold, all points are drawn, event if the points fall
  96463. * outside the visible plot area at the current zoom. The advantage of
  96464. * drawing all points (including markers and columns), is that animation is
  96465. * performed on updates. On the other hand, when the series contains more
  96466. * points than the crop threshold, the series data is cropped to only
  96467. * contain points that fall within the plot area. The advantage of cropping
  96468. * away invisible points is to increase performance on large series.
  96469. */
  96470. cropThreshold?: number;
  96471. /**
  96472. * (Highcharts) You can set the cursor to "pointer" if you have click events
  96473. * attached to the series, to signal to the user that the points and lines
  96474. * can be clicked.
  96475. *
  96476. * In styled mode, the series cursor can be set with the same classes as
  96477. * listed under series.color.
  96478. */
  96479. cursor?: (string|CursorValue);
  96480. /**
  96481. * (Highcharts) A reserved subspace to store options and values for
  96482. * customized functionality. Here you can add additional data for your own
  96483. * event callbacks and formatter callbacks.
  96484. */
  96485. custom?: Dictionary<any>;
  96486. /**
  96487. * (Highcharts) A name for the dash style to use for the line connecting the
  96488. * columns of the waterfall series. Possible values: Dash, DashDot, Dot,
  96489. * LongDash, LongDashDot, LongDashDotDot, ShortDash, ShortDashDot,
  96490. * ShortDashDotDot, ShortDot, Solid
  96491. *
  96492. * In styled mode, the stroke dash-array can be set with the
  96493. * `.highcharts-graph` class.
  96494. */
  96495. dashStyle?: DashStyleValue;
  96496. /**
  96497. * (Highstock) Data grouping is the concept of sampling the data values into
  96498. * larger blocks in order to ease readability and increase performance of
  96499. * the JavaScript charts. Highstock by default applies data grouping when
  96500. * the points become closer than a certain pixel value, determined by the
  96501. * `groupPixelWidth` option.
  96502. *
  96503. * If data grouping is applied, the grouping information of grouped points
  96504. * can be read from the Point.dataGroup. If point options other than the
  96505. * data itself are set, for example `name` or `color` or custom properties,
  96506. * the grouping logic doesn't know how to group it. In this case the options
  96507. * of the first point instance are copied over to the group point. This can
  96508. * be altered through a custom `approximation` callback function.
  96509. */
  96510. dataGrouping?: DataGroupingOptionsObject;
  96511. /**
  96512. * (Highcharts, Highstock, Highmaps, Gantt) Options for the series data
  96513. * labels, appearing next to each data point.
  96514. *
  96515. * Since v6.2.0, multiple data labels can be applied to each single point by
  96516. * defining them as an array of configs.
  96517. *
  96518. * In styled mode, the data labels can be styled with the
  96519. * `.highcharts-data-label-box` and `.highcharts-data-label` class names
  96520. * (see example).
  96521. */
  96522. dataLabels?: (PlotWaterfallDataLabelsOptions|Array<PlotWaterfallDataLabelsOptions>);
  96523. /**
  96524. * (Highcharts, Highstock) Options for the series data sorting.
  96525. */
  96526. dataSorting?: (DataSortingOptionsObject|PlotWaterfallDataSortingOptions);
  96527. /**
  96528. * (Highcharts) Depth of the columns in a 3D column chart.
  96529. */
  96530. depth?: number;
  96531. /**
  96532. * (Highcharts) A description of the series to add to the screen reader
  96533. * information about the series.
  96534. */
  96535. description?: string;
  96536. /**
  96537. * (Highcharts) The draggable-points module allows points to be moved around
  96538. * or modified in the chart. In addition to the options mentioned under the
  96539. * `dragDrop` API structure, the module fires three events, point.dragStart,
  96540. * point.drag and point.drop.
  96541. */
  96542. dragDrop?: SeriesDragDropOptionsObject;
  96543. /**
  96544. * (Highcharts) 3D columns only. The color of the edges. Similar to
  96545. * `borderColor`, except it defaults to the same color as the column.
  96546. */
  96547. edgeColor?: ColorString;
  96548. /**
  96549. * (Highcharts) 3D columns only. The width of the colored edges.
  96550. */
  96551. edgeWidth?: number;
  96552. /**
  96553. * (Highcharts) Enable or disable the mouse tracking for a specific series.
  96554. * This includes point tooltips and click events on graphs and points. For
  96555. * large datasets it improves performance.
  96556. */
  96557. enableMouseTracking?: boolean;
  96558. /**
  96559. * (Highcharts) General event handlers for the series items. These event
  96560. * hooks can also be attached to the series at run time using the
  96561. * `Highcharts.addEvent` function.
  96562. */
  96563. events?: SeriesEventsOptionsObject;
  96564. /**
  96565. * (Highcharts) Determines whether the series should look for the nearest
  96566. * point in both dimensions or just the x-dimension when hovering the
  96567. * series. Defaults to `'xy'` for scatter series and `'x'` for most other
  96568. * series. If the data has duplicate x-values, it is recommended to set this
  96569. * to `'xy'` to allow hovering over all points.
  96570. *
  96571. * Applies only to series types using nearest neighbor search (not direct
  96572. * hover) for tooltip.
  96573. */
  96574. findNearestPointBy?: OptionsFindNearestPointByValue;
  96575. /**
  96576. * (Highcharts, Highstock, Gantt) Whether to use the Y extremes of the total
  96577. * chart width or only the zoomed area when zooming in on parts of the X
  96578. * axis. By default, the Y axis adjusts to the min and max of the visible
  96579. * data. Cartesian series only.
  96580. */
  96581. getExtremesFromAll?: boolean;
  96582. /**
  96583. * (Highcharts, Highstock, Gantt) Whether to group non-stacked columns or to
  96584. * let them render independent of each other. Non-grouped columns will be
  96585. * laid out individually and overlap each other.
  96586. */
  96587. grouping?: boolean;
  96588. /**
  96589. * (Highcharts, Highstock, Gantt) Padding between each value groups, in x
  96590. * axis units.
  96591. */
  96592. groupPadding?: number;
  96593. /**
  96594. * (Highcharts) The spacing between columns on the Z Axis in a 3D chart.
  96595. */
  96596. groupZPadding?: number;
  96597. /**
  96598. * (Highcharts) When set to `false` will prevent the series data from being
  96599. * included in any form of data export.
  96600. *
  96601. * Since version 6.0.0 until 7.1.0 the option was existing undocumented as
  96602. * `includeInCSVExport`.
  96603. */
  96604. includeInDataExport?: boolean;
  96605. /**
  96606. * (Highmaps) What property to join the `mapData` to the value data. For
  96607. * example, if joinBy is "code", the mapData items with a specific code is
  96608. * merged into the data with the same code. For maps loaded from GeoJSON,
  96609. * the keys may be held in each point's `properties` object.
  96610. *
  96611. * The joinBy option can also be an array of two values, where the first
  96612. * points to a key in the `mapData`, and the second points to another key in
  96613. * the `data`.
  96614. *
  96615. * When joinBy is `null`, the map items are joined by their position in the
  96616. * array, which performs much better in maps with many data points. This is
  96617. * the recommended option if you are printing more than a thousand data
  96618. * points and have a backend that can preprocess the data into a parallel
  96619. * array of the mapData.
  96620. */
  96621. joinBy?: (string|Array<string>);
  96622. /**
  96623. * (Highcharts) An array specifying which option maps to which key in the
  96624. * data point array. This makes it convenient to work with unstructured data
  96625. * arrays from different sources.
  96626. */
  96627. keys?: Array<string>;
  96628. /**
  96629. * (Highcharts, Highstock, Gantt) Series labels are placed as close to the
  96630. * series as possible in a natural way, seeking to avoid other series. The
  96631. * goal of this feature is to make the chart more easily readable, like if a
  96632. * human designer placed the labels in the optimal position.
  96633. *
  96634. * The series labels currently work with series types having a `graph` or an
  96635. * `area`.
  96636. */
  96637. label?: SeriesLabelOptionsObject;
  96638. /**
  96639. * (Highstock) The line marks the last price from all points.
  96640. */
  96641. lastPrice?: SeriesLastPriceOptionsObject;
  96642. /**
  96643. * (Highstock) The line marks the last price from visible range of points.
  96644. */
  96645. lastVisiblePrice?: SeriesLastVisiblePriceOptionsObject;
  96646. /**
  96647. * (Highcharts) The color of the line that connects columns in a waterfall
  96648. * series.
  96649. *
  96650. * In styled mode, the stroke can be set with the `.highcharts-graph` class.
  96651. */
  96652. lineColor?: (ColorString|GradientColorObject|PatternObject);
  96653. /**
  96654. * (Highcharts) The width of the line connecting waterfall columns.
  96655. */
  96656. lineWidth?: number;
  96657. /**
  96658. * (Highcharts, Highstock, Gantt) The id of another series to link to.
  96659. * Additionally, the value can be ":previous" to link to the previous
  96660. * series. When two series are linked, only the first one appears in the
  96661. * legend. Toggling the visibility of this also toggles the linked series.
  96662. *
  96663. * If master series uses data sorting and linked series does not have its
  96664. * own sorting definition, the linked series will be sorted in the same
  96665. * order as the master one.
  96666. */
  96667. linkedTo?: string;
  96668. /**
  96669. * (Highcharts, Highstock, Gantt) The maximum allowed pixel width for a
  96670. * column, translated to the height of a bar in a bar chart. This prevents
  96671. * the columns from becoming too wide when there is a small number of points
  96672. * in the chart.
  96673. */
  96674. maxPointWidth?: number;
  96675. /**
  96676. * (Highcharts, Highstock, Gantt) The minimal height for a column or width
  96677. * for a bar. By default, 0 values are not shown. To visualize a 0 (or close
  96678. * to zero) point, set the minimal point length to a pixel value like 3\. In
  96679. * stacked column charts, minPointLength might not be respected for tightly
  96680. * packed values.
  96681. */
  96682. minPointLength?: number;
  96683. /**
  96684. * (Highstock) Options for the corresponding navigator series if
  96685. * `showInNavigator` is `true` for this series. Available options are the
  96686. * same as any series, documented at plotOptions and series.
  96687. *
  96688. * These options are merged with options in navigator.series, and will take
  96689. * precedence if the same option is defined both places.
  96690. */
  96691. navigatorOptions?: PlotSeriesOptions;
  96692. /**
  96693. * (Highcharts) The color for the parts of the graph or points that are
  96694. * below the threshold. Note that `zones` takes precedence over the negative
  96695. * color. Using `negativeColor` is equivalent to applying a zone with value
  96696. * of 0.
  96697. */
  96698. negativeColor?: (ColorString|GradientColorObject|PatternObject);
  96699. /**
  96700. * (Highcharts) Opacity of a series parts: line, fill (e.g. area) and
  96701. * dataLabels.
  96702. */
  96703. opacity?: number;
  96704. /**
  96705. * (Highcharts) Properties for each single point.
  96706. */
  96707. point?: PlotSeriesPointOptions;
  96708. /**
  96709. * (Highcharts) Same as accessibility.pointDescriptionFormatter, but for an
  96710. * individual series. Overrides the chart wide configuration.
  96711. */
  96712. pointDescriptionFormatter?: Function;
  96713. /**
  96714. * (Highcharts, Highstock, Gantt) If no x values are given for the points in
  96715. * a series, `pointInterval` defines the interval of the x values. For
  96716. * example, if a series contains one value every decade starting from year
  96717. * 0, set `pointInterval` to `10`. In true `datetime` axes, the
  96718. * `pointInterval` is set in milliseconds.
  96719. *
  96720. * It can be also be combined with `pointIntervalUnit` to draw irregular
  96721. * time intervals.
  96722. *
  96723. * Please note that this options applies to the _series data_, not the
  96724. * interval of the axis ticks, which is independent.
  96725. */
  96726. pointInterval?: number;
  96727. /**
  96728. * (Highcharts, Highstock, Gantt) On datetime series, this allows for
  96729. * setting the pointInterval to irregular time units, `day`, `month` and
  96730. * `year`. A day is usually the same as 24 hours, but `pointIntervalUnit`
  96731. * also takes the DST crossover into consideration when dealing with local
  96732. * time. Combine this option with `pointInterval` to draw weeks, quarters, 6
  96733. * months, 10 years etc.
  96734. *
  96735. * Please note that this options applies to the _series data_, not the
  96736. * interval of the axis ticks, which is independent.
  96737. */
  96738. pointIntervalUnit?: OptionsPointIntervalUnitValue;
  96739. /**
  96740. * (Highcharts, Highstock, Gantt) Padding between each column or bar, in x
  96741. * axis units.
  96742. */
  96743. pointPadding?: number;
  96744. /**
  96745. * (Highcharts, Highstock, Gantt) Possible values: `"on"`, `"between"`,
  96746. * `number`.
  96747. *
  96748. * In a column chart, when pointPlacement is `"on"`, the point will not
  96749. * create any padding of the X axis. In a polar column chart this means that
  96750. * the first column points directly north. If the pointPlacement is
  96751. * `"between"`, the columns will be laid out between ticks. This is useful
  96752. * for example for visualising an amount between two points in time or in a
  96753. * certain sector of a polar chart.
  96754. *
  96755. * Since Highcharts 3.0.2, the point placement can also be numeric, where 0
  96756. * is on the axis value, -0.5 is between this value and the previous, and
  96757. * 0.5 is between this value and the next. Unlike the textual options,
  96758. * numeric point placement options won't affect axis padding.
  96759. *
  96760. * Note that pointPlacement needs a pointRange to work. For column series
  96761. * this is computed, but for line-type series it needs to be set.
  96762. *
  96763. * For the `xrange` series type and gantt charts, if the Y axis is a
  96764. * category axis, the `pointPlacement` applies to the Y axis rather than the
  96765. * (typically datetime) X axis.
  96766. *
  96767. * Defaults to `undefined` in cartesian charts, `"between"` in polar charts.
  96768. */
  96769. pointPlacement?: (number|string);
  96770. /**
  96771. * (Highcharts, Highstock, Gantt) The X axis range that each point is valid
  96772. * for. This determines the width of the column. On a categorized axis, the
  96773. * range will be 1 by default (one category unit). On linear and datetime
  96774. * axes, the range will be computed as the distance between the two closest
  96775. * data points.
  96776. *
  96777. * The default `null` means it is computed automatically, but this option
  96778. * can be used to override the automatic value.
  96779. *
  96780. * This option is set by default to 1 if data sorting is enabled.
  96781. */
  96782. pointRange?: (number|null);
  96783. /**
  96784. * (Highcharts, Highstock, Gantt) If no x values are given for the points in
  96785. * a series, pointStart defines on what value to start. For example, if a
  96786. * series contains one yearly value starting from 1945, set pointStart to
  96787. * 1945.
  96788. */
  96789. pointStart?: number;
  96790. /**
  96791. * (Highcharts, Highstock, Gantt) A pixel value specifying a fixed width for
  96792. * each column or bar point. When set to `undefined`, the width is
  96793. * calculated from the `pointPadding` and `groupPadding`. The width effects
  96794. * the dimension that is not based on the point value. For column series it
  96795. * is the hoizontal length and for bar series it is the vertical length.
  96796. */
  96797. pointWidth?: number;
  96798. /**
  96799. * (Highcharts) Whether to select the series initially. If `showCheckbox` is
  96800. * true, the checkbox next to the series name in the legend will be checked
  96801. * for a selected series.
  96802. */
  96803. selected?: boolean;
  96804. /**
  96805. * (Highcharts) Whether to apply a drop shadow to the graph line. Since 2.3
  96806. * the shadow can be an object configuration containing `color`, `offsetX`,
  96807. * `offsetY`, `opacity` and `width`.
  96808. */
  96809. shadow?: (boolean|ShadowOptionsObject);
  96810. /**
  96811. * (Highcharts) If true, a checkbox is displayed next to the legend item to
  96812. * allow selecting the series. The state of the checkbox is determined by
  96813. * the `selected` option.
  96814. */
  96815. showCheckbox?: boolean;
  96816. /**
  96817. * (Highcharts) Whether to display this particular series or series type in
  96818. * the legend. Standalone series are shown in legend by default, and linked
  96819. * series are not. Since v7.2.0 it is possible to show series that use
  96820. * colorAxis by setting this option to `true`.
  96821. */
  96822. showInLegend?: boolean;
  96823. /**
  96824. * (Highstock) Whether or not to show the series in the navigator. Takes
  96825. * precedence over navigator.baseSeries if defined.
  96826. */
  96827. showInNavigator?: boolean;
  96828. /**
  96829. * (Highcharts) If set to `true`, the accessibility module will skip past
  96830. * the points in this series for keyboard navigation.
  96831. */
  96832. skipKeyboardNavigation?: boolean;
  96833. /**
  96834. * (Highcharts, Highstock) When this is true, the series will not cause the
  96835. * Y axis to cross the zero plane (or threshold option) unless the data
  96836. * actually crosses the plane.
  96837. *
  96838. * For example, if `softThreshold` is `false`, a series of 0, 1, 2, 3 will
  96839. * make the Y axis show negative values according to the `minPadding`
  96840. * option. If `softThreshold` is `true`, the Y axis starts at 0.
  96841. */
  96842. softThreshold?: boolean;
  96843. /**
  96844. * (Highcharts, Highstock) Whether to stack the values of each series on top
  96845. * of each other. Possible values are `undefined` to disable, `"normal"` to
  96846. * stack by value or `"percent"`.
  96847. *
  96848. * When stacking is enabled, data must be sorted in ascending X order.
  96849. *
  96850. * Some stacking options are related to specific series types. In the
  96851. * streamgraph series type, the stacking option is set to `"stream"`. The
  96852. * second one is `"overlap"`, which only applies to waterfall series.
  96853. */
  96854. stacking?: OptionsStackingValue;
  96855. states?: SeriesStatesOptionsObject;
  96856. /**
  96857. * (Highcharts) Sticky tracking of mouse events. When true, the `mouseOut`
  96858. * event on a series isn't triggered until the mouse moves over another
  96859. * series, or out of the plot area. When false, the `mouseOut` event on a
  96860. * series is triggered when the mouse leaves the area around the series'
  96861. * graph or markers. This also implies the tooltip when not shared. When
  96862. * `stickyTracking` is false and `tooltip.shared` is false, the tooltip will
  96863. * be hidden when moving the mouse between series. Defaults to true for line
  96864. * and area type series, but to false for columns, pies etc.
  96865. *
  96866. * **Note:** The boost module will force this option because of technical
  96867. * limitations.
  96868. */
  96869. stickyTracking?: boolean;
  96870. /**
  96871. * (Highcharts) The Y axis value to serve as the base for the columns, for
  96872. * distinguishing between values above and below a threshold. If `null`, the
  96873. * columns extend from the padding Y axis minimum.
  96874. */
  96875. threshold?: (number|null);
  96876. /**
  96877. * (Highcharts) A configuration object for the tooltip rendering of each
  96878. * single series. Properties are inherited from tooltip, but only the
  96879. * following properties can be defined on a series level.
  96880. */
  96881. tooltip?: SeriesTooltipOptionsObject;
  96882. /**
  96883. * (Highcharts, Highstock, Gantt) When a series contains a data array that
  96884. * is longer than this, only one dimensional arrays of numbers, or two
  96885. * dimensional arrays with x and y values are allowed. Also, only the first
  96886. * point is tested, and the rest are assumed to be the same format. This
  96887. * saves expensive data checking and indexing in long series. Set it to `0`
  96888. * disable.
  96889. *
  96890. * Note: In boost mode turbo threshold is forced. Only array of numbers or
  96891. * two dimensional arrays are allowed.
  96892. */
  96893. turboThreshold?: number;
  96894. /**
  96895. * (Highcharts) The color used specifically for positive point columns. When
  96896. * not specified, the general series color is used.
  96897. *
  96898. * In styled mode, the waterfall colors can be set with the
  96899. * `.highcharts-point-negative`, `.highcharts-sum` and
  96900. * `.highcharts-intermediate-sum` classes.
  96901. */
  96902. upColor?: (ColorString|GradientColorObject|PatternObject);
  96903. /**
  96904. * (Highcharts) Set the initial visibility of the series.
  96905. */
  96906. visible?: boolean;
  96907. /**
  96908. * (Highmaps) Define the z index of the series.
  96909. */
  96910. zIndex?: number;
  96911. /**
  96912. * (Highcharts, Highstock) Defines the Axis on which the zones are applied.
  96913. */
  96914. zoneAxis?: string;
  96915. /**
  96916. * (Highcharts, Highstock) An array defining zones within a series. Zones
  96917. * can be applied to the X axis, Y axis or Z axis for bubbles, according to
  96918. * the `zoneAxis` option. The zone definitions have to be in ascending order
  96919. * regarding to the value.
  96920. *
  96921. * In styled mode, the color zones are styled with the
  96922. * `.highcharts-zone-{n}` class, or custom classed from the `className`
  96923. * option (view live demo).
  96924. */
  96925. zones?: Array<SeriesZonesOptionsObject>;
  96926. }
  96927. /**
  96928. * (Highstock) Enable or disable the initial animation when a series is
  96929. * displayed. The animation can also be set as a configuration object. Please
  96930. * note that this option only applies to the initial animation of the series
  96931. * itself. For other animations, see chart.animation and the animation parameter
  96932. * under the API methods. The following properties are supported:
  96933. *
  96934. * - `defer`: The animation delay time in milliseconds.
  96935. *
  96936. * - `duration`: The duration of the animation in milliseconds.
  96937. *
  96938. * - `easing`: Can be a string reference to an easing function set on the `Math`
  96939. * object or a function. See the _Custom easing function_ demo below.
  96940. *
  96941. * Due to poor performance, animation is disabled in old IE browsers for several
  96942. * chart types.
  96943. */
  96944. export interface PlotWilliamsrAnimationOptions {
  96945. defer?: number;
  96946. }
  96947. /**
  96948. * (Highcharts, Highstock, Highmaps, Gantt) Enable or disable the initial
  96949. * animation when a series is displayed for the `dataLabels`. The animation can
  96950. * also be set as a configuration object. Please note that this option only
  96951. * applies to the initial animation. For other animations, see chart.animation
  96952. * and the animation parameter under the API methods. The following properties
  96953. * are supported:
  96954. *
  96955. * - `defer`: The animation delay time in milliseconds.
  96956. */
  96957. export interface PlotWilliamsrDataLabelsAnimationOptions {
  96958. /**
  96959. * (Highcharts, Highstock, Highmaps, Gantt) The animation delay time in
  96960. * milliseconds. Set to `0` renders dataLabel immediately. As `undefined`
  96961. * inherits defer time from the series.animation.defer.
  96962. */
  96963. defer?: number;
  96964. }
  96965. /**
  96966. * (Highcharts, Highstock, Highmaps, Gantt) Options for the series data labels,
  96967. * appearing next to each data point.
  96968. *
  96969. * Since v6.2.0, multiple data labels can be applied to each single point by
  96970. * defining them as an array of configs.
  96971. *
  96972. * In styled mode, the data labels can be styled with the
  96973. * `.highcharts-data-label-box` and `.highcharts-data-label` class names (see
  96974. * example).
  96975. */
  96976. export interface PlotWilliamsrDataLabelsOptions {
  96977. /**
  96978. * (Highcharts, Highstock, Highmaps, Gantt) The alignment of the data label
  96979. * compared to the point. If `right`, the right side of the label should be
  96980. * touching the point. For points with an extent, like columns, the
  96981. * alignments also dictates how to align it inside the box, as given with
  96982. * the inside option. Can be one of `left`, `center` or `right`.
  96983. */
  96984. align?: (AlignValue|null);
  96985. /**
  96986. * (Highcharts, Highstock, Highmaps, Gantt) Whether to allow data labels to
  96987. * overlap. To make the labels less sensitive for overlapping, the
  96988. * dataLabels.padding can be set to 0.
  96989. */
  96990. allowOverlap?: boolean;
  96991. /**
  96992. * (Highcharts, Highstock, Highmaps, Gantt) Enable or disable the initial
  96993. * animation when a series is displayed for the `dataLabels`. The animation
  96994. * can also be set as a configuration object. Please note that this option
  96995. * only applies to the initial animation. For other animations, see
  96996. * chart.animation and the animation parameter under the API methods. The
  96997. * following properties are supported:
  96998. *
  96999. * - `defer`: The animation delay time in milliseconds.
  97000. */
  97001. animation?: (boolean|PlotWilliamsrDataLabelsAnimationOptions|Partial<AnimationOptionsObject>);
  97002. /**
  97003. * (Highcharts, Highstock, Highmaps, Gantt) The background color or gradient
  97004. * for the data label.
  97005. */
  97006. backgroundColor?: (ColorString|GradientColorObject|PatternObject);
  97007. /**
  97008. * (Highcharts, Highstock, Highmaps, Gantt) The border color for the data
  97009. * label. Defaults to `undefined`.
  97010. */
  97011. borderColor?: (ColorString|GradientColorObject|PatternObject);
  97012. /**
  97013. * (Highcharts, Highstock, Highmaps, Gantt) The border radius in pixels for
  97014. * the data label.
  97015. */
  97016. borderRadius?: number;
  97017. /**
  97018. * (Highcharts, Highstock, Highmaps, Gantt) The border width in pixels for
  97019. * the data label.
  97020. */
  97021. borderWidth?: number;
  97022. /**
  97023. * (Highcharts, Highstock, Highmaps, Gantt) A class name for the data label.
  97024. * Particularly in styled mode, this can be used to give each series' or
  97025. * point's data label unique styling. In addition to this option, a default
  97026. * color class name is added so that we can give the labels a contrast text
  97027. * shadow.
  97028. */
  97029. className?: string;
  97030. /**
  97031. * (Highcharts, Highstock, Highmaps, Gantt) The text color for the data
  97032. * labels. Defaults to `undefined`. For certain series types, like column or
  97033. * map, the data labels can be drawn inside the points. In this case the
  97034. * data label will be drawn with maximum contrast by default. Additionally,
  97035. * it will be given a `text-outline` style with the opposite color, to
  97036. * further increase the contrast. This can be overridden by setting the
  97037. * `text-outline` style to `none` in the `dataLabels.style` option.
  97038. */
  97039. color?: (ColorString|GradientColorObject|PatternObject);
  97040. /**
  97041. * (Highcharts, Highstock, Highmaps, Gantt) Whether to hide data labels that
  97042. * are outside the plot area. By default, the data label is moved inside the
  97043. * plot area according to the overflow option.
  97044. */
  97045. crop?: boolean;
  97046. /**
  97047. * (Highcharts, Highstock, Gantt) Whether to defer displaying the data
  97048. * labels until the initial series animation has finished. Setting to
  97049. * `false` renders the data label immediately. If set to `true` inherits the
  97050. * defer time set in plotOptions.series.animation.
  97051. */
  97052. defer?: boolean;
  97053. /**
  97054. * (Highcharts, Highstock, Highmaps, Gantt) Enable or disable the data
  97055. * labels.
  97056. */
  97057. enabled?: boolean;
  97058. /**
  97059. * (Highcharts, Highstock, Highmaps, Gantt) A declarative filter to control
  97060. * of which data labels to display. The declarative filter is designed for
  97061. * use when callback functions are not available, like when the chart
  97062. * options require a pure JSON structure or for use with graphical editors.
  97063. * For programmatic control, use the `formatter` instead, and return
  97064. * `undefined` to disable a single data label.
  97065. */
  97066. filter?: DataLabelsFilterOptionsObject;
  97067. /**
  97068. * (Highcharts, Highstock, Highmaps, Gantt) A format string for the data
  97069. * label. Available variables are the same as for `formatter`.
  97070. */
  97071. format?: string;
  97072. /**
  97073. * (Highcharts, Highstock, Highmaps, Gantt) Callback JavaScript function to
  97074. * format the data label. Note that if a `format` is defined, the format
  97075. * takes precedence and the formatter is ignored.
  97076. */
  97077. formatter?: DataLabelsFormatterCallbackFunction;
  97078. /**
  97079. * (Highcharts, Highstock, Highmaps, Gantt) For points with an extent, like
  97080. * columns or map areas, whether to align the data label inside the box or
  97081. * to the actual value point. Defaults to `false` in most cases, `true` in
  97082. * stacked columns.
  97083. */
  97084. inside?: boolean;
  97085. /**
  97086. * (Highcharts, Highstock, Highmaps, Gantt) Format for points with the value
  97087. * of null. Works analogously to format. `nullFormat` can be applied only to
  97088. * series which support displaying null points.
  97089. */
  97090. nullFormat?: (boolean|string);
  97091. /**
  97092. * (Highcharts, Highstock, Highmaps, Gantt) Callback JavaScript function
  97093. * that defines formatting for points with the value of null. Works
  97094. * analogously to formatter. `nullPointFormatter` can be applied only to
  97095. * series which support displaying null points.
  97096. */
  97097. nullFormatter?: DataLabelsFormatterCallbackFunction;
  97098. /**
  97099. * (Highcharts, Highstock, Highmaps, Gantt) How to handle data labels that
  97100. * flow outside the plot area. The default is `"justify"`, which aligns them
  97101. * inside the plot area. For columns and bars, this means it will be moved
  97102. * inside the bar. To display data labels outside the plot area, set `crop`
  97103. * to `false` and `overflow` to `"allow"`.
  97104. */
  97105. overflow?: DataLabelsOverflowValue;
  97106. /**
  97107. * (Highcharts, Highstock, Highmaps, Gantt) When either the `borderWidth` or
  97108. * the `backgroundColor` is set, this is the padding within the box.
  97109. */
  97110. padding?: number;
  97111. /**
  97112. * (Highcharts, Highstock, Highmaps, Gantt) Aligns data labels relative to
  97113. * points. If `center` alignment is not possible, it defaults to `right`.
  97114. */
  97115. position?: AlignValue;
  97116. /**
  97117. * (Highcharts, Highstock, Highmaps, Gantt) Text rotation in degrees. Note
  97118. * that due to a more complex structure, backgrounds, borders and padding
  97119. * will be lost on a rotated data label.
  97120. */
  97121. rotation?: number;
  97122. /**
  97123. * (Highcharts, Highstock, Highmaps, Gantt) The shadow of the box. Works
  97124. * best with `borderWidth` or `backgroundColor`. Since 2.3 the shadow can be
  97125. * an object configuration containing `color`, `offsetX`, `offsetY`,
  97126. * `opacity` and `width`.
  97127. */
  97128. shadow?: (boolean|ShadowOptionsObject);
  97129. /**
  97130. * (Highcharts, Highstock, Highmaps, Gantt) The name of a symbol to use for
  97131. * the border around the label. Symbols are predefined functions on the
  97132. * Renderer object.
  97133. */
  97134. shape?: string;
  97135. /**
  97136. * (Highcharts, Highstock, Highmaps, Gantt) Styles for the label. The
  97137. * default `color` setting is `"contrast"`, which is a pseudo color that
  97138. * Highcharts picks up and applies the maximum contrast to the underlying
  97139. * point item, for example the bar in a bar chart.
  97140. *
  97141. * The `textOutline` is a pseudo property that applies an outline of the
  97142. * given width with the given color, which by default is the maximum
  97143. * contrast to the text. So a bright text color will result in a black text
  97144. * outline for maximum readability on a mixed background. In some cases,
  97145. * especially with grayscale text, the text outline doesn't work well, in
  97146. * which cases it can be disabled by setting it to `"none"`. When `useHTML`
  97147. * is true, the `textOutline` will not be picked up. In this, case, the same
  97148. * effect can be acheived through the `text-shadow` CSS property.
  97149. *
  97150. * For some series types, where each point has an extent, like for example
  97151. * tree maps, the data label may overflow the point. There are two
  97152. * strategies for handling overflow. By default, the text will wrap to
  97153. * multiple lines. The other strategy is to set `style.textOverflow` to
  97154. * `ellipsis`, which will keep the text on one line plus it will break
  97155. * inside long words.
  97156. */
  97157. style?: CSSObject;
  97158. /**
  97159. * (Highcharts, Highstock, Highmaps, Gantt) Options for a label text which
  97160. * should follow marker's shape. Border and background are disabled for a
  97161. * label that follows a path.
  97162. *
  97163. * **Note:** Only SVG-based renderer supports this option. Setting `useHTML`
  97164. * to true will disable this option.
  97165. */
  97166. textPath?: DataLabelsTextPathOptionsObject;
  97167. /**
  97168. * (Highcharts, Highstock, Highmaps, Gantt) Whether to use HTML to render
  97169. * the labels.
  97170. */
  97171. useHTML?: boolean;
  97172. /**
  97173. * (Highcharts, Highstock, Highmaps, Gantt) The vertical alignment of a data
  97174. * label. Can be one of `top`, `middle` or `bottom`. The default value
  97175. * depends on the data, for instance in a column chart, the label is above
  97176. * positive values and below negative values.
  97177. */
  97178. verticalAlign?: (VerticalAlignValue|null);
  97179. /**
  97180. * (Highcharts, Highstock, Highmaps, Gantt) The x position offset of the
  97181. * label relative to the point in pixels.
  97182. */
  97183. x?: number;
  97184. /**
  97185. * (Highcharts, Highstock, Highmaps, Gantt) The y position offset of the
  97186. * label relative to the point in pixels.
  97187. */
  97188. y?: number;
  97189. /**
  97190. * (Highcharts, Highstock, Highmaps, Gantt) The Z index of the data labels.
  97191. * The default Z index puts it above the series. Use a Z index of 2 to
  97192. * display it behind the series.
  97193. */
  97194. z?: number;
  97195. }
  97196. /**
  97197. * (Highcharts, Highstock) Options for the series data sorting.
  97198. */
  97199. export interface PlotWilliamsrDataSortingOptions {
  97200. /**
  97201. * (Highcharts, Highstock) Enable or disable data sorting for the series.
  97202. * Use xAxis.reversed to change the sorting order.
  97203. */
  97204. enabled?: boolean;
  97205. /**
  97206. * (Highcharts, Highstock) Whether to allow matching points by name in an
  97207. * update. If this option is disabled, points will be matched by order.
  97208. */
  97209. matchByName?: boolean;
  97210. /**
  97211. * (Highcharts, Highstock) Determines what data value should be used to sort
  97212. * by.
  97213. */
  97214. sortKey?: string;
  97215. }
  97216. /**
  97217. * (Highstock) Williams %R. This series requires the `linkedTo` option to be set
  97218. * and should be loaded after the `stock/indicators/indicators.js`.
  97219. *
  97220. * In TypeScript the type option must always be set.
  97221. *
  97222. * Configuration options for the series are given in three levels:
  97223. *
  97224. * 1. Options for all series in a chart are defined in the plotOptions.series
  97225. * object.
  97226. *
  97227. * 2. Options for all `williamsr` series are defined in plotOptions.williamsr.
  97228. *
  97229. * 3. Options for one single series are given in the series instance array. (see
  97230. * online documentation for example)
  97231. */
  97232. export interface PlotWilliamsrOptions {
  97233. /**
  97234. * (Highstock) Accessibility options for a series.
  97235. */
  97236. accessibility?: SeriesAccessibilityOptionsObject;
  97237. /**
  97238. * (Highstock) Allow this series' points to be selected by clicking on the
  97239. * graphic (columns, point markers, pie slices, map areas etc).
  97240. *
  97241. * The selected points can be handled by point select and unselect events,
  97242. * or collectively by the getSelectedPoints function.
  97243. *
  97244. * And alternative way of selecting points is through dragging.
  97245. */
  97246. allowPointSelect?: boolean;
  97247. /**
  97248. * (Highstock) Enable or disable the initial animation when a series is
  97249. * displayed. The animation can also be set as a configuration object.
  97250. * Please note that this option only applies to the initial animation of the
  97251. * series itself. For other animations, see chart.animation and the
  97252. * animation parameter under the API methods. The following properties are
  97253. * supported:
  97254. *
  97255. * - `defer`: The animation delay time in milliseconds.
  97256. *
  97257. * - `duration`: The duration of the animation in milliseconds.
  97258. *
  97259. * - `easing`: Can be a string reference to an easing function set on the
  97260. * `Math` object or a function. See the _Custom easing function_ demo below.
  97261. *
  97262. * Due to poor performance, animation is disabled in old IE browsers for
  97263. * several chart types.
  97264. */
  97265. animation?: (boolean|PlotWilliamsrAnimationOptions|Partial<AnimationOptionsObject>);
  97266. /**
  97267. * (Highstock) For some series, there is a limit that shuts down initial
  97268. * animation by default when the total number of points in the chart is too
  97269. * high. For example, for a column chart and its derivatives, animation does
  97270. * not run if there is more than 250 points totally. To disable this cap,
  97271. * set `animationLimit` to `Infinity`.
  97272. */
  97273. animationLimit?: number;
  97274. /**
  97275. * (Highstock) Sets the color blending in the boost module.
  97276. */
  97277. boostBlending?: OptionsBoostBlendingValue;
  97278. /**
  97279. * (Highstock) Set the point threshold for when a series should enter boost
  97280. * mode.
  97281. *
  97282. * Setting it to e.g. 2000 will cause the series to enter boost mode when
  97283. * there are 2000 or more points in the series.
  97284. *
  97285. * To disable boosting on the series, set the `boostThreshold` to 0. Setting
  97286. * it to 1 will force boosting.
  97287. *
  97288. * Note that the cropThreshold also affects this setting. When zooming in on
  97289. * a series that has fewer points than the `cropThreshold`, all points are
  97290. * rendered although outside the visible plot area, and the `boostThreshold`
  97291. * won't take effect.
  97292. */
  97293. boostThreshold?: number;
  97294. /**
  97295. * (Highmaps) The border color of the map areas.
  97296. *
  97297. * In styled mode, the border stroke is given in the `.highcharts-point`
  97298. * class.
  97299. */
  97300. borderColor?: (ColorString|GradientColorObject|PatternObject);
  97301. /**
  97302. * (Highmaps) The border width of each map area.
  97303. *
  97304. * In styled mode, the border stroke width is given in the
  97305. * `.highcharts-point` class.
  97306. */
  97307. borderWidth?: number;
  97308. /**
  97309. * (Highstock) An additional class name to apply to the series' graphical
  97310. * elements. This option does not replace default class names of the
  97311. * graphical element.
  97312. */
  97313. className?: string;
  97314. /**
  97315. * (Highstock) Disable this option to allow series rendering in the whole
  97316. * plotting area.
  97317. *
  97318. * **Note:** Clipping should be always enabled when chart.zoomType is set
  97319. */
  97320. clip?: boolean;
  97321. /**
  97322. * (Highstock) The main color of the series. In line type series it applies
  97323. * to the line and the point markers unless otherwise specified. In bar type
  97324. * series it applies to the bars unless a color is specified per point. The
  97325. * default value is pulled from the `options.colors` array.
  97326. *
  97327. * In styled mode, the color can be defined by the colorIndex option. Also,
  97328. * the series color can be set with the `.highcharts-series`,
  97329. * `.highcharts-color-{n}`, `.highcharts-{type}-series` or
  97330. * `.highcharts-series-{n}` class, or individual classes given by the
  97331. * `className` option.
  97332. */
  97333. color?: (ColorString|GradientColorObject|PatternObject);
  97334. /**
  97335. * (Highstock) Styled mode only. A specific color index to use for the
  97336. * series, so its graphic representations are given the class name
  97337. * `highcharts-color-{n}`.
  97338. */
  97339. colorIndex?: number;
  97340. /**
  97341. * (Highcharts, Highstock, Highmaps) Determines what data value should be
  97342. * used to calculate point color if `colorAxis` is used. Requires to set
  97343. * `min` and `max` if some custom point property is used or if approximation
  97344. * for data grouping is set to `'sum'`.
  97345. */
  97346. colorKey?: string;
  97347. /**
  97348. * (Highstock) Compare the values of the series against the first non-null,
  97349. * non- zero value in the visible range. The y axis will show percentage or
  97350. * absolute change depending on whether `compare` is set to `"percent"` or
  97351. * `"value"`. When this is applied to multiple series, it allows comparing
  97352. * the development of the series against each other. Adds a `change` field
  97353. * to every point object.
  97354. */
  97355. compare?: string;
  97356. /**
  97357. * (Highstock) When compare is `percent`, this option dictates whether to
  97358. * use 0 or 100 as the base of comparison.
  97359. */
  97360. compareBase?: (0|100);
  97361. /**
  97362. * (Highstock) Defines if comparison should start from the first point
  97363. * within the visible range or should start from the first point **before**
  97364. * the range.
  97365. *
  97366. * In other words, this flag determines if first point within the visible
  97367. * range will have 0% (`compareStart=true`) or should have been already
  97368. * calculated according to the previous point (`compareStart=false`).
  97369. */
  97370. compareStart?: boolean;
  97371. /**
  97372. * (Highstock) Whether to compare indicator to the main series values or
  97373. * indicator values.
  97374. */
  97375. compareToMain?: boolean;
  97376. /**
  97377. * (Highcharts) Polar charts only. Whether to connect the ends of a line
  97378. * series plot across the extremes.
  97379. */
  97380. connectEnds?: boolean;
  97381. /**
  97382. * (Highcharts, Highstock) Whether to connect a graph line across null
  97383. * points, or render a gap between the two points on either side of the
  97384. * null.
  97385. */
  97386. connectNulls?: boolean;
  97387. /**
  97388. * (Gantt) Override Pathfinder connector options for a series. Requires
  97389. * Highcharts Gantt to be loaded.
  97390. */
  97391. connectors?: SeriesConnectorsOptionsObject;
  97392. /**
  97393. * (Highcharts, Highstock, Gantt) When true, each point or column edge is
  97394. * rounded to its nearest pixel in order to render sharp on screen. In some
  97395. * cases, when there are a lot of densely packed columns, this leads to
  97396. * visible difference in column widths or distance between columns. In these
  97397. * cases, setting `crisp` to `false` may look better, even though each
  97398. * column is rendered blurry.
  97399. */
  97400. crisp?: boolean;
  97401. /**
  97402. * (Highcharts, Highstock) When the series contains less points than the
  97403. * crop threshold, all points are drawn, even if the points fall outside the
  97404. * visible plot area at the current zoom. The advantage of drawing all
  97405. * points (including markers and columns), is that animation is performed on
  97406. * updates. On the other hand, when the series contains more points than the
  97407. * crop threshold, the series data is cropped to only contain points that
  97408. * fall within the plot area. The advantage of cropping away invisible
  97409. * points is to increase performance on large series.
  97410. */
  97411. cropThreshold?: number;
  97412. /**
  97413. * (Highstock) You can set the cursor to "pointer" if you have click events
  97414. * attached to the series, to signal to the user that the points and lines
  97415. * can be clicked.
  97416. *
  97417. * In styled mode, the series cursor can be set with the same classes as
  97418. * listed under series.color.
  97419. */
  97420. cursor?: (string|CursorValue);
  97421. /**
  97422. * (Highstock) A reserved subspace to store options and values for
  97423. * customized functionality. Here you can add additional data for your own
  97424. * event callbacks and formatter callbacks.
  97425. */
  97426. custom?: Dictionary<any>;
  97427. /**
  97428. * (Highstock) Name of the dash style to use for the graph, or for some
  97429. * series types the outline of each shape.
  97430. *
  97431. * In styled mode, the stroke dash-array can be set with the same classes as
  97432. * listed under series.color.
  97433. */
  97434. dashStyle?: DashStyleValue;
  97435. /**
  97436. * (Highstock) Data grouping is the concept of sampling the data values into
  97437. * larger blocks in order to ease readability and increase performance of
  97438. * the JavaScript charts. Highstock by default applies data grouping when
  97439. * the points become closer than a certain pixel value, determined by the
  97440. * `groupPixelWidth` option.
  97441. *
  97442. * If data grouping is applied, the grouping information of grouped points
  97443. * can be read from the Point.dataGroup. If point options other than the
  97444. * data itself are set, for example `name` or `color` or custom properties,
  97445. * the grouping logic doesn't know how to group it. In this case the options
  97446. * of the first point instance are copied over to the group point. This can
  97447. * be altered through a custom `approximation` callback function.
  97448. */
  97449. dataGrouping?: DataGroupingOptionsObject;
  97450. /**
  97451. * (Highcharts, Highstock, Highmaps, Gantt) Options for the series data
  97452. * labels, appearing next to each data point.
  97453. *
  97454. * Since v6.2.0, multiple data labels can be applied to each single point by
  97455. * defining them as an array of configs.
  97456. *
  97457. * In styled mode, the data labels can be styled with the
  97458. * `.highcharts-data-label-box` and `.highcharts-data-label` class names
  97459. * (see example).
  97460. */
  97461. dataLabels?: (PlotWilliamsrDataLabelsOptions|Array<PlotWilliamsrDataLabelsOptions>);
  97462. /**
  97463. * (Highcharts, Highstock) Options for the series data sorting.
  97464. */
  97465. dataSorting?: (DataSortingOptionsObject|PlotWilliamsrDataSortingOptions);
  97466. /**
  97467. * (Highstock) A description of the series to add to the screen reader
  97468. * information about the series.
  97469. */
  97470. description?: string;
  97471. /**
  97472. * (Highstock) Enable or disable the mouse tracking for a specific series.
  97473. * This includes point tooltips and click events on graphs and points. For
  97474. * large datasets it improves performance.
  97475. */
  97476. enableMouseTracking?: boolean;
  97477. /**
  97478. * (Highstock) General event handlers for the series items. These event
  97479. * hooks can also be attached to the series at run time using the
  97480. * `Highcharts.addEvent` function.
  97481. */
  97482. events?: SeriesEventsOptionsObject;
  97483. /**
  97484. * (Highstock) Determines whether the series should look for the nearest
  97485. * point in both dimensions or just the x-dimension when hovering the
  97486. * series. Defaults to `'xy'` for scatter series and `'x'` for most other
  97487. * series. If the data has duplicate x-values, it is recommended to set this
  97488. * to `'xy'` to allow hovering over all points.
  97489. *
  97490. * Applies only to series types using nearest neighbor search (not direct
  97491. * hover) for tooltip.
  97492. */
  97493. findNearestPointBy?: OptionsFindNearestPointByValue;
  97494. /**
  97495. * (Highstock) Defines when to display a gap in the graph, together with the
  97496. * gapUnit option.
  97497. *
  97498. * In case when `dataGrouping` is enabled, points can be grouped into a
  97499. * larger time span. This can make the grouped points to have a greater
  97500. * distance than the absolute value of `gapSize` property, which will result
  97501. * in disappearing graph completely. To prevent this situation the mentioned
  97502. * distance between grouped points is used instead of previously defined
  97503. * `gapSize`.
  97504. *
  97505. * In practice, this option is most often used to visualize gaps in time
  97506. * series. In a stock chart, intraday data is available for daytime hours,
  97507. * while gaps will appear in nights and weekends.
  97508. */
  97509. gapSize?: number;
  97510. /**
  97511. * (Highstock) Together with gapSize, this option defines where to draw gaps
  97512. * in the graph.
  97513. *
  97514. * When the `gapUnit` is `"relative"` (default), a gap size of 5 means that
  97515. * if the distance between two points is greater than 5 times that of the
  97516. * two closest points, the graph will be broken.
  97517. *
  97518. * When the `gapUnit` is `"value"`, the gap is based on absolute axis
  97519. * values, which on a datetime axis is milliseconds. This also applies to
  97520. * the navigator series that inherits gap options from the base series.
  97521. */
  97522. gapUnit?: OptionsGapUnitValue;
  97523. /**
  97524. * (Highcharts, Highstock, Gantt) Whether to use the Y extremes of the total
  97525. * chart width or only the zoomed area when zooming in on parts of the X
  97526. * axis. By default, the Y axis adjusts to the min and max of the visible
  97527. * data. Cartesian series only.
  97528. */
  97529. getExtremesFromAll?: boolean;
  97530. /**
  97531. * (Highstock) When set to `false` will prevent the series data from being
  97532. * included in any form of data export.
  97533. *
  97534. * Since version 6.0.0 until 7.1.0 the option was existing undocumented as
  97535. * `includeInCSVExport`.
  97536. */
  97537. includeInDataExport?: boolean;
  97538. /**
  97539. * (Highcharts, Highstock, Gantt) Series labels are placed as close to the
  97540. * series as possible in a natural way, seeking to avoid other series. The
  97541. * goal of this feature is to make the chart more easily readable, like if a
  97542. * human designer placed the labels in the optimal position.
  97543. *
  97544. * The series labels currently work with series types having a `graph` or an
  97545. * `area`.
  97546. */
  97547. label?: SeriesLabelOptionsObject;
  97548. /**
  97549. * (Highstock) The line marks the last price from all points.
  97550. */
  97551. lastPrice?: SeriesLastPriceOptionsObject;
  97552. /**
  97553. * (Highstock) The line marks the last price from visible range of points.
  97554. */
  97555. lastVisiblePrice?: SeriesLastVisiblePriceOptionsObject;
  97556. /**
  97557. * (Highcharts, Highstock) The SVG value used for the `stroke-linecap` and
  97558. * `stroke-linejoin` of a line graph. Round means that lines are rounded in
  97559. * the ends and bends.
  97560. */
  97561. linecap?: SeriesLinecapValue;
  97562. /**
  97563. * (Highcharts, Highstock) Pixel width of the graph line.
  97564. */
  97565. lineWidth?: number;
  97566. /**
  97567. * (Highcharts, Highstock, Gantt) The main series ID that indicator will be
  97568. * based on. Required for this indicator.
  97569. */
  97570. linkedTo?: string;
  97571. /**
  97572. * (Highstock) Options for the point markers of line-like series. Properties
  97573. * like `fillColor`, `lineColor` and `lineWidth` define the visual
  97574. * appearance of the markers. Other series types, like column series, don't
  97575. * have markers, but have visual options on the series level instead.
  97576. *
  97577. * In styled mode, the markers can be styled with the `.highcharts-point`,
  97578. * `.highcharts-point-hover` and `.highcharts-point-select` class names.
  97579. */
  97580. marker?: PointMarkerOptionsObject;
  97581. /**
  97582. * (Highstock) The name of the series as shown in the legend, tooltip etc.
  97583. * If not set, it will be based on a technical indicator type and default
  97584. * params.
  97585. */
  97586. name?: string;
  97587. /**
  97588. * (Highstock) The color for the parts of the graph or points that are below
  97589. * the threshold. Note that `zones` takes precedence over the negative
  97590. * color. Using `negativeColor` is equivalent to applying a zone with value
  97591. * of 0.
  97592. */
  97593. negativeColor?: (ColorString|GradientColorObject|PatternObject);
  97594. /**
  97595. * (Highstock) Opacity of a series parts: line, fill (e.g. area) and
  97596. * dataLabels.
  97597. */
  97598. opacity?: number;
  97599. /**
  97600. * (Highstock) Paramters used in calculation of Williams %R series points.
  97601. */
  97602. params?: PlotWilliamsrParamsOptions;
  97603. /**
  97604. * (Highstock) Properties for each single point.
  97605. */
  97606. point?: PlotSeriesPointOptions;
  97607. /**
  97608. * (Highstock) Same as accessibility.pointDescriptionFormatter, but for an
  97609. * individual series. Overrides the chart wide configuration.
  97610. */
  97611. pointDescriptionFormatter?: Function;
  97612. /**
  97613. * (Highstock) Whether to select the series initially. If `showCheckbox` is
  97614. * true, the checkbox next to the series name in the legend will be checked
  97615. * for a selected series.
  97616. */
  97617. selected?: boolean;
  97618. /**
  97619. * (Highstock) Whether to apply a drop shadow to the graph line. Since 2.3
  97620. * the shadow can be an object configuration containing `color`, `offsetX`,
  97621. * `offsetY`, `opacity` and `width`.
  97622. */
  97623. shadow?: (boolean|ShadowOptionsObject);
  97624. /**
  97625. * (Highstock) If true, a checkbox is displayed next to the legend item to
  97626. * allow selecting the series. The state of the checkbox is determined by
  97627. * the `selected` option.
  97628. */
  97629. showCheckbox?: boolean;
  97630. /**
  97631. * (Highstock) Whether to display this particular series or series type in
  97632. * the legend. Standalone series are shown in legend by default, and linked
  97633. * series are not. Since v7.2.0 it is possible to show series that use
  97634. * colorAxis by setting this option to `true`.
  97635. */
  97636. showInLegend?: boolean;
  97637. /**
  97638. * (Highstock) If set to `true`, the accessibility module will skip past the
  97639. * points in this series for keyboard navigation.
  97640. */
  97641. skipKeyboardNavigation?: boolean;
  97642. /**
  97643. * (Highcharts, Highstock) When this is true, the series will not cause the
  97644. * Y axis to cross the zero plane (or threshold option) unless the data
  97645. * actually crosses the plane.
  97646. *
  97647. * For example, if `softThreshold` is `false`, a series of 0, 1, 2, 3 will
  97648. * make the Y axis show negative values according to the `minPadding`
  97649. * option. If `softThreshold` is `true`, the Y axis starts at 0.
  97650. */
  97651. softThreshold?: boolean;
  97652. states?: SeriesStatesOptionsObject;
  97653. /**
  97654. * (Highcharts, Highstock) Whether to apply steps to the line. Possible
  97655. * values are `left`, `center` and `right`.
  97656. */
  97657. step?: OptionsStepValue;
  97658. /**
  97659. * (Highstock) Sticky tracking of mouse events. When true, the `mouseOut`
  97660. * event on a series isn't triggered until the mouse moves over another
  97661. * series, or out of the plot area. When false, the `mouseOut` event on a
  97662. * series is triggered when the mouse leaves the area around the series'
  97663. * graph or markers. This also implies the tooltip when not shared. When
  97664. * `stickyTracking` is false and `tooltip.shared` is false, the tooltip will
  97665. * be hidden when moving the mouse between series. Defaults to true for line
  97666. * and area type series, but to false for columns, pies etc.
  97667. *
  97668. * **Note:** The boost module will force this option because of technical
  97669. * limitations.
  97670. */
  97671. stickyTracking?: boolean;
  97672. /**
  97673. * (Highcharts, Highstock) The threshold, also called zero level or base
  97674. * level. For line type series this is only used in conjunction with
  97675. * negativeColor.
  97676. */
  97677. threshold?: (number|null);
  97678. /**
  97679. * (Highstock) A configuration object for the tooltip rendering of each
  97680. * single series. Properties are inherited from tooltip, but only the
  97681. * following properties can be defined on a series level.
  97682. */
  97683. tooltip?: SeriesTooltipOptionsObject;
  97684. /**
  97685. * (Highcharts, Highstock, Gantt) When a series contains a data array that
  97686. * is longer than this, only one dimensional arrays of numbers, or two
  97687. * dimensional arrays with x and y values are allowed. Also, only the first
  97688. * point is tested, and the rest are assumed to be the same format. This
  97689. * saves expensive data checking and indexing in long series. Set it to `0`
  97690. * disable.
  97691. *
  97692. * Note: In boost mode turbo threshold is forced. Only array of numbers or
  97693. * two dimensional arrays are allowed.
  97694. */
  97695. turboThreshold?: number;
  97696. /**
  97697. * (Highstock) Set the initial visibility of the series.
  97698. */
  97699. visible?: boolean;
  97700. /**
  97701. * (Highmaps) Define the z index of the series.
  97702. */
  97703. zIndex?: number;
  97704. /**
  97705. * (Highcharts, Highstock) Defines the Axis on which the zones are applied.
  97706. */
  97707. zoneAxis?: string;
  97708. /**
  97709. * (Highcharts, Highstock) An array defining zones within a series. Zones
  97710. * can be applied to the X axis, Y axis or Z axis for bubbles, according to
  97711. * the `zoneAxis` option. The zone definitions have to be in ascending order
  97712. * regarding to the value.
  97713. *
  97714. * In styled mode, the color zones are styled with the
  97715. * `.highcharts-zone-{n}` class, or custom classed from the `className`
  97716. * option (view live demo).
  97717. */
  97718. zones?: Array<SeriesZonesOptionsObject>;
  97719. }
  97720. /**
  97721. * (Highstock) Paramters used in calculation of Williams %R series points.
  97722. */
  97723. export interface PlotWilliamsrParamsOptions {
  97724. /**
  97725. * (Highstock) Period for Williams %R oscillator
  97726. */
  97727. period?: number;
  97728. }
  97729. /**
  97730. * (Highcharts, Highstock) Enable or disable the initial animation when a series
  97731. * is displayed. The animation can also be set as a configuration object. Please
  97732. * note that this option only applies to the initial animation of the series
  97733. * itself. For other animations, see chart.animation and the animation parameter
  97734. * under the API methods. The following properties are supported:
  97735. *
  97736. * - `defer`: The animation delay time in milliseconds.
  97737. *
  97738. * - `duration`: The duration of the animation in milliseconds.
  97739. *
  97740. * - `easing`: Can be a string reference to an easing function set on the `Math`
  97741. * object or a function. See the _Custom easing function_ demo below.
  97742. *
  97743. * Due to poor performance, animation is disabled in old IE browsers for several
  97744. * chart types.
  97745. */
  97746. export interface PlotWindbarbAnimationOptions {
  97747. defer?: number;
  97748. }
  97749. /**
  97750. * (Highcharts, Highstock, Highmaps, Gantt) Enable or disable the initial
  97751. * animation when a series is displayed for the `dataLabels`. The animation can
  97752. * also be set as a configuration object. Please note that this option only
  97753. * applies to the initial animation. For other animations, see chart.animation
  97754. * and the animation parameter under the API methods. The following properties
  97755. * are supported:
  97756. *
  97757. * - `defer`: The animation delay time in milliseconds.
  97758. */
  97759. export interface PlotWindbarbDataLabelsAnimationOptions {
  97760. /**
  97761. * (Highcharts, Highstock, Highmaps, Gantt) The animation delay time in
  97762. * milliseconds. Set to `0` renders dataLabel immediately. As `undefined`
  97763. * inherits defer time from the series.animation.defer.
  97764. */
  97765. defer?: number;
  97766. }
  97767. /**
  97768. * (Highcharts, Highstock, Highmaps, Gantt) Options for the series data labels,
  97769. * appearing next to each data point.
  97770. *
  97771. * Since v6.2.0, multiple data labels can be applied to each single point by
  97772. * defining them as an array of configs.
  97773. *
  97774. * In styled mode, the data labels can be styled with the
  97775. * `.highcharts-data-label-box` and `.highcharts-data-label` class names (see
  97776. * example).
  97777. */
  97778. export interface PlotWindbarbDataLabelsOptions {
  97779. /**
  97780. * (Highcharts, Highstock, Highmaps, Gantt) The alignment of the data label
  97781. * compared to the point. If `right`, the right side of the label should be
  97782. * touching the point. For points with an extent, like columns, the
  97783. * alignments also dictates how to align it inside the box, as given with
  97784. * the inside option. Can be one of `left`, `center` or `right`.
  97785. */
  97786. align?: string;
  97787. /**
  97788. * (Highcharts, Highstock, Highmaps, Gantt) Whether to allow data labels to
  97789. * overlap. To make the labels less sensitive for overlapping, the
  97790. * dataLabels.padding can be set to 0.
  97791. */
  97792. allowOverlap?: boolean;
  97793. /**
  97794. * (Highcharts, Highstock, Highmaps, Gantt) Enable or disable the initial
  97795. * animation when a series is displayed for the `dataLabels`. The animation
  97796. * can also be set as a configuration object. Please note that this option
  97797. * only applies to the initial animation. For other animations, see
  97798. * chart.animation and the animation parameter under the API methods. The
  97799. * following properties are supported:
  97800. *
  97801. * - `defer`: The animation delay time in milliseconds.
  97802. */
  97803. animation?: (boolean|PlotWindbarbDataLabelsAnimationOptions|Partial<AnimationOptionsObject>);
  97804. /**
  97805. * (Highcharts, Highstock, Highmaps, Gantt) The background color or gradient
  97806. * for the data label.
  97807. */
  97808. backgroundColor?: (ColorString|GradientColorObject|PatternObject);
  97809. /**
  97810. * (Highcharts, Highstock, Highmaps, Gantt) The border color for the data
  97811. * label. Defaults to `undefined`.
  97812. */
  97813. borderColor?: (ColorString|GradientColorObject|PatternObject);
  97814. /**
  97815. * (Highcharts, Highstock, Highmaps, Gantt) The border radius in pixels for
  97816. * the data label.
  97817. */
  97818. borderRadius?: number;
  97819. /**
  97820. * (Highcharts, Highstock, Highmaps, Gantt) The border width in pixels for
  97821. * the data label.
  97822. */
  97823. borderWidth?: number;
  97824. /**
  97825. * (Highcharts, Highstock, Highmaps, Gantt) A class name for the data label.
  97826. * Particularly in styled mode, this can be used to give each series' or
  97827. * point's data label unique styling. In addition to this option, a default
  97828. * color class name is added so that we can give the labels a contrast text
  97829. * shadow.
  97830. */
  97831. className?: string;
  97832. /**
  97833. * (Highcharts, Highstock, Highmaps, Gantt) The text color for the data
  97834. * labels. Defaults to `undefined`. For certain series types, like column or
  97835. * map, the data labels can be drawn inside the points. In this case the
  97836. * data label will be drawn with maximum contrast by default. Additionally,
  97837. * it will be given a `text-outline` style with the opposite color, to
  97838. * further increase the contrast. This can be overridden by setting the
  97839. * `text-outline` style to `none` in the `dataLabels.style` option.
  97840. */
  97841. color?: (ColorString|GradientColorObject|PatternObject);
  97842. /**
  97843. * (Highcharts, Highstock, Highmaps, Gantt) Whether to hide data labels that
  97844. * are outside the plot area. By default, the data label is moved inside the
  97845. * plot area according to the overflow option.
  97846. */
  97847. crop?: boolean;
  97848. /**
  97849. * (Highcharts, Highstock, Gantt) Whether to defer displaying the data
  97850. * labels until the initial series animation has finished. Setting to
  97851. * `false` renders the data label immediately. If set to `true` inherits the
  97852. * defer time set in plotOptions.series.animation.
  97853. */
  97854. defer?: boolean;
  97855. /**
  97856. * (Highcharts, Highstock, Highmaps, Gantt) Enable or disable the data
  97857. * labels.
  97858. */
  97859. enabled?: boolean;
  97860. /**
  97861. * (Highcharts, Highstock, Highmaps, Gantt) A declarative filter to control
  97862. * of which data labels to display. The declarative filter is designed for
  97863. * use when callback functions are not available, like when the chart
  97864. * options require a pure JSON structure or for use with graphical editors.
  97865. * For programmatic control, use the `formatter` instead, and return
  97866. * `undefined` to disable a single data label.
  97867. */
  97868. filter?: DataLabelsFilterOptionsObject;
  97869. /**
  97870. * (Highcharts, Highstock, Highmaps, Gantt) A format string for the data
  97871. * label. Available variables are the same as for `formatter`.
  97872. */
  97873. format?: string;
  97874. /**
  97875. * (Highcharts, Highstock, Highmaps, Gantt) Callback JavaScript function to
  97876. * format the data label. Note that if a `format` is defined, the format
  97877. * takes precedence and the formatter is ignored.
  97878. */
  97879. formatter?: DataLabelsFormatterCallbackFunction;
  97880. /**
  97881. * (Highcharts, Highstock, Highmaps, Gantt) For points with an extent, like
  97882. * columns or map areas, whether to align the data label inside the box or
  97883. * to the actual value point. Defaults to `false` in most cases, `true` in
  97884. * stacked columns.
  97885. */
  97886. inside?: boolean;
  97887. /**
  97888. * (Highcharts, Highstock, Highmaps, Gantt) Format for points with the value
  97889. * of null. Works analogously to format. `nullFormat` can be applied only to
  97890. * series which support displaying null points.
  97891. */
  97892. nullFormat?: (boolean|string);
  97893. /**
  97894. * (Highcharts, Highstock, Highmaps, Gantt) Callback JavaScript function
  97895. * that defines formatting for points with the value of null. Works
  97896. * analogously to formatter. `nullPointFormatter` can be applied only to
  97897. * series which support displaying null points.
  97898. */
  97899. nullFormatter?: DataLabelsFormatterCallbackFunction;
  97900. /**
  97901. * (Highcharts, Highstock, Highmaps, Gantt) How to handle data labels that
  97902. * flow outside the plot area. The default is `"justify"`, which aligns them
  97903. * inside the plot area. For columns and bars, this means it will be moved
  97904. * inside the bar. To display data labels outside the plot area, set `crop`
  97905. * to `false` and `overflow` to `"allow"`.
  97906. */
  97907. overflow?: DataLabelsOverflowValue;
  97908. /**
  97909. * (Highcharts, Highstock, Highmaps, Gantt) When either the `borderWidth` or
  97910. * the `backgroundColor` is set, this is the padding within the box.
  97911. */
  97912. padding?: number;
  97913. /**
  97914. * (Highcharts, Highstock, Highmaps, Gantt) Aligns data labels relative to
  97915. * points. If `center` alignment is not possible, it defaults to `right`.
  97916. */
  97917. position?: AlignValue;
  97918. /**
  97919. * (Highcharts, Highstock, Highmaps, Gantt) Text rotation in degrees. Note
  97920. * that due to a more complex structure, backgrounds, borders and padding
  97921. * will be lost on a rotated data label.
  97922. */
  97923. rotation?: number;
  97924. /**
  97925. * (Highcharts, Highstock, Highmaps, Gantt) The shadow of the box. Works
  97926. * best with `borderWidth` or `backgroundColor`. Since 2.3 the shadow can be
  97927. * an object configuration containing `color`, `offsetX`, `offsetY`,
  97928. * `opacity` and `width`.
  97929. */
  97930. shadow?: (boolean|ShadowOptionsObject);
  97931. /**
  97932. * (Highcharts, Highstock, Highmaps, Gantt) The name of a symbol to use for
  97933. * the border around the label. Symbols are predefined functions on the
  97934. * Renderer object.
  97935. */
  97936. shape?: string;
  97937. /**
  97938. * (Highcharts, Highstock, Highmaps, Gantt) Styles for the label. The
  97939. * default `color` setting is `"contrast"`, which is a pseudo color that
  97940. * Highcharts picks up and applies the maximum contrast to the underlying
  97941. * point item, for example the bar in a bar chart.
  97942. *
  97943. * The `textOutline` is a pseudo property that applies an outline of the
  97944. * given width with the given color, which by default is the maximum
  97945. * contrast to the text. So a bright text color will result in a black text
  97946. * outline for maximum readability on a mixed background. In some cases,
  97947. * especially with grayscale text, the text outline doesn't work well, in
  97948. * which cases it can be disabled by setting it to `"none"`. When `useHTML`
  97949. * is true, the `textOutline` will not be picked up. In this, case, the same
  97950. * effect can be acheived through the `text-shadow` CSS property.
  97951. *
  97952. * For some series types, where each point has an extent, like for example
  97953. * tree maps, the data label may overflow the point. There are two
  97954. * strategies for handling overflow. By default, the text will wrap to
  97955. * multiple lines. The other strategy is to set `style.textOverflow` to
  97956. * `ellipsis`, which will keep the text on one line plus it will break
  97957. * inside long words.
  97958. */
  97959. style?: CSSObject;
  97960. /**
  97961. * (Highcharts, Highstock, Highmaps, Gantt) Options for a label text which
  97962. * should follow marker's shape. Border and background are disabled for a
  97963. * label that follows a path.
  97964. *
  97965. * **Note:** Only SVG-based renderer supports this option. Setting `useHTML`
  97966. * to true will disable this option.
  97967. */
  97968. textPath?: DataLabelsTextPathOptionsObject;
  97969. /**
  97970. * (Highcharts, Highstock, Highmaps, Gantt) Whether to use HTML to render
  97971. * the labels.
  97972. */
  97973. useHTML?: boolean;
  97974. /**
  97975. * (Highcharts, Highstock, Highmaps, Gantt) The vertical alignment of a data
  97976. * label. Can be one of `top`, `middle` or `bottom`. The default value
  97977. * depends on the data, for instance in a column chart, the label is above
  97978. * positive values and below negative values.
  97979. */
  97980. verticalAlign?: string;
  97981. /**
  97982. * (Highcharts, Highstock, Highmaps, Gantt) The x position offset of the
  97983. * label relative to the point in pixels.
  97984. */
  97985. x?: number;
  97986. /**
  97987. * (Highcharts, Highstock, Highmaps, Gantt) The y position offset of the
  97988. * label relative to the point in pixels.
  97989. */
  97990. y?: number;
  97991. /**
  97992. * (Highcharts, Highstock, Highmaps, Gantt) The Z index of the data labels.
  97993. * The default Z index puts it above the series. Use a Z index of 2 to
  97994. * display it behind the series.
  97995. */
  97996. z?: number;
  97997. }
  97998. /**
  97999. * (Highcharts, Highstock) Options for the series data sorting.
  98000. */
  98001. export interface PlotWindbarbDataSortingOptions {
  98002. /**
  98003. * (Highcharts, Highstock) Enable or disable data sorting for the series.
  98004. * Use xAxis.reversed to change the sorting order.
  98005. */
  98006. enabled?: boolean;
  98007. /**
  98008. * (Highcharts, Highstock) Whether to allow matching points by name in an
  98009. * update. If this option is disabled, points will be matched by order.
  98010. */
  98011. matchByName?: boolean;
  98012. /**
  98013. * (Highcharts, Highstock) Determines what data value should be used to sort
  98014. * by.
  98015. */
  98016. sortKey?: string;
  98017. }
  98018. /**
  98019. * (Highcharts, Highstock) Wind barbs are a convenient way to represent wind
  98020. * speed and direction in one graphical form. Wind direction is given by the
  98021. * stem direction, and wind speed by the number and shape of barbs.
  98022. *
  98023. * In TypeScript the type option must always be set.
  98024. *
  98025. * Configuration options for the series are given in three levels:
  98026. *
  98027. * 1. Options for all series in a chart are defined in the plotOptions.series
  98028. * object.
  98029. *
  98030. * 2. Options for all `windbarb` series are defined in plotOptions.windbarb.
  98031. *
  98032. * 3. Options for one single series are given in the series instance array. (see
  98033. * online documentation for example)
  98034. */
  98035. export interface PlotWindbarbOptions {
  98036. /**
  98037. * (Highcharts, Highstock) Accessibility options for a series.
  98038. */
  98039. accessibility?: SeriesAccessibilityOptionsObject;
  98040. /**
  98041. * (Highmaps) Whether all areas of the map defined in `mapData` should be
  98042. * rendered. If `true`, areas which don't correspond to a data point, are
  98043. * rendered as `null` points. If `false`, those areas are skipped.
  98044. */
  98045. allAreas?: boolean;
  98046. /**
  98047. * (Highcharts, Highstock) Allow this series' points to be selected by
  98048. * clicking on the graphic (columns, point markers, pie slices, map areas
  98049. * etc).
  98050. *
  98051. * The selected points can be handled by point select and unselect events,
  98052. * or collectively by the getSelectedPoints function.
  98053. *
  98054. * And alternative way of selecting points is through dragging.
  98055. */
  98056. allowPointSelect?: boolean;
  98057. /**
  98058. * (Highcharts, Highstock) Enable or disable the initial animation when a
  98059. * series is displayed. The animation can also be set as a configuration
  98060. * object. Please note that this option only applies to the initial
  98061. * animation of the series itself. For other animations, see chart.animation
  98062. * and the animation parameter under the API methods. The following
  98063. * properties are supported:
  98064. *
  98065. * - `defer`: The animation delay time in milliseconds.
  98066. *
  98067. * - `duration`: The duration of the animation in milliseconds.
  98068. *
  98069. * - `easing`: Can be a string reference to an easing function set on the
  98070. * `Math` object or a function. See the _Custom easing function_ demo below.
  98071. *
  98072. * Due to poor performance, animation is disabled in old IE browsers for
  98073. * several chart types.
  98074. */
  98075. animation?: (boolean|PlotWindbarbAnimationOptions|Partial<AnimationOptionsObject>);
  98076. /**
  98077. * (Highcharts, Highstock) For some series, there is a limit that shuts down
  98078. * initial animation by default when the total number of points in the chart
  98079. * is too high. For example, for a column chart and its derivatives,
  98080. * animation does not run if there is more than 250 points totally. To
  98081. * disable this cap, set `animationLimit` to `Infinity`.
  98082. */
  98083. animationLimit?: number;
  98084. /**
  98085. * (Highcharts, Highstock, Gantt) The color of the border surrounding each
  98086. * column or bar.
  98087. *
  98088. * In styled mode, the border stroke can be set with the `.highcharts-point`
  98089. * rule.
  98090. */
  98091. borderColor?: (ColorString|GradientColorObject|PatternObject);
  98092. /**
  98093. * (Highcharts, Highstock, Gantt) The corner radius of the border
  98094. * surrounding each column or bar.
  98095. */
  98096. borderRadius?: number;
  98097. /**
  98098. * (Highcharts, Highstock, Gantt) The width of the border surrounding each
  98099. * column or bar. Defaults to `1` when there is room for a border, but to
  98100. * `0` when the columns are so dense that a border would cover the next
  98101. * column.
  98102. *
  98103. * In styled mode, the stroke width can be set with the `.highcharts-point`
  98104. * rule.
  98105. */
  98106. borderWidth?: number;
  98107. /**
  98108. * (Highcharts, Highstock, Gantt) When `true`, the columns will center in
  98109. * the category, ignoring null or missing points. When `false`, space will
  98110. * be reserved for null or missing points.
  98111. */
  98112. centerInCategory?: boolean;
  98113. /**
  98114. * (Highcharts, Highstock) An additional class name to apply to the series'
  98115. * graphical elements. This option does not replace default class names of
  98116. * the graphical element.
  98117. */
  98118. className?: string;
  98119. /**
  98120. * (Highcharts, Highstock) Disable this option to allow series rendering in
  98121. * the whole plotting area.
  98122. *
  98123. * **Note:** Clipping should be always enabled when chart.zoomType is set
  98124. */
  98125. clip?: boolean;
  98126. /**
  98127. * (Highcharts, Highstock) The main color of the series. In line type series
  98128. * it applies to the line and the point markers unless otherwise specified.
  98129. * In bar type series it applies to the bars unless a color is specified per
  98130. * point. The default value is pulled from the `options.colors` array.
  98131. *
  98132. * In styled mode, the color can be defined by the colorIndex option. Also,
  98133. * the series color can be set with the `.highcharts-series`,
  98134. * `.highcharts-color-{n}`, `.highcharts-{type}-series` or
  98135. * `.highcharts-series-{n}` class, or individual classes given by the
  98136. * `className` option.
  98137. */
  98138. color?: (ColorString|GradientColorObject|PatternObject);
  98139. /**
  98140. * (Highcharts, Highstock, Highmaps) When using dual or multiple color axes,
  98141. * this number defines which colorAxis the particular series is connected
  98142. * to. It refers to either the axis id or the index of the axis in the
  98143. * colorAxis array, with 0 being the first. Set this option to false to
  98144. * prevent a series from connecting to the default color axis.
  98145. *
  98146. * Since v7.2.0 the option can also be an axis id or an axis index instead
  98147. * of a boolean flag.
  98148. */
  98149. colorAxis?: (boolean|number|string);
  98150. /**
  98151. * (Highcharts, Highstock, Gantt) When using automatic point colors pulled
  98152. * from the global colors or series-specific plotOptions.column.colors
  98153. * collections, this option determines whether the chart should receive one
  98154. * color per series or one color per point.
  98155. *
  98156. * In styled mode, the `colors` or `series.colors` arrays are not supported,
  98157. * and instead this option gives the points individual color class names on
  98158. * the form `highcharts-color-{n}`.
  98159. */
  98160. colorByPoint?: boolean;
  98161. /**
  98162. * (Highcharts, Highstock) Styled mode only. A specific color index to use
  98163. * for the series, so its graphic representations are given the class name
  98164. * `highcharts-color-{n}`.
  98165. */
  98166. colorIndex?: number;
  98167. /**
  98168. * (Highcharts, Highstock, Highmaps) Determines what data value should be
  98169. * used to calculate point color if `colorAxis` is used. Requires to set
  98170. * `min` and `max` if some custom point property is used or if approximation
  98171. * for data grouping is set to `'sum'`.
  98172. */
  98173. colorKey?: string;
  98174. /**
  98175. * (Highcharts, Highstock, Gantt) A series specific or series type specific
  98176. * color set to apply instead of the global colors when colorByPoint is
  98177. * true.
  98178. */
  98179. colors?: Array<(ColorString|GradientColorObject|PatternObject)>;
  98180. /**
  98181. * (Highstock) Compare the values of the series against the first non-null,
  98182. * non- zero value in the visible range. The y axis will show percentage or
  98183. * absolute change depending on whether `compare` is set to `"percent"` or
  98184. * `"value"`. When this is applied to multiple series, it allows comparing
  98185. * the development of the series against each other. Adds a `change` field
  98186. * to every point object.
  98187. */
  98188. compare?: string;
  98189. /**
  98190. * (Highstock) When compare is `percent`, this option dictates whether to
  98191. * use 0 or 100 as the base of comparison.
  98192. */
  98193. compareBase?: (0|100);
  98194. /**
  98195. * (Highstock) Defines if comparison should start from the first point
  98196. * within the visible range or should start from the first point **before**
  98197. * the range.
  98198. *
  98199. * In other words, this flag determines if first point within the visible
  98200. * range will have 0% (`compareStart=true`) or should have been already
  98201. * calculated according to the previous point (`compareStart=false`).
  98202. */
  98203. compareStart?: boolean;
  98204. /**
  98205. * (Gantt) Override Pathfinder connector options for a series. Requires
  98206. * Highcharts Gantt to be loaded.
  98207. */
  98208. connectors?: SeriesConnectorsOptionsObject;
  98209. /**
  98210. * (Highcharts, Highstock, Gantt) When true, each point or column edge is
  98211. * rounded to its nearest pixel in order to render sharp on screen. In some
  98212. * cases, when there are a lot of densely packed columns, this leads to
  98213. * visible difference in column widths or distance between columns. In these
  98214. * cases, setting `crisp` to `false` may look better, even though each
  98215. * column is rendered blurry.
  98216. */
  98217. crisp?: boolean;
  98218. /**
  98219. * (Highcharts, Highstock) You can set the cursor to "pointer" if you have
  98220. * click events attached to the series, to signal to the user that the
  98221. * points and lines can be clicked.
  98222. *
  98223. * In styled mode, the series cursor can be set with the same classes as
  98224. * listed under series.color.
  98225. */
  98226. cursor?: (string|CursorValue);
  98227. /**
  98228. * (Highcharts, Highstock) A reserved subspace to store options and values
  98229. * for customized functionality. Here you can add additional data for your
  98230. * own event callbacks and formatter callbacks.
  98231. */
  98232. custom?: Dictionary<any>;
  98233. /**
  98234. * (Highcharts, Highstock) Data grouping options for the wind barbs. In
  98235. * Highcharts, this requires the `modules/datagrouping.js` module to be
  98236. * loaded. In Highstock, data grouping is included.
  98237. */
  98238. dataGrouping?: DataGroupingOptionsObject;
  98239. /**
  98240. * (Highcharts, Highstock, Highmaps, Gantt) Options for the series data
  98241. * labels, appearing next to each data point.
  98242. *
  98243. * Since v6.2.0, multiple data labels can be applied to each single point by
  98244. * defining them as an array of configs.
  98245. *
  98246. * In styled mode, the data labels can be styled with the
  98247. * `.highcharts-data-label-box` and `.highcharts-data-label` class names
  98248. * (see example).
  98249. */
  98250. dataLabels?: (PlotWindbarbDataLabelsOptions|Array<PlotWindbarbDataLabelsOptions>);
  98251. /**
  98252. * (Highcharts, Highstock) Options for the series data sorting.
  98253. */
  98254. dataSorting?: (DataSortingOptionsObject|PlotWindbarbDataSortingOptions);
  98255. /**
  98256. * (Highcharts) Depth of the columns in a 3D column chart.
  98257. */
  98258. depth?: number;
  98259. /**
  98260. * (Highcharts, Highstock) A description of the series to add to the screen
  98261. * reader information about the series.
  98262. */
  98263. description?: string;
  98264. /**
  98265. * (Highcharts) 3D columns only. The color of the edges. Similar to
  98266. * `borderColor`, except it defaults to the same color as the column.
  98267. */
  98268. edgeColor?: ColorString;
  98269. /**
  98270. * (Highcharts) 3D columns only. The width of the colored edges.
  98271. */
  98272. edgeWidth?: number;
  98273. /**
  98274. * (Highcharts, Highstock) Enable or disable the mouse tracking for a
  98275. * specific series. This includes point tooltips and click events on graphs
  98276. * and points. For large datasets it improves performance.
  98277. */
  98278. enableMouseTracking?: boolean;
  98279. /**
  98280. * (Highcharts, Highstock) General event handlers for the series items.
  98281. * These event hooks can also be attached to the series at run time using
  98282. * the `Highcharts.addEvent` function.
  98283. */
  98284. events?: SeriesEventsOptionsObject;
  98285. /**
  98286. * (Highcharts, Highstock) Determines whether the series should look for the
  98287. * nearest point in both dimensions or just the x-dimension when hovering
  98288. * the series. Defaults to `'xy'` for scatter series and `'x'` for most
  98289. * other series. If the data has duplicate x-values, it is recommended to
  98290. * set this to `'xy'` to allow hovering over all points.
  98291. *
  98292. * Applies only to series types using nearest neighbor search (not direct
  98293. * hover) for tooltip.
  98294. */
  98295. findNearestPointBy?: OptionsFindNearestPointByValue;
  98296. /**
  98297. * (Highcharts, Highstock, Gantt) Whether to use the Y extremes of the total
  98298. * chart width or only the zoomed area when zooming in on parts of the X
  98299. * axis. By default, the Y axis adjusts to the min and max of the visible
  98300. * data. Cartesian series only.
  98301. */
  98302. getExtremesFromAll?: boolean;
  98303. /**
  98304. * (Highcharts, Highstock, Gantt) Whether to group non-stacked columns or to
  98305. * let them render independent of each other. Non-grouped columns will be
  98306. * laid out individually and overlap each other.
  98307. */
  98308. grouping?: boolean;
  98309. /**
  98310. * (Highcharts, Highstock, Gantt) Padding between each value groups, in x
  98311. * axis units.
  98312. */
  98313. groupPadding?: number;
  98314. /**
  98315. * (Highcharts) The spacing between columns on the Z Axis in a 3D chart.
  98316. */
  98317. groupZPadding?: number;
  98318. /**
  98319. * (Highcharts, Highstock) When set to `false` will prevent the series data
  98320. * from being included in any form of data export.
  98321. *
  98322. * Since version 6.0.0 until 7.1.0 the option was existing undocumented as
  98323. * `includeInCSVExport`.
  98324. */
  98325. includeInDataExport?: boolean;
  98326. /**
  98327. * (Highmaps) What property to join the `mapData` to the value data. For
  98328. * example, if joinBy is "code", the mapData items with a specific code is
  98329. * merged into the data with the same code. For maps loaded from GeoJSON,
  98330. * the keys may be held in each point's `properties` object.
  98331. *
  98332. * The joinBy option can also be an array of two values, where the first
  98333. * points to a key in the `mapData`, and the second points to another key in
  98334. * the `data`.
  98335. *
  98336. * When joinBy is `null`, the map items are joined by their position in the
  98337. * array, which performs much better in maps with many data points. This is
  98338. * the recommended option if you are printing more than a thousand data
  98339. * points and have a backend that can preprocess the data into a parallel
  98340. * array of the mapData.
  98341. */
  98342. joinBy?: (string|Array<string>);
  98343. /**
  98344. * (Highcharts, Highstock) An array specifying which option maps to which
  98345. * key in the data point array. This makes it convenient to work with
  98346. * unstructured data arrays from different sources.
  98347. */
  98348. keys?: Array<string>;
  98349. /**
  98350. * (Highcharts, Highstock, Gantt) Series labels are placed as close to the
  98351. * series as possible in a natural way, seeking to avoid other series. The
  98352. * goal of this feature is to make the chart more easily readable, like if a
  98353. * human designer placed the labels in the optimal position.
  98354. *
  98355. * The series labels currently work with series types having a `graph` or an
  98356. * `area`.
  98357. */
  98358. label?: SeriesLabelOptionsObject;
  98359. /**
  98360. * (Highstock) The line marks the last price from all points.
  98361. */
  98362. lastPrice?: SeriesLastPriceOptionsObject;
  98363. /**
  98364. * (Highstock) The line marks the last price from visible range of points.
  98365. */
  98366. lastVisiblePrice?: SeriesLastVisiblePriceOptionsObject;
  98367. /**
  98368. * (Highcharts, Highstock) The line width of the wind barb symbols.
  98369. */
  98370. lineWidth?: number;
  98371. /**
  98372. * (Highcharts, Highstock, Gantt) The id of another series to link to.
  98373. * Additionally, the value can be ":previous" to link to the previous
  98374. * series. When two series are linked, only the first one appears in the
  98375. * legend. Toggling the visibility of this also toggles the linked series.
  98376. *
  98377. * If master series uses data sorting and linked series does not have its
  98378. * own sorting definition, the linked series will be sorted in the same
  98379. * order as the master one.
  98380. */
  98381. linkedTo?: string;
  98382. /**
  98383. * (Highcharts, Highstock, Gantt) The maximum allowed pixel width for a
  98384. * column, translated to the height of a bar in a bar chart. This prevents
  98385. * the columns from becoming too wide when there is a small number of points
  98386. * in the chart.
  98387. */
  98388. maxPointWidth?: number;
  98389. /**
  98390. * (Highcharts, Highstock, Gantt) The minimal height for a column or width
  98391. * for a bar. By default, 0 values are not shown. To visualize a 0 (or close
  98392. * to zero) point, set the minimal point length to a pixel value like 3\. In
  98393. * stacked column charts, minPointLength might not be respected for tightly
  98394. * packed values.
  98395. */
  98396. minPointLength?: number;
  98397. /**
  98398. * (Highstock) Options for the corresponding navigator series if
  98399. * `showInNavigator` is `true` for this series. Available options are the
  98400. * same as any series, documented at plotOptions and series.
  98401. *
  98402. * These options are merged with options in navigator.series, and will take
  98403. * precedence if the same option is defined both places.
  98404. */
  98405. navigatorOptions?: PlotSeriesOptions;
  98406. /**
  98407. * (Highcharts, Highstock) The color for the parts of the graph or points
  98408. * that are below the threshold. Note that `zones` takes precedence over the
  98409. * negative color. Using `negativeColor` is equivalent to applying a zone
  98410. * with value of 0.
  98411. */
  98412. negativeColor?: (ColorString|GradientColorObject|PatternObject);
  98413. /**
  98414. * (Highcharts, Highstock) The id of another series in the chart that the
  98415. * wind barbs are projected on. When `null`, the wind symbols are drawn on
  98416. * the X axis, but offset up or down by the `yOffset` setting.
  98417. */
  98418. onSeries?: (string|null);
  98419. /**
  98420. * (Highcharts, Highstock) Opacity of a series parts: line, fill (e.g. area)
  98421. * and dataLabels.
  98422. */
  98423. opacity?: number;
  98424. /**
  98425. * (Highcharts, Highstock) Properties for each single point.
  98426. */
  98427. point?: PlotSeriesPointOptions;
  98428. /**
  98429. * (Highcharts, Highstock) Same as accessibility.pointDescriptionFormatter,
  98430. * but for an individual series. Overrides the chart wide configuration.
  98431. */
  98432. pointDescriptionFormatter?: Function;
  98433. /**
  98434. * (Highcharts, Highstock, Gantt) If no x values are given for the points in
  98435. * a series, `pointInterval` defines the interval of the x values. For
  98436. * example, if a series contains one value every decade starting from year
  98437. * 0, set `pointInterval` to `10`. In true `datetime` axes, the
  98438. * `pointInterval` is set in milliseconds.
  98439. *
  98440. * It can be also be combined with `pointIntervalUnit` to draw irregular
  98441. * time intervals.
  98442. *
  98443. * Please note that this options applies to the _series data_, not the
  98444. * interval of the axis ticks, which is independent.
  98445. */
  98446. pointInterval?: number;
  98447. /**
  98448. * (Highcharts, Highstock, Gantt) On datetime series, this allows for
  98449. * setting the pointInterval to irregular time units, `day`, `month` and
  98450. * `year`. A day is usually the same as 24 hours, but `pointIntervalUnit`
  98451. * also takes the DST crossover into consideration when dealing with local
  98452. * time. Combine this option with `pointInterval` to draw weeks, quarters, 6
  98453. * months, 10 years etc.
  98454. *
  98455. * Please note that this options applies to the _series data_, not the
  98456. * interval of the axis ticks, which is independent.
  98457. */
  98458. pointIntervalUnit?: OptionsPointIntervalUnitValue;
  98459. /**
  98460. * (Highcharts, Highstock, Gantt) Padding between each column or bar, in x
  98461. * axis units.
  98462. */
  98463. pointPadding?: number;
  98464. /**
  98465. * (Highcharts, Highstock, Gantt) Possible values: `"on"`, `"between"`,
  98466. * `number`.
  98467. *
  98468. * In a column chart, when pointPlacement is `"on"`, the point will not
  98469. * create any padding of the X axis. In a polar column chart this means that
  98470. * the first column points directly north. If the pointPlacement is
  98471. * `"between"`, the columns will be laid out between ticks. This is useful
  98472. * for example for visualising an amount between two points in time or in a
  98473. * certain sector of a polar chart.
  98474. *
  98475. * Since Highcharts 3.0.2, the point placement can also be numeric, where 0
  98476. * is on the axis value, -0.5 is between this value and the previous, and
  98477. * 0.5 is between this value and the next. Unlike the textual options,
  98478. * numeric point placement options won't affect axis padding.
  98479. *
  98480. * Note that pointPlacement needs a pointRange to work. For column series
  98481. * this is computed, but for line-type series it needs to be set.
  98482. *
  98483. * For the `xrange` series type and gantt charts, if the Y axis is a
  98484. * category axis, the `pointPlacement` applies to the Y axis rather than the
  98485. * (typically datetime) X axis.
  98486. *
  98487. * Defaults to `undefined` in cartesian charts, `"between"` in polar charts.
  98488. */
  98489. pointPlacement?: (number|string);
  98490. /**
  98491. * (Highcharts, Highstock, Gantt) The X axis range that each point is valid
  98492. * for. This determines the width of the column. On a categorized axis, the
  98493. * range will be 1 by default (one category unit). On linear and datetime
  98494. * axes, the range will be computed as the distance between the two closest
  98495. * data points.
  98496. *
  98497. * The default `null` means it is computed automatically, but this option
  98498. * can be used to override the automatic value.
  98499. *
  98500. * This option is set by default to 1 if data sorting is enabled.
  98501. */
  98502. pointRange?: (number|null);
  98503. /**
  98504. * (Highcharts, Highstock, Gantt) If no x values are given for the points in
  98505. * a series, pointStart defines on what value to start. For example, if a
  98506. * series contains one yearly value starting from 1945, set pointStart to
  98507. * 1945.
  98508. */
  98509. pointStart?: number;
  98510. /**
  98511. * (Highcharts, Highstock, Gantt) A pixel value specifying a fixed width for
  98512. * each column or bar point. When set to `undefined`, the width is
  98513. * calculated from the `pointPadding` and `groupPadding`. The width effects
  98514. * the dimension that is not based on the point value. For column series it
  98515. * is the hoizontal length and for bar series it is the vertical length.
  98516. */
  98517. pointWidth?: number;
  98518. /**
  98519. * (Highcharts, Highstock) Whether to select the series initially. If
  98520. * `showCheckbox` is true, the checkbox next to the series name in the
  98521. * legend will be checked for a selected series.
  98522. */
  98523. selected?: boolean;
  98524. /**
  98525. * (Highcharts, Highstock) If true, a checkbox is displayed next to the
  98526. * legend item to allow selecting the series. The state of the checkbox is
  98527. * determined by the `selected` option.
  98528. */
  98529. showCheckbox?: boolean;
  98530. /**
  98531. * (Highcharts, Highstock) Whether to display this particular series or
  98532. * series type in the legend. Standalone series are shown in legend by
  98533. * default, and linked series are not. Since v7.2.0 it is possible to show
  98534. * series that use colorAxis by setting this option to `true`.
  98535. */
  98536. showInLegend?: boolean;
  98537. /**
  98538. * (Highstock) Whether or not to show the series in the navigator. Takes
  98539. * precedence over navigator.baseSeries if defined.
  98540. */
  98541. showInNavigator?: boolean;
  98542. /**
  98543. * (Highcharts, Highstock) If set to `true`, the accessibility module will
  98544. * skip past the points in this series for keyboard navigation.
  98545. */
  98546. skipKeyboardNavigation?: boolean;
  98547. /**
  98548. * (Highcharts, Highstock) When this is true, the series will not cause the
  98549. * Y axis to cross the zero plane (or threshold option) unless the data
  98550. * actually crosses the plane.
  98551. *
  98552. * For example, if `softThreshold` is `false`, a series of 0, 1, 2, 3 will
  98553. * make the Y axis show negative values according to the `minPadding`
  98554. * option. If `softThreshold` is `true`, the Y axis starts at 0.
  98555. */
  98556. softThreshold?: boolean;
  98557. states?: SeriesStatesOptionsObject;
  98558. /**
  98559. * (Highcharts, Highstock) Sticky tracking of mouse events. When true, the
  98560. * `mouseOut` event on a series isn't triggered until the mouse moves over
  98561. * another series, or out of the plot area. When false, the `mouseOut` event
  98562. * on a series is triggered when the mouse leaves the area around the
  98563. * series' graph or markers. This also implies the tooltip when not shared.
  98564. * When `stickyTracking` is false and `tooltip.shared` is false, the tooltip
  98565. * will be hidden when moving the mouse between series. Defaults to true for
  98566. * line and area type series, but to false for columns, pies etc.
  98567. *
  98568. * **Note:** The boost module will force this option because of technical
  98569. * limitations.
  98570. */
  98571. stickyTracking?: boolean;
  98572. /**
  98573. * (Highcharts) The Y axis value to serve as the base for the columns, for
  98574. * distinguishing between values above and below a threshold. If `null`, the
  98575. * columns extend from the padding Y axis minimum.
  98576. */
  98577. threshold?: (number|null);
  98578. /**
  98579. * (Highcharts, Highstock) A configuration object for the tooltip rendering
  98580. * of each single series. Properties are inherited from tooltip, but only
  98581. * the following properties can be defined on a series level.
  98582. */
  98583. tooltip?: SeriesTooltipOptionsObject;
  98584. /**
  98585. * (Highcharts, Highstock, Gantt) When a series contains a data array that
  98586. * is longer than this, only one dimensional arrays of numbers, or two
  98587. * dimensional arrays with x and y values are allowed. Also, only the first
  98588. * point is tested, and the rest are assumed to be the same format. This
  98589. * saves expensive data checking and indexing in long series. Set it to `0`
  98590. * disable.
  98591. *
  98592. * Note: In boost mode turbo threshold is forced. Only array of numbers or
  98593. * two dimensional arrays are allowed.
  98594. */
  98595. turboThreshold?: number;
  98596. /**
  98597. * (Highcharts, Highstock) Pixel length of the stems.
  98598. */
  98599. vectorLength?: number;
  98600. /**
  98601. * (Highcharts, Highstock) Set the initial visibility of the series.
  98602. */
  98603. visible?: boolean;
  98604. /**
  98605. * (Highcharts, Highstock) Horizontal offset from the cartesian position, in
  98606. * pixels. When the chart is inverted, this option allows translation like
  98607. * yOffset in non inverted charts.
  98608. */
  98609. xOffset?: number;
  98610. /**
  98611. * (Highcharts, Highstock) Vertical offset from the cartesian position, in
  98612. * pixels. The default value makes sure the symbols don't overlap the X axis
  98613. * when `onSeries` is `null`, and that they don't overlap the linked series
  98614. * when `onSeries` is given.
  98615. */
  98616. yOffset?: number;
  98617. /**
  98618. * (Highmaps) Define the z index of the series.
  98619. */
  98620. zIndex?: number;
  98621. /**
  98622. * (Highcharts, Highstock) Defines the Axis on which the zones are applied.
  98623. */
  98624. zoneAxis?: string;
  98625. /**
  98626. * (Highcharts, Highstock) An array defining zones within a series. Zones
  98627. * can be applied to the X axis, Y axis or Z axis for bubbles, according to
  98628. * the `zoneAxis` option. The zone definitions have to be in ascending order
  98629. * regarding to the value.
  98630. *
  98631. * In styled mode, the color zones are styled with the
  98632. * `.highcharts-zone-{n}` class, or custom classed from the `className`
  98633. * option (view live demo).
  98634. */
  98635. zones?: Array<SeriesZonesOptionsObject>;
  98636. }
  98637. /**
  98638. * (Highstock) Enable or disable the initial animation when a series is
  98639. * displayed. The animation can also be set as a configuration object. Please
  98640. * note that this option only applies to the initial animation of the series
  98641. * itself. For other animations, see chart.animation and the animation parameter
  98642. * under the API methods. The following properties are supported:
  98643. *
  98644. * - `defer`: The animation delay time in milliseconds.
  98645. *
  98646. * - `duration`: The duration of the animation in milliseconds.
  98647. *
  98648. * - `easing`: Can be a string reference to an easing function set on the `Math`
  98649. * object or a function. See the _Custom easing function_ demo below.
  98650. *
  98651. * Due to poor performance, animation is disabled in old IE browsers for several
  98652. * chart types.
  98653. */
  98654. export interface PlotWmaAnimationOptions {
  98655. defer?: number;
  98656. }
  98657. /**
  98658. * (Highcharts, Highstock, Highmaps, Gantt) Enable or disable the initial
  98659. * animation when a series is displayed for the `dataLabels`. The animation can
  98660. * also be set as a configuration object. Please note that this option only
  98661. * applies to the initial animation. For other animations, see chart.animation
  98662. * and the animation parameter under the API methods. The following properties
  98663. * are supported:
  98664. *
  98665. * - `defer`: The animation delay time in milliseconds.
  98666. */
  98667. export interface PlotWmaDataLabelsAnimationOptions {
  98668. /**
  98669. * (Highcharts, Highstock, Highmaps, Gantt) The animation delay time in
  98670. * milliseconds. Set to `0` renders dataLabel immediately. As `undefined`
  98671. * inherits defer time from the series.animation.defer.
  98672. */
  98673. defer?: number;
  98674. }
  98675. /**
  98676. * (Highcharts, Highstock, Highmaps, Gantt) Options for the series data labels,
  98677. * appearing next to each data point.
  98678. *
  98679. * Since v6.2.0, multiple data labels can be applied to each single point by
  98680. * defining them as an array of configs.
  98681. *
  98682. * In styled mode, the data labels can be styled with the
  98683. * `.highcharts-data-label-box` and `.highcharts-data-label` class names (see
  98684. * example).
  98685. */
  98686. export interface PlotWmaDataLabelsOptions {
  98687. /**
  98688. * (Highcharts, Highstock, Highmaps, Gantt) The alignment of the data label
  98689. * compared to the point. If `right`, the right side of the label should be
  98690. * touching the point. For points with an extent, like columns, the
  98691. * alignments also dictates how to align it inside the box, as given with
  98692. * the inside option. Can be one of `left`, `center` or `right`.
  98693. */
  98694. align?: (AlignValue|null);
  98695. /**
  98696. * (Highcharts, Highstock, Highmaps, Gantt) Whether to allow data labels to
  98697. * overlap. To make the labels less sensitive for overlapping, the
  98698. * dataLabels.padding can be set to 0.
  98699. */
  98700. allowOverlap?: boolean;
  98701. /**
  98702. * (Highcharts, Highstock, Highmaps, Gantt) Enable or disable the initial
  98703. * animation when a series is displayed for the `dataLabels`. The animation
  98704. * can also be set as a configuration object. Please note that this option
  98705. * only applies to the initial animation. For other animations, see
  98706. * chart.animation and the animation parameter under the API methods. The
  98707. * following properties are supported:
  98708. *
  98709. * - `defer`: The animation delay time in milliseconds.
  98710. */
  98711. animation?: (boolean|PlotWmaDataLabelsAnimationOptions|Partial<AnimationOptionsObject>);
  98712. /**
  98713. * (Highcharts, Highstock, Highmaps, Gantt) The background color or gradient
  98714. * for the data label.
  98715. */
  98716. backgroundColor?: (ColorString|GradientColorObject|PatternObject);
  98717. /**
  98718. * (Highcharts, Highstock, Highmaps, Gantt) The border color for the data
  98719. * label. Defaults to `undefined`.
  98720. */
  98721. borderColor?: (ColorString|GradientColorObject|PatternObject);
  98722. /**
  98723. * (Highcharts, Highstock, Highmaps, Gantt) The border radius in pixels for
  98724. * the data label.
  98725. */
  98726. borderRadius?: number;
  98727. /**
  98728. * (Highcharts, Highstock, Highmaps, Gantt) The border width in pixels for
  98729. * the data label.
  98730. */
  98731. borderWidth?: number;
  98732. /**
  98733. * (Highcharts, Highstock, Highmaps, Gantt) A class name for the data label.
  98734. * Particularly in styled mode, this can be used to give each series' or
  98735. * point's data label unique styling. In addition to this option, a default
  98736. * color class name is added so that we can give the labels a contrast text
  98737. * shadow.
  98738. */
  98739. className?: string;
  98740. /**
  98741. * (Highcharts, Highstock, Highmaps, Gantt) The text color for the data
  98742. * labels. Defaults to `undefined`. For certain series types, like column or
  98743. * map, the data labels can be drawn inside the points. In this case the
  98744. * data label will be drawn with maximum contrast by default. Additionally,
  98745. * it will be given a `text-outline` style with the opposite color, to
  98746. * further increase the contrast. This can be overridden by setting the
  98747. * `text-outline` style to `none` in the `dataLabels.style` option.
  98748. */
  98749. color?: (ColorString|GradientColorObject|PatternObject);
  98750. /**
  98751. * (Highcharts, Highstock, Highmaps, Gantt) Whether to hide data labels that
  98752. * are outside the plot area. By default, the data label is moved inside the
  98753. * plot area according to the overflow option.
  98754. */
  98755. crop?: boolean;
  98756. /**
  98757. * (Highcharts, Highstock, Gantt) Whether to defer displaying the data
  98758. * labels until the initial series animation has finished. Setting to
  98759. * `false` renders the data label immediately. If set to `true` inherits the
  98760. * defer time set in plotOptions.series.animation.
  98761. */
  98762. defer?: boolean;
  98763. /**
  98764. * (Highcharts, Highstock, Highmaps, Gantt) Enable or disable the data
  98765. * labels.
  98766. */
  98767. enabled?: boolean;
  98768. /**
  98769. * (Highcharts, Highstock, Highmaps, Gantt) A declarative filter to control
  98770. * of which data labels to display. The declarative filter is designed for
  98771. * use when callback functions are not available, like when the chart
  98772. * options require a pure JSON structure or for use with graphical editors.
  98773. * For programmatic control, use the `formatter` instead, and return
  98774. * `undefined` to disable a single data label.
  98775. */
  98776. filter?: DataLabelsFilterOptionsObject;
  98777. /**
  98778. * (Highcharts, Highstock, Highmaps, Gantt) A format string for the data
  98779. * label. Available variables are the same as for `formatter`.
  98780. */
  98781. format?: string;
  98782. /**
  98783. * (Highcharts, Highstock, Highmaps, Gantt) Callback JavaScript function to
  98784. * format the data label. Note that if a `format` is defined, the format
  98785. * takes precedence and the formatter is ignored.
  98786. */
  98787. formatter?: DataLabelsFormatterCallbackFunction;
  98788. /**
  98789. * (Highcharts, Highstock, Highmaps, Gantt) For points with an extent, like
  98790. * columns or map areas, whether to align the data label inside the box or
  98791. * to the actual value point. Defaults to `false` in most cases, `true` in
  98792. * stacked columns.
  98793. */
  98794. inside?: boolean;
  98795. /**
  98796. * (Highcharts, Highstock, Highmaps, Gantt) Format for points with the value
  98797. * of null. Works analogously to format. `nullFormat` can be applied only to
  98798. * series which support displaying null points.
  98799. */
  98800. nullFormat?: (boolean|string);
  98801. /**
  98802. * (Highcharts, Highstock, Highmaps, Gantt) Callback JavaScript function
  98803. * that defines formatting for points with the value of null. Works
  98804. * analogously to formatter. `nullPointFormatter` can be applied only to
  98805. * series which support displaying null points.
  98806. */
  98807. nullFormatter?: DataLabelsFormatterCallbackFunction;
  98808. /**
  98809. * (Highcharts, Highstock, Highmaps, Gantt) How to handle data labels that
  98810. * flow outside the plot area. The default is `"justify"`, which aligns them
  98811. * inside the plot area. For columns and bars, this means it will be moved
  98812. * inside the bar. To display data labels outside the plot area, set `crop`
  98813. * to `false` and `overflow` to `"allow"`.
  98814. */
  98815. overflow?: DataLabelsOverflowValue;
  98816. /**
  98817. * (Highcharts, Highstock, Highmaps, Gantt) When either the `borderWidth` or
  98818. * the `backgroundColor` is set, this is the padding within the box.
  98819. */
  98820. padding?: number;
  98821. /**
  98822. * (Highcharts, Highstock, Highmaps, Gantt) Aligns data labels relative to
  98823. * points. If `center` alignment is not possible, it defaults to `right`.
  98824. */
  98825. position?: AlignValue;
  98826. /**
  98827. * (Highcharts, Highstock, Highmaps, Gantt) Text rotation in degrees. Note
  98828. * that due to a more complex structure, backgrounds, borders and padding
  98829. * will be lost on a rotated data label.
  98830. */
  98831. rotation?: number;
  98832. /**
  98833. * (Highcharts, Highstock, Highmaps, Gantt) The shadow of the box. Works
  98834. * best with `borderWidth` or `backgroundColor`. Since 2.3 the shadow can be
  98835. * an object configuration containing `color`, `offsetX`, `offsetY`,
  98836. * `opacity` and `width`.
  98837. */
  98838. shadow?: (boolean|ShadowOptionsObject);
  98839. /**
  98840. * (Highcharts, Highstock, Highmaps, Gantt) The name of a symbol to use for
  98841. * the border around the label. Symbols are predefined functions on the
  98842. * Renderer object.
  98843. */
  98844. shape?: string;
  98845. /**
  98846. * (Highcharts, Highstock, Highmaps, Gantt) Styles for the label. The
  98847. * default `color` setting is `"contrast"`, which is a pseudo color that
  98848. * Highcharts picks up and applies the maximum contrast to the underlying
  98849. * point item, for example the bar in a bar chart.
  98850. *
  98851. * The `textOutline` is a pseudo property that applies an outline of the
  98852. * given width with the given color, which by default is the maximum
  98853. * contrast to the text. So a bright text color will result in a black text
  98854. * outline for maximum readability on a mixed background. In some cases,
  98855. * especially with grayscale text, the text outline doesn't work well, in
  98856. * which cases it can be disabled by setting it to `"none"`. When `useHTML`
  98857. * is true, the `textOutline` will not be picked up. In this, case, the same
  98858. * effect can be acheived through the `text-shadow` CSS property.
  98859. *
  98860. * For some series types, where each point has an extent, like for example
  98861. * tree maps, the data label may overflow the point. There are two
  98862. * strategies for handling overflow. By default, the text will wrap to
  98863. * multiple lines. The other strategy is to set `style.textOverflow` to
  98864. * `ellipsis`, which will keep the text on one line plus it will break
  98865. * inside long words.
  98866. */
  98867. style?: CSSObject;
  98868. /**
  98869. * (Highcharts, Highstock, Highmaps, Gantt) Options for a label text which
  98870. * should follow marker's shape. Border and background are disabled for a
  98871. * label that follows a path.
  98872. *
  98873. * **Note:** Only SVG-based renderer supports this option. Setting `useHTML`
  98874. * to true will disable this option.
  98875. */
  98876. textPath?: DataLabelsTextPathOptionsObject;
  98877. /**
  98878. * (Highcharts, Highstock, Highmaps, Gantt) Whether to use HTML to render
  98879. * the labels.
  98880. */
  98881. useHTML?: boolean;
  98882. /**
  98883. * (Highcharts, Highstock, Highmaps, Gantt) The vertical alignment of a data
  98884. * label. Can be one of `top`, `middle` or `bottom`. The default value
  98885. * depends on the data, for instance in a column chart, the label is above
  98886. * positive values and below negative values.
  98887. */
  98888. verticalAlign?: (VerticalAlignValue|null);
  98889. /**
  98890. * (Highcharts, Highstock, Highmaps, Gantt) The x position offset of the
  98891. * label relative to the point in pixels.
  98892. */
  98893. x?: number;
  98894. /**
  98895. * (Highcharts, Highstock, Highmaps, Gantt) The y position offset of the
  98896. * label relative to the point in pixels.
  98897. */
  98898. y?: number;
  98899. /**
  98900. * (Highcharts, Highstock, Highmaps, Gantt) The Z index of the data labels.
  98901. * The default Z index puts it above the series. Use a Z index of 2 to
  98902. * display it behind the series.
  98903. */
  98904. z?: number;
  98905. }
  98906. /**
  98907. * (Highcharts, Highstock) Options for the series data sorting.
  98908. */
  98909. export interface PlotWmaDataSortingOptions {
  98910. /**
  98911. * (Highcharts, Highstock) Enable or disable data sorting for the series.
  98912. * Use xAxis.reversed to change the sorting order.
  98913. */
  98914. enabled?: boolean;
  98915. /**
  98916. * (Highcharts, Highstock) Whether to allow matching points by name in an
  98917. * update. If this option is disabled, points will be matched by order.
  98918. */
  98919. matchByName?: boolean;
  98920. /**
  98921. * (Highcharts, Highstock) Determines what data value should be used to sort
  98922. * by.
  98923. */
  98924. sortKey?: string;
  98925. }
  98926. /**
  98927. * (Highstock) Weighted moving average indicator (WMA). This series requires
  98928. * `linkedTo` option to be set.
  98929. *
  98930. * In TypeScript the type option must always be set.
  98931. *
  98932. * Configuration options for the series are given in three levels:
  98933. *
  98934. * 1. Options for all series in a chart are defined in the plotOptions.series
  98935. * object.
  98936. *
  98937. * 2. Options for all `wma` series are defined in plotOptions.wma.
  98938. *
  98939. * 3. Options for one single series are given in the series instance array. (see
  98940. * online documentation for example)
  98941. */
  98942. export interface PlotWmaOptions {
  98943. /**
  98944. * (Highstock) Accessibility options for a series.
  98945. */
  98946. accessibility?: SeriesAccessibilityOptionsObject;
  98947. /**
  98948. * (Highstock) Allow this series' points to be selected by clicking on the
  98949. * graphic (columns, point markers, pie slices, map areas etc).
  98950. *
  98951. * The selected points can be handled by point select and unselect events,
  98952. * or collectively by the getSelectedPoints function.
  98953. *
  98954. * And alternative way of selecting points is through dragging.
  98955. */
  98956. allowPointSelect?: boolean;
  98957. /**
  98958. * (Highstock) Enable or disable the initial animation when a series is
  98959. * displayed. The animation can also be set as a configuration object.
  98960. * Please note that this option only applies to the initial animation of the
  98961. * series itself. For other animations, see chart.animation and the
  98962. * animation parameter under the API methods. The following properties are
  98963. * supported:
  98964. *
  98965. * - `defer`: The animation delay time in milliseconds.
  98966. *
  98967. * - `duration`: The duration of the animation in milliseconds.
  98968. *
  98969. * - `easing`: Can be a string reference to an easing function set on the
  98970. * `Math` object or a function. See the _Custom easing function_ demo below.
  98971. *
  98972. * Due to poor performance, animation is disabled in old IE browsers for
  98973. * several chart types.
  98974. */
  98975. animation?: (boolean|PlotWmaAnimationOptions|Partial<AnimationOptionsObject>);
  98976. /**
  98977. * (Highstock) For some series, there is a limit that shuts down initial
  98978. * animation by default when the total number of points in the chart is too
  98979. * high. For example, for a column chart and its derivatives, animation does
  98980. * not run if there is more than 250 points totally. To disable this cap,
  98981. * set `animationLimit` to `Infinity`.
  98982. */
  98983. animationLimit?: number;
  98984. /**
  98985. * (Highstock) Sets the color blending in the boost module.
  98986. */
  98987. boostBlending?: OptionsBoostBlendingValue;
  98988. /**
  98989. * (Highstock) Set the point threshold for when a series should enter boost
  98990. * mode.
  98991. *
  98992. * Setting it to e.g. 2000 will cause the series to enter boost mode when
  98993. * there are 2000 or more points in the series.
  98994. *
  98995. * To disable boosting on the series, set the `boostThreshold` to 0. Setting
  98996. * it to 1 will force boosting.
  98997. *
  98998. * Note that the cropThreshold also affects this setting. When zooming in on
  98999. * a series that has fewer points than the `cropThreshold`, all points are
  99000. * rendered although outside the visible plot area, and the `boostThreshold`
  99001. * won't take effect.
  99002. */
  99003. boostThreshold?: number;
  99004. /**
  99005. * (Highmaps) The border color of the map areas.
  99006. *
  99007. * In styled mode, the border stroke is given in the `.highcharts-point`
  99008. * class.
  99009. */
  99010. borderColor?: (ColorString|GradientColorObject|PatternObject);
  99011. /**
  99012. * (Highmaps) The border width of each map area.
  99013. *
  99014. * In styled mode, the border stroke width is given in the
  99015. * `.highcharts-point` class.
  99016. */
  99017. borderWidth?: number;
  99018. /**
  99019. * (Highstock) An additional class name to apply to the series' graphical
  99020. * elements. This option does not replace default class names of the
  99021. * graphical element.
  99022. */
  99023. className?: string;
  99024. /**
  99025. * (Highstock) Disable this option to allow series rendering in the whole
  99026. * plotting area.
  99027. *
  99028. * **Note:** Clipping should be always enabled when chart.zoomType is set
  99029. */
  99030. clip?: boolean;
  99031. /**
  99032. * (Highstock) The main color of the series. In line type series it applies
  99033. * to the line and the point markers unless otherwise specified. In bar type
  99034. * series it applies to the bars unless a color is specified per point. The
  99035. * default value is pulled from the `options.colors` array.
  99036. *
  99037. * In styled mode, the color can be defined by the colorIndex option. Also,
  99038. * the series color can be set with the `.highcharts-series`,
  99039. * `.highcharts-color-{n}`, `.highcharts-{type}-series` or
  99040. * `.highcharts-series-{n}` class, or individual classes given by the
  99041. * `className` option.
  99042. */
  99043. color?: (ColorString|GradientColorObject|PatternObject);
  99044. /**
  99045. * (Highstock) Styled mode only. A specific color index to use for the
  99046. * series, so its graphic representations are given the class name
  99047. * `highcharts-color-{n}`.
  99048. */
  99049. colorIndex?: number;
  99050. /**
  99051. * (Highcharts, Highstock, Highmaps) Determines what data value should be
  99052. * used to calculate point color if `colorAxis` is used. Requires to set
  99053. * `min` and `max` if some custom point property is used or if approximation
  99054. * for data grouping is set to `'sum'`.
  99055. */
  99056. colorKey?: string;
  99057. /**
  99058. * (Highstock) Compare the values of the series against the first non-null,
  99059. * non- zero value in the visible range. The y axis will show percentage or
  99060. * absolute change depending on whether `compare` is set to `"percent"` or
  99061. * `"value"`. When this is applied to multiple series, it allows comparing
  99062. * the development of the series against each other. Adds a `change` field
  99063. * to every point object.
  99064. */
  99065. compare?: string;
  99066. /**
  99067. * (Highstock) When compare is `percent`, this option dictates whether to
  99068. * use 0 or 100 as the base of comparison.
  99069. */
  99070. compareBase?: (0|100);
  99071. /**
  99072. * (Highstock) Defines if comparison should start from the first point
  99073. * within the visible range or should start from the first point **before**
  99074. * the range.
  99075. *
  99076. * In other words, this flag determines if first point within the visible
  99077. * range will have 0% (`compareStart=true`) or should have been already
  99078. * calculated according to the previous point (`compareStart=false`).
  99079. */
  99080. compareStart?: boolean;
  99081. /**
  99082. * (Highstock) Whether to compare indicator to the main series values or
  99083. * indicator values.
  99084. */
  99085. compareToMain?: boolean;
  99086. /**
  99087. * (Highcharts) Polar charts only. Whether to connect the ends of a line
  99088. * series plot across the extremes.
  99089. */
  99090. connectEnds?: boolean;
  99091. /**
  99092. * (Highcharts, Highstock) Whether to connect a graph line across null
  99093. * points, or render a gap between the two points on either side of the
  99094. * null.
  99095. */
  99096. connectNulls?: boolean;
  99097. /**
  99098. * (Gantt) Override Pathfinder connector options for a series. Requires
  99099. * Highcharts Gantt to be loaded.
  99100. */
  99101. connectors?: SeriesConnectorsOptionsObject;
  99102. /**
  99103. * (Highcharts, Highstock, Gantt) When true, each point or column edge is
  99104. * rounded to its nearest pixel in order to render sharp on screen. In some
  99105. * cases, when there are a lot of densely packed columns, this leads to
  99106. * visible difference in column widths or distance between columns. In these
  99107. * cases, setting `crisp` to `false` may look better, even though each
  99108. * column is rendered blurry.
  99109. */
  99110. crisp?: boolean;
  99111. /**
  99112. * (Highcharts, Highstock) When the series contains less points than the
  99113. * crop threshold, all points are drawn, even if the points fall outside the
  99114. * visible plot area at the current zoom. The advantage of drawing all
  99115. * points (including markers and columns), is that animation is performed on
  99116. * updates. On the other hand, when the series contains more points than the
  99117. * crop threshold, the series data is cropped to only contain points that
  99118. * fall within the plot area. The advantage of cropping away invisible
  99119. * points is to increase performance on large series.
  99120. */
  99121. cropThreshold?: number;
  99122. /**
  99123. * (Highstock) You can set the cursor to "pointer" if you have click events
  99124. * attached to the series, to signal to the user that the points and lines
  99125. * can be clicked.
  99126. *
  99127. * In styled mode, the series cursor can be set with the same classes as
  99128. * listed under series.color.
  99129. */
  99130. cursor?: (string|CursorValue);
  99131. /**
  99132. * (Highstock) A reserved subspace to store options and values for
  99133. * customized functionality. Here you can add additional data for your own
  99134. * event callbacks and formatter callbacks.
  99135. */
  99136. custom?: Dictionary<any>;
  99137. /**
  99138. * (Highstock) Name of the dash style to use for the graph, or for some
  99139. * series types the outline of each shape.
  99140. *
  99141. * In styled mode, the stroke dash-array can be set with the same classes as
  99142. * listed under series.color.
  99143. */
  99144. dashStyle?: DashStyleValue;
  99145. /**
  99146. * (Highstock) Data grouping is the concept of sampling the data values into
  99147. * larger blocks in order to ease readability and increase performance of
  99148. * the JavaScript charts. Highstock by default applies data grouping when
  99149. * the points become closer than a certain pixel value, determined by the
  99150. * `groupPixelWidth` option.
  99151. *
  99152. * If data grouping is applied, the grouping information of grouped points
  99153. * can be read from the Point.dataGroup. If point options other than the
  99154. * data itself are set, for example `name` or `color` or custom properties,
  99155. * the grouping logic doesn't know how to group it. In this case the options
  99156. * of the first point instance are copied over to the group point. This can
  99157. * be altered through a custom `approximation` callback function.
  99158. */
  99159. dataGrouping?: DataGroupingOptionsObject;
  99160. /**
  99161. * (Highcharts, Highstock, Highmaps, Gantt) Options for the series data
  99162. * labels, appearing next to each data point.
  99163. *
  99164. * Since v6.2.0, multiple data labels can be applied to each single point by
  99165. * defining them as an array of configs.
  99166. *
  99167. * In styled mode, the data labels can be styled with the
  99168. * `.highcharts-data-label-box` and `.highcharts-data-label` class names
  99169. * (see example).
  99170. */
  99171. dataLabels?: (PlotWmaDataLabelsOptions|Array<PlotWmaDataLabelsOptions>);
  99172. /**
  99173. * (Highcharts, Highstock) Options for the series data sorting.
  99174. */
  99175. dataSorting?: (DataSortingOptionsObject|PlotWmaDataSortingOptions);
  99176. /**
  99177. * (Highstock) A description of the series to add to the screen reader
  99178. * information about the series.
  99179. */
  99180. description?: string;
  99181. /**
  99182. * (Highstock) Enable or disable the mouse tracking for a specific series.
  99183. * This includes point tooltips and click events on graphs and points. For
  99184. * large datasets it improves performance.
  99185. */
  99186. enableMouseTracking?: boolean;
  99187. /**
  99188. * (Highstock) General event handlers for the series items. These event
  99189. * hooks can also be attached to the series at run time using the
  99190. * `Highcharts.addEvent` function.
  99191. */
  99192. events?: SeriesEventsOptionsObject;
  99193. /**
  99194. * (Highstock) Determines whether the series should look for the nearest
  99195. * point in both dimensions or just the x-dimension when hovering the
  99196. * series. Defaults to `'xy'` for scatter series and `'x'` for most other
  99197. * series. If the data has duplicate x-values, it is recommended to set this
  99198. * to `'xy'` to allow hovering over all points.
  99199. *
  99200. * Applies only to series types using nearest neighbor search (not direct
  99201. * hover) for tooltip.
  99202. */
  99203. findNearestPointBy?: OptionsFindNearestPointByValue;
  99204. /**
  99205. * (Highstock) Defines when to display a gap in the graph, together with the
  99206. * gapUnit option.
  99207. *
  99208. * In case when `dataGrouping` is enabled, points can be grouped into a
  99209. * larger time span. This can make the grouped points to have a greater
  99210. * distance than the absolute value of `gapSize` property, which will result
  99211. * in disappearing graph completely. To prevent this situation the mentioned
  99212. * distance between grouped points is used instead of previously defined
  99213. * `gapSize`.
  99214. *
  99215. * In practice, this option is most often used to visualize gaps in time
  99216. * series. In a stock chart, intraday data is available for daytime hours,
  99217. * while gaps will appear in nights and weekends.
  99218. */
  99219. gapSize?: number;
  99220. /**
  99221. * (Highstock) Together with gapSize, this option defines where to draw gaps
  99222. * in the graph.
  99223. *
  99224. * When the `gapUnit` is `"relative"` (default), a gap size of 5 means that
  99225. * if the distance between two points is greater than 5 times that of the
  99226. * two closest points, the graph will be broken.
  99227. *
  99228. * When the `gapUnit` is `"value"`, the gap is based on absolute axis
  99229. * values, which on a datetime axis is milliseconds. This also applies to
  99230. * the navigator series that inherits gap options from the base series.
  99231. */
  99232. gapUnit?: OptionsGapUnitValue;
  99233. /**
  99234. * (Highcharts, Highstock, Gantt) Whether to use the Y extremes of the total
  99235. * chart width or only the zoomed area when zooming in on parts of the X
  99236. * axis. By default, the Y axis adjusts to the min and max of the visible
  99237. * data. Cartesian series only.
  99238. */
  99239. getExtremesFromAll?: boolean;
  99240. /**
  99241. * (Highstock) When set to `false` will prevent the series data from being
  99242. * included in any form of data export.
  99243. *
  99244. * Since version 6.0.0 until 7.1.0 the option was existing undocumented as
  99245. * `includeInCSVExport`.
  99246. */
  99247. includeInDataExport?: boolean;
  99248. /**
  99249. * (Highcharts, Highstock, Gantt) Series labels are placed as close to the
  99250. * series as possible in a natural way, seeking to avoid other series. The
  99251. * goal of this feature is to make the chart more easily readable, like if a
  99252. * human designer placed the labels in the optimal position.
  99253. *
  99254. * The series labels currently work with series types having a `graph` or an
  99255. * `area`.
  99256. */
  99257. label?: SeriesLabelOptionsObject;
  99258. /**
  99259. * (Highstock) The line marks the last price from all points.
  99260. */
  99261. lastPrice?: SeriesLastPriceOptionsObject;
  99262. /**
  99263. * (Highstock) The line marks the last price from visible range of points.
  99264. */
  99265. lastVisiblePrice?: SeriesLastVisiblePriceOptionsObject;
  99266. /**
  99267. * (Highcharts, Highstock) The SVG value used for the `stroke-linecap` and
  99268. * `stroke-linejoin` of a line graph. Round means that lines are rounded in
  99269. * the ends and bends.
  99270. */
  99271. linecap?: SeriesLinecapValue;
  99272. /**
  99273. * (Highcharts, Highstock) Pixel width of the graph line.
  99274. */
  99275. lineWidth?: number;
  99276. /**
  99277. * (Highcharts, Highstock, Gantt) The main series ID that indicator will be
  99278. * based on. Required for this indicator.
  99279. */
  99280. linkedTo?: string;
  99281. /**
  99282. * (Highstock) Options for the point markers of line-like series. Properties
  99283. * like `fillColor`, `lineColor` and `lineWidth` define the visual
  99284. * appearance of the markers. Other series types, like column series, don't
  99285. * have markers, but have visual options on the series level instead.
  99286. *
  99287. * In styled mode, the markers can be styled with the `.highcharts-point`,
  99288. * `.highcharts-point-hover` and `.highcharts-point-select` class names.
  99289. */
  99290. marker?: PointMarkerOptionsObject;
  99291. /**
  99292. * (Highstock) The name of the series as shown in the legend, tooltip etc.
  99293. * If not set, it will be based on a technical indicator type and default
  99294. * params.
  99295. */
  99296. name?: string;
  99297. /**
  99298. * (Highstock) The color for the parts of the graph or points that are below
  99299. * the threshold. Note that `zones` takes precedence over the negative
  99300. * color. Using `negativeColor` is equivalent to applying a zone with value
  99301. * of 0.
  99302. */
  99303. negativeColor?: (ColorString|GradientColorObject|PatternObject);
  99304. /**
  99305. * (Highstock) Opacity of a series parts: line, fill (e.g. area) and
  99306. * dataLabels.
  99307. */
  99308. opacity?: number;
  99309. /**
  99310. * (Highstock) Paramters used in calculation of regression series' points.
  99311. */
  99312. params?: PlotWmaParamsOptions;
  99313. /**
  99314. * (Highstock) Properties for each single point.
  99315. */
  99316. point?: PlotSeriesPointOptions;
  99317. /**
  99318. * (Highstock) Same as accessibility.pointDescriptionFormatter, but for an
  99319. * individual series. Overrides the chart wide configuration.
  99320. */
  99321. pointDescriptionFormatter?: Function;
  99322. /**
  99323. * (Highstock) Whether to select the series initially. If `showCheckbox` is
  99324. * true, the checkbox next to the series name in the legend will be checked
  99325. * for a selected series.
  99326. */
  99327. selected?: boolean;
  99328. /**
  99329. * (Highstock) Whether to apply a drop shadow to the graph line. Since 2.3
  99330. * the shadow can be an object configuration containing `color`, `offsetX`,
  99331. * `offsetY`, `opacity` and `width`.
  99332. */
  99333. shadow?: (boolean|ShadowOptionsObject);
  99334. /**
  99335. * (Highstock) If true, a checkbox is displayed next to the legend item to
  99336. * allow selecting the series. The state of the checkbox is determined by
  99337. * the `selected` option.
  99338. */
  99339. showCheckbox?: boolean;
  99340. /**
  99341. * (Highstock) Whether to display this particular series or series type in
  99342. * the legend. Standalone series are shown in legend by default, and linked
  99343. * series are not. Since v7.2.0 it is possible to show series that use
  99344. * colorAxis by setting this option to `true`.
  99345. */
  99346. showInLegend?: boolean;
  99347. /**
  99348. * (Highstock) If set to `true`, the accessibility module will skip past the
  99349. * points in this series for keyboard navigation.
  99350. */
  99351. skipKeyboardNavigation?: boolean;
  99352. /**
  99353. * (Highcharts, Highstock) When this is true, the series will not cause the
  99354. * Y axis to cross the zero plane (or threshold option) unless the data
  99355. * actually crosses the plane.
  99356. *
  99357. * For example, if `softThreshold` is `false`, a series of 0, 1, 2, 3 will
  99358. * make the Y axis show negative values according to the `minPadding`
  99359. * option. If `softThreshold` is `true`, the Y axis starts at 0.
  99360. */
  99361. softThreshold?: boolean;
  99362. states?: SeriesStatesOptionsObject;
  99363. /**
  99364. * (Highcharts, Highstock) Whether to apply steps to the line. Possible
  99365. * values are `left`, `center` and `right`.
  99366. */
  99367. step?: OptionsStepValue;
  99368. /**
  99369. * (Highstock) Sticky tracking of mouse events. When true, the `mouseOut`
  99370. * event on a series isn't triggered until the mouse moves over another
  99371. * series, or out of the plot area. When false, the `mouseOut` event on a
  99372. * series is triggered when the mouse leaves the area around the series'
  99373. * graph or markers. This also implies the tooltip when not shared. When
  99374. * `stickyTracking` is false and `tooltip.shared` is false, the tooltip will
  99375. * be hidden when moving the mouse between series. Defaults to true for line
  99376. * and area type series, but to false for columns, pies etc.
  99377. *
  99378. * **Note:** The boost module will force this option because of technical
  99379. * limitations.
  99380. */
  99381. stickyTracking?: boolean;
  99382. /**
  99383. * (Highcharts, Highstock) The threshold, also called zero level or base
  99384. * level. For line type series this is only used in conjunction with
  99385. * negativeColor.
  99386. */
  99387. threshold?: (number|null);
  99388. /**
  99389. * (Highstock) A configuration object for the tooltip rendering of each
  99390. * single series. Properties are inherited from tooltip, but only the
  99391. * following properties can be defined on a series level.
  99392. */
  99393. tooltip?: SeriesTooltipOptionsObject;
  99394. /**
  99395. * (Highcharts, Highstock, Gantt) When a series contains a data array that
  99396. * is longer than this, only one dimensional arrays of numbers, or two
  99397. * dimensional arrays with x and y values are allowed. Also, only the first
  99398. * point is tested, and the rest are assumed to be the same format. This
  99399. * saves expensive data checking and indexing in long series. Set it to `0`
  99400. * disable.
  99401. *
  99402. * Note: In boost mode turbo threshold is forced. Only array of numbers or
  99403. * two dimensional arrays are allowed.
  99404. */
  99405. turboThreshold?: number;
  99406. /**
  99407. * (Highstock) Set the initial visibility of the series.
  99408. */
  99409. visible?: boolean;
  99410. /**
  99411. * (Highmaps) Define the z index of the series.
  99412. */
  99413. zIndex?: number;
  99414. /**
  99415. * (Highcharts, Highstock) Defines the Axis on which the zones are applied.
  99416. */
  99417. zoneAxis?: string;
  99418. /**
  99419. * (Highcharts, Highstock) An array defining zones within a series. Zones
  99420. * can be applied to the X axis, Y axis or Z axis for bubbles, according to
  99421. * the `zoneAxis` option. The zone definitions have to be in ascending order
  99422. * regarding to the value.
  99423. *
  99424. * In styled mode, the color zones are styled with the
  99425. * `.highcharts-zone-{n}` class, or custom classed from the `className`
  99426. * option (view live demo).
  99427. */
  99428. zones?: Array<SeriesZonesOptionsObject>;
  99429. }
  99430. /**
  99431. * (Highstock) Paramters used in calculation of regression series' points.
  99432. */
  99433. export interface PlotWmaParamsOptions {
  99434. /**
  99435. * (Highstock) The point index which indicator calculations will base. For
  99436. * example using OHLC data, index=2 means the indicator will be calculated
  99437. * using Low values.
  99438. */
  99439. index?: number;
  99440. /**
  99441. * (Highstock) The base period for indicator calculations. This is the
  99442. * number of data points which are taken into account for the indicator
  99443. * calculations.
  99444. */
  99445. period?: number;
  99446. }
  99447. /**
  99448. * (Highcharts) Enable or disable the initial animation when a series is
  99449. * displayed. The animation can also be set as a configuration object. Please
  99450. * note that this option only applies to the initial animation of the series
  99451. * itself. For other animations, see chart.animation and the animation parameter
  99452. * under the API methods. The following properties are supported:
  99453. *
  99454. * - `defer`: The animation delay time in milliseconds.
  99455. *
  99456. * - `duration`: The duration of the animation in milliseconds.
  99457. *
  99458. * - `easing`: Can be a string reference to an easing function set on the `Math`
  99459. * object or a function. See the _Custom easing function_ demo below.
  99460. *
  99461. * Due to poor performance, animation is disabled in old IE browsers for several
  99462. * chart types.
  99463. */
  99464. export interface PlotWordcloudAnimationOptions {
  99465. defer?: number;
  99466. }
  99467. /**
  99468. * (Highcharts) A word cloud is a visualization of a set of words, where the
  99469. * size and placement of a word is determined by how it is weighted.
  99470. *
  99471. * In TypeScript the type option must always be set.
  99472. *
  99473. * Configuration options for the series are given in three levels:
  99474. *
  99475. * 1. Options for all series in a chart are defined in the plotOptions.series
  99476. * object.
  99477. *
  99478. * 2. Options for all `wordcloud` series are defined in plotOptions.wordcloud.
  99479. *
  99480. * 3. Options for one single series are given in the series instance array. (see
  99481. * online documentation for example)
  99482. */
  99483. export interface PlotWordcloudOptions {
  99484. /**
  99485. * (Highcharts) Accessibility options for a series.
  99486. */
  99487. accessibility?: SeriesAccessibilityOptionsObject;
  99488. /**
  99489. * (Highcharts) If there is no space for a word on the playing field, then
  99490. * this option will allow the playing field to be extended to fit the word.
  99491. * If false then the word will be dropped from the visualization.
  99492. *
  99493. * NB! This option is currently not decided to be published in the API, and
  99494. * is therefore marked as private.
  99495. */
  99496. allowExtendPlayingField?: boolean;
  99497. /**
  99498. * (Highcharts) Allow this series' points to be selected by clicking on the
  99499. * graphic (columns, point markers, pie slices, map areas etc).
  99500. *
  99501. * The selected points can be handled by point select and unselect events,
  99502. * or collectively by the getSelectedPoints function.
  99503. *
  99504. * And alternative way of selecting points is through dragging.
  99505. */
  99506. allowPointSelect?: boolean;
  99507. /**
  99508. * (Highcharts) Enable or disable the initial animation when a series is
  99509. * displayed. The animation can also be set as a configuration object.
  99510. * Please note that this option only applies to the initial animation of the
  99511. * series itself. For other animations, see chart.animation and the
  99512. * animation parameter under the API methods. The following properties are
  99513. * supported:
  99514. *
  99515. * - `defer`: The animation delay time in milliseconds.
  99516. *
  99517. * - `duration`: The duration of the animation in milliseconds.
  99518. *
  99519. * - `easing`: Can be a string reference to an easing function set on the
  99520. * `Math` object or a function. See the _Custom easing function_ demo below.
  99521. *
  99522. * Due to poor performance, animation is disabled in old IE browsers for
  99523. * several chart types.
  99524. */
  99525. animation?: (boolean|PlotWordcloudAnimationOptions|Partial<AnimationOptionsObject>);
  99526. /**
  99527. * (Highcharts) For some series, there is a limit that shuts down initial
  99528. * animation by default when the total number of points in the chart is too
  99529. * high. For example, for a column chart and its derivatives, animation does
  99530. * not run if there is more than 250 points totally. To disable this cap,
  99531. * set `animationLimit` to `Infinity`.
  99532. */
  99533. animationLimit?: number;
  99534. /**
  99535. * (Highcharts, Highstock, Gantt) The color of the border surrounding each
  99536. * column or bar.
  99537. *
  99538. * In styled mode, the border stroke can be set with the `.highcharts-point`
  99539. * rule.
  99540. */
  99541. borderColor?: (ColorString|GradientColorObject|PatternObject);
  99542. /**
  99543. * (Highcharts, Highstock, Gantt) The corner radius of the border
  99544. * surrounding each column or bar.
  99545. */
  99546. borderRadius?: number;
  99547. /**
  99548. * (Highcharts, Highstock, Gantt) The width of the border surrounding each
  99549. * column or bar. Defaults to `1` when there is room for a border, but to
  99550. * `0` when the columns are so dense that a border would cover the next
  99551. * column.
  99552. *
  99553. * In styled mode, the stroke width can be set with the `.highcharts-point`
  99554. * rule.
  99555. */
  99556. borderWidth?: number;
  99557. /**
  99558. * (Highcharts, Highstock, Gantt) When `true`, the columns will center in
  99559. * the category, ignoring null or missing points. When `false`, space will
  99560. * be reserved for null or missing points.
  99561. */
  99562. centerInCategory?: boolean;
  99563. /**
  99564. * (Highcharts) An additional class name to apply to the series' graphical
  99565. * elements. This option does not replace default class names of the
  99566. * graphical element.
  99567. */
  99568. className?: string;
  99569. clip?: boolean;
  99570. /**
  99571. * (Highcharts) The main color of the series. In line type series it applies
  99572. * to the line and the point markers unless otherwise specified. In bar type
  99573. * series it applies to the bars unless a color is specified per point. The
  99574. * default value is pulled from the `options.colors` array.
  99575. *
  99576. * In styled mode, the color can be defined by the colorIndex option. Also,
  99577. * the series color can be set with the `.highcharts-series`,
  99578. * `.highcharts-color-{n}`, `.highcharts-{type}-series` or
  99579. * `.highcharts-series-{n}` class, or individual classes given by the
  99580. * `className` option.
  99581. */
  99582. color?: (ColorString|GradientColorObject|PatternObject);
  99583. /**
  99584. * (Highcharts, Highstock, Gantt) When using automatic point colors pulled
  99585. * from the global colors or series-specific plotOptions.column.colors
  99586. * collections, this option determines whether the chart should receive one
  99587. * color per series or one color per point.
  99588. *
  99589. * In styled mode, the `colors` or `series.colors` arrays are not supported,
  99590. * and instead this option gives the points individual color class names on
  99591. * the form `highcharts-color-{n}`.
  99592. */
  99593. colorByPoint?: boolean;
  99594. /**
  99595. * (Highcharts) Styled mode only. A specific color index to use for the
  99596. * series, so its graphic representations are given the class name
  99597. * `highcharts-color-{n}`.
  99598. */
  99599. colorIndex?: number;
  99600. /**
  99601. * (Highcharts, Highstock, Highmaps) Determines what data value should be
  99602. * used to calculate point color if `colorAxis` is used. Requires to set
  99603. * `min` and `max` if some custom point property is used or if approximation
  99604. * for data grouping is set to `'sum'`.
  99605. */
  99606. colorKey?: string;
  99607. /**
  99608. * (Highcharts, Highstock, Gantt) A series specific or series type specific
  99609. * color set to apply instead of the global colors when colorByPoint is
  99610. * true.
  99611. */
  99612. colors?: Array<(ColorString|GradientColorObject|PatternObject)>;
  99613. /**
  99614. * (Highstock) Defines if comparison should start from the first point
  99615. * within the visible range or should start from the first point **before**
  99616. * the range.
  99617. *
  99618. * In other words, this flag determines if first point within the visible
  99619. * range will have 0% (`compareStart=true`) or should have been already
  99620. * calculated according to the previous point (`compareStart=false`).
  99621. */
  99622. compareStart?: boolean;
  99623. /**
  99624. * (Gantt) Override Pathfinder connector options for a series. Requires
  99625. * Highcharts Gantt to be loaded.
  99626. */
  99627. connectors?: SeriesConnectorsOptionsObject;
  99628. /**
  99629. * (Highcharts, Highstock, Gantt) When the series contains less points than
  99630. * the crop threshold, all points are drawn, event if the points fall
  99631. * outside the visible plot area at the current zoom. The advantage of
  99632. * drawing all points (including markers and columns), is that animation is
  99633. * performed on updates. On the other hand, when the series contains more
  99634. * points than the crop threshold, the series data is cropped to only
  99635. * contain points that fall within the plot area. The advantage of cropping
  99636. * away invisible points is to increase performance on large series.
  99637. */
  99638. cropThreshold?: number;
  99639. /**
  99640. * (Highcharts) You can set the cursor to "pointer" if you have click events
  99641. * attached to the series, to signal to the user that the points and lines
  99642. * can be clicked.
  99643. *
  99644. * In styled mode, the series cursor can be set with the same classes as
  99645. * listed under series.color.
  99646. */
  99647. cursor?: (string|CursorValue);
  99648. /**
  99649. * (Highcharts) A reserved subspace to store options and values for
  99650. * customized functionality. Here you can add additional data for your own
  99651. * event callbacks and formatter callbacks.
  99652. */
  99653. custom?: Dictionary<any>;
  99654. /**
  99655. * (Highcharts) Name of the dash style to use for the graph, or for some
  99656. * series types the outline of each shape.
  99657. *
  99658. * In styled mode, the stroke dash-array can be set with the same classes as
  99659. * listed under series.color.
  99660. */
  99661. dashStyle?: DashStyleValue;
  99662. /**
  99663. * (Highcharts) A description of the series to add to the screen reader
  99664. * information about the series.
  99665. */
  99666. description?: string;
  99667. /**
  99668. * (Highcharts) 3D columns only. The width of the colored edges.
  99669. */
  99670. edgeWidth?: number;
  99671. /**
  99672. * (Highcharts) Enable or disable the mouse tracking for a specific series.
  99673. * This includes point tooltips and click events on graphs and points. For
  99674. * large datasets it improves performance.
  99675. */
  99676. enableMouseTracking?: boolean;
  99677. /**
  99678. * (Highcharts) General event handlers for the series items. These event
  99679. * hooks can also be attached to the series at run time using the
  99680. * `Highcharts.addEvent` function.
  99681. */
  99682. events?: SeriesEventsOptionsObject;
  99683. /**
  99684. * (Highcharts) When set to `false` will prevent the series data from being
  99685. * included in any form of data export.
  99686. *
  99687. * Since version 6.0.0 until 7.1.0 the option was existing undocumented as
  99688. * `includeInCSVExport`.
  99689. */
  99690. includeInDataExport?: boolean;
  99691. /**
  99692. * (Highcharts) An array specifying which option maps to which key in the
  99693. * data point array. This makes it convenient to work with unstructured data
  99694. * arrays from different sources.
  99695. */
  99696. keys?: Array<string>;
  99697. /**
  99698. * (Highcharts, Highstock, Gantt) Series labels are placed as close to the
  99699. * series as possible in a natural way, seeking to avoid other series. The
  99700. * goal of this feature is to make the chart more easily readable, like if a
  99701. * human designer placed the labels in the optimal position.
  99702. *
  99703. * The series labels currently work with series types having a `graph` or an
  99704. * `area`.
  99705. */
  99706. label?: SeriesLabelOptionsObject;
  99707. /**
  99708. * (Highstock) The line marks the last price from all points.
  99709. */
  99710. lastPrice?: SeriesLastPriceOptionsObject;
  99711. /**
  99712. * (Highstock) The line marks the last price from visible range of points.
  99713. */
  99714. lastVisiblePrice?: SeriesLastVisiblePriceOptionsObject;
  99715. /**
  99716. * (Highcharts, Highstock, Gantt) The id of another series to link to.
  99717. * Additionally, the value can be ":previous" to link to the previous
  99718. * series. When two series are linked, only the first one appears in the
  99719. * legend. Toggling the visibility of this also toggles the linked series.
  99720. *
  99721. * If master series uses data sorting and linked series does not have its
  99722. * own sorting definition, the linked series will be sorted in the same
  99723. * order as the master one.
  99724. */
  99725. linkedTo?: string;
  99726. /**
  99727. * (Highcharts) The word with the largest weight will have a font size equal
  99728. * to this value. The font size of a word is the ratio between its weight
  99729. * and the largest occuring weight, multiplied with the value of
  99730. * maxFontSize.
  99731. */
  99732. maxFontSize?: number;
  99733. /**
  99734. * (Highcharts) A threshold determining the minimum font size that can be
  99735. * applied to a word.
  99736. */
  99737. minFontSize?: number;
  99738. /**
  99739. * (Highcharts) Opacity of a series parts: line, fill (e.g. area) and
  99740. * dataLabels.
  99741. */
  99742. opacity?: number;
  99743. /**
  99744. * (Highcharts) This option decides which algorithm is used for placement,
  99745. * and rotation of a word. The choice of algorith is therefore a crucial
  99746. * part of the resulting layout of the wordcloud. It is possible for users
  99747. * to add their own custom placement strategies for use in word cloud. Read
  99748. * more about it in our documentation
  99749. */
  99750. placementStrategy?: string;
  99751. /**
  99752. * (Highcharts) Properties for each single point.
  99753. */
  99754. point?: PlotSeriesPointOptions;
  99755. /**
  99756. * (Highcharts) Same as accessibility.pointDescriptionFormatter, but for an
  99757. * individual series. Overrides the chart wide configuration.
  99758. */
  99759. pointDescriptionFormatter?: Function;
  99760. /**
  99761. * (Highcharts) Rotation options for the words in the wordcloud.
  99762. */
  99763. rotation?: PlotWordcloudRotationOptions;
  99764. /**
  99765. * (Highcharts) Whether to select the series initially. If `showCheckbox` is
  99766. * true, the checkbox next to the series name in the legend will be checked
  99767. * for a selected series.
  99768. */
  99769. selected?: boolean;
  99770. /**
  99771. * (Highcharts) Whether to display this particular series or series type in
  99772. * the legend. Standalone series are shown in legend by default, and linked
  99773. * series are not. Since v7.2.0 it is possible to show series that use
  99774. * colorAxis by setting this option to `true`.
  99775. */
  99776. showInLegend?: boolean;
  99777. /**
  99778. * (Highcharts) If set to `true`, the accessibility module will skip past
  99779. * the points in this series for keyboard navigation.
  99780. */
  99781. skipKeyboardNavigation?: boolean;
  99782. /**
  99783. * (Highcharts) Spiral used for placing a word after the initial position
  99784. * experienced a collision with either another word or the borders. It is
  99785. * possible for users to add their own custom spiralling algorithms for use
  99786. * in word cloud. Read more about it in our documentation
  99787. */
  99788. spiral?: string;
  99789. states?: SeriesStatesOptionsObject;
  99790. /**
  99791. * (Highcharts) Sticky tracking of mouse events. When true, the `mouseOut`
  99792. * event on a series isn't triggered until the mouse moves over another
  99793. * series, or out of the plot area. When false, the `mouseOut` event on a
  99794. * series is triggered when the mouse leaves the area around the series'
  99795. * graph or markers. This also implies the tooltip when not shared. When
  99796. * `stickyTracking` is false and `tooltip.shared` is false, the tooltip will
  99797. * be hidden when moving the mouse between series. Defaults to true for line
  99798. * and area type series, but to false for columns, pies etc.
  99799. *
  99800. * **Note:** The boost module will force this option because of technical
  99801. * limitations.
  99802. */
  99803. stickyTracking?: boolean;
  99804. /**
  99805. * (Highcharts) CSS styles for the words.
  99806. */
  99807. style?: CSSObject;
  99808. /**
  99809. * (Highcharts) A configuration object for the tooltip rendering of each
  99810. * single series. Properties are inherited from tooltip, but only the
  99811. * following properties can be defined on a series level.
  99812. */
  99813. tooltip?: SeriesTooltipOptionsObject;
  99814. /**
  99815. * (Highcharts, Highstock, Gantt) When a series contains a data array that
  99816. * is longer than this, only one dimensional arrays of numbers, or two
  99817. * dimensional arrays with x and y values are allowed. Also, only the first
  99818. * point is tested, and the rest are assumed to be the same format. This
  99819. * saves expensive data checking and indexing in long series. Set it to `0`
  99820. * disable.
  99821. *
  99822. * Note: In boost mode turbo threshold is forced. Only array of numbers or
  99823. * two dimensional arrays are allowed.
  99824. */
  99825. turboThreshold?: number;
  99826. /**
  99827. * (Highcharts) Set the initial visibility of the series.
  99828. */
  99829. visible?: boolean;
  99830. /**
  99831. * (Highmaps) Define the z index of the series.
  99832. */
  99833. zIndex?: number;
  99834. }
  99835. /**
  99836. * (Highcharts) Rotation options for the words in the wordcloud.
  99837. */
  99838. export interface PlotWordcloudRotationOptions {
  99839. /**
  99840. * (Highcharts) The smallest degree of rotation for a word.
  99841. */
  99842. from?: number;
  99843. /**
  99844. * (Highcharts) The number of possible orientations for a word, within the
  99845. * range of `rotation.from` and `rotation.to`. Must be a number larger than
  99846. * 0.
  99847. */
  99848. orientations?: number;
  99849. /**
  99850. * (Highcharts) The largest degree of rotation for a word.
  99851. */
  99852. to?: number;
  99853. }
  99854. /**
  99855. * (Highcharts, Highstock, Gantt) Enable or disable the initial animation when a
  99856. * series is displayed. The animation can also be set as a configuration object.
  99857. * Please note that this option only applies to the initial animation of the
  99858. * series itself. For other animations, see chart.animation and the animation
  99859. * parameter under the API methods. The following properties are supported:
  99860. *
  99861. * - `defer`: The animation delay time in milliseconds.
  99862. *
  99863. * - `duration`: The duration of the animation in milliseconds.
  99864. *
  99865. * - `easing`: Can be a string reference to an easing function set on the `Math`
  99866. * object or a function. See the _Custom easing function_ demo below.
  99867. *
  99868. * Due to poor performance, animation is disabled in old IE browsers for several
  99869. * chart types.
  99870. */
  99871. export interface PlotXrangeAnimationOptions {
  99872. defer?: number;
  99873. }
  99874. /**
  99875. * (Highcharts, Highstock, Highmaps, Gantt) Enable or disable the initial
  99876. * animation when a series is displayed for the `dataLabels`. The animation can
  99877. * also be set as a configuration object. Please note that this option only
  99878. * applies to the initial animation. For other animations, see chart.animation
  99879. * and the animation parameter under the API methods. The following properties
  99880. * are supported:
  99881. *
  99882. * - `defer`: The animation delay time in milliseconds.
  99883. */
  99884. export interface PlotXrangeDataLabelsAnimationOptions {
  99885. /**
  99886. * (Highcharts, Highstock, Highmaps, Gantt) The animation delay time in
  99887. * milliseconds. Set to `0` renders dataLabel immediately. As `undefined`
  99888. * inherits defer time from the series.animation.defer.
  99889. */
  99890. defer?: number;
  99891. }
  99892. /**
  99893. * (Highcharts, Highstock, Highmaps, Gantt) Options for the series data labels,
  99894. * appearing next to each data point.
  99895. *
  99896. * Since v6.2.0, multiple data labels can be applied to each single point by
  99897. * defining them as an array of configs.
  99898. *
  99899. * In styled mode, the data labels can be styled with the
  99900. * `.highcharts-data-label-box` and `.highcharts-data-label` class names (see
  99901. * example).
  99902. */
  99903. export interface PlotXrangeDataLabelsOptions {
  99904. /**
  99905. * (Highcharts, Highstock, Highmaps, Gantt) The alignment of the data label
  99906. * compared to the point. If `right`, the right side of the label should be
  99907. * touching the point. For points with an extent, like columns, the
  99908. * alignments also dictates how to align it inside the box, as given with
  99909. * the inside option. Can be one of `left`, `center` or `right`.
  99910. */
  99911. align?: string;
  99912. /**
  99913. * (Highcharts, Highstock, Highmaps, Gantt) Whether to allow data labels to
  99914. * overlap. To make the labels less sensitive for overlapping, the
  99915. * dataLabels.padding can be set to 0.
  99916. */
  99917. allowOverlap?: boolean;
  99918. /**
  99919. * (Highcharts, Highstock, Highmaps, Gantt) Enable or disable the initial
  99920. * animation when a series is displayed for the `dataLabels`. The animation
  99921. * can also be set as a configuration object. Please note that this option
  99922. * only applies to the initial animation. For other animations, see
  99923. * chart.animation and the animation parameter under the API methods. The
  99924. * following properties are supported:
  99925. *
  99926. * - `defer`: The animation delay time in milliseconds.
  99927. */
  99928. animation?: (boolean|PlotXrangeDataLabelsAnimationOptions|Partial<AnimationOptionsObject>);
  99929. /**
  99930. * (Highcharts, Highstock, Highmaps, Gantt) The background color or gradient
  99931. * for the data label.
  99932. */
  99933. backgroundColor?: (ColorString|GradientColorObject|PatternObject);
  99934. /**
  99935. * (Highcharts, Highstock, Highmaps, Gantt) The border color for the data
  99936. * label. Defaults to `undefined`.
  99937. */
  99938. borderColor?: (ColorString|GradientColorObject|PatternObject);
  99939. /**
  99940. * (Highcharts, Highstock, Highmaps, Gantt) The border radius in pixels for
  99941. * the data label.
  99942. */
  99943. borderRadius?: number;
  99944. /**
  99945. * (Highcharts, Highstock, Highmaps, Gantt) The border width in pixels for
  99946. * the data label.
  99947. */
  99948. borderWidth?: number;
  99949. /**
  99950. * (Highcharts, Highstock, Highmaps, Gantt) A class name for the data label.
  99951. * Particularly in styled mode, this can be used to give each series' or
  99952. * point's data label unique styling. In addition to this option, a default
  99953. * color class name is added so that we can give the labels a contrast text
  99954. * shadow.
  99955. */
  99956. className?: string;
  99957. /**
  99958. * (Highcharts, Highstock, Highmaps, Gantt) The text color for the data
  99959. * labels. Defaults to `undefined`. For certain series types, like column or
  99960. * map, the data labels can be drawn inside the points. In this case the
  99961. * data label will be drawn with maximum contrast by default. Additionally,
  99962. * it will be given a `text-outline` style with the opposite color, to
  99963. * further increase the contrast. This can be overridden by setting the
  99964. * `text-outline` style to `none` in the `dataLabels.style` option.
  99965. */
  99966. color?: (ColorString|GradientColorObject|PatternObject);
  99967. /**
  99968. * (Highcharts, Highstock, Highmaps, Gantt) Whether to hide data labels that
  99969. * are outside the plot area. By default, the data label is moved inside the
  99970. * plot area according to the overflow option.
  99971. */
  99972. crop?: boolean;
  99973. /**
  99974. * (Highcharts, Highstock, Gantt) Whether to defer displaying the data
  99975. * labels until the initial series animation has finished. Setting to
  99976. * `false` renders the data label immediately. If set to `true` inherits the
  99977. * defer time set in plotOptions.series.animation.
  99978. */
  99979. defer?: boolean;
  99980. /**
  99981. * (Highcharts, Highstock, Highmaps, Gantt) Enable or disable the data
  99982. * labels.
  99983. */
  99984. enabled?: boolean;
  99985. /**
  99986. * (Highcharts, Highstock, Highmaps, Gantt) A declarative filter to control
  99987. * of which data labels to display. The declarative filter is designed for
  99988. * use when callback functions are not available, like when the chart
  99989. * options require a pure JSON structure or for use with graphical editors.
  99990. * For programmatic control, use the `formatter` instead, and return
  99991. * `undefined` to disable a single data label.
  99992. */
  99993. filter?: DataLabelsFilterOptionsObject;
  99994. /**
  99995. * (Highcharts, Highstock, Highmaps, Gantt) A format string for the data
  99996. * label. Available variables are the same as for `formatter`.
  99997. */
  99998. format?: string;
  99999. /**
  100000. * (Highcharts, Highstock, Highmaps, Gantt) Callback JavaScript function to
  100001. * format the data label. Note that if a `format` is defined, the format
  100002. * takes precedence and the formatter is ignored.
  100003. */
  100004. formatter?: DataLabelsFormatterCallbackFunction;
  100005. /**
  100006. * (Highcharts, Highstock, Highmaps, Gantt) For points with an extent, like
  100007. * columns or map areas, whether to align the data label inside the box or
  100008. * to the actual value point. Defaults to `false` in most cases, `true` in
  100009. * stacked columns.
  100010. */
  100011. inside?: boolean;
  100012. /**
  100013. * (Highcharts, Highstock, Highmaps, Gantt) Format for points with the value
  100014. * of null. Works analogously to format. `nullFormat` can be applied only to
  100015. * series which support displaying null points.
  100016. */
  100017. nullFormat?: (boolean|string);
  100018. /**
  100019. * (Highcharts, Highstock, Highmaps, Gantt) Callback JavaScript function
  100020. * that defines formatting for points with the value of null. Works
  100021. * analogously to formatter. `nullPointFormatter` can be applied only to
  100022. * series which support displaying null points.
  100023. */
  100024. nullFormatter?: DataLabelsFormatterCallbackFunction;
  100025. /**
  100026. * (Highcharts, Highstock, Highmaps, Gantt) How to handle data labels that
  100027. * flow outside the plot area. The default is `"justify"`, which aligns them
  100028. * inside the plot area. For columns and bars, this means it will be moved
  100029. * inside the bar. To display data labels outside the plot area, set `crop`
  100030. * to `false` and `overflow` to `"allow"`.
  100031. */
  100032. overflow?: DataLabelsOverflowValue;
  100033. /**
  100034. * (Highcharts, Highstock, Highmaps, Gantt) When either the `borderWidth` or
  100035. * the `backgroundColor` is set, this is the padding within the box.
  100036. */
  100037. padding?: number;
  100038. /**
  100039. * (Highcharts, Highstock, Highmaps, Gantt) Aligns data labels relative to
  100040. * points. If `center` alignment is not possible, it defaults to `right`.
  100041. */
  100042. position?: AlignValue;
  100043. /**
  100044. * (Highcharts, Highstock, Highmaps, Gantt) Text rotation in degrees. Note
  100045. * that due to a more complex structure, backgrounds, borders and padding
  100046. * will be lost on a rotated data label.
  100047. */
  100048. rotation?: number;
  100049. /**
  100050. * (Highcharts, Highstock, Highmaps, Gantt) The shadow of the box. Works
  100051. * best with `borderWidth` or `backgroundColor`. Since 2.3 the shadow can be
  100052. * an object configuration containing `color`, `offsetX`, `offsetY`,
  100053. * `opacity` and `width`.
  100054. */
  100055. shadow?: (boolean|ShadowOptionsObject);
  100056. /**
  100057. * (Highcharts, Highstock, Highmaps, Gantt) The name of a symbol to use for
  100058. * the border around the label. Symbols are predefined functions on the
  100059. * Renderer object.
  100060. */
  100061. shape?: string;
  100062. /**
  100063. * (Highcharts, Highstock, Highmaps, Gantt) Styles for the label. The
  100064. * default `color` setting is `"contrast"`, which is a pseudo color that
  100065. * Highcharts picks up and applies the maximum contrast to the underlying
  100066. * point item, for example the bar in a bar chart.
  100067. *
  100068. * The `textOutline` is a pseudo property that applies an outline of the
  100069. * given width with the given color, which by default is the maximum
  100070. * contrast to the text. So a bright text color will result in a black text
  100071. * outline for maximum readability on a mixed background. In some cases,
  100072. * especially with grayscale text, the text outline doesn't work well, in
  100073. * which cases it can be disabled by setting it to `"none"`. When `useHTML`
  100074. * is true, the `textOutline` will not be picked up. In this, case, the same
  100075. * effect can be acheived through the `text-shadow` CSS property.
  100076. *
  100077. * For some series types, where each point has an extent, like for example
  100078. * tree maps, the data label may overflow the point. There are two
  100079. * strategies for handling overflow. By default, the text will wrap to
  100080. * multiple lines. The other strategy is to set `style.textOverflow` to
  100081. * `ellipsis`, which will keep the text on one line plus it will break
  100082. * inside long words.
  100083. */
  100084. style?: CSSObject;
  100085. /**
  100086. * (Highcharts, Highstock, Highmaps, Gantt) Options for a label text which
  100087. * should follow marker's shape. Border and background are disabled for a
  100088. * label that follows a path.
  100089. *
  100090. * **Note:** Only SVG-based renderer supports this option. Setting `useHTML`
  100091. * to true will disable this option.
  100092. */
  100093. textPath?: DataLabelsTextPathOptionsObject;
  100094. /**
  100095. * (Highcharts, Highstock, Highmaps, Gantt) Whether to use HTML to render
  100096. * the labels.
  100097. */
  100098. useHTML?: boolean;
  100099. /**
  100100. * (Highcharts, Highstock, Highmaps, Gantt) The vertical alignment of a data
  100101. * label. Can be one of `top`, `middle` or `bottom`. The default value
  100102. * depends on the data, for instance in a column chart, the label is above
  100103. * positive values and below negative values.
  100104. */
  100105. verticalAlign?: string;
  100106. /**
  100107. * (Highcharts, Highstock, Highmaps, Gantt) The x position offset of the
  100108. * label relative to the point in pixels.
  100109. */
  100110. x?: number;
  100111. /**
  100112. * (Highcharts, Highstock, Highmaps, Gantt) The y position offset of the
  100113. * label relative to the point in pixels.
  100114. */
  100115. y?: number;
  100116. /**
  100117. * (Highcharts, Highstock, Highmaps, Gantt) The Z index of the data labels.
  100118. * The default Z index puts it above the series. Use a Z index of 2 to
  100119. * display it behind the series.
  100120. */
  100121. z?: number;
  100122. }
  100123. /**
  100124. * (Highcharts, Highstock, Gantt) Style options for the guide box. The guide box
  100125. * has one state by default, the `default` state.
  100126. */
  100127. export interface PlotXrangeDragDropGuideBoxOptions {
  100128. /**
  100129. * (Highcharts, Highstock, Gantt) Style options for the guide box default
  100130. * state.
  100131. */
  100132. default?: DragDropGuideBoxOptionsObject;
  100133. }
  100134. /**
  100135. * (Highcharts, Highstock, Gantt) The X-range series displays ranges on the X
  100136. * axis, typically time intervals with a start and end date.
  100137. *
  100138. * In TypeScript the type option must always be set.
  100139. *
  100140. * Configuration options for the series are given in three levels:
  100141. *
  100142. * 1. Options for all series in a chart are defined in the plotOptions.series
  100143. * object.
  100144. *
  100145. * 2. Options for all `xrange` series are defined in plotOptions.xrange.
  100146. *
  100147. * 3. Options for one single series are given in the series instance array. (see
  100148. * online documentation for example)
  100149. */
  100150. export interface PlotXrangeOptions {
  100151. /**
  100152. * (Highcharts, Highstock, Gantt) Accessibility options for a series.
  100153. */
  100154. accessibility?: SeriesAccessibilityOptionsObject;
  100155. /**
  100156. * (Highmaps) Whether all areas of the map defined in `mapData` should be
  100157. * rendered. If `true`, areas which don't correspond to a data point, are
  100158. * rendered as `null` points. If `false`, those areas are skipped.
  100159. */
  100160. allAreas?: boolean;
  100161. /**
  100162. * (Highcharts, Highstock, Gantt) Allow this series' points to be selected
  100163. * by clicking on the graphic (columns, point markers, pie slices, map areas
  100164. * etc).
  100165. *
  100166. * The selected points can be handled by point select and unselect events,
  100167. * or collectively by the getSelectedPoints function.
  100168. *
  100169. * And alternative way of selecting points is through dragging.
  100170. */
  100171. allowPointSelect?: boolean;
  100172. /**
  100173. * (Highcharts, Highstock, Gantt) Enable or disable the initial animation
  100174. * when a series is displayed. The animation can also be set as a
  100175. * configuration object. Please note that this option only applies to the
  100176. * initial animation of the series itself. For other animations, see
  100177. * chart.animation and the animation parameter under the API methods. The
  100178. * following properties are supported:
  100179. *
  100180. * - `defer`: The animation delay time in milliseconds.
  100181. *
  100182. * - `duration`: The duration of the animation in milliseconds.
  100183. *
  100184. * - `easing`: Can be a string reference to an easing function set on the
  100185. * `Math` object or a function. See the _Custom easing function_ demo below.
  100186. *
  100187. * Due to poor performance, animation is disabled in old IE browsers for
  100188. * several chart types.
  100189. */
  100190. animation?: (boolean|PlotXrangeAnimationOptions|Partial<AnimationOptionsObject>);
  100191. /**
  100192. * (Highcharts, Highstock, Gantt) For some series, there is a limit that
  100193. * shuts down initial animation by default when the total number of points
  100194. * in the chart is too high. For example, for a column chart and its
  100195. * derivatives, animation does not run if there is more than 250 points
  100196. * totally. To disable this cap, set `animationLimit` to `Infinity`.
  100197. */
  100198. animationLimit?: number;
  100199. /**
  100200. * (Highcharts, Highstock, Gantt) The color of the border surrounding each
  100201. * column or bar.
  100202. *
  100203. * In styled mode, the border stroke can be set with the `.highcharts-point`
  100204. * rule.
  100205. */
  100206. borderColor?: (ColorString|GradientColorObject|PatternObject);
  100207. /**
  100208. * (Highcharts, Highstock, Gantt) The corner radius of the border
  100209. * surrounding each column or bar.
  100210. */
  100211. borderRadius?: number;
  100212. /**
  100213. * (Highcharts, Highstock, Gantt) The width of the border surrounding each
  100214. * column or bar. Defaults to `1` when there is room for a border, but to
  100215. * `0` when the columns are so dense that a border would cover the next
  100216. * column.
  100217. *
  100218. * In styled mode, the stroke width can be set with the `.highcharts-point`
  100219. * rule.
  100220. */
  100221. borderWidth?: number;
  100222. /**
  100223. * (Highcharts, Highstock, Gantt) When `true`, the columns will center in
  100224. * the category, ignoring null or missing points. When `false`, space will
  100225. * be reserved for null or missing points.
  100226. */
  100227. centerInCategory?: boolean;
  100228. /**
  100229. * (Highcharts, Highstock, Gantt) An additional class name to apply to the
  100230. * series' graphical elements. This option does not replace default class
  100231. * names of the graphical element.
  100232. */
  100233. className?: string;
  100234. /**
  100235. * (Highcharts, Highstock, Gantt) Disable this option to allow series
  100236. * rendering in the whole plotting area.
  100237. *
  100238. * **Note:** Clipping should be always enabled when chart.zoomType is set
  100239. */
  100240. clip?: boolean;
  100241. /**
  100242. * (Highcharts, Highstock, Gantt) The main color of the series. In line type
  100243. * series it applies to the line and the point markers unless otherwise
  100244. * specified. In bar type series it applies to the bars unless a color is
  100245. * specified per point. The default value is pulled from the
  100246. * `options.colors` array.
  100247. *
  100248. * In styled mode, the color can be defined by the colorIndex option. Also,
  100249. * the series color can be set with the `.highcharts-series`,
  100250. * `.highcharts-color-{n}`, `.highcharts-{type}-series` or
  100251. * `.highcharts-series-{n}` class, or individual classes given by the
  100252. * `className` option.
  100253. */
  100254. color?: (ColorString|GradientColorObject|PatternObject);
  100255. /**
  100256. * (Highcharts, Highstock, Highmaps) When using dual or multiple color axes,
  100257. * this number defines which colorAxis the particular series is connected
  100258. * to. It refers to either the axis id or the index of the axis in the
  100259. * colorAxis array, with 0 being the first. Set this option to false to
  100260. * prevent a series from connecting to the default color axis.
  100261. *
  100262. * Since v7.2.0 the option can also be an axis id or an axis index instead
  100263. * of a boolean flag.
  100264. */
  100265. colorAxis?: (boolean|number|string);
  100266. /**
  100267. * (Highcharts, Highstock, Gantt) In an X-range series, this option makes
  100268. * all points of the same Y-axis category the same color.
  100269. */
  100270. colorByPoint?: boolean;
  100271. /**
  100272. * (Highcharts, Highstock, Gantt) Styled mode only. A specific color index
  100273. * to use for the series, so its graphic representations are given the class
  100274. * name `highcharts-color-{n}`.
  100275. */
  100276. colorIndex?: number;
  100277. /**
  100278. * (Highcharts, Highstock, Highmaps) Determines what data value should be
  100279. * used to calculate point color if `colorAxis` is used. Requires to set
  100280. * `min` and `max` if some custom point property is used or if approximation
  100281. * for data grouping is set to `'sum'`.
  100282. */
  100283. colorKey?: string;
  100284. /**
  100285. * (Highcharts, Highstock, Gantt) A series specific or series type specific
  100286. * color set to apply instead of the global colors when colorByPoint is
  100287. * true.
  100288. */
  100289. colors?: Array<(ColorString|GradientColorObject|PatternObject)>;
  100290. /**
  100291. * (Highstock) Compare the values of the series against the first non-null,
  100292. * non- zero value in the visible range. The y axis will show percentage or
  100293. * absolute change depending on whether `compare` is set to `"percent"` or
  100294. * `"value"`. When this is applied to multiple series, it allows comparing
  100295. * the development of the series against each other. Adds a `change` field
  100296. * to every point object.
  100297. */
  100298. compare?: string;
  100299. /**
  100300. * (Highstock) When compare is `percent`, this option dictates whether to
  100301. * use 0 or 100 as the base of comparison.
  100302. */
  100303. compareBase?: (0|100);
  100304. /**
  100305. * (Highstock) Defines if comparison should start from the first point
  100306. * within the visible range or should start from the first point **before**
  100307. * the range.
  100308. *
  100309. * In other words, this flag determines if first point within the visible
  100310. * range will have 0% (`compareStart=true`) or should have been already
  100311. * calculated according to the previous point (`compareStart=false`).
  100312. */
  100313. compareStart?: boolean;
  100314. /**
  100315. * (Gantt) Override Pathfinder connector options for a series. Requires
  100316. * Highcharts Gantt to be loaded.
  100317. */
  100318. connectors?: SeriesConnectorsOptionsObject;
  100319. /**
  100320. * (Highcharts, Highstock, Gantt) You can set the cursor to "pointer" if you
  100321. * have click events attached to the series, to signal to the user that the
  100322. * points and lines can be clicked.
  100323. *
  100324. * In styled mode, the series cursor can be set with the same classes as
  100325. * listed under series.color.
  100326. */
  100327. cursor?: (string|CursorValue);
  100328. /**
  100329. * (Highcharts, Highstock, Gantt) A reserved subspace to store options and
  100330. * values for customized functionality. Here you can add additional data for
  100331. * your own event callbacks and formatter callbacks.
  100332. */
  100333. custom?: Dictionary<any>;
  100334. /**
  100335. * (Highcharts, Highstock, Gantt) Name of the dash style to use for the
  100336. * graph, or for some series types the outline of each shape.
  100337. *
  100338. * In styled mode, the stroke dash-array can be set with the same classes as
  100339. * listed under series.color.
  100340. */
  100341. dashStyle?: DashStyleValue;
  100342. /**
  100343. * (Highstock) Data grouping is the concept of sampling the data values into
  100344. * larger blocks in order to ease readability and increase performance of
  100345. * the JavaScript charts. Highstock by default applies data grouping when
  100346. * the points become closer than a certain pixel value, determined by the
  100347. * `groupPixelWidth` option.
  100348. *
  100349. * If data grouping is applied, the grouping information of grouped points
  100350. * can be read from the Point.dataGroup. If point options other than the
  100351. * data itself are set, for example `name` or `color` or custom properties,
  100352. * the grouping logic doesn't know how to group it. In this case the options
  100353. * of the first point instance are copied over to the group point. This can
  100354. * be altered through a custom `approximation` callback function.
  100355. */
  100356. dataGrouping?: DataGroupingOptionsObject;
  100357. /**
  100358. * (Highcharts, Highstock, Highmaps, Gantt) Options for the series data
  100359. * labels, appearing next to each data point.
  100360. *
  100361. * Since v6.2.0, multiple data labels can be applied to each single point by
  100362. * defining them as an array of configs.
  100363. *
  100364. * In styled mode, the data labels can be styled with the
  100365. * `.highcharts-data-label-box` and `.highcharts-data-label` class names
  100366. * (see example).
  100367. */
  100368. dataLabels?: (PlotXrangeDataLabelsOptions|Array<PlotXrangeDataLabelsOptions>);
  100369. /**
  100370. * (Highcharts, Highstock, Gantt) A description of the series to add to the
  100371. * screen reader information about the series.
  100372. */
  100373. description?: string;
  100374. /**
  100375. * (Highcharts, Highstock, Gantt) The draggable-points module allows points
  100376. * to be moved around or modified in the chart. In addition to the options
  100377. * mentioned under the `dragDrop` API structure, the module fires three
  100378. * events, point.dragStart, point.drag and point.drop.
  100379. */
  100380. dragDrop?: SeriesDragDropOptionsObject;
  100381. /**
  100382. * (Highcharts, Highstock, Gantt) Enable or disable the mouse tracking for a
  100383. * specific series. This includes point tooltips and click events on graphs
  100384. * and points. For large datasets it improves performance.
  100385. */
  100386. enableMouseTracking?: boolean;
  100387. /**
  100388. * (Highcharts, Highstock, Gantt) General event handlers for the series
  100389. * items. These event hooks can also be attached to the series at run time
  100390. * using the `Highcharts.addEvent` function.
  100391. */
  100392. events?: SeriesEventsOptionsObject;
  100393. /**
  100394. * (Highcharts, Highstock, Gantt) Whether to group non-stacked columns or to
  100395. * let them render independent of each other. Non-grouped columns will be
  100396. * laid out individually and overlap each other.
  100397. */
  100398. grouping?: boolean;
  100399. /**
  100400. * (Highcharts, Highstock, Gantt) Padding between each value groups, in x
  100401. * axis units.
  100402. */
  100403. groupPadding?: number;
  100404. /**
  100405. * (Highcharts) The spacing between columns on the Z Axis in a 3D chart.
  100406. */
  100407. groupZPadding?: number;
  100408. /**
  100409. * (Highcharts, Highstock, Gantt) When set to `false` will prevent the
  100410. * series data from being included in any form of data export.
  100411. *
  100412. * Since version 6.0.0 until 7.1.0 the option was existing undocumented as
  100413. * `includeInCSVExport`.
  100414. */
  100415. includeInDataExport?: boolean;
  100416. /**
  100417. * (Highmaps) What property to join the `mapData` to the value data. For
  100418. * example, if joinBy is "code", the mapData items with a specific code is
  100419. * merged into the data with the same code. For maps loaded from GeoJSON,
  100420. * the keys may be held in each point's `properties` object.
  100421. *
  100422. * The joinBy option can also be an array of two values, where the first
  100423. * points to a key in the `mapData`, and the second points to another key in
  100424. * the `data`.
  100425. *
  100426. * When joinBy is `null`, the map items are joined by their position in the
  100427. * array, which performs much better in maps with many data points. This is
  100428. * the recommended option if you are printing more than a thousand data
  100429. * points and have a backend that can preprocess the data into a parallel
  100430. * array of the mapData.
  100431. */
  100432. joinBy?: (string|Array<string>);
  100433. /**
  100434. * (Highcharts, Highstock, Gantt) An array specifying which option maps to
  100435. * which key in the data point array. This makes it convenient to work with
  100436. * unstructured data arrays from different sources.
  100437. */
  100438. keys?: Array<string>;
  100439. /**
  100440. * (Highcharts, Highstock, Gantt) Series labels are placed as close to the
  100441. * series as possible in a natural way, seeking to avoid other series. The
  100442. * goal of this feature is to make the chart more easily readable, like if a
  100443. * human designer placed the labels in the optimal position.
  100444. *
  100445. * The series labels currently work with series types having a `graph` or an
  100446. * `area`.
  100447. */
  100448. label?: SeriesLabelOptionsObject;
  100449. /**
  100450. * (Highstock) The line marks the last price from all points.
  100451. */
  100452. lastPrice?: SeriesLastPriceOptionsObject;
  100453. /**
  100454. * (Highstock) The line marks the last price from visible range of points.
  100455. */
  100456. lastVisiblePrice?: SeriesLastVisiblePriceOptionsObject;
  100457. /**
  100458. * (Highcharts, Highstock, Gantt) The id of another series to link to.
  100459. * Additionally, the value can be ":previous" to link to the previous
  100460. * series. When two series are linked, only the first one appears in the
  100461. * legend. Toggling the visibility of this also toggles the linked series.
  100462. *
  100463. * If master series uses data sorting and linked series does not have its
  100464. * own sorting definition, the linked series will be sorted in the same
  100465. * order as the master one.
  100466. */
  100467. linkedTo?: string;
  100468. /**
  100469. * (Highcharts, Highstock, Gantt) The maximum allowed pixel width for a
  100470. * column, translated to the height of a bar in a bar chart. This prevents
  100471. * the columns from becoming too wide when there is a small number of points
  100472. * in the chart.
  100473. */
  100474. maxPointWidth?: number;
  100475. /**
  100476. * (Highcharts, Highstock, Gantt) The minimal height for a column or width
  100477. * for a bar. By default, 0 values are not shown. To visualize a 0 (or close
  100478. * to zero) point, set the minimal point length to a pixel value like 3\. In
  100479. * stacked column charts, minPointLength might not be respected for tightly
  100480. * packed values.
  100481. */
  100482. minPointLength?: number;
  100483. /**
  100484. * (Highstock) Options for the corresponding navigator series if
  100485. * `showInNavigator` is `true` for this series. Available options are the
  100486. * same as any series, documented at plotOptions and series.
  100487. *
  100488. * These options are merged with options in navigator.series, and will take
  100489. * precedence if the same option is defined both places.
  100490. */
  100491. navigatorOptions?: PlotSeriesOptions;
  100492. /**
  100493. * (Highcharts, Highstock, Gantt) Opacity of a series parts: line, fill
  100494. * (e.g. area) and dataLabels.
  100495. */
  100496. opacity?: number;
  100497. /**
  100498. * (Highcharts, Highstock, Gantt) A partial fill for each point, typically
  100499. * used to visualize how much of a task is performed. The partial fill
  100500. * object can be set either on series or point level.
  100501. */
  100502. partialFill?: PlotXrangePartialFillOptions;
  100503. /**
  100504. * (Highcharts, Highstock, Gantt) Properties for each single point.
  100505. */
  100506. point?: PlotSeriesPointOptions;
  100507. /**
  100508. * (Highcharts, Highstock, Gantt) Same as
  100509. * accessibility.pointDescriptionFormatter, but for an individual series.
  100510. * Overrides the chart wide configuration.
  100511. */
  100512. pointDescriptionFormatter?: Function;
  100513. /**
  100514. * (Highcharts, Highstock, Gantt) Padding between each column or bar, in x
  100515. * axis units.
  100516. */
  100517. pointPadding?: number;
  100518. pointRange?: number;
  100519. /**
  100520. * (Highcharts, Highstock, Gantt) A pixel value specifying a fixed width for
  100521. * each column or bar point. When set to `undefined`, the width is
  100522. * calculated from the `pointPadding` and `groupPadding`. The width effects
  100523. * the dimension that is not based on the point value. For column series it
  100524. * is the hoizontal length and for bar series it is the vertical length.
  100525. */
  100526. pointWidth?: number;
  100527. /**
  100528. * (Highcharts, Highstock, Gantt) Whether to select the series initially. If
  100529. * `showCheckbox` is true, the checkbox next to the series name in the
  100530. * legend will be checked for a selected series.
  100531. */
  100532. selected?: boolean;
  100533. /**
  100534. * (Highcharts, Highstock, Gantt) Whether to apply a drop shadow to the
  100535. * graph line. Since 2.3 the shadow can be an object configuration
  100536. * containing `color`, `offsetX`, `offsetY`, `opacity` and `width`.
  100537. */
  100538. shadow?: (boolean|ShadowOptionsObject);
  100539. /**
  100540. * (Highcharts, Highstock, Gantt) If true, a checkbox is displayed next to
  100541. * the legend item to allow selecting the series. The state of the checkbox
  100542. * is determined by the `selected` option.
  100543. */
  100544. showCheckbox?: boolean;
  100545. /**
  100546. * (Highcharts, Highstock, Gantt) Whether to display this particular series
  100547. * or series type in the legend. Standalone series are shown in legend by
  100548. * default, and linked series are not. Since v7.2.0 it is possible to show
  100549. * series that use colorAxis by setting this option to `true`.
  100550. */
  100551. showInLegend?: boolean;
  100552. /**
  100553. * (Highstock) Whether or not to show the series in the navigator. Takes
  100554. * precedence over navigator.baseSeries if defined.
  100555. */
  100556. showInNavigator?: boolean;
  100557. /**
  100558. * (Highcharts, Highstock, Gantt) If set to `true`, the accessibility module
  100559. * will skip past the points in this series for keyboard navigation.
  100560. */
  100561. skipKeyboardNavigation?: boolean;
  100562. states?: SeriesStatesOptionsObject;
  100563. /**
  100564. * (Highcharts, Highstock, Gantt) Sticky tracking of mouse events. When
  100565. * true, the `mouseOut` event on a series isn't triggered until the mouse
  100566. * moves over another series, or out of the plot area. When false, the
  100567. * `mouseOut` event on a series is triggered when the mouse leaves the area
  100568. * around the series' graph or markers. This also implies the tooltip when
  100569. * not shared. When `stickyTracking` is false and `tooltip.shared` is false,
  100570. * the tooltip will be hidden when moving the mouse between series. Defaults
  100571. * to true for line and area type series, but to false for columns, pies
  100572. * etc.
  100573. *
  100574. * **Note:** The boost module will force this option because of technical
  100575. * limitations.
  100576. */
  100577. stickyTracking?: boolean;
  100578. /**
  100579. * (Highcharts, Highstock, Gantt) A configuration object for the tooltip
  100580. * rendering of each single series. Properties are inherited from tooltip,
  100581. * but only the following properties can be defined on a series level.
  100582. */
  100583. tooltip?: SeriesTooltipOptionsObject;
  100584. /**
  100585. * (Highcharts, Highstock, Gantt) When a series contains a data array that
  100586. * is longer than this, only one dimensional arrays of numbers, or two
  100587. * dimensional arrays with x and y values are allowed. Also, only the first
  100588. * point is tested, and the rest are assumed to be the same format. This
  100589. * saves expensive data checking and indexing in long series. Set it to `0`
  100590. * disable.
  100591. *
  100592. * Note: In boost mode turbo threshold is forced. Only array of numbers or
  100593. * two dimensional arrays are allowed.
  100594. */
  100595. turboThreshold?: number;
  100596. /**
  100597. * (Highcharts, Highstock, Gantt) Set the initial visibility of the series.
  100598. */
  100599. visible?: boolean;
  100600. /**
  100601. * (Highmaps) Define the z index of the series.
  100602. */
  100603. zIndex?: number;
  100604. /**
  100605. * (Highcharts, Highstock) Defines the Axis on which the zones are applied.
  100606. */
  100607. zoneAxis?: string;
  100608. /**
  100609. * (Highcharts, Highstock) An array defining zones within a series. Zones
  100610. * can be applied to the X axis, Y axis or Z axis for bubbles, according to
  100611. * the `zoneAxis` option. The zone definitions have to be in ascending order
  100612. * regarding to the value.
  100613. *
  100614. * In styled mode, the color zones are styled with the
  100615. * `.highcharts-zone-{n}` class, or custom classed from the `className`
  100616. * option (view live demo).
  100617. */
  100618. zones?: Array<SeriesZonesOptionsObject>;
  100619. }
  100620. /**
  100621. * (Highcharts, Highstock, Gantt) A partial fill for each point, typically used
  100622. * to visualize how much of a task is performed. The partial fill object can be
  100623. * set either on series or point level.
  100624. */
  100625. export interface PlotXrangePartialFillOptions {
  100626. /**
  100627. * (Highcharts, Highstock, Gantt) The fill color to be used for partial
  100628. * fills. Defaults to a darker shade of the point color.
  100629. */
  100630. fill?: (ColorString|GradientColorObject|PatternObject);
  100631. }
  100632. /**
  100633. * (Highstock) Enable or disable the initial animation when a series is
  100634. * displayed. The animation can also be set as a configuration object. Please
  100635. * note that this option only applies to the initial animation of the series
  100636. * itself. For other animations, see chart.animation and the animation parameter
  100637. * under the API methods. The following properties are supported:
  100638. *
  100639. * - `defer`: The animation delay time in milliseconds.
  100640. *
  100641. * - `duration`: The duration of the animation in milliseconds.
  100642. *
  100643. * - `easing`: Can be a string reference to an easing function set on the `Math`
  100644. * object or a function. See the _Custom easing function_ demo below.
  100645. *
  100646. * Due to poor performance, animation is disabled in old IE browsers for several
  100647. * chart types.
  100648. */
  100649. export interface PlotZigzagAnimationOptions {
  100650. defer?: number;
  100651. }
  100652. /**
  100653. * (Highcharts, Highstock, Highmaps, Gantt) Enable or disable the initial
  100654. * animation when a series is displayed for the `dataLabels`. The animation can
  100655. * also be set as a configuration object. Please note that this option only
  100656. * applies to the initial animation. For other animations, see chart.animation
  100657. * and the animation parameter under the API methods. The following properties
  100658. * are supported:
  100659. *
  100660. * - `defer`: The animation delay time in milliseconds.
  100661. */
  100662. export interface PlotZigzagDataLabelsAnimationOptions {
  100663. /**
  100664. * (Highcharts, Highstock, Highmaps, Gantt) The animation delay time in
  100665. * milliseconds. Set to `0` renders dataLabel immediately. As `undefined`
  100666. * inherits defer time from the series.animation.defer.
  100667. */
  100668. defer?: number;
  100669. }
  100670. /**
  100671. * (Highcharts, Highstock, Highmaps, Gantt) Options for the series data labels,
  100672. * appearing next to each data point.
  100673. *
  100674. * Since v6.2.0, multiple data labels can be applied to each single point by
  100675. * defining them as an array of configs.
  100676. *
  100677. * In styled mode, the data labels can be styled with the
  100678. * `.highcharts-data-label-box` and `.highcharts-data-label` class names (see
  100679. * example).
  100680. */
  100681. export interface PlotZigzagDataLabelsOptions {
  100682. /**
  100683. * (Highcharts, Highstock, Highmaps, Gantt) The alignment of the data label
  100684. * compared to the point. If `right`, the right side of the label should be
  100685. * touching the point. For points with an extent, like columns, the
  100686. * alignments also dictates how to align it inside the box, as given with
  100687. * the inside option. Can be one of `left`, `center` or `right`.
  100688. */
  100689. align?: (AlignValue|null);
  100690. /**
  100691. * (Highcharts, Highstock, Highmaps, Gantt) Whether to allow data labels to
  100692. * overlap. To make the labels less sensitive for overlapping, the
  100693. * dataLabels.padding can be set to 0.
  100694. */
  100695. allowOverlap?: boolean;
  100696. /**
  100697. * (Highcharts, Highstock, Highmaps, Gantt) Enable or disable the initial
  100698. * animation when a series is displayed for the `dataLabels`. The animation
  100699. * can also be set as a configuration object. Please note that this option
  100700. * only applies to the initial animation. For other animations, see
  100701. * chart.animation and the animation parameter under the API methods. The
  100702. * following properties are supported:
  100703. *
  100704. * - `defer`: The animation delay time in milliseconds.
  100705. */
  100706. animation?: (boolean|PlotZigzagDataLabelsAnimationOptions|Partial<AnimationOptionsObject>);
  100707. /**
  100708. * (Highcharts, Highstock, Highmaps, Gantt) The background color or gradient
  100709. * for the data label.
  100710. */
  100711. backgroundColor?: (ColorString|GradientColorObject|PatternObject);
  100712. /**
  100713. * (Highcharts, Highstock, Highmaps, Gantt) The border color for the data
  100714. * label. Defaults to `undefined`.
  100715. */
  100716. borderColor?: (ColorString|GradientColorObject|PatternObject);
  100717. /**
  100718. * (Highcharts, Highstock, Highmaps, Gantt) The border radius in pixels for
  100719. * the data label.
  100720. */
  100721. borderRadius?: number;
  100722. /**
  100723. * (Highcharts, Highstock, Highmaps, Gantt) The border width in pixels for
  100724. * the data label.
  100725. */
  100726. borderWidth?: number;
  100727. /**
  100728. * (Highcharts, Highstock, Highmaps, Gantt) A class name for the data label.
  100729. * Particularly in styled mode, this can be used to give each series' or
  100730. * point's data label unique styling. In addition to this option, a default
  100731. * color class name is added so that we can give the labels a contrast text
  100732. * shadow.
  100733. */
  100734. className?: string;
  100735. /**
  100736. * (Highcharts, Highstock, Highmaps, Gantt) The text color for the data
  100737. * labels. Defaults to `undefined`. For certain series types, like column or
  100738. * map, the data labels can be drawn inside the points. In this case the
  100739. * data label will be drawn with maximum contrast by default. Additionally,
  100740. * it will be given a `text-outline` style with the opposite color, to
  100741. * further increase the contrast. This can be overridden by setting the
  100742. * `text-outline` style to `none` in the `dataLabels.style` option.
  100743. */
  100744. color?: (ColorString|GradientColorObject|PatternObject);
  100745. /**
  100746. * (Highcharts, Highstock, Highmaps, Gantt) Whether to hide data labels that
  100747. * are outside the plot area. By default, the data label is moved inside the
  100748. * plot area according to the overflow option.
  100749. */
  100750. crop?: boolean;
  100751. /**
  100752. * (Highcharts, Highstock, Gantt) Whether to defer displaying the data
  100753. * labels until the initial series animation has finished. Setting to
  100754. * `false` renders the data label immediately. If set to `true` inherits the
  100755. * defer time set in plotOptions.series.animation.
  100756. */
  100757. defer?: boolean;
  100758. /**
  100759. * (Highcharts, Highstock, Highmaps, Gantt) Enable or disable the data
  100760. * labels.
  100761. */
  100762. enabled?: boolean;
  100763. /**
  100764. * (Highcharts, Highstock, Highmaps, Gantt) A declarative filter to control
  100765. * of which data labels to display. The declarative filter is designed for
  100766. * use when callback functions are not available, like when the chart
  100767. * options require a pure JSON structure or for use with graphical editors.
  100768. * For programmatic control, use the `formatter` instead, and return
  100769. * `undefined` to disable a single data label.
  100770. */
  100771. filter?: DataLabelsFilterOptionsObject;
  100772. /**
  100773. * (Highcharts, Highstock, Highmaps, Gantt) A format string for the data
  100774. * label. Available variables are the same as for `formatter`.
  100775. */
  100776. format?: string;
  100777. /**
  100778. * (Highcharts, Highstock, Highmaps, Gantt) Callback JavaScript function to
  100779. * format the data label. Note that if a `format` is defined, the format
  100780. * takes precedence and the formatter is ignored.
  100781. */
  100782. formatter?: DataLabelsFormatterCallbackFunction;
  100783. /**
  100784. * (Highcharts, Highstock, Highmaps, Gantt) For points with an extent, like
  100785. * columns or map areas, whether to align the data label inside the box or
  100786. * to the actual value point. Defaults to `false` in most cases, `true` in
  100787. * stacked columns.
  100788. */
  100789. inside?: boolean;
  100790. /**
  100791. * (Highcharts, Highstock, Highmaps, Gantt) Format for points with the value
  100792. * of null. Works analogously to format. `nullFormat` can be applied only to
  100793. * series which support displaying null points.
  100794. */
  100795. nullFormat?: (boolean|string);
  100796. /**
  100797. * (Highcharts, Highstock, Highmaps, Gantt) Callback JavaScript function
  100798. * that defines formatting for points with the value of null. Works
  100799. * analogously to formatter. `nullPointFormatter` can be applied only to
  100800. * series which support displaying null points.
  100801. */
  100802. nullFormatter?: DataLabelsFormatterCallbackFunction;
  100803. /**
  100804. * (Highcharts, Highstock, Highmaps, Gantt) How to handle data labels that
  100805. * flow outside the plot area. The default is `"justify"`, which aligns them
  100806. * inside the plot area. For columns and bars, this means it will be moved
  100807. * inside the bar. To display data labels outside the plot area, set `crop`
  100808. * to `false` and `overflow` to `"allow"`.
  100809. */
  100810. overflow?: DataLabelsOverflowValue;
  100811. /**
  100812. * (Highcharts, Highstock, Highmaps, Gantt) When either the `borderWidth` or
  100813. * the `backgroundColor` is set, this is the padding within the box.
  100814. */
  100815. padding?: number;
  100816. /**
  100817. * (Highcharts, Highstock, Highmaps, Gantt) Aligns data labels relative to
  100818. * points. If `center` alignment is not possible, it defaults to `right`.
  100819. */
  100820. position?: AlignValue;
  100821. /**
  100822. * (Highcharts, Highstock, Highmaps, Gantt) Text rotation in degrees. Note
  100823. * that due to a more complex structure, backgrounds, borders and padding
  100824. * will be lost on a rotated data label.
  100825. */
  100826. rotation?: number;
  100827. /**
  100828. * (Highcharts, Highstock, Highmaps, Gantt) The shadow of the box. Works
  100829. * best with `borderWidth` or `backgroundColor`. Since 2.3 the shadow can be
  100830. * an object configuration containing `color`, `offsetX`, `offsetY`,
  100831. * `opacity` and `width`.
  100832. */
  100833. shadow?: (boolean|ShadowOptionsObject);
  100834. /**
  100835. * (Highcharts, Highstock, Highmaps, Gantt) The name of a symbol to use for
  100836. * the border around the label. Symbols are predefined functions on the
  100837. * Renderer object.
  100838. */
  100839. shape?: string;
  100840. /**
  100841. * (Highcharts, Highstock, Highmaps, Gantt) Styles for the label. The
  100842. * default `color` setting is `"contrast"`, which is a pseudo color that
  100843. * Highcharts picks up and applies the maximum contrast to the underlying
  100844. * point item, for example the bar in a bar chart.
  100845. *
  100846. * The `textOutline` is a pseudo property that applies an outline of the
  100847. * given width with the given color, which by default is the maximum
  100848. * contrast to the text. So a bright text color will result in a black text
  100849. * outline for maximum readability on a mixed background. In some cases,
  100850. * especially with grayscale text, the text outline doesn't work well, in
  100851. * which cases it can be disabled by setting it to `"none"`. When `useHTML`
  100852. * is true, the `textOutline` will not be picked up. In this, case, the same
  100853. * effect can be acheived through the `text-shadow` CSS property.
  100854. *
  100855. * For some series types, where each point has an extent, like for example
  100856. * tree maps, the data label may overflow the point. There are two
  100857. * strategies for handling overflow. By default, the text will wrap to
  100858. * multiple lines. The other strategy is to set `style.textOverflow` to
  100859. * `ellipsis`, which will keep the text on one line plus it will break
  100860. * inside long words.
  100861. */
  100862. style?: CSSObject;
  100863. /**
  100864. * (Highcharts, Highstock, Highmaps, Gantt) Options for a label text which
  100865. * should follow marker's shape. Border and background are disabled for a
  100866. * label that follows a path.
  100867. *
  100868. * **Note:** Only SVG-based renderer supports this option. Setting `useHTML`
  100869. * to true will disable this option.
  100870. */
  100871. textPath?: DataLabelsTextPathOptionsObject;
  100872. /**
  100873. * (Highcharts, Highstock, Highmaps, Gantt) Whether to use HTML to render
  100874. * the labels.
  100875. */
  100876. useHTML?: boolean;
  100877. /**
  100878. * (Highcharts, Highstock, Highmaps, Gantt) The vertical alignment of a data
  100879. * label. Can be one of `top`, `middle` or `bottom`. The default value
  100880. * depends on the data, for instance in a column chart, the label is above
  100881. * positive values and below negative values.
  100882. */
  100883. verticalAlign?: (VerticalAlignValue|null);
  100884. /**
  100885. * (Highcharts, Highstock, Highmaps, Gantt) The x position offset of the
  100886. * label relative to the point in pixels.
  100887. */
  100888. x?: number;
  100889. /**
  100890. * (Highcharts, Highstock, Highmaps, Gantt) The y position offset of the
  100891. * label relative to the point in pixels.
  100892. */
  100893. y?: number;
  100894. /**
  100895. * (Highcharts, Highstock, Highmaps, Gantt) The Z index of the data labels.
  100896. * The default Z index puts it above the series. Use a Z index of 2 to
  100897. * display it behind the series.
  100898. */
  100899. z?: number;
  100900. }
  100901. /**
  100902. * (Highcharts, Highstock) Options for the series data sorting.
  100903. */
  100904. export interface PlotZigzagDataSortingOptions {
  100905. /**
  100906. * (Highcharts, Highstock) Enable or disable data sorting for the series.
  100907. * Use xAxis.reversed to change the sorting order.
  100908. */
  100909. enabled?: boolean;
  100910. /**
  100911. * (Highcharts, Highstock) Whether to allow matching points by name in an
  100912. * update. If this option is disabled, points will be matched by order.
  100913. */
  100914. matchByName?: boolean;
  100915. /**
  100916. * (Highcharts, Highstock) Determines what data value should be used to sort
  100917. * by.
  100918. */
  100919. sortKey?: string;
  100920. }
  100921. /**
  100922. * (Highstock) Zig Zag indicator.
  100923. *
  100924. * This series requires `linkedTo` option to be set.
  100925. *
  100926. * In TypeScript the type option must always be set.
  100927. *
  100928. * Configuration options for the series are given in three levels:
  100929. *
  100930. * 1. Options for all series in a chart are defined in the plotOptions.series
  100931. * object.
  100932. *
  100933. * 2. Options for all `zigzag` series are defined in plotOptions.zigzag.
  100934. *
  100935. * 3. Options for one single series are given in the series instance array. (see
  100936. * online documentation for example)
  100937. */
  100938. export interface PlotZigzagOptions {
  100939. /**
  100940. * (Highstock) Accessibility options for a series.
  100941. */
  100942. accessibility?: SeriesAccessibilityOptionsObject;
  100943. /**
  100944. * (Highstock) Allow this series' points to be selected by clicking on the
  100945. * graphic (columns, point markers, pie slices, map areas etc).
  100946. *
  100947. * The selected points can be handled by point select and unselect events,
  100948. * or collectively by the getSelectedPoints function.
  100949. *
  100950. * And alternative way of selecting points is through dragging.
  100951. */
  100952. allowPointSelect?: boolean;
  100953. /**
  100954. * (Highstock) Enable or disable the initial animation when a series is
  100955. * displayed. The animation can also be set as a configuration object.
  100956. * Please note that this option only applies to the initial animation of the
  100957. * series itself. For other animations, see chart.animation and the
  100958. * animation parameter under the API methods. The following properties are
  100959. * supported:
  100960. *
  100961. * - `defer`: The animation delay time in milliseconds.
  100962. *
  100963. * - `duration`: The duration of the animation in milliseconds.
  100964. *
  100965. * - `easing`: Can be a string reference to an easing function set on the
  100966. * `Math` object or a function. See the _Custom easing function_ demo below.
  100967. *
  100968. * Due to poor performance, animation is disabled in old IE browsers for
  100969. * several chart types.
  100970. */
  100971. animation?: (boolean|PlotZigzagAnimationOptions|Partial<AnimationOptionsObject>);
  100972. /**
  100973. * (Highstock) For some series, there is a limit that shuts down initial
  100974. * animation by default when the total number of points in the chart is too
  100975. * high. For example, for a column chart and its derivatives, animation does
  100976. * not run if there is more than 250 points totally. To disable this cap,
  100977. * set `animationLimit` to `Infinity`.
  100978. */
  100979. animationLimit?: number;
  100980. /**
  100981. * (Highstock) Sets the color blending in the boost module.
  100982. */
  100983. boostBlending?: OptionsBoostBlendingValue;
  100984. /**
  100985. * (Highstock) Set the point threshold for when a series should enter boost
  100986. * mode.
  100987. *
  100988. * Setting it to e.g. 2000 will cause the series to enter boost mode when
  100989. * there are 2000 or more points in the series.
  100990. *
  100991. * To disable boosting on the series, set the `boostThreshold` to 0. Setting
  100992. * it to 1 will force boosting.
  100993. *
  100994. * Note that the cropThreshold also affects this setting. When zooming in on
  100995. * a series that has fewer points than the `cropThreshold`, all points are
  100996. * rendered although outside the visible plot area, and the `boostThreshold`
  100997. * won't take effect.
  100998. */
  100999. boostThreshold?: number;
  101000. /**
  101001. * (Highmaps) The border color of the map areas.
  101002. *
  101003. * In styled mode, the border stroke is given in the `.highcharts-point`
  101004. * class.
  101005. */
  101006. borderColor?: (ColorString|GradientColorObject|PatternObject);
  101007. /**
  101008. * (Highmaps) The border width of each map area.
  101009. *
  101010. * In styled mode, the border stroke width is given in the
  101011. * `.highcharts-point` class.
  101012. */
  101013. borderWidth?: number;
  101014. /**
  101015. * (Highstock) An additional class name to apply to the series' graphical
  101016. * elements. This option does not replace default class names of the
  101017. * graphical element.
  101018. */
  101019. className?: string;
  101020. /**
  101021. * (Highstock) Disable this option to allow series rendering in the whole
  101022. * plotting area.
  101023. *
  101024. * **Note:** Clipping should be always enabled when chart.zoomType is set
  101025. */
  101026. clip?: boolean;
  101027. /**
  101028. * (Highstock) The main color of the series. In line type series it applies
  101029. * to the line and the point markers unless otherwise specified. In bar type
  101030. * series it applies to the bars unless a color is specified per point. The
  101031. * default value is pulled from the `options.colors` array.
  101032. *
  101033. * In styled mode, the color can be defined by the colorIndex option. Also,
  101034. * the series color can be set with the `.highcharts-series`,
  101035. * `.highcharts-color-{n}`, `.highcharts-{type}-series` or
  101036. * `.highcharts-series-{n}` class, or individual classes given by the
  101037. * `className` option.
  101038. */
  101039. color?: (ColorString|GradientColorObject|PatternObject);
  101040. /**
  101041. * (Highstock) Styled mode only. A specific color index to use for the
  101042. * series, so its graphic representations are given the class name
  101043. * `highcharts-color-{n}`.
  101044. */
  101045. colorIndex?: number;
  101046. /**
  101047. * (Highcharts, Highstock, Highmaps) Determines what data value should be
  101048. * used to calculate point color if `colorAxis` is used. Requires to set
  101049. * `min` and `max` if some custom point property is used or if approximation
  101050. * for data grouping is set to `'sum'`.
  101051. */
  101052. colorKey?: string;
  101053. /**
  101054. * (Highstock) Compare the values of the series against the first non-null,
  101055. * non- zero value in the visible range. The y axis will show percentage or
  101056. * absolute change depending on whether `compare` is set to `"percent"` or
  101057. * `"value"`. When this is applied to multiple series, it allows comparing
  101058. * the development of the series against each other. Adds a `change` field
  101059. * to every point object.
  101060. */
  101061. compare?: string;
  101062. /**
  101063. * (Highstock) When compare is `percent`, this option dictates whether to
  101064. * use 0 or 100 as the base of comparison.
  101065. */
  101066. compareBase?: (0|100);
  101067. /**
  101068. * (Highstock) Defines if comparison should start from the first point
  101069. * within the visible range or should start from the first point **before**
  101070. * the range.
  101071. *
  101072. * In other words, this flag determines if first point within the visible
  101073. * range will have 0% (`compareStart=true`) or should have been already
  101074. * calculated according to the previous point (`compareStart=false`).
  101075. */
  101076. compareStart?: boolean;
  101077. /**
  101078. * (Highstock) Whether to compare indicator to the main series values or
  101079. * indicator values.
  101080. */
  101081. compareToMain?: boolean;
  101082. /**
  101083. * (Highcharts) Polar charts only. Whether to connect the ends of a line
  101084. * series plot across the extremes.
  101085. */
  101086. connectEnds?: boolean;
  101087. /**
  101088. * (Highcharts, Highstock) Whether to connect a graph line across null
  101089. * points, or render a gap between the two points on either side of the
  101090. * null.
  101091. */
  101092. connectNulls?: boolean;
  101093. /**
  101094. * (Gantt) Override Pathfinder connector options for a series. Requires
  101095. * Highcharts Gantt to be loaded.
  101096. */
  101097. connectors?: SeriesConnectorsOptionsObject;
  101098. /**
  101099. * (Highcharts, Highstock, Gantt) When true, each point or column edge is
  101100. * rounded to its nearest pixel in order to render sharp on screen. In some
  101101. * cases, when there are a lot of densely packed columns, this leads to
  101102. * visible difference in column widths or distance between columns. In these
  101103. * cases, setting `crisp` to `false` may look better, even though each
  101104. * column is rendered blurry.
  101105. */
  101106. crisp?: boolean;
  101107. /**
  101108. * (Highcharts, Highstock) When the series contains less points than the
  101109. * crop threshold, all points are drawn, even if the points fall outside the
  101110. * visible plot area at the current zoom. The advantage of drawing all
  101111. * points (including markers and columns), is that animation is performed on
  101112. * updates. On the other hand, when the series contains more points than the
  101113. * crop threshold, the series data is cropped to only contain points that
  101114. * fall within the plot area. The advantage of cropping away invisible
  101115. * points is to increase performance on large series.
  101116. */
  101117. cropThreshold?: number;
  101118. /**
  101119. * (Highstock) You can set the cursor to "pointer" if you have click events
  101120. * attached to the series, to signal to the user that the points and lines
  101121. * can be clicked.
  101122. *
  101123. * In styled mode, the series cursor can be set with the same classes as
  101124. * listed under series.color.
  101125. */
  101126. cursor?: (string|CursorValue);
  101127. /**
  101128. * (Highstock) A reserved subspace to store options and values for
  101129. * customized functionality. Here you can add additional data for your own
  101130. * event callbacks and formatter callbacks.
  101131. */
  101132. custom?: Dictionary<any>;
  101133. /**
  101134. * (Highstock) Name of the dash style to use for the graph, or for some
  101135. * series types the outline of each shape.
  101136. *
  101137. * In styled mode, the stroke dash-array can be set with the same classes as
  101138. * listed under series.color.
  101139. */
  101140. dashStyle?: DashStyleValue;
  101141. /**
  101142. * (Highstock) Data grouping is the concept of sampling the data values into
  101143. * larger blocks in order to ease readability and increase performance of
  101144. * the JavaScript charts. Highstock by default applies data grouping when
  101145. * the points become closer than a certain pixel value, determined by the
  101146. * `groupPixelWidth` option.
  101147. *
  101148. * If data grouping is applied, the grouping information of grouped points
  101149. * can be read from the Point.dataGroup. If point options other than the
  101150. * data itself are set, for example `name` or `color` or custom properties,
  101151. * the grouping logic doesn't know how to group it. In this case the options
  101152. * of the first point instance are copied over to the group point. This can
  101153. * be altered through a custom `approximation` callback function.
  101154. */
  101155. dataGrouping?: DataGroupingOptionsObject;
  101156. /**
  101157. * (Highcharts, Highstock, Highmaps, Gantt) Options for the series data
  101158. * labels, appearing next to each data point.
  101159. *
  101160. * Since v6.2.0, multiple data labels can be applied to each single point by
  101161. * defining them as an array of configs.
  101162. *
  101163. * In styled mode, the data labels can be styled with the
  101164. * `.highcharts-data-label-box` and `.highcharts-data-label` class names
  101165. * (see example).
  101166. */
  101167. dataLabels?: (PlotZigzagDataLabelsOptions|Array<PlotZigzagDataLabelsOptions>);
  101168. /**
  101169. * (Highcharts, Highstock) Options for the series data sorting.
  101170. */
  101171. dataSorting?: (DataSortingOptionsObject|PlotZigzagDataSortingOptions);
  101172. /**
  101173. * (Highstock) A description of the series to add to the screen reader
  101174. * information about the series.
  101175. */
  101176. description?: string;
  101177. /**
  101178. * (Highstock) Enable or disable the mouse tracking for a specific series.
  101179. * This includes point tooltips and click events on graphs and points. For
  101180. * large datasets it improves performance.
  101181. */
  101182. enableMouseTracking?: boolean;
  101183. /**
  101184. * (Highstock) General event handlers for the series items. These event
  101185. * hooks can also be attached to the series at run time using the
  101186. * `Highcharts.addEvent` function.
  101187. */
  101188. events?: SeriesEventsOptionsObject;
  101189. /**
  101190. * (Highstock) Determines whether the series should look for the nearest
  101191. * point in both dimensions or just the x-dimension when hovering the
  101192. * series. Defaults to `'xy'` for scatter series and `'x'` for most other
  101193. * series. If the data has duplicate x-values, it is recommended to set this
  101194. * to `'xy'` to allow hovering over all points.
  101195. *
  101196. * Applies only to series types using nearest neighbor search (not direct
  101197. * hover) for tooltip.
  101198. */
  101199. findNearestPointBy?: OptionsFindNearestPointByValue;
  101200. /**
  101201. * (Highstock) Defines when to display a gap in the graph, together with the
  101202. * gapUnit option.
  101203. *
  101204. * In case when `dataGrouping` is enabled, points can be grouped into a
  101205. * larger time span. This can make the grouped points to have a greater
  101206. * distance than the absolute value of `gapSize` property, which will result
  101207. * in disappearing graph completely. To prevent this situation the mentioned
  101208. * distance between grouped points is used instead of previously defined
  101209. * `gapSize`.
  101210. *
  101211. * In practice, this option is most often used to visualize gaps in time
  101212. * series. In a stock chart, intraday data is available for daytime hours,
  101213. * while gaps will appear in nights and weekends.
  101214. */
  101215. gapSize?: number;
  101216. /**
  101217. * (Highstock) Together with gapSize, this option defines where to draw gaps
  101218. * in the graph.
  101219. *
  101220. * When the `gapUnit` is `"relative"` (default), a gap size of 5 means that
  101221. * if the distance between two points is greater than 5 times that of the
  101222. * two closest points, the graph will be broken.
  101223. *
  101224. * When the `gapUnit` is `"value"`, the gap is based on absolute axis
  101225. * values, which on a datetime axis is milliseconds. This also applies to
  101226. * the navigator series that inherits gap options from the base series.
  101227. */
  101228. gapUnit?: OptionsGapUnitValue;
  101229. /**
  101230. * (Highcharts, Highstock, Gantt) Whether to use the Y extremes of the total
  101231. * chart width or only the zoomed area when zooming in on parts of the X
  101232. * axis. By default, the Y axis adjusts to the min and max of the visible
  101233. * data. Cartesian series only.
  101234. */
  101235. getExtremesFromAll?: boolean;
  101236. /**
  101237. * (Highstock) When set to `false` will prevent the series data from being
  101238. * included in any form of data export.
  101239. *
  101240. * Since version 6.0.0 until 7.1.0 the option was existing undocumented as
  101241. * `includeInCSVExport`.
  101242. */
  101243. includeInDataExport?: boolean;
  101244. /**
  101245. * (Highcharts, Highstock, Gantt) Series labels are placed as close to the
  101246. * series as possible in a natural way, seeking to avoid other series. The
  101247. * goal of this feature is to make the chart more easily readable, like if a
  101248. * human designer placed the labels in the optimal position.
  101249. *
  101250. * The series labels currently work with series types having a `graph` or an
  101251. * `area`.
  101252. */
  101253. label?: SeriesLabelOptionsObject;
  101254. /**
  101255. * (Highstock) The line marks the last price from all points.
  101256. */
  101257. lastPrice?: SeriesLastPriceOptionsObject;
  101258. /**
  101259. * (Highstock) The line marks the last price from visible range of points.
  101260. */
  101261. lastVisiblePrice?: SeriesLastVisiblePriceOptionsObject;
  101262. /**
  101263. * (Highcharts, Highstock) The SVG value used for the `stroke-linecap` and
  101264. * `stroke-linejoin` of a line graph. Round means that lines are rounded in
  101265. * the ends and bends.
  101266. */
  101267. linecap?: SeriesLinecapValue;
  101268. /**
  101269. * (Highcharts, Highstock) Pixel width of the graph line.
  101270. */
  101271. lineWidth?: number;
  101272. /**
  101273. * (Highcharts, Highstock, Gantt) The main series ID that indicator will be
  101274. * based on. Required for this indicator.
  101275. */
  101276. linkedTo?: string;
  101277. /**
  101278. * (Highstock) Options for the point markers of line-like series. Properties
  101279. * like `fillColor`, `lineColor` and `lineWidth` define the visual
  101280. * appearance of the markers. Other series types, like column series, don't
  101281. * have markers, but have visual options on the series level instead.
  101282. *
  101283. * In styled mode, the markers can be styled with the `.highcharts-point`,
  101284. * `.highcharts-point-hover` and `.highcharts-point-select` class names.
  101285. */
  101286. marker?: PointMarkerOptionsObject;
  101287. /**
  101288. * (Highstock) The name of the series as shown in the legend, tooltip etc.
  101289. * If not set, it will be based on a technical indicator type and default
  101290. * params.
  101291. */
  101292. name?: string;
  101293. /**
  101294. * (Highstock) The color for the parts of the graph or points that are below
  101295. * the threshold. Note that `zones` takes precedence over the negative
  101296. * color. Using `negativeColor` is equivalent to applying a zone with value
  101297. * of 0.
  101298. */
  101299. negativeColor?: (ColorString|GradientColorObject|PatternObject);
  101300. /**
  101301. * (Highstock) Opacity of a series parts: line, fill (e.g. area) and
  101302. * dataLabels.
  101303. */
  101304. opacity?: number;
  101305. /**
  101306. * (Highstock) Paramters used in calculation of regression series' points.
  101307. */
  101308. params?: PlotZigzagParamsOptions;
  101309. /**
  101310. * (Highstock) Properties for each single point.
  101311. */
  101312. point?: PlotSeriesPointOptions;
  101313. /**
  101314. * (Highstock) Same as accessibility.pointDescriptionFormatter, but for an
  101315. * individual series. Overrides the chart wide configuration.
  101316. */
  101317. pointDescriptionFormatter?: Function;
  101318. /**
  101319. * (Highstock) Whether to select the series initially. If `showCheckbox` is
  101320. * true, the checkbox next to the series name in the legend will be checked
  101321. * for a selected series.
  101322. */
  101323. selected?: boolean;
  101324. /**
  101325. * (Highstock) Whether to apply a drop shadow to the graph line. Since 2.3
  101326. * the shadow can be an object configuration containing `color`, `offsetX`,
  101327. * `offsetY`, `opacity` and `width`.
  101328. */
  101329. shadow?: (boolean|ShadowOptionsObject);
  101330. /**
  101331. * (Highstock) If true, a checkbox is displayed next to the legend item to
  101332. * allow selecting the series. The state of the checkbox is determined by
  101333. * the `selected` option.
  101334. */
  101335. showCheckbox?: boolean;
  101336. /**
  101337. * (Highstock) Whether to display this particular series or series type in
  101338. * the legend. Standalone series are shown in legend by default, and linked
  101339. * series are not. Since v7.2.0 it is possible to show series that use
  101340. * colorAxis by setting this option to `true`.
  101341. */
  101342. showInLegend?: boolean;
  101343. /**
  101344. * (Highstock) If set to `true`, the accessibility module will skip past the
  101345. * points in this series for keyboard navigation.
  101346. */
  101347. skipKeyboardNavigation?: boolean;
  101348. /**
  101349. * (Highcharts, Highstock) When this is true, the series will not cause the
  101350. * Y axis to cross the zero plane (or threshold option) unless the data
  101351. * actually crosses the plane.
  101352. *
  101353. * For example, if `softThreshold` is `false`, a series of 0, 1, 2, 3 will
  101354. * make the Y axis show negative values according to the `minPadding`
  101355. * option. If `softThreshold` is `true`, the Y axis starts at 0.
  101356. */
  101357. softThreshold?: boolean;
  101358. states?: SeriesStatesOptionsObject;
  101359. /**
  101360. * (Highcharts, Highstock) Whether to apply steps to the line. Possible
  101361. * values are `left`, `center` and `right`.
  101362. */
  101363. step?: OptionsStepValue;
  101364. /**
  101365. * (Highstock) Sticky tracking of mouse events. When true, the `mouseOut`
  101366. * event on a series isn't triggered until the mouse moves over another
  101367. * series, or out of the plot area. When false, the `mouseOut` event on a
  101368. * series is triggered when the mouse leaves the area around the series'
  101369. * graph or markers. This also implies the tooltip when not shared. When
  101370. * `stickyTracking` is false and `tooltip.shared` is false, the tooltip will
  101371. * be hidden when moving the mouse between series. Defaults to true for line
  101372. * and area type series, but to false for columns, pies etc.
  101373. *
  101374. * **Note:** The boost module will force this option because of technical
  101375. * limitations.
  101376. */
  101377. stickyTracking?: boolean;
  101378. /**
  101379. * (Highcharts, Highstock) The threshold, also called zero level or base
  101380. * level. For line type series this is only used in conjunction with
  101381. * negativeColor.
  101382. */
  101383. threshold?: (number|null);
  101384. /**
  101385. * (Highstock) A configuration object for the tooltip rendering of each
  101386. * single series. Properties are inherited from tooltip, but only the
  101387. * following properties can be defined on a series level.
  101388. */
  101389. tooltip?: SeriesTooltipOptionsObject;
  101390. /**
  101391. * (Highcharts, Highstock, Gantt) When a series contains a data array that
  101392. * is longer than this, only one dimensional arrays of numbers, or two
  101393. * dimensional arrays with x and y values are allowed. Also, only the first
  101394. * point is tested, and the rest are assumed to be the same format. This
  101395. * saves expensive data checking and indexing in long series. Set it to `0`
  101396. * disable.
  101397. *
  101398. * Note: In boost mode turbo threshold is forced. Only array of numbers or
  101399. * two dimensional arrays are allowed.
  101400. */
  101401. turboThreshold?: number;
  101402. /**
  101403. * (Highstock) Set the initial visibility of the series.
  101404. */
  101405. visible?: boolean;
  101406. /**
  101407. * (Highmaps) Define the z index of the series.
  101408. */
  101409. zIndex?: number;
  101410. /**
  101411. * (Highcharts, Highstock) Defines the Axis on which the zones are applied.
  101412. */
  101413. zoneAxis?: string;
  101414. /**
  101415. * (Highcharts, Highstock) An array defining zones within a series. Zones
  101416. * can be applied to the X axis, Y axis or Z axis for bubbles, according to
  101417. * the `zoneAxis` option. The zone definitions have to be in ascending order
  101418. * regarding to the value.
  101419. *
  101420. * In styled mode, the color zones are styled with the
  101421. * `.highcharts-zone-{n}` class, or custom classed from the `className`
  101422. * option (view live demo).
  101423. */
  101424. zones?: Array<SeriesZonesOptionsObject>;
  101425. }
  101426. /**
  101427. * (Highstock) Paramters used in calculation of regression series' points.
  101428. */
  101429. export interface PlotZigzagParamsOptions {
  101430. /**
  101431. * (Highstock) The threshold for the value change.
  101432. *
  101433. * For example deviation=1 means the indicator will ignore all price
  101434. * movements less than 1%.
  101435. */
  101436. deviation?: number;
  101437. /**
  101438. * (Highstock) The point index which indicator calculations will base - high
  101439. * value.
  101440. *
  101441. * For example using OHLC data, index=1 means the indicator will be
  101442. * calculated using High values.
  101443. */
  101444. highIndex?: number;
  101445. /**
  101446. * (Highstock) The point index which indicator calculations will base - low
  101447. * value.
  101448. *
  101449. * For example using OHLC data, index=2 means the indicator will be
  101450. * calculated using Low values.
  101451. */
  101452. lowIndex?: number;
  101453. }
  101454. /**
  101455. * (Highcharts, Highstock, Gantt) Accessibility options for a data point.
  101456. */
  101457. export interface PointAccessibilityOptionsObject {
  101458. /**
  101459. * (Highcharts, Highstock, Gantt) Provide a description of the data point,
  101460. * announced to screen readers.
  101461. */
  101462. description?: string;
  101463. /**
  101464. * (Highcharts, Highstock, Gantt) Set to false to disable accessibility
  101465. * functionality for a specific point. The point will not be included in
  101466. * keyboard navigation, and will not be exposed to assistive technology.
  101467. */
  101468. enabled?: boolean;
  101469. }
  101470. /**
  101471. * Common information for a click event on a series point.
  101472. */
  101473. export interface PointClickEventObject extends PointerEventObject {
  101474. /**
  101475. * Clicked point.
  101476. */
  101477. point: Point;
  101478. }
  101479. /**
  101480. * Contains information about a points new values.
  101481. */
  101482. export interface PointDragDropObject {
  101483. /**
  101484. * New values.
  101485. */
  101486. newValues: Dictionary<number>;
  101487. /**
  101488. * Updated point.
  101489. */
  101490. point: Point;
  101491. }
  101492. /**
  101493. * Contains common information for a drag event on series points.
  101494. */
  101495. export interface PointDragEventObject {
  101496. /**
  101497. * New points during drag.
  101498. */
  101499. newPoints: Dictionary<PointDragDropObject>;
  101500. /**
  101501. * Original data.
  101502. */
  101503. origin: DragDropPositionObject;
  101504. /**
  101505. * Prevent default drag action.
  101506. */
  101507. preventDefault: Function;
  101508. /**
  101509. * Target point that caused the event.
  101510. */
  101511. target: Point;
  101512. /**
  101513. * Event type.
  101514. */
  101515. type: "drag";
  101516. }
  101517. /**
  101518. * Contains common information for a drag event on series point.
  101519. */
  101520. export interface PointDragStartEventObject extends MouseEvent {
  101521. /**
  101522. * Data property being dragged.
  101523. */
  101524. updateProp?: string;
  101525. }
  101526. /**
  101527. * Contains common information for a drop event on series points.
  101528. */
  101529. export interface PointDropEventObject {
  101530. /**
  101531. * New point after drag if only a single one.
  101532. */
  101533. newPoint?: PointDragDropObject;
  101534. /**
  101535. * New point id after drag if only a single one.
  101536. */
  101537. newPointId?: string;
  101538. /**
  101539. * New points after drop.
  101540. */
  101541. newPoints: Dictionary<PointDragDropObject>;
  101542. /**
  101543. * Number of new points.
  101544. */
  101545. numNewPoints: number;
  101546. /**
  101547. * Original data.
  101548. */
  101549. origin: DragDropPositionObject;
  101550. /**
  101551. * Prevent default drop action.
  101552. */
  101553. preventDefault: Function;
  101554. /**
  101555. * Target point that caused the event.
  101556. */
  101557. target: Point;
  101558. /**
  101559. * Event type.
  101560. */
  101561. type: "drop";
  101562. }
  101563. /**
  101564. * One position in relation to an axis.
  101565. */
  101566. export interface PointerAxisCoordinateObject {
  101567. /**
  101568. * Related axis.
  101569. */
  101570. axis: Axis;
  101571. /**
  101572. * Axis value.
  101573. */
  101574. value: number;
  101575. }
  101576. /**
  101577. * Positions in terms of axis values.
  101578. */
  101579. export interface PointerAxisCoordinatesObject {
  101580. /**
  101581. * Positions on the x-axis.
  101582. */
  101583. xAxis: Array<PointerAxisCoordinateObject>;
  101584. /**
  101585. * Positions on the y-axis.
  101586. */
  101587. yAxis: Array<PointerAxisCoordinateObject>;
  101588. }
  101589. /**
  101590. * Pointer coordinates.
  101591. */
  101592. export interface PointerCoordinatesObject {
  101593. chartX: number;
  101594. chartY: number;
  101595. }
  101596. /**
  101597. * A native browser mouse or touch event, extended with position information
  101598. * relative to the Chart.container.
  101599. */
  101600. export interface PointerEventObject extends PointerEvent {
  101601. /**
  101602. * The X coordinate of the pointer interaction relative to the chart.
  101603. */
  101604. chartX: number;
  101605. /**
  101606. * The Y coordinate of the pointer interaction relative to the chart.
  101607. */
  101608. chartY: number;
  101609. }
  101610. /**
  101611. * (Highcharts, Highstock, Gantt) The individual point events.
  101612. */
  101613. export interface PointEventsOptionsObject {
  101614. /**
  101615. * (Highcharts, Highstock, Gantt) Fires when a point is clicked. One
  101616. * parameter, `event`, is passed to the function, containing common event
  101617. * information.
  101618. *
  101619. * If the `series.allowPointSelect` option is true, the default action for
  101620. * the point's click event is to toggle the point's select state. Returning
  101621. * `false` cancels this action.
  101622. */
  101623. click?: PointClickCallbackFunction;
  101624. /**
  101625. * (Highcharts, Highstock, Gantt) Callback that fires while dragging a
  101626. * point. The mouse event is passed in as parameter. The original data can
  101627. * be accessed from `e.origin`, and the new point values can be accessed
  101628. * from `e.newPoints`. If there is only a single point being updated, it can
  101629. * be accessed from `e.newPoint` for simplicity, and its ID can be accessed
  101630. * from `e.newPointId`. The `this` context is the point being dragged. To
  101631. * stop the default drag action, return false. See drag and drop options.
  101632. */
  101633. drag?: PointDragCallbackFunction;
  101634. /**
  101635. * (Highcharts, Highstock, Gantt) Callback that fires when starting to drag
  101636. * a point. The mouse event object is passed in as an argument. If a drag
  101637. * handle is used, `e.updateProp` is set to the data property being dragged.
  101638. * The `this` context is the point. See drag and drop options.
  101639. */
  101640. dragStart?: PointDragStartCallbackFunction;
  101641. /**
  101642. * (Highcharts, Highstock, Gantt) Callback that fires when the point is
  101643. * dropped. The parameters passed are the same as for drag. To stop the
  101644. * default drop action, return false. See drag and drop options.
  101645. */
  101646. drop?: PointDropCallbackFunction;
  101647. /**
  101648. * (Highcharts) Fires when the legend item belonging to the pie point
  101649. * (slice) is clicked. The `this` keyword refers to the point itself. One
  101650. * parameter, `event`, is passed to the function, containing common event
  101651. * information. The default action is to toggle the visibility of the point.
  101652. * This can be prevented by calling `event.preventDefault()`.
  101653. */
  101654. legendItemClick?: PointLegendItemClickCallbackFunction;
  101655. /**
  101656. * (Highcharts, Highstock, Gantt) Fires when the mouse leaves the area close
  101657. * to the point. One parameter, `event`, is passed to the function,
  101658. * containing common event information.
  101659. */
  101660. mouseOut?: PointMouseOutCallbackFunction;
  101661. /**
  101662. * (Highcharts, Highstock, Gantt) Fires when the mouse enters the area close
  101663. * to the point. One parameter, `event`, is passed to the function,
  101664. * containing common event information.
  101665. */
  101666. mouseOver?: PointMouseOverCallbackFunction;
  101667. /**
  101668. * (Highcharts, Highstock, Gantt) Fires when the point is removed using the
  101669. * `.remove()` method. One parameter, `event`, is passed to the function.
  101670. * Returning `false` cancels the operation.
  101671. */
  101672. remove?: PointRemoveCallbackFunction;
  101673. /**
  101674. * Fires when the point is selected either programmatically or following a
  101675. * click on the point. One parameter, `event`, is passed to the function.
  101676. * Returning `false` cancels the operation.
  101677. */
  101678. select?: PointSelectCallbackFunction;
  101679. /**
  101680. * Fires when the point is unselected either programmatically or following a
  101681. * click on the point. One parameter, `event`, is passed to the function.
  101682. * Returning `false` cancels the operation.
  101683. */
  101684. unselect?: PointUnselectCallbackFunction;
  101685. /**
  101686. * (Highcharts, Highstock, Gantt) Fires when the point is updated
  101687. * programmatically through the `.update()` method. One parameter, `event`,
  101688. * is passed to the function. The new point options can be accessed through
  101689. * `event.options`. Returning `false` cancels the operation.
  101690. */
  101691. update?: PointUpdateCallbackFunction;
  101692. }
  101693. /**
  101694. * Information about the select/unselect event.
  101695. */
  101696. export interface PointInteractionEventObject extends Event {
  101697. accumulate: boolean;
  101698. }
  101699. /**
  101700. * Configuration hash for the data label and tooltip formatters.
  101701. */
  101702. export interface PointLabelObject {
  101703. /**
  101704. * The point's current color.
  101705. */
  101706. color?: (ColorString|GradientColorObject|PatternObject);
  101707. /**
  101708. * The point's current color index, used in styled mode instead of `color`.
  101709. * The color index is inserted in class names used for styling.
  101710. */
  101711. colorIndex: number;
  101712. /**
  101713. * The name of the related point.
  101714. */
  101715. key?: string;
  101716. /**
  101717. * The percentage for related points in a stacked series or pies.
  101718. */
  101719. percentage: number;
  101720. /**
  101721. * The related point. The point name, if defined, is available through
  101722. * `this.point.name`.
  101723. */
  101724. point: Point;
  101725. /**
  101726. * The related series. The series name is available through
  101727. * `this.series.name`.
  101728. */
  101729. series: Series;
  101730. /**
  101731. * The total of values in either a stack for stacked series, or a pie in a
  101732. * pie series.
  101733. */
  101734. total?: number;
  101735. /**
  101736. * For categorized axes this property holds the category name for the point.
  101737. * For other axes it holds the X value.
  101738. */
  101739. x?: (number|string);
  101740. /**
  101741. * The y value of the point.
  101742. */
  101743. y?: number;
  101744. }
  101745. /**
  101746. * Information about the legend click event.
  101747. */
  101748. export interface PointLegendItemClickEventObject {
  101749. /**
  101750. * Related browser event.
  101751. */
  101752. browserEvent: PointerEvent;
  101753. /**
  101754. * Prevent the default action of toggle the visibility of the point.
  101755. */
  101756. preventDefault: Function;
  101757. /**
  101758. * Related point.
  101759. */
  101760. target: Point;
  101761. /**
  101762. * Event type.
  101763. */
  101764. type: "legendItemClick";
  101765. }
  101766. /**
  101767. * (Highcharts, Highstock) Options for the point markers of line-like series.
  101768. */
  101769. export interface PointMarkerOptionsObject {
  101770. /**
  101771. * (Highcharts, Highstock, Highmaps) Animation for the marker as it moves
  101772. * between values. Set to `false` to disable animation. Defaults to `{
  101773. * duration: 50 }`.
  101774. */
  101775. animation?: (boolean|Partial<AnimationOptionsObject>);
  101776. /**
  101777. * (Highcharts, Highstock, Highmaps) The color of the marker.
  101778. */
  101779. color?: (ColorString|GradientColorObject|PatternObject);
  101780. /**
  101781. * (Highcharts, Highstock) Enable or disable the point marker. If
  101782. * `undefined`, the markers are hidden when the data is dense, and shown for
  101783. * more widespread data points.
  101784. */
  101785. enabled?: boolean;
  101786. /**
  101787. * (Highcharts, Highstock) The threshold for how dense the point markers
  101788. * should be before they are hidden, given that `enabled` is not defined.
  101789. * The number indicates the horizontal distance between the two closest
  101790. * points in the series, as multiples of the `marker.radius`. In other
  101791. * words, the default value of 2 means points are hidden if overlapping
  101792. * horizontally.
  101793. */
  101794. enabledThreshold?: number;
  101795. /**
  101796. * (Highcharts, Highstock) The fill color of the point marker. When
  101797. * `undefined`, the series' or point's color is used.
  101798. */
  101799. fillColor?: (ColorString|GradientColorObject|PatternObject);
  101800. /**
  101801. * (Highcharts) The fill opacity of the bubble markers.
  101802. */
  101803. fillOpacity?: number;
  101804. /**
  101805. * (Highcharts, Highstock) Image markers only. Set the image width
  101806. * explicitly. When using this option, a `width` must also be set.
  101807. */
  101808. height?: number;
  101809. /**
  101810. * (Highcharts, Highstock) The color of the point marker's outline. When
  101811. * `undefined`, the series' or point's color is used.
  101812. */
  101813. lineColor?: (string|ColorString|GradientColorObject|PatternObject);
  101814. /**
  101815. * (Highcharts, Highstock) The width of the point marker's outline.
  101816. */
  101817. lineWidth?: number;
  101818. /**
  101819. * (Highcharts, Highstock) The radius of the point marker.
  101820. */
  101821. radius?: number;
  101822. /**
  101823. * (Highcharts, Highstock) States for a single point marker.
  101824. */
  101825. states?: PointStatesOptionsObject;
  101826. /**
  101827. * (Highcharts, Highstock) A predefined shape or symbol for the marker. When
  101828. * undefined, the symbol is pulled from options.symbols. Other possible
  101829. * values are `'circle'`, `'square'`,`'diamond'`, `'triangle'` and
  101830. * `'triangle-down'`.
  101831. *
  101832. * Additionally, the URL to a graphic can be given on this form:
  101833. * `'url(graphic.png)'`. Note that for the image to be applied to exported
  101834. * charts, its URL needs to be accessible by the export server.
  101835. *
  101836. * Custom callbacks for symbol path generation can also be added to
  101837. * `Highcharts.SVGRenderer.prototype.symbols`. The callback is then used by
  101838. * its method name, as shown in the demo.
  101839. */
  101840. symbol?: (string|SymbolKeyValue);
  101841. /**
  101842. * (Highcharts, Highstock) Image markers only. Set the image width
  101843. * explicitly. When using this option, a `height` must also be set.
  101844. */
  101845. width?: number;
  101846. }
  101847. /**
  101848. * The generic point options for all series.
  101849. *
  101850. * In TypeScript you have to extend `PointOptionsObject` with an additional
  101851. * declaration to allow custom data options: (see online documentation for
  101852. * example)
  101853. */
  101854. export interface PointOptionsObject {
  101855. /**
  101856. * (Highcharts) Accessibility options for a data point.
  101857. */
  101858. accessibility?: PointAccessibilityOptionsObject;
  101859. /**
  101860. * (Highcharts, Highstock) The color of the border surrounding the column or
  101861. * bar.
  101862. *
  101863. * In styled mode, the border stroke can be set with the `.highcharts-point`
  101864. * rule.
  101865. */
  101866. borderColor?: (ColorString|GradientColorObject|PatternObject);
  101867. /**
  101868. * (Highcharts, Highstock) The width of the border surrounding the column or
  101869. * bar.
  101870. *
  101871. * In styled mode, the stroke width can be set with the `.highcharts-point`
  101872. * rule.
  101873. */
  101874. borderWidth?: number;
  101875. /**
  101876. * (Highcharts) The dash style of the box.
  101877. */
  101878. boxDashStyle?: DashStyleValue;
  101879. /**
  101880. * (Highcharts, Gantt) An additional, individual class name for the data
  101881. * point's graphic representation.
  101882. */
  101883. className?: string;
  101884. /**
  101885. * (Highstock) The closing value of each data point.
  101886. */
  101887. close?: number;
  101888. /**
  101889. * (Highcharts, Highstock, Gantt) Individual color for the point. By default
  101890. * the color is pulled from the global `colors` array.
  101891. *
  101892. * In styled mode, the `color` option doesn't take effect. Instead, use
  101893. * `colorIndex`.
  101894. */
  101895. color?: (ColorString|GradientColorObject|PatternObject);
  101896. /**
  101897. * (Highcharts, Gantt) A specific color index to use for the point, so its
  101898. * graphic representations are given the class name `highcharts-color-{n}`.
  101899. * In styled mode this will change the color of the graphic. In non-styled
  101900. * mode, the color by is set by the `fill` attribute, so the change in class
  101901. * name won't have a visual effect by default.
  101902. */
  101903. colorIndex?: number;
  101904. /**
  101905. * (Highcharts) Serves a purpose only if a `colorAxis` object is defined in
  101906. * the chart options. This value will decide which color the point gets from
  101907. * the scale of the colorAxis.
  101908. */
  101909. colorValue?: number;
  101910. /**
  101911. * (Highcharts, Highstock) Color of the line that connects the dumbbell
  101912. * point's values. By default it is the series' color.
  101913. */
  101914. connectorColor?: string;
  101915. /**
  101916. * (Highcharts, Highstock) Pixel width of the line that connects the
  101917. * dumbbell point's values.
  101918. */
  101919. connectorWidth?: number;
  101920. /**
  101921. * (Highcharts) A reserved subspace to store options and values for
  101922. * customized functionality. Here you can add additional data for your own
  101923. * event callbacks and formatter callbacks.
  101924. */
  101925. custom?: Dictionary<any>;
  101926. /**
  101927. * (Highcharts) A name for the dash style to use for the column or bar.
  101928. * Overrides dashStyle on the series.
  101929. *
  101930. * In styled mode, the stroke dash-array can be set with the same classes as
  101931. * listed under data.color.
  101932. */
  101933. dashStyle?: DashStyleValue;
  101934. /**
  101935. * (Highcharts, Highstock, Gantt) Individual data label for each point. The
  101936. * options are the same as the ones for plotOptions.series.dataLabels.
  101937. */
  101938. dataLabels?: (DataLabelsOptions|SeriesNetworkgraphDataLabelsOptionsObject|SeriesPackedBubbleDataLabelsOptionsObject|SeriesPieDataLabelsOptionsObject|SeriesSunburstDataLabelsOptionsObject|
  101939. Array<DataLabelsOptions>|Array<SeriesNetworkgraphDataLabelsOptionsObject>|Array<SeriesPackedBubbleDataLabelsOptionsObject>|Array<SeriesSunburstDataLabelsOptionsObject>);
  101940. /**
  101941. * (Highcharts) A description of the point to add to the screen reader
  101942. * information about the point.
  101943. */
  101944. description?: string;
  101945. /**
  101946. * (Highcharts, Highstock) The wind direction in degrees, where 0 is north
  101947. * (pointing towards south).
  101948. */
  101949. direction?: number;
  101950. /**
  101951. * (Highcharts) Point specific options for the draggable-points module.
  101952. * Overrides options on `series.dragDrop`.
  101953. */
  101954. dragDrop?: SeriesLineDataDragDropOptions;
  101955. /**
  101956. * (Highcharts) The `id` of a series in the drilldown.series array to use
  101957. * for a drilldown for this point.
  101958. */
  101959. drilldown?: string;
  101960. /**
  101961. * (Highcharts, Highstock, Gantt) The individual point events.
  101962. */
  101963. events?: PointEventsOptionsObject;
  101964. /**
  101965. * (Highstock) The fill color of an individual flag. By default it inherits
  101966. * from the series color.
  101967. */
  101968. fillColor?: (ColorString|GradientColorObject|PatternObject);
  101969. /**
  101970. * (Highcharts) The node that the link runs from.
  101971. */
  101972. from?: string;
  101973. /**
  101974. * (Highcharts, Highstock) The high or maximum value for each data point.
  101975. */
  101976. high?: number;
  101977. /**
  101978. * (Highcharts, Highstock, Gantt) An id for the point. This can be used
  101979. * after render time to get a pointer to the point object through
  101980. * `chart.get()`.
  101981. */
  101982. id?: string;
  101983. /**
  101984. * (Highcharts) The inner radius of an individual point in a solid gauge.
  101985. * Can be given as a number (pixels) or percentage string.
  101986. */
  101987. innerRadius?: (number|string);
  101988. /**
  101989. * (Highcharts) When this property is true, the points acts as a summary
  101990. * column for the values added or substracted since the last intermediate
  101991. * sum, or since the start of the series. The `y` value is ignored.
  101992. */
  101993. isIntermediateSum?: boolean;
  101994. /**
  101995. * (Highcharts) When this property is true, the point display the total sum
  101996. * across the entire series. The `y` value is ignored.
  101997. */
  101998. isSum?: boolean;
  101999. /**
  102000. * (Highcharts) The label of event.
  102001. */
  102002. label?: string;
  102003. /**
  102004. * (Highcharts) The rank for this point's data label in case of collision.
  102005. * If two data labels are about to overlap, only the one with the highest
  102006. * `labelrank` will be drawn.
  102007. */
  102008. labelrank?: number;
  102009. /**
  102010. * (Highcharts) The sequential index of the data point in the legend.
  102011. */
  102012. legendIndex?: number;
  102013. /**
  102014. * (Highcharts, Highstock) The length of the vector. The rendered length
  102015. * will relate to the `vectorLength` setting.
  102016. */
  102017. length?: number;
  102018. /**
  102019. * (Highcharts, Highstock) The low or minimum value for each data point.
  102020. */
  102021. low?: number;
  102022. /**
  102023. * (Highcharts, Highstock) Color of the start markers in a dumbbell graph.
  102024. */
  102025. lowColor?: (ColorString|GradientColorObject|PatternObject);
  102026. /**
  102027. * (Highcharts, Highstock) Options for the point markers of line-like
  102028. * series.
  102029. */
  102030. marker?: PointMarkerOptionsObject;
  102031. /**
  102032. * (Highcharts) The median for each data point. This is drawn as a line
  102033. * through the middle area of the box.
  102034. */
  102035. median?: number;
  102036. /**
  102037. * (Highcharts) The dash style of the median.
  102038. */
  102039. medianDashStyle?: DashStyleValue;
  102040. /**
  102041. * (Highcharts) The name of the point as shown in the legend, tooltip,
  102042. * dataLabels, etc.
  102043. */
  102044. name?: (number|string);
  102045. /**
  102046. * (Highstock) The opening value of each data point.
  102047. */
  102048. open?: number;
  102049. /**
  102050. * (Highcharts) Only for treemap. Use this option to build a tree structure.
  102051. * The value should be the id of the point which is the parent. If no points
  102052. * has a matching id, or this option is undefined, then the parent will be
  102053. * set to the root.
  102054. */
  102055. parent?: string;
  102056. /**
  102057. * (Highcharts, Highmaps) Point padding for a single point.
  102058. */
  102059. pointPadding?: number;
  102060. /**
  102061. * (Highcharts, Highstock, Gantt) A pixel value specifying a fixed width for
  102062. * the column or bar. Overrides pointWidth on the series. The width effects
  102063. * the dimension that is not based on the point value.
  102064. */
  102065. pointWidth?: number;
  102066. /**
  102067. * (Highcharts) The lower quartile for each data point. This is the bottom
  102068. * of the box.
  102069. */
  102070. q1?: number;
  102071. /**
  102072. * (Highcharts) The higher quartile for each data point. This is the top of
  102073. * the box.
  102074. */
  102075. q3?: number;
  102076. /**
  102077. * (Highcharts) The outer radius of an individual point in a solid gauge.
  102078. * Can be given as a number (pixels) or percentage string.
  102079. */
  102080. radius?: (number|string);
  102081. /**
  102082. * (Highcharts, Highstock, Gantt) Whether the data point is selected
  102083. * initially.
  102084. */
  102085. selected?: boolean;
  102086. /**
  102087. * (Highcharts) The set or sets the options will be applied to. If a single
  102088. * entry is defined, then it will create a new set. If more than one entry
  102089. * is defined, then it will define the overlap between the sets in the
  102090. * array.
  102091. */
  102092. sets?: Array<string>;
  102093. /**
  102094. * (Highcharts) Whether to display a slice offset from the center.
  102095. */
  102096. sliced?: boolean;
  102097. /**
  102098. * (Highcharts) The dash style of the stem.
  102099. */
  102100. stemDashStyle?: DashStyleValue;
  102101. /**
  102102. * (Highcharts) The target value of a point.
  102103. */
  102104. target?: number;
  102105. /**
  102106. * (Highcharts) Individual target options for each point.
  102107. */
  102108. targetOptions?: SeriesBulletDataTargetOptions;
  102109. /**
  102110. * (Highstock) The longer text to be shown in the flag's tooltip.
  102111. */
  102112. text?: string;
  102113. /**
  102114. * (Highstock) The short text to be shown on the flag.
  102115. */
  102116. title?: string;
  102117. /**
  102118. * (Highcharts) The node that the link runs to.
  102119. */
  102120. to?: string;
  102121. /**
  102122. * (Highcharts, Highstock) The wind speed in meters per second.
  102123. */
  102124. value?: (number|null);
  102125. /**
  102126. * (Highcharts) The weighting of a word. The weight decides the relative
  102127. * size of a word compared to the rest of the collection.
  102128. */
  102129. weight?: number;
  102130. /**
  102131. * (Highcharts) The dash style of the whiskers.
  102132. */
  102133. whiskerDashStyle?: DashStyleValue;
  102134. /**
  102135. * (Highcharts, Highstock) The x value of the point. For datetime axes, the
  102136. * X value is the timestamp in milliseconds since 1970.
  102137. */
  102138. x?: number;
  102139. /**
  102140. * (Highcharts, Highstock) The y value of the point.
  102141. */
  102142. y?: (number|null);
  102143. /**
  102144. * (Highcharts) The relative width for each column. On a category axis, the
  102145. * widths are distributed so they sum up to the X axis length. On linear and
  102146. * datetime axes, the columns will be laid out from the X value and Z units
  102147. * along the axis.
  102148. */
  102149. z?: (number|null);
  102150. }
  102151. /**
  102152. * (Highcharts, Highstock) The hover state for a single point marker.
  102153. */
  102154. export interface PointStatesHoverOptionsObject {
  102155. /**
  102156. * (Highcharts, Highstock) Animation when hovering over the marker.
  102157. */
  102158. animation?: (boolean|Partial<AnimationOptionsObject>);
  102159. /**
  102160. * (Highcharts, Highstock) Enable or disable the point marker.
  102161. */
  102162. enabled?: boolean;
  102163. /**
  102164. * (Highcharts, Highstock) The fill color of the marker in hover state. When
  102165. * `undefined`, the series' or point's fillColor for normal state is used.
  102166. */
  102167. fillColor?: (ColorString|GradientColorObject|PatternObject);
  102168. /**
  102169. * (Highcharts, Highmaps) Set the marker's fixed height on hover state.
  102170. */
  102171. height?: (number|undefined);
  102172. /**
  102173. * (Highcharts, Highstock) The number of pixels to increase the height of
  102174. * the hovered point.
  102175. */
  102176. heightPlus?: (number|undefined);
  102177. /**
  102178. * (Highcharts, Highstock) The color of the point marker's outline. When
  102179. * `undefined`, the series' or point's lineColor for normal state is used.
  102180. */
  102181. lineColor?: (ColorString|GradientColorObject|PatternObject);
  102182. /**
  102183. * (Highcharts, Highstock) The width of the point marker's outline. When
  102184. * `undefined`, the series' or point's lineWidth for normal state is used.
  102185. */
  102186. lineWidth?: number;
  102187. /**
  102188. * (Highcharts, Highstock) The additional line width for a hovered point.
  102189. */
  102190. lineWidthPlus?: (number|undefined);
  102191. /**
  102192. * (Highcharts, Highstock) The radius of the point marker. In hover state,
  102193. * it defaults to the normal state's radius + 2 as per the radiusPlus
  102194. * option.
  102195. */
  102196. radius?: number;
  102197. /**
  102198. * (Highcharts, Highstock) The number of pixels to increase the radius of
  102199. * the hovered point.
  102200. */
  102201. radiusPlus?: number;
  102202. /**
  102203. * (Highcharts, Highmaps) Set the marker's fixed width on hover state.
  102204. */
  102205. width?: (number|undefined);
  102206. /**
  102207. * (Highcharts, Highstock) The number of pixels to increase the width of the
  102208. * hovered point.
  102209. */
  102210. widthPlus?: (number|undefined);
  102211. }
  102212. /**
  102213. * (Highcharts) The opposite state of a hover for a single point node. Applied
  102214. * to all not connected nodes to the hovered one.
  102215. */
  102216. export interface PointStatesInactiveOptionsObject {
  102217. /**
  102218. * (Highcharts) Animation when not hovering over the node.
  102219. */
  102220. animation?: (boolean|Partial<AnimationOptionsObject>);
  102221. /**
  102222. * (Highcharts) Opacity of inactive markers.
  102223. */
  102224. opacity?: number;
  102225. }
  102226. /**
  102227. * (Highcharts, Highstock) The normal state of a single point marker. Currently
  102228. * only used for setting animation when returning to normal state from hover.
  102229. */
  102230. export interface PointStatesNormalOptionsObject {
  102231. /**
  102232. * (Highcharts, Highstock) Animation when returning to normal state after
  102233. * hovering.
  102234. */
  102235. animation?: (boolean|Partial<AnimationOptionsObject>);
  102236. }
  102237. /**
  102238. * (Highcharts, Highstock) States for a single point marker.
  102239. */
  102240. export interface PointStatesOptionsObject {
  102241. /**
  102242. * (Highcharts, Highstock) The hover state for a single point marker.
  102243. */
  102244. hover?: PointStatesHoverOptionsObject;
  102245. /**
  102246. * (Highcharts) The opposite state of a hover for a single point node.
  102247. * Applied to all not connected nodes to the hovered one.
  102248. */
  102249. inactive?: PointStatesInactiveOptionsObject;
  102250. /**
  102251. * (Highcharts, Highstock) The normal state of a single point marker.
  102252. * Currently only used for setting animation when returning to normal state
  102253. * from hover.
  102254. */
  102255. normal?: PointStatesNormalOptionsObject;
  102256. /**
  102257. * (Highcharts, Highstock) The appearance of the point marker when selected.
  102258. * In order to allow a point to be selected, set the
  102259. * `series.allowPointSelect` option to true.
  102260. */
  102261. select?: PointStatesSelectOptionsObject;
  102262. }
  102263. /**
  102264. * (Highcharts, Highstock) The appearance of the point marker when selected. In
  102265. * order to allow a point to be selected, set the `series.allowPointSelect`
  102266. * option to true.
  102267. */
  102268. export interface PointStatesSelectOptionsObject {
  102269. /**
  102270. * (Highcharts, Highstock) Enable or disable visible feedback for selection.
  102271. */
  102272. enabled?: boolean;
  102273. /**
  102274. * (Highcharts, Highstock) The fill color of the point marker.
  102275. */
  102276. fillColor?: (ColorString|GradientColorObject|PatternObject);
  102277. /**
  102278. * (Highcharts, Highmaps) Set the marker's fixed height on select state.
  102279. */
  102280. height?: (number|undefined);
  102281. /**
  102282. * (Highcharts, Highstock) The number of pixels to increase the height of
  102283. * the hovered point.
  102284. */
  102285. heightPlus?: (number|undefined);
  102286. /**
  102287. * (Highcharts, Highstock) The color of the point marker's outline. When
  102288. * `undefined`, the series' or point's color is used.
  102289. */
  102290. lineColor?: (ColorString|GradientColorObject|PatternObject);
  102291. /**
  102292. * (Highcharts, Highstock) The width of the point marker's outline.
  102293. */
  102294. lineWidth?: number;
  102295. /**
  102296. * (Highcharts, Highstock) The radius of the point marker. In hover state,
  102297. * it defaults to the normal state's radius + 2.
  102298. */
  102299. radius?: number;
  102300. /**
  102301. * (Highcharts, Highmaps) Set the marker's fixed width on select state.
  102302. */
  102303. width?: (number|undefined);
  102304. /**
  102305. * (Highcharts, Highstock) The number of pixels to increase the width of the
  102306. * hovered point.
  102307. */
  102308. widthPlus?: (number|undefined);
  102309. }
  102310. /**
  102311. * Information about the update event.
  102312. */
  102313. export interface PointUpdateEventObject extends Event {
  102314. /**
  102315. * Options data of the update event.
  102316. */
  102317. options: PointOptionsType;
  102318. }
  102319. /**
  102320. * An object containing `x` and `y` properties for the position of an element.
  102321. */
  102322. export interface PositionObject {
  102323. /**
  102324. * X position of the element.
  102325. */
  102326. x: number;
  102327. /**
  102328. * Y position of the element.
  102329. */
  102330. y: number;
  102331. }
  102332. /**
  102333. * Defines the center position and the radius for a gradient.
  102334. */
  102335. export interface RadialGradientColorObject {
  102336. /**
  102337. * Center horizontal position relative to the shape. Float ranges 0-1.
  102338. */
  102339. cx: number;
  102340. /**
  102341. * Center vertical position relative to the shape. Float ranges 0-1.
  102342. */
  102343. cy: number;
  102344. /**
  102345. * Radius relative to the shape. Float ranges 0-1.
  102346. */
  102347. r: number;
  102348. }
  102349. /**
  102350. * Describes a range.
  102351. */
  102352. export interface RangeObject {
  102353. /**
  102354. * Maximum number of the range.
  102355. */
  102356. max: number;
  102357. /**
  102358. * Minimum number of the range.
  102359. */
  102360. min: number;
  102361. }
  102362. /**
  102363. * (Highstock, Gantt) Positioning for the button row.
  102364. */
  102365. export interface RangeSelectorButtonPositionOptions {
  102366. /**
  102367. * (Highstock, Gantt) The alignment of the input box. Allowed properties are
  102368. * `left`, `center`, `right`.
  102369. */
  102370. align?: AlignValue;
  102371. /**
  102372. * (Highstock, Gantt) X offset of the button row.
  102373. */
  102374. x?: number;
  102375. /**
  102376. * (Highstock, Gantt) Y offset of the button row.
  102377. */
  102378. y?: number;
  102379. }
  102380. export interface RangeSelectorButtonsEventsOptions {
  102381. /**
  102382. * (Highstock, Gantt) Fires when clicking on the rangeSelector button. One
  102383. * parameter, event, is passed to the function, containing common event
  102384. * information. (see online documentation for example)
  102385. *
  102386. * Return false to stop default button's click action.
  102387. */
  102388. click?: RangeSelectorClickCallbackFunction;
  102389. }
  102390. /**
  102391. * (Highstock, Gantt) An array of configuration objects for the buttons.
  102392. *
  102393. * Defaults to: (see online documentation for example)
  102394. */
  102395. export interface RangeSelectorButtonsOptions {
  102396. /**
  102397. * (Highstock, Gantt) How many units of the defined type the button should
  102398. * span. If `type` is "month" and `count` is 3, the button spans three
  102399. * months.
  102400. */
  102401. count?: number;
  102402. /**
  102403. * (Highstock) A custom data grouping object for each button.
  102404. */
  102405. dataGrouping?: DataGroupingOptionsObject;
  102406. events?: RangeSelectorButtonsEventsOptions;
  102407. /**
  102408. * (Highstock, Gantt) Additional range (in milliseconds) added to the end of
  102409. * the calculated time span.
  102410. */
  102411. offsetMax?: number;
  102412. /**
  102413. * (Highstock, Gantt) Additional range (in milliseconds) added to the start
  102414. * of the calculated time span.
  102415. */
  102416. offsetMin?: number;
  102417. /**
  102418. * (Highstock, Gantt) When buttons apply dataGrouping on a series, by
  102419. * default zooming in/out will deselect buttons and unset dataGrouping.
  102420. * Enable this option to keep buttons selected when extremes change.
  102421. */
  102422. preserveDataGrouping?: boolean;
  102423. /**
  102424. * (Highstock, Gantt) The text for the button itself.
  102425. */
  102426. text?: string;
  102427. /**
  102428. * (Highstock, Gantt) Explanation for the button, shown as a tooltip on
  102429. * hover, and used by assistive technology.
  102430. */
  102431. title?: string;
  102432. /**
  102433. * (Highstock, Gantt) Defined the time span for the button. Can be one of
  102434. * `millisecond`, `second`, `minute`, `hour`, `day`, `week`, `month`,
  102435. * `year`, `ytd`, and `all`.
  102436. */
  102437. type?: RangeSelectorButtonTypeValue;
  102438. }
  102439. /**
  102440. * (Highstock, Gantt) Positioning for the input boxes. Allowed properties are
  102441. * `align`, `x` and `y`.
  102442. */
  102443. export interface RangeSelectorInputPositionOptions {
  102444. /**
  102445. * (Highstock, Gantt) The alignment of the input box. Allowed properties are
  102446. * `left`, `center`, `right`.
  102447. */
  102448. align?: AlignValue;
  102449. /**
  102450. * (Highstock, Gantt) X offset of the input row.
  102451. */
  102452. x?: number;
  102453. /**
  102454. * (Highstock, Gantt) Y offset of the input row.
  102455. */
  102456. y?: number;
  102457. }
  102458. /**
  102459. * (Highstock, Gantt) The range selector is a tool for selecting ranges to
  102460. * display within the chart. It provides buttons to select preconfigured ranges
  102461. * in the chart, like 1 day, 1 week, 1 month etc. It also provides input boxes
  102462. * where min and max dates can be manually input.
  102463. */
  102464. export interface RangeSelectorOptions {
  102465. /**
  102466. * (Highstock, Gantt) Whether to enable all buttons from the start. By
  102467. * default buttons are only enabled if the corresponding time range exists
  102468. * on the X axis, but enabling all buttons allows for dynamically loading
  102469. * different time ranges.
  102470. */
  102471. allButtonsEnabled?: boolean;
  102472. /**
  102473. * (Highstock, Gantt) Positioning for the button row.
  102474. */
  102475. buttonPosition?: RangeSelectorButtonPositionOptions;
  102476. /**
  102477. * (Highstock, Gantt) An array of configuration objects for the buttons.
  102478. *
  102479. * Defaults to: (see online documentation for example)
  102480. */
  102481. buttons?: Array<RangeSelectorButtonsOptions>;
  102482. /**
  102483. * (Highstock, Gantt) The space in pixels between the buttons in the range
  102484. * selector.
  102485. */
  102486. buttonSpacing?: number;
  102487. /**
  102488. * (Highstock, Gantt) A collection of attributes for the buttons. The object
  102489. * takes SVG attributes like `fill`, `stroke`, `stroke-width`, as well as
  102490. * `style`, a collection of CSS properties for the text.
  102491. *
  102492. * The object can also be extended with states, so you can set
  102493. * presentational options for `hover`, `select` or `disabled` button states.
  102494. *
  102495. * CSS styles for the text label.
  102496. *
  102497. * In styled mode, the buttons are styled by the
  102498. * `.highcharts-range-selector-buttons .highcharts-button` rule with its
  102499. * different states.
  102500. */
  102501. buttonTheme?: SVGAttributes;
  102502. /**
  102503. * (Highstock, Gantt) Whether to collapse the range selector buttons into a
  102504. * dropdown when there is not enough room to show everything in a single
  102505. * row, instead of dividing the range selector into multiple rows. Can be
  102506. * one of the following:
  102507. *
  102508. * - `always`: Always collapse
  102509. *
  102510. * - `responsive`: Only collapse when there is not enough room
  102511. *
  102512. * - `never`: Never collapse
  102513. */
  102514. dropdown?: OptionsDropdownValue;
  102515. /**
  102516. * (Highstock, Gantt) Enable or disable the range selector. Default to
  102517. * `true` for stock charts, using the `stockChart` factory.
  102518. */
  102519. enabled?: (boolean|undefined);
  102520. /**
  102521. * (Highstock, Gantt) When the rangeselector is floating, the plot area does
  102522. * not reserve space for it. This opens for positioning anywhere on the
  102523. * chart.
  102524. */
  102525. floating?: boolean;
  102526. /**
  102527. * (Highstock, Gantt) The border color of the date input boxes.
  102528. */
  102529. inputBoxBorderColor?: ColorString;
  102530. /**
  102531. * (Highstock, Gantt) The pixel height of the date input boxes.
  102532. */
  102533. inputBoxHeight?: number;
  102534. /**
  102535. * (Highstock, Gantt) The pixel width of the date input boxes. When
  102536. * `undefined`, the width is fitted to the rendered content.
  102537. */
  102538. inputBoxWidth?: (number|undefined);
  102539. /**
  102540. * (Highstock, Gantt) The date format in the input boxes when not selected
  102541. * for editing. Defaults to `%b %e, %Y`.
  102542. *
  102543. * This is used to determine which type of input to show, `datetime-local`,
  102544. * `date` or `time` and falling back to `text` when the browser does not
  102545. * support the input type or the format contains milliseconds.
  102546. */
  102547. inputDateFormat?: string;
  102548. /**
  102549. * (Highstock, Gantt) A custom callback function to parse values entered in
  102550. * the input boxes and return a valid JavaScript time as milliseconds since
  102551. * 1970. The first argument passed is a value to parse, second is a boolean
  102552. * indicating use of the UTC time.
  102553. *
  102554. * This will only get called for inputs of type `text`. Since v8.2.3, the
  102555. * input type is dynamically determined based on the granularity of the
  102556. * `inputDateFormat` and the browser support.
  102557. */
  102558. inputDateParser?: RangeSelectorParseCallbackFunction;
  102559. /**
  102560. * (Highstock, Gantt) The date format in the input boxes when they are
  102561. * selected for editing. This must be a format that is recognized by
  102562. * JavaScript Date.parse.
  102563. *
  102564. * This will only be used for inputs of type `text`. Since v8.2.3, the input
  102565. * type is dynamically determined based on the granularity of the
  102566. * `inputDateFormat` and the browser support.
  102567. */
  102568. inputEditDateFormat?: string;
  102569. /**
  102570. * (Highstock, Gantt) Enable or disable the date input boxes.
  102571. */
  102572. inputEnabled?: boolean;
  102573. /**
  102574. * (Highstock, Gantt) Positioning for the input boxes. Allowed properties
  102575. * are `align`, `x` and `y`.
  102576. */
  102577. inputPosition?: RangeSelectorInputPositionOptions;
  102578. /**
  102579. * (Highstock, Gantt) The space in pixels between the labels and the date
  102580. * input boxes in the range selector.
  102581. */
  102582. inputSpacing?: number;
  102583. /**
  102584. * (Highstock, Gantt) CSS for the HTML inputs in the range selector.
  102585. *
  102586. * In styled mode, the inputs are styled by the `.highcharts-range-input
  102587. * text` rule in SVG mode, and `input.highcharts-range-selector` when
  102588. * active.
  102589. */
  102590. inputStyle?: CSSObject;
  102591. /**
  102592. * (Highstock, Gantt) CSS styles for the labels - the Zoom, From and To
  102593. * texts.
  102594. *
  102595. * In styled mode, the labels are styled by the `.highcharts-range-label`
  102596. * class.
  102597. */
  102598. labelStyle?: CSSObject;
  102599. /**
  102600. * (Highstock, Gantt) The index of the button to appear pre-selected.
  102601. */
  102602. selected?: number;
  102603. /**
  102604. * (Highstock, Gantt) The vertical alignment of the rangeselector box.
  102605. * Allowed properties are `top`, `middle`, `bottom`.
  102606. */
  102607. verticalAlign?: VerticalAlignValue;
  102608. /**
  102609. * (Highstock, Gantt) The x offset of the range selector relative to its
  102610. * horizontal alignment within `chart.spacingLeft` and `chart.spacingRight`.
  102611. */
  102612. x?: number;
  102613. /**
  102614. * (Highstock, Gantt) The y offset of the range selector relative to its
  102615. * horizontal alignment within `chart.spacingLeft` and `chart.spacingRight`.
  102616. */
  102617. y?: number;
  102618. }
  102619. /**
  102620. * A rectangle.
  102621. */
  102622. export interface RectangleObject {
  102623. /**
  102624. * Height of the rectangle.
  102625. */
  102626. height: number;
  102627. /**
  102628. * Width of the rectangle.
  102629. */
  102630. width: number;
  102631. /**
  102632. * Horizontal position of the rectangle.
  102633. */
  102634. x: number;
  102635. /**
  102636. * Vertical position of the rectangle.
  102637. */
  102638. y: number;
  102639. }
  102640. /**
  102641. * (Highcharts, Highstock, Highmaps, Gantt) Allows setting a set of rules to
  102642. * apply for different screen or chart sizes. Each rule specifies additional
  102643. * chart options.
  102644. */
  102645. export interface ResponsiveOptions {
  102646. /**
  102647. * (Highcharts, Highstock, Highmaps, Gantt) A set of rules for responsive
  102648. * settings. The rules are executed from the top down.
  102649. */
  102650. rules?: Array<ResponsiveRulesOptions>;
  102651. }
  102652. /**
  102653. * (Highcharts, Highstock, Highmaps, Gantt) Under which conditions the rule
  102654. * applies.
  102655. */
  102656. export interface ResponsiveRulesConditionOptions {
  102657. /**
  102658. * (Highcharts, Highstock, Highmaps, Gantt) A callback function to gain
  102659. * complete control on when the responsive rule applies. Return `true` if it
  102660. * applies. This opens for checking against other metrics than the chart
  102661. * size, for example the document size or other elements.
  102662. */
  102663. callback?: ResponsiveCallbackFunction;
  102664. /**
  102665. * (Highcharts, Highstock, Highmaps, Gantt) The responsive rule applies if
  102666. * the chart height is less than this.
  102667. */
  102668. maxHeight?: number;
  102669. /**
  102670. * (Highcharts, Highstock, Highmaps, Gantt) The responsive rule applies if
  102671. * the chart width is less than this.
  102672. */
  102673. maxWidth?: number;
  102674. /**
  102675. * (Highcharts, Highstock, Highmaps, Gantt) The responsive rule applies if
  102676. * the chart height is greater than this.
  102677. */
  102678. minHeight?: number;
  102679. /**
  102680. * (Highcharts, Highstock, Highmaps, Gantt) The responsive rule applies if
  102681. * the chart width is greater than this.
  102682. */
  102683. minWidth?: number;
  102684. }
  102685. /**
  102686. * (Highcharts, Highstock, Highmaps, Gantt) A set of rules for responsive
  102687. * settings. The rules are executed from the top down.
  102688. */
  102689. export interface ResponsiveRulesOptions {
  102690. /**
  102691. * (Highcharts, Highstock, Highmaps, Gantt) A full set of chart options to
  102692. * apply as overrides to the general chart options. The chart options are
  102693. * applied when the given rule is active.
  102694. *
  102695. * A special case is configuration objects that take arrays, for example
  102696. * xAxis, yAxis or series. For these collections, an `id` option is used to
  102697. * map the new option set to an existing object. If an existing object of
  102698. * the same id is not found, the item of the same indexupdated. So for
  102699. * example, setting `chartOptions` with two series items without an `id`,
  102700. * will cause the existing chart's two series to be updated with respective
  102701. * options.
  102702. */
  102703. chartOptions?: Options;
  102704. /**
  102705. * (Highcharts, Highstock, Highmaps, Gantt) Under which conditions the rule
  102706. * applies.
  102707. */
  102708. condition?: ResponsiveRulesConditionOptions;
  102709. }
  102710. /**
  102711. * (Highcharts) A node in a sankey diagram.
  102712. */
  102713. export interface SankeyNodeObject extends Point {
  102714. /**
  102715. * The color of the auto generated node.
  102716. */
  102717. color: (ColorString|GradientColorObject|PatternObject);
  102718. /**
  102719. * The color index of the auto generated node, especially for use in styled
  102720. * mode.
  102721. */
  102722. colorIndex: number;
  102723. /**
  102724. * An optional column index of where to place the node. The default
  102725. * behaviour is to place it next to the preceding node.
  102726. */
  102727. column: number;
  102728. /**
  102729. * The id of the auto-generated node, refering to the `from` or `to` setting
  102730. * of the link.
  102731. */
  102732. id: string;
  102733. /**
  102734. * (Highcharts) The name to display for the node in data labels and
  102735. * tooltips. Use this when the name is different from the `id`. Where the id
  102736. * must be unique for each node, this is not necessary for the name.
  102737. */
  102738. name: string;
  102739. /**
  102740. * The vertical offset of a node in terms of weight. Positive values shift
  102741. * the node downwards, negative shift it upwards.
  102742. */
  102743. offset: number;
  102744. }
  102745. /**
  102746. * (Highstock, Gantt) The scrollbar is a means of panning over the X axis of a
  102747. * stock chart. Scrollbars can also be applied to other types of axes.
  102748. *
  102749. * Another approach to scrollable charts is the chart.scrollablePlotArea option
  102750. * that is especially suitable for simpler cartesian charts on mobile.
  102751. *
  102752. * In styled mode, all the presentational options for the scrollbar are replaced
  102753. * by the classes `.highcharts-scrollbar-thumb`, `.highcharts-scrollbar-arrow`,
  102754. * `.highcharts-scrollbar-button`, `.highcharts-scrollbar-rifles` and
  102755. * `.highcharts-scrollbar-track`.
  102756. */
  102757. export interface ScrollbarOptions {
  102758. /**
  102759. * (Highstock, Gantt) The background color of the scrollbar itself.
  102760. */
  102761. barBackgroundColor?: (ColorString|GradientColorObject|PatternObject);
  102762. /**
  102763. * (Highstock, Gantt) The color of the scrollbar's border.
  102764. */
  102765. barBorderColor?: (ColorString|GradientColorObject|PatternObject);
  102766. /**
  102767. * (Highstock, Gantt) The border rounding radius of the bar.
  102768. */
  102769. barBorderRadius?: number;
  102770. /**
  102771. * (Highstock, Gantt) The width of the bar's border.
  102772. */
  102773. barBorderWidth?: number;
  102774. /**
  102775. * (Highstock, Gantt) The color of the small arrow inside the scrollbar
  102776. * buttons.
  102777. */
  102778. buttonArrowColor?: (ColorString|GradientColorObject|PatternObject);
  102779. /**
  102780. * (Highstock, Gantt) The color of scrollbar buttons.
  102781. */
  102782. buttonBackgroundColor?: (ColorString|GradientColorObject|PatternObject);
  102783. /**
  102784. * (Highstock, Gantt) The color of the border of the scrollbar buttons.
  102785. */
  102786. buttonBorderColor?: (ColorString|GradientColorObject|PatternObject);
  102787. /**
  102788. * (Highstock, Gantt) The corner radius of the scrollbar buttons.
  102789. */
  102790. buttonBorderRadius?: number;
  102791. /**
  102792. * (Highstock, Gantt) The border width of the scrollbar buttons.
  102793. */
  102794. buttonBorderWidth?: number;
  102795. /**
  102796. * (Highstock, Gantt) Enable or disable the scrollbar.
  102797. */
  102798. enabled?: boolean;
  102799. /**
  102800. * (Highstock, Gantt) The height of the scrollbar. The height also applies
  102801. * to the width of the scroll arrows so that they are always squares.
  102802. * Defaults to 20 for touch devices and 14 for mouse devices.
  102803. */
  102804. height?: number;
  102805. /**
  102806. * (Highstock, Gantt) Whether to redraw the main chart as the scrollbar or
  102807. * the navigator zoomed window is moved. Defaults to `true` for modern
  102808. * browsers and `false` for legacy IE browsers as well as mobile devices.
  102809. */
  102810. liveRedraw?: boolean;
  102811. /**
  102812. * (Highstock, Gantt) The margin between the scrollbar and its axis when the
  102813. * scrollbar is applied directly to an axis.
  102814. */
  102815. margin?: number;
  102816. /**
  102817. * (Highstock, Gantt) The minimum width of the scrollbar.
  102818. */
  102819. minWidth?: number;
  102820. /**
  102821. * (Highstock, Gantt) The color of the small rifles in the middle of the
  102822. * scrollbar.
  102823. */
  102824. rifleColor?: (ColorString|GradientColorObject|PatternObject);
  102825. /**
  102826. * (Highstock, Gantt) Whether to show or hide the scrollbar when the
  102827. * scrolled content is zoomed out to it full extent.
  102828. */
  102829. showFull?: boolean;
  102830. /**
  102831. * (Highstock, Gantt) The color of the track background.
  102832. */
  102833. trackBackgroundColor?: (ColorString|GradientColorObject|PatternObject);
  102834. /**
  102835. * (Highstock, Gantt) The color of the border of the scrollbar track.
  102836. */
  102837. trackBorderColor?: (ColorString|GradientColorObject|PatternObject);
  102838. /**
  102839. * (Highstock, Gantt) The corner radius of the border of the scrollbar
  102840. * track.
  102841. */
  102842. trackBorderRadius?: number;
  102843. /**
  102844. * (Highstock, Gantt) The width of the border of the scrollbar track.
  102845. */
  102846. trackBorderWidth?: number;
  102847. /**
  102848. * (Highstock, Gantt) The z index of the scrollbar group.
  102849. */
  102850. zIndex?: number;
  102851. }
  102852. /**
  102853. * Axis-specific data of a selection.
  102854. */
  102855. export interface SelectDataObject {
  102856. axis: Axis;
  102857. max: number;
  102858. min: number;
  102859. }
  102860. /**
  102861. * Object for select events.
  102862. */
  102863. export interface SelectEventObject {
  102864. originalEvent: Event;
  102865. xAxis: Array<SelectDataObject>;
  102866. yAxis: Array<SelectDataObject>;
  102867. }
  102868. /**
  102869. * (Highstock) An Acceleration bands indicator. If the type option is not
  102870. * specified, it is inherited from chart.type.
  102871. *
  102872. * In TypeScript the type option must always be set.
  102873. *
  102874. * Configuration options for the series are given in three levels:
  102875. *
  102876. * 1. Options for all series in a chart are defined in the plotOptions.series
  102877. * object.
  102878. *
  102879. * 2. Options for all `abands` series are defined in plotOptions.abands.
  102880. *
  102881. * 3. Options for one single series are given in the series instance array. (see
  102882. * online documentation for example)
  102883. *
  102884. * You have to extend the `SeriesAbandsOptions` via an interface to allow custom
  102885. * properties: ``` declare interface SeriesAbandsOptions { customProperty:
  102886. * string; }
  102887. *
  102888. */
  102889. export interface SeriesAbandsOptions extends PlotAbandsOptions, SeriesOptions {
  102890. /**
  102891. * Not available
  102892. */
  102893. dataParser?: undefined;
  102894. /**
  102895. * Not available
  102896. */
  102897. dataURL?: undefined;
  102898. /**
  102899. * (Highcharts, Highstock, Highmaps, Gantt) This property is only in
  102900. * TypeScript non-optional and might be `undefined` in series objects from
  102901. * unknown sources.
  102902. */
  102903. type: "abands";
  102904. }
  102905. /**
  102906. * (Highstock) Keyboard navigation for a series
  102907. */
  102908. export interface SeriesAccessibilityKeyboardNavigationOptionsObject {
  102909. /**
  102910. * (Highstock) Enable/disable keyboard navigation support for a specific
  102911. * series.
  102912. */
  102913. enabled?: boolean;
  102914. }
  102915. /**
  102916. * (Highstock) Accessibility options for a series.
  102917. */
  102918. export interface SeriesAccessibilityOptionsObject {
  102919. /**
  102920. * (Highstock) Provide a description of the series, announced to screen
  102921. * readers.
  102922. */
  102923. description?: string;
  102924. /**
  102925. * (Highstock) Enable/disable accessibility functionality for a specific
  102926. * series.
  102927. */
  102928. enabled?: boolean;
  102929. /**
  102930. * (Highstock) Expose only the series element to screen readers, not its
  102931. * points.
  102932. */
  102933. exposeAsGroupOnly?: boolean;
  102934. /**
  102935. * (Highstock) Keyboard navigation for a series
  102936. */
  102937. keyboardNavigation?: SeriesAccessibilityKeyboardNavigationOptionsObject;
  102938. /**
  102939. * (Highstock) Formatter function to use instead of the default for point
  102940. * descriptions. Same as `accessibility.point.descriptionFormatter`, but for
  102941. * a single series.
  102942. */
  102943. pointDescriptionFormatter?: ScreenReaderFormatterCallbackFunction<Point>;
  102944. }
  102945. /**
  102946. * (Highstock) A `AD` series. If the type option is not specified, it is
  102947. * inherited from chart.type.
  102948. *
  102949. * In TypeScript the type option must always be set.
  102950. *
  102951. * Configuration options for the series are given in three levels:
  102952. *
  102953. * 1. Options for all series in a chart are defined in the plotOptions.series
  102954. * object.
  102955. *
  102956. * 2. Options for all `ad` series are defined in plotOptions.ad.
  102957. *
  102958. * 3. Options for one single series are given in the series instance array. (see
  102959. * online documentation for example)
  102960. *
  102961. * You have to extend the `SeriesAdOptions` via an interface to allow custom
  102962. * properties: ``` declare interface SeriesAdOptions { customProperty: string; }
  102963. *
  102964. */
  102965. export interface SeriesAdOptions extends PlotAdOptions, SeriesOptions {
  102966. /**
  102967. * Not available
  102968. */
  102969. dataParser?: undefined;
  102970. /**
  102971. * Not available
  102972. */
  102973. dataURL?: undefined;
  102974. /**
  102975. * (Highcharts, Highstock, Highmaps, Gantt) This property is only in
  102976. * TypeScript non-optional and might be `undefined` in series objects from
  102977. * unknown sources.
  102978. */
  102979. type: "ad";
  102980. }
  102981. /**
  102982. * Event information regarding completed animation of a series.
  102983. */
  102984. export interface SeriesAfterAnimateEventObject {
  102985. /**
  102986. * Animated series.
  102987. */
  102988. target: Series;
  102989. /**
  102990. * Event type.
  102991. */
  102992. type: "afterAnimate";
  102993. }
  102994. /**
  102995. * (Highstock) An `AO` series. If the type option is not specified, it is
  102996. * inherited from chart.type.
  102997. *
  102998. * In TypeScript the type option must always be set.
  102999. *
  103000. * Configuration options for the series are given in three levels:
  103001. *
  103002. * 1. Options for all series in a chart are defined in the plotOptions.series
  103003. * object.
  103004. *
  103005. * 2. Options for all `ao` series are defined in plotOptions.ao.
  103006. *
  103007. * 3. Options for one single series are given in the series instance array. (see
  103008. * online documentation for example)
  103009. *
  103010. * You have to extend the `SeriesAoOptions` via an interface to allow custom
  103011. * properties: ``` declare interface SeriesAoOptions { customProperty: string; }
  103012. *
  103013. */
  103014. export interface SeriesAoOptions extends PlotAoOptions, SeriesOptions {
  103015. /**
  103016. * Not available
  103017. */
  103018. dataParser?: undefined;
  103019. /**
  103020. * Not available
  103021. */
  103022. dataURL?: undefined;
  103023. /**
  103024. * (Highcharts, Highstock, Highmaps, Gantt) This property is only in
  103025. * TypeScript non-optional and might be `undefined` in series objects from
  103026. * unknown sources.
  103027. */
  103028. type: "ao";
  103029. }
  103030. /**
  103031. * (Highstock) An `Absolute Price Oscillator` series. If the type option is not
  103032. * specified, it is inherited from chart.type.
  103033. *
  103034. * In TypeScript the type option must always be set.
  103035. *
  103036. * Configuration options for the series are given in three levels:
  103037. *
  103038. * 1. Options for all series in a chart are defined in the plotOptions.series
  103039. * object.
  103040. *
  103041. * 2. Options for all `apo` series are defined in plotOptions.apo.
  103042. *
  103043. * 3. Options for one single series are given in the series instance array. (see
  103044. * online documentation for example)
  103045. *
  103046. * You have to extend the `SeriesApoOptions` via an interface to allow custom
  103047. * properties: ``` declare interface SeriesApoOptions { customProperty: string;
  103048. * }
  103049. *
  103050. */
  103051. export interface SeriesApoOptions extends PlotApoOptions, SeriesOptions {
  103052. /**
  103053. * Not available
  103054. */
  103055. dataParser?: undefined;
  103056. /**
  103057. * Not available
  103058. */
  103059. dataURL?: undefined;
  103060. /**
  103061. * (Highcharts, Highstock, Highmaps, Gantt) This property is only in
  103062. * TypeScript non-optional and might be `undefined` in series objects from
  103063. * unknown sources.
  103064. */
  103065. type: "apo";
  103066. }
  103067. /**
  103068. * (Highcharts, Highstock, Gantt) Enable or disable the initial animation when a
  103069. * series is displayed for the `dataLabels`. The animation can also be set as a
  103070. * configuration object. Please note that this option only applies to the
  103071. * initial animation. For other animations, see chart.animation and the
  103072. * animation parameter under the API methods. The following properties are
  103073. * supported:
  103074. *
  103075. * - `defer`: The animation delay time in milliseconds.
  103076. */
  103077. export interface SeriesAreaDataDataLabelsAnimationOptions {
  103078. /**
  103079. * (Highcharts, Highstock, Gantt) The animation delay time in milliseconds.
  103080. * Set to `0` renders dataLabel immediately. As `undefined` inherits defer
  103081. * time from the series.animation.defer.
  103082. */
  103083. defer?: number;
  103084. }
  103085. /**
  103086. * (Highcharts, Highstock) Style options for the guide box. The guide box has
  103087. * one state by default, the `default` state.
  103088. */
  103089. export interface SeriesAreaDataDragDropGuideBoxOptions {
  103090. /**
  103091. * (Highcharts, Highstock) Style options for the guide box default state.
  103092. */
  103093. default?: DragDropGuideBoxOptionsObject;
  103094. }
  103095. /**
  103096. * (Highcharts, Highstock) A `area` series. If the type option is not specified,
  103097. * it is inherited from chart.type.
  103098. *
  103099. * In TypeScript the type option must always be set.
  103100. *
  103101. * Configuration options for the series are given in three levels:
  103102. *
  103103. * 1. Options for all series in a chart are defined in the plotOptions.series
  103104. * object.
  103105. *
  103106. * 2. Options for all `area` series are defined in plotOptions.area.
  103107. *
  103108. * 3. Options for one single series are given in the series instance array. (see
  103109. * online documentation for example)
  103110. *
  103111. * You have to extend the `SeriesAreaOptions` via an interface to allow custom
  103112. * properties: ``` declare interface SeriesAreaOptions { customProperty: string;
  103113. * }
  103114. *
  103115. */
  103116. export interface SeriesAreaOptions extends PlotAreaOptions, SeriesOptions {
  103117. /**
  103118. * (Highcharts, Highstock) An array of data points for the series. For the
  103119. * `area` series type, points can be given in the following ways:
  103120. *
  103121. * 1. An array of numerical values. In this case, the numerical values will
  103122. * be interpreted as `y` options. The `x` values will be automatically
  103123. * calculated, either starting at 0 and incremented by 1, or from
  103124. * `pointStart` * and `pointInterval` given in the series options. If the
  103125. * axis has categories, these will be used. Example: (see online
  103126. * documentation for example)
  103127. *
  103128. * 2. An array of arrays with 2 values. In this case, the values correspond
  103129. * to `x,y`. If the first value is a string, it is applied as the name of
  103130. * the point, and the `x` value is inferred. (see online documentation for
  103131. * example)
  103132. *
  103133. * 3. An array of objects with named values. The following snippet shows
  103134. * only a few settings, see the complete options set below. If the total
  103135. * number of data points exceeds the series' turboThreshold, this option is
  103136. * not available. (see online documentation for example)
  103137. */
  103138. data?: Array<(number|[(number|string), (number|null)]|null|PointOptionsObject)>;
  103139. /**
  103140. * Not available
  103141. */
  103142. dataParser?: undefined;
  103143. /**
  103144. * Not available
  103145. */
  103146. dataURL?: undefined;
  103147. /**
  103148. * (Highcharts, Highstock, Highmaps, Gantt) This property is only in
  103149. * TypeScript non-optional and might be `undefined` in series objects from
  103150. * unknown sources.
  103151. */
  103152. type: "area";
  103153. /**
  103154. * Not available
  103155. */
  103156. useOhlcData?: undefined;
  103157. }
  103158. /**
  103159. * (Highcharts, Highstock) Enable or disable the initial animation when a series
  103160. * is displayed for the `dataLabels`. The animation can also be set as a
  103161. * configuration object. Please note that this option only applies to the
  103162. * initial animation. For other animations, see chart.animation and the
  103163. * animation parameter under the API methods. The following properties are
  103164. * supported:
  103165. *
  103166. * - `defer`: The animation delay time in milliseconds.
  103167. */
  103168. export interface SeriesArearangeDataDataLabelsAnimationOptions {
  103169. /**
  103170. * (Highcharts, Highstock) The animation delay time in milliseconds. Set to
  103171. * `0` renders dataLabel immediately. As `undefined` inherits defer time
  103172. * from the series.animation.defer.
  103173. */
  103174. defer?: number;
  103175. }
  103176. /**
  103177. * (Highcharts, Highstock) Style options for the guide box. The guide box has
  103178. * one state by default, the `default` state.
  103179. */
  103180. export interface SeriesArearangeDataDragDropGuideBoxOptions {
  103181. /**
  103182. * (Highcharts, Highstock) Style options for the guide box default state.
  103183. */
  103184. default?: DragDropGuideBoxOptionsObject;
  103185. }
  103186. /**
  103187. * (Highcharts, Highstock) Extended data labels for range series types. Range
  103188. * series data labels use no `x` and `y` options. Instead, they have `xLow`,
  103189. * `xHigh`, `yLow` and `yHigh` options to allow the higher and lower data label
  103190. * sets individually.
  103191. */
  103192. export interface SeriesAreaRangeDataLabelsOptionsObject {
  103193. /**
  103194. * (Highcharts, Highstock) The alignment of the data label compared to the
  103195. * point. If `right`, the right side of the label should be touching the
  103196. * point. For points with an extent, like columns, the alignments also
  103197. * dictates how to align it inside the box, as given with the inside option.
  103198. * Can be one of `left`, `center` or `right`.
  103199. */
  103200. align?: string;
  103201. /**
  103202. * (Highcharts, Highstock) Whether to allow data labels to overlap. To make
  103203. * the labels less sensitive for overlapping, the dataLabels.padding can be
  103204. * set to 0.
  103205. */
  103206. allowOverlap?: boolean;
  103207. /**
  103208. * (Highcharts, Highstock) Enable or disable the initial animation when a
  103209. * series is displayed for the `dataLabels`. The animation can also be set
  103210. * as a configuration object. Please note that this option only applies to
  103211. * the initial animation. For other animations, see chart.animation and the
  103212. * animation parameter under the API methods. The following properties are
  103213. * supported:
  103214. *
  103215. * - `defer`: The animation delay time in milliseconds.
  103216. */
  103217. animation?: (boolean|PlotArearangeDataLabelsAnimationOptions|PlotAreasplinerangeDataLabelsAnimationOptions|PlotColumnrangeDataLabelsAnimationOptions|PlotDumbbellDataLabelsAnimationOptions|
  103218. PlotLollipopDataLabelsAnimationOptions|Partial<AnimationOptionsObject>);
  103219. /**
  103220. * (Highcharts, Highstock) The background color or gradient for the data
  103221. * label.
  103222. */
  103223. backgroundColor?: (ColorString|GradientColorObject|PatternObject);
  103224. /**
  103225. * (Highcharts, Highstock) The border color for the data label. Defaults to
  103226. * `undefined`.
  103227. */
  103228. borderColor?: (ColorString|GradientColorObject|PatternObject);
  103229. /**
  103230. * (Highcharts, Highstock) The border radius in pixels for the data label.
  103231. */
  103232. borderRadius?: number;
  103233. /**
  103234. * (Highcharts, Highstock) The border width in pixels for the data label.
  103235. */
  103236. borderWidth?: number;
  103237. /**
  103238. * (Highcharts, Highstock) A class name for the data label. Particularly in
  103239. * styled mode, this can be used to give each series' or point's data label
  103240. * unique styling. In addition to this option, a default color class name is
  103241. * added so that we can give the labels a contrast text shadow.
  103242. */
  103243. className?: string;
  103244. /**
  103245. * (Highcharts, Highstock) The text color for the data labels. Defaults to
  103246. * `undefined`. For certain series types, like column or map, the data
  103247. * labels can be drawn inside the points. In this case the data label will
  103248. * be drawn with maximum contrast by default. Additionally, it will be given
  103249. * a `text-outline` style with the opposite color, to further increase the
  103250. * contrast. This can be overridden by setting the `text-outline` style to
  103251. * `none` in the `dataLabels.style` option.
  103252. */
  103253. color?: (ColorString|GradientColorObject|PatternObject);
  103254. /**
  103255. * (Highcharts, Highstock) Whether to hide data labels that are outside the
  103256. * plot area. By default, the data label is moved inside the plot area
  103257. * according to the overflow option.
  103258. */
  103259. crop?: boolean;
  103260. /**
  103261. * (Highcharts, Highstock, Gantt) Whether to defer displaying the data
  103262. * labels until the initial series animation has finished. Setting to
  103263. * `false` renders the data label immediately. If set to `true` inherits the
  103264. * defer time set in plotOptions.series.animation.
  103265. */
  103266. defer?: boolean;
  103267. /**
  103268. * (Highcharts, Highstock) Enable or disable the data labels.
  103269. */
  103270. enabled?: boolean;
  103271. /**
  103272. * (Highcharts, Highstock) A declarative filter to control of which data
  103273. * labels to display. The declarative filter is designed for use when
  103274. * callback functions are not available, like when the chart options require
  103275. * a pure JSON structure or for use with graphical editors. For programmatic
  103276. * control, use the `formatter` instead, and return `undefined` to disable a
  103277. * single data label.
  103278. */
  103279. filter?: DataLabelsFilterOptionsObject;
  103280. /**
  103281. * (Highcharts, Highstock) A format string for the data label. Available
  103282. * variables are the same as for `formatter`.
  103283. */
  103284. format?: string;
  103285. /**
  103286. * (Highcharts, Highstock) Callback JavaScript function to format the data
  103287. * label. Note that if a `format` is defined, the format takes precedence
  103288. * and the formatter is ignored.
  103289. */
  103290. formatter?: DataLabelsFormatterCallbackFunction;
  103291. /**
  103292. * (Highcharts, Highstock) For points with an extent, like columns or map
  103293. * areas, whether to align the data label inside the box or to the actual
  103294. * value point. Defaults to `false` in most cases, `true` in stacked
  103295. * columns.
  103296. */
  103297. inside?: boolean;
  103298. /**
  103299. * (Highcharts, Highstock) Format for points with the value of null. Works
  103300. * analogously to format. `nullFormat` can be applied only to series which
  103301. * support displaying null points.
  103302. */
  103303. nullFormat?: (boolean|string);
  103304. /**
  103305. * (Highcharts, Highstock) Callback JavaScript function that defines
  103306. * formatting for points with the value of null. Works analogously to
  103307. * formatter. `nullPointFormatter` can be applied only to series which
  103308. * support displaying null points.
  103309. */
  103310. nullFormatter?: DataLabelsFormatterCallbackFunction;
  103311. /**
  103312. * (Highcharts, Highstock) How to handle data labels that flow outside the
  103313. * plot area. The default is `"justify"`, which aligns them inside the plot
  103314. * area. For columns and bars, this means it will be moved inside the bar.
  103315. * To display data labels outside the plot area, set `crop` to `false` and
  103316. * `overflow` to `"allow"`.
  103317. */
  103318. overflow?: DataLabelsOverflowValue;
  103319. /**
  103320. * (Highcharts, Highstock) When either the `borderWidth` or the
  103321. * `backgroundColor` is set, this is the padding within the box.
  103322. */
  103323. padding?: number;
  103324. /**
  103325. * (Highcharts, Highstock) Aligns data labels relative to points. If
  103326. * `center` alignment is not possible, it defaults to `right`.
  103327. */
  103328. position?: AlignValue;
  103329. /**
  103330. * (Highcharts, Highstock) Text rotation in degrees. Note that due to a more
  103331. * complex structure, backgrounds, borders and padding will be lost on a
  103332. * rotated data label.
  103333. */
  103334. rotation?: number;
  103335. /**
  103336. * (Highcharts, Highstock) The shadow of the box. Works best with
  103337. * `borderWidth` or `backgroundColor`. Since 2.3 the shadow can be an object
  103338. * configuration containing `color`, `offsetX`, `offsetY`, `opacity` and
  103339. * `width`.
  103340. */
  103341. shadow?: (boolean|ShadowOptionsObject);
  103342. /**
  103343. * (Highcharts, Highstock) The name of a symbol to use for the border around
  103344. * the label. Symbols are predefined functions on the Renderer object.
  103345. */
  103346. shape?: string;
  103347. /**
  103348. * (Highcharts, Highstock) Styles for the label. The default `color` setting
  103349. * is `"contrast"`, which is a pseudo color that Highcharts picks up and
  103350. * applies the maximum contrast to the underlying point item, for example
  103351. * the bar in a bar chart.
  103352. *
  103353. * The `textOutline` is a pseudo property that applies an outline of the
  103354. * given width with the given color, which by default is the maximum
  103355. * contrast to the text. So a bright text color will result in a black text
  103356. * outline for maximum readability on a mixed background. In some cases,
  103357. * especially with grayscale text, the text outline doesn't work well, in
  103358. * which cases it can be disabled by setting it to `"none"`. When `useHTML`
  103359. * is true, the `textOutline` will not be picked up. In this, case, the same
  103360. * effect can be acheived through the `text-shadow` CSS property.
  103361. *
  103362. * For some series types, where each point has an extent, like for example
  103363. * tree maps, the data label may overflow the point. There are two
  103364. * strategies for handling overflow. By default, the text will wrap to
  103365. * multiple lines. The other strategy is to set `style.textOverflow` to
  103366. * `ellipsis`, which will keep the text on one line plus it will break
  103367. * inside long words.
  103368. */
  103369. style?: CSSObject;
  103370. /**
  103371. * (Highcharts, Highstock) Options for a label text which should follow
  103372. * marker's shape. Border and background are disabled for a label that
  103373. * follows a path.
  103374. *
  103375. * **Note:** Only SVG-based renderer supports this option. Setting `useHTML`
  103376. * to true will disable this option.
  103377. */
  103378. textPath?: DataLabelsTextPathOptionsObject;
  103379. /**
  103380. * (Highcharts, Highstock) Whether to use HTML to render the labels.
  103381. */
  103382. useHTML?: boolean;
  103383. /**
  103384. * (Highcharts, Highstock) The vertical alignment of a data label. Can be
  103385. * one of `top`, `middle` or `bottom`. The default value depends on the
  103386. * data, for instance in a column chart, the label is above positive values
  103387. * and below negative values.
  103388. */
  103389. verticalAlign?: string;
  103390. /**
  103391. * (Highcharts, Highstock) The x position offset of the label relative to
  103392. * the point in pixels.
  103393. */
  103394. x?: number;
  103395. /**
  103396. * (Highcharts, Highstock) X offset of the higher data labels relative to
  103397. * the point value.
  103398. */
  103399. xHigh?: number;
  103400. /**
  103401. * (Highcharts, Highstock) X offset of the lower data labels relative to the
  103402. * point value.
  103403. */
  103404. xLow?: number;
  103405. /**
  103406. * (Highcharts, Highstock) The y position offset of the label relative to
  103407. * the point in pixels.
  103408. */
  103409. y?: number;
  103410. /**
  103411. * (Highcharts, Highstock) Y offset of the higher data labels relative to
  103412. * the point value.
  103413. */
  103414. yHigh?: number;
  103415. /**
  103416. * (Highcharts, Highstock) Y offset of the lower data labels relative to the
  103417. * point value.
  103418. */
  103419. yLow?: number;
  103420. /**
  103421. * (Highcharts, Highstock) The Z index of the data labels. The default Z
  103422. * index puts it above the series. Use a Z index of 2 to display it behind
  103423. * the series.
  103424. */
  103425. z?: number;
  103426. }
  103427. /**
  103428. * (Highcharts, Highstock) A `arearange` series. If the type option is not
  103429. * specified, it is inherited from chart.type.
  103430. *
  103431. * In TypeScript the type option must always be set.
  103432. *
  103433. * Configuration options for the series are given in three levels:
  103434. *
  103435. * 1. Options for all series in a chart are defined in the plotOptions.series
  103436. * object.
  103437. *
  103438. * 2. Options for all `arearange` series are defined in plotOptions.arearange.
  103439. *
  103440. * 3. Options for one single series are given in the series instance array. (see
  103441. * online documentation for example)
  103442. *
  103443. * You have to extend the `SeriesArearangeOptions` via an interface to allow
  103444. * custom properties: ``` declare interface SeriesArearangeOptions {
  103445. * customProperty: string; }
  103446. *
  103447. */
  103448. export interface SeriesArearangeOptions extends PlotArearangeOptions, SeriesOptions {
  103449. /**
  103450. * (Highcharts, Highstock) An array of data points for the series. For the
  103451. * `arearange` series type, points can be given in the following ways:
  103452. *
  103453. * 1. An array of arrays with 3 or 2 values. In this case, the values
  103454. * correspond to `x,low,high`. If the first value is a string, it is applied
  103455. * as the name of the point, and the `x` value is inferred. The `x` value
  103456. * can also be omitted, in which case the inner arrays should be of length
  103457. * 2\. Then the `x` value is automatically calculated, either starting at 0
  103458. * and incremented by 1, or from `pointStart` and `pointInterval` given in
  103459. * the series options. (see online documentation for example)
  103460. *
  103461. * 2. An array of objects with named values. The following snippet shows
  103462. * only a few settings, see the complete options set below. If the total
  103463. * number of data points exceeds the series' turboThreshold, this option is
  103464. * not available. (see online documentation for example)
  103465. */
  103466. data?: Array<([(number|string), number]|[(number|string), number, number]|PointOptionsObject)>;
  103467. /**
  103468. * Not available
  103469. */
  103470. dataParser?: undefined;
  103471. /**
  103472. * Not available
  103473. */
  103474. dataURL?: undefined;
  103475. /**
  103476. * Not available
  103477. */
  103478. stack?: undefined;
  103479. /**
  103480. * (Highcharts, Highstock, Highmaps, Gantt) This property is only in
  103481. * TypeScript non-optional and might be `undefined` in series objects from
  103482. * unknown sources.
  103483. */
  103484. type: "arearange";
  103485. }
  103486. /**
  103487. * (Highcharts, Highstock, Gantt) Enable or disable the initial animation when a
  103488. * series is displayed for the `dataLabels`. The animation can also be set as a
  103489. * configuration object. Please note that this option only applies to the
  103490. * initial animation. For other animations, see chart.animation and the
  103491. * animation parameter under the API methods. The following properties are
  103492. * supported:
  103493. *
  103494. * - `defer`: The animation delay time in milliseconds.
  103495. */
  103496. export interface SeriesAreasplineDataDataLabelsAnimationOptions {
  103497. /**
  103498. * (Highcharts, Highstock, Gantt) The animation delay time in milliseconds.
  103499. * Set to `0` renders dataLabel immediately. As `undefined` inherits defer
  103500. * time from the series.animation.defer.
  103501. */
  103502. defer?: number;
  103503. }
  103504. /**
  103505. * (Highcharts, Highstock) Style options for the guide box. The guide box has
  103506. * one state by default, the `default` state.
  103507. */
  103508. export interface SeriesAreasplineDataDragDropGuideBoxOptions {
  103509. /**
  103510. * (Highcharts, Highstock) Style options for the guide box default state.
  103511. */
  103512. default?: DragDropGuideBoxOptionsObject;
  103513. }
  103514. /**
  103515. * (Highcharts, Highstock) A `areaspline` series. If the type option is not
  103516. * specified, it is inherited from chart.type.
  103517. *
  103518. * In TypeScript the type option must always be set.
  103519. *
  103520. * Configuration options for the series are given in three levels:
  103521. *
  103522. * 1. Options for all series in a chart are defined in the plotOptions.series
  103523. * object.
  103524. *
  103525. * 2. Options for all `areaspline` series are defined in plotOptions.areaspline.
  103526. *
  103527. * 3. Options for one single series are given in the series instance array. (see
  103528. * online documentation for example)
  103529. *
  103530. * You have to extend the `SeriesAreasplineOptions` via an interface to allow
  103531. * custom properties: ``` declare interface SeriesAreasplineOptions {
  103532. * customProperty: string; }
  103533. *
  103534. */
  103535. export interface SeriesAreasplineOptions extends PlotAreasplineOptions, SeriesOptions {
  103536. /**
  103537. * (Highcharts, Highstock) An array of data points for the series. For the
  103538. * `areaspline` series type, points can be given in the following ways:
  103539. *
  103540. * 1. An array of numerical values. In this case, the numerical values will
  103541. * be interpreted as `y` options. The `x` values will be automatically
  103542. * calculated, either starting at 0 and incremented by 1, or from
  103543. * `pointStart` and `pointInterval` given in the series options. If the axis
  103544. * has categories, these will be used. Example: (see online documentation
  103545. * for example)
  103546. *
  103547. * 2. An array of arrays with 2 values. In this case, the values correspond
  103548. * to `x,y`. If the first value is a string, it is applied as the name of
  103549. * the point, and the `x` value is inferred. (see online documentation for
  103550. * example)
  103551. *
  103552. * 3. An array of objects with named values. The following snippet shows
  103553. * only a few settings, see the complete options set below. If the total
  103554. * number of data points exceeds the series' turboThreshold, this option is
  103555. * not available. (see online documentation for example)
  103556. */
  103557. data?: Array<(number|[(number|string), (number|null)]|null|PointOptionsObject)>;
  103558. /**
  103559. * Not available
  103560. */
  103561. dataParser?: undefined;
  103562. /**
  103563. * Not available
  103564. */
  103565. dataURL?: undefined;
  103566. /**
  103567. * (Highcharts, Highstock, Highmaps, Gantt) This property is only in
  103568. * TypeScript non-optional and might be `undefined` in series objects from
  103569. * unknown sources.
  103570. */
  103571. type: "areaspline";
  103572. }
  103573. /**
  103574. * (Highcharts, Highstock) Enable or disable the initial animation when a series
  103575. * is displayed for the `dataLabels`. The animation can also be set as a
  103576. * configuration object. Please note that this option only applies to the
  103577. * initial animation. For other animations, see chart.animation and the
  103578. * animation parameter under the API methods. The following properties are
  103579. * supported:
  103580. *
  103581. * - `defer`: The animation delay time in milliseconds.
  103582. */
  103583. export interface SeriesAreasplinerangeDataDataLabelsAnimationOptions {
  103584. /**
  103585. * (Highcharts, Highstock) The animation delay time in milliseconds. Set to
  103586. * `0` renders dataLabel immediately. As `undefined` inherits defer time
  103587. * from the series.animation.defer.
  103588. */
  103589. defer?: number;
  103590. }
  103591. /**
  103592. * (Highcharts, Highstock) Style options for the guide box. The guide box has
  103593. * one state by default, the `default` state.
  103594. */
  103595. export interface SeriesAreasplinerangeDataDragDropGuideBoxOptions {
  103596. /**
  103597. * (Highcharts, Highstock) Style options for the guide box default state.
  103598. */
  103599. default?: DragDropGuideBoxOptionsObject;
  103600. }
  103601. /**
  103602. * (Highcharts, Highstock) A `areasplinerange` series. If the type option is not
  103603. * specified, it is inherited from chart.type.
  103604. *
  103605. * In TypeScript the type option must always be set.
  103606. *
  103607. * Configuration options for the series are given in three levels:
  103608. *
  103609. * 1. Options for all series in a chart are defined in the plotOptions.series
  103610. * object.
  103611. *
  103612. * 2. Options for all `areasplinerange` series are defined in
  103613. * plotOptions.areasplinerange.
  103614. *
  103615. * 3. Options for one single series are given in the series instance array. (see
  103616. * online documentation for example)
  103617. *
  103618. * You have to extend the `SeriesAreasplinerangeOptions` via an interface to
  103619. * allow custom properties: ``` declare interface SeriesAreasplinerangeOptions {
  103620. * customProperty: string; }
  103621. *
  103622. */
  103623. export interface SeriesAreasplinerangeOptions extends PlotAreasplinerangeOptions, SeriesOptions {
  103624. /**
  103625. * (Highcharts, Highstock) An array of data points for the series. For the
  103626. * `areasplinerange` series type, points can be given in the following ways:
  103627. *
  103628. * 1. An array of arrays with 3 or 2 values. In this case, the values
  103629. * correspond to `x,low,high`. If the first value is a string, it is applied
  103630. * as the name of the point, and the `x` value is inferred. The `x` value
  103631. * can also be omitted, in which case the inner arrays should be of length
  103632. * 2\. Then the `x` value is automatically calculated, either starting at 0
  103633. * and incremented by 1, or from `pointStart` and `pointInterval` given in
  103634. * the series options. (see online documentation for example)
  103635. *
  103636. * 2. An array of objects with named values. The following snippet shows
  103637. * only a few settings, see the complete options set below. If the total
  103638. * number of data points exceeds the series' turboThreshold, this option is
  103639. * not available. (see online documentation for example)
  103640. */
  103641. data?: Array<([(number|string), number]|[(number|string), number, number]|PointOptionsObject)>;
  103642. /**
  103643. * Not available
  103644. */
  103645. dataParser?: undefined;
  103646. /**
  103647. * Not available
  103648. */
  103649. dataURL?: undefined;
  103650. /**
  103651. * Not available
  103652. */
  103653. stack?: undefined;
  103654. /**
  103655. * (Highcharts, Highstock, Highmaps, Gantt) This property is only in
  103656. * TypeScript non-optional and might be `undefined` in series objects from
  103657. * unknown sources.
  103658. */
  103659. type: "areasplinerange";
  103660. }
  103661. /**
  103662. * (Highstock) A Aroon indicator. If the type option is not specified, it is
  103663. * inherited from chart.type.
  103664. *
  103665. * In TypeScript the type option must always be set.
  103666. *
  103667. * Configuration options for the series are given in three levels:
  103668. *
  103669. * 1. Options for all series in a chart are defined in the plotOptions.series
  103670. * object.
  103671. *
  103672. * 2. Options for all `aroon` series are defined in plotOptions.aroon.
  103673. *
  103674. * 3. Options for one single series are given in the series instance array. (see
  103675. * online documentation for example)
  103676. *
  103677. * You have to extend the `SeriesAroonOptions` via an interface to allow custom
  103678. * properties: ``` declare interface SeriesAroonOptions { customProperty:
  103679. * string; }
  103680. *
  103681. */
  103682. export interface SeriesAroonOptions extends PlotAroonOptions, SeriesOptions {
  103683. /**
  103684. * Not available
  103685. */
  103686. dataParser?: undefined;
  103687. /**
  103688. * Not available
  103689. */
  103690. dataURL?: undefined;
  103691. /**
  103692. * (Highcharts, Highstock, Highmaps, Gantt) This property is only in
  103693. * TypeScript non-optional and might be `undefined` in series objects from
  103694. * unknown sources.
  103695. */
  103696. type: "aroon";
  103697. }
  103698. /**
  103699. * (Highstock) An `Aroon Oscillator` series. If the type option is not
  103700. * specified, it is inherited from chart.type.
  103701. *
  103702. * In TypeScript the type option must always be set.
  103703. *
  103704. * Configuration options for the series are given in three levels:
  103705. *
  103706. * 1. Options for all series in a chart are defined in the plotOptions.series
  103707. * object.
  103708. *
  103709. * 2. Options for all `aroonoscillator` series are defined in
  103710. * plotOptions.aroonoscillator.
  103711. *
  103712. * 3. Options for one single series are given in the series instance array. (see
  103713. * online documentation for example)
  103714. *
  103715. * You have to extend the `SeriesAroonoscillatorOptions` via an interface to
  103716. * allow custom properties: ``` declare interface SeriesAroonoscillatorOptions {
  103717. * customProperty: string; }
  103718. *
  103719. */
  103720. export interface SeriesAroonoscillatorOptions extends PlotAroonoscillatorOptions, SeriesOptions {
  103721. /**
  103722. * Not available
  103723. */
  103724. aroonDown?: undefined;
  103725. /**
  103726. * Not available
  103727. */
  103728. dataParser?: undefined;
  103729. /**
  103730. * Not available
  103731. */
  103732. dataURL?: undefined;
  103733. /**
  103734. * (Highcharts, Highstock, Highmaps, Gantt) This property is only in
  103735. * TypeScript non-optional and might be `undefined` in series objects from
  103736. * unknown sources.
  103737. */
  103738. type: "aroonoscillator";
  103739. }
  103740. /**
  103741. * (Highstock) A `ATR` series. If the type option is not specified, it is
  103742. * inherited from chart.type.
  103743. *
  103744. * In TypeScript the type option must always be set.
  103745. *
  103746. * Configuration options for the series are given in three levels:
  103747. *
  103748. * 1. Options for all series in a chart are defined in the plotOptions.series
  103749. * object.
  103750. *
  103751. * 2. Options for all `atr` series are defined in plotOptions.atr.
  103752. *
  103753. * 3. Options for one single series are given in the series instance array. (see
  103754. * online documentation for example)
  103755. *
  103756. * You have to extend the `SeriesAtrOptions` via an interface to allow custom
  103757. * properties: ``` declare interface SeriesAtrOptions { customProperty: string;
  103758. * }
  103759. *
  103760. */
  103761. export interface SeriesAtrOptions extends PlotAtrOptions, SeriesOptions {
  103762. /**
  103763. * Not available
  103764. */
  103765. dataParser?: undefined;
  103766. /**
  103767. * Not available
  103768. */
  103769. dataURL?: undefined;
  103770. /**
  103771. * (Highcharts, Highstock, Highmaps, Gantt) This property is only in
  103772. * TypeScript non-optional and might be `undefined` in series objects from
  103773. * unknown sources.
  103774. */
  103775. type: "atr";
  103776. }
  103777. /**
  103778. * (Highcharts, Highstock, Gantt) Enable or disable the initial animation when a
  103779. * series is displayed for the `dataLabels`. The animation can also be set as a
  103780. * configuration object. Please note that this option only applies to the
  103781. * initial animation. For other animations, see chart.animation and the
  103782. * animation parameter under the API methods. The following properties are
  103783. * supported:
  103784. *
  103785. * - `defer`: The animation delay time in milliseconds.
  103786. */
  103787. export interface SeriesBarDataDataLabelsAnimationOptions {
  103788. /**
  103789. * (Highcharts, Highstock, Gantt) The animation delay time in milliseconds.
  103790. * Set to `0` renders dataLabel immediately. As `undefined` inherits defer
  103791. * time from the series.animation.defer.
  103792. */
  103793. defer?: number;
  103794. }
  103795. /**
  103796. * (Highcharts) Style options for the guide box. The guide box has one state by
  103797. * default, the `default` state.
  103798. */
  103799. export interface SeriesBarDataDragDropGuideBoxOptions {
  103800. /**
  103801. * (Highcharts) Style options for the guide box default state.
  103802. */
  103803. default?: DragDropGuideBoxOptionsObject;
  103804. }
  103805. /**
  103806. * (Highcharts) A `bar` series. If the type option is not specified, it is
  103807. * inherited from chart.type.
  103808. *
  103809. * In TypeScript the type option must always be set.
  103810. *
  103811. * Configuration options for the series are given in three levels:
  103812. *
  103813. * 1. Options for all series in a chart are defined in the plotOptions.series
  103814. * object.
  103815. *
  103816. * 2. Options for all `bar` series are defined in plotOptions.bar.
  103817. *
  103818. * 3. Options for one single series are given in the series instance array. (see
  103819. * online documentation for example)
  103820. *
  103821. * You have to extend the `SeriesBarOptions` via an interface to allow custom
  103822. * properties: ``` declare interface SeriesBarOptions { customProperty: string;
  103823. * }
  103824. *
  103825. */
  103826. export interface SeriesBarOptions extends PlotBarOptions, SeriesOptions {
  103827. /**
  103828. * (Highcharts) An array of data points for the series. For the `bar` series
  103829. * type, points can be given in the following ways:
  103830. *
  103831. * 1. An array of numerical values. In this case, the numerical values will
  103832. * be interpreted as `y` options. The `x` values will be automatically
  103833. * calculated, either starting at 0 and incremented by 1, or from
  103834. * `pointStart` and `pointInterval` given in the series options. If the axis
  103835. * has categories, these will be used. Example: (see online documentation
  103836. * for example)
  103837. *
  103838. * 2. An array of arrays with 2 values. In this case, the values correspond
  103839. * to `x,y`. If the first value is a string, it is applied as the name of
  103840. * the point, and the `x` value is inferred. (see online documentation for
  103841. * example)
  103842. *
  103843. * 3. An array of objects with named values. The following snippet shows
  103844. * only a few settings, see the complete options set below. If the total
  103845. * number of data points exceeds the series' turboThreshold, this option is
  103846. * not available. (see online documentation for example)
  103847. */
  103848. data?: Array<(number|[(number|string), (number|null)]|null|PointOptionsObject)>;
  103849. /**
  103850. * Not available
  103851. */
  103852. dataParser?: undefined;
  103853. /**
  103854. * Not available
  103855. */
  103856. dataURL?: undefined;
  103857. /**
  103858. * (Highcharts, Highstock, Highmaps, Gantt) This property is only in
  103859. * TypeScript non-optional and might be `undefined` in series objects from
  103860. * unknown sources.
  103861. */
  103862. type: "bar";
  103863. }
  103864. /**
  103865. * (Highstock) A bollinger bands indicator. If the type option is not specified,
  103866. * it is inherited from chart.type.
  103867. *
  103868. * In TypeScript the type option must always be set.
  103869. *
  103870. * Configuration options for the series are given in three levels:
  103871. *
  103872. * 1. Options for all series in a chart are defined in the plotOptions.series
  103873. * object.
  103874. *
  103875. * 2. Options for all `bb` series are defined in plotOptions.bb.
  103876. *
  103877. * 3. Options for one single series are given in the series instance array. (see
  103878. * online documentation for example)
  103879. *
  103880. * You have to extend the `SeriesBbOptions` via an interface to allow custom
  103881. * properties: ``` declare interface SeriesBbOptions { customProperty: string; }
  103882. *
  103883. */
  103884. export interface SeriesBbOptions extends PlotBbOptions, SeriesOptions {
  103885. /**
  103886. * Not available
  103887. */
  103888. dataParser?: undefined;
  103889. /**
  103890. * Not available
  103891. */
  103892. dataURL?: undefined;
  103893. /**
  103894. * (Highcharts, Highstock, Highmaps, Gantt) This property is only in
  103895. * TypeScript non-optional and might be `undefined` in series objects from
  103896. * unknown sources.
  103897. */
  103898. type: "bb";
  103899. }
  103900. /**
  103901. * (Highcharts) A `bellcurve` series. If the type option is not specified, it is
  103902. * inherited from chart.type.
  103903. *
  103904. * For options that apply to multiple series, it is recommended to add them to
  103905. * the plotOptions.series options structure. To apply to all series of this
  103906. * specific type, apply it to plotOptions.bellcurve.
  103907. *
  103908. * In TypeScript the type option must always be set.
  103909. *
  103910. * Configuration options for the series are given in three levels:
  103911. *
  103912. * 1. Options for all series in a chart are defined in the plotOptions.series
  103913. * object.
  103914. *
  103915. * 2. Options for all `bellcurve` series are defined in plotOptions.bellcurve.
  103916. *
  103917. * 3. Options for one single series are given in the series instance array. (see
  103918. * online documentation for example)
  103919. *
  103920. * You have to extend the `SeriesBellcurveOptions` via an interface to allow
  103921. * custom properties: ``` declare interface SeriesBellcurveOptions {
  103922. * customProperty: string; }
  103923. *
  103924. */
  103925. export interface SeriesBellcurveOptions extends PlotBellcurveOptions, SeriesOptions {
  103926. /**
  103927. * (Highcharts) An integer identifying the index to use for the base series,
  103928. * or a string representing the id of the series.
  103929. */
  103930. baseSeries?: (number|string);
  103931. /**
  103932. * Not available
  103933. */
  103934. data?: undefined;
  103935. /**
  103936. * Not available
  103937. */
  103938. dataParser?: undefined;
  103939. /**
  103940. * Not available
  103941. */
  103942. dataURL?: undefined;
  103943. /**
  103944. * (Highcharts, Highstock, Highmaps, Gantt) This property is only in
  103945. * TypeScript non-optional and might be `undefined` in series objects from
  103946. * unknown sources.
  103947. */
  103948. type: "bellcurve";
  103949. }
  103950. /**
  103951. * (Highcharts, Highstock, Gantt) Enable or disable the initial animation when a
  103952. * series is displayed for the `dataLabels`. The animation can also be set as a
  103953. * configuration object. Please note that this option only applies to the
  103954. * initial animation. For other animations, see chart.animation and the
  103955. * animation parameter under the API methods. The following properties are
  103956. * supported:
  103957. *
  103958. * - `defer`: The animation delay time in milliseconds.
  103959. */
  103960. export interface SeriesBoxplotDataDataLabelsAnimationOptions {
  103961. /**
  103962. * (Highcharts, Highstock, Gantt) The animation delay time in milliseconds.
  103963. * Set to `0` renders dataLabel immediately. As `undefined` inherits defer
  103964. * time from the series.animation.defer.
  103965. */
  103966. defer?: number;
  103967. }
  103968. /**
  103969. * (Highcharts) Style options for the guide box. The guide box has one state by
  103970. * default, the `default` state.
  103971. */
  103972. export interface SeriesBoxplotDataDragDropGuideBoxOptions {
  103973. /**
  103974. * (Highcharts) Style options for the guide box default state.
  103975. */
  103976. default?: DragDropGuideBoxOptionsObject;
  103977. }
  103978. /**
  103979. * (Highcharts) A `boxplot` series. If the type option is not specified, it is
  103980. * inherited from chart.type.
  103981. *
  103982. * In TypeScript the type option must always be set.
  103983. *
  103984. * Configuration options for the series are given in three levels:
  103985. *
  103986. * 1. Options for all series in a chart are defined in the plotOptions.series
  103987. * object.
  103988. *
  103989. * 2. Options for all `boxplot` series are defined in plotOptions.boxplot.
  103990. *
  103991. * 3. Options for one single series are given in the series instance array. (see
  103992. * online documentation for example)
  103993. *
  103994. * You have to extend the `SeriesBoxplotOptions` via an interface to allow
  103995. * custom properties: ``` declare interface SeriesBoxplotOptions {
  103996. * customProperty: string; }
  103997. *
  103998. */
  103999. export interface SeriesBoxplotOptions extends PlotBoxplotOptions, SeriesOptions {
  104000. /**
  104001. * (Highcharts) An array of data points for the series. For the `boxplot`
  104002. * series type, points can be given in the following ways:
  104003. *
  104004. * 1. An array of arrays with 6 or 5 values. In this case, the values
  104005. * correspond to `x,low,q1,median,q3,high`. If the first value is a string,
  104006. * it is applied as the name of the point, and the `x` value is inferred.
  104007. * The `x` value can also be omitted, in which case the inner arrays should
  104008. * be of length 5. Then the `x` value is automatically calculated, either
  104009. * starting at 0 and incremented by 1, or from `pointStart` and
  104010. * `pointInterval` given in the series options. (see online documentation
  104011. * for example)
  104012. *
  104013. * 2. An array of objects with named values. The following snippet shows
  104014. * only a few settings, see the complete options set below. If the total
  104015. * number of data points exceeds the series' turboThreshold, this option is
  104016. * not available. (see online documentation for example)
  104017. */
  104018. data?: Array<([(number|string), number, number, number, number]|[(number|string), number, number, number, number, number]|PointOptionsObject)>;
  104019. /**
  104020. * Not available
  104021. */
  104022. dataParser?: undefined;
  104023. /**
  104024. * Not available
  104025. */
  104026. dataURL?: undefined;
  104027. /**
  104028. * Not available
  104029. */
  104030. stack?: undefined;
  104031. /**
  104032. * (Highcharts, Highstock, Highmaps, Gantt) This property is only in
  104033. * TypeScript non-optional and might be `undefined` in series objects from
  104034. * unknown sources.
  104035. */
  104036. type: "boxplot";
  104037. }
  104038. /**
  104039. * (Highcharts, Highstock, Gantt) Enable or disable the initial animation when a
  104040. * series is displayed for the `dataLabels`. The animation can also be set as a
  104041. * configuration object. Please note that this option only applies to the
  104042. * initial animation. For other animations, see chart.animation and the
  104043. * animation parameter under the API methods. The following properties are
  104044. * supported:
  104045. *
  104046. * - `defer`: The animation delay time in milliseconds.
  104047. */
  104048. export interface SeriesBubbleDataDataLabelsAnimationOptions {
  104049. /**
  104050. * (Highcharts, Highstock, Gantt) The animation delay time in milliseconds.
  104051. * Set to `0` renders dataLabel immediately. As `undefined` inherits defer
  104052. * time from the series.animation.defer.
  104053. */
  104054. defer?: number;
  104055. }
  104056. /**
  104057. * (Highcharts) Style options for the guide box. The guide box has one state by
  104058. * default, the `default` state.
  104059. */
  104060. export interface SeriesBubbleDataDragDropGuideBoxOptions {
  104061. /**
  104062. * (Highcharts) Style options for the guide box default state.
  104063. */
  104064. default?: DragDropGuideBoxOptionsObject;
  104065. }
  104066. /**
  104067. * (Highcharts, Highstock) A `bubble` series. If the type option is not
  104068. * specified, it is inherited from chart.type.
  104069. *
  104070. * In TypeScript the type option must always be set.
  104071. *
  104072. * Configuration options for the series are given in three levels:
  104073. *
  104074. * 1. Options for all series in a chart are defined in the plotOptions.series
  104075. * object.
  104076. *
  104077. * 2. Options for all `bubble` series are defined in plotOptions.bubble.
  104078. *
  104079. * 3. Options for one single series are given in the series instance array. (see
  104080. * online documentation for example)
  104081. *
  104082. * You have to extend the `SeriesBubbleOptions` via an interface to allow custom
  104083. * properties: ``` declare interface SeriesBubbleOptions { customProperty:
  104084. * string; }
  104085. *
  104086. */
  104087. export interface SeriesBubbleOptions extends PlotBubbleOptions, SeriesOptions {
  104088. /**
  104089. * (Highcharts) An array of data points for the series. For the `bubble`
  104090. * series type, points can be given in the following ways:
  104091. *
  104092. * 1. An array of arrays with 3 or 2 values. In this case, the values
  104093. * correspond to `x,y,z`. If the first value is a string, it is applied as
  104094. * the name of the point, and the `x` value is inferred. The `x` value can
  104095. * also be omitted, in which case the inner arrays should be of length 2\.
  104096. * Then the `x` value is automatically calculated, either starting at 0 and
  104097. * incremented by 1, or from `pointStart` and `pointInterval` given in the
  104098. * series options. (see online documentation for example)
  104099. *
  104100. * 2. An array of objects with named values. The following snippet shows
  104101. * only a few settings, see the complete options set below. If the total
  104102. * number of data points exceeds the series' turboThreshold, this option is
  104103. * not available. (see online documentation for example)
  104104. */
  104105. data?: Array<([(number|string), number]|[(number|string), number, number]|PointOptionsObject)>;
  104106. /**
  104107. * Not available
  104108. */
  104109. dataParser?: undefined;
  104110. /**
  104111. * Not available
  104112. */
  104113. dataURL?: undefined;
  104114. /**
  104115. * Not available
  104116. */
  104117. stack?: undefined;
  104118. /**
  104119. * (Highcharts, Highstock, Highmaps, Gantt) This property is only in
  104120. * TypeScript non-optional and might be `undefined` in series objects from
  104121. * unknown sources.
  104122. */
  104123. type: "bubble";
  104124. }
  104125. /**
  104126. * (Highcharts, Highstock, Gantt) Enable or disable the initial animation when a
  104127. * series is displayed for the `dataLabels`. The animation can also be set as a
  104128. * configuration object. Please note that this option only applies to the
  104129. * initial animation. For other animations, see chart.animation and the
  104130. * animation parameter under the API methods. The following properties are
  104131. * supported:
  104132. *
  104133. * - `defer`: The animation delay time in milliseconds.
  104134. */
  104135. export interface SeriesBulletDataDataLabelsAnimationOptions {
  104136. /**
  104137. * (Highcharts, Highstock, Gantt) The animation delay time in milliseconds.
  104138. * Set to `0` renders dataLabel immediately. As `undefined` inherits defer
  104139. * time from the series.animation.defer.
  104140. */
  104141. defer?: number;
  104142. }
  104143. /**
  104144. * (Highcharts) Style options for the guide box. The guide box has one state by
  104145. * default, the `default` state.
  104146. */
  104147. export interface SeriesBulletDataDragDropGuideBoxOptions {
  104148. /**
  104149. * (Highcharts) Style options for the guide box default state.
  104150. */
  104151. default?: DragDropGuideBoxOptionsObject;
  104152. }
  104153. /**
  104154. * (Highcharts) Individual target options for each point.
  104155. */
  104156. export interface SeriesBulletDataTargetOptions {
  104157. /**
  104158. * (Highcharts) The border color of the rectangle representing the target.
  104159. * When not set, the point's border color is used.
  104160. *
  104161. * In styled mode, use class `highcharts-bullet-target` instead.
  104162. */
  104163. borderColor?: ColorString;
  104164. /**
  104165. * (Highcharts) The border width of the rectangle representing the target.
  104166. *
  104167. * In styled mode, use class `highcharts-bullet-target` instead.
  104168. */
  104169. borderWidth?: number;
  104170. /**
  104171. * (Highcharts) The color of the rectangle representing the target. When not
  104172. * set, point's color (if set in point's options - `color`) or zone of the
  104173. * target value (if `zones` or `negativeColor` are set) or the same color as
  104174. * the point has is used.
  104175. *
  104176. * In styled mode, use class `highcharts-bullet-target` instead.
  104177. */
  104178. color?: (ColorString|GradientColorObject|PatternObject);
  104179. /**
  104180. * (Highcharts) The height of the rectangle representing the target.
  104181. */
  104182. height?: number;
  104183. /**
  104184. * (Highcharts) The width of the rectangle representing the target. Could be
  104185. * set as a pixel value or as a percentage of a column width.
  104186. */
  104187. width?: (number|string);
  104188. }
  104189. /**
  104190. * (Highcharts) A `bullet` series. If the type option is not specified, it is
  104191. * inherited from chart.type.
  104192. *
  104193. * In TypeScript the type option must always be set.
  104194. *
  104195. * Configuration options for the series are given in three levels:
  104196. *
  104197. * 1. Options for all series in a chart are defined in the plotOptions.series
  104198. * object.
  104199. *
  104200. * 2. Options for all `bullet` series are defined in plotOptions.bullet.
  104201. *
  104202. * 3. Options for one single series are given in the series instance array. (see
  104203. * online documentation for example)
  104204. *
  104205. * You have to extend the `SeriesBulletOptions` via an interface to allow custom
  104206. * properties: ``` declare interface SeriesBulletOptions { customProperty:
  104207. * string; }
  104208. *
  104209. */
  104210. export interface SeriesBulletOptions extends PlotBulletOptions, SeriesOptions {
  104211. /**
  104212. * (Highcharts) An array of data points for the series. For the `bullet`
  104213. * series type, points can be given in the following ways:
  104214. *
  104215. * 1. An array of arrays with 3 or 2 values. In this case, the values
  104216. * correspond to `x,y,target`. If the first value is a string, it is applied
  104217. * as the name of the point, and the `x` value is inferred. The `x` value
  104218. * can also be omitted, in which case the inner arrays should be of length
  104219. * 2\. Then the `x` value is automatically calculated, either starting at 0
  104220. * and incremented by 1, or from `pointStart` and `pointInterval` given in
  104221. * the series options. (see online documentation for example)
  104222. *
  104223. * 2. An array of objects with named values. The following snippet shows
  104224. * only a few settings, see the complete options set below. If the total
  104225. * number of data points exceeds the series' turboThreshold, this option is
  104226. * not available. (see online documentation for example)
  104227. */
  104228. data?: Array<([(number|string), number]|[(number|string), number, number]|PointOptionsObject)>;
  104229. /**
  104230. * Not available
  104231. */
  104232. dataParser?: undefined;
  104233. /**
  104234. * Not available
  104235. */
  104236. dataURL?: undefined;
  104237. /**
  104238. * (Highcharts, Highstock, Highmaps, Gantt) This property is only in
  104239. * TypeScript non-optional and might be `undefined` in series objects from
  104240. * unknown sources.
  104241. */
  104242. type: "bullet";
  104243. }
  104244. /**
  104245. * (Highcharts, Highstock) Enable or disable the initial animation when a series
  104246. * is displayed for the `dataLabels`. The animation can also be set as a
  104247. * configuration object. Please note that this option only applies to the
  104248. * initial animation. For other animations, see chart.animation and the
  104249. * animation parameter under the API methods. The following properties are
  104250. * supported:
  104251. *
  104252. * - `defer`: The animation delay time in milliseconds.
  104253. */
  104254. export interface SeriesCandlestickDataDataLabelsAnimationOptions {
  104255. /**
  104256. * (Highcharts, Highstock) The animation delay time in milliseconds. Set to
  104257. * `0` renders dataLabel immediately. As `undefined` inherits defer time
  104258. * from the series.animation.defer.
  104259. */
  104260. defer?: number;
  104261. }
  104262. /**
  104263. * (Highstock) Style options for the guide box. The guide box has one state by
  104264. * default, the `default` state.
  104265. */
  104266. export interface SeriesCandlestickDataDragDropGuideBoxOptions {
  104267. /**
  104268. * (Highstock) Style options for the guide box default state.
  104269. */
  104270. default?: DragDropGuideBoxOptionsObject;
  104271. }
  104272. /**
  104273. * (Highstock) A `candlestick` series. If the type option is not specified, it
  104274. * is inherited from chart.type.
  104275. *
  104276. * In TypeScript the type option must always be set.
  104277. *
  104278. * Configuration options for the series are given in three levels:
  104279. *
  104280. * 1. Options for all series in a chart are defined in the plotOptions.series
  104281. * object.
  104282. *
  104283. * 2. Options for all `candlestick` series are defined in
  104284. * plotOptions.candlestick.
  104285. *
  104286. * 3. Options for one single series are given in the series instance array. (see
  104287. * online documentation for example)
  104288. *
  104289. * You have to extend the `SeriesCandlestickOptions` via an interface to allow
  104290. * custom properties: ``` declare interface SeriesCandlestickOptions {
  104291. * customProperty: string; }
  104292. *
  104293. */
  104294. export interface SeriesCandlestickOptions extends PlotCandlestickOptions, SeriesOptions {
  104295. /**
  104296. * (Highstock) An array of data points for the series. For the `candlestick`
  104297. * series type, points can be given in the following ways:
  104298. *
  104299. * 1. An array of arrays with 5 or 4 values. In this case, the values
  104300. * correspond to `x,open,high,low,close`. If the first value is a string, it
  104301. * is applied as the name of the point, and the `x` value is inferred. The
  104302. * `x` value can also be omitted, in which case the inner arrays should be
  104303. * of length 4. Then the `x` value is automatically calculated, either
  104304. * starting at 0 and incremented by 1, or from `pointStart` and
  104305. * `pointInterval` given in the series options. (see online documentation
  104306. * for example)
  104307. *
  104308. * 2. An array of objects with named values. The following snippet shows
  104309. * only a few settings, see the complete options set below. If the total
  104310. * number of data points exceeds the series' turboThreshold, this option is
  104311. * not available. (see online documentation for example)
  104312. */
  104313. data?: Array<([(number|string), number, number, number]|[(number|string), number, number, number, number]|PointOptionsObject)>;
  104314. /**
  104315. * Not available
  104316. */
  104317. dataParser?: undefined;
  104318. /**
  104319. * Not available
  104320. */
  104321. dataURL?: undefined;
  104322. /**
  104323. * (Highcharts, Highstock, Highmaps, Gantt) This property is only in
  104324. * TypeScript non-optional and might be `undefined` in series objects from
  104325. * unknown sources.
  104326. */
  104327. type: "candlestick";
  104328. }
  104329. /**
  104330. * (Highstock) A `CCI` series. If the type option is not specified, it is
  104331. * inherited from chart.type.
  104332. *
  104333. * In TypeScript the type option must always be set.
  104334. *
  104335. * Configuration options for the series are given in three levels:
  104336. *
  104337. * 1. Options for all series in a chart are defined in the plotOptions.series
  104338. * object.
  104339. *
  104340. * 2. Options for all `cci` series are defined in plotOptions.cci.
  104341. *
  104342. * 3. Options for one single series are given in the series instance array. (see
  104343. * online documentation for example)
  104344. *
  104345. * You have to extend the `SeriesCciOptions` via an interface to allow custom
  104346. * properties: ``` declare interface SeriesCciOptions { customProperty: string;
  104347. * }
  104348. *
  104349. */
  104350. export interface SeriesCciOptions extends PlotCciOptions, SeriesOptions {
  104351. /**
  104352. * Not available
  104353. */
  104354. dataParser?: undefined;
  104355. /**
  104356. * Not available
  104357. */
  104358. dataURL?: undefined;
  104359. /**
  104360. * (Highcharts, Highstock, Highmaps, Gantt) This property is only in
  104361. * TypeScript non-optional and might be `undefined` in series objects from
  104362. * unknown sources.
  104363. */
  104364. type: "cci";
  104365. }
  104366. /**
  104367. * (Highstock) A `Chaikin Oscillator` series. If the type option is not
  104368. * specified, it is inherited from chart.type.
  104369. *
  104370. * In TypeScript the type option must always be set.
  104371. *
  104372. * Configuration options for the series are given in three levels:
  104373. *
  104374. * 1. Options for all series in a chart are defined in the plotOptions.series
  104375. * object.
  104376. *
  104377. * 2. Options for all `chaikin` series are defined in plotOptions.chaikin.
  104378. *
  104379. * 3. Options for one single series are given in the series instance array. (see
  104380. * online documentation for example)
  104381. *
  104382. * You have to extend the `SeriesChaikinOptions` via an interface to allow
  104383. * custom properties: ``` declare interface SeriesChaikinOptions {
  104384. * customProperty: string; }
  104385. *
  104386. */
  104387. export interface SeriesChaikinOptions extends PlotChaikinOptions, SeriesOptions {
  104388. /**
  104389. * Not available
  104390. */
  104391. dataParser?: undefined;
  104392. /**
  104393. * Not available
  104394. */
  104395. dataURL?: undefined;
  104396. /**
  104397. * (Highcharts, Highstock, Highmaps, Gantt) This property is only in
  104398. * TypeScript non-optional and might be `undefined` in series objects from
  104399. * unknown sources.
  104400. */
  104401. type: "chaikin";
  104402. }
  104403. /**
  104404. * Event information regarding check of a series box.
  104405. */
  104406. export interface SeriesCheckboxClickEventObject {
  104407. /**
  104408. * Whether the box has been checked.
  104409. */
  104410. checked: boolean;
  104411. /**
  104412. * Related series.
  104413. */
  104414. item: Series;
  104415. /**
  104416. * Related series.
  104417. */
  104418. target: Series;
  104419. /**
  104420. * Event type.
  104421. */
  104422. type: "checkboxClick";
  104423. }
  104424. /**
  104425. * Common information for a click event on a series.
  104426. */
  104427. export interface SeriesClickEventObject extends Event {
  104428. /**
  104429. * Nearest point on the graph.
  104430. */
  104431. point: Point;
  104432. }
  104433. /**
  104434. * (Highstock) A `CMF` series. If the type option is not specified, it is
  104435. * inherited from chart.type.
  104436. *
  104437. * In TypeScript the type option must always be set.
  104438. *
  104439. * Configuration options for the series are given in three levels:
  104440. *
  104441. * 1. Options for all series in a chart are defined in the plotOptions.series
  104442. * object.
  104443. *
  104444. * 2. Options for all `cmf` series are defined in plotOptions.cmf.
  104445. *
  104446. * 3. Options for one single series are given in the series instance array. (see
  104447. * online documentation for example)
  104448. *
  104449. * You have to extend the `SeriesCmfOptions` via an interface to allow custom
  104450. * properties: ``` declare interface SeriesCmfOptions { customProperty: string;
  104451. * }
  104452. *
  104453. */
  104454. export interface SeriesCmfOptions extends PlotCmfOptions, SeriesOptions {
  104455. /**
  104456. * Not available
  104457. */
  104458. dataParser?: undefined;
  104459. /**
  104460. * Not available
  104461. */
  104462. dataURL?: undefined;
  104463. /**
  104464. * (Highcharts, Highstock, Highmaps, Gantt) This property is only in
  104465. * TypeScript non-optional and might be `undefined` in series objects from
  104466. * unknown sources.
  104467. */
  104468. type: "cmf";
  104469. }
  104470. /**
  104471. * (Highcharts, Highstock, Gantt) Enable or disable the initial animation when a
  104472. * series is displayed for the `dataLabels`. The animation can also be set as a
  104473. * configuration object. Please note that this option only applies to the
  104474. * initial animation. For other animations, see chart.animation and the
  104475. * animation parameter under the API methods. The following properties are
  104476. * supported:
  104477. *
  104478. * - `defer`: The animation delay time in milliseconds.
  104479. */
  104480. export interface SeriesColumnDataDataLabelsAnimationOptions {
  104481. /**
  104482. * (Highcharts, Highstock, Gantt) The animation delay time in milliseconds.
  104483. * Set to `0` renders dataLabel immediately. As `undefined` inherits defer
  104484. * time from the series.animation.defer.
  104485. */
  104486. defer?: number;
  104487. }
  104488. /**
  104489. * (Highcharts, Highstock) Style options for the guide box. The guide box has
  104490. * one state by default, the `default` state.
  104491. */
  104492. export interface SeriesColumnDataDragDropGuideBoxOptions {
  104493. /**
  104494. * (Highcharts, Highstock) Style options for the guide box default state.
  104495. */
  104496. default?: DragDropGuideBoxOptionsObject;
  104497. }
  104498. /**
  104499. * (Highcharts, Highstock) A `column` series. If the type option is not
  104500. * specified, it is inherited from chart.type.
  104501. *
  104502. * In TypeScript the type option must always be set.
  104503. *
  104504. * Configuration options for the series are given in three levels:
  104505. *
  104506. * 1. Options for all series in a chart are defined in the plotOptions.series
  104507. * object.
  104508. *
  104509. * 2. Options for all `column` series are defined in plotOptions.column.
  104510. *
  104511. * 3. Options for one single series are given in the series instance array. (see
  104512. * online documentation for example)
  104513. *
  104514. * You have to extend the `SeriesColumnOptions` via an interface to allow custom
  104515. * properties: ``` declare interface SeriesColumnOptions { customProperty:
  104516. * string; }
  104517. *
  104518. */
  104519. export interface SeriesColumnOptions extends PlotColumnOptions, SeriesOptions {
  104520. /**
  104521. * (Highcharts, Highstock) An array of data points for the series. For the
  104522. * `column` series type, points can be given in the following ways:
  104523. *
  104524. * 1. An array of numerical values. In this case, the numerical values will
  104525. * be interpreted as `y` options. The `x` values will be automatically
  104526. * calculated, either starting at 0 and incremented by 1, or from
  104527. * `pointStart` and `pointInterval` given in the series options. If the axis
  104528. * has categories, these will be used. Example: (see online documentation
  104529. * for example)
  104530. *
  104531. * 2. An array of arrays with 2 values. In this case, the values correspond
  104532. * to `x,y`. If the first value is a string, it is applied as the name of
  104533. * the point, and the `x` value is inferred. (see online documentation for
  104534. * example)
  104535. *
  104536. * 3. An array of objects with named values. The following snippet shows
  104537. * only a few settings, see the complete options set below. If the total
  104538. * number of data points exceeds the series' turboThreshold, this option is
  104539. * not available. (see online documentation for example)
  104540. */
  104541. data?: Array<(number|[(number|string), (number|null)]|null|PointOptionsObject)>;
  104542. /**
  104543. * Not available
  104544. */
  104545. dataParser?: undefined;
  104546. /**
  104547. * Not available
  104548. */
  104549. dataURL?: undefined;
  104550. /**
  104551. * (Highcharts, Highstock, Highmaps, Gantt) This property is only in
  104552. * TypeScript non-optional and might be `undefined` in series objects from
  104553. * unknown sources.
  104554. */
  104555. type: "column";
  104556. }
  104557. /**
  104558. * (Highcharts, Highstock, Gantt) Enable or disable the initial animation when a
  104559. * series is displayed for the `dataLabels`. The animation can also be set as a
  104560. * configuration object. Please note that this option only applies to the
  104561. * initial animation. For other animations, see chart.animation and the
  104562. * animation parameter under the API methods. The following properties are
  104563. * supported:
  104564. *
  104565. * - `defer`: The animation delay time in milliseconds.
  104566. */
  104567. export interface SeriesColumnpyramidDataDataLabelsAnimationOptions {
  104568. /**
  104569. * (Highcharts, Highstock, Gantt) The animation delay time in milliseconds.
  104570. * Set to `0` renders dataLabel immediately. As `undefined` inherits defer
  104571. * time from the series.animation.defer.
  104572. */
  104573. defer?: number;
  104574. }
  104575. /**
  104576. * (Highcharts, Highstock) Style options for the guide box. The guide box has
  104577. * one state by default, the `default` state.
  104578. */
  104579. export interface SeriesColumnpyramidDataDragDropGuideBoxOptions {
  104580. /**
  104581. * (Highcharts, Highstock) Style options for the guide box default state.
  104582. */
  104583. default?: DragDropGuideBoxOptionsObject;
  104584. }
  104585. /**
  104586. * (Highcharts, Highstock) A `columnpyramid` series. If the type option is not
  104587. * specified, it is inherited from chart.type.
  104588. *
  104589. * In TypeScript the type option must always be set.
  104590. *
  104591. * Configuration options for the series are given in three levels:
  104592. *
  104593. * 1. Options for all series in a chart are defined in the plotOptions.series
  104594. * object.
  104595. *
  104596. * 2. Options for all `columnpyramid` series are defined in
  104597. * plotOptions.columnpyramid.
  104598. *
  104599. * 3. Options for one single series are given in the series instance array. (see
  104600. * online documentation for example)
  104601. *
  104602. * You have to extend the `SeriesColumnpyramidOptions` via an interface to allow
  104603. * custom properties: ``` declare interface SeriesColumnpyramidOptions {
  104604. * customProperty: string; }
  104605. *
  104606. */
  104607. export interface SeriesColumnpyramidOptions extends PlotColumnpyramidOptions, SeriesOptions {
  104608. /**
  104609. * (Highcharts, Highstock) An array of data points for the series. For the
  104610. * `columnpyramid` series type, points can be given in the following ways:
  104611. *
  104612. * 1. An array of numerical values. In this case, the numerical values will
  104613. * be interpreted as `y` options. The `x` values will be automatically
  104614. * calculated, either starting at 0 and incremented by 1, or from
  104615. * `pointStart` and `pointInterval` given in the series options. If the axis
  104616. * has categories, these will be used. Example: (see online documentation
  104617. * for example)
  104618. *
  104619. * 2. An array of arrays with 2 values. In this case, the values correspond
  104620. * to `x,y`. If the first value is a string, it is applied as the name of
  104621. * the point, and the `x` value is inferred. (see online documentation for
  104622. * example)
  104623. *
  104624. * 3. An array of objects with named values. The objects are point
  104625. * configuration objects as seen below. If the total number of data points
  104626. * exceeds the series' turboThreshold, this option is not available. (see
  104627. * online documentation for example)
  104628. */
  104629. data?: Array<(number|[(number|string), (number|null)]|null|PointOptionsObject)>;
  104630. /**
  104631. * Not available
  104632. */
  104633. dataParser?: undefined;
  104634. /**
  104635. * Not available
  104636. */
  104637. dataURL?: undefined;
  104638. /**
  104639. * (Highcharts, Highstock, Highmaps, Gantt) This property is only in
  104640. * TypeScript non-optional and might be `undefined` in series objects from
  104641. * unknown sources.
  104642. */
  104643. type: "columnpyramid";
  104644. }
  104645. /**
  104646. * (Highcharts, Highstock) Enable or disable the initial animation when a series
  104647. * is displayed for the `dataLabels`. The animation can also be set as a
  104648. * configuration object. Please note that this option only applies to the
  104649. * initial animation. For other animations, see chart.animation and the
  104650. * animation parameter under the API methods. The following properties are
  104651. * supported:
  104652. *
  104653. * - `defer`: The animation delay time in milliseconds.
  104654. */
  104655. export interface SeriesColumnrangeDataDataLabelsAnimationOptions {
  104656. /**
  104657. * (Highcharts, Highstock) The animation delay time in milliseconds. Set to
  104658. * `0` renders dataLabel immediately. As `undefined` inherits defer time
  104659. * from the series.animation.defer.
  104660. */
  104661. defer?: number;
  104662. }
  104663. /**
  104664. * (Highcharts, Highstock) Style options for the guide box. The guide box has
  104665. * one state by default, the `default` state.
  104666. */
  104667. export interface SeriesColumnrangeDataDragDropGuideBoxOptions {
  104668. /**
  104669. * (Highcharts, Highstock) Style options for the guide box default state.
  104670. */
  104671. default?: DragDropGuideBoxOptionsObject;
  104672. }
  104673. /**
  104674. * (Highcharts, Highstock) A `columnrange` series. If the type option is not
  104675. * specified, it is inherited from chart.type.
  104676. *
  104677. * In TypeScript the type option must always be set.
  104678. *
  104679. * Configuration options for the series are given in three levels:
  104680. *
  104681. * 1. Options for all series in a chart are defined in the plotOptions.series
  104682. * object.
  104683. *
  104684. * 2. Options for all `columnrange` series are defined in
  104685. * plotOptions.columnrange.
  104686. *
  104687. * 3. Options for one single series are given in the series instance array. (see
  104688. * online documentation for example)
  104689. *
  104690. * You have to extend the `SeriesColumnrangeOptions` via an interface to allow
  104691. * custom properties: ``` declare interface SeriesColumnrangeOptions {
  104692. * customProperty: string; }
  104693. *
  104694. */
  104695. export interface SeriesColumnrangeOptions extends PlotColumnrangeOptions, SeriesOptions {
  104696. /**
  104697. * (Highcharts, Highstock) An array of data points for the series. For the
  104698. * `columnrange` series type, points can be given in the following ways:
  104699. *
  104700. * 1. An array of arrays with 3 or 2 values. In this case, the values
  104701. * correspond to `x,low,high`. If the first value is a string, it is applied
  104702. * as the name of the point, and the `x` value is inferred. The `x` value
  104703. * can also be omitted, in which case the inner arrays should be of length
  104704. * 2\. Then the `x` value is automatically calculated, either starting at 0
  104705. * and incremented by 1, or from `pointStart` and `pointInterval` given in
  104706. * the series options. (see online documentation for example)
  104707. *
  104708. * 2. An array of objects with named values. The following snippet shows
  104709. * only a few settings, see the complete options set below. If the total
  104710. * number of data points exceeds the series' turboThreshold, this option is
  104711. * not available. (see online documentation for example)
  104712. */
  104713. data?: Array<([(number|string), number]|[(number|string), number, number]|PointOptionsObject)>;
  104714. /**
  104715. * Not available
  104716. */
  104717. dataParser?: undefined;
  104718. /**
  104719. * Not available
  104720. */
  104721. dataURL?: undefined;
  104722. /**
  104723. * Not available
  104724. */
  104725. stack?: undefined;
  104726. /**
  104727. * (Highcharts, Highstock, Highmaps, Gantt) This property is only in
  104728. * TypeScript non-optional and might be `undefined` in series objects from
  104729. * unknown sources.
  104730. */
  104731. type: "columnrange";
  104732. }
  104733. /**
  104734. * (Gantt) Override Pathfinder connector options for a series. Requires
  104735. * Highcharts Gantt to be loaded.
  104736. */
  104737. export interface SeriesConnectorsOptionsObject {
  104738. animation?: ConnectorsAnimationOptionsObject;
  104739. /**
  104740. * (Gantt) Set the default dash style for this chart's connecting lines.
  104741. */
  104742. dashStyle?: string;
  104743. /**
  104744. * (Gantt) Marker options specific to the end markers for this chart's
  104745. * Pathfinder connectors. Overrides the generic marker options.
  104746. */
  104747. endMarker?: ConnectorsEndMarkerOptions;
  104748. /**
  104749. * (Gantt) Set the default color for this chart's Pathfinder connecting
  104750. * lines. Defaults to the color of the point being connected.
  104751. */
  104752. lineColor?: ColorString;
  104753. /**
  104754. * (Gantt) Set the default pixel width for this chart's Pathfinder
  104755. * connecting lines.
  104756. */
  104757. lineWidth?: number;
  104758. /**
  104759. * (Gantt) Marker options for this chart's Pathfinder connectors. Note that
  104760. * this option is overridden by the `startMarker` and `endMarker` options.
  104761. */
  104762. marker?: ConnectorsMarkerOptions;
  104763. /**
  104764. * (Gantt) Marker options specific to the start markers for this chart's
  104765. * Pathfinder connectors. Overrides the generic marker options.
  104766. */
  104767. startMarker?: ConnectorsStartMarkerOptions;
  104768. /**
  104769. * (Gantt) Set the default pathfinder algorithm to use for this chart. It is
  104770. * possible to define your own algorithms by adding them to the
  104771. * Highcharts.Pathfinder.prototype.algorithms object before the chart has
  104772. * been created.
  104773. *
  104774. * The default algorithms are as follows:
  104775. *
  104776. * `straight`: Draws a straight line between the connecting points. Does not
  104777. * avoid other points when drawing.
  104778. *
  104779. * `simpleConnect`: Finds a path between the points using right angles only.
  104780. * Takes only starting/ending points into account, and will not avoid other
  104781. * points.
  104782. *
  104783. * `fastAvoid`: Finds a path between the points using right angles only.
  104784. * Will attempt to avoid other points, but its focus is performance over
  104785. * accuracy. Works well with less dense datasets.
  104786. *
  104787. * Default value: `straight` is used as default for most series types, while
  104788. * `simpleConnect` is used as default for Gantt series, to show dependencies
  104789. * between points.
  104790. */
  104791. type?: (string|PathfinderTypeValue);
  104792. }
  104793. /**
  104794. * (Highcharts, Highstock, Gantt) Enable or disable the initial animation when a
  104795. * series is displayed for the `dataLabels`. The animation can also be set as a
  104796. * configuration object. Please note that this option only applies to the
  104797. * initial animation. For other animations, see chart.animation and the
  104798. * animation parameter under the API methods. The following properties are
  104799. * supported:
  104800. *
  104801. * - `defer`: The animation delay time in milliseconds.
  104802. */
  104803. export interface SeriesCylinderDataDataLabelsAnimationOptions {
  104804. /**
  104805. * (Highcharts, Highstock, Gantt) The animation delay time in milliseconds.
  104806. * Set to `0` renders dataLabel immediately. As `undefined` inherits defer
  104807. * time from the series.animation.defer.
  104808. */
  104809. defer?: number;
  104810. }
  104811. /**
  104812. * (Highcharts, Highstock) Style options for the guide box. The guide box has
  104813. * one state by default, the `default` state.
  104814. */
  104815. export interface SeriesCylinderDataDragDropGuideBoxOptions {
  104816. /**
  104817. * (Highcharts, Highstock) Style options for the guide box default state.
  104818. */
  104819. default?: DragDropGuideBoxOptionsObject;
  104820. }
  104821. /**
  104822. * (Highcharts) A `cylinder` series. If the type option is not specified, it is
  104823. * inherited from chart.type.
  104824. *
  104825. * In TypeScript the type option must always be set.
  104826. *
  104827. * Configuration options for the series are given in three levels:
  104828. *
  104829. * 1. Options for all series in a chart are defined in the plotOptions.series
  104830. * object.
  104831. *
  104832. * 2. Options for all `cylinder` series are defined in plotOptions.cylinder.
  104833. *
  104834. * 3. Options for one single series are given in the series instance array. (see
  104835. * online documentation for example)
  104836. *
  104837. * You have to extend the `SeriesCylinderOptions` via an interface to allow
  104838. * custom properties: ``` declare interface SeriesCylinderOptions {
  104839. * customProperty: string; }
  104840. *
  104841. */
  104842. export interface SeriesCylinderOptions extends PlotCylinderOptions, SeriesOptions {
  104843. /**
  104844. * (Highcharts, Highstock) An array of data points for the series. For the
  104845. * `cylinder` series type, points can be given in the following ways:
  104846. *
  104847. * 1. An array of numerical values. In this case, the numerical values will
  104848. * be interpreted as `y` options. The `x` values will be automatically
  104849. * calculated, either starting at 0 and incremented by 1, or from
  104850. * `pointStart` and `pointInterval` given in the series options. If the axis
  104851. * has categories, these will be used. Example: (see online documentation
  104852. * for example)
  104853. *
  104854. * 2. An array of arrays with 2 values. In this case, the values correspond
  104855. * to `x,y`. If the first value is a string, it is applied as the name of
  104856. * the point, and the `x` value is inferred. (see online documentation for
  104857. * example)
  104858. *
  104859. * 3. An array of objects with named values. The following snippet shows
  104860. * only a few settings, see the complete options set below. If the total
  104861. * number of data points exceeds the series' turboThreshold, this option is
  104862. * not available. (see online documentation for example)
  104863. */
  104864. data?: Array<(number|[(number|string), (number|null)]|null|PointOptionsObject)>;
  104865. /**
  104866. * (Highcharts, Highstock, Highmaps, Gantt) This property is only in
  104867. * TypeScript non-optional and might be `undefined` in series objects from
  104868. * unknown sources.
  104869. */
  104870. type: "cylinder";
  104871. }
  104872. /**
  104873. * (Highstock) A `DEMA` series. If the type option is not specified, it is
  104874. * inherited from chart.type.
  104875. *
  104876. * In TypeScript the type option must always be set.
  104877. *
  104878. * Configuration options for the series are given in three levels:
  104879. *
  104880. * 1. Options for all series in a chart are defined in the plotOptions.series
  104881. * object.
  104882. *
  104883. * 2. Options for all `dema` series are defined in plotOptions.dema.
  104884. *
  104885. * 3. Options for one single series are given in the series instance array. (see
  104886. * online documentation for example)
  104887. *
  104888. * You have to extend the `SeriesDemaOptions` via an interface to allow custom
  104889. * properties: ``` declare interface SeriesDemaOptions { customProperty: string;
  104890. * }
  104891. *
  104892. */
  104893. export interface SeriesDemaOptions extends PlotDemaOptions, SeriesOptions {
  104894. /**
  104895. * Not available
  104896. */
  104897. dataParser?: undefined;
  104898. /**
  104899. * Not available
  104900. */
  104901. dataURL?: undefined;
  104902. /**
  104903. * (Highcharts, Highstock, Highmaps, Gantt) This property is only in
  104904. * TypeScript non-optional and might be `undefined` in series objects from
  104905. * unknown sources.
  104906. */
  104907. type: "dema";
  104908. }
  104909. /**
  104910. * (Highcharts, Highstock, Highmaps, Gantt) Enable or disable the initial
  104911. * animation when a series is displayed for the `dataLabels`. The animation can
  104912. * also be set as a configuration object. Please note that this option only
  104913. * applies to the initial animation. For other animations, see chart.animation
  104914. * and the animation parameter under the API methods. The following properties
  104915. * are supported:
  104916. *
  104917. * - `defer`: The animation delay time in milliseconds.
  104918. */
  104919. export interface SeriesDependencywheelNodesDataLabelsAnimationOptions {
  104920. /**
  104921. * (Highcharts, Highstock, Highmaps, Gantt) The animation delay time in
  104922. * milliseconds. Set to `0` renders dataLabel immediately. As `undefined`
  104923. * inherits defer time from the series.animation.defer.
  104924. */
  104925. defer?: number;
  104926. }
  104927. /**
  104928. * (Highcharts) A `dependencywheel` series. If the type option is not specified,
  104929. * it is inherited from chart.type.
  104930. *
  104931. * In TypeScript the type option must always be set.
  104932. *
  104933. * Configuration options for the series are given in three levels:
  104934. *
  104935. * 1. Options for all series in a chart are defined in the plotOptions.series
  104936. * object.
  104937. *
  104938. * 2. Options for all `dependencywheel` series are defined in
  104939. * plotOptions.dependencywheel.
  104940. *
  104941. * 3. Options for one single series are given in the series instance array. (see
  104942. * online documentation for example)
  104943. *
  104944. * You have to extend the `SeriesDependencywheelOptions` via an interface to
  104945. * allow custom properties: ``` declare interface SeriesDependencywheelOptions {
  104946. * customProperty: string; }
  104947. *
  104948. */
  104949. export interface SeriesDependencywheelOptions extends PlotDependencywheelOptions, SeriesOptions {
  104950. /**
  104951. * (Highcharts) An array of data points for the series. For the
  104952. * `dependencywheel` series type, points can be given in the following way:
  104953. *
  104954. * An array of objects with named values. The following snippet shows only a
  104955. * few settings, see the complete options set below. If the total number of
  104956. * data points exceeds the series' turboThreshold, this option is not
  104957. * available. (see online documentation for example)
  104958. */
  104959. data?: Array<SeriesSankeyPointOptionsObject>;
  104960. /**
  104961. * (Highcharts) A collection of options for the individual nodes. The nodes
  104962. * in a dependency diagram are auto-generated instances of
  104963. * `Highcharts.Point`, but options can be applied here and linked by the
  104964. * `id`.
  104965. */
  104966. nodes?: Array<SeriesSankeyNodesOptionsObject>;
  104967. /**
  104968. * (Highcharts, Highstock, Highmaps, Gantt) This property is only in
  104969. * TypeScript non-optional and might be `undefined` in series objects from
  104970. * unknown sources.
  104971. */
  104972. type: "dependencywheel";
  104973. }
  104974. /**
  104975. * (Highstock) A Detrended Price Oscillator. If the type option is not
  104976. * specified, it is inherited from chart.type.
  104977. *
  104978. * In TypeScript the type option must always be set.
  104979. *
  104980. * Configuration options for the series are given in three levels:
  104981. *
  104982. * 1. Options for all series in a chart are defined in the plotOptions.series
  104983. * object.
  104984. *
  104985. * 2. Options for all `dpo` series are defined in plotOptions.dpo.
  104986. *
  104987. * 3. Options for one single series are given in the series instance array. (see
  104988. * online documentation for example)
  104989. *
  104990. * You have to extend the `SeriesDpoOptions` via an interface to allow custom
  104991. * properties: ``` declare interface SeriesDpoOptions { customProperty: string;
  104992. * }
  104993. *
  104994. */
  104995. export interface SeriesDpoOptions extends PlotDpoOptions, SeriesOptions {
  104996. /**
  104997. * Not available
  104998. */
  104999. dataParser?: undefined;
  105000. /**
  105001. * Not available
  105002. */
  105003. dataURL?: undefined;
  105004. /**
  105005. * (Highcharts, Highstock, Highmaps, Gantt) This property is only in
  105006. * TypeScript non-optional and might be `undefined` in series objects from
  105007. * unknown sources.
  105008. */
  105009. type: "dpo";
  105010. }
  105011. /**
  105012. * (Highcharts, Highstock, Gantt) The draggable-points module allows points to
  105013. * be moved around or modified in the chart. In addition to the options
  105014. * mentioned under the `dragDrop` API structure, the module fires three events,
  105015. * point.dragStart, point.drag and point.drop.
  105016. */
  105017. export interface SeriesDragDropOptionsObject {
  105018. /**
  105019. * (Highstock) Allow close value to be dragged individually.
  105020. */
  105021. draggableClose?: boolean;
  105022. /**
  105023. * (Gantt) Allow end value to be dragged individually.
  105024. */
  105025. draggableEnd?: boolean;
  105026. /**
  105027. * (Highstock) Allow high value to be dragged individually.
  105028. */
  105029. draggableHigh?: boolean;
  105030. /**
  105031. * (Highstock) Allow low value to be dragged individually.
  105032. */
  105033. draggableLow?: boolean;
  105034. /**
  105035. * (Highstock) Allow open value to be dragged individually.
  105036. */
  105037. draggableOpen?: boolean;
  105038. /**
  105039. * (Highcharts, Highstock) Allow Q1 value to be dragged individually.
  105040. */
  105041. draggableQ1?: boolean;
  105042. /**
  105043. * (Highcharts, Highstock) Allow Q3 value to be dragged individually.
  105044. */
  105045. draggableQ3?: boolean;
  105046. /**
  105047. * (Gantt) Allow start value to be dragged individually.
  105048. */
  105049. draggableStart?: boolean;
  105050. /**
  105051. * (Highcharts) Allow target value to be dragged individually.
  105052. */
  105053. draggableTarget?: boolean;
  105054. /**
  105055. * (Highcharts, Highstock, Gantt) Enable dragging in the X dimension.
  105056. */
  105057. draggableX?: boolean;
  105058. /**
  105059. * (Highcharts, Highstock, Gantt) Allow x value to be dragged individually.
  105060. */
  105061. draggableX1?: boolean;
  105062. /**
  105063. * (Highcharts, Highstock, Gantt) Allow x2 value to be dragged individually.
  105064. */
  105065. draggableX2?: boolean;
  105066. /**
  105067. * (Highcharts, Highstock, Gantt) Enable dragging in the Y dimension. Note
  105068. * that this is not supported for TreeGrid axes (the default axis type in
  105069. * Gantt charts).
  105070. */
  105071. draggableY?: boolean;
  105072. /**
  105073. * (Highcharts, Highstock, Gantt) Options for the drag handles.
  105074. */
  105075. dragHandle?: DragDropHandleOptionsObject;
  105076. /**
  105077. * (Highcharts, Highstock, Gantt) Set the maximum X value the points can be
  105078. * moved to.
  105079. */
  105080. dragMaxX?: number;
  105081. /**
  105082. * (Highcharts, Highstock, Gantt) Set the maximum Y value the points can be
  105083. * moved to.
  105084. */
  105085. dragMaxY?: number;
  105086. /**
  105087. * (Highcharts, Highstock, Gantt) Set the minimum X value the points can be
  105088. * moved to.
  105089. */
  105090. dragMinX?: number;
  105091. /**
  105092. * (Highcharts, Highstock, Gantt) Set the minimum Y value the points can be
  105093. * moved to.
  105094. */
  105095. dragMinY?: number;
  105096. /**
  105097. * (Highcharts, Highstock, Gantt) The X precision value to drag to for this
  105098. * series. Set to 0 to disable. By default this is disabled, except for
  105099. * category axes, where the default is 1.
  105100. */
  105101. dragPrecisionX?: number;
  105102. /**
  105103. * (Highcharts, Highstock, Gantt) The Y precision value to drag to for this
  105104. * series. Set to 0 to disable. By default this is disabled, except for
  105105. * category axes, where the default is 1.
  105106. */
  105107. dragPrecisionY?: number;
  105108. /**
  105109. * (Highcharts, Highstock, Gantt) The amount of pixels to drag the pointer
  105110. * before it counts as a drag operation. This prevents drag/drop to fire
  105111. * when just clicking or selecting points.
  105112. */
  105113. dragSensitivity?: number;
  105114. /**
  105115. * (Highcharts, Highstock, Gantt) Group the points by a property. Points
  105116. * with the same property value will be grouped together when moving.
  105117. */
  105118. groupBy?: string;
  105119. /**
  105120. * (Highcharts, Highstock, Gantt) Style options for the guide box. The guide
  105121. * box has one state by default, the `default` state.
  105122. */
  105123. guideBox?: (PlotAreaDragDropGuideBoxOptions|PlotArearangeDragDropGuideBoxOptions|PlotAreasplineDragDropGuideBoxOptions|PlotAreasplinerangeDragDropGuideBoxOptions|PlotBarDragDropGuideBoxOptions|
  105124. PlotBoxplotDragDropGuideBoxOptions|PlotBubbleDragDropGuideBoxOptions|PlotBulletDragDropGuideBoxOptions|PlotCandlestickDragDropGuideBoxOptions|PlotColumnDragDropGuideBoxOptions|
  105125. PlotColumnpyramidDragDropGuideBoxOptions|PlotColumnrangeDragDropGuideBoxOptions|PlotDumbbellDragDropGuideBoxOptions|PlotErrorbarDragDropGuideBoxOptions|PlotFlagsDragDropGuideBoxOptions|
  105126. PlotFunnel3dDragDropGuideBoxOptions|PlotGanttDragDropGuideBoxOptions|PlotHeatmapDragDropGuideBoxOptions|PlotLineDragDropGuideBoxOptions|PlotLollipopDragDropGuideBoxOptions|
  105127. PlotMapbubbleDragDropGuideBoxOptions|PlotMapDragDropGuideBoxOptions|PlotMaplineDragDropGuideBoxOptions|PlotMappointDragDropGuideBoxOptions|PlotOhlcDragDropGuideBoxOptions|
  105128. PlotPolygonDragDropGuideBoxOptions|PlotPyramid3dDragDropGuideBoxOptions|PlotScatterDragDropGuideBoxOptions|PlotSeriesDragDropGuideBoxOptions|PlotSplineDragDropGuideBoxOptions|
  105129. PlotStreamgraphDragDropGuideBoxOptions|PlotTilemapDragDropGuideBoxOptions|PlotTimelineDragDropGuideBoxOptions|PlotVariwideDragDropGuideBoxOptions|PlotWaterfallDragDropGuideBoxOptions|
  105130. PlotXrangeDragDropGuideBoxOptions|Dictionary<DragDropGuideBoxOptionsObject>);
  105131. /**
  105132. * (Highcharts, Highstock, Gantt) Update points as they are dragged. If
  105133. * false, a guide box is drawn to illustrate the new point size.
  105134. */
  105135. liveRedraw?: boolean;
  105136. }
  105137. /**
  105138. * (Highcharts, Highstock) Enable or disable the initial animation when a series
  105139. * is displayed for the `dataLabels`. The animation can also be set as a
  105140. * configuration object. Please note that this option only applies to the
  105141. * initial animation. For other animations, see chart.animation and the
  105142. * animation parameter under the API methods. The following properties are
  105143. * supported:
  105144. *
  105145. * - `defer`: The animation delay time in milliseconds.
  105146. */
  105147. export interface SeriesDumbbellDataDataLabelsAnimationOptions {
  105148. /**
  105149. * (Highcharts, Highstock) The animation delay time in milliseconds. Set to
  105150. * `0` renders dataLabel immediately. As `undefined` inherits defer time
  105151. * from the series.animation.defer.
  105152. */
  105153. defer?: number;
  105154. }
  105155. /**
  105156. * (Highcharts, Highstock) Style options for the guide box. The guide box has
  105157. * one state by default, the `default` state.
  105158. */
  105159. export interface SeriesDumbbellDataDragDropGuideBoxOptions {
  105160. /**
  105161. * (Highcharts, Highstock) Style options for the guide box default state.
  105162. */
  105163. default?: DragDropGuideBoxOptionsObject;
  105164. }
  105165. /**
  105166. * (Highcharts, Highstock) The `dumbbell` series. If the type option is not
  105167. * specified, it is inherited from chart.type.
  105168. *
  105169. * In TypeScript the type option must always be set.
  105170. *
  105171. * Configuration options for the series are given in three levels:
  105172. *
  105173. * 1. Options for all series in a chart are defined in the plotOptions.series
  105174. * object.
  105175. *
  105176. * 2. Options for all `dumbbell` series are defined in plotOptions.dumbbell.
  105177. *
  105178. * 3. Options for one single series are given in the series instance array. (see
  105179. * online documentation for example)
  105180. *
  105181. * You have to extend the `SeriesDumbbellOptions` via an interface to allow
  105182. * custom properties: ``` declare interface SeriesDumbbellOptions {
  105183. * customProperty: string; }
  105184. *
  105185. */
  105186. export interface SeriesDumbbellOptions extends PlotDumbbellOptions, SeriesOptions {
  105187. /**
  105188. * (Highcharts, Highstock) An array of data points for the series. For the
  105189. * `dumbbell` series type, points can be given in the following ways:
  105190. *
  105191. * 1. An array of arrays with 3 or 2 values. In this case, the values
  105192. * correspond to `x,low,high`. If the first value is a string, it is applied
  105193. * as the name of the point, and the `x` value is inferred. The `x` value
  105194. * can also be omitted, in which case the inner arrays should be of length
  105195. * 2\. Then the `x` value is automatically calculated, either starting at 0
  105196. * and incremented by 1, or from `pointStart` and `pointInterval` given in
  105197. * the series options. (see online documentation for example)
  105198. *
  105199. * 2. An array of objects with named values. The following snippet shows
  105200. * only a few settings, see the complete options set below. If the total
  105201. * number of data points exceeds the series' turboThreshold, this option is
  105202. * not available. (see online documentation for example)
  105203. */
  105204. data?: Array<([(number|string), number]|[(number|string), number, number]|PointOptionsObject)>;
  105205. /**
  105206. * (Highcharts, Highstock, Highmaps, Gantt) This property is only in
  105207. * TypeScript non-optional and might be `undefined` in series objects from
  105208. * unknown sources.
  105209. */
  105210. type: "dumbbell";
  105211. }
  105212. /**
  105213. * (Highstock) A `EMA` series. If the type option is not specified, it is
  105214. * inherited from chart.type.
  105215. *
  105216. * In TypeScript the type option must always be set.
  105217. *
  105218. * Configuration options for the series are given in three levels:
  105219. *
  105220. * 1. Options for all series in a chart are defined in the plotOptions.series
  105221. * object.
  105222. *
  105223. * 2. Options for all `ema` series are defined in plotOptions.ema.
  105224. *
  105225. * 3. Options for one single series are given in the series instance array. (see
  105226. * online documentation for example)
  105227. *
  105228. * You have to extend the `SeriesEmaOptions` via an interface to allow custom
  105229. * properties: ``` declare interface SeriesEmaOptions { customProperty: string;
  105230. * }
  105231. *
  105232. */
  105233. export interface SeriesEmaOptions extends PlotEmaOptions, SeriesOptions {
  105234. /**
  105235. * Not available
  105236. */
  105237. dataParser?: undefined;
  105238. /**
  105239. * Not available
  105240. */
  105241. dataURL?: undefined;
  105242. /**
  105243. * (Highcharts, Highstock, Highmaps, Gantt) This property is only in
  105244. * TypeScript non-optional and might be `undefined` in series objects from
  105245. * unknown sources.
  105246. */
  105247. type: "ema";
  105248. }
  105249. /**
  105250. * (Highcharts) Style options for the guide box. The guide box has one state by
  105251. * default, the `default` state.
  105252. */
  105253. export interface SeriesErrorbarDataDragDropGuideBoxOptions {
  105254. /**
  105255. * (Highcharts) Style options for the guide box default state.
  105256. */
  105257. default?: DragDropGuideBoxOptionsObject;
  105258. }
  105259. /**
  105260. * (Highcharts) A `errorbar` series. If the type option is not specified, it is
  105261. * inherited from chart.type.
  105262. *
  105263. * In TypeScript the type option must always be set.
  105264. *
  105265. * Configuration options for the series are given in three levels:
  105266. *
  105267. * 1. Options for all series in a chart are defined in the plotOptions.series
  105268. * object.
  105269. *
  105270. * 2. Options for all `errorbar` series are defined in plotOptions.errorbar.
  105271. *
  105272. * 3. Options for one single series are given in the series instance array. (see
  105273. * online documentation for example)
  105274. *
  105275. * You have to extend the `SeriesErrorbarOptions` via an interface to allow
  105276. * custom properties: ``` declare interface SeriesErrorbarOptions {
  105277. * customProperty: string; }
  105278. *
  105279. */
  105280. export interface SeriesErrorbarOptions extends PlotErrorbarOptions, SeriesOptions {
  105281. /**
  105282. * (Highcharts) An array of data points for the series. For the `errorbar`
  105283. * series type, points can be given in the following ways:
  105284. *
  105285. * 1. An array of arrays with 3 or 2 values. In this case, the values
  105286. * correspond to `x,low,high`. If the first value is a string, it is applied
  105287. * as the name of the point, and the `x` value is inferred. The `x` value
  105288. * can also be omitted, in which case the inner arrays should be of length
  105289. * 2\. Then the `x` value is automatically calculated, either starting at 0
  105290. * and incremented by 1, or from `pointStart` and `pointInterval` given in
  105291. * the series options. (see online documentation for example)
  105292. *
  105293. * 2. An array of objects with named values. The following snippet shows
  105294. * only a few settings, see the complete options set below. If the total
  105295. * number of data points exceeds the series' turboThreshold, this option is
  105296. * not available. (see online documentation for example)
  105297. */
  105298. data?: Array<([(number|string), number]|[(number|string), number, number]|PointOptionsObject)>;
  105299. /**
  105300. * Not available
  105301. */
  105302. dataParser?: undefined;
  105303. /**
  105304. * Not available
  105305. */
  105306. dataURL?: undefined;
  105307. /**
  105308. * Not available
  105309. */
  105310. stack?: undefined;
  105311. /**
  105312. * (Highcharts, Highstock, Highmaps, Gantt) This property is only in
  105313. * TypeScript non-optional and might be `undefined` in series objects from
  105314. * unknown sources.
  105315. */
  105316. type: "errorbar";
  105317. }
  105318. /**
  105319. * (Highstock) General event handlers for the series items. These event hooks
  105320. * can also be attached to the series at run time using the
  105321. * `Highcharts.addEvent` function.
  105322. */
  105323. export interface SeriesEventsOptionsObject {
  105324. /**
  105325. * (Highcharts, Highstock, Gantt) Fires after the series has finished its
  105326. * initial animation, or in case animation is disabled, immediately as the
  105327. * series is displayed.
  105328. */
  105329. afterAnimate?: SeriesAfterAnimateCallbackFunction;
  105330. /**
  105331. * (Highstock) Fires when the checkbox next to the series' name in the
  105332. * legend is clicked. One parameter, `event`, is passed to the function. The
  105333. * state of the checkbox is found by `event.checked`. The checked item is
  105334. * found by `event.item`. Return `false` to prevent the default action which
  105335. * is to toggle the select state of the series.
  105336. */
  105337. checkboxClick?: (Function|SeriesCheckboxClickCallbackFunction);
  105338. /**
  105339. * (Highstock) Fires when the series is clicked. One parameter, `event`, is
  105340. * passed to the function, containing common event information.
  105341. * Additionally, `event.point` holds a pointer to the nearest point on the
  105342. * graph.
  105343. */
  105344. click?: SeriesClickCallbackFunction;
  105345. /**
  105346. * (Highstock) Fires when the series is hidden after chart generation time,
  105347. * either by clicking the legend item or by calling `.hide()`.
  105348. */
  105349. hide?: SeriesHideCallbackFunction;
  105350. /**
  105351. * (Highstock) Fires when the legend item belonging to the series is
  105352. * clicked. One parameter, `event`, is passed to the function. The default
  105353. * action is to toggle the visibility of the series. This can be prevented
  105354. * by returning `false` or calling `event.preventDefault()`.
  105355. */
  105356. legendItemClick?: SeriesLegendItemClickCallbackFunction;
  105357. /**
  105358. * (Highstock) Fires when the mouse leaves the graph. One parameter,
  105359. * `event`, is passed to the function, containing common event information.
  105360. * If the stickyTracking option is true, `mouseOut` doesn't happen before
  105361. * the mouse enters another graph or leaves the plot area.
  105362. */
  105363. mouseOut?: SeriesMouseOutCallbackFunction;
  105364. /**
  105365. * (Highstock) Fires when the mouse enters the graph. One parameter,
  105366. * `event`, is passed to the function, containing common event information.
  105367. */
  105368. mouseOver?: SeriesMouseOverCallbackFunction;
  105369. /**
  105370. * (Highcharts) Fires on a request for change of root node for the tree,
  105371. * before the update is made. An event object is passed to the function,
  105372. * containing additional properties `newRootId`, `previousRootId`, `redraw`
  105373. * and `trigger`.
  105374. */
  105375. setRootNode?: Function;
  105376. /**
  105377. * (Highstock) Fires when the series is shown after chart generation time,
  105378. * either by clicking the legend item or by calling `.show()`.
  105379. */
  105380. show?: SeriesShowCallbackFunction;
  105381. }
  105382. /**
  105383. * (Highstock) Style options for the guide box. The guide box has one state by
  105384. * default, the `default` state.
  105385. */
  105386. export interface SeriesFlagsDataDragDropGuideBoxOptions {
  105387. /**
  105388. * (Highstock) Style options for the guide box default state.
  105389. */
  105390. default?: DragDropGuideBoxOptionsObject;
  105391. }
  105392. /**
  105393. * (Highstock) A `flags` series. If the type option is not specified, it is
  105394. * inherited from chart.type.
  105395. *
  105396. * In TypeScript the type option must always be set.
  105397. *
  105398. * Configuration options for the series are given in three levels:
  105399. *
  105400. * 1. Options for all series in a chart are defined in the plotOptions.series
  105401. * object.
  105402. *
  105403. * 2. Options for all `flags` series are defined in plotOptions.flags.
  105404. *
  105405. * 3. Options for one single series are given in the series instance array. (see
  105406. * online documentation for example)
  105407. *
  105408. * You have to extend the `SeriesFlagsOptions` via an interface to allow custom
  105409. * properties: ``` declare interface SeriesFlagsOptions { customProperty:
  105410. * string; }
  105411. *
  105412. */
  105413. export interface SeriesFlagsOptions extends PlotFlagsOptions, SeriesOptions {
  105414. /**
  105415. * Not available
  105416. */
  105417. borderRadius?: undefined;
  105418. /**
  105419. * Not available
  105420. */
  105421. colorByPoint?: undefined;
  105422. /**
  105423. * (Highstock) An array of data points for the series. For the `flags`
  105424. * series type, points can be given in the following ways:
  105425. *
  105426. * 1. An array of objects with named values. The following snippet shows
  105427. * only a few settings, see the complete options set below. If the total
  105428. * number of data points exceeds the series' turboThreshold, this option is
  105429. * not available. (see online documentation for example)
  105430. */
  105431. data?: Array<PointOptionsObject>;
  105432. /**
  105433. * Not available
  105434. */
  105435. dataParser?: undefined;
  105436. /**
  105437. * Not available
  105438. */
  105439. dataURL?: undefined;
  105440. /**
  105441. * Not available
  105442. */
  105443. pointPadding?: undefined;
  105444. /**
  105445. * Not available
  105446. */
  105447. pointWidth?: undefined;
  105448. /**
  105449. * (Highcharts, Highstock, Highmaps, Gantt) This property is only in
  105450. * TypeScript non-optional and might be `undefined` in series objects from
  105451. * unknown sources.
  105452. */
  105453. type: "flags";
  105454. /**
  105455. * Not available
  105456. */
  105457. useOhlcData?: undefined;
  105458. }
  105459. /**
  105460. * (Highcharts) A `funnel3d` series. If the type option is not specified, it is
  105461. * inherited from chart.type.
  105462. *
  105463. * In TypeScript the type option must always be set.
  105464. *
  105465. * Configuration options for the series are given in three levels:
  105466. *
  105467. * 1. Options for all series in a chart are defined in the plotOptions.series
  105468. * object.
  105469. *
  105470. * 2. Options for all `funnel3d` series are defined in plotOptions.funnel3d.
  105471. *
  105472. * 3. Options for one single series are given in the series instance array. (see
  105473. * online documentation for example)
  105474. *
  105475. * You have to extend the `SeriesFunnel3dOptions` via an interface to allow
  105476. * custom properties: ``` declare interface SeriesFunnel3dOptions {
  105477. * customProperty: string; }
  105478. *
  105479. */
  105480. export interface SeriesFunnel3dOptions extends PlotFunnel3dOptions, SeriesOptions {
  105481. /**
  105482. * Not available
  105483. */
  105484. allAreas?: undefined;
  105485. /**
  105486. * Not available
  105487. */
  105488. boostThreshold?: undefined;
  105489. /**
  105490. * (Highcharts) The center of the series. By default, it is centered in the
  105491. * middle of the plot area, so it fills the plot area height.
  105492. */
  105493. center?: Array<(number|string)>;
  105494. /**
  105495. * Not available
  105496. */
  105497. colorAxis?: undefined;
  105498. /**
  105499. * Not available
  105500. */
  105501. compare?: undefined;
  105502. /**
  105503. * Not available
  105504. */
  105505. compareBase?: undefined;
  105506. /**
  105507. * (Highcharts) Polar charts only. Whether to connect the ends of a line
  105508. * series plot across the extremes.
  105509. */
  105510. connectEnds?: boolean;
  105511. /**
  105512. * (Highcharts, Highstock) Whether to connect a graph line across null
  105513. * points, or render a gap between the two points on either side of the
  105514. * null.
  105515. */
  105516. connectNulls?: boolean;
  105517. /**
  105518. * (Highcharts) The end angle of the pie in degrees where 0 is top and 90 is
  105519. * right. Defaults to `startAngle` plus 360.
  105520. */
  105521. endAngle?: number;
  105522. /**
  105523. * (Highcharts) If the total sum of the pie's values is 0, the series is
  105524. * represented as an empty circle . The `fillColor` option defines the color
  105525. * of that circle. Use pie.borderWidth to set the border thickness.
  105526. */
  105527. fillColor?: (ColorString|GradientColorObject|PatternObject);
  105528. /**
  105529. * (Highstock) Defines when to display a gap in the graph, together with the
  105530. * gapUnit option.
  105531. *
  105532. * In case when `dataGrouping` is enabled, points can be grouped into a
  105533. * larger time span. This can make the grouped points to have a greater
  105534. * distance than the absolute value of `gapSize` property, which will result
  105535. * in disappearing graph completely. To prevent this situation the mentioned
  105536. * distance between grouped points is used instead of previously defined
  105537. * `gapSize`.
  105538. *
  105539. * In practice, this option is most often used to visualize gaps in time
  105540. * series. In a stock chart, intraday data is available for daytime hours,
  105541. * while gaps will appear in nights and weekends.
  105542. */
  105543. gapSize?: number;
  105544. /**
  105545. * (Highstock) Together with gapSize, this option defines where to draw gaps
  105546. * in the graph.
  105547. *
  105548. * When the `gapUnit` is `"relative"` (default), a gap size of 5 means that
  105549. * if the distance between two points is greater than 5 times that of the
  105550. * two closest points, the graph will be broken.
  105551. *
  105552. * When the `gapUnit` is `"value"`, the gap is based on absolute axis
  105553. * values, which on a datetime axis is milliseconds. This also applies to
  105554. * the navigator series that inherits gap options from the base series.
  105555. */
  105556. gapUnit?: OptionsGapUnitValue;
  105557. /**
  105558. * (Highcharts) Equivalent to chart.ignoreHiddenSeries, this option tells
  105559. * whether the series shall be redrawn as if the hidden point were `null`.
  105560. *
  105561. * The default value changed from `false` to `true` with Highcharts 3.0.
  105562. */
  105563. ignoreHiddenPoint?: boolean;
  105564. /**
  105565. * (Highcharts, Highstock) The line cap used for line ends and line joins on
  105566. * the graph.
  105567. */
  105568. linecap?: SeriesLinecapValue;
  105569. /**
  105570. * (Highcharts, Highstock) Pixel width of the graph line.
  105571. */
  105572. lineWidth?: number;
  105573. /**
  105574. * (Highcharts) Options for the point markers of line-like series.
  105575. * Properties like `fillColor`, `lineColor` and `lineWidth` define the
  105576. * visual appearance of the markers. Other series types, like column series,
  105577. * don't have markers, but have visual options on the series level instead.
  105578. *
  105579. * In styled mode, the markers can be styled with the `.highcharts-point`,
  105580. * `.highcharts-point-hover` and `.highcharts-point-select` class names.
  105581. */
  105582. marker?: PointMarkerOptionsObject;
  105583. /**
  105584. * (Highcharts) The minimum size for a pie in response to auto margins. The
  105585. * pie will try to shrink to make room for data labels in side the plot
  105586. * area, but only to this size.
  105587. */
  105588. minSize?: (number|string);
  105589. /**
  105590. * (Highcharts) If a point is sliced, moved out from the center, how many
  105591. * pixels should it be moved?.
  105592. */
  105593. slicedOffset?: number;
  105594. /**
  105595. * (Highcharts) The start angle of the pie slices in degrees where 0 is top
  105596. * and 90 right.
  105597. */
  105598. startAngle?: number;
  105599. /**
  105600. * (Highcharts, Highstock) Whether to apply steps to the line. Possible
  105601. * values are `left`, `center` and `right`.
  105602. */
  105603. step?: OptionsStepValue;
  105604. /**
  105605. * (Highcharts, Highstock, Highmaps, Gantt) This property is only in
  105606. * TypeScript non-optional and might be `undefined` in series objects from
  105607. * unknown sources.
  105608. */
  105609. type: "funnel3d";
  105610. /**
  105611. * (Highstock) The parameter allows setting line series type and use OHLC
  105612. * indicators. Data in OHLC format is required.
  105613. */
  105614. useOhlcData?: boolean;
  105615. }
  105616. /**
  105617. * (Highcharts) Enable or disable the initial animation when a series is
  105618. * displayed for the `dataLabels`. The animation can also be set as a
  105619. * configuration object. Please note that this option only applies to the
  105620. * initial animation. For other animations, see chart.animation and the
  105621. * animation parameter under the API methods. The following properties are
  105622. * supported:
  105623. *
  105624. * - `defer`: The animation delay time in milliseconds.
  105625. */
  105626. export interface SeriesFunnelDataDataLabelsAnimationOptions {
  105627. /**
  105628. * (Highcharts) The animation delay time in milliseconds. Set to `0` renders
  105629. * dataLabel immediately. As `undefined` inherits defer time from the
  105630. * series.animation.defer.
  105631. */
  105632. defer?: number;
  105633. }
  105634. /**
  105635. * (Highcharts) Style options for the guide box. The guide box has one state by
  105636. * default, the `default` state.
  105637. */
  105638. export interface SeriesFunnelDataDragDropGuideBoxOptions {
  105639. /**
  105640. * (Highcharts) Style options for the guide box default state.
  105641. */
  105642. default?: DragDropGuideBoxOptionsObject;
  105643. }
  105644. /**
  105645. * (Highcharts) A `funnel` series. If the type option is not specified, it is
  105646. * inherited from chart.type.
  105647. *
  105648. * In TypeScript the type option must always be set.
  105649. *
  105650. * Configuration options for the series are given in three levels:
  105651. *
  105652. * 1. Options for all series in a chart are defined in the plotOptions.series
  105653. * object.
  105654. *
  105655. * 2. Options for all `funnel` series are defined in plotOptions.funnel.
  105656. *
  105657. * 3. Options for one single series are given in the series instance array. (see
  105658. * online documentation for example)
  105659. *
  105660. * You have to extend the `SeriesFunnelOptions` via an interface to allow custom
  105661. * properties: ``` declare interface SeriesFunnelOptions { customProperty:
  105662. * string; }
  105663. *
  105664. */
  105665. export interface SeriesFunnelOptions extends PlotFunnelOptions, SeriesOptions {
  105666. /**
  105667. * (Highcharts) An array of data points for the series. For the `funnel`
  105668. * series type, points can be given in the following ways:
  105669. *
  105670. * 1. An array of numerical values. In this case, the numerical values will
  105671. * be interpreted as `y` options. Example: (see online documentation for
  105672. * example)
  105673. *
  105674. * 2. An array of objects with named values. The following snippet shows
  105675. * only a few settings, see the complete options set below. If the total
  105676. * number of data points exceeds the series' turboThreshold, this option is
  105677. * not available. (see online documentation for example)
  105678. */
  105679. data?: Array<(number|null|PointOptionsObject)>;
  105680. /**
  105681. * Not available
  105682. */
  105683. dataParser?: undefined;
  105684. /**
  105685. * Not available
  105686. */
  105687. dataURL?: undefined;
  105688. /**
  105689. * Not available
  105690. */
  105691. stack?: undefined;
  105692. /**
  105693. * (Highcharts, Highstock, Highmaps, Gantt) This property is only in
  105694. * TypeScript non-optional and might be `undefined` in series objects from
  105695. * unknown sources.
  105696. */
  105697. type: "funnel";
  105698. /**
  105699. * Not available
  105700. */
  105701. xAxis?: undefined;
  105702. /**
  105703. * Not available
  105704. */
  105705. yAxis?: undefined;
  105706. }
  105707. /**
  105708. * (Gantt) Style options for the guide box. The guide box has one state by
  105709. * default, the `default` state.
  105710. */
  105711. export interface SeriesGanttDataDragDropGuideBoxOptions {
  105712. /**
  105713. * (Gantt) Style options for the guide box default state.
  105714. */
  105715. default?: DragDropGuideBoxOptionsObject;
  105716. }
  105717. /**
  105718. * (Gantt) A `gantt` series.
  105719. *
  105720. * In TypeScript the type option must always be set.
  105721. *
  105722. * Configuration options for the series are given in three levels:
  105723. *
  105724. * 1. Options for all series in a chart are defined in the plotOptions.series
  105725. * object.
  105726. *
  105727. * 2. Options for all `gantt` series are defined in plotOptions.gantt.
  105728. *
  105729. * 3. Options for one single series are given in the series instance array. (see
  105730. * online documentation for example)
  105731. *
  105732. * You have to extend the `SeriesGanttOptions` via an interface to allow custom
  105733. * properties: ``` declare interface SeriesGanttOptions { customProperty:
  105734. * string; }
  105735. *
  105736. */
  105737. export interface SeriesGanttOptions extends PlotGanttOptions, SeriesOptions {
  105738. /**
  105739. * (Gantt) Data for a Gantt series.
  105740. */
  105741. data?: Array<GanttPointOptionsObject>;
  105742. /**
  105743. * (Highcharts, Highstock, Highmaps, Gantt) This property is only in
  105744. * TypeScript non-optional and might be `undefined` in series objects from
  105745. * unknown sources.
  105746. */
  105747. type: "gantt";
  105748. }
  105749. /**
  105750. * (Highcharts, Highstock, Gantt) Enable or disable the initial animation when a
  105751. * series is displayed for the `dataLabels`. The animation can also be set as a
  105752. * configuration object. Please note that this option only applies to the
  105753. * initial animation. For other animations, see chart.animation and the
  105754. * animation parameter under the API methods. The following properties are
  105755. * supported:
  105756. *
  105757. * - `defer`: The animation delay time in milliseconds.
  105758. */
  105759. export interface SeriesGaugeDataDataLabelsAnimationOptions {
  105760. /**
  105761. * (Highcharts, Highstock, Gantt) The animation delay time in milliseconds.
  105762. * Set to `0` renders dataLabel immediately. As `undefined` inherits defer
  105763. * time from the series.animation.defer.
  105764. */
  105765. defer?: number;
  105766. }
  105767. /**
  105768. * (Highcharts) Style options for the guide box. The guide box has one state by
  105769. * default, the `default` state.
  105770. */
  105771. export interface SeriesGaugeDataDragDropGuideBoxOptions {
  105772. /**
  105773. * (Highcharts) Style options for the guide box default state.
  105774. */
  105775. default?: DragDropGuideBoxOptionsObject;
  105776. }
  105777. /**
  105778. * (Highcharts) A `gauge` series. If the type option is not specified, it is
  105779. * inherited from chart.type.
  105780. *
  105781. * In TypeScript the type option must always be set.
  105782. *
  105783. * Configuration options for the series are given in three levels:
  105784. *
  105785. * 1. Options for all series in a chart are defined in the plotOptions.series
  105786. * object.
  105787. *
  105788. * 2. Options for all `gauge` series are defined in plotOptions.gauge.
  105789. *
  105790. * 3. Options for one single series are given in the series instance array. (see
  105791. * online documentation for example)
  105792. *
  105793. * You have to extend the `SeriesGaugeOptions` via an interface to allow custom
  105794. * properties: ``` declare interface SeriesGaugeOptions { customProperty:
  105795. * string; }
  105796. *
  105797. */
  105798. export interface SeriesGaugeOptions extends PlotGaugeOptions, SeriesOptions {
  105799. /**
  105800. * (Highcharts) An array of data points for the series. For the `gauge`
  105801. * series type, points can be given in the following ways:
  105802. *
  105803. * 1. An array of numerical values. In this case, the numerical values will
  105804. * be interpreted as `y` options. Example: (see online documentation for
  105805. * example)
  105806. *
  105807. * 2. An array of objects with named values. The following snippet shows
  105808. * only a few settings, see the complete options set below. If the total
  105809. * number of data points exceeds the series' turboThreshold, this option is
  105810. * not available. (see online documentation for example)
  105811. *
  105812. * The typical gauge only contains a single data value.
  105813. */
  105814. data?: Array<(number|null|PointOptionsObject)>;
  105815. /**
  105816. * Not available
  105817. */
  105818. dataParser?: undefined;
  105819. /**
  105820. * Not available
  105821. */
  105822. dataURL?: undefined;
  105823. /**
  105824. * Not available
  105825. */
  105826. stack?: undefined;
  105827. /**
  105828. * (Highcharts, Highstock, Highmaps, Gantt) This property is only in
  105829. * TypeScript non-optional and might be `undefined` in series objects from
  105830. * unknown sources.
  105831. */
  105832. type: "gauge";
  105833. }
  105834. /**
  105835. * (Highcharts, Highstock, Gantt) Enable or disable the initial animation when a
  105836. * series is displayed for the `dataLabels`. The animation can also be set as a
  105837. * configuration object. Please note that this option only applies to the
  105838. * initial animation. For other animations, see chart.animation and the
  105839. * animation parameter under the API methods. The following properties are
  105840. * supported:
  105841. *
  105842. * - `defer`: The animation delay time in milliseconds.
  105843. */
  105844. export interface SeriesHeatmapDataDataLabelsAnimationOptions {
  105845. /**
  105846. * (Highcharts, Highstock, Gantt) The animation delay time in milliseconds.
  105847. * Set to `0` renders dataLabel immediately. As `undefined` inherits defer
  105848. * time from the series.animation.defer.
  105849. */
  105850. defer?: number;
  105851. }
  105852. /**
  105853. * (Highcharts, Highmaps) Style options for the guide box. The guide box has one
  105854. * state by default, the `default` state.
  105855. */
  105856. export interface SeriesHeatmapDataDragDropGuideBoxOptions {
  105857. /**
  105858. * (Highcharts, Highmaps) Style options for the guide box default state.
  105859. */
  105860. default?: DragDropGuideBoxOptionsObject;
  105861. }
  105862. /**
  105863. * (Highcharts, Highmaps) A `heatmap` series. If the type option is not
  105864. * specified, it is inherited from chart.type.
  105865. *
  105866. * In TypeScript the type option must always be set.
  105867. *
  105868. * Configuration options for the series are given in three levels:
  105869. *
  105870. * 1. Options for all series in a chart are defined in the plotOptions.series
  105871. * object.
  105872. *
  105873. * 2. Options for all `heatmap` series are defined in plotOptions.heatmap.
  105874. *
  105875. * 3. Options for one single series are given in the series instance array. (see
  105876. * online documentation for example)
  105877. *
  105878. * You have to extend the `SeriesHeatmapOptions` via an interface to allow
  105879. * custom properties: ``` declare interface SeriesHeatmapOptions {
  105880. * customProperty: string; }
  105881. *
  105882. */
  105883. export interface SeriesHeatmapOptions extends PlotHeatmapOptions, SeriesOptions {
  105884. /**
  105885. * (Highcharts, Highmaps) An array of data points for the series. For the
  105886. * `heatmap` series type, points can be given in the following ways:
  105887. *
  105888. * 1. An array of arrays with 3 or 2 values. In this case, the values
  105889. * correspond to `x,y,value`. If the first value is a string, it is applied
  105890. * as the name of the point, and the `x` value is inferred. The `x` value
  105891. * can also be omitted, in which case the inner arrays should be of length
  105892. * 2\. Then the `x` value is automatically calculated, either starting at 0
  105893. * and incremented by 1, or from `pointStart` and `pointInterval` given in
  105894. * the series options. (see online documentation for example)
  105895. *
  105896. * 2. An array of objects with named values. The following snippet shows
  105897. * only a few settings, see the complete options set below. If the total
  105898. * number of data points exceeds the series' turboThreshold, this option is
  105899. * not available. (see online documentation for example)
  105900. */
  105901. data?: Array<(Array<number>|PointOptionsObject)>;
  105902. /**
  105903. * Not available
  105904. */
  105905. dataParser?: undefined;
  105906. /**
  105907. * Not available
  105908. */
  105909. dataURL?: undefined;
  105910. /**
  105911. * Not available
  105912. */
  105913. stack?: undefined;
  105914. /**
  105915. * (Highcharts, Highstock, Highmaps, Gantt) This property is only in
  105916. * TypeScript non-optional and might be `undefined` in series objects from
  105917. * unknown sources.
  105918. */
  105919. type: "heatmap";
  105920. }
  105921. /**
  105922. * (Highcharts) A `histogram` series. If the type option is not specified, it is
  105923. * inherited from chart.type.
  105924. *
  105925. * In TypeScript the type option must always be set.
  105926. *
  105927. * Configuration options for the series are given in three levels:
  105928. *
  105929. * 1. Options for all series in a chart are defined in the plotOptions.series
  105930. * object.
  105931. *
  105932. * 2. Options for all `histogram` series are defined in plotOptions.histogram.
  105933. *
  105934. * 3. Options for one single series are given in the series instance array. (see
  105935. * online documentation for example)
  105936. *
  105937. * You have to extend the `SeriesHistogramOptions` via an interface to allow
  105938. * custom properties: ``` declare interface SeriesHistogramOptions {
  105939. * customProperty: string; }
  105940. *
  105941. */
  105942. export interface SeriesHistogramOptions extends PlotHistogramOptions, SeriesOptions {
  105943. /**
  105944. * (Highcharts) An integer identifying the index to use for the base series,
  105945. * or a string representing the id of the series.
  105946. */
  105947. baseSeries?: (number|string);
  105948. /**
  105949. * Not available
  105950. */
  105951. data?: undefined;
  105952. /**
  105953. * Not available
  105954. */
  105955. dataParser?: undefined;
  105956. /**
  105957. * Not available
  105958. */
  105959. dataURL?: undefined;
  105960. /**
  105961. * (Highcharts, Highstock, Highmaps, Gantt) This property is only in
  105962. * TypeScript non-optional and might be `undefined` in series objects from
  105963. * unknown sources.
  105964. */
  105965. type: "histogram";
  105966. }
  105967. /**
  105968. * (Highstock) A `IKH` series. If the type option is not specified, it is
  105969. * inherited from chart.type.
  105970. *
  105971. * In TypeScript the type option must always be set.
  105972. *
  105973. * Configuration options for the series are given in three levels:
  105974. *
  105975. * 1. Options for all series in a chart are defined in the plotOptions.series
  105976. * object.
  105977. *
  105978. * 2. Options for all `ikh` series are defined in plotOptions.ikh.
  105979. *
  105980. * 3. Options for one single series are given in the series instance array. (see
  105981. * online documentation for example)
  105982. *
  105983. * You have to extend the `SeriesIkhOptions` via an interface to allow custom
  105984. * properties: ``` declare interface SeriesIkhOptions { customProperty: string;
  105985. * }
  105986. *
  105987. */
  105988. export interface SeriesIkhOptions extends PlotIkhOptions, SeriesOptions {
  105989. /**
  105990. * Not available
  105991. */
  105992. dataParser?: undefined;
  105993. /**
  105994. * Not available
  105995. */
  105996. dataURL?: undefined;
  105997. /**
  105998. * (Highcharts, Highstock, Highmaps, Gantt) This property is only in
  105999. * TypeScript non-optional and might be `undefined` in series objects from
  106000. * unknown sources.
  106001. */
  106002. type: "ikh";
  106003. }
  106004. /**
  106005. * (Highcharts) Enable or disable the initial animation when a series is
  106006. * displayed for the `dataLabels`. The animation can also be set as a
  106007. * configuration object. Please note that this option only applies to the
  106008. * initial animation. For other animations, see chart.animation and the
  106009. * animation parameter under the API methods. The following properties are
  106010. * supported:
  106011. *
  106012. * - `defer`: The animation delay time in milliseconds.
  106013. */
  106014. export interface SeriesItemDataDataLabelsAnimationOptions {
  106015. /**
  106016. * (Highcharts) The animation delay time in milliseconds. Set to `0` renders
  106017. * dataLabel immediately. As `undefined` inherits defer time from the
  106018. * series.animation.defer.
  106019. */
  106020. defer?: number;
  106021. }
  106022. /**
  106023. * (Highcharts) Style options for the guide box. The guide box has one state by
  106024. * default, the `default` state.
  106025. */
  106026. export interface SeriesItemDataDragDropGuideBoxOptions {
  106027. /**
  106028. * (Highcharts) Style options for the guide box default state.
  106029. */
  106030. default?: DragDropGuideBoxOptionsObject;
  106031. }
  106032. /**
  106033. * (Highcharts) An `item` series. If the type option is not specified, it is
  106034. * inherited from chart.type.
  106035. *
  106036. * In TypeScript the type option must always be set.
  106037. *
  106038. * Configuration options for the series are given in three levels:
  106039. *
  106040. * 1. Options for all series in a chart are defined in the plotOptions.series
  106041. * object.
  106042. *
  106043. * 2. Options for all `item` series are defined in plotOptions.item.
  106044. *
  106045. * 3. Options for one single series are given in the series instance array. (see
  106046. * online documentation for example)
  106047. *
  106048. * You have to extend the `SeriesItemOptions` via an interface to allow custom
  106049. * properties: ``` declare interface SeriesItemOptions { customProperty: string;
  106050. * }
  106051. *
  106052. */
  106053. export interface SeriesItemOptions extends PlotItemOptions, SeriesOptions {
  106054. /**
  106055. * (Highcharts) An array of data points for the series. For the `item`
  106056. * series type, points can be given in the following ways:
  106057. *
  106058. * 1. An array of numerical values. In this case, the numerical values will
  106059. * be interpreted as `y` options. Example: (see online documentation for
  106060. * example)
  106061. *
  106062. * 2. An array of objects with named values. The following snippet shows
  106063. * only a few settings, see the complete options set below. If the total
  106064. * number of data points exceeds the series' turboThreshold, this option is
  106065. * not available. (see online documentation for example)
  106066. */
  106067. data?: Array<(number|[string, (number|null)]|null|PointOptionsObject)>;
  106068. /**
  106069. * Not available
  106070. */
  106071. dataParser?: undefined;
  106072. /**
  106073. * Not available
  106074. */
  106075. dataURL?: undefined;
  106076. /**
  106077. * Not available
  106078. */
  106079. stack?: undefined;
  106080. /**
  106081. * (Highcharts, Highstock, Highmaps, Gantt) This property is only in
  106082. * TypeScript non-optional and might be `undefined` in series objects from
  106083. * unknown sources.
  106084. */
  106085. type: "item";
  106086. /**
  106087. * Not available
  106088. */
  106089. xAxis?: undefined;
  106090. /**
  106091. * Not available
  106092. */
  106093. yAxis?: undefined;
  106094. }
  106095. /**
  106096. * (Highstock) A Keltner Channels indicator. If the type option is not
  106097. * specified, it is inherited fromchart.type.
  106098. *
  106099. * In TypeScript the type option must always be set.
  106100. *
  106101. * Configuration options for the series are given in three levels:
  106102. *
  106103. * 1. Options for all series in a chart are defined in the plotOptions.series
  106104. * object.
  106105. *
  106106. * 2. Options for all `keltnerchannels` series are defined in
  106107. * plotOptions.keltnerchannels.
  106108. *
  106109. * 3. Options for one single series are given in the series instance array. (see
  106110. * online documentation for example)
  106111. *
  106112. * You have to extend the `SeriesKeltnerchannelsOptions` via an interface to
  106113. * allow custom properties: ``` declare interface SeriesKeltnerchannelsOptions {
  106114. * customProperty: string; }
  106115. *
  106116. */
  106117. export interface SeriesKeltnerchannelsOptions extends PlotKeltnerchannelsOptions, SeriesOptions {
  106118. /**
  106119. * Not available
  106120. */
  106121. dataParser?: undefined;
  106122. /**
  106123. * Not available
  106124. */
  106125. dataURL?: undefined;
  106126. /**
  106127. * (Highcharts, Highstock, Highmaps, Gantt) This property is only in
  106128. * TypeScript non-optional and might be `undefined` in series objects from
  106129. * unknown sources.
  106130. */
  106131. type: "keltnerchannels";
  106132. }
  106133. /**
  106134. * (Highcharts, Highstock, Gantt) Series labels are placed as close to the
  106135. * series as possible in a natural way, seeking to avoid other series. The goal
  106136. * of this feature is to make the chart more easily readable, like if a human
  106137. * designer placed the labels in the optimal position.
  106138. *
  106139. * The series labels currently work with series types having a `graph` or an
  106140. * `area`.
  106141. */
  106142. export interface SeriesLabelOptionsObject {
  106143. /**
  106144. * (Highcharts, Highstock, Gantt) An array of boxes to avoid when laying out
  106145. * the labels. Each item has a `left`, `right`, `top` and `bottom` property.
  106146. */
  106147. boxesToAvoid?: Array<LabelIntersectBoxObject>;
  106148. /**
  106149. * (Highcharts, Highstock, Gantt) Allow labels to be placed distant to the
  106150. * graph if necessary, and draw a connector line to the graph. Setting this
  106151. * option to true may decrease the performance significantly, since the
  106152. * algorithm with systematically search for open spaces in the whole plot
  106153. * area. Visually, it may also result in a more cluttered chart, though more
  106154. * of the series will be labeled.
  106155. */
  106156. connectorAllowed?: boolean;
  106157. /**
  106158. * (Highcharts, Highstock, Gantt) If the label is closer than this to a
  106159. * neighbour graph, draw a connector.
  106160. */
  106161. connectorNeighbourDistance?: number;
  106162. /**
  106163. * (Highcharts, Highstock, Gantt) Enable the series label per series.
  106164. */
  106165. enabled?: boolean;
  106166. /**
  106167. * (Highcharts, Highstock, Gantt) A format string for the label, with
  106168. * support for a subset of HTML. Variables are enclosed by curly brackets.
  106169. * Available variables are `name`, `options.xxx`, `color` and other members
  106170. * from the `series` object. Use this option also to set a static text for
  106171. * the label.
  106172. */
  106173. format?: string;
  106174. /**
  106175. * (Highcharts, Highstock, Gantt) Callback function to format each of the
  106176. * series' labels. The `this` keyword refers to the series object. By
  106177. * default the `formatter` is undefined and the `series.name` is rendered.
  106178. */
  106179. formatter?: FormatterCallbackFunction<Series>;
  106180. /**
  106181. * (Highcharts, Highstock, Gantt) For area-like series, allow the font size
  106182. * to vary so that small areas get a smaller font size. The default applies
  106183. * this effect to area-like series but not line-like series.
  106184. */
  106185. maxFontSize?: (number|null);
  106186. /**
  106187. * (Highcharts, Highstock, Gantt) For area-like series, allow the font size
  106188. * to vary so that small areas get a smaller font size. The default applies
  106189. * this effect to area-like series but not line-like series.
  106190. */
  106191. minFontSize?: (number|null);
  106192. /**
  106193. * (Highcharts, Highstock, Gantt) Draw the label on the area of an area
  106194. * series. By default it is drawn on the area. Set it to `false` to draw it
  106195. * next to the graph instead.
  106196. */
  106197. onArea?: (boolean|null);
  106198. /**
  106199. * (Highcharts, Highstock, Gantt) Styles for the series label. The color
  106200. * defaults to the series color, or a contrast color if `onArea`.
  106201. */
  106202. style?: CSSObject;
  106203. }
  106204. /**
  106205. * (Highstock) The line marks the last price from all points.
  106206. */
  106207. export interface SeriesLastPriceOptionsObject {
  106208. /**
  106209. * (Highstock) The color of the line of last price.
  106210. */
  106211. color?: string;
  106212. /**
  106213. * (Highstock) Enable or disable the indicator.
  106214. */
  106215. enabled?: boolean;
  106216. }
  106217. export interface SeriesLastVisiblePriceLabelOptionsObject {
  106218. /**
  106219. * (Highstock) Enable or disable the label.
  106220. */
  106221. enabled?: boolean;
  106222. }
  106223. /**
  106224. * (Highstock) The line marks the last price from visible range of points.
  106225. */
  106226. export interface SeriesLastVisiblePriceOptionsObject {
  106227. /**
  106228. * (Highstock) Enable or disable the indicator.
  106229. */
  106230. enabled?: boolean;
  106231. label?: SeriesLastVisiblePriceLabelOptionsObject;
  106232. }
  106233. /**
  106234. * Information about the legend click event.
  106235. */
  106236. export interface SeriesLegendItemClickEventObject {
  106237. /**
  106238. * Related browser event.
  106239. */
  106240. browserEvent: PointerEvent;
  106241. /**
  106242. * Prevent the default action of toggle the visibility of the series.
  106243. */
  106244. preventDefault: Function;
  106245. /**
  106246. * Related series.
  106247. */
  106248. target: Series;
  106249. /**
  106250. * Event type.
  106251. */
  106252. type: "legendItemClick";
  106253. }
  106254. /**
  106255. * (Highstock) A linear regression intercept series. If the type option is not
  106256. * specified, it is inherited from chart.type.
  106257. *
  106258. * In TypeScript the type option must always be set.
  106259. *
  106260. * Configuration options for the series are given in three levels:
  106261. *
  106262. * 1. Options for all series in a chart are defined in the plotOptions.series
  106263. * object.
  106264. *
  106265. * 2. Options for all `linearregressionangle` series are defined in
  106266. * plotOptions.linearregressionangle.
  106267. *
  106268. * 3. Options for one single series are given in the series instance array. (see
  106269. * online documentation for example)
  106270. *
  106271. * You have to extend the `SeriesLinearregressionangleOptions` via an interface
  106272. * to allow custom properties: ``` declare interface
  106273. * SeriesLinearregressionangleOptions { customProperty: string; }
  106274. *
  106275. */
  106276. export interface SeriesLinearregressionangleOptions extends PlotLinearregressionangleOptions, SeriesOptions {
  106277. /**
  106278. * Not available
  106279. */
  106280. dataParser?: undefined;
  106281. /**
  106282. * Not available
  106283. */
  106284. dataURL?: undefined;
  106285. /**
  106286. * (Highcharts, Highstock, Highmaps, Gantt) This property is only in
  106287. * TypeScript non-optional and might be `undefined` in series objects from
  106288. * unknown sources.
  106289. */
  106290. type: "linearregressionangle";
  106291. }
  106292. /**
  106293. * (Highstock) A linear regression intercept series. If the type option is not
  106294. * specified, it is inherited from chart.type.
  106295. *
  106296. * In TypeScript the type option must always be set.
  106297. *
  106298. * Configuration options for the series are given in three levels:
  106299. *
  106300. * 1. Options for all series in a chart are defined in the plotOptions.series
  106301. * object.
  106302. *
  106303. * 2. Options for all `linearregressionintercept` series are defined in
  106304. * plotOptions.linearregressionintercept.
  106305. *
  106306. * 3. Options for one single series are given in the series instance array. (see
  106307. * online documentation for example)
  106308. *
  106309. * You have to extend the `SeriesLinearregressioninterceptOptions` via an
  106310. * interface to allow custom properties: ``` declare interface
  106311. * SeriesLinearregressioninterceptOptions { customProperty: string; }
  106312. *
  106313. */
  106314. export interface SeriesLinearregressioninterceptOptions extends PlotLinearregressioninterceptOptions, SeriesOptions {
  106315. /**
  106316. * Not available
  106317. */
  106318. dataParser?: undefined;
  106319. /**
  106320. * Not available
  106321. */
  106322. dataURL?: undefined;
  106323. /**
  106324. * (Highcharts, Highstock, Highmaps, Gantt) This property is only in
  106325. * TypeScript non-optional and might be `undefined` in series objects from
  106326. * unknown sources.
  106327. */
  106328. type: "linearregressionintercept";
  106329. }
  106330. /**
  106331. * (Highstock) A linear regression series. If the type option is not specified,
  106332. * it is inherited from chart.type.
  106333. *
  106334. * In TypeScript the type option must always be set.
  106335. *
  106336. * Configuration options for the series are given in three levels:
  106337. *
  106338. * 1. Options for all series in a chart are defined in the plotOptions.series
  106339. * object.
  106340. *
  106341. * 2. Options for all `linearregression` series are defined in
  106342. * plotOptions.linearregression.
  106343. *
  106344. * 3. Options for one single series are given in the series instance array. (see
  106345. * online documentation for example)
  106346. *
  106347. * You have to extend the `SeriesLinearregressionOptions` via an interface to
  106348. * allow custom properties: ``` declare interface SeriesLinearregressionOptions
  106349. * { customProperty: string; }
  106350. *
  106351. */
  106352. export interface SeriesLinearregressionOptions extends PlotLinearregressionOptions, SeriesOptions {
  106353. /**
  106354. * Not available
  106355. */
  106356. dataParser?: undefined;
  106357. /**
  106358. * Not available
  106359. */
  106360. dataURL?: undefined;
  106361. /**
  106362. * (Highcharts, Highstock, Highmaps, Gantt) This property is only in
  106363. * TypeScript non-optional and might be `undefined` in series objects from
  106364. * unknown sources.
  106365. */
  106366. type: "linearregression";
  106367. }
  106368. /**
  106369. * (Highstock) A linear regression intercept series. If the type option is not
  106370. * specified, it is inherited from chart.type.
  106371. *
  106372. * In TypeScript the type option must always be set.
  106373. *
  106374. * Configuration options for the series are given in three levels:
  106375. *
  106376. * 1. Options for all series in a chart are defined in the plotOptions.series
  106377. * object.
  106378. *
  106379. * 2. Options for all `linearregressionslope` series are defined in
  106380. * plotOptions.linearregressionslope.
  106381. *
  106382. * 3. Options for one single series are given in the series instance array. (see
  106383. * online documentation for example)
  106384. *
  106385. * You have to extend the `SeriesLinearregressionslopeOptions` via an interface
  106386. * to allow custom properties: ``` declare interface
  106387. * SeriesLinearregressionslopeOptions { customProperty: string; }
  106388. *
  106389. */
  106390. export interface SeriesLinearregressionslopeOptions extends PlotLinearregressionslopeOptions, SeriesOptions {
  106391. /**
  106392. * Not available
  106393. */
  106394. dataParser?: undefined;
  106395. /**
  106396. * Not available
  106397. */
  106398. dataURL?: undefined;
  106399. /**
  106400. * (Highcharts, Highstock, Highmaps, Gantt) This property is only in
  106401. * TypeScript non-optional and might be `undefined` in series objects from
  106402. * unknown sources.
  106403. */
  106404. type: "linearregressionslope";
  106405. }
  106406. /**
  106407. * (Highcharts, Highstock, Gantt) Enable or disable the initial animation when a
  106408. * series is displayed for the `dataLabels`. The animation can also be set as a
  106409. * configuration object. Please note that this option only applies to the
  106410. * initial animation. For other animations, see chart.animation and the
  106411. * animation parameter under the API methods. The following properties are
  106412. * supported:
  106413. *
  106414. * - `defer`: The animation delay time in milliseconds.
  106415. */
  106416. export interface SeriesLineDataDataLabelsAnimationOptions {
  106417. /**
  106418. * (Highcharts, Highstock, Gantt) The animation delay time in milliseconds.
  106419. * Set to `0` renders dataLabel immediately. As `undefined` inherits defer
  106420. * time from the series.animation.defer.
  106421. */
  106422. defer?: number;
  106423. }
  106424. /**
  106425. * (Highcharts, Highstock) Style options for the guide box. The guide box has
  106426. * one state by default, the `default` state.
  106427. */
  106428. export interface SeriesLineDataDragDropGuideBoxOptions {
  106429. /**
  106430. * (Highcharts, Highstock) Style options for the guide box default state.
  106431. */
  106432. default?: DragDropGuideBoxOptionsObject;
  106433. }
  106434. /**
  106435. * (Highcharts, Highstock, Gantt) Point specific options for the
  106436. * draggable-points module. Overrides options on `series.dragDrop`.
  106437. */
  106438. export interface SeriesLineDataDragDropOptions {
  106439. /**
  106440. * (Highcharts, Highstock, Gantt) Enable dragging in the X dimension.
  106441. */
  106442. draggableX?: boolean;
  106443. /**
  106444. * (Highcharts, Highstock, Gantt) Enable dragging in the Y dimension. Note
  106445. * that this is not supported for TreeGrid axes (the default axis type in
  106446. * Gantt charts).
  106447. */
  106448. draggableY?: boolean;
  106449. /**
  106450. * (Highcharts, Highstock, Gantt) Options for the drag handles.
  106451. */
  106452. dragHandle?: DragDropHandleOptionsObject;
  106453. /**
  106454. * (Highcharts, Highstock, Gantt) Set the maximum X value the points can be
  106455. * moved to.
  106456. */
  106457. dragMaxX?: number;
  106458. /**
  106459. * (Highcharts, Highstock, Gantt) Set the maximum Y value the points can be
  106460. * moved to.
  106461. */
  106462. dragMaxY?: number;
  106463. /**
  106464. * (Highcharts, Highstock, Gantt) Set the minimum X value the points can be
  106465. * moved to.
  106466. */
  106467. dragMinX?: number;
  106468. /**
  106469. * (Highcharts, Highstock, Gantt) Set the minimum Y value the points can be
  106470. * moved to.
  106471. */
  106472. dragMinY?: number;
  106473. /**
  106474. * (Highcharts, Highstock, Gantt) The X precision value to drag to for this
  106475. * series. Set to 0 to disable. By default this is disabled, except for
  106476. * category axes, where the default is 1.
  106477. */
  106478. dragPrecisionX?: number;
  106479. /**
  106480. * (Highcharts, Highstock, Gantt) The Y precision value to drag to for this
  106481. * series. Set to 0 to disable. By default this is disabled, except for
  106482. * category axes, where the default is 1.
  106483. */
  106484. dragPrecisionY?: number;
  106485. /**
  106486. * (Highcharts, Highstock, Gantt) The amount of pixels to drag the pointer
  106487. * before it counts as a drag operation. This prevents drag/drop to fire
  106488. * when just clicking or selecting points.
  106489. */
  106490. dragSensitivity?: number;
  106491. /**
  106492. * (Highcharts, Highstock, Gantt) Group the points by a property. Points
  106493. * with the same property value will be grouped together when moving.
  106494. */
  106495. groupBy?: string;
  106496. /**
  106497. * (Highcharts, Highstock, Gantt) Style options for the guide box. The guide
  106498. * box has one state by default, the `default` state.
  106499. */
  106500. guideBox?: (SeriesAreaDataDragDropGuideBoxOptions|SeriesArearangeDataDragDropGuideBoxOptions|SeriesAreasplineDataDragDropGuideBoxOptions|SeriesAreasplinerangeDataDragDropGuideBoxOptions|
  106501. SeriesBarDataDragDropGuideBoxOptions|SeriesBoxplotDataDragDropGuideBoxOptions|SeriesBubbleDataDragDropGuideBoxOptions|SeriesBulletDataDragDropGuideBoxOptions|
  106502. SeriesCandlestickDataDragDropGuideBoxOptions|SeriesColumnDataDragDropGuideBoxOptions|SeriesColumnpyramidDataDragDropGuideBoxOptions|SeriesColumnrangeDataDragDropGuideBoxOptions|
  106503. SeriesCylinderDataDragDropGuideBoxOptions|SeriesDumbbellDataDragDropGuideBoxOptions|SeriesErrorbarDataDragDropGuideBoxOptions|SeriesFlagsDataDragDropGuideBoxOptions|
  106504. SeriesFunnelDataDragDropGuideBoxOptions|SeriesGanttDataDragDropGuideBoxOptions|SeriesGaugeDataDragDropGuideBoxOptions|SeriesHeatmapDataDragDropGuideBoxOptions|SeriesItemDataDragDropGuideBoxOptions|
  106505. SeriesLineDataDragDropGuideBoxOptions|SeriesLollipopDataDragDropGuideBoxOptions|SeriesNetworkgraphDataDragDropGuideBoxOptions|SeriesOhlcDataDragDropGuideBoxOptions|
  106506. SeriesPackedbubbleDataDragDropGuideBoxOptions|SeriesParetoDataDragDropGuideBoxOptions|SeriesPieDataDragDropGuideBoxOptions|SeriesPolygonDataDragDropGuideBoxOptions|
  106507. SeriesPyramidDataDragDropGuideBoxOptions|SeriesScatter3dDataDragDropGuideBoxOptions|SeriesScatterDataDragDropGuideBoxOptions|SeriesSolidgaugeDataDragDropGuideBoxOptions|
  106508. SeriesSplineDataDragDropGuideBoxOptions|SeriesStreamgraphDataDragDropGuideBoxOptions|SeriesSunburstDataDragDropGuideBoxOptions|SeriesTilemapDataDragDropGuideBoxOptions|
  106509. SeriesTimelineDataDragDropGuideBoxOptions|SeriesTreemapDataDragDropGuideBoxOptions|SeriesVariablepieDataDragDropGuideBoxOptions|SeriesVariwideDataDragDropGuideBoxOptions|
  106510. SeriesVectorDataDragDropGuideBoxOptions|SeriesVennDataDragDropGuideBoxOptions|SeriesWaterfallDataDragDropGuideBoxOptions|SeriesWindbarbDataDragDropGuideBoxOptions|
  106511. SeriesWordcloudDataDragDropGuideBoxOptions|SeriesXrangeDataDragDropGuideBoxOptions|Dictionary<DragDropGuideBoxOptionsObject>);
  106512. /**
  106513. * (Highcharts, Highstock, Gantt) Update points as they are dragged. If
  106514. * false, a guide box is drawn to illustrate the new point size.
  106515. */
  106516. liveRedraw?: boolean;
  106517. }
  106518. /**
  106519. * (Highcharts, Highstock) A `line` series. If the type option is not specified,
  106520. * it is inherited from chart.type.
  106521. *
  106522. * In TypeScript the type option must always be set.
  106523. *
  106524. * Configuration options for the series are given in three levels:
  106525. *
  106526. * 1. Options for all series in a chart are defined in the plotOptions.series
  106527. * object.
  106528. *
  106529. * 2. Options for all `line` series are defined in plotOptions.line.
  106530. *
  106531. * 3. Options for one single series are given in the series instance array. (see
  106532. * online documentation for example)
  106533. *
  106534. * You have to extend the `SeriesLineOptions` via an interface to allow custom
  106535. * properties: ``` declare interface SeriesLineOptions { customProperty: string;
  106536. * }
  106537. *
  106538. */
  106539. export interface SeriesLineOptions extends PlotLineOptions, SeriesOptions {
  106540. /**
  106541. * (Highcharts, Highstock) An array of data points for the series. For the
  106542. * `line` series type, points can be given in the following ways:
  106543. *
  106544. * 1. An array of numerical values. In this case, the numerical values will
  106545. * be interpreted as `y` options. The `x` values will be automatically
  106546. * calculated, either starting at 0 and incremented by 1, or from
  106547. * `pointStart` and `pointInterval` given in the series options. If the axis
  106548. * has categories, these will be used. Example: (see online documentation
  106549. * for example)
  106550. *
  106551. * 2. An array of arrays with 2 values. In this case, the values correspond
  106552. * to `x,y`. If the first value is a string, it is applied as the name of
  106553. * the point, and the `x` value is inferred. (see online documentation for
  106554. * example)
  106555. *
  106556. * 3. An array of objects with named values. The following snippet shows
  106557. * only a few settings, see the complete options set below. If the total
  106558. * number of data points exceeds the series' turboThreshold, this option is
  106559. * not available. (see online documentation for example)
  106560. *
  106561. * **Note:** In TypeScript you have to extend `PointOptionsObject` with an
  106562. * additional declaration to allow custom data types: ```ts declare module
  106563. * `highcharts` { interface PointOptionsObject { custom: Record<string,
  106564. * (boolean|number|string)>; } } ```
  106565. */
  106566. data?: Array<(number|[(number|string), (number|null)]|null|PointOptionsObject)>;
  106567. /**
  106568. * Not available
  106569. */
  106570. dataParser?: undefined;
  106571. /**
  106572. * Not available
  106573. */
  106574. dataURL?: undefined;
  106575. /**
  106576. * (Highcharts, Highstock, Highmaps, Gantt) This property is only in
  106577. * TypeScript non-optional and might be `undefined` in series objects from
  106578. * unknown sources.
  106579. */
  106580. type: "line";
  106581. }
  106582. /**
  106583. * (Highcharts, Highstock) Enable or disable the initial animation when a series
  106584. * is displayed for the `dataLabels`. The animation can also be set as a
  106585. * configuration object. Please note that this option only applies to the
  106586. * initial animation. For other animations, see chart.animation and the
  106587. * animation parameter under the API methods. The following properties are
  106588. * supported:
  106589. *
  106590. * - `defer`: The animation delay time in milliseconds.
  106591. */
  106592. export interface SeriesLollipopDataDataLabelsAnimationOptions {
  106593. /**
  106594. * (Highcharts, Highstock) The animation delay time in milliseconds. Set to
  106595. * `0` renders dataLabel immediately. As `undefined` inherits defer time
  106596. * from the series.animation.defer.
  106597. */
  106598. defer?: number;
  106599. }
  106600. /**
  106601. * (Highcharts, Highstock) Style options for the guide box. The guide box has
  106602. * one state by default, the `default` state.
  106603. */
  106604. export interface SeriesLollipopDataDragDropGuideBoxOptions {
  106605. /**
  106606. * (Highcharts, Highstock) Style options for the guide box default state.
  106607. */
  106608. default?: DragDropGuideBoxOptionsObject;
  106609. }
  106610. /**
  106611. * (Highcharts, Highstock) The `lollipop` series. If the type option is not
  106612. * specified, it is inherited from chart.type.
  106613. *
  106614. * In TypeScript the type option must always be set.
  106615. *
  106616. * Configuration options for the series are given in three levels:
  106617. *
  106618. * 1. Options for all series in a chart are defined in the plotOptions.series
  106619. * object.
  106620. *
  106621. * 2. Options for all `lollipop` series are defined in plotOptions.lollipop.
  106622. *
  106623. * 3. Options for one single series are given in the series instance array. (see
  106624. * online documentation for example)
  106625. *
  106626. * You have to extend the `SeriesLollipopOptions` via an interface to allow
  106627. * custom properties: ``` declare interface SeriesLollipopOptions {
  106628. * customProperty: string; }
  106629. *
  106630. */
  106631. export interface SeriesLollipopOptions extends PlotLollipopOptions, SeriesOptions {
  106632. /**
  106633. * (Highcharts, Highstock) An array of data points for the series. For the
  106634. * `lollipop` series type, points can be given in the following ways:
  106635. *
  106636. * 1. An array of numerical values. In this case, the numerical values will
  106637. * be interpreted as `y` options. The `x` values will be automatically
  106638. * calculated, either starting at 0 and incremented by 1, or from
  106639. * `pointStart` and `pointInterval` given in the series options. If the axis
  106640. * has categories, these will be used. Example: (see online documentation
  106641. * for example)
  106642. *
  106643. * 2. An array of arrays with 2 values. In this case, the values correspond
  106644. * to `x,y`. If the first value is a string, it is applied as the name of
  106645. * the point, and the `x` value is inferred. (see online documentation for
  106646. * example)
  106647. *
  106648. * 3. An array of objects with named values. The following snippet shows
  106649. * only a few settings, see the complete options set below. If the total
  106650. * number of data points exceeds the series' turboThreshold, this option is
  106651. * not available. (see online documentation for example)
  106652. */
  106653. data?: Array<(number|[(number|string), (number|null)]|null|PointOptionsObject)>;
  106654. /**
  106655. * (Highcharts, Highstock, Highmaps, Gantt) This property is only in
  106656. * TypeScript non-optional and might be `undefined` in series objects from
  106657. * unknown sources.
  106658. */
  106659. type: "lollipop";
  106660. }
  106661. /**
  106662. * (Highstock) A `MACD` series. If the type option is not specified, it is
  106663. * inherited from chart.type.
  106664. *
  106665. * In TypeScript the type option must always be set.
  106666. *
  106667. * Configuration options for the series are given in three levels:
  106668. *
  106669. * 1. Options for all series in a chart are defined in the plotOptions.series
  106670. * object.
  106671. *
  106672. * 2. Options for all `macd` series are defined in plotOptions.macd.
  106673. *
  106674. * 3. Options for one single series are given in the series instance array. (see
  106675. * online documentation for example)
  106676. *
  106677. * You have to extend the `SeriesMacdOptions` via an interface to allow custom
  106678. * properties: ``` declare interface SeriesMacdOptions { customProperty: string;
  106679. * }
  106680. *
  106681. */
  106682. export interface SeriesMacdOptions extends PlotMacdOptions, SeriesOptions {
  106683. /**
  106684. * Not available
  106685. */
  106686. dataParser?: undefined;
  106687. /**
  106688. * Not available
  106689. */
  106690. dataURL?: undefined;
  106691. /**
  106692. * (Highcharts, Highstock, Highmaps, Gantt) This property is only in
  106693. * TypeScript non-optional and might be `undefined` in series objects from
  106694. * unknown sources.
  106695. */
  106696. type: "macd";
  106697. }
  106698. /**
  106699. * (Highmaps) An array of data points for the series. For the `mapbubble` series
  106700. * type, points can be given in the following ways:
  106701. *
  106702. * 1. An array of numerical values. In this case, the numerical values will be
  106703. * interpreted as `z` options. Example: (see online documentation for example)
  106704. *
  106705. * 2. An array of objects with named values. The following snippet shows only a
  106706. * few settings, see the complete options set below. If the total number of data
  106707. * points exceeds the series' turboThreshold, this option is not available. (see
  106708. * online documentation for example)
  106709. */
  106710. export interface SeriesMapbubbleDataOptions {
  106711. /**
  106712. * (Highmaps) Individual color for the point. By default the color is either
  106713. * used to denote the value, or pulled from the global `colors` array.
  106714. */
  106715. color?: (ColorString|GradientColorObject|PatternObject);
  106716. /**
  106717. * (Highmaps) Individual data label for each point. The options are the same
  106718. * as the ones for plotOptions.series.dataLabels.
  106719. */
  106720. dataLabels?: DataLabelsOptions;
  106721. /**
  106722. * (Highmaps) The `id` of a series in the drilldown.series array to use for
  106723. * a drilldown for this point.
  106724. */
  106725. drilldown?: string;
  106726. /**
  106727. * (Highmaps) Individual point events
  106728. */
  106729. events?: PointEventsOptionsObject;
  106730. /**
  106731. * (Highmaps) An id for the point. This can be used after render time to get
  106732. * a pointer to the point object through `chart.get()`.
  106733. */
  106734. id?: string;
  106735. /**
  106736. * (Highmaps) The name of the point as shown in the legend, tooltip,
  106737. * dataLabel etc.
  106738. */
  106739. name?: string;
  106740. /**
  106741. * (Highmaps) While the `x` and `y` values of the bubble are determined by
  106742. * the underlying map, the `z` indicates the actual value that gives the
  106743. * size of the bubble.
  106744. */
  106745. z?: (number|null);
  106746. }
  106747. /**
  106748. * (Highmaps) A `mapbubble` series. If the type option is not specified, it is
  106749. * inherited from chart.type.
  106750. *
  106751. * In TypeScript the type option must always be set.
  106752. *
  106753. * Configuration options for the series are given in three levels:
  106754. *
  106755. * 1. Options for all series in a chart are defined in the plotOptions.series
  106756. * object.
  106757. *
  106758. * 2. Options for all `mapbubble` series are defined in plotOptions.mapbubble.
  106759. *
  106760. * 3. Options for one single series are given in the series instance array. (see
  106761. * online documentation for example)
  106762. *
  106763. * You have to extend the `SeriesMapbubbleOptions` via an interface to allow
  106764. * custom properties: ``` declare interface SeriesMapbubbleOptions {
  106765. * customProperty: string; }
  106766. *
  106767. */
  106768. export interface SeriesMapbubbleOptions extends PlotMapbubbleOptions, SeriesOptions {
  106769. /**
  106770. * (Highmaps) An array of data points for the series. For the `mapbubble`
  106771. * series type, points can be given in the following ways:
  106772. *
  106773. * 1. An array of numerical values. In this case, the numerical values will
  106774. * be interpreted as `z` options. Example: (see online documentation for
  106775. * example)
  106776. *
  106777. * 2. An array of objects with named values. The following snippet shows
  106778. * only a few settings, see the complete options set below. If the total
  106779. * number of data points exceeds the series' turboThreshold, this option is
  106780. * not available. (see online documentation for example)
  106781. */
  106782. data?: Array<(number|null|SeriesMapbubbleDataOptions)>;
  106783. /**
  106784. * Not available
  106785. */
  106786. dataParser?: undefined;
  106787. /**
  106788. * Not available
  106789. */
  106790. dataURL?: undefined;
  106791. /**
  106792. * (Highcharts, Highstock, Highmaps, Gantt) This property is only in
  106793. * TypeScript non-optional and might be `undefined` in series objects from
  106794. * unknown sources.
  106795. */
  106796. type: "mapbubble";
  106797. }
  106798. /**
  106799. * (Highmaps) An array of data points for the series. For the `map` series type,
  106800. * points can be given in the following ways:
  106801. *
  106802. * 1. An array of numerical values. In this case, the numerical values will be
  106803. * interpreted as `value` options. Example: (see online documentation for
  106804. * example)
  106805. *
  106806. * 2. An array of arrays with 2 values. In this case, the values correspond to
  106807. * `[hc-key, value]`. Example: (see online documentation for example)
  106808. *
  106809. * 3. An array of objects with named values. The following snippet shows only a
  106810. * few settings, see the complete options set below. If the total number of data
  106811. * points exceeds the series' turboThreshold, this option is not available. (see
  106812. * online documentation for example)
  106813. */
  106814. export interface SeriesMapDataOptions {
  106815. /**
  106816. * (Highmaps) Individual color for the point. By default the color is either
  106817. * used to denote the value, or pulled from the global `colors` array.
  106818. */
  106819. color?: (ColorString|GradientColorObject|PatternObject);
  106820. /**
  106821. * (Highmaps) Individual data label for each point. The options are the same
  106822. * as the ones for plotOptions.series.dataLabels.
  106823. */
  106824. dataLabels?: DataLabelsOptions;
  106825. /**
  106826. * (Highmaps) The `id` of a series in the drilldown.series array to use for
  106827. * a drilldown for this point.
  106828. */
  106829. drilldown?: string;
  106830. /**
  106831. * (Highmaps) Individual point events
  106832. */
  106833. events?: PointEventsOptionsObject;
  106834. /**
  106835. * (Highmaps) An id for the point. This can be used after render time to get
  106836. * a pointer to the point object through `chart.get()`.
  106837. */
  106838. id?: string;
  106839. /**
  106840. * (Highmaps) When data labels are laid out on a map, Highmaps runs a
  106841. * simplified algorithm to detect collision. When two labels collide, the
  106842. * one with the lowest rank is hidden. By default the rank is computed from
  106843. * the area.
  106844. */
  106845. labelrank?: number;
  106846. /**
  106847. * (Highmaps) The relative mid point of an area, used to place the data
  106848. * label. Ranges from 0 to 1\. When `mapData` is used, middleX can be
  106849. * defined there.
  106850. */
  106851. middleX?: number;
  106852. /**
  106853. * (Highmaps) The relative mid point of an area, used to place the data
  106854. * label. Ranges from 0 to 1\. When `mapData` is used, middleY can be
  106855. * defined there.
  106856. */
  106857. middleY?: number;
  106858. /**
  106859. * (Highmaps) The name of the point as shown in the legend, tooltip,
  106860. * dataLabel etc.
  106861. */
  106862. name?: string;
  106863. /**
  106864. * (Highmaps) For map and mapline series types, the SVG path for the shape.
  106865. * For compatibily with old IE, not all SVG path definitions are supported,
  106866. * but M, L and C operators are safe.
  106867. *
  106868. * To achieve a better separation between the structure and the data, it is
  106869. * recommended to use `mapData` to define that paths instead of defining
  106870. * them on the data points themselves.
  106871. */
  106872. path?: string;
  106873. /**
  106874. * (Highmaps) The numeric value of the data point.
  106875. */
  106876. value?: (number|null);
  106877. }
  106878. /**
  106879. * (Highmaps) A `mapline` series. If the type option is not specified, it is
  106880. * inherited from chart.type.
  106881. *
  106882. * In TypeScript the type option must always be set.
  106883. *
  106884. * Configuration options for the series are given in three levels:
  106885. *
  106886. * 1. Options for all series in a chart are defined in the plotOptions.series
  106887. * object.
  106888. *
  106889. * 2. Options for all `mapline` series are defined in plotOptions.mapline.
  106890. *
  106891. * 3. Options for one single series are given in the series instance array. (see
  106892. * online documentation for example)
  106893. *
  106894. * You have to extend the `SeriesMaplineOptions` via an interface to allow
  106895. * custom properties: ``` declare interface SeriesMaplineOptions {
  106896. * customProperty: string; }
  106897. *
  106898. */
  106899. export interface SeriesMaplineOptions extends PlotMaplineOptions, SeriesOptions {
  106900. /**
  106901. * (Highmaps) An array of data points for the series. For the `mapline`
  106902. * series type, points can be given in the following ways:
  106903. *
  106904. * 1. An array of numerical values. In this case, the numerical values will
  106905. * be interpreted as `value` options. Example: (see online documentation for
  106906. * example)
  106907. *
  106908. * 2. An array of arrays with 2 values. In this case, the values correspond
  106909. * to `[hc-key, value]`. Example: (see online documentation for example)
  106910. *
  106911. * 3. An array of objects with named values. The following snippet shows
  106912. * only a few settings, see the complete options set below. If the total
  106913. * number of data points exceeds the series' turboThreshold, this option is
  106914. * not available. (see online documentation for example)
  106915. */
  106916. data?: Array<(number|[string, (number|null)]|null|any)>;
  106917. /**
  106918. * Not available
  106919. */
  106920. dataParser?: undefined;
  106921. /**
  106922. * Not available
  106923. */
  106924. dataURL?: undefined;
  106925. /**
  106926. * (Highcharts, Highstock, Highmaps, Gantt) This property is only in
  106927. * TypeScript non-optional and might be `undefined` in series objects from
  106928. * unknown sources.
  106929. */
  106930. type: "mapline";
  106931. }
  106932. /**
  106933. * (Highmaps) A `map` series. If the type option is not specified, it is
  106934. * inherited from chart.type.
  106935. *
  106936. * In TypeScript the type option must always be set.
  106937. *
  106938. * Configuration options for the series are given in three levels:
  106939. *
  106940. * 1. Options for all series in a chart are defined in the plotOptions.series
  106941. * object.
  106942. *
  106943. * 2. Options for all `map` series are defined in plotOptions.map.
  106944. *
  106945. * 3. Options for one single series are given in the series instance array. (see
  106946. * online documentation for example)
  106947. *
  106948. * You have to extend the `SeriesMapOptions` via an interface to allow custom
  106949. * properties: ``` declare interface SeriesMapOptions { customProperty: string;
  106950. * }
  106951. *
  106952. */
  106953. export interface SeriesMapOptions extends PlotMapOptions, SeriesOptions {
  106954. /**
  106955. * (Highmaps) An array of data points for the series. For the `map` series
  106956. * type, points can be given in the following ways:
  106957. *
  106958. * 1. An array of numerical values. In this case, the numerical values will
  106959. * be interpreted as `value` options. Example: (see online documentation for
  106960. * example)
  106961. *
  106962. * 2. An array of arrays with 2 values. In this case, the values correspond
  106963. * to `[hc-key, value]`. Example: (see online documentation for example)
  106964. *
  106965. * 3. An array of objects with named values. The following snippet shows
  106966. * only a few settings, see the complete options set below. If the total
  106967. * number of data points exceeds the series' turboThreshold, this option is
  106968. * not available. (see online documentation for example)
  106969. */
  106970. data?: Array<(number|[string, (number|null)]|null|SeriesMapDataOptions)>;
  106971. /**
  106972. * Not available
  106973. */
  106974. dataParser?: undefined;
  106975. /**
  106976. * Not available
  106977. */
  106978. dataURL?: undefined;
  106979. /**
  106980. * (Highcharts, Highstock, Highmaps, Gantt) This property is only in
  106981. * TypeScript non-optional and might be `undefined` in series objects from
  106982. * unknown sources.
  106983. */
  106984. type: "map";
  106985. }
  106986. /**
  106987. * (Highmaps) An array of data points for the series. For the `mappoint` series
  106988. * type, points can be given in the following ways:
  106989. *
  106990. * 1. An array of numerical values. In this case, the numerical values will be
  106991. * interpreted as `y` options. The `x` values will be automatically calculated,
  106992. * either starting at 0 and incremented by 1, or from `pointStart` and
  106993. * `pointInterval` given in the series options. If the axis has categories,
  106994. * these will be used. Example: (see online documentation for example)
  106995. *
  106996. * 2. An array of arrays with 2 values. In this case, the values correspond to
  106997. * `x,y`. If the first value is a string, it is applied as the name of the
  106998. * point, and the `x` value is inferred. (see online documentation for example)
  106999. *
  107000. * 3. An array of objects with named values. The following snippet shows only a
  107001. * few settings, see the complete options set below. If the total number of data
  107002. * points exceeds the series' turboThreshold, this option is not available. (see
  107003. * online documentation for example)
  107004. */
  107005. export interface SeriesMappointDataOptions {
  107006. /**
  107007. * (Highmaps) Individual color for the point. By default the color is either
  107008. * used to denote the value, or pulled from the global `colors` array.
  107009. */
  107010. color?: (ColorString|GradientColorObject|PatternObject);
  107011. /**
  107012. * (Highmaps) Individual data label for each point. The options are the same
  107013. * as the ones for plotOptions.series.dataLabels.
  107014. */
  107015. dataLabels?: DataLabelsOptions;
  107016. /**
  107017. * (Highmaps) The `id` of a series in the drilldown.series array to use for
  107018. * a drilldown for this point.
  107019. */
  107020. drilldown?: string;
  107021. /**
  107022. * (Highmaps) Individual point events
  107023. */
  107024. events?: PointEventsOptionsObject;
  107025. /**
  107026. * (Highmaps) An id for the point. This can be used after render time to get
  107027. * a pointer to the point object through `chart.get()`.
  107028. */
  107029. id?: string;
  107030. /**
  107031. * (Highmaps) The latitude of the point. Must be combined with the `lon`
  107032. * option to work. Overrides `x` and `y` values.
  107033. */
  107034. lat?: number;
  107035. /**
  107036. * (Highmaps) The longitude of the point. Must be combined with the `lon`
  107037. * option to work. Overrides `x` and `y` values.
  107038. */
  107039. lon?: number;
  107040. /**
  107041. * (Highmaps) The name of the point as shown in the legend, tooltip,
  107042. * dataLabel etc.
  107043. */
  107044. name?: string;
  107045. /**
  107046. * (Highmaps) The x coordinate of the point in terms of the map path
  107047. * coordinates.
  107048. */
  107049. x?: number;
  107050. /**
  107051. * (Highmaps) The x coordinate of the point in terms of the map path
  107052. * coordinates.
  107053. */
  107054. y?: (number|null);
  107055. }
  107056. /**
  107057. * (Highmaps) A `mappoint` series. If the type option is not specified, it is
  107058. * inherited from chart.type.
  107059. *
  107060. * In TypeScript the type option must always be set.
  107061. *
  107062. * Configuration options for the series are given in three levels:
  107063. *
  107064. * 1. Options for all series in a chart are defined in the plotOptions.series
  107065. * object.
  107066. *
  107067. * 2. Options for all `mappoint` series are defined in plotOptions.mappoint.
  107068. *
  107069. * 3. Options for one single series are given in the series instance array. (see
  107070. * online documentation for example)
  107071. *
  107072. * You have to extend the `SeriesMappointOptions` via an interface to allow
  107073. * custom properties: ``` declare interface SeriesMappointOptions {
  107074. * customProperty: string; }
  107075. *
  107076. */
  107077. export interface SeriesMappointOptions extends PlotMappointOptions, SeriesOptions {
  107078. /**
  107079. * (Highmaps) An array of data points for the series. For the `mappoint`
  107080. * series type, points can be given in the following ways:
  107081. *
  107082. * 1. An array of numerical values. In this case, the numerical values will
  107083. * be interpreted as `y` options. The `x` values will be automatically
  107084. * calculated, either starting at 0 and incremented by 1, or from
  107085. * `pointStart` and `pointInterval` given in the series options. If the axis
  107086. * has categories, these will be used. Example: (see online documentation
  107087. * for example)
  107088. *
  107089. * 2. An array of arrays with 2 values. In this case, the values correspond
  107090. * to `x,y`. If the first value is a string, it is applied as the name of
  107091. * the point, and the `x` value is inferred. (see online documentation for
  107092. * example)
  107093. *
  107094. * 3. An array of objects with named values. The following snippet shows
  107095. * only a few settings, see the complete options set below. If the total
  107096. * number of data points exceeds the series' turboThreshold, this option is
  107097. * not available. (see online documentation for example)
  107098. */
  107099. data?: Array<(number|[number, (number|null)]|null|SeriesMappointDataOptions)>;
  107100. /**
  107101. * Not available
  107102. */
  107103. dataParser?: undefined;
  107104. /**
  107105. * Not available
  107106. */
  107107. dataURL?: undefined;
  107108. /**
  107109. * (Highcharts, Highstock, Highmaps, Gantt) This property is only in
  107110. * TypeScript non-optional and might be `undefined` in series objects from
  107111. * unknown sources.
  107112. */
  107113. type: "mappoint";
  107114. }
  107115. /**
  107116. * (Highstock) A `MFI` series. If the type option is not specified, it is
  107117. * inherited from chart.type.
  107118. *
  107119. * In TypeScript the type option must always be set.
  107120. *
  107121. * Configuration options for the series are given in three levels:
  107122. *
  107123. * 1. Options for all series in a chart are defined in the plotOptions.series
  107124. * object.
  107125. *
  107126. * 2. Options for all `mfi` series are defined in plotOptions.mfi.
  107127. *
  107128. * 3. Options for one single series are given in the series instance array. (see
  107129. * online documentation for example)
  107130. *
  107131. * You have to extend the `SeriesMfiOptions` via an interface to allow custom
  107132. * properties: ``` declare interface SeriesMfiOptions { customProperty: string;
  107133. * }
  107134. *
  107135. */
  107136. export interface SeriesMfiOptions extends PlotMfiOptions, SeriesOptions {
  107137. /**
  107138. * Not available
  107139. */
  107140. dataParser?: undefined;
  107141. /**
  107142. * Not available
  107143. */
  107144. dataURL?: undefined;
  107145. /**
  107146. * (Highcharts, Highstock, Highmaps, Gantt) This property is only in
  107147. * TypeScript non-optional and might be `undefined` in series objects from
  107148. * unknown sources.
  107149. */
  107150. type: "mfi";
  107151. }
  107152. /**
  107153. * (Highstock) A `Momentum` series. If the type option is not specified, it is
  107154. * inherited from chart.type.
  107155. *
  107156. * In TypeScript the type option must always be set.
  107157. *
  107158. * Configuration options for the series are given in three levels:
  107159. *
  107160. * 1. Options for all series in a chart are defined in the plotOptions.series
  107161. * object.
  107162. *
  107163. * 2. Options for all `momentum` series are defined in plotOptions.momentum.
  107164. *
  107165. * 3. Options for one single series are given in the series instance array. (see
  107166. * online documentation for example)
  107167. *
  107168. * You have to extend the `SeriesMomentumOptions` via an interface to allow
  107169. * custom properties: ``` declare interface SeriesMomentumOptions {
  107170. * customProperty: string; }
  107171. *
  107172. */
  107173. export interface SeriesMomentumOptions extends PlotMomentumOptions, SeriesOptions {
  107174. /**
  107175. * Not available
  107176. */
  107177. dataParser?: undefined;
  107178. /**
  107179. * Not available
  107180. */
  107181. dataURL?: undefined;
  107182. /**
  107183. * (Highcharts, Highstock, Highmaps, Gantt) This property is only in
  107184. * TypeScript non-optional and might be `undefined` in series objects from
  107185. * unknown sources.
  107186. */
  107187. type: "momentum";
  107188. }
  107189. /**
  107190. * (Highstock) A `NATR` series. If the type option is not specified, it is
  107191. * inherited from chart.type.
  107192. *
  107193. * In TypeScript the type option must always be set.
  107194. *
  107195. * Configuration options for the series are given in three levels:
  107196. *
  107197. * 1. Options for all series in a chart are defined in the plotOptions.series
  107198. * object.
  107199. *
  107200. * 2. Options for all `natr` series are defined in plotOptions.natr.
  107201. *
  107202. * 3. Options for one single series are given in the series instance array. (see
  107203. * online documentation for example)
  107204. *
  107205. * You have to extend the `SeriesNatrOptions` via an interface to allow custom
  107206. * properties: ``` declare interface SeriesNatrOptions { customProperty: string;
  107207. * }
  107208. *
  107209. */
  107210. export interface SeriesNatrOptions extends PlotNatrOptions, SeriesOptions {
  107211. /**
  107212. * Not available
  107213. */
  107214. dataParser?: undefined;
  107215. /**
  107216. * Not available
  107217. */
  107218. dataURL?: undefined;
  107219. /**
  107220. * (Highcharts, Highstock, Highmaps, Gantt) This property is only in
  107221. * TypeScript non-optional and might be `undefined` in series objects from
  107222. * unknown sources.
  107223. */
  107224. type: "natr";
  107225. }
  107226. /**
  107227. * (Highcharts) Enable or disable the initial animation when a series is
  107228. * displayed for the `dataLabels`. The animation can also be set as a
  107229. * configuration object. Please note that this option only applies to the
  107230. * initial animation. For other animations, see chart.animation and the
  107231. * animation parameter under the API methods. The following properties are
  107232. * supported:
  107233. *
  107234. * - `defer`: The animation delay time in milliseconds.
  107235. */
  107236. export interface SeriesNetworkgraphDataDataLabelsAnimationOptions {
  107237. /**
  107238. * (Highcharts) The animation delay time in milliseconds. Set to `0` renders
  107239. * dataLabel immediately. As `undefined` inherits defer time from the
  107240. * series.animation.defer.
  107241. */
  107242. defer?: number;
  107243. }
  107244. /**
  107245. * (Highcharts) Style options for the guide box. The guide box has one state by
  107246. * default, the `default` state.
  107247. */
  107248. export interface SeriesNetworkgraphDataDragDropGuideBoxOptions {
  107249. /**
  107250. * (Highcharts) Style options for the guide box default state.
  107251. */
  107252. default?: DragDropGuideBoxOptionsObject;
  107253. }
  107254. /**
  107255. * Context for the formatter function.
  107256. */
  107257. export interface SeriesNetworkgraphDataLabelsFormatterContextObject extends PointLabelObject {
  107258. /**
  107259. * The color of the node.
  107260. */
  107261. color: ColorString;
  107262. /**
  107263. * The ID of the node.
  107264. */
  107265. key: string;
  107266. /**
  107267. * The point (node) object. The node name, if defined, is available through
  107268. * `this.point.name`. Arrays: `this.point.linksFrom` and
  107269. * `this.point.linksTo` contains all nodes connected to this point.
  107270. */
  107271. point: Point;
  107272. }
  107273. /**
  107274. * (Highcharts, Highstock, Highmaps, Gantt) Options for the series data labels,
  107275. * appearing next to each data point.
  107276. *
  107277. * Since v6.2.0, multiple data labels can be applied to each single point by
  107278. * defining them as an array of configs.
  107279. *
  107280. * In styled mode, the data labels can be styled with the
  107281. * `.highcharts-data-label-box` and `.highcharts-data-label` class names (see
  107282. * example).
  107283. */
  107284. export interface SeriesNetworkgraphDataLabelsOptionsObject {
  107285. /**
  107286. * (Highcharts, Highstock, Highmaps, Gantt) The alignment of the data label
  107287. * compared to the point. If `right`, the right side of the label should be
  107288. * touching the point. For points with an extent, like columns, the
  107289. * alignments also dictates how to align it inside the box, as given with
  107290. * the inside option. Can be one of `left`, `center` or `right`.
  107291. */
  107292. align?: (AlignValue|null);
  107293. /**
  107294. * (Highcharts, Highstock, Highmaps, Gantt) Whether to allow data labels to
  107295. * overlap. To make the labels less sensitive for overlapping, the
  107296. * dataLabels.padding can be set to 0.
  107297. */
  107298. allowOverlap?: boolean;
  107299. /**
  107300. * (Highcharts, Highstock, Highmaps, Gantt) Enable or disable the initial
  107301. * animation when a series is displayed for the `dataLabels`. The animation
  107302. * can also be set as a configuration object. Please note that this option
  107303. * only applies to the initial animation. For other animations, see
  107304. * chart.animation and the animation parameter under the API methods. The
  107305. * following properties are supported:
  107306. *
  107307. * - `defer`: The animation delay time in milliseconds.
  107308. */
  107309. animation?: (boolean|PlotNetworkgraphDataLabelsAnimationOptions|Partial<AnimationOptionsObject>);
  107310. /**
  107311. * (Highcharts, Highstock, Highmaps, Gantt) The background color or gradient
  107312. * for the data label.
  107313. */
  107314. backgroundColor?: (ColorString|GradientColorObject|PatternObject);
  107315. /**
  107316. * (Highcharts, Highstock, Highmaps, Gantt) The border color for the data
  107317. * label. Defaults to `undefined`.
  107318. */
  107319. borderColor?: (ColorString|GradientColorObject|PatternObject);
  107320. /**
  107321. * (Highcharts, Highstock, Highmaps, Gantt) The border radius in pixels for
  107322. * the data label.
  107323. */
  107324. borderRadius?: number;
  107325. /**
  107326. * (Highcharts, Highstock, Highmaps, Gantt) The border width in pixels for
  107327. * the data label.
  107328. */
  107329. borderWidth?: number;
  107330. /**
  107331. * (Highcharts, Highstock, Highmaps, Gantt) A class name for the data label.
  107332. * Particularly in styled mode, this can be used to give each series' or
  107333. * point's data label unique styling. In addition to this option, a default
  107334. * color class name is added so that we can give the labels a contrast text
  107335. * shadow.
  107336. */
  107337. className?: string;
  107338. /**
  107339. * (Highcharts, Highstock, Highmaps, Gantt) The text color for the data
  107340. * labels. Defaults to `undefined`. For certain series types, like column or
  107341. * map, the data labels can be drawn inside the points. In this case the
  107342. * data label will be drawn with maximum contrast by default. Additionally,
  107343. * it will be given a `text-outline` style with the opposite color, to
  107344. * further increase the contrast. This can be overridden by setting the
  107345. * `text-outline` style to `none` in the `dataLabels.style` option.
  107346. */
  107347. color?: (ColorString|GradientColorObject|PatternObject);
  107348. /**
  107349. * (Highcharts, Highstock, Highmaps, Gantt) Whether to hide data labels that
  107350. * are outside the plot area. By default, the data label is moved inside the
  107351. * plot area according to the overflow option.
  107352. */
  107353. crop?: boolean;
  107354. /**
  107355. * (Highcharts, Highstock, Gantt) Whether to defer displaying the data
  107356. * labels until the initial series animation has finished. Setting to
  107357. * `false` renders the data label immediately. If set to `true` inherits the
  107358. * defer time set in plotOptions.series.animation.
  107359. */
  107360. defer?: boolean;
  107361. /**
  107362. * (Highcharts, Highstock, Highmaps, Gantt) Enable or disable the data
  107363. * labels.
  107364. */
  107365. enabled?: boolean;
  107366. /**
  107367. * (Highcharts, Highstock, Highmaps, Gantt) A declarative filter to control
  107368. * of which data labels to display. The declarative filter is designed for
  107369. * use when callback functions are not available, like when the chart
  107370. * options require a pure JSON structure or for use with graphical editors.
  107371. * For programmatic control, use the `formatter` instead, and return
  107372. * `undefined` to disable a single data label.
  107373. */
  107374. filter?: DataLabelsFilterOptionsObject;
  107375. /**
  107376. * (Highcharts, Highstock, Highmaps, Gantt) The format string specifying
  107377. * what to show for _node_ in the networkgraph. In v7.0 defaults to `{key}`,
  107378. * since v7.1 defaults to `undefined` and `formatter` is used instead.
  107379. */
  107380. format?: string;
  107381. /**
  107382. * (Highcharts, Highstock, Highmaps, Gantt) Callback JavaScript function to
  107383. * format the data label for a node. Note that if a `format` is defined, the
  107384. * format takes precedence and the formatter is ignored.
  107385. */
  107386. formatter?: SeriesNetworkgraphDataLabelsFormatterCallbackFunction;
  107387. /**
  107388. * (Highcharts, Highstock, Highmaps, Gantt) For points with an extent, like
  107389. * columns or map areas, whether to align the data label inside the box or
  107390. * to the actual value point. Defaults to `false` in most cases, `true` in
  107391. * stacked columns.
  107392. */
  107393. inside?: boolean;
  107394. /**
  107395. * (Highcharts, Highstock, Highmaps, Gantt) The format string specifying
  107396. * what to show for _links_ in the networkgraph. (Default: `undefined`)
  107397. */
  107398. linkFormat?: string;
  107399. /**
  107400. * (Highcharts, Highstock, Highmaps, Gantt) Callback to format data labels
  107401. * for _links_ in the sankey diagram. The `linkFormat` option takes
  107402. * precedence over the `linkFormatter`.
  107403. */
  107404. linkFormatter?: SeriesNetworkgraphDataLabelsFormatterCallbackFunction;
  107405. /**
  107406. * (Highcharts, Highstock, Highmaps, Gantt) Options for a _link_ label text
  107407. * which should follow link connection. Border and background are disabled
  107408. * for a label that follows a path.
  107409. *
  107410. * **Note:** Only SVG-based renderer supports this option. Setting `useHTML`
  107411. * to true will disable this option.
  107412. */
  107413. linkTextPath?: DataLabelsTextPathOptionsObject;
  107414. /**
  107415. * (Highcharts, Highstock, Highmaps, Gantt) Format for points with the value
  107416. * of null. Works analogously to format. `nullFormat` can be applied only to
  107417. * series which support displaying null points.
  107418. */
  107419. nullFormat?: (boolean|string);
  107420. /**
  107421. * (Highcharts, Highstock, Highmaps, Gantt) Callback JavaScript function
  107422. * that defines formatting for points with the value of null. Works
  107423. * analogously to formatter. `nullPointFormatter` can be applied only to
  107424. * series which support displaying null points.
  107425. */
  107426. nullFormatter?: DataLabelsFormatterCallbackFunction;
  107427. /**
  107428. * (Highcharts, Highstock, Highmaps, Gantt) How to handle data labels that
  107429. * flow outside the plot area. The default is `"justify"`, which aligns them
  107430. * inside the plot area. For columns and bars, this means it will be moved
  107431. * inside the bar. To display data labels outside the plot area, set `crop`
  107432. * to `false` and `overflow` to `"allow"`.
  107433. */
  107434. overflow?: DataLabelsOverflowValue;
  107435. /**
  107436. * (Highcharts, Highstock, Highmaps, Gantt) When either the `borderWidth` or
  107437. * the `backgroundColor` is set, this is the padding within the box.
  107438. */
  107439. padding?: number;
  107440. /**
  107441. * (Highcharts, Highstock, Highmaps, Gantt) Aligns data labels relative to
  107442. * points. If `center` alignment is not possible, it defaults to `right`.
  107443. */
  107444. position?: AlignValue;
  107445. /**
  107446. * (Highcharts, Highstock, Highmaps, Gantt) Text rotation in degrees. Note
  107447. * that due to a more complex structure, backgrounds, borders and padding
  107448. * will be lost on a rotated data label.
  107449. */
  107450. rotation?: number;
  107451. /**
  107452. * (Highcharts, Highstock, Highmaps, Gantt) The shadow of the box. Works
  107453. * best with `borderWidth` or `backgroundColor`. Since 2.3 the shadow can be
  107454. * an object configuration containing `color`, `offsetX`, `offsetY`,
  107455. * `opacity` and `width`.
  107456. */
  107457. shadow?: (boolean|ShadowOptionsObject);
  107458. /**
  107459. * (Highcharts, Highstock, Highmaps, Gantt) The name of a symbol to use for
  107460. * the border around the label. Symbols are predefined functions on the
  107461. * Renderer object.
  107462. */
  107463. shape?: string;
  107464. /**
  107465. * (Highcharts, Highstock, Highmaps, Gantt) Styles for the label. The
  107466. * default `color` setting is `"contrast"`, which is a pseudo color that
  107467. * Highcharts picks up and applies the maximum contrast to the underlying
  107468. * point item, for example the bar in a bar chart.
  107469. *
  107470. * The `textOutline` is a pseudo property that applies an outline of the
  107471. * given width with the given color, which by default is the maximum
  107472. * contrast to the text. So a bright text color will result in a black text
  107473. * outline for maximum readability on a mixed background. In some cases,
  107474. * especially with grayscale text, the text outline doesn't work well, in
  107475. * which cases it can be disabled by setting it to `"none"`. When `useHTML`
  107476. * is true, the `textOutline` will not be picked up. In this, case, the same
  107477. * effect can be acheived through the `text-shadow` CSS property.
  107478. *
  107479. * For some series types, where each point has an extent, like for example
  107480. * tree maps, the data label may overflow the point. There are two
  107481. * strategies for handling overflow. By default, the text will wrap to
  107482. * multiple lines. The other strategy is to set `style.textOverflow` to
  107483. * `ellipsis`, which will keep the text on one line plus it will break
  107484. * inside long words.
  107485. */
  107486. style?: (CSSObject|PlotNetworkgraphDataLabelsStyleOptions);
  107487. /**
  107488. * (Highcharts, Highstock, Highmaps, Gantt) Options for a label text which
  107489. * should follow marker's shape. Border and background are disabled for a
  107490. * label that follows a path.
  107491. *
  107492. * **Note:** Only SVG-based renderer supports this option. Setting `useHTML`
  107493. * to true will disable this option.
  107494. */
  107495. textPath?: DataLabelsTextPathOptionsObject;
  107496. /**
  107497. * (Highcharts, Highstock, Highmaps, Gantt) Whether to use HTML to render
  107498. * the labels.
  107499. */
  107500. useHTML?: boolean;
  107501. /**
  107502. * (Highcharts, Highstock, Highmaps, Gantt) The vertical alignment of a data
  107503. * label. Can be one of `top`, `middle` or `bottom`. The default value
  107504. * depends on the data, for instance in a column chart, the label is above
  107505. * positive values and below negative values.
  107506. */
  107507. verticalAlign?: (VerticalAlignValue|null);
  107508. /**
  107509. * (Highcharts, Highstock, Highmaps, Gantt) The x position offset of the
  107510. * label relative to the point in pixels.
  107511. */
  107512. x?: number;
  107513. /**
  107514. * (Highcharts, Highstock, Highmaps, Gantt) The y position offset of the
  107515. * label relative to the point in pixels.
  107516. */
  107517. y?: number;
  107518. /**
  107519. * (Highcharts, Highstock, Highmaps, Gantt) The Z index of the data labels.
  107520. * The default Z index puts it above the series. Use a Z index of 2 to
  107521. * display it behind the series.
  107522. */
  107523. z?: number;
  107524. }
  107525. /**
  107526. * (Highcharts) A collection of options for the individual nodes. The nodes in a
  107527. * networkgraph diagram are auto-generated instances of `Highcharts.Point`, but
  107528. * options can be applied here and linked by the `id`.
  107529. */
  107530. export interface SeriesNetworkgraphNodesOptions {
  107531. /**
  107532. * (Highcharts) The color of the auto generated node.
  107533. */
  107534. color?: ColorString;
  107535. /**
  107536. * (Highcharts) The color index of the auto generated node, especially for
  107537. * use in styled mode.
  107538. */
  107539. colorIndex?: number;
  107540. /**
  107541. * (Highcharts) Individual data label for each node. The options are the
  107542. * same as the ones for series.networkgraph.dataLabels.
  107543. */
  107544. dataLabels?: (SeriesNetworkgraphDataLabelsOptionsObject|Array<SeriesNetworkgraphDataLabelsOptionsObject>);
  107545. /**
  107546. * (Highcharts) The id of the auto-generated node, refering to the `from` or
  107547. * `to` setting of the link.
  107548. */
  107549. id?: string;
  107550. /**
  107551. * (Highcharts) Mass of the node. By default, each node has mass equal to
  107552. * it's marker radius . Mass is used to determine how two connected nodes
  107553. * should affect each other:
  107554. *
  107555. * Attractive force is multiplied by the ratio of two connected nodes; if a
  107556. * big node has weights twice as the small one, then the small one will move
  107557. * towards the big one twice faster than the big one to the small one .
  107558. */
  107559. mass?: number;
  107560. /**
  107561. * (Highcharts) The name to display for the node in data labels and
  107562. * tooltips. Use this when the name is different from the `id`. Where the id
  107563. * must be unique for each node, this is not necessary for the name.
  107564. */
  107565. name?: string;
  107566. }
  107567. /**
  107568. * (Highcharts) A `networkgraph` series. If the type option is not specified, it
  107569. * is inherited from chart.type.
  107570. *
  107571. * In TypeScript the type option must always be set.
  107572. *
  107573. * Configuration options for the series are given in three levels:
  107574. *
  107575. * 1. Options for all series in a chart are defined in the plotOptions.series
  107576. * object.
  107577. *
  107578. * 2. Options for all `networkgraph` series are defined in
  107579. * plotOptions.networkgraph.
  107580. *
  107581. * 3. Options for one single series are given in the series instance array. (see
  107582. * online documentation for example)
  107583. *
  107584. * You have to extend the `SeriesNetworkgraphOptions` via an interface to allow
  107585. * custom properties: ``` declare interface SeriesNetworkgraphOptions {
  107586. * customProperty: string; }
  107587. *
  107588. */
  107589. export interface SeriesNetworkgraphOptions extends PlotNetworkgraphOptions, SeriesOptions {
  107590. /**
  107591. * (Highcharts) An array of data points for the series. For the
  107592. * `networkgraph` series type, points can be given in the following way:
  107593. *
  107594. * An array of objects with named values. The following snippet shows only a
  107595. * few settings, see the complete options set below. If the total number of
  107596. * data points exceeds the series' turboThreshold, this option is not
  107597. * available. (see online documentation for example)
  107598. */
  107599. data?: (PointOptionsObject|Array<(object|any[]|number)>);
  107600. /**
  107601. * (Highcharts) A collection of options for the individual nodes. The nodes
  107602. * in a networkgraph diagram are auto-generated instances of
  107603. * `Highcharts.Point`, but options can be applied here and linked by the
  107604. * `id`.
  107605. */
  107606. nodes?: Array<SeriesNetworkgraphNodesOptions>;
  107607. /**
  107608. * Not available
  107609. */
  107610. stack?: undefined;
  107611. /**
  107612. * (Highcharts, Highstock, Highmaps, Gantt) This property is only in
  107613. * TypeScript non-optional and might be `undefined` in series objects from
  107614. * unknown sources.
  107615. */
  107616. type: "networkgraph";
  107617. /**
  107618. * Not available
  107619. */
  107620. xAxis?: undefined;
  107621. /**
  107622. * Not available
  107623. */
  107624. yAxis?: undefined;
  107625. }
  107626. /**
  107627. * (Highcharts, Highstock) Enable or disable the initial animation when a series
  107628. * is displayed for the `dataLabels`. The animation can also be set as a
  107629. * configuration object. Please note that this option only applies to the
  107630. * initial animation. For other animations, see chart.animation and the
  107631. * animation parameter under the API methods. The following properties are
  107632. * supported:
  107633. *
  107634. * - `defer`: The animation delay time in milliseconds.
  107635. */
  107636. export interface SeriesOhlcDataDataLabelsAnimationOptions {
  107637. /**
  107638. * (Highcharts, Highstock) The animation delay time in milliseconds. Set to
  107639. * `0` renders dataLabel immediately. As `undefined` inherits defer time
  107640. * from the series.animation.defer.
  107641. */
  107642. defer?: number;
  107643. }
  107644. /**
  107645. * (Highstock) Style options for the guide box. The guide box has one state by
  107646. * default, the `default` state.
  107647. */
  107648. export interface SeriesOhlcDataDragDropGuideBoxOptions {
  107649. /**
  107650. * (Highstock) Style options for the guide box default state.
  107651. */
  107652. default?: DragDropGuideBoxOptionsObject;
  107653. }
  107654. /**
  107655. * (Highstock) A `ohlc` series. If the type option is not specified, it is
  107656. * inherited from chart.type.
  107657. *
  107658. * In TypeScript the type option must always be set.
  107659. *
  107660. * Configuration options for the series are given in three levels:
  107661. *
  107662. * 1. Options for all series in a chart are defined in the plotOptions.series
  107663. * object.
  107664. *
  107665. * 2. Options for all `ohlc` series are defined in plotOptions.ohlc.
  107666. *
  107667. * 3. Options for one single series are given in the series instance array. (see
  107668. * online documentation for example)
  107669. *
  107670. * You have to extend the `SeriesOhlcOptions` via an interface to allow custom
  107671. * properties: ``` declare interface SeriesOhlcOptions { customProperty: string;
  107672. * }
  107673. *
  107674. */
  107675. export interface SeriesOhlcOptions extends PlotOhlcOptions, SeriesOptions {
  107676. /**
  107677. * (Highstock) An array of data points for the series. For the `ohlc` series
  107678. * type, points can be given in the following ways:
  107679. *
  107680. * 1. An array of arrays with 5 or 4 values. In this case, the values
  107681. * correspond to `x,open,high,low,close`. If the first value is a string, it
  107682. * is applied as the name of the point, and the `x` value is inferred. The
  107683. * `x` value can also be omitted, in which case the inner arrays should be
  107684. * of length 4\. Then the `x` value is automatically calculated, either
  107685. * starting at 0 and incremented by 1, or from `pointStart` and
  107686. * `pointInterval` given in the series options. (see online documentation
  107687. * for example)
  107688. *
  107689. * 2. An array of objects with named values. The following snippet shows
  107690. * only a few settings, see the complete options set below. If the total
  107691. * number of data points exceeds the series' turboThreshold, this option is
  107692. * not available. (see online documentation for example)
  107693. */
  107694. data?: Array<([(number|string), number, number, number]|[(number|string), number, number, number, number]|PointOptionsObject)>;
  107695. /**
  107696. * Not available
  107697. */
  107698. dataParser?: undefined;
  107699. /**
  107700. * Not available
  107701. */
  107702. dataURL?: undefined;
  107703. /**
  107704. * (Highcharts, Highstock, Highmaps, Gantt) This property is only in
  107705. * TypeScript non-optional and might be `undefined` in series objects from
  107706. * unknown sources.
  107707. */
  107708. type: "ohlc";
  107709. }
  107710. /**
  107711. * (Highcharts, Highstock, Highmaps, Gantt) Series options for specific data and
  107712. * the data itself. In TypeScript you have to cast the series options to
  107713. * specific series types, to get all possible options for a series.
  107714. *
  107715. * You have to extend the `SeriesOptions` via an interface to allow custom
  107716. * properties: ``` declare interface SeriesOptions { customProperty: string; }
  107717. *
  107718. */
  107719. export interface SeriesOptions {
  107720. /**
  107721. * (Highcharts, Highstock, Highmaps, Gantt) An id for the series. This can
  107722. * be used after render time to get a pointer to the series object through
  107723. * `chart.get()`.
  107724. */
  107725. id?: string;
  107726. /**
  107727. * (Highcharts, Highstock, Highmaps, Gantt) The index of the series in the
  107728. * chart, affecting the internal index in the `chart.series` array, the
  107729. * visible Z index as well as the order in the legend.
  107730. */
  107731. index?: number;
  107732. /**
  107733. * (Highcharts, Highstock, Highmaps, Gantt) The sequential index of the
  107734. * series in the legend.
  107735. */
  107736. legendIndex?: number;
  107737. /**
  107738. * (Highmaps) A map data object containing a `path` definition and
  107739. * optionally additional properties to join in the data as per the `joinBy`
  107740. * option.
  107741. */
  107742. mapData?: (Array<SeriesMapDataOptions>|any);
  107743. /**
  107744. * (Highcharts, Highstock, Highmaps, Gantt) The name of the series as shown
  107745. * in the legend, tooltip etc.
  107746. */
  107747. name?: string;
  107748. /**
  107749. * (Highcharts, Highstock) This option allows grouping series in a stacked
  107750. * chart. The stack option can be a string or anything else, as long as the
  107751. * grouped series' stack options match each other after conversion into a
  107752. * string.
  107753. */
  107754. stack?: (number|string);
  107755. /**
  107756. * (Highcharts, Highstock, Highmaps, Gantt) The type of series, for example
  107757. * `line` or `column`. By default, the series type is inherited from
  107758. * chart.type, so unless the chart is a combination of series types, there
  107759. * is no need to set it on the series level.
  107760. */
  107761. type: string;
  107762. /**
  107763. * (Highcharts, Highstock) When using dual or multiple x axes, this number
  107764. * defines which xAxis the particular series is connected to. It refers to
  107765. * either the axis id or the index of the axis in the xAxis array, with 0
  107766. * being the first.
  107767. */
  107768. xAxis?: (number|string);
  107769. /**
  107770. * (Highcharts, Highstock) When using dual or multiple y axes, this number
  107771. * defines which yAxis the particular series is connected to. It refers to
  107772. * either the axis id or the index of the axis in the yAxis array, with 0
  107773. * being the first.
  107774. */
  107775. yAxis?: (number|string);
  107776. /**
  107777. * (Highcharts, Highstock) Define the visual z index of the series.
  107778. */
  107779. zIndex?: number;
  107780. }
  107781. /**
  107782. * The registry for all types of series options.
  107783. */
  107784. export interface SeriesOptionsRegistry {
  107785. SeriesAbandsOptions: SeriesAbandsOptions;
  107786. SeriesAdOptions: SeriesAdOptions;
  107787. SeriesAoOptions: SeriesAoOptions;
  107788. SeriesApoOptions: SeriesApoOptions;
  107789. SeriesAreaOptions: SeriesAreaOptions;
  107790. SeriesArearangeOptions: SeriesArearangeOptions;
  107791. SeriesAreasplineOptions: SeriesAreasplineOptions;
  107792. SeriesAreasplinerangeOptions: SeriesAreasplinerangeOptions;
  107793. SeriesAroonOptions: SeriesAroonOptions;
  107794. SeriesAroonoscillatorOptions: SeriesAroonoscillatorOptions;
  107795. SeriesAtrOptions: SeriesAtrOptions;
  107796. SeriesBarOptions: SeriesBarOptions;
  107797. SeriesBbOptions: SeriesBbOptions;
  107798. SeriesBellcurveOptions: SeriesBellcurveOptions;
  107799. SeriesBoxplotOptions: SeriesBoxplotOptions;
  107800. SeriesBubbleOptions: SeriesBubbleOptions;
  107801. SeriesBulletOptions: SeriesBulletOptions;
  107802. SeriesCandlestickOptions: SeriesCandlestickOptions;
  107803. SeriesCciOptions: SeriesCciOptions;
  107804. SeriesChaikinOptions: SeriesChaikinOptions;
  107805. SeriesCmfOptions: SeriesCmfOptions;
  107806. SeriesColumnOptions: SeriesColumnOptions;
  107807. SeriesColumnpyramidOptions: SeriesColumnpyramidOptions;
  107808. SeriesColumnrangeOptions: SeriesColumnrangeOptions;
  107809. SeriesCylinderOptions: SeriesCylinderOptions;
  107810. SeriesDemaOptions: SeriesDemaOptions;
  107811. SeriesDependencywheelOptions: SeriesDependencywheelOptions;
  107812. SeriesDpoOptions: SeriesDpoOptions;
  107813. SeriesDumbbellOptions: SeriesDumbbellOptions;
  107814. SeriesEmaOptions: SeriesEmaOptions;
  107815. SeriesErrorbarOptions: SeriesErrorbarOptions;
  107816. SeriesFlagsOptions: SeriesFlagsOptions;
  107817. SeriesFunnel3dOptions: SeriesFunnel3dOptions;
  107818. SeriesFunnelOptions: SeriesFunnelOptions;
  107819. SeriesGanttOptions: SeriesGanttOptions;
  107820. SeriesGaugeOptions: SeriesGaugeOptions;
  107821. SeriesHeatmapOptions: SeriesHeatmapOptions;
  107822. SeriesHistogramOptions: SeriesHistogramOptions;
  107823. SeriesIkhOptions: SeriesIkhOptions;
  107824. SeriesItemOptions: SeriesItemOptions;
  107825. SeriesKeltnerchannelsOptions: SeriesKeltnerchannelsOptions;
  107826. SeriesLinearregressionangleOptions: SeriesLinearregressionangleOptions;
  107827. SeriesLinearregressioninterceptOptions: SeriesLinearregressioninterceptOptions;
  107828. SeriesLinearregressionOptions: SeriesLinearregressionOptions;
  107829. SeriesLinearregressionslopeOptions: SeriesLinearregressionslopeOptions;
  107830. SeriesLineOptions: SeriesLineOptions;
  107831. SeriesLollipopOptions: SeriesLollipopOptions;
  107832. SeriesMacdOptions: SeriesMacdOptions;
  107833. SeriesMapbubbleOptions: SeriesMapbubbleOptions;
  107834. SeriesMaplineOptions: SeriesMaplineOptions;
  107835. SeriesMapOptions: SeriesMapOptions;
  107836. SeriesMappointOptions: SeriesMappointOptions;
  107837. SeriesMfiOptions: SeriesMfiOptions;
  107838. SeriesMomentumOptions: SeriesMomentumOptions;
  107839. SeriesNatrOptions: SeriesNatrOptions;
  107840. SeriesNetworkgraphOptions: SeriesNetworkgraphOptions;
  107841. SeriesOhlcOptions: SeriesOhlcOptions;
  107842. SeriesOrganizationOptions: SeriesOrganizationOptions;
  107843. SeriesPackedbubbleOptions: SeriesPackedbubbleOptions;
  107844. SeriesParetoOptions: SeriesParetoOptions;
  107845. SeriesPcOptions: SeriesPcOptions;
  107846. SeriesPieOptions: SeriesPieOptions;
  107847. SeriesPivotpointsOptions: SeriesPivotpointsOptions;
  107848. SeriesPolygonOptions: SeriesPolygonOptions;
  107849. SeriesPpoOptions: SeriesPpoOptions;
  107850. SeriesPriceenvelopesOptions: SeriesPriceenvelopesOptions;
  107851. SeriesPsarOptions: SeriesPsarOptions;
  107852. SeriesPyramid3dOptions: SeriesPyramid3dOptions;
  107853. SeriesPyramidOptions: SeriesPyramidOptions;
  107854. SeriesRocOptions: SeriesRocOptions;
  107855. SeriesRsiOptions: SeriesRsiOptions;
  107856. SeriesSankeyOptions: SeriesSankeyOptions;
  107857. SeriesScatter3dOptions: SeriesScatter3dOptions;
  107858. SeriesScatterOptions: SeriesScatterOptions;
  107859. SeriesSlowstochasticOptions: SeriesSlowstochasticOptions;
  107860. SeriesSmaOptions: SeriesSmaOptions;
  107861. SeriesSolidgaugeOptions: SeriesSolidgaugeOptions;
  107862. SeriesSplineOptions: SeriesSplineOptions;
  107863. SeriesStochasticOptions: SeriesStochasticOptions;
  107864. SeriesStreamgraphOptions: SeriesStreamgraphOptions;
  107865. SeriesSunburstOptions: SeriesSunburstOptions;
  107866. SeriesSupertrendOptions: SeriesSupertrendOptions;
  107867. SeriesTemaOptions: SeriesTemaOptions;
  107868. SeriesTilemapOptions: SeriesTilemapOptions;
  107869. SeriesTimelineOptions: SeriesTimelineOptions;
  107870. SeriesTreemapOptions: SeriesTreemapOptions;
  107871. SeriesTrendlineOptions: SeriesTrendlineOptions;
  107872. SeriesTrixOptions: SeriesTrixOptions;
  107873. SeriesVariablepieOptions: SeriesVariablepieOptions;
  107874. SeriesVariwideOptions: SeriesVariwideOptions;
  107875. SeriesVbpOptions: SeriesVbpOptions;
  107876. SeriesVectorOptions: SeriesVectorOptions;
  107877. SeriesVennOptions: SeriesVennOptions;
  107878. SeriesVwapOptions: SeriesVwapOptions;
  107879. SeriesWaterfallOptions: SeriesWaterfallOptions;
  107880. SeriesWilliamsrOptions: SeriesWilliamsrOptions;
  107881. SeriesWindbarbOptions: SeriesWindbarbOptions;
  107882. SeriesWmaOptions: SeriesWmaOptions;
  107883. SeriesWordcloudOptions: SeriesWordcloudOptions;
  107884. SeriesXrangeOptions: SeriesXrangeOptions;
  107885. SeriesZigzagOptions: SeriesZigzagOptions;
  107886. }
  107887. /**
  107888. * (Highcharts) Enable or disable the initial animation when a series is
  107889. * displayed for the `dataLabels`. The animation can also be set as a
  107890. * configuration object. Please note that this option only applies to the
  107891. * initial animation. For other animations, see chart.animation and the
  107892. * animation parameter under the API methods. The following properties are
  107893. * supported:
  107894. *
  107895. * - `defer`: The animation delay time in milliseconds.
  107896. */
  107897. export interface SeriesOrganizationDataDataLabelsAnimationOptions {
  107898. /**
  107899. * (Highcharts) The animation delay time in milliseconds. Set to `0` renders
  107900. * dataLabel immediately. As `undefined` inherits defer time from the
  107901. * series.animation.defer.
  107902. */
  107903. defer?: number;
  107904. }
  107905. /**
  107906. * (Highcharts, Highstock, Highmaps, Gantt) Options for the data labels
  107907. * appearing on top of the nodes and links. For sankey charts, data labels are
  107908. * visible for the nodes by default, but hidden for links. This is controlled by
  107909. * modifying the `nodeFormat`, and the `format` that applies to links and is an
  107910. * empty string by default.
  107911. */
  107912. export interface SeriesOrganizationDataLabelsOptionsObject {
  107913. /**
  107914. * (Highcharts, Highstock, Highmaps, Gantt) The alignment of the data label
  107915. * compared to the point. If `right`, the right side of the label should be
  107916. * touching the point. For points with an extent, like columns, the
  107917. * alignments also dictates how to align it inside the box, as given with
  107918. * the inside option. Can be one of `left`, `center` or `right`.
  107919. */
  107920. align?: string;
  107921. /**
  107922. * (Highcharts, Highstock, Highmaps, Gantt) Whether to allow data labels to
  107923. * overlap. To make the labels less sensitive for overlapping, the
  107924. * dataLabels.padding can be set to 0.
  107925. */
  107926. allowOverlap?: boolean;
  107927. /**
  107928. * (Highcharts, Highstock, Highmaps, Gantt) Enable or disable the initial
  107929. * animation when a series is displayed for the `dataLabels`. The animation
  107930. * can also be set as a configuration object. Please note that this option
  107931. * only applies to the initial animation. For other animations, see
  107932. * chart.animation and the animation parameter under the API methods. The
  107933. * following properties are supported:
  107934. *
  107935. * - `defer`: The animation delay time in milliseconds.
  107936. */
  107937. animation?: (boolean|PlotOrganizationDataLabelsAnimationOptions|Partial<AnimationOptionsObject>);
  107938. /**
  107939. * (Highcharts, Highstock, Highmaps, Gantt) The background color or gradient
  107940. * for the data label.
  107941. */
  107942. backgroundColor?: string;
  107943. /**
  107944. * (Highcharts, Highstock, Highmaps, Gantt) The border color for the data
  107945. * label. Defaults to `undefined`.
  107946. */
  107947. borderColor?: (ColorString|GradientColorObject|PatternObject);
  107948. /**
  107949. * (Highcharts, Highstock, Highmaps, Gantt) The border radius in pixels for
  107950. * the data label.
  107951. */
  107952. borderRadius?: number;
  107953. /**
  107954. * (Highcharts, Highstock, Highmaps, Gantt) The border width in pixels for
  107955. * the data label.
  107956. */
  107957. borderWidth?: number;
  107958. /**
  107959. * (Highcharts, Highstock, Highmaps, Gantt) A class name for the data label.
  107960. * Particularly in styled mode, this can be used to give each series' or
  107961. * point's data label unique styling. In addition to this option, a default
  107962. * color class name is added so that we can give the labels a contrast text
  107963. * shadow.
  107964. */
  107965. className?: string;
  107966. /**
  107967. * (Highcharts, Highstock, Highmaps, Gantt) The text color for the data
  107968. * labels. Defaults to `undefined`. For certain series types, like column or
  107969. * map, the data labels can be drawn inside the points. In this case the
  107970. * data label will be drawn with maximum contrast by default. Additionally,
  107971. * it will be given a `text-outline` style with the opposite color, to
  107972. * further increase the contrast. This can be overridden by setting the
  107973. * `text-outline` style to `none` in the `dataLabels.style` option.
  107974. */
  107975. color?: (ColorString|GradientColorObject|PatternObject);
  107976. /**
  107977. * (Highcharts, Highstock, Highmaps, Gantt) Whether to hide data labels that
  107978. * are outside the plot area. By default, the data label is moved inside the
  107979. * plot area according to the overflow option.
  107980. */
  107981. crop?: boolean;
  107982. /**
  107983. * (Highcharts, Highstock, Gantt) Whether to defer displaying the data
  107984. * labels until the initial series animation has finished. Setting to
  107985. * `false` renders the data label immediately. If set to `true` inherits the
  107986. * defer time set in plotOptions.series.animation.
  107987. */
  107988. defer?: boolean;
  107989. /**
  107990. * (Highcharts, Highstock, Highmaps, Gantt) Enable or disable the data
  107991. * labels.
  107992. */
  107993. enabled?: boolean;
  107994. /**
  107995. * (Highcharts, Highstock, Highmaps, Gantt) A declarative filter to control
  107996. * of which data labels to display. The declarative filter is designed for
  107997. * use when callback functions are not available, like when the chart
  107998. * options require a pure JSON structure or for use with graphical editors.
  107999. * For programmatic control, use the `formatter` instead, and return
  108000. * `undefined` to disable a single data label.
  108001. */
  108002. filter?: DataLabelsFilterOptionsObject;
  108003. /**
  108004. * (Highcharts, Highstock, Highmaps, Gantt) A format string for the data
  108005. * label. Available variables are the same as for `formatter`.
  108006. */
  108007. format?: string;
  108008. /**
  108009. * (Highcharts, Highstock, Highmaps, Gantt) Callback JavaScript function to
  108010. * format the data label. Note that if a `format` is defined, the format
  108011. * takes precedence and the formatter is ignored.
  108012. */
  108013. formatter?: SeriesSankeyDataLabelsFormatterCallbackFunction;
  108014. /**
  108015. * (Highcharts, Highstock, Highmaps, Gantt) For points with an extent, like
  108016. * columns or map areas, whether to align the data label inside the box or
  108017. * to the actual value point. Defaults to `false` in most cases, `true` in
  108018. * stacked columns.
  108019. */
  108020. inside?: boolean;
  108021. /**
  108022. * (Highcharts, Highstock, Highmaps, Gantt) The format string specifying
  108023. * what to show for _nodes_ in the sankey diagram. By default the
  108024. * `nodeFormatter` returns `{point.name}`.
  108025. */
  108026. nodeFormat?: string;
  108027. /**
  108028. * (Highcharts, Highstock, Highmaps, Gantt) A callback for defining the
  108029. * format for _nodes_ in the organization chart. The `nodeFormat` option
  108030. * takes precedence over `nodeFormatter`.
  108031. *
  108032. * In an organization chart, the `nodeFormatter` is a quite complex function
  108033. * of the available options, striving for a good default layout of cards
  108034. * with or without images. In organization chart, the data labels come with
  108035. * `useHTML` set to true, meaning they will be rendered as true HTML above
  108036. * the SVG.
  108037. */
  108038. nodeFormatter?: SeriesSankeyDataLabelsFormatterCallbackFunction;
  108039. /**
  108040. * (Highcharts, Highstock, Highmaps, Gantt) Format for points with the value
  108041. * of null. Works analogously to format. `nullFormat` can be applied only to
  108042. * series which support displaying null points.
  108043. */
  108044. nullFormat?: (boolean|string);
  108045. /**
  108046. * (Highcharts, Highstock, Highmaps, Gantt) Callback JavaScript function
  108047. * that defines formatting for points with the value of null. Works
  108048. * analogously to formatter. `nullPointFormatter` can be applied only to
  108049. * series which support displaying null points.
  108050. */
  108051. nullFormatter?: DataLabelsFormatterCallbackFunction;
  108052. /**
  108053. * (Highcharts, Highstock, Highmaps, Gantt) How to handle data labels that
  108054. * flow outside the plot area. The default is `"justify"`, which aligns them
  108055. * inside the plot area. For columns and bars, this means it will be moved
  108056. * inside the bar. To display data labels outside the plot area, set `crop`
  108057. * to `false` and `overflow` to `"allow"`.
  108058. */
  108059. overflow?: DataLabelsOverflowValue;
  108060. /**
  108061. * (Highcharts, Highstock, Highmaps, Gantt) When either the `borderWidth` or
  108062. * the `backgroundColor` is set, this is the padding within the box.
  108063. */
  108064. padding?: number;
  108065. /**
  108066. * (Highcharts, Highstock, Highmaps, Gantt) Aligns data labels relative to
  108067. * points. If `center` alignment is not possible, it defaults to `right`.
  108068. */
  108069. position?: AlignValue;
  108070. /**
  108071. * (Highcharts, Highstock, Highmaps, Gantt) Text rotation in degrees. Note
  108072. * that due to a more complex structure, backgrounds, borders and padding
  108073. * will be lost on a rotated data label.
  108074. */
  108075. rotation?: number;
  108076. /**
  108077. * (Highcharts, Highstock, Highmaps, Gantt) The shadow of the box. Works
  108078. * best with `borderWidth` or `backgroundColor`. Since 2.3 the shadow can be
  108079. * an object configuration containing `color`, `offsetX`, `offsetY`,
  108080. * `opacity` and `width`.
  108081. */
  108082. shadow?: (boolean|ShadowOptionsObject);
  108083. /**
  108084. * (Highcharts, Highstock, Highmaps, Gantt) The name of a symbol to use for
  108085. * the border around the label. Symbols are predefined functions on the
  108086. * Renderer object.
  108087. */
  108088. shape?: string;
  108089. /**
  108090. * (Highcharts, Highstock, Highmaps, Gantt) Styles for the label. The
  108091. * default `color` setting is `"contrast"`, which is a pseudo color that
  108092. * Highcharts picks up and applies the maximum contrast to the underlying
  108093. * point item, for example the bar in a bar chart.
  108094. *
  108095. * The `textOutline` is a pseudo property that applies an outline of the
  108096. * given width with the given color, which by default is the maximum
  108097. * contrast to the text. So a bright text color will result in a black text
  108098. * outline for maximum readability on a mixed background. In some cases,
  108099. * especially with grayscale text, the text outline doesn't work well, in
  108100. * which cases it can be disabled by setting it to `"none"`. When `useHTML`
  108101. * is true, the `textOutline` will not be picked up. In this, case, the same
  108102. * effect can be acheived through the `text-shadow` CSS property.
  108103. *
  108104. * For some series types, where each point has an extent, like for example
  108105. * tree maps, the data label may overflow the point. There are two
  108106. * strategies for handling overflow. By default, the text will wrap to
  108107. * multiple lines. The other strategy is to set `style.textOverflow` to
  108108. * `ellipsis`, which will keep the text on one line plus it will break
  108109. * inside long words.
  108110. */
  108111. style?: CSSObject;
  108112. /**
  108113. * (Highcharts, Highstock, Highmaps, Gantt) Options for a label text which
  108114. * should follow marker's shape. Border and background are disabled for a
  108115. * label that follows a path.
  108116. *
  108117. * **Note:** Only SVG-based renderer supports this option. Setting `useHTML`
  108118. * to true will disable this option.
  108119. */
  108120. textPath?: DataLabelsTextPathOptionsObject;
  108121. /**
  108122. * (Highcharts, Highstock, Highmaps, Gantt) Whether to use HTML to render
  108123. * the labels.
  108124. */
  108125. useHTML?: boolean;
  108126. /**
  108127. * (Highcharts, Highstock, Highmaps, Gantt) The vertical alignment of a data
  108128. * label. Can be one of `top`, `middle` or `bottom`. The default value
  108129. * depends on the data, for instance in a column chart, the label is above
  108130. * positive values and below negative values.
  108131. */
  108132. verticalAlign?: string;
  108133. /**
  108134. * (Highcharts, Highstock, Highmaps, Gantt) The x position offset of the
  108135. * label relative to the point in pixels.
  108136. */
  108137. x?: number;
  108138. /**
  108139. * (Highcharts, Highstock, Highmaps, Gantt) The y position offset of the
  108140. * label relative to the point in pixels.
  108141. */
  108142. y?: number;
  108143. /**
  108144. * (Highcharts, Highstock, Highmaps, Gantt) The Z index of the data labels.
  108145. * The default Z index puts it above the series. Use a Z index of 2 to
  108146. * display it behind the series.
  108147. */
  108148. z?: number;
  108149. }
  108150. /**
  108151. * (Highcharts, Highstock, Highmaps, Gantt) Enable or disable the initial
  108152. * animation when a series is displayed for the `dataLabels`. The animation can
  108153. * also be set as a configuration object. Please note that this option only
  108154. * applies to the initial animation. For other animations, see chart.animation
  108155. * and the animation parameter under the API methods. The following properties
  108156. * are supported:
  108157. *
  108158. * - `defer`: The animation delay time in milliseconds.
  108159. */
  108160. export interface SeriesOrganizationNodesDataLabelsAnimationOptions {
  108161. /**
  108162. * (Highcharts, Highstock, Highmaps, Gantt) The animation delay time in
  108163. * milliseconds. Set to `0` renders dataLabel immediately. As `undefined`
  108164. * inherits defer time from the series.animation.defer.
  108165. */
  108166. defer?: number;
  108167. }
  108168. /**
  108169. * (Highcharts) An `organization` series. If the type option is not specified,
  108170. * it is inherited from chart.type.
  108171. *
  108172. * In TypeScript the type option must always be set.
  108173. *
  108174. * Configuration options for the series are given in three levels:
  108175. *
  108176. * 1. Options for all series in a chart are defined in the plotOptions.series
  108177. * object.
  108178. *
  108179. * 2. Options for all `organization` series are defined in
  108180. * plotOptions.organization.
  108181. *
  108182. * 3. Options for one single series are given in the series instance array. (see
  108183. * online documentation for example)
  108184. *
  108185. * You have to extend the `SeriesOrganizationOptions` via an interface to allow
  108186. * custom properties: ``` declare interface SeriesOrganizationOptions {
  108187. * customProperty: string; }
  108188. *
  108189. */
  108190. export interface SeriesOrganizationOptions extends PlotOrganizationOptions, SeriesOptions {
  108191. /**
  108192. * (Highcharts) An array of data points for the series. For the
  108193. * `organization` series type, points can be given in the following way:
  108194. *
  108195. * An array of objects with named values. The following snippet shows only a
  108196. * few settings, see the complete options set below. If the total number of
  108197. * data points exceeds the series' turboThreshold, this option is not
  108198. * available. (see online documentation for example)
  108199. */
  108200. data?: Array<SeriesSankeyPointOptionsObject>;
  108201. /**
  108202. * (Highcharts) A collection of options for the individual nodes. The nodes
  108203. * in an org chart are auto-generated instances of `Highcharts.Point`, but
  108204. * options can be applied here and linked by the `id`.
  108205. */
  108206. nodes?: Array<SeriesSankeyNodesOptionsObject>;
  108207. /**
  108208. * (Highcharts, Highstock, Highmaps, Gantt) This property is only in
  108209. * TypeScript non-optional and might be `undefined` in series objects from
  108210. * unknown sources.
  108211. */
  108212. type: "organization";
  108213. }
  108214. /**
  108215. * (Highcharts) Enable or disable the initial animation when a series is
  108216. * displayed for the `dataLabels`. The animation can also be set as a
  108217. * configuration object. Please note that this option only applies to the
  108218. * initial animation. For other animations, see chart.animation and the
  108219. * animation parameter under the API methods. The following properties are
  108220. * supported:
  108221. *
  108222. * - `defer`: The animation delay time in milliseconds.
  108223. */
  108224. export interface SeriesPackedbubbleDataDataLabelsAnimationOptions {
  108225. /**
  108226. * (Highcharts) The animation delay time in milliseconds. Set to `0` renders
  108227. * dataLabel immediately. As `undefined` inherits defer time from the
  108228. * series.animation.defer.
  108229. */
  108230. defer?: number;
  108231. }
  108232. /**
  108233. * (Highcharts) Style options for the guide box. The guide box has one state by
  108234. * default, the `default` state.
  108235. */
  108236. export interface SeriesPackedbubbleDataDragDropGuideBoxOptions {
  108237. /**
  108238. * (Highcharts) Style options for the guide box default state.
  108239. */
  108240. default?: DragDropGuideBoxOptionsObject;
  108241. }
  108242. /**
  108243. * Context for the formatter function.
  108244. */
  108245. export interface SeriesPackedBubbleDataLabelsFormatterContextObject extends PointLabelObject {
  108246. /**
  108247. * The color of the node.
  108248. */
  108249. color: ColorString;
  108250. /**
  108251. * The ID of the node.
  108252. */
  108253. key: string;
  108254. /**
  108255. * The point (node) object. The node name, if defined, is available through
  108256. * `this.point.name`. Arrays: `this.point.linksFrom` and
  108257. * `this.point.linksTo` contains all nodes connected to this point.
  108258. */
  108259. point: Point;
  108260. }
  108261. /**
  108262. * (Highcharts, Highstock, Highmaps, Gantt) Options for the series data labels,
  108263. * appearing next to each data point.
  108264. *
  108265. * Since v6.2.0, multiple data labels can be applied to each single point by
  108266. * defining them as an array of configs.
  108267. *
  108268. * In styled mode, the data labels can be styled with the
  108269. * `.highcharts-data-label-box` and `.highcharts-data-label` class names (see
  108270. * example).
  108271. */
  108272. export interface SeriesPackedBubbleDataLabelsOptionsObject {
  108273. /**
  108274. * (Highcharts, Highstock, Highmaps, Gantt) The alignment of the data label
  108275. * compared to the point. If `right`, the right side of the label should be
  108276. * touching the point. For points with an extent, like columns, the
  108277. * alignments also dictates how to align it inside the box, as given with
  108278. * the inside option. Can be one of `left`, `center` or `right`.
  108279. */
  108280. align?: (AlignValue|null);
  108281. /**
  108282. * (Highcharts, Highstock, Highmaps, Gantt) Whether to allow data labels to
  108283. * overlap. To make the labels less sensitive for overlapping, the
  108284. * dataLabels.padding can be set to 0.
  108285. */
  108286. allowOverlap?: boolean;
  108287. /**
  108288. * (Highcharts, Highstock, Highmaps, Gantt) Enable or disable the initial
  108289. * animation when a series is displayed for the `dataLabels`. The animation
  108290. * can also be set as a configuration object. Please note that this option
  108291. * only applies to the initial animation. For other animations, see
  108292. * chart.animation and the animation parameter under the API methods. The
  108293. * following properties are supported:
  108294. *
  108295. * - `defer`: The animation delay time in milliseconds.
  108296. */
  108297. animation?: (boolean|PlotPackedbubbleDataLabelsAnimationOptions|Partial<AnimationOptionsObject>);
  108298. /**
  108299. * (Highcharts, Highstock, Highmaps, Gantt) Presentation attributes for the
  108300. * text path.
  108301. */
  108302. attributes?: SVGAttributes;
  108303. /**
  108304. * (Highcharts, Highstock, Highmaps, Gantt) The background color or gradient
  108305. * for the data label.
  108306. */
  108307. backgroundColor?: (ColorString|GradientColorObject|PatternObject);
  108308. /**
  108309. * (Highcharts, Highstock, Highmaps, Gantt) The border color for the data
  108310. * label. Defaults to `undefined`.
  108311. */
  108312. borderColor?: (ColorString|GradientColorObject|PatternObject);
  108313. /**
  108314. * (Highcharts, Highstock, Highmaps, Gantt) The border radius in pixels for
  108315. * the data label.
  108316. */
  108317. borderRadius?: number;
  108318. /**
  108319. * (Highcharts, Highstock, Highmaps, Gantt) The border width in pixels for
  108320. * the data label.
  108321. */
  108322. borderWidth?: number;
  108323. /**
  108324. * (Highcharts, Highstock, Highmaps, Gantt) A class name for the data label.
  108325. * Particularly in styled mode, this can be used to give each series' or
  108326. * point's data label unique styling. In addition to this option, a default
  108327. * color class name is added so that we can give the labels a contrast text
  108328. * shadow.
  108329. */
  108330. className?: string;
  108331. /**
  108332. * (Highcharts, Highstock, Highmaps, Gantt) The text color for the data
  108333. * labels. Defaults to `undefined`. For certain series types, like column or
  108334. * map, the data labels can be drawn inside the points. In this case the
  108335. * data label will be drawn with maximum contrast by default. Additionally,
  108336. * it will be given a `text-outline` style with the opposite color, to
  108337. * further increase the contrast. This can be overridden by setting the
  108338. * `text-outline` style to `none` in the `dataLabels.style` option.
  108339. */
  108340. color?: (ColorString|GradientColorObject|PatternObject);
  108341. /**
  108342. * (Highcharts, Highstock, Highmaps, Gantt) Whether to hide data labels that
  108343. * are outside the plot area. By default, the data label is moved inside the
  108344. * plot area according to the overflow option.
  108345. */
  108346. crop?: boolean;
  108347. /**
  108348. * (Highcharts, Highstock, Gantt) Whether to defer displaying the data
  108349. * labels until the initial series animation has finished. Setting to
  108350. * `false` renders the data label immediately. If set to `true` inherits the
  108351. * defer time set in plotOptions.series.animation.
  108352. */
  108353. defer?: boolean;
  108354. /**
  108355. * (Highcharts, Highstock, Highmaps, Gantt) Enable or disable the data
  108356. * labels.
  108357. */
  108358. enabled?: boolean;
  108359. /**
  108360. * (Highcharts, Highstock, Highmaps, Gantt) A declarative filter to control
  108361. * of which data labels to display. The declarative filter is designed for
  108362. * use when callback functions are not available, like when the chart
  108363. * options require a pure JSON structure or for use with graphical editors.
  108364. * For programmatic control, use the `formatter` instead, and return
  108365. * `undefined` to disable a single data label.
  108366. */
  108367. filter?: DataLabelsFilterOptionsObject;
  108368. /**
  108369. * (Highcharts, Highstock, Highmaps, Gantt) The format string specifying
  108370. * what to show for _node_ in the networkgraph. In v7.0 defaults to `{key}`,
  108371. * since v7.1 defaults to `undefined` and `formatter` is used instead.
  108372. */
  108373. format?: string;
  108374. /**
  108375. * (Highcharts, Highstock, Highmaps, Gantt) Callback JavaScript function to
  108376. * format the data label for a node. Note that if a `format` is defined, the
  108377. * format takes precedence and the formatter is ignored.
  108378. */
  108379. formatter?: SeriesPackedBubbleDataLabelsFormatterCallbackFunction;
  108380. /**
  108381. * (Highcharts, Highstock, Highmaps, Gantt) For points with an extent, like
  108382. * columns or map areas, whether to align the data label inside the box or
  108383. * to the actual value point. Defaults to `false` in most cases, `true` in
  108384. * stacked columns.
  108385. */
  108386. inside?: boolean;
  108387. /**
  108388. * (Highcharts, Highstock, Highmaps, Gantt) Format for points with the value
  108389. * of null. Works analogously to format. `nullFormat` can be applied only to
  108390. * series which support displaying null points.
  108391. */
  108392. nullFormat?: (boolean|string);
  108393. /**
  108394. * (Highcharts, Highstock, Highmaps, Gantt) Callback JavaScript function
  108395. * that defines formatting for points with the value of null. Works
  108396. * analogously to formatter. `nullPointFormatter` can be applied only to
  108397. * series which support displaying null points.
  108398. */
  108399. nullFormatter?: DataLabelsFormatterCallbackFunction;
  108400. /**
  108401. * (Highcharts, Highstock, Highmaps, Gantt) How to handle data labels that
  108402. * flow outside the plot area. The default is `"justify"`, which aligns them
  108403. * inside the plot area. For columns and bars, this means it will be moved
  108404. * inside the bar. To display data labels outside the plot area, set `crop`
  108405. * to `false` and `overflow` to `"allow"`.
  108406. */
  108407. overflow?: DataLabelsOverflowValue;
  108408. /**
  108409. * (Highcharts, Highstock, Highmaps, Gantt) When either the `borderWidth` or
  108410. * the `backgroundColor` is set, this is the padding within the box.
  108411. */
  108412. padding?: number;
  108413. parentNodeFormat?: string;
  108414. parentNodeFormatter?: SeriesPackedBubbleDataLabelsFormatterCallbackFunction;
  108415. parentNodeTextPath?: SeriesPackedBubbleDataLabelsTextPathOptionsObject;
  108416. /**
  108417. * (Highcharts, Highstock, Highmaps, Gantt) Aligns data labels relative to
  108418. * points. If `center` alignment is not possible, it defaults to `right`.
  108419. */
  108420. position?: AlignValue;
  108421. /**
  108422. * (Highcharts, Highstock, Highmaps, Gantt) Text rotation in degrees. Note
  108423. * that due to a more complex structure, backgrounds, borders and padding
  108424. * will be lost on a rotated data label.
  108425. */
  108426. rotation?: number;
  108427. /**
  108428. * (Highcharts, Highstock, Highmaps, Gantt) The shadow of the box. Works
  108429. * best with `borderWidth` or `backgroundColor`. Since 2.3 the shadow can be
  108430. * an object configuration containing `color`, `offsetX`, `offsetY`,
  108431. * `opacity` and `width`.
  108432. */
  108433. shadow?: (boolean|ShadowOptionsObject);
  108434. /**
  108435. * (Highcharts, Highstock, Highmaps, Gantt) The name of a symbol to use for
  108436. * the border around the label. Symbols are predefined functions on the
  108437. * Renderer object.
  108438. */
  108439. shape?: string;
  108440. /**
  108441. * (Highcharts, Highstock, Highmaps, Gantt) Styles for the label. The
  108442. * default `color` setting is `"contrast"`, which is a pseudo color that
  108443. * Highcharts picks up and applies the maximum contrast to the underlying
  108444. * point item, for example the bar in a bar chart.
  108445. *
  108446. * The `textOutline` is a pseudo property that applies an outline of the
  108447. * given width with the given color, which by default is the maximum
  108448. * contrast to the text. So a bright text color will result in a black text
  108449. * outline for maximum readability on a mixed background. In some cases,
  108450. * especially with grayscale text, the text outline doesn't work well, in
  108451. * which cases it can be disabled by setting it to `"none"`. When `useHTML`
  108452. * is true, the `textOutline` will not be picked up. In this, case, the same
  108453. * effect can be acheived through the `text-shadow` CSS property.
  108454. *
  108455. * For some series types, where each point has an extent, like for example
  108456. * tree maps, the data label may overflow the point. There are two
  108457. * strategies for handling overflow. By default, the text will wrap to
  108458. * multiple lines. The other strategy is to set `style.textOverflow` to
  108459. * `ellipsis`, which will keep the text on one line plus it will break
  108460. * inside long words.
  108461. */
  108462. style?: (CSSObject|PlotPackedbubbleDataLabelsStyleOptions);
  108463. /**
  108464. * (Highcharts, Highstock, Highmaps, Gantt) Options for a _node_ label text
  108465. * which should follow marker's shape.
  108466. *
  108467. * **Note:** Only SVG-based renderer supports this option.
  108468. */
  108469. textPath?: DataLabelsTextPathOptionsObject;
  108470. /**
  108471. * (Highcharts, Highstock, Highmaps, Gantt) Whether to use HTML to render
  108472. * the labels.
  108473. */
  108474. useHTML?: boolean;
  108475. /**
  108476. * (Highcharts, Highstock, Highmaps, Gantt) The vertical alignment of a data
  108477. * label. Can be one of `top`, `middle` or `bottom`. The default value
  108478. * depends on the data, for instance in a column chart, the label is above
  108479. * positive values and below negative values.
  108480. */
  108481. verticalAlign?: string;
  108482. /**
  108483. * (Highcharts, Highstock, Highmaps, Gantt) The x position offset of the
  108484. * label relative to the point in pixels.
  108485. */
  108486. x?: number;
  108487. /**
  108488. * (Highcharts, Highstock, Highmaps, Gantt) The y position offset of the
  108489. * label relative to the point in pixels.
  108490. */
  108491. y?: number;
  108492. /**
  108493. * (Highcharts, Highstock, Highmaps, Gantt) The Z index of the data labels.
  108494. * The default Z index puts it above the series. Use a Z index of 2 to
  108495. * display it behind the series.
  108496. */
  108497. z?: number;
  108498. }
  108499. export interface SeriesPackedBubbleDataLabelsTextPathOptionsObject {
  108500. /**
  108501. * (Highcharts, Highstock, Highmaps, Gantt) Enable or disable `textPath`
  108502. * option for link's or marker's data labels.
  108503. */
  108504. enabled?: boolean;
  108505. }
  108506. /**
  108507. * (Highcharts) A `packedbubble` series. If the type option is not specified, it
  108508. * is inherited from chart.type.
  108509. *
  108510. * In TypeScript the type option must always be set.
  108511. *
  108512. * Configuration options for the series are given in three levels:
  108513. *
  108514. * 1. Options for all series in a chart are defined in the plotOptions.series
  108515. * object.
  108516. *
  108517. * 2. Options for all `packedbubble` series are defined in
  108518. * plotOptions.packedbubble.
  108519. *
  108520. * 3. Options for one single series are given in the series instance array. (see
  108521. * online documentation for example)
  108522. *
  108523. * You have to extend the `SeriesPackedbubbleOptions` via an interface to allow
  108524. * custom properties: ``` declare interface SeriesPackedbubbleOptions {
  108525. * customProperty: string; }
  108526. *
  108527. */
  108528. export interface SeriesPackedbubbleOptions extends PlotPackedbubbleOptions, SeriesOptions {
  108529. /**
  108530. * (Highcharts) An array of data points for the series. For the
  108531. * `packedbubble` series type, points can be given in the following ways:
  108532. *
  108533. * 1. An array of `values`. (see online documentation for example)
  108534. *
  108535. * 2. An array of objects with named values. The objects are point
  108536. * configuration objects as seen below. If the total number of data points
  108537. * exceeds the series' turboThreshold, this option is not available. (see
  108538. * online documentation for example)
  108539. */
  108540. data?: (PointOptionsObject|Array<(object|any[])>);
  108541. /**
  108542. * Not available
  108543. */
  108544. dataParser?: undefined;
  108545. /**
  108546. * Not available
  108547. */
  108548. dataURL?: undefined;
  108549. /**
  108550. * Not available
  108551. */
  108552. stack?: undefined;
  108553. /**
  108554. * (Highcharts, Highstock, Highmaps, Gantt) This property is only in
  108555. * TypeScript non-optional and might be `undefined` in series objects from
  108556. * unknown sources.
  108557. */
  108558. type: "packedbubble";
  108559. }
  108560. /**
  108561. * (Highcharts, Highstock, Gantt) Enable or disable the initial animation when a
  108562. * series is displayed for the `dataLabels`. The animation can also be set as a
  108563. * configuration object. Please note that this option only applies to the
  108564. * initial animation. For other animations, see chart.animation and the
  108565. * animation parameter under the API methods. The following properties are
  108566. * supported:
  108567. *
  108568. * - `defer`: The animation delay time in milliseconds.
  108569. */
  108570. export interface SeriesParetoDataDataLabelsAnimationOptions {
  108571. /**
  108572. * (Highcharts, Highstock, Gantt) The animation delay time in milliseconds.
  108573. * Set to `0` renders dataLabel immediately. As `undefined` inherits defer
  108574. * time from the series.animation.defer.
  108575. */
  108576. defer?: number;
  108577. }
  108578. /**
  108579. * (Highcharts) Style options for the guide box. The guide box has one state by
  108580. * default, the `default` state.
  108581. */
  108582. export interface SeriesParetoDataDragDropGuideBoxOptions {
  108583. /**
  108584. * (Highcharts) Style options for the guide box default state.
  108585. */
  108586. default?: DragDropGuideBoxOptionsObject;
  108587. }
  108588. /**
  108589. * (Highcharts) A `pareto` series. If the type option is not specified, it is
  108590. * inherited from chart.type.
  108591. *
  108592. * In TypeScript the type option must always be set.
  108593. *
  108594. * Configuration options for the series are given in three levels:
  108595. *
  108596. * 1. Options for all series in a chart are defined in the plotOptions.series
  108597. * object.
  108598. *
  108599. * 2. Options for all `pareto` series are defined in plotOptions.pareto.
  108600. *
  108601. * 3. Options for one single series are given in the series instance array. (see
  108602. * online documentation for example)
  108603. *
  108604. * You have to extend the `SeriesParetoOptions` via an interface to allow custom
  108605. * properties: ``` declare interface SeriesParetoOptions { customProperty:
  108606. * string; }
  108607. *
  108608. */
  108609. export interface SeriesParetoOptions extends PlotParetoOptions, SeriesOptions {
  108610. /**
  108611. * (Highcharts) An integer identifying the index to use for the base series,
  108612. * or a string representing the id of the series.
  108613. */
  108614. baseSeries?: (number|string);
  108615. /**
  108616. * (Highcharts) An array of data points for the series. For the `pareto`
  108617. * series type, points are calculated dynamically.
  108618. */
  108619. data?: Array<(Array<(number|string)>|PointOptionsObject)>;
  108620. /**
  108621. * Not available
  108622. */
  108623. dataParser?: undefined;
  108624. /**
  108625. * Not available
  108626. */
  108627. dataURL?: undefined;
  108628. /**
  108629. * (Highcharts, Highstock, Highmaps, Gantt) This property is only in
  108630. * TypeScript non-optional and might be `undefined` in series objects from
  108631. * unknown sources.
  108632. */
  108633. type: "pareto";
  108634. }
  108635. /**
  108636. * (Highstock) A Price channel indicator. If the type option is not specified,
  108637. * it is inherited from chart.type.
  108638. *
  108639. * In TypeScript the type option must always be set.
  108640. *
  108641. * Configuration options for the series are given in three levels:
  108642. *
  108643. * 1. Options for all series in a chart are defined in the plotOptions.series
  108644. * object.
  108645. *
  108646. * 2. Options for all `pc` series are defined in plotOptions.pc.
  108647. *
  108648. * 3. Options for one single series are given in the series instance array. (see
  108649. * online documentation for example)
  108650. *
  108651. * You have to extend the `SeriesPcOptions` via an interface to allow custom
  108652. * properties: ``` declare interface SeriesPcOptions { customProperty: string; }
  108653. *
  108654. */
  108655. export interface SeriesPcOptions extends PlotPcOptions, SeriesOptions {
  108656. /**
  108657. * Not available
  108658. */
  108659. dataParser?: undefined;
  108660. /**
  108661. * Not available
  108662. */
  108663. dataURL?: undefined;
  108664. /**
  108665. * (Highcharts, Highstock, Highmaps, Gantt) This property is only in
  108666. * TypeScript non-optional and might be `undefined` in series objects from
  108667. * unknown sources.
  108668. */
  108669. type: "pc";
  108670. }
  108671. /**
  108672. * (Highcharts) Enable or disable the initial animation when a series is
  108673. * displayed for the `dataLabels`. The animation can also be set as a
  108674. * configuration object. Please note that this option only applies to the
  108675. * initial animation. For other animations, see chart.animation and the
  108676. * animation parameter under the API methods. The following properties are
  108677. * supported:
  108678. *
  108679. * - `defer`: The animation delay time in milliseconds.
  108680. */
  108681. export interface SeriesPieDataDataLabelsAnimationOptions {
  108682. /**
  108683. * (Highcharts) The animation delay time in milliseconds. Set to `0` renders
  108684. * dataLabel immediately. As `undefined` inherits defer time from the
  108685. * series.animation.defer.
  108686. */
  108687. defer?: number;
  108688. }
  108689. /**
  108690. * (Highcharts) Style options for the guide box. The guide box has one state by
  108691. * default, the `default` state.
  108692. */
  108693. export interface SeriesPieDataDragDropGuideBoxOptions {
  108694. /**
  108695. * (Highcharts) Style options for the guide box default state.
  108696. */
  108697. default?: DragDropGuideBoxOptionsObject;
  108698. }
  108699. /**
  108700. * (Highcharts, Highstock, Highmaps, Gantt) Options for the series data labels,
  108701. * appearing next to each data point.
  108702. *
  108703. * Since v6.2.0, multiple data labels can be applied to each single point by
  108704. * defining them as an array of configs.
  108705. *
  108706. * In styled mode, the data labels can be styled with the
  108707. * `.highcharts-data-label-box` and `.highcharts-data-label` class names (see
  108708. * example).
  108709. */
  108710. export interface SeriesPieDataLabelsOptionsObject {
  108711. /**
  108712. * (Highcharts) Alignment method for data labels. Possible values are:
  108713. *
  108714. * - `toPlotEdges`: Each label touches the nearest vertical edge of the plot
  108715. * area.
  108716. *
  108717. * - `connectors`: Connectors have the same x position and the widest label
  108718. * of each half (left & right) touches the nearest vertical edge of the plot
  108719. * area.
  108720. */
  108721. alignTo?: string;
  108722. /**
  108723. * (Highcharts, Highstock, Highmaps, Gantt) Enable or disable the initial
  108724. * animation when a series is displayed for the `dataLabels`. The animation
  108725. * can also be set as a configuration object. Please note that this option
  108726. * only applies to the initial animation. For other animations, see
  108727. * chart.animation and the animation parameter under the API methods. The
  108728. * following properties are supported:
  108729. *
  108730. * - `defer`: The animation delay time in milliseconds.
  108731. */
  108732. animation?: (boolean|PlotFunnelDataLabelsAnimationOptions|PlotItemDataLabelsAnimationOptions|PlotPieDataLabelsAnimationOptions|PlotPyramidDataLabelsAnimationOptions|
  108733. PlotVariablepieDataLabelsAnimationOptions|Partial<AnimationOptionsObject>);
  108734. /**
  108735. * (Highcharts, Highstock, Highmaps, Gantt) The background color or gradient
  108736. * for the data label.
  108737. */
  108738. backgroundColor?: (ColorString|GradientColorObject|PatternObject);
  108739. /**
  108740. * (Highcharts, Highstock, Highmaps, Gantt) The border color for the data
  108741. * label. Defaults to `undefined`.
  108742. */
  108743. borderColor?: (ColorString|GradientColorObject|PatternObject);
  108744. /**
  108745. * (Highcharts, Highstock, Highmaps, Gantt) The border radius in pixels for
  108746. * the data label.
  108747. */
  108748. borderRadius?: number;
  108749. /**
  108750. * (Highcharts, Highstock, Highmaps, Gantt) The border width in pixels for
  108751. * the data label.
  108752. */
  108753. borderWidth?: number;
  108754. /**
  108755. * (Highcharts, Highstock, Highmaps, Gantt) A class name for the data label.
  108756. * Particularly in styled mode, this can be used to give each series' or
  108757. * point's data label unique styling. In addition to this option, a default
  108758. * color class name is added so that we can give the labels a contrast text
  108759. * shadow.
  108760. */
  108761. className?: string;
  108762. /**
  108763. * (Highcharts, Highstock, Highmaps, Gantt) The text color for the data
  108764. * labels. Defaults to `undefined`. For certain series types, like column or
  108765. * map, the data labels can be drawn inside the points. In this case the
  108766. * data label will be drawn with maximum contrast by default. Additionally,
  108767. * it will be given a `text-outline` style with the opposite color, to
  108768. * further increase the contrast. This can be overridden by setting the
  108769. * `text-outline` style to `none` in the `dataLabels.style` option.
  108770. */
  108771. color?: (ColorString|GradientColorObject|PatternObject);
  108772. /**
  108773. * (Highcharts) The color of the line connecting the data label to the pie
  108774. * slice. The default color is the same as the point's color.
  108775. *
  108776. * In styled mode, the connector stroke is given in the
  108777. * `.highcharts-data-label-connector` class.
  108778. */
  108779. connectorColor?: (ColorString|GradientColorObject|PatternObject);
  108780. /**
  108781. * (Highcharts) The distance from the data label to the connector. Note that
  108782. * data labels also have a default `padding`, so in order for the connector
  108783. * to touch the text, the `padding` must also be 0.
  108784. */
  108785. connectorPadding?: number;
  108786. /**
  108787. * (Highcharts) Specifies the method that is used to generate the connector
  108788. * path. Highcharts provides 3 built-in connector shapes: `'fixedOffset'`
  108789. * (default), `'straight'` and `'crookedLine'`. Using `'crookedLine'` has
  108790. * the most sense (in most of the cases) when `'alignTo'` is set.
  108791. *
  108792. * Users can provide their own method by passing a function instead of a
  108793. * String. 3 arguments are passed to the callback:
  108794. *
  108795. * - Object that holds the information about the coordinates of the label
  108796. * (`x` & `y` properties) and how the label is located in relation to the
  108797. * pie (`alignment` property). `alignment` can by one of the following:
  108798. * `'left'` (pie on the left side of the data label), `'right'` (pie on the
  108799. * right side of the data label) or `'center'` (data label overlaps the
  108800. * pie).
  108801. *
  108802. * - Object that holds the information about the position of the connector.
  108803. * Its `touchingSliceAt` porperty tells the position of the place where the
  108804. * connector touches the slice.
  108805. *
  108806. * - Data label options
  108807. *
  108808. * The function has to return an SVG path definition in array form (see the
  108809. * example).
  108810. */
  108811. connectorShape?: (string|Function);
  108812. /**
  108813. * (Highcharts) The width of the line connecting the data label to the pie
  108814. * slice.
  108815. *
  108816. * In styled mode, the connector stroke width is given in the
  108817. * `.highcharts-data-label-connector` class.
  108818. */
  108819. connectorWidth?: number;
  108820. /**
  108821. * (Highcharts) Works only if `connectorShape` is `'crookedLine'`. It
  108822. * defines how far from the vertical plot edge the coonnector path should be
  108823. * crooked.
  108824. */
  108825. crookDistance?: string;
  108826. /**
  108827. * (Highcharts, Highstock, Highmaps, Gantt) Whether to hide data labels that
  108828. * are outside the plot area. By default, the data label is moved inside the
  108829. * plot area according to the overflow option.
  108830. */
  108831. crop?: boolean;
  108832. /**
  108833. * (Highcharts, Highstock, Gantt) Whether to defer displaying the data
  108834. * labels until the initial series animation has finished. Setting to
  108835. * `false` renders the data label immediately. If set to `true` inherits the
  108836. * defer time set in plotOptions.series.animation.
  108837. */
  108838. defer?: boolean;
  108839. /**
  108840. * (Highcharts) The distance of the data label from the pie's edge. Negative
  108841. * numbers put the data label on top of the pie slices. Can also be defined
  108842. * as a percentage of pie's radius. Connectors are only shown for data
  108843. * labels outside the pie.
  108844. */
  108845. distance?: (number|string);
  108846. /**
  108847. * (Highcharts, Highstock, Highmaps, Gantt) Enable or disable the data
  108848. * labels.
  108849. */
  108850. enabled?: boolean;
  108851. /**
  108852. * (Highcharts, Highstock, Highmaps, Gantt) A declarative filter to control
  108853. * of which data labels to display. The declarative filter is designed for
  108854. * use when callback functions are not available, like when the chart
  108855. * options require a pure JSON structure or for use with graphical editors.
  108856. * For programmatic control, use the `formatter` instead, and return
  108857. * `undefined` to disable a single data label.
  108858. */
  108859. filter?: DataLabelsFilterOptionsObject;
  108860. /**
  108861. * (Highcharts, Highstock, Highmaps, Gantt) A format string for the data
  108862. * label. Available variables are the same as for `formatter`.
  108863. */
  108864. format?: string;
  108865. /**
  108866. * (Highcharts, Highstock, Highmaps, Gantt) Callback JavaScript function to
  108867. * format the data label. Note that if a `format` is defined, the format
  108868. * takes precedence and the formatter is ignored.
  108869. */
  108870. formatter?: DataLabelsFormatterCallbackFunction;
  108871. /**
  108872. * (Highcharts, Highstock, Highmaps, Gantt) Format for points with the value
  108873. * of null. Works analogously to format. `nullFormat` can be applied only to
  108874. * series which support displaying null points.
  108875. */
  108876. nullFormat?: (boolean|string);
  108877. /**
  108878. * (Highcharts, Highstock, Highmaps, Gantt) Callback JavaScript function
  108879. * that defines formatting for points with the value of null. Works
  108880. * analogously to formatter. `nullPointFormatter` can be applied only to
  108881. * series which support displaying null points.
  108882. */
  108883. nullFormatter?: DataLabelsFormatterCallbackFunction;
  108884. /**
  108885. * (Highcharts, Highstock, Highmaps, Gantt) How to handle data labels that
  108886. * flow outside the plot area. The default is `"justify"`, which aligns them
  108887. * inside the plot area. For columns and bars, this means it will be moved
  108888. * inside the bar. To display data labels outside the plot area, set `crop`
  108889. * to `false` and `overflow` to `"allow"`.
  108890. */
  108891. overflow?: DataLabelsOverflowValue;
  108892. /**
  108893. * (Highcharts, Highstock, Highmaps, Gantt) When either the `borderWidth` or
  108894. * the `backgroundColor` is set, this is the padding within the box.
  108895. */
  108896. padding?: number;
  108897. /**
  108898. * (Highcharts, Highstock, Highmaps, Gantt) Aligns data labels relative to
  108899. * points. If `center` alignment is not possible, it defaults to `right`.
  108900. */
  108901. position?: AlignValue;
  108902. /**
  108903. * (Highcharts, Highstock, Highmaps, Gantt) Text rotation in degrees. Note
  108904. * that due to a more complex structure, backgrounds, borders and padding
  108905. * will be lost on a rotated data label.
  108906. */
  108907. rotation?: number;
  108908. /**
  108909. * (Highcharts, Highstock, Highmaps, Gantt) The shadow of the box. Works
  108910. * best with `borderWidth` or `backgroundColor`. Since 2.3 the shadow can be
  108911. * an object configuration containing `color`, `offsetX`, `offsetY`,
  108912. * `opacity` and `width`.
  108913. */
  108914. shadow?: (boolean|ShadowOptionsObject);
  108915. /**
  108916. * (Highcharts, Highstock, Highmaps, Gantt) The name of a symbol to use for
  108917. * the border around the label. Symbols are predefined functions on the
  108918. * Renderer object.
  108919. */
  108920. shape?: string;
  108921. /**
  108922. * (Highcharts) Whether to render the connector as a soft arc or a line with
  108923. * sharp break. Works only if `connectorShape` equals to `fixedOffset`.
  108924. */
  108925. softConnector?: boolean;
  108926. /**
  108927. * (Highcharts, Highstock, Highmaps, Gantt) Styles for the label. The
  108928. * default `color` setting is `"contrast"`, which is a pseudo color that
  108929. * Highcharts picks up and applies the maximum contrast to the underlying
  108930. * point item, for example the bar in a bar chart.
  108931. *
  108932. * The `textOutline` is a pseudo property that applies an outline of the
  108933. * given width with the given color, which by default is the maximum
  108934. * contrast to the text. So a bright text color will result in a black text
  108935. * outline for maximum readability on a mixed background. In some cases,
  108936. * especially with grayscale text, the text outline doesn't work well, in
  108937. * which cases it can be disabled by setting it to `"none"`. When `useHTML`
  108938. * is true, the `textOutline` will not be picked up. In this, case, the same
  108939. * effect can be acheived through the `text-shadow` CSS property.
  108940. *
  108941. * For some series types, where each point has an extent, like for example
  108942. * tree maps, the data label may overflow the point. There are two
  108943. * strategies for handling overflow. By default, the text will wrap to
  108944. * multiple lines. The other strategy is to set `style.textOverflow` to
  108945. * `ellipsis`, which will keep the text on one line plus it will break
  108946. * inside long words.
  108947. */
  108948. style?: CSSObject;
  108949. /**
  108950. * (Highcharts, Highstock, Highmaps, Gantt) Options for a label text which
  108951. * should follow marker's shape. Border and background are disabled for a
  108952. * label that follows a path.
  108953. *
  108954. * **Note:** Only SVG-based renderer supports this option. Setting `useHTML`
  108955. * to true will disable this option.
  108956. */
  108957. textPath?: DataLabelsTextPathOptionsObject;
  108958. /**
  108959. * (Highcharts, Highstock, Highmaps, Gantt) Whether to use HTML to render
  108960. * the labels.
  108961. */
  108962. useHTML?: boolean;
  108963. /**
  108964. * (Highcharts, Highstock, Highmaps, Gantt) The vertical alignment of a data
  108965. * label. Can be one of `top`, `middle` or `bottom`. The default value
  108966. * depends on the data, for instance in a column chart, the label is above
  108967. * positive values and below negative values.
  108968. */
  108969. verticalAlign?: (string|VerticalAlignValue|null);
  108970. /**
  108971. * (Highcharts, Highstock, Highmaps, Gantt) The x position offset of the
  108972. * label relative to the point in pixels.
  108973. */
  108974. x?: number;
  108975. /**
  108976. * (Highcharts, Highstock, Highmaps, Gantt) The y position offset of the
  108977. * label relative to the point in pixels.
  108978. */
  108979. y?: number;
  108980. /**
  108981. * (Highcharts, Highstock, Highmaps, Gantt) The Z index of the data labels.
  108982. * The default Z index puts it above the series. Use a Z index of 2 to
  108983. * display it behind the series.
  108984. */
  108985. z?: number;
  108986. }
  108987. /**
  108988. * (Highcharts) A `pie` series. If the type option is not specified, it is
  108989. * inherited from chart.type.
  108990. *
  108991. * In TypeScript the type option must always be set.
  108992. *
  108993. * Configuration options for the series are given in three levels:
  108994. *
  108995. * 1. Options for all series in a chart are defined in the plotOptions.series
  108996. * object.
  108997. *
  108998. * 2. Options for all `pie` series are defined in plotOptions.pie.
  108999. *
  109000. * 3. Options for one single series are given in the series instance array. (see
  109001. * online documentation for example)
  109002. *
  109003. * You have to extend the `SeriesPieOptions` via an interface to allow custom
  109004. * properties: ``` declare interface SeriesPieOptions { customProperty: string;
  109005. * }
  109006. *
  109007. */
  109008. export interface SeriesPieOptions extends PlotPieOptions, SeriesOptions {
  109009. /**
  109010. * (Highcharts) An array of data points for the series. For the `pie` series
  109011. * type, points can be given in the following ways:
  109012. *
  109013. * 1. An array of numerical values. In this case, the numerical values will
  109014. * be interpreted as `y` options. Example: (see online documentation for
  109015. * example)
  109016. *
  109017. * 2. An array of objects with named values. The following snippet shows
  109018. * only a few settings, see the complete options set below. If the total
  109019. * number of data points exceeds the series' turboThreshold, this option is
  109020. * not available. (see online documentation for example)
  109021. */
  109022. data?: Array<(number|[string, (number|null)]|null|PointOptionsObject)>;
  109023. /**
  109024. * Not available
  109025. */
  109026. dataParser?: undefined;
  109027. /**
  109028. * Not available
  109029. */
  109030. dataURL?: undefined;
  109031. /**
  109032. * Not available
  109033. */
  109034. stack?: undefined;
  109035. /**
  109036. * (Highcharts, Highstock, Highmaps, Gantt) This property is only in
  109037. * TypeScript non-optional and might be `undefined` in series objects from
  109038. * unknown sources.
  109039. */
  109040. type: "pie";
  109041. /**
  109042. * Not available
  109043. */
  109044. xAxis?: undefined;
  109045. /**
  109046. * Not available
  109047. */
  109048. yAxis?: undefined;
  109049. }
  109050. /**
  109051. * (Highstock) A pivot points indicator. If the type option is not specified, it
  109052. * is inherited from chart.type.
  109053. *
  109054. * In TypeScript the type option must always be set.
  109055. *
  109056. * Configuration options for the series are given in three levels:
  109057. *
  109058. * 1. Options for all series in a chart are defined in the plotOptions.series
  109059. * object.
  109060. *
  109061. * 2. Options for all `pivotpoints` series are defined in
  109062. * plotOptions.pivotpoints.
  109063. *
  109064. * 3. Options for one single series are given in the series instance array. (see
  109065. * online documentation for example)
  109066. *
  109067. * You have to extend the `SeriesPivotpointsOptions` via an interface to allow
  109068. * custom properties: ``` declare interface SeriesPivotpointsOptions {
  109069. * customProperty: string; }
  109070. *
  109071. */
  109072. export interface SeriesPivotpointsOptions extends PlotPivotpointsOptions, SeriesOptions {
  109073. /**
  109074. * Not available
  109075. */
  109076. dataParser?: undefined;
  109077. /**
  109078. * Not available
  109079. */
  109080. dataURL?: undefined;
  109081. /**
  109082. * (Highcharts, Highstock, Highmaps, Gantt) This property is only in
  109083. * TypeScript non-optional and might be `undefined` in series objects from
  109084. * unknown sources.
  109085. */
  109086. type: "pivotpoints";
  109087. }
  109088. /**
  109089. * Translation and scale for the plot area of a series.
  109090. */
  109091. export interface SeriesPlotBoxObject {
  109092. scaleX: number;
  109093. scaleY: number;
  109094. translateX: number;
  109095. translateY: number;
  109096. }
  109097. /**
  109098. * (Highcharts, Highstock, Gantt) Enable or disable the initial animation when a
  109099. * series is displayed for the `dataLabels`. The animation can also be set as a
  109100. * configuration object. Please note that this option only applies to the
  109101. * initial animation. For other animations, see chart.animation and the
  109102. * animation parameter under the API methods. The following properties are
  109103. * supported:
  109104. *
  109105. * - `defer`: The animation delay time in milliseconds.
  109106. */
  109107. export interface SeriesPolygonDataDataLabelsAnimationOptions {
  109108. /**
  109109. * (Highcharts, Highstock, Gantt) The animation delay time in milliseconds.
  109110. * Set to `0` renders dataLabel immediately. As `undefined` inherits defer
  109111. * time from the series.animation.defer.
  109112. */
  109113. defer?: number;
  109114. }
  109115. /**
  109116. * (Highcharts, Highstock) Style options for the guide box. The guide box has
  109117. * one state by default, the `default` state.
  109118. */
  109119. export interface SeriesPolygonDataDragDropGuideBoxOptions {
  109120. /**
  109121. * (Highcharts, Highstock) Style options for the guide box default state.
  109122. */
  109123. default?: DragDropGuideBoxOptionsObject;
  109124. }
  109125. /**
  109126. * (Highcharts, Highstock) A `polygon` series. If the type option is not
  109127. * specified, it is inherited from chart.type.
  109128. *
  109129. * In TypeScript the type option must always be set.
  109130. *
  109131. * Configuration options for the series are given in three levels:
  109132. *
  109133. * 1. Options for all series in a chart are defined in the plotOptions.series
  109134. * object.
  109135. *
  109136. * 2. Options for all `polygon` series are defined in plotOptions.polygon.
  109137. *
  109138. * 3. Options for one single series are given in the series instance array. (see
  109139. * online documentation for example)
  109140. *
  109141. * You have to extend the `SeriesPolygonOptions` via an interface to allow
  109142. * custom properties: ``` declare interface SeriesPolygonOptions {
  109143. * customProperty: string; }
  109144. *
  109145. */
  109146. export interface SeriesPolygonOptions extends PlotPolygonOptions, SeriesOptions {
  109147. /**
  109148. * (Highcharts, Highstock) An array of data points for the series. For the
  109149. * `polygon` series type, points can be given in the following ways:
  109150. *
  109151. * 1. An array of numerical values. In this case, the numerical values will
  109152. * be interpreted as `y` options. The `x` values will be automatically
  109153. * calculated, either starting at 0 and incremented by 1, or from
  109154. * `pointStart` and `pointInterval` given in the series options. If the axis
  109155. * has categories, these will be used. Example: (see online documentation
  109156. * for example)
  109157. *
  109158. * 2. An array of arrays with 2 values. In this case, the values correspond
  109159. * to `x,y`. If the first value is a string, it is applied as the name of
  109160. * the point, and the `x` value is inferred. (see online documentation for
  109161. * example)
  109162. *
  109163. * 3. An array of objects with named values. The following snippet shows
  109164. * only a few settings, see the complete options set below. If the total
  109165. * number of data points exceeds the series' turboThreshold, this option is
  109166. * not available. (see online documentation for example)
  109167. */
  109168. data?: Array<(number|[(number|string), (number|null)]|null|PointOptionsObject)>;
  109169. /**
  109170. * Not available
  109171. */
  109172. dataParser?: undefined;
  109173. /**
  109174. * Not available
  109175. */
  109176. dataURL?: undefined;
  109177. /**
  109178. * Not available
  109179. */
  109180. stack?: undefined;
  109181. /**
  109182. * (Highcharts, Highstock, Highmaps, Gantt) This property is only in
  109183. * TypeScript non-optional and might be `undefined` in series objects from
  109184. * unknown sources.
  109185. */
  109186. type: "polygon";
  109187. }
  109188. /**
  109189. * (Highstock) A `Percentage Price Oscillator` series. If the type option is not
  109190. * specified, it is inherited from chart.type.
  109191. *
  109192. * In TypeScript the type option must always be set.
  109193. *
  109194. * Configuration options for the series are given in three levels:
  109195. *
  109196. * 1. Options for all series in a chart are defined in the plotOptions.series
  109197. * object.
  109198. *
  109199. * 2. Options for all `ppo` series are defined in plotOptions.ppo.
  109200. *
  109201. * 3. Options for one single series are given in the series instance array. (see
  109202. * online documentation for example)
  109203. *
  109204. * You have to extend the `SeriesPpoOptions` via an interface to allow custom
  109205. * properties: ``` declare interface SeriesPpoOptions { customProperty: string;
  109206. * }
  109207. *
  109208. */
  109209. export interface SeriesPpoOptions extends PlotPpoOptions, SeriesOptions {
  109210. /**
  109211. * Not available
  109212. */
  109213. dataParser?: undefined;
  109214. /**
  109215. * Not available
  109216. */
  109217. dataURL?: undefined;
  109218. /**
  109219. * (Highcharts, Highstock, Highmaps, Gantt) This property is only in
  109220. * TypeScript non-optional and might be `undefined` in series objects from
  109221. * unknown sources.
  109222. */
  109223. type: "ppo";
  109224. }
  109225. /**
  109226. * (Highstock) A price envelopes indicator. If the type option is not specified,
  109227. * it is inherited from chart.type.
  109228. *
  109229. * In TypeScript the type option must always be set.
  109230. *
  109231. * Configuration options for the series are given in three levels:
  109232. *
  109233. * 1. Options for all series in a chart are defined in the plotOptions.series
  109234. * object.
  109235. *
  109236. * 2. Options for all `priceenvelopes` series are defined in
  109237. * plotOptions.priceenvelopes.
  109238. *
  109239. * 3. Options for one single series are given in the series instance array. (see
  109240. * online documentation for example)
  109241. *
  109242. * You have to extend the `SeriesPriceenvelopesOptions` via an interface to
  109243. * allow custom properties: ``` declare interface SeriesPriceenvelopesOptions {
  109244. * customProperty: string; }
  109245. *
  109246. */
  109247. export interface SeriesPriceenvelopesOptions extends PlotPriceenvelopesOptions, SeriesOptions {
  109248. /**
  109249. * Not available
  109250. */
  109251. dataParser?: undefined;
  109252. /**
  109253. * Not available
  109254. */
  109255. dataURL?: undefined;
  109256. /**
  109257. * (Highcharts, Highstock, Highmaps, Gantt) This property is only in
  109258. * TypeScript non-optional and might be `undefined` in series objects from
  109259. * unknown sources.
  109260. */
  109261. type: "priceenvelopes";
  109262. }
  109263. /**
  109264. * (Highstock) A `PSAR` series. If the type option is not specified, it is
  109265. * inherited from chart.type.
  109266. *
  109267. * In TypeScript the type option must always be set.
  109268. *
  109269. * Configuration options for the series are given in three levels:
  109270. *
  109271. * 1. Options for all series in a chart are defined in the plotOptions.series
  109272. * object.
  109273. *
  109274. * 2. Options for all `psar` series are defined in plotOptions.psar.
  109275. *
  109276. * 3. Options for one single series are given in the series instance array. (see
  109277. * online documentation for example)
  109278. *
  109279. * You have to extend the `SeriesPsarOptions` via an interface to allow custom
  109280. * properties: ``` declare interface SeriesPsarOptions { customProperty: string;
  109281. * }
  109282. *
  109283. */
  109284. export interface SeriesPsarOptions extends PlotPsarOptions, SeriesOptions {
  109285. /**
  109286. * Not available
  109287. */
  109288. dataParser?: undefined;
  109289. /**
  109290. * Not available
  109291. */
  109292. dataURL?: undefined;
  109293. /**
  109294. * (Highcharts, Highstock, Highmaps, Gantt) This property is only in
  109295. * TypeScript non-optional and might be `undefined` in series objects from
  109296. * unknown sources.
  109297. */
  109298. type: "psar";
  109299. }
  109300. /**
  109301. * (Highcharts) A `pyramid3d` series. If the type option is not specified, it is
  109302. * inherited from chart.type.
  109303. *
  109304. * In TypeScript the type option must always be set.
  109305. *
  109306. * Configuration options for the series are given in three levels:
  109307. *
  109308. * 1. Options for all series in a chart are defined in the plotOptions.series
  109309. * object.
  109310. *
  109311. * 2. Options for all `pyramid3d` series are defined in plotOptions.pyramid3d.
  109312. *
  109313. * 3. Options for one single series are given in the series instance array. (see
  109314. * online documentation for example)
  109315. *
  109316. * You have to extend the `SeriesPyramid3dOptions` via an interface to allow
  109317. * custom properties: ``` declare interface SeriesPyramid3dOptions {
  109318. * customProperty: string; }
  109319. *
  109320. */
  109321. export interface SeriesPyramid3dOptions extends PlotPyramid3dOptions, SeriesOptions {
  109322. /**
  109323. * Not available
  109324. */
  109325. allAreas?: undefined;
  109326. /**
  109327. * Not available
  109328. */
  109329. boostThreshold?: undefined;
  109330. /**
  109331. * (Highcharts) The center of the series. By default, it is centered in the
  109332. * middle of the plot area, so it fills the plot area height.
  109333. */
  109334. center?: Array<(number|string)>;
  109335. /**
  109336. * Not available
  109337. */
  109338. colorAxis?: undefined;
  109339. /**
  109340. * Not available
  109341. */
  109342. compare?: undefined;
  109343. /**
  109344. * Not available
  109345. */
  109346. compareBase?: undefined;
  109347. /**
  109348. * (Highcharts) Polar charts only. Whether to connect the ends of a line
  109349. * series plot across the extremes.
  109350. */
  109351. connectEnds?: boolean;
  109352. /**
  109353. * (Highcharts, Highstock) Whether to connect a graph line across null
  109354. * points, or render a gap between the two points on either side of the
  109355. * null.
  109356. */
  109357. connectNulls?: boolean;
  109358. /**
  109359. * Not available
  109360. */
  109361. dataSorting?: undefined;
  109362. /**
  109363. * (Highcharts) The end angle of the pie in degrees where 0 is top and 90 is
  109364. * right. Defaults to `startAngle` plus 360.
  109365. */
  109366. endAngle?: number;
  109367. /**
  109368. * (Highcharts) If the total sum of the pie's values is 0, the series is
  109369. * represented as an empty circle . The `fillColor` option defines the color
  109370. * of that circle. Use pie.borderWidth to set the border thickness.
  109371. */
  109372. fillColor?: (ColorString|GradientColorObject|PatternObject);
  109373. /**
  109374. * (Highstock) Defines when to display a gap in the graph, together with the
  109375. * gapUnit option.
  109376. *
  109377. * In case when `dataGrouping` is enabled, points can be grouped into a
  109378. * larger time span. This can make the grouped points to have a greater
  109379. * distance than the absolute value of `gapSize` property, which will result
  109380. * in disappearing graph completely. To prevent this situation the mentioned
  109381. * distance between grouped points is used instead of previously defined
  109382. * `gapSize`.
  109383. *
  109384. * In practice, this option is most often used to visualize gaps in time
  109385. * series. In a stock chart, intraday data is available for daytime hours,
  109386. * while gaps will appear in nights and weekends.
  109387. */
  109388. gapSize?: number;
  109389. /**
  109390. * (Highstock) Together with gapSize, this option defines where to draw gaps
  109391. * in the graph.
  109392. *
  109393. * When the `gapUnit` is `"relative"` (default), a gap size of 5 means that
  109394. * if the distance between two points is greater than 5 times that of the
  109395. * two closest points, the graph will be broken.
  109396. *
  109397. * When the `gapUnit` is `"value"`, the gap is based on absolute axis
  109398. * values, which on a datetime axis is milliseconds. This also applies to
  109399. * the navigator series that inherits gap options from the base series.
  109400. */
  109401. gapUnit?: OptionsGapUnitValue;
  109402. /**
  109403. * (Highcharts) Equivalent to chart.ignoreHiddenSeries, this option tells
  109404. * whether the series shall be redrawn as if the hidden point were `null`.
  109405. *
  109406. * The default value changed from `false` to `true` with Highcharts 3.0.
  109407. */
  109408. ignoreHiddenPoint?: boolean;
  109409. /**
  109410. * (Highcharts, Highstock) The line cap used for line ends and line joins on
  109411. * the graph.
  109412. */
  109413. linecap?: SeriesLinecapValue;
  109414. /**
  109415. * (Highcharts, Highstock) Pixel width of the graph line.
  109416. */
  109417. lineWidth?: number;
  109418. /**
  109419. * (Highcharts) Options for the point markers of line-like series.
  109420. * Properties like `fillColor`, `lineColor` and `lineWidth` define the
  109421. * visual appearance of the markers. Other series types, like column series,
  109422. * don't have markers, but have visual options on the series level instead.
  109423. *
  109424. * In styled mode, the markers can be styled with the `.highcharts-point`,
  109425. * `.highcharts-point-hover` and `.highcharts-point-select` class names.
  109426. */
  109427. marker?: PointMarkerOptionsObject;
  109428. /**
  109429. * (Highcharts) The minimum size for a pie in response to auto margins. The
  109430. * pie will try to shrink to make room for data labels in side the plot
  109431. * area, but only to this size.
  109432. */
  109433. minSize?: (number|string);
  109434. /**
  109435. * (Highcharts) If a point is sliced, moved out from the center, how many
  109436. * pixels should it be moved?.
  109437. */
  109438. slicedOffset?: number;
  109439. /**
  109440. * (Highcharts) The start angle of the pie slices in degrees where 0 is top
  109441. * and 90 right.
  109442. */
  109443. startAngle?: number;
  109444. /**
  109445. * (Highcharts, Highstock) Whether to apply steps to the line. Possible
  109446. * values are `left`, `center` and `right`.
  109447. */
  109448. step?: OptionsStepValue;
  109449. /**
  109450. * (Highcharts, Highstock, Highmaps, Gantt) This property is only in
  109451. * TypeScript non-optional and might be `undefined` in series objects from
  109452. * unknown sources.
  109453. */
  109454. type: "pyramid3d";
  109455. /**
  109456. * (Highstock) The parameter allows setting line series type and use OHLC
  109457. * indicators. Data in OHLC format is required.
  109458. */
  109459. useOhlcData?: boolean;
  109460. }
  109461. /**
  109462. * (Highcharts) Enable or disable the initial animation when a series is
  109463. * displayed for the `dataLabels`. The animation can also be set as a
  109464. * configuration object. Please note that this option only applies to the
  109465. * initial animation. For other animations, see chart.animation and the
  109466. * animation parameter under the API methods. The following properties are
  109467. * supported:
  109468. *
  109469. * - `defer`: The animation delay time in milliseconds.
  109470. */
  109471. export interface SeriesPyramidDataDataLabelsAnimationOptions {
  109472. /**
  109473. * (Highcharts) The animation delay time in milliseconds. Set to `0` renders
  109474. * dataLabel immediately. As `undefined` inherits defer time from the
  109475. * series.animation.defer.
  109476. */
  109477. defer?: number;
  109478. }
  109479. /**
  109480. * (Highcharts) Style options for the guide box. The guide box has one state by
  109481. * default, the `default` state.
  109482. */
  109483. export interface SeriesPyramidDataDragDropGuideBoxOptions {
  109484. /**
  109485. * (Highcharts) Style options for the guide box default state.
  109486. */
  109487. default?: DragDropGuideBoxOptionsObject;
  109488. }
  109489. /**
  109490. * (Highcharts) A `pyramid` series. If the type option is not specified, it is
  109491. * inherited from chart.type.
  109492. *
  109493. * In TypeScript the type option must always be set.
  109494. *
  109495. * Configuration options for the series are given in three levels:
  109496. *
  109497. * 1. Options for all series in a chart are defined in the plotOptions.series
  109498. * object.
  109499. *
  109500. * 2. Options for all `pyramid` series are defined in plotOptions.pyramid.
  109501. *
  109502. * 3. Options for one single series are given in the series instance array. (see
  109503. * online documentation for example)
  109504. *
  109505. * You have to extend the `SeriesPyramidOptions` via an interface to allow
  109506. * custom properties: ``` declare interface SeriesPyramidOptions {
  109507. * customProperty: string; }
  109508. *
  109509. */
  109510. export interface SeriesPyramidOptions extends PlotPyramidOptions, SeriesOptions {
  109511. /**
  109512. * (Highcharts) An array of data points for the series. For the `pyramid`
  109513. * series type, points can be given in the following ways:
  109514. *
  109515. * 1. An array of numerical values. In this case, the numerical values will
  109516. * be interpreted as `y` options. Example: (see online documentation for
  109517. * example)
  109518. *
  109519. * 2. An array of objects with named values. The following snippet shows
  109520. * only a few settings, see the complete options set below. If the total
  109521. * number of data points exceeds the series' turboThreshold, this option is
  109522. * not available. (see online documentation for example)
  109523. */
  109524. data?: Array<(number|null|PointOptionsObject)>;
  109525. /**
  109526. * Not available
  109527. */
  109528. dataParser?: undefined;
  109529. /**
  109530. * Not available
  109531. */
  109532. dataURL?: undefined;
  109533. /**
  109534. * Not available
  109535. */
  109536. stack?: undefined;
  109537. /**
  109538. * (Highcharts, Highstock, Highmaps, Gantt) This property is only in
  109539. * TypeScript non-optional and might be `undefined` in series objects from
  109540. * unknown sources.
  109541. */
  109542. type: "pyramid";
  109543. /**
  109544. * Not available
  109545. */
  109546. xAxis?: undefined;
  109547. /**
  109548. * Not available
  109549. */
  109550. yAxis?: undefined;
  109551. }
  109552. /**
  109553. * (Highstock) A `ROC` series. If the type option is not specified, it is
  109554. * inherited from chart.type.
  109555. *
  109556. * Rate of change indicator (ROC). The indicator value for each point is defined
  109557. * as:
  109558. *
  109559. * `(C - Cn) / Cn * 100`
  109560. *
  109561. * where: `C` is the close value of the point of the same x in the linked series
  109562. * and `Cn` is the close value of the point `n` periods ago. `n` is set through
  109563. * period.
  109564. *
  109565. * This series requires `linkedTo` option to be set.
  109566. *
  109567. * In TypeScript the type option must always be set.
  109568. *
  109569. * Configuration options for the series are given in three levels:
  109570. *
  109571. * 1. Options for all series in a chart are defined in the plotOptions.series
  109572. * object.
  109573. *
  109574. * 2. Options for all `roc` series are defined in plotOptions.roc.
  109575. *
  109576. * 3. Options for one single series are given in the series instance array. (see
  109577. * online documentation for example)
  109578. *
  109579. * You have to extend the `SeriesRocOptions` via an interface to allow custom
  109580. * properties: ``` declare interface SeriesRocOptions { customProperty: string;
  109581. * }
  109582. *
  109583. */
  109584. export interface SeriesRocOptions extends PlotRocOptions, SeriesOptions {
  109585. /**
  109586. * Not available
  109587. */
  109588. dataParser?: undefined;
  109589. /**
  109590. * Not available
  109591. */
  109592. dataURL?: undefined;
  109593. /**
  109594. * (Highcharts, Highstock, Highmaps, Gantt) This property is only in
  109595. * TypeScript non-optional and might be `undefined` in series objects from
  109596. * unknown sources.
  109597. */
  109598. type: "roc";
  109599. }
  109600. /**
  109601. * (Highstock) A `RSI` series. If the type option is not specified, it is
  109602. * inherited from chart.type.
  109603. *
  109604. * In TypeScript the type option must always be set.
  109605. *
  109606. * Configuration options for the series are given in three levels:
  109607. *
  109608. * 1. Options for all series in a chart are defined in the plotOptions.series
  109609. * object.
  109610. *
  109611. * 2. Options for all `rsi` series are defined in plotOptions.rsi.
  109612. *
  109613. * 3. Options for one single series are given in the series instance array. (see
  109614. * online documentation for example)
  109615. *
  109616. * You have to extend the `SeriesRsiOptions` via an interface to allow custom
  109617. * properties: ``` declare interface SeriesRsiOptions { customProperty: string;
  109618. * }
  109619. *
  109620. */
  109621. export interface SeriesRsiOptions extends PlotRsiOptions, SeriesOptions {
  109622. /**
  109623. * Not available
  109624. */
  109625. dataParser?: undefined;
  109626. /**
  109627. * Not available
  109628. */
  109629. dataURL?: undefined;
  109630. /**
  109631. * (Highcharts, Highstock, Highmaps, Gantt) This property is only in
  109632. * TypeScript non-optional and might be `undefined` in series objects from
  109633. * unknown sources.
  109634. */
  109635. type: "rsi";
  109636. }
  109637. /**
  109638. * (Highcharts) Enable or disable the initial animation when a series is
  109639. * displayed for the `dataLabels`. The animation can also be set as a
  109640. * configuration object. Please note that this option only applies to the
  109641. * initial animation. For other animations, see chart.animation and the
  109642. * animation parameter under the API methods. The following properties are
  109643. * supported:
  109644. *
  109645. * - `defer`: The animation delay time in milliseconds.
  109646. */
  109647. export interface SeriesSankeyDataDataLabelsAnimationOptions {
  109648. /**
  109649. * (Highcharts) The animation delay time in milliseconds. Set to `0` renders
  109650. * dataLabel immediately. As `undefined` inherits defer time from the
  109651. * series.animation.defer.
  109652. */
  109653. defer?: number;
  109654. }
  109655. /**
  109656. * Context for the node formatter function.
  109657. */
  109658. export interface SeriesSankeyDataLabelsFormatterContextObject extends PointLabelObject {
  109659. /**
  109660. * The node object. The node name, if defined, is available through
  109661. * `this.point.name`.
  109662. */
  109663. point: SankeyNodeObject;
  109664. }
  109665. /**
  109666. * (Highcharts, Highstock, Highmaps, Gantt) Individual data label for each node.
  109667. * The options are the same as the ones for series.sankey.dataLabels.
  109668. */
  109669. export interface SeriesSankeyDataLabelsOptionsObject {
  109670. /**
  109671. * (Highcharts, Highstock, Highmaps, Gantt) The alignment of the data label
  109672. * compared to the point. If `right`, the right side of the label should be
  109673. * touching the point. For points with an extent, like columns, the
  109674. * alignments also dictates how to align it inside the box, as given with
  109675. * the inside option. Can be one of `left`, `center` or `right`.
  109676. */
  109677. align?: string;
  109678. /**
  109679. * (Highcharts, Highstock, Highmaps, Gantt) Whether to allow data labels to
  109680. * overlap. To make the labels less sensitive for overlapping, the
  109681. * dataLabels.padding can be set to 0.
  109682. */
  109683. allowOverlap?: boolean;
  109684. /**
  109685. * (Highcharts, Highstock, Highmaps, Gantt) Enable or disable the initial
  109686. * animation when a series is displayed for the `dataLabels`. The animation
  109687. * can also be set as a configuration object. Please note that this option
  109688. * only applies to the initial animation. For other animations, see
  109689. * chart.animation and the animation parameter under the API methods. The
  109690. * following properties are supported:
  109691. *
  109692. * - `defer`: The animation delay time in milliseconds.
  109693. */
  109694. animation?: (boolean|PlotDependencywheelDataLabelsAnimationOptions|PlotDependencywheelLevelsDataLabelsAnimationOptions|PlotOrganizationLevelsDataLabelsAnimationOptions|
  109695. PlotSankeyDataLabelsAnimationOptions|PlotSankeyLevelsDataLabelsAnimationOptions|SeriesDependencywheelNodesDataLabelsAnimationOptions|SeriesOrganizationNodesDataLabelsAnimationOptions|
  109696. SeriesSankeyNodesDataLabelsAnimationOptions|Partial<AnimationOptionsObject>);
  109697. /**
  109698. * (Highcharts, Highstock, Highmaps, Gantt) The background color or gradient
  109699. * for the data label.
  109700. */
  109701. backgroundColor?: string;
  109702. /**
  109703. * (Highcharts, Highstock, Highmaps, Gantt) The border color for the data
  109704. * label. Defaults to `undefined`.
  109705. */
  109706. borderColor?: (ColorString|GradientColorObject|PatternObject);
  109707. /**
  109708. * (Highcharts, Highstock, Highmaps, Gantt) The border radius in pixels for
  109709. * the data label.
  109710. */
  109711. borderRadius?: number;
  109712. /**
  109713. * (Highcharts, Highstock, Highmaps, Gantt) The border width in pixels for
  109714. * the data label.
  109715. */
  109716. borderWidth?: number;
  109717. /**
  109718. * (Highcharts, Highstock, Highmaps, Gantt) A class name for the data label.
  109719. * Particularly in styled mode, this can be used to give each series' or
  109720. * point's data label unique styling. In addition to this option, a default
  109721. * color class name is added so that we can give the labels a contrast text
  109722. * shadow.
  109723. */
  109724. className?: string;
  109725. /**
  109726. * (Highcharts, Highstock, Highmaps, Gantt) The text color for the data
  109727. * labels. Defaults to `undefined`. For certain series types, like column or
  109728. * map, the data labels can be drawn inside the points. In this case the
  109729. * data label will be drawn with maximum contrast by default. Additionally,
  109730. * it will be given a `text-outline` style with the opposite color, to
  109731. * further increase the contrast. This can be overridden by setting the
  109732. * `text-outline` style to `none` in the `dataLabels.style` option.
  109733. */
  109734. color?: (ColorString|GradientColorObject|PatternObject);
  109735. /**
  109736. * (Highcharts, Highstock, Highmaps, Gantt) Whether to hide data labels that
  109737. * are outside the plot area. By default, the data label is moved inside the
  109738. * plot area according to the overflow option.
  109739. */
  109740. crop?: boolean;
  109741. /**
  109742. * (Highcharts, Highstock, Gantt) Whether to defer displaying the data
  109743. * labels until the initial series animation has finished. Setting to
  109744. * `false` renders the data label immediately. If set to `true` inherits the
  109745. * defer time set in plotOptions.series.animation.
  109746. */
  109747. defer?: boolean;
  109748. /**
  109749. * (Highcharts, Highstock, Highmaps, Gantt) Enable or disable the data
  109750. * labels.
  109751. */
  109752. enabled?: boolean;
  109753. /**
  109754. * (Highcharts, Highstock, Highmaps, Gantt) A declarative filter to control
  109755. * of which data labels to display. The declarative filter is designed for
  109756. * use when callback functions are not available, like when the chart
  109757. * options require a pure JSON structure or for use with graphical editors.
  109758. * For programmatic control, use the `formatter` instead, and return
  109759. * `undefined` to disable a single data label.
  109760. */
  109761. filter?: DataLabelsFilterOptionsObject;
  109762. /**
  109763. * (Highcharts, Highstock, Highmaps, Gantt) A format string for the data
  109764. * label. Available variables are the same as for `formatter`.
  109765. */
  109766. format?: string;
  109767. /**
  109768. * (Highcharts, Highstock, Highmaps, Gantt) Callback JavaScript function to
  109769. * format the data label. Note that if a `format` is defined, the format
  109770. * takes precedence and the formatter is ignored.
  109771. */
  109772. formatter?: SeriesSankeyDataLabelsFormatterCallbackFunction;
  109773. /**
  109774. * (Highcharts, Highstock, Highmaps, Gantt) For points with an extent, like
  109775. * columns or map areas, whether to align the data label inside the box or
  109776. * to the actual value point. Defaults to `false` in most cases, `true` in
  109777. * stacked columns.
  109778. */
  109779. inside?: boolean;
  109780. /**
  109781. * (Highcharts, Highstock, Highmaps, Gantt) The format string specifying
  109782. * what to show for _nodes_ in the sankey diagram. By default the
  109783. * `nodeFormatter` returns `{point.name}`.
  109784. */
  109785. nodeFormat?: string;
  109786. /**
  109787. * (Highcharts, Highstock, Highmaps, Gantt) Callback to format data labels
  109788. * for _nodes_ in the sankey diagram. The `nodeFormat` option takes
  109789. * precedence over the `nodeFormatter`.
  109790. */
  109791. nodeFormatter?: SeriesSankeyDataLabelsFormatterCallbackFunction;
  109792. /**
  109793. * (Highcharts, Highstock, Highmaps, Gantt) Format for points with the value
  109794. * of null. Works analogously to format. `nullFormat` can be applied only to
  109795. * series which support displaying null points.
  109796. */
  109797. nullFormat?: (boolean|string);
  109798. /**
  109799. * (Highcharts, Highstock, Highmaps, Gantt) Callback JavaScript function
  109800. * that defines formatting for points with the value of null. Works
  109801. * analogously to formatter. `nullPointFormatter` can be applied only to
  109802. * series which support displaying null points.
  109803. */
  109804. nullFormatter?: DataLabelsFormatterCallbackFunction;
  109805. /**
  109806. * (Highcharts, Highstock, Highmaps, Gantt) How to handle data labels that
  109807. * flow outside the plot area. The default is `"justify"`, which aligns them
  109808. * inside the plot area. For columns and bars, this means it will be moved
  109809. * inside the bar. To display data labels outside the plot area, set `crop`
  109810. * to `false` and `overflow` to `"allow"`.
  109811. */
  109812. overflow?: DataLabelsOverflowValue;
  109813. /**
  109814. * (Highcharts, Highstock, Highmaps, Gantt) When either the `borderWidth` or
  109815. * the `backgroundColor` is set, this is the padding within the box.
  109816. */
  109817. padding?: number;
  109818. /**
  109819. * (Highcharts, Highstock, Highmaps, Gantt) Aligns data labels relative to
  109820. * points. If `center` alignment is not possible, it defaults to `right`.
  109821. */
  109822. position?: AlignValue;
  109823. /**
  109824. * (Highcharts, Highstock, Highmaps, Gantt) Text rotation in degrees. Note
  109825. * that due to a more complex structure, backgrounds, borders and padding
  109826. * will be lost on a rotated data label.
  109827. */
  109828. rotation?: number;
  109829. /**
  109830. * (Highcharts, Highstock, Highmaps, Gantt) The shadow of the box. Works
  109831. * best with `borderWidth` or `backgroundColor`. Since 2.3 the shadow can be
  109832. * an object configuration containing `color`, `offsetX`, `offsetY`,
  109833. * `opacity` and `width`.
  109834. */
  109835. shadow?: (boolean|ShadowOptionsObject);
  109836. /**
  109837. * (Highcharts, Highstock, Highmaps, Gantt) The name of a symbol to use for
  109838. * the border around the label. Symbols are predefined functions on the
  109839. * Renderer object.
  109840. */
  109841. shape?: string;
  109842. /**
  109843. * (Highcharts, Highstock, Highmaps, Gantt) Styles for the label. The
  109844. * default `color` setting is `"contrast"`, which is a pseudo color that
  109845. * Highcharts picks up and applies the maximum contrast to the underlying
  109846. * point item, for example the bar in a bar chart.
  109847. *
  109848. * The `textOutline` is a pseudo property that applies an outline of the
  109849. * given width with the given color, which by default is the maximum
  109850. * contrast to the text. So a bright text color will result in a black text
  109851. * outline for maximum readability on a mixed background. In some cases,
  109852. * especially with grayscale text, the text outline doesn't work well, in
  109853. * which cases it can be disabled by setting it to `"none"`. When `useHTML`
  109854. * is true, the `textOutline` will not be picked up. In this, case, the same
  109855. * effect can be acheived through the `text-shadow` CSS property.
  109856. *
  109857. * For some series types, where each point has an extent, like for example
  109858. * tree maps, the data label may overflow the point. There are two
  109859. * strategies for handling overflow. By default, the text will wrap to
  109860. * multiple lines. The other strategy is to set `style.textOverflow` to
  109861. * `ellipsis`, which will keep the text on one line plus it will break
  109862. * inside long words.
  109863. */
  109864. style?: CSSObject;
  109865. /**
  109866. * (Highcharts, Highstock, Highmaps, Gantt) Options for a label text which
  109867. * should follow marker's shape. Border and background are disabled for a
  109868. * label that follows a path.
  109869. *
  109870. * **Note:** Only SVG-based renderer supports this option. Setting `useHTML`
  109871. * to true will disable this option.
  109872. */
  109873. textPath?: DataLabelsTextPathOptionsObject;
  109874. /**
  109875. * (Highcharts, Highstock, Highmaps, Gantt) Whether to use HTML to render
  109876. * the labels.
  109877. */
  109878. useHTML?: boolean;
  109879. /**
  109880. * (Highcharts, Highstock, Highmaps, Gantt) The vertical alignment of a data
  109881. * label. Can be one of `top`, `middle` or `bottom`. The default value
  109882. * depends on the data, for instance in a column chart, the label is above
  109883. * positive values and below negative values.
  109884. */
  109885. verticalAlign?: string;
  109886. /**
  109887. * (Highcharts, Highstock, Highmaps, Gantt) The x position offset of the
  109888. * label relative to the point in pixels.
  109889. */
  109890. x?: number;
  109891. /**
  109892. * (Highcharts, Highstock, Highmaps, Gantt) The y position offset of the
  109893. * label relative to the point in pixels.
  109894. */
  109895. y?: number;
  109896. /**
  109897. * (Highcharts, Highstock, Highmaps, Gantt) The Z index of the data labels.
  109898. * The default Z index puts it above the series. Use a Z index of 2 to
  109899. * display it behind the series.
  109900. */
  109901. z?: number;
  109902. }
  109903. /**
  109904. * (Highcharts, Highstock, Highmaps, Gantt) Enable or disable the initial
  109905. * animation when a series is displayed for the `dataLabels`. The animation can
  109906. * also be set as a configuration object. Please note that this option only
  109907. * applies to the initial animation. For other animations, see chart.animation
  109908. * and the animation parameter under the API methods. The following properties
  109909. * are supported:
  109910. *
  109911. * - `defer`: The animation delay time in milliseconds.
  109912. */
  109913. export interface SeriesSankeyNodesDataLabelsAnimationOptions {
  109914. /**
  109915. * (Highcharts, Highstock, Highmaps, Gantt) The animation delay time in
  109916. * milliseconds. Set to `0` renders dataLabel immediately. As `undefined`
  109917. * inherits defer time from the series.animation.defer.
  109918. */
  109919. defer?: number;
  109920. }
  109921. /**
  109922. * (Highcharts) A collection of options for the individual nodes. The nodes in a
  109923. * sankey diagram are auto-generated instances of `Highcharts.Point`, but
  109924. * options can be applied here and linked by the `id`.
  109925. */
  109926. export interface SeriesSankeyNodesOptionsObject {
  109927. /**
  109928. * (Highcharts) The color of the auto generated node.
  109929. */
  109930. color?: (ColorString|GradientColorObject|PatternObject);
  109931. /**
  109932. * (Highcharts) The color index of the auto generated node, especially for
  109933. * use in styled mode.
  109934. */
  109935. colorIndex?: number;
  109936. /**
  109937. * (Highcharts) An optional column index of where to place the node. The
  109938. * default behaviour is to place it next to the preceding node. Note that
  109939. * this option name is counter intuitive in inverted charts, like for
  109940. * example an organization chart rendered top down. In this case the
  109941. * "columns" are horizontal.
  109942. */
  109943. column?: number;
  109944. /**
  109945. * (Highcharts, Highstock, Highmaps, Gantt) Individual data label for each
  109946. * node. The options are the same as the ones for series.sankey.dataLabels.
  109947. */
  109948. dataLabels?: (SeriesOrganizationDataLabelsOptionsObject|SeriesSankeyDataLabelsOptionsObject|Array<SeriesOrganizationDataLabelsOptionsObject>|Array<SeriesSankeyDataLabelsOptionsObject>);
  109949. /**
  109950. * (Highcharts) The job description for the node card, will be inserted by
  109951. * the default `dataLabel.nodeFormatter`.
  109952. */
  109953. description?: string;
  109954. /**
  109955. * (Highcharts) The id of the auto-generated node, refering to the `from` or
  109956. * `to` setting of the link.
  109957. */
  109958. id?: string;
  109959. /**
  109960. * (Highcharts) An image for the node card, will be inserted by the default
  109961. * `dataLabel.nodeFormatter`.
  109962. */
  109963. image?: string;
  109964. /**
  109965. * (Highcharts) Layout for the node's children. If `hanging`, this node's
  109966. * children will hang below their parent, allowing a tighter packing of
  109967. * nodes in the diagram.
  109968. */
  109969. layout?: SeriesOrganizationNodesLayoutValue;
  109970. /**
  109971. * (Highcharts) An optional level index of where to place the node. The
  109972. * default behaviour is to place it next to the preceding node. Alias of
  109973. * `nodes.column`, but in inverted sankeys and org charts, the levels are
  109974. * laid out as rows.
  109975. */
  109976. level?: number;
  109977. /**
  109978. * (Highcharts) The name to display for the node in data labels and
  109979. * tooltips. Use this when the name is different from the `id`. Where the id
  109980. * must be unique for each node, this is not necessary for the name.
  109981. */
  109982. name?: string;
  109983. /**
  109984. * (Highcharts) In a horizontal layout, the vertical offset of a node in
  109985. * terms of weight. Positive values shift the node downwards, negative shift
  109986. * it upwards. In a vertical layout, like organization chart, the offset is
  109987. * horizontal.
  109988. *
  109989. * If a percantage string is given, the node is offset by the percentage of
  109990. * the node size plus `nodePadding`.
  109991. */
  109992. offset?: (number|string);
  109993. /**
  109994. * (Highcharts) The job title for the node card, will be inserted by the
  109995. * default `dataLabel.nodeFormatter`.
  109996. */
  109997. title?: string;
  109998. }
  109999. /**
  110000. * (Highcharts) A `sankey` series. If the type option is not specified, it is
  110001. * inherited from chart.type.
  110002. *
  110003. * In TypeScript the type option must always be set.
  110004. *
  110005. * Configuration options for the series are given in three levels:
  110006. *
  110007. * 1. Options for all series in a chart are defined in the plotOptions.series
  110008. * object.
  110009. *
  110010. * 2. Options for all `sankey` series are defined in plotOptions.sankey.
  110011. *
  110012. * 3. Options for one single series are given in the series instance array. (see
  110013. * online documentation for example)
  110014. *
  110015. * You have to extend the `SeriesSankeyOptions` via an interface to allow custom
  110016. * properties: ``` declare interface SeriesSankeyOptions { customProperty:
  110017. * string; }
  110018. *
  110019. */
  110020. export interface SeriesSankeyOptions extends PlotSankeyOptions, SeriesOptions {
  110021. /**
  110022. * Not available
  110023. */
  110024. borderRadius?: undefined;
  110025. /**
  110026. * (Highcharts) An array of data points for the series. For the `sankey`
  110027. * series type, points can be given in the following way:
  110028. *
  110029. * An array of objects with named values. The following snippet shows only a
  110030. * few settings, see the complete options set below. If the total number of
  110031. * data points exceeds the series' turboThreshold, this option is not
  110032. * available. (see online documentation for example)
  110033. */
  110034. data?: Array<SeriesSankeyPointOptionsObject>;
  110035. /**
  110036. * Not available
  110037. */
  110038. dataParser?: undefined;
  110039. /**
  110040. * Not available
  110041. */
  110042. dataURL?: undefined;
  110043. /**
  110044. * Not available
  110045. */
  110046. depth?: undefined;
  110047. /**
  110048. * Not available
  110049. */
  110050. edgeColor?: undefined;
  110051. /**
  110052. * Not available
  110053. */
  110054. edgeWidth?: undefined;
  110055. /**
  110056. * Not available
  110057. */
  110058. grouping?: undefined;
  110059. /**
  110060. * Not available
  110061. */
  110062. groupPadding?: undefined;
  110063. /**
  110064. * Not available
  110065. */
  110066. groupZPadding?: undefined;
  110067. /**
  110068. * Not available
  110069. */
  110070. maxPointWidth?: undefined;
  110071. /**
  110072. * (Highcharts) A collection of options for the individual nodes. The nodes
  110073. * in a sankey diagram are auto-generated instances of `Highcharts.Point`,
  110074. * but options can be applied here and linked by the `id`.
  110075. */
  110076. nodes?: Array<SeriesSankeyNodesOptionsObject>;
  110077. /**
  110078. * Not available
  110079. */
  110080. pointPadding?: undefined;
  110081. /**
  110082. * Not available
  110083. */
  110084. pointWidth?: undefined;
  110085. /**
  110086. * (Highcharts, Highstock, Highmaps, Gantt) This property is only in
  110087. * TypeScript non-optional and might be `undefined` in series objects from
  110088. * unknown sources.
  110089. */
  110090. type: "sankey";
  110091. }
  110092. /**
  110093. * (Highcharts) An array of data points for the series. For the `sankey` series
  110094. * type, points can be given in the following way:
  110095. *
  110096. * An array of objects with named values. The following snippet shows only a few
  110097. * settings, see the complete options set below. If the total number of data
  110098. * points exceeds the series' turboThreshold, this option is not available. (see
  110099. * online documentation for example)
  110100. */
  110101. export interface SeriesSankeyPointOptionsObject {
  110102. /**
  110103. * (Highcharts) Accessibility options for a data point.
  110104. */
  110105. accessibility?: PointAccessibilityOptionsObject;
  110106. /**
  110107. * (Highcharts, Gantt) An additional, individual class name for the data
  110108. * point's graphic representation.
  110109. */
  110110. className?: string;
  110111. /**
  110112. * (Highcharts) The color for the individual _link_. By default, the link
  110113. * color is the same as the node it extends from. The `series.fillOpacity`
  110114. * option also applies to the points, so when setting a specific link color,
  110115. * consider setting the `fillOpacity` to 1.
  110116. */
  110117. color?: (ColorString|GradientColorObject|PatternObject);
  110118. /**
  110119. * (Highcharts, Gantt) A specific color index to use for the point, so its
  110120. * graphic representations are given the class name `highcharts-color-{n}`.
  110121. * In styled mode this will change the color of the graphic. In non-styled
  110122. * mode, the color by is set by the `fill` attribute, so the change in class
  110123. * name won't have a visual effect by default.
  110124. */
  110125. colorIndex?: number;
  110126. /**
  110127. * (Highcharts) A reserved subspace to store options and values for
  110128. * customized functionality. Here you can add additional data for your own
  110129. * event callbacks and formatter callbacks.
  110130. */
  110131. custom?: Dictionary<any>;
  110132. /**
  110133. * (Highcharts) Individual data label for each point. The options are the
  110134. * same as the ones for plotOptions.series.dataLabels.
  110135. */
  110136. dataLabels?: (DataLabelsOptions|SeriesOrganizationDataLabelsOptionsObject|SeriesSankeyDataLabelsOptionsObject|Array<SeriesOrganizationDataLabelsOptionsObject>|
  110137. Array<SeriesSankeyDataLabelsOptionsObject>);
  110138. /**
  110139. * (Highcharts) A description of the point to add to the screen reader
  110140. * information about the point.
  110141. */
  110142. description?: string;
  110143. /**
  110144. * (Highcharts, Highstock, Gantt) The individual point events.
  110145. */
  110146. events?: PointEventsOptionsObject;
  110147. /**
  110148. * (Highcharts) The node that the link runs from.
  110149. */
  110150. from?: string;
  110151. /**
  110152. * (Highcharts, Highstock, Gantt) An id for the point. This can be used
  110153. * after render time to get a pointer to the point object through
  110154. * `chart.get()`.
  110155. */
  110156. id?: string;
  110157. /**
  110158. * (Highcharts) The rank for this point's data label in case of collision.
  110159. * If two data labels are about to overlap, only the one with the highest
  110160. * `labelrank` will be drawn.
  110161. */
  110162. labelrank?: number;
  110163. /**
  110164. * (Highcharts) The name of the point as shown in the legend, tooltip,
  110165. * dataLabels, etc.
  110166. */
  110167. name?: string;
  110168. /**
  110169. * (Highcharts) Whether the link goes out of the system.
  110170. */
  110171. outgoing?: boolean;
  110172. /**
  110173. * (Highcharts, Highstock, Gantt) Whether the data point is selected
  110174. * initially.
  110175. */
  110176. selected?: boolean;
  110177. /**
  110178. * (Highcharts) The node that the link runs to.
  110179. */
  110180. to?: string;
  110181. /**
  110182. * (Highcharts) The weight of the link.
  110183. */
  110184. weight?: (number|null);
  110185. }
  110186. /**
  110187. * (Highcharts, Highstock, Gantt) Enable or disable the initial animation when a
  110188. * series is displayed for the `dataLabels`. The animation can also be set as a
  110189. * configuration object. Please note that this option only applies to the
  110190. * initial animation. For other animations, see chart.animation and the
  110191. * animation parameter under the API methods. The following properties are
  110192. * supported:
  110193. *
  110194. * - `defer`: The animation delay time in milliseconds.
  110195. */
  110196. export interface SeriesScatter3dDataDataLabelsAnimationOptions {
  110197. /**
  110198. * (Highcharts, Highstock, Gantt) The animation delay time in milliseconds.
  110199. * Set to `0` renders dataLabel immediately. As `undefined` inherits defer
  110200. * time from the series.animation.defer.
  110201. */
  110202. defer?: number;
  110203. }
  110204. /**
  110205. * (Highcharts) Style options for the guide box. The guide box has one state by
  110206. * default, the `default` state.
  110207. */
  110208. export interface SeriesScatter3dDataDragDropGuideBoxOptions {
  110209. /**
  110210. * (Highcharts) Style options for the guide box default state.
  110211. */
  110212. default?: DragDropGuideBoxOptionsObject;
  110213. }
  110214. /**
  110215. * (Highcharts) A `scatter3d` series. If the type option is not specified, it is
  110216. * inherited from chart.type.
  110217. *
  110218. * scatter3d](#plotOptions.scatter3d).
  110219. *
  110220. * In TypeScript the type option must always be set.
  110221. *
  110222. * Configuration options for the series are given in three levels:
  110223. *
  110224. * 1. Options for all series in a chart are defined in the plotOptions.series
  110225. * object.
  110226. *
  110227. * 2. Options for all `scatter3d` series are defined in plotOptions.scatter3d.
  110228. *
  110229. * 3. Options for one single series are given in the series instance array. (see
  110230. * online documentation for example)
  110231. *
  110232. * You have to extend the `SeriesScatter3dOptions` via an interface to allow
  110233. * custom properties: ``` declare interface SeriesScatter3dOptions {
  110234. * customProperty: string; }
  110235. *
  110236. */
  110237. export interface SeriesScatter3dOptions extends PlotScatter3dOptions, SeriesOptions {
  110238. /**
  110239. * (Highcharts) An array of data points for the series. For the `scatter3d`
  110240. * series type, points can be given in the following ways:
  110241. *
  110242. * 1. An array of arrays with 3 values. In this case, the values correspond
  110243. * to `x,y,z`. If the first value is a string, it is applied as the name of
  110244. * the point, and the `x` value is inferred. (see online documentation for
  110245. * example)
  110246. *
  110247. * 3. An array of objects with named values. The following snippet shows
  110248. * only a few settings, see the complete options set below. If the total
  110249. * number of data points exceeds the series' turboThreshold, this option is
  110250. * not available. (see online documentation for example)
  110251. */
  110252. data?: Array<(Array<number>|PointOptionsObject)>;
  110253. /**
  110254. * (Highcharts, Highstock, Highmaps, Gantt) This property is only in
  110255. * TypeScript non-optional and might be `undefined` in series objects from
  110256. * unknown sources.
  110257. */
  110258. type: "scatter3d";
  110259. }
  110260. /**
  110261. * (Highcharts, Highstock, Gantt) Enable or disable the initial animation when a
  110262. * series is displayed for the `dataLabels`. The animation can also be set as a
  110263. * configuration object. Please note that this option only applies to the
  110264. * initial animation. For other animations, see chart.animation and the
  110265. * animation parameter under the API methods. The following properties are
  110266. * supported:
  110267. *
  110268. * - `defer`: The animation delay time in milliseconds.
  110269. */
  110270. export interface SeriesScatterDataDataLabelsAnimationOptions {
  110271. /**
  110272. * (Highcharts, Highstock, Gantt) The animation delay time in milliseconds.
  110273. * Set to `0` renders dataLabel immediately. As `undefined` inherits defer
  110274. * time from the series.animation.defer.
  110275. */
  110276. defer?: number;
  110277. }
  110278. /**
  110279. * (Highcharts, Highstock) Style options for the guide box. The guide box has
  110280. * one state by default, the `default` state.
  110281. */
  110282. export interface SeriesScatterDataDragDropGuideBoxOptions {
  110283. /**
  110284. * (Highcharts, Highstock) Style options for the guide box default state.
  110285. */
  110286. default?: DragDropGuideBoxOptionsObject;
  110287. }
  110288. /**
  110289. * (Highcharts, Highstock) A `scatter` series. If the type option is not
  110290. * specified, it is inherited from chart.type.
  110291. *
  110292. * In TypeScript the type option must always be set.
  110293. *
  110294. * Configuration options for the series are given in three levels:
  110295. *
  110296. * 1. Options for all series in a chart are defined in the plotOptions.series
  110297. * object.
  110298. *
  110299. * 2. Options for all `scatter` series are defined in plotOptions.scatter.
  110300. *
  110301. * 3. Options for one single series are given in the series instance array. (see
  110302. * online documentation for example)
  110303. *
  110304. * You have to extend the `SeriesScatterOptions` via an interface to allow
  110305. * custom properties: ``` declare interface SeriesScatterOptions {
  110306. * customProperty: string; }
  110307. *
  110308. */
  110309. export interface SeriesScatterOptions extends PlotScatterOptions, SeriesOptions {
  110310. /**
  110311. * (Highcharts, Highstock) An array of data points for the series. For the
  110312. * `scatter` series type, points can be given in the following ways:
  110313. *
  110314. * 1. An array of numerical values. In this case, the numerical values will
  110315. * be interpreted as `y` options. The `x` values will be automatically
  110316. * calculated, either starting at 0 and incremented by 1, or from
  110317. * `pointStart` and `pointInterval` given in the series options. If the axis
  110318. * has categories, these will be used. Example: (see online documentation
  110319. * for example)
  110320. *
  110321. * 2. An array of arrays with 2 values. In this case, the values correspond
  110322. * to `x,y`. If the first value is a string, it is applied as the name of
  110323. * the point, and the `x` value is inferred. (see online documentation for
  110324. * example)
  110325. *
  110326. * 3. An array of objects with named values. The following snippet shows
  110327. * only a few settings, see the complete options set below. If the total
  110328. * number of data points exceeds the series' turboThreshold, this option is
  110329. * not available. (see online documentation for example)
  110330. */
  110331. data?: Array<(number|[(number|string), (number|null)]|null|PointOptionsObject)>;
  110332. /**
  110333. * Not available
  110334. */
  110335. dataParser?: undefined;
  110336. /**
  110337. * Not available
  110338. */
  110339. dataURL?: undefined;
  110340. /**
  110341. * (Highcharts, Highstock, Highmaps, Gantt) This property is only in
  110342. * TypeScript non-optional and might be `undefined` in series objects from
  110343. * unknown sources.
  110344. */
  110345. type: "scatter";
  110346. /**
  110347. * Not available
  110348. */
  110349. useOhlcData?: undefined;
  110350. }
  110351. /**
  110352. * (Highstock) A Slow Stochastic indicator. If the type option is not specified,
  110353. * it is inherited from chart.type.
  110354. *
  110355. * In TypeScript the type option must always be set.
  110356. *
  110357. * Configuration options for the series are given in three levels:
  110358. *
  110359. * 1. Options for all series in a chart are defined in the plotOptions.series
  110360. * object.
  110361. *
  110362. * 2. Options for all `slowstochastic` series are defined in
  110363. * plotOptions.slowstochastic.
  110364. *
  110365. * 3. Options for one single series are given in the series instance array. (see
  110366. * online documentation for example)
  110367. *
  110368. * You have to extend the `SeriesSlowstochasticOptions` via an interface to
  110369. * allow custom properties: ``` declare interface SeriesSlowstochasticOptions {
  110370. * customProperty: string; }
  110371. *
  110372. */
  110373. export interface SeriesSlowstochasticOptions extends PlotSlowstochasticOptions, SeriesOptions {
  110374. /**
  110375. * (Highcharts, Highstock, Highmaps, Gantt) This property is only in
  110376. * TypeScript non-optional and might be `undefined` in series objects from
  110377. * unknown sources.
  110378. */
  110379. type: "slowstochastic";
  110380. }
  110381. /**
  110382. * (Highstock) A `SMA` series. If the type option is not specified, it is
  110383. * inherited from chart.type.
  110384. *
  110385. * In TypeScript the type option must always be set.
  110386. *
  110387. * Configuration options for the series are given in three levels:
  110388. *
  110389. * 1. Options for all series in a chart are defined in the plotOptions.series
  110390. * object.
  110391. *
  110392. * 2. Options for all `sma` series are defined in plotOptions.sma.
  110393. *
  110394. * 3. Options for one single series are given in the series instance array. (see
  110395. * online documentation for example)
  110396. *
  110397. * You have to extend the `SeriesSmaOptions` via an interface to allow custom
  110398. * properties: ``` declare interface SeriesSmaOptions { customProperty: string;
  110399. * }
  110400. *
  110401. */
  110402. export interface SeriesSmaOptions extends PlotSmaOptions, SeriesOptions {
  110403. /**
  110404. * Not available
  110405. */
  110406. dataParser?: undefined;
  110407. /**
  110408. * Not available
  110409. */
  110410. dataURL?: undefined;
  110411. /**
  110412. * (Highcharts, Highstock, Highmaps, Gantt) This property is only in
  110413. * TypeScript non-optional and might be `undefined` in series objects from
  110414. * unknown sources.
  110415. */
  110416. type: "sma";
  110417. /**
  110418. * Not available
  110419. */
  110420. useOhlcData?: undefined;
  110421. }
  110422. /**
  110423. * (Highcharts, Highstock, Gantt) Enable or disable the initial animation when a
  110424. * series is displayed for the `dataLabels`. The animation can also be set as a
  110425. * configuration object. Please note that this option only applies to the
  110426. * initial animation. For other animations, see chart.animation and the
  110427. * animation parameter under the API methods. The following properties are
  110428. * supported:
  110429. *
  110430. * - `defer`: The animation delay time in milliseconds.
  110431. */
  110432. export interface SeriesSolidgaugeDataDataLabelsAnimationOptions {
  110433. /**
  110434. * (Highcharts, Highstock, Gantt) The animation delay time in milliseconds.
  110435. * Set to `0` renders dataLabel immediately. As `undefined` inherits defer
  110436. * time from the series.animation.defer.
  110437. */
  110438. defer?: number;
  110439. }
  110440. /**
  110441. * (Highcharts) Style options for the guide box. The guide box has one state by
  110442. * default, the `default` state.
  110443. */
  110444. export interface SeriesSolidgaugeDataDragDropGuideBoxOptions {
  110445. /**
  110446. * (Highcharts) Style options for the guide box default state.
  110447. */
  110448. default?: DragDropGuideBoxOptionsObject;
  110449. }
  110450. /**
  110451. * (Highcharts) A `solidgauge` series. If the type option is not specified, it
  110452. * is inherited from chart.type.
  110453. *
  110454. * In TypeScript the type option must always be set.
  110455. *
  110456. * Configuration options for the series are given in three levels:
  110457. *
  110458. * 1. Options for all series in a chart are defined in the plotOptions.series
  110459. * object.
  110460. *
  110461. * 2. Options for all `solidgauge` series are defined in plotOptions.solidgauge.
  110462. *
  110463. * 3. Options for one single series are given in the series instance array. (see
  110464. * online documentation for example)
  110465. *
  110466. * You have to extend the `SeriesSolidgaugeOptions` via an interface to allow
  110467. * custom properties: ``` declare interface SeriesSolidgaugeOptions {
  110468. * customProperty: string; }
  110469. *
  110470. */
  110471. export interface SeriesSolidgaugeOptions extends PlotSolidgaugeOptions, SeriesOptions {
  110472. /**
  110473. * (Highcharts) An array of data points for the series. For the `solidgauge`
  110474. * series type, points can be given in the following ways:
  110475. *
  110476. * 1. An array of numerical values. In this case, the numerical values will
  110477. * be interpreted as `y` options. Example: (see online documentation for
  110478. * example)
  110479. *
  110480. * 2. An array of objects with named values. The following snippet shows
  110481. * only a few settings, see the complete options set below. If the total
  110482. * number of data points exceeds the series' turboThreshold, this option is
  110483. * not available. (see online documentation for example)
  110484. *
  110485. * The typical gauge only contains a single data value.
  110486. */
  110487. data?: Array<(number|null|PointOptionsObject)>;
  110488. /**
  110489. * Not available
  110490. */
  110491. dataParser?: undefined;
  110492. /**
  110493. * Not available
  110494. */
  110495. dataURL?: undefined;
  110496. /**
  110497. * Not available
  110498. */
  110499. dial?: undefined;
  110500. /**
  110501. * Not available
  110502. */
  110503. pivot?: undefined;
  110504. /**
  110505. * Not available
  110506. */
  110507. stack?: undefined;
  110508. /**
  110509. * (Highcharts, Highstock, Highmaps, Gantt) This property is only in
  110510. * TypeScript non-optional and might be `undefined` in series objects from
  110511. * unknown sources.
  110512. */
  110513. type: "solidgauge";
  110514. /**
  110515. * Not available
  110516. */
  110517. wrap?: undefined;
  110518. }
  110519. /**
  110520. * (Highcharts, Highstock, Gantt) Enable or disable the initial animation when a
  110521. * series is displayed for the `dataLabels`. The animation can also be set as a
  110522. * configuration object. Please note that this option only applies to the
  110523. * initial animation. For other animations, see chart.animation and the
  110524. * animation parameter under the API methods. The following properties are
  110525. * supported:
  110526. *
  110527. * - `defer`: The animation delay time in milliseconds.
  110528. */
  110529. export interface SeriesSplineDataDataLabelsAnimationOptions {
  110530. /**
  110531. * (Highcharts, Highstock, Gantt) The animation delay time in milliseconds.
  110532. * Set to `0` renders dataLabel immediately. As `undefined` inherits defer
  110533. * time from the series.animation.defer.
  110534. */
  110535. defer?: number;
  110536. }
  110537. /**
  110538. * (Highcharts, Highstock) Style options for the guide box. The guide box has
  110539. * one state by default, the `default` state.
  110540. */
  110541. export interface SeriesSplineDataDragDropGuideBoxOptions {
  110542. /**
  110543. * (Highcharts, Highstock) Style options for the guide box default state.
  110544. */
  110545. default?: DragDropGuideBoxOptionsObject;
  110546. }
  110547. /**
  110548. * (Highcharts, Highstock) A `spline` series. If the type option is not
  110549. * specified, it is inherited from chart.type.
  110550. *
  110551. * In TypeScript the type option must always be set.
  110552. *
  110553. * Configuration options for the series are given in three levels:
  110554. *
  110555. * 1. Options for all series in a chart are defined in the plotOptions.series
  110556. * object.
  110557. *
  110558. * 2. Options for all `spline` series are defined in plotOptions.spline.
  110559. *
  110560. * 3. Options for one single series are given in the series instance array. (see
  110561. * online documentation for example)
  110562. *
  110563. * You have to extend the `SeriesSplineOptions` via an interface to allow custom
  110564. * properties: ``` declare interface SeriesSplineOptions { customProperty:
  110565. * string; }
  110566. *
  110567. */
  110568. export interface SeriesSplineOptions extends PlotSplineOptions, SeriesOptions {
  110569. /**
  110570. * (Highcharts, Highstock) An array of data points for the series. For the
  110571. * `spline` series type, points can be given in the following ways:
  110572. *
  110573. * 1. An array of numerical values. In this case, the numerical values will
  110574. * be interpreted as `y` options. The `x` values will be automatically
  110575. * calculated, either starting at 0 and incremented by 1, or from
  110576. * `pointStart` and `pointInterval` given in the series options. If the axis
  110577. * has categories, these will be used. Example: (see online documentation
  110578. * for example)
  110579. *
  110580. * 2. An array of arrays with 2 values. In this case, the values correspond
  110581. * to `x,y`. If the first value is a string, it is applied as the name of
  110582. * the point, and the `x` value is inferred. (see online documentation for
  110583. * example)
  110584. *
  110585. * 3. An array of objects with named values. The following snippet shows
  110586. * only a few settings, see the complete options set below. If the total
  110587. * number of data points exceeds the series' turboThreshold, this option is
  110588. * not available. (see online documentation for example)
  110589. */
  110590. data?: Array<(number|[(number|string), (number|null)]|null|PointOptionsObject)>;
  110591. /**
  110592. * Not available
  110593. */
  110594. dataParser?: undefined;
  110595. /**
  110596. * Not available
  110597. */
  110598. dataURL?: undefined;
  110599. /**
  110600. * (Highcharts, Highstock, Highmaps, Gantt) This property is only in
  110601. * TypeScript non-optional and might be `undefined` in series objects from
  110602. * unknown sources.
  110603. */
  110604. type: "spline";
  110605. }
  110606. /**
  110607. * (Highcharts, Highstock) Options for the halo appearing around the hovered
  110608. * point in line-type series as well as outside the hovered slice in pie charts.
  110609. * By default the halo is filled by the current point or series color with an
  110610. * opacity of 0.25\. The halo can be disabled by setting the `halo` option to
  110611. * `null`.
  110612. *
  110613. * In styled mode, the halo is styled with the `.highcharts-halo` class, with
  110614. * colors inherited from `.highcharts-color-{n}`.
  110615. */
  110616. export interface SeriesStatesHoverHaloOptionsObject {
  110617. /**
  110618. * (Highcharts, Highstock) A collection of SVG attributes to override the
  110619. * appearance of the halo, for example `fill`, `stroke` and `stroke-width`.
  110620. */
  110621. attributes?: (PlotTilemapStatesHoverHaloAttributesOptions|SVGAttributes);
  110622. enabled?: boolean;
  110623. /**
  110624. * (Highcharts, Highstock) Opacity for the halo unless a specific fill is
  110625. * overridden using the `attributes` setting. Note that Highcharts is only
  110626. * able to apply opacity to colors of hex or rgb(a) formats.
  110627. */
  110628. opacity?: number;
  110629. /**
  110630. * (Highcharts, Highstock) The pixel size of the halo. For point markers
  110631. * this is the radius of the halo. For pie slices it is the width of the
  110632. * halo outside the slice. For bubbles it defaults to 5 and is the width of
  110633. * the halo outside the bubble.
  110634. */
  110635. size?: number;
  110636. }
  110637. /**
  110638. * (Highstock) Options for the hovered series. These settings override the
  110639. * normal state options when a series is moused over or touched.
  110640. */
  110641. export interface SeriesStatesHoverOptionsObject {
  110642. /**
  110643. * (Highcharts, Highstock) Animation setting for hovering the graph in
  110644. * line-type series.
  110645. */
  110646. animation?: (boolean|Partial<AnimationOptionsObject>);
  110647. /**
  110648. * (Highmaps) The border color of the point in this state.
  110649. */
  110650. borderColor?: (string|ColorString|GradientColorObject|PatternObject);
  110651. /**
  110652. * (Highmaps) The border width of the point in this state
  110653. */
  110654. borderWidth?: number;
  110655. /**
  110656. * (Highmaps) The relative brightness of the point when hovered, relative to
  110657. * the normal point color.
  110658. */
  110659. brightness?: number;
  110660. /**
  110661. * (Highmaps) The color of the shape in this state.
  110662. */
  110663. color?: (ColorString|GradientColorObject|PatternObject);
  110664. /**
  110665. * (Highstock) Enable separate styles for the hovered series to visualize
  110666. * that the user hovers either the series itself or the legend.
  110667. */
  110668. enabled?: boolean;
  110669. /**
  110670. * (Highstock) The fill or background color of the flag.
  110671. */
  110672. fillColor?: (ColorString|GradientColorObject|PatternObject);
  110673. /**
  110674. * (Highcharts, Highstock) Options for the halo appearing around the hovered
  110675. * point in line-type series as well as outside the hovered slice in pie
  110676. * charts. By default the halo is filled by the current point or series
  110677. * color with an opacity of 0.25\. The halo can be disabled by setting the
  110678. * `halo` option to `null`.
  110679. *
  110680. * In styled mode, the halo is styled with the `.highcharts-halo` class,
  110681. * with colors inherited from `.highcharts-color-{n}`.
  110682. */
  110683. halo?: (SeriesStatesHoverHaloOptionsObject|null);
  110684. /**
  110685. * (Highstock) The color of the line/border of the flag.
  110686. */
  110687. lineColor?: (ColorString|GradientColorObject|PatternObject);
  110688. /**
  110689. * (Highcharts, Highstock) Pixel width of the graph line. By default this
  110690. * property is undefined, and the `lineWidthPlus` property dictates how much
  110691. * to increase the linewidth from normal state.
  110692. */
  110693. lineWidth?: number;
  110694. /**
  110695. * (Highcharts, Highstock) The additional line width for the graph of a
  110696. * hovered series.
  110697. */
  110698. lineWidthPlus?: number;
  110699. /**
  110700. * (Highcharts, Highstock, Gantt) Opacity for the links between nodes in the
  110701. * sankey diagram in hover mode.
  110702. */
  110703. linkOpacity?: number;
  110704. /**
  110705. * (Highcharts) The opacity of a point in treemap. When a point has
  110706. * children, the visibility of the children is determined by the opacity.
  110707. */
  110708. opacity?: number;
  110709. /**
  110710. * (Highcharts) The shadow option for hovered state.
  110711. */
  110712. shadow?: boolean;
  110713. }
  110714. /**
  110715. * (Highstock) The opposite state of a hover for series.
  110716. */
  110717. export interface SeriesStatesInactiveOptionsObject {
  110718. /**
  110719. * (Highstock) Animation when not hovering over the marker.
  110720. */
  110721. animation?: (boolean|Partial<AnimationOptionsObject>);
  110722. /**
  110723. * (Highstock) Enable or disable the inactive state for a series
  110724. */
  110725. enabled?: boolean;
  110726. /**
  110727. * (Highcharts) Opacity for the links between nodes in the sankey diagram in
  110728. * inactive mode.
  110729. */
  110730. linkOpacity?: number;
  110731. /**
  110732. * (Highstock) Opacity of inactive markers.
  110733. */
  110734. opacity?: number;
  110735. }
  110736. /**
  110737. * (Highstock) The normal state of a series, or for point items in column, pie
  110738. * and similar series. Currently only used for setting animation when returning
  110739. * to normal state from hover.
  110740. */
  110741. export interface SeriesStatesNormalOptionsObject {
  110742. /**
  110743. * (Highstock) Animation when returning to normal state after hovering.
  110744. */
  110745. animation?: (boolean|Partial<AnimationOptionsObject>);
  110746. }
  110747. /**
  110748. * (Highcharts) A wrapper object for all the series options in specific states.
  110749. */
  110750. export interface SeriesStatesOptionsObject {
  110751. /**
  110752. * (Highstock) Options for the hovered series. These settings override the
  110753. * normal state options when a series is moused over or touched.
  110754. */
  110755. hover?: SeriesStatesHoverOptionsObject;
  110756. /**
  110757. * (Highstock) The opposite state of a hover for series.
  110758. */
  110759. inactive?: SeriesStatesInactiveOptionsObject;
  110760. /**
  110761. * (Highstock) The normal state of a series, or for point items in column,
  110762. * pie and similar series. Currently only used for setting animation when
  110763. * returning to normal state from hover.
  110764. */
  110765. normal?: SeriesStatesNormalOptionsObject;
  110766. /**
  110767. * (Highstock) Specific options for point in selected states, after being
  110768. * selected by allowPointSelect or programmatically.
  110769. */
  110770. select?: SeriesStatesSelectOptionsObject;
  110771. }
  110772. /**
  110773. * (Highstock) Specific options for point in selected states, after being
  110774. * selected by allowPointSelect or programmatically.
  110775. */
  110776. export interface SeriesStatesSelectOptionsObject {
  110777. /**
  110778. * (Highcharts, Highstock) Animation setting for hovering the graph in
  110779. * line-type series.
  110780. */
  110781. animation?: (boolean|Partial<AnimationOptionsObject>);
  110782. /**
  110783. * (Highmaps) The border color of the point in this state.
  110784. */
  110785. borderColor?: (string|ColorString|GradientColorObject|PatternObject);
  110786. /**
  110787. * (Highmaps) The border width of the point in this state
  110788. */
  110789. borderWidth?: number;
  110790. /**
  110791. * (Highmaps) The color of the shape in this state.
  110792. */
  110793. color?: (string|ColorString|GradientColorObject|PatternObject);
  110794. /**
  110795. * (Highstock) Enable separate styles for the hovered series to visualize
  110796. * that the user hovers either the series itself or the legend.
  110797. */
  110798. enabled?: boolean;
  110799. /**
  110800. * (Highcharts, Highstock) Options for the halo appearing around the hovered
  110801. * point in line-type series as well as outside the hovered slice in pie
  110802. * charts. By default the halo is filled by the current point or series
  110803. * color with an opacity of 0.25\. The halo can be disabled by setting the
  110804. * `halo` option to `null`.
  110805. *
  110806. * In styled mode, the halo is styled with the `.highcharts-halo` class,
  110807. * with colors inherited from `.highcharts-color-{n}`.
  110808. */
  110809. halo?: (SeriesStatesHoverHaloOptionsObject|null);
  110810. /**
  110811. * (Highcharts, Highstock) Pixel width of the graph line. By default this
  110812. * property is undefined, and the `lineWidthPlus` property dictates how much
  110813. * to increase the linewidth from normal state.
  110814. */
  110815. lineWidth?: number;
  110816. /**
  110817. * (Highcharts, Highstock) The additional line width for the graph of a
  110818. * hovered series.
  110819. */
  110820. lineWidthPlus?: number;
  110821. }
  110822. /**
  110823. * (Highstock) A Stochastic indicator. If the type option is not specified, it
  110824. * is inherited from chart.type.
  110825. *
  110826. * In TypeScript the type option must always be set.
  110827. *
  110828. * Configuration options for the series are given in three levels:
  110829. *
  110830. * 1. Options for all series in a chart are defined in the plotOptions.series
  110831. * object.
  110832. *
  110833. * 2. Options for all `stochastic` series are defined in plotOptions.stochastic.
  110834. *
  110835. * 3. Options for one single series are given in the series instance array. (see
  110836. * online documentation for example)
  110837. *
  110838. * You have to extend the `SeriesStochasticOptions` via an interface to allow
  110839. * custom properties: ``` declare interface SeriesStochasticOptions {
  110840. * customProperty: string; }
  110841. *
  110842. */
  110843. export interface SeriesStochasticOptions extends PlotStochasticOptions, SeriesOptions {
  110844. /**
  110845. * Not available
  110846. */
  110847. dataParser?: undefined;
  110848. /**
  110849. * Not available
  110850. */
  110851. dataURL?: undefined;
  110852. /**
  110853. * (Highcharts, Highstock, Highmaps, Gantt) This property is only in
  110854. * TypeScript non-optional and might be `undefined` in series objects from
  110855. * unknown sources.
  110856. */
  110857. type: "stochastic";
  110858. }
  110859. /**
  110860. * (Highcharts, Highstock, Gantt) Enable or disable the initial animation when a
  110861. * series is displayed for the `dataLabels`. The animation can also be set as a
  110862. * configuration object. Please note that this option only applies to the
  110863. * initial animation. For other animations, see chart.animation and the
  110864. * animation parameter under the API methods. The following properties are
  110865. * supported:
  110866. *
  110867. * - `defer`: The animation delay time in milliseconds.
  110868. */
  110869. export interface SeriesStreamgraphDataDataLabelsAnimationOptions {
  110870. /**
  110871. * (Highcharts, Highstock, Gantt) The animation delay time in milliseconds.
  110872. * Set to `0` renders dataLabel immediately. As `undefined` inherits defer
  110873. * time from the series.animation.defer.
  110874. */
  110875. defer?: number;
  110876. }
  110877. /**
  110878. * (Highcharts, Highstock) Style options for the guide box. The guide box has
  110879. * one state by default, the `default` state.
  110880. */
  110881. export interface SeriesStreamgraphDataDragDropGuideBoxOptions {
  110882. /**
  110883. * (Highcharts, Highstock) Style options for the guide box default state.
  110884. */
  110885. default?: DragDropGuideBoxOptionsObject;
  110886. }
  110887. /**
  110888. * (Highcharts, Highstock) A `streamgraph` series. If the type option is not
  110889. * specified, it is inherited from chart.type.
  110890. *
  110891. * In TypeScript the type option must always be set.
  110892. *
  110893. * Configuration options for the series are given in three levels:
  110894. *
  110895. * 1. Options for all series in a chart are defined in the plotOptions.series
  110896. * object.
  110897. *
  110898. * 2. Options for all `streamgraph` series are defined in
  110899. * plotOptions.streamgraph.
  110900. *
  110901. * 3. Options for one single series are given in the series instance array. (see
  110902. * online documentation for example)
  110903. *
  110904. * You have to extend the `SeriesStreamgraphOptions` via an interface to allow
  110905. * custom properties: ``` declare interface SeriesStreamgraphOptions {
  110906. * customProperty: string; }
  110907. *
  110908. */
  110909. export interface SeriesStreamgraphOptions extends PlotStreamgraphOptions, SeriesOptions {
  110910. /**
  110911. * (Highcharts, Highstock) An array of data points for the series. For the
  110912. * `streamgraph` series type, points can be given in the following ways:
  110913. *
  110914. * 1. An array of numerical values. In this case, the numerical values will
  110915. * be interpreted as `y` options. The `x` values will be automatically
  110916. * calculated, either starting at 0 and incremented by 1, or from
  110917. * `pointStart` and `pointInterval` given in the series options. If the axis
  110918. * has categories, these will be used. Example: (see online documentation
  110919. * for example)
  110920. *
  110921. * 2. An array of arrays with 2 values. In this case, the values correspond
  110922. * to `x,y`. If the first value is a string, it is applied as the name of
  110923. * the point, and the `x` value is inferred. (see online documentation for
  110924. * example)
  110925. *
  110926. * 3. An array of objects with named values. The following snippet shows
  110927. * only a few settings, see the complete options set below. If the total
  110928. * number of data points exceeds the series' turboThreshold, this option is
  110929. * not available. (see online documentation for example)
  110930. */
  110931. data?: Array<(number|[(number|string), (number|null)]|null|PointOptionsObject)>;
  110932. /**
  110933. * Not available
  110934. */
  110935. dataParser?: undefined;
  110936. /**
  110937. * Not available
  110938. */
  110939. dataURL?: undefined;
  110940. /**
  110941. * (Highcharts, Highstock, Highmaps, Gantt) This property is only in
  110942. * TypeScript non-optional and might be `undefined` in series objects from
  110943. * unknown sources.
  110944. */
  110945. type: "streamgraph";
  110946. }
  110947. /**
  110948. * (Highcharts) Enable or disable the initial animation when a series is
  110949. * displayed for the `dataLabels`. The animation can also be set as a
  110950. * configuration object. Please note that this option only applies to the
  110951. * initial animation. For other animations, see chart.animation and the
  110952. * animation parameter under the API methods. The following properties are
  110953. * supported:
  110954. *
  110955. * - `defer`: The animation delay time in milliseconds.
  110956. */
  110957. export interface SeriesSunburstDataDataLabelsAnimationOptions {
  110958. /**
  110959. * (Highcharts) The animation delay time in milliseconds. Set to `0` renders
  110960. * dataLabel immediately. As `undefined` inherits defer time from the
  110961. * series.animation.defer.
  110962. */
  110963. defer?: number;
  110964. }
  110965. /**
  110966. * (Highcharts) Style options for the guide box. The guide box has one state by
  110967. * default, the `default` state.
  110968. */
  110969. export interface SeriesSunburstDataDragDropGuideBoxOptions {
  110970. /**
  110971. * (Highcharts) Style options for the guide box default state.
  110972. */
  110973. default?: DragDropGuideBoxOptionsObject;
  110974. }
  110975. /**
  110976. * (Highcharts, Highstock, Highmaps, Gantt) Can set `dataLabels` on all points
  110977. * which lies on the same level.
  110978. */
  110979. export interface SeriesSunburstDataLabelsOptionsObject {
  110980. /**
  110981. * (Highcharts) Alignment method for data labels. Possible values are:
  110982. *
  110983. * - `toPlotEdges`: Each label touches the nearest vertical edge of the plot
  110984. * area.
  110985. *
  110986. * - `connectors`: Connectors have the same x position and the widest label
  110987. * of each half (left & right) touches the nearest vertical edge of the plot
  110988. * area.
  110989. */
  110990. alignTo?: string;
  110991. allowOverlap?: boolean;
  110992. /**
  110993. * (Highcharts, Highstock, Highmaps, Gantt) Enable or disable the initial
  110994. * animation when a series is displayed for the `dataLabels`. The animation
  110995. * can also be set as a configuration object. Please note that this option
  110996. * only applies to the initial animation. For other animations, see
  110997. * chart.animation and the animation parameter under the API methods. The
  110998. * following properties are supported:
  110999. *
  111000. * - `defer`: The animation delay time in milliseconds.
  111001. */
  111002. animation?: (boolean|PlotSunburstDataLabelsAnimationOptions|PlotSunburstLevelsDataLabelsAnimationOptions|Partial<AnimationOptionsObject>);
  111003. /**
  111004. * (Highcharts, Highstock, Highmaps, Gantt) The background color or gradient
  111005. * for the data label.
  111006. */
  111007. backgroundColor?: (ColorString|GradientColorObject|PatternObject);
  111008. /**
  111009. * (Highcharts, Highstock, Highmaps, Gantt) The border color for the data
  111010. * label. Defaults to `undefined`.
  111011. */
  111012. borderColor?: (ColorString|GradientColorObject|PatternObject);
  111013. /**
  111014. * (Highcharts, Highstock, Highmaps, Gantt) The border radius in pixels for
  111015. * the data label.
  111016. */
  111017. borderRadius?: number;
  111018. /**
  111019. * (Highcharts, Highstock, Highmaps, Gantt) The border width in pixels for
  111020. * the data label.
  111021. */
  111022. borderWidth?: number;
  111023. /**
  111024. * (Highcharts, Highstock, Highmaps, Gantt) A class name for the data label.
  111025. * Particularly in styled mode, this can be used to give each series' or
  111026. * point's data label unique styling. In addition to this option, a default
  111027. * color class name is added so that we can give the labels a contrast text
  111028. * shadow.
  111029. */
  111030. className?: string;
  111031. /**
  111032. * (Highcharts, Highstock, Highmaps, Gantt) The text color for the data
  111033. * labels. Defaults to `undefined`. For certain series types, like column or
  111034. * map, the data labels can be drawn inside the points. In this case the
  111035. * data label will be drawn with maximum contrast by default. Additionally,
  111036. * it will be given a `text-outline` style with the opposite color, to
  111037. * further increase the contrast. This can be overridden by setting the
  111038. * `text-outline` style to `none` in the `dataLabels.style` option.
  111039. */
  111040. color?: (ColorString|GradientColorObject|PatternObject);
  111041. /**
  111042. * (Highcharts) The color of the line connecting the data label to the pie
  111043. * slice. The default color is the same as the point's color.
  111044. *
  111045. * In styled mode, the connector stroke is given in the
  111046. * `.highcharts-data-label-connector` class.
  111047. */
  111048. connectorColor?: (ColorString|GradientColorObject|PatternObject);
  111049. /**
  111050. * (Highcharts) The distance from the data label to the connector. Note that
  111051. * data labels also have a default `padding`, so in order for the connector
  111052. * to touch the text, the `padding` must also be 0.
  111053. */
  111054. connectorPadding?: number;
  111055. /**
  111056. * (Highcharts) Specifies the method that is used to generate the connector
  111057. * path. Highcharts provides 3 built-in connector shapes: `'fixedOffset'`
  111058. * (default), `'straight'` and `'crookedLine'`. Using `'crookedLine'` has
  111059. * the most sense (in most of the cases) when `'alignTo'` is set.
  111060. *
  111061. * Users can provide their own method by passing a function instead of a
  111062. * String. 3 arguments are passed to the callback:
  111063. *
  111064. * - Object that holds the information about the coordinates of the label
  111065. * (`x` & `y` properties) and how the label is located in relation to the
  111066. * pie (`alignment` property). `alignment` can by one of the following:
  111067. * `'left'` (pie on the left side of the data label), `'right'` (pie on the
  111068. * right side of the data label) or `'center'` (data label overlaps the
  111069. * pie).
  111070. *
  111071. * - Object that holds the information about the position of the connector.
  111072. * Its `touchingSliceAt` porperty tells the position of the place where the
  111073. * connector touches the slice.
  111074. *
  111075. * - Data label options
  111076. *
  111077. * The function has to return an SVG path definition in array form (see the
  111078. * example).
  111079. */
  111080. connectorShape?: (string|Function);
  111081. /**
  111082. * (Highcharts) The width of the line connecting the data label to the pie
  111083. * slice.
  111084. *
  111085. * In styled mode, the connector stroke width is given in the
  111086. * `.highcharts-data-label-connector` class.
  111087. */
  111088. connectorWidth?: number;
  111089. /**
  111090. * (Highcharts) Works only if `connectorShape` is `'crookedLine'`. It
  111091. * defines how far from the vertical plot edge the coonnector path should be
  111092. * crooked.
  111093. */
  111094. crookDistance?: string;
  111095. /**
  111096. * (Highcharts, Highstock, Highmaps, Gantt) Whether to hide data labels that
  111097. * are outside the plot area. By default, the data label is moved inside the
  111098. * plot area according to the overflow option.
  111099. */
  111100. crop?: boolean;
  111101. /**
  111102. * (Highcharts, Highstock, Gantt) Whether to defer displaying the data
  111103. * labels until the initial series animation has finished. Setting to
  111104. * `false` renders the data label immediately. If set to `true` inherits the
  111105. * defer time set in plotOptions.series.animation.
  111106. */
  111107. defer?: boolean;
  111108. /**
  111109. * (Highcharts) The distance of the data label from the pie's edge. Negative
  111110. * numbers put the data label on top of the pie slices. Can also be defined
  111111. * as a percentage of pie's radius. Connectors are only shown for data
  111112. * labels outside the pie.
  111113. */
  111114. distance?: (number|string);
  111115. /**
  111116. * (Highcharts, Highstock, Highmaps, Gantt) Enable or disable the data
  111117. * labels.
  111118. */
  111119. enabled?: boolean;
  111120. /**
  111121. * (Highcharts, Highstock, Highmaps, Gantt) A declarative filter to control
  111122. * of which data labels to display. The declarative filter is designed for
  111123. * use when callback functions are not available, like when the chart
  111124. * options require a pure JSON structure or for use with graphical editors.
  111125. * For programmatic control, use the `formatter` instead, and return
  111126. * `undefined` to disable a single data label.
  111127. */
  111128. filter?: DataLabelsFilterOptionsObject;
  111129. /**
  111130. * (Highcharts, Highstock, Highmaps, Gantt) A format string for the data
  111131. * label. Available variables are the same as for `formatter`.
  111132. */
  111133. format?: string;
  111134. /**
  111135. * (Highcharts, Highstock, Highmaps, Gantt) Callback JavaScript function to
  111136. * format the data label. Note that if a `format` is defined, the format
  111137. * takes precedence and the formatter is ignored.
  111138. */
  111139. formatter?: DataLabelsFormatterCallbackFunction;
  111140. /**
  111141. * (Highcharts, Highstock, Highmaps, Gantt) Format for points with the value
  111142. * of null. Works analogously to format. `nullFormat` can be applied only to
  111143. * series which support displaying null points.
  111144. */
  111145. nullFormat?: (boolean|string);
  111146. /**
  111147. * (Highcharts, Highstock, Highmaps, Gantt) Callback JavaScript function
  111148. * that defines formatting for points with the value of null. Works
  111149. * analogously to formatter. `nullPointFormatter` can be applied only to
  111150. * series which support displaying null points.
  111151. */
  111152. nullFormatter?: DataLabelsFormatterCallbackFunction;
  111153. /**
  111154. * (Highcharts, Highstock, Highmaps, Gantt) How to handle data labels that
  111155. * flow outside the plot area. The default is `"justify"`, which aligns them
  111156. * inside the plot area. For columns and bars, this means it will be moved
  111157. * inside the bar. To display data labels outside the plot area, set `crop`
  111158. * to `false` and `overflow` to `"allow"`.
  111159. */
  111160. overflow?: DataLabelsOverflowValue;
  111161. /**
  111162. * (Highcharts, Highstock, Highmaps, Gantt) When either the `borderWidth` or
  111163. * the `backgroundColor` is set, this is the padding within the box.
  111164. */
  111165. padding?: number;
  111166. /**
  111167. * (Highcharts, Highstock, Highmaps, Gantt) Aligns data labels relative to
  111168. * points. If `center` alignment is not possible, it defaults to `right`.
  111169. */
  111170. position?: AlignValue;
  111171. /**
  111172. * (Highcharts, Highstock, Highmaps, Gantt) Text rotation in degrees. Note
  111173. * that due to a more complex structure, backgrounds, borders and padding
  111174. * will be lost on a rotated data label.
  111175. */
  111176. rotation?: number;
  111177. /**
  111178. * (Highcharts, Highstock, Highmaps, Gantt) Decides how the data label will
  111179. * be rotated relative to the perimeter of the sunburst. Valid values are
  111180. * `auto`, `circular`, `parallel` and `perpendicular`. When `auto`, the best
  111181. * fit will be computed for the point. The `circular` option works similiar
  111182. * to `auto`, but uses the `textPath` feature - labels are curved, resulting
  111183. * in a better layout, however multiple lines and `textOutline` are not
  111184. * supported.
  111185. *
  111186. * The `series.rotation` option takes precedence over `rotationMode`.
  111187. */
  111188. rotationMode?: OptionsRotationModeValue;
  111189. /**
  111190. * (Highcharts, Highstock, Highmaps, Gantt) The shadow of the box. Works
  111191. * best with `borderWidth` or `backgroundColor`. Since 2.3 the shadow can be
  111192. * an object configuration containing `color`, `offsetX`, `offsetY`,
  111193. * `opacity` and `width`.
  111194. */
  111195. shadow?: (boolean|ShadowOptionsObject);
  111196. /**
  111197. * (Highcharts, Highstock, Highmaps, Gantt) The name of a symbol to use for
  111198. * the border around the label. Symbols are predefined functions on the
  111199. * Renderer object.
  111200. */
  111201. shape?: string;
  111202. /**
  111203. * (Highcharts) Whether to render the connector as a soft arc or a line with
  111204. * sharp break. Works only if `connectorShape` equals to `fixedOffset`.
  111205. */
  111206. softConnector?: boolean;
  111207. /**
  111208. * (Highcharts, Highstock, Highmaps, Gantt) Styles for the label. The
  111209. * default `color` setting is `"contrast"`, which is a pseudo color that
  111210. * Highcharts picks up and applies the maximum contrast to the underlying
  111211. * point item, for example the bar in a bar chart.
  111212. *
  111213. * The `textOutline` is a pseudo property that applies an outline of the
  111214. * given width with the given color, which by default is the maximum
  111215. * contrast to the text. So a bright text color will result in a black text
  111216. * outline for maximum readability on a mixed background. In some cases,
  111217. * especially with grayscale text, the text outline doesn't work well, in
  111218. * which cases it can be disabled by setting it to `"none"`. When `useHTML`
  111219. * is true, the `textOutline` will not be picked up. In this, case, the same
  111220. * effect can be acheived through the `text-shadow` CSS property.
  111221. *
  111222. * For some series types, where each point has an extent, like for example
  111223. * tree maps, the data label may overflow the point. There are two
  111224. * strategies for handling overflow. By default, the text will wrap to
  111225. * multiple lines. The other strategy is to set `style.textOverflow` to
  111226. * `ellipsis`, which will keep the text on one line plus it will break
  111227. * inside long words.
  111228. */
  111229. style?: CSSObject;
  111230. /**
  111231. * (Highcharts, Highstock, Highmaps, Gantt) Options for a label text which
  111232. * should follow marker's shape. Border and background are disabled for a
  111233. * label that follows a path.
  111234. *
  111235. * **Note:** Only SVG-based renderer supports this option. Setting `useHTML`
  111236. * to true will disable this option.
  111237. */
  111238. textPath?: DataLabelsTextPathOptionsObject;
  111239. /**
  111240. * (Highcharts, Highstock, Highmaps, Gantt) Whether to use HTML to render
  111241. * the labels.
  111242. */
  111243. useHTML?: boolean;
  111244. /**
  111245. * (Highcharts, Highstock, Highmaps, Gantt) The vertical alignment of a data
  111246. * label. Can be one of `top`, `middle` or `bottom`. The default value
  111247. * depends on the data, for instance in a column chart, the label is above
  111248. * positive values and below negative values.
  111249. */
  111250. verticalAlign?: (VerticalAlignValue|null);
  111251. /**
  111252. * (Highcharts, Highstock, Highmaps, Gantt) The x position offset of the
  111253. * label relative to the point in pixels.
  111254. */
  111255. x?: number;
  111256. /**
  111257. * (Highcharts, Highstock, Highmaps, Gantt) The y position offset of the
  111258. * label relative to the point in pixels.
  111259. */
  111260. y?: number;
  111261. /**
  111262. * (Highcharts, Highstock, Highmaps, Gantt) The Z index of the data labels.
  111263. * The default Z index puts it above the series. Use a Z index of 2 to
  111264. * display it behind the series.
  111265. */
  111266. z?: number;
  111267. }
  111268. /**
  111269. * (Highcharts) A `sunburst` series. If the type option is not specified, it is
  111270. * inherited from chart.type.
  111271. *
  111272. * In TypeScript the type option must always be set.
  111273. *
  111274. * Configuration options for the series are given in three levels:
  111275. *
  111276. * 1. Options for all series in a chart are defined in the plotOptions.series
  111277. * object.
  111278. *
  111279. * 2. Options for all `sunburst` series are defined in plotOptions.sunburst.
  111280. *
  111281. * 3. Options for one single series are given in the series instance array. (see
  111282. * online documentation for example)
  111283. *
  111284. * You have to extend the `SeriesSunburstOptions` via an interface to allow
  111285. * custom properties: ``` declare interface SeriesSunburstOptions {
  111286. * customProperty: string; }
  111287. *
  111288. */
  111289. export interface SeriesSunburstOptions extends PlotSunburstOptions, SeriesOptions {
  111290. /**
  111291. * (Highcharts) An array of data points for the series. For the `treemap`
  111292. * series type, points can be given in the following ways:
  111293. *
  111294. * 1. An array of numerical values. In this case, the numerical values will
  111295. * be interpreted as `value` options. Example: (see online documentation for
  111296. * example)
  111297. *
  111298. * 2. An array of objects with named values. The following snippet shows
  111299. * only a few settings, see the complete options set below. If the total
  111300. * number of data points exceeds the series' turboThreshold, this option is
  111301. * not available. (see online documentation for example)
  111302. */
  111303. data?: Array<(number|null|PointOptionsObject)>;
  111304. /**
  111305. * Not available
  111306. */
  111307. dataParser?: undefined;
  111308. /**
  111309. * Not available
  111310. */
  111311. dataURL?: undefined;
  111312. /**
  111313. * Not available
  111314. */
  111315. stack?: undefined;
  111316. /**
  111317. * (Highcharts, Highstock, Highmaps, Gantt) This property is only in
  111318. * TypeScript non-optional and might be `undefined` in series objects from
  111319. * unknown sources.
  111320. */
  111321. type: "sunburst";
  111322. }
  111323. /**
  111324. * (Highstock) A `Supertrend indicator` series. If the type option is not
  111325. * specified, it is inherited from chart.type.
  111326. *
  111327. * In TypeScript the type option must always be set.
  111328. *
  111329. * Configuration options for the series are given in three levels:
  111330. *
  111331. * 1. Options for all series in a chart are defined in the plotOptions.series
  111332. * object.
  111333. *
  111334. * 2. Options for all `supertrend` series are defined in plotOptions.supertrend.
  111335. *
  111336. * 3. Options for one single series are given in the series instance array. (see
  111337. * online documentation for example)
  111338. *
  111339. * You have to extend the `SeriesSupertrendOptions` via an interface to allow
  111340. * custom properties: ``` declare interface SeriesSupertrendOptions {
  111341. * customProperty: string; }
  111342. *
  111343. */
  111344. export interface SeriesSupertrendOptions extends PlotSupertrendOptions, SeriesOptions {
  111345. /**
  111346. * Not available
  111347. */
  111348. data?: undefined;
  111349. /**
  111350. * Not available
  111351. */
  111352. dataParser?: undefined;
  111353. /**
  111354. * Not available
  111355. */
  111356. dataURL?: undefined;
  111357. /**
  111358. * (Highcharts, Highstock, Highmaps, Gantt) This property is only in
  111359. * TypeScript non-optional and might be `undefined` in series objects from
  111360. * unknown sources.
  111361. */
  111362. type: "supertrend";
  111363. }
  111364. /**
  111365. * (Highstock) A `TEMA` series. If the type option is not specified, it is
  111366. * inherited from chart.type.
  111367. *
  111368. * In TypeScript the type option must always be set.
  111369. *
  111370. * Configuration options for the series are given in three levels:
  111371. *
  111372. * 1. Options for all series in a chart are defined in the plotOptions.series
  111373. * object.
  111374. *
  111375. * 2. Options for all `tema` series are defined in plotOptions.tema.
  111376. *
  111377. * 3. Options for one single series are given in the series instance array. (see
  111378. * online documentation for example)
  111379. *
  111380. * You have to extend the `SeriesTemaOptions` via an interface to allow custom
  111381. * properties: ``` declare interface SeriesTemaOptions { customProperty: string;
  111382. * }
  111383. *
  111384. */
  111385. export interface SeriesTemaOptions extends PlotTemaOptions, SeriesOptions {
  111386. /**
  111387. * Not available
  111388. */
  111389. dataParser?: undefined;
  111390. /**
  111391. * Not available
  111392. */
  111393. dataURL?: undefined;
  111394. /**
  111395. * (Highcharts, Highstock, Highmaps, Gantt) This property is only in
  111396. * TypeScript non-optional and might be `undefined` in series objects from
  111397. * unknown sources.
  111398. */
  111399. type: "tema";
  111400. }
  111401. /**
  111402. * (Highcharts, Highstock, Gantt) Enable or disable the initial animation when a
  111403. * series is displayed for the `dataLabels`. The animation can also be set as a
  111404. * configuration object. Please note that this option only applies to the
  111405. * initial animation. For other animations, see chart.animation and the
  111406. * animation parameter under the API methods. The following properties are
  111407. * supported:
  111408. *
  111409. * - `defer`: The animation delay time in milliseconds.
  111410. */
  111411. export interface SeriesTilemapDataDataLabelsAnimationOptions {
  111412. /**
  111413. * (Highcharts, Highstock, Gantt) The animation delay time in milliseconds.
  111414. * Set to `0` renders dataLabel immediately. As `undefined` inherits defer
  111415. * time from the series.animation.defer.
  111416. */
  111417. defer?: number;
  111418. }
  111419. /**
  111420. * (Highcharts, Highmaps) Style options for the guide box. The guide box has one
  111421. * state by default, the `default` state.
  111422. */
  111423. export interface SeriesTilemapDataDragDropGuideBoxOptions {
  111424. /**
  111425. * (Highcharts, Highmaps) Style options for the guide box default state.
  111426. */
  111427. default?: DragDropGuideBoxOptionsObject;
  111428. }
  111429. /**
  111430. * (Highcharts, Highmaps) A `tilemap` series. If the type option is not
  111431. * specified, it is inherited from chart.type.
  111432. *
  111433. * In TypeScript the type option must always be set.
  111434. *
  111435. * Configuration options for the series are given in three levels:
  111436. *
  111437. * 1. Options for all series in a chart are defined in the plotOptions.series
  111438. * object.
  111439. *
  111440. * 2. Options for all `tilemap` series are defined in plotOptions.tilemap.
  111441. *
  111442. * 3. Options for one single series are given in the series instance array. (see
  111443. * online documentation for example)
  111444. *
  111445. * You have to extend the `SeriesTilemapOptions` via an interface to allow
  111446. * custom properties: ``` declare interface SeriesTilemapOptions {
  111447. * customProperty: string; }
  111448. *
  111449. */
  111450. export interface SeriesTilemapOptions extends PlotTilemapOptions, SeriesOptions {
  111451. /**
  111452. * (Highcharts, Highmaps) An array of data points for the series. For the
  111453. * `tilemap` series type, points can be given in the following ways:
  111454. *
  111455. * 1. An array of arrays with 3 or 2 values. In this case, the values
  111456. * correspond to `x,y,value`. If the first value is a string, it is applied
  111457. * as the name of the point, and the `x` value is inferred. The `x` value
  111458. * can also be omitted, in which case the inner arrays should be of length
  111459. * 2\. Then the `x` value is automatically calculated, either starting at 0
  111460. * and incremented by 1, or from `pointStart` and `pointInterval` given in
  111461. * the series options. (see online documentation for example)
  111462. *
  111463. * 2. An array of objects with named values. The objects are point
  111464. * configuration objects as seen below. If the total number of data points
  111465. * exceeds the series' turboThreshold, this option is not available. (see
  111466. * online documentation for example)
  111467. *
  111468. * Note that for some tileShapes the grid coordinates are offset.
  111469. */
  111470. data?: Array<([(number|string), number]|[(number|string), number, number]|PointOptionsObject)>;
  111471. /**
  111472. * Not available
  111473. */
  111474. dataParser?: undefined;
  111475. /**
  111476. * Not available
  111477. */
  111478. dataURL?: undefined;
  111479. /**
  111480. * Not available
  111481. */
  111482. mapData?: undefined;
  111483. /**
  111484. * Not available
  111485. */
  111486. stack?: undefined;
  111487. /**
  111488. * (Highcharts, Highstock, Highmaps, Gantt) This property is only in
  111489. * TypeScript non-optional and might be `undefined` in series objects from
  111490. * unknown sources.
  111491. */
  111492. type: "tilemap";
  111493. }
  111494. /**
  111495. * (Highcharts, Highstock, Gantt) Enable or disable the initial animation when a
  111496. * series is displayed for the `dataLabels`. The animation can also be set as a
  111497. * configuration object. Please note that this option only applies to the
  111498. * initial animation. For other animations, see chart.animation and the
  111499. * animation parameter under the API methods. The following properties are
  111500. * supported:
  111501. *
  111502. * - `defer`: The animation delay time in milliseconds.
  111503. */
  111504. export interface SeriesTimelineDataDataLabelsAnimationOptions {
  111505. /**
  111506. * (Highcharts, Highstock, Gantt) The animation delay time in milliseconds.
  111507. * Set to `0` renders dataLabel immediately. As `undefined` inherits defer
  111508. * time from the series.animation.defer.
  111509. */
  111510. defer?: number;
  111511. }
  111512. /**
  111513. * (Highcharts) Style options for the guide box. The guide box has one state by
  111514. * default, the `default` state.
  111515. */
  111516. export interface SeriesTimelineDataDragDropGuideBoxOptions {
  111517. /**
  111518. * (Highcharts) Style options for the guide box default state.
  111519. */
  111520. default?: DragDropGuideBoxOptionsObject;
  111521. }
  111522. /**
  111523. * (Highcharts) The `timeline` series. If the type option is not specified, it
  111524. * is inherited from chart.type.
  111525. *
  111526. * In TypeScript the type option must always be set.
  111527. *
  111528. * Configuration options for the series are given in three levels:
  111529. *
  111530. * 1. Options for all series in a chart are defined in the plotOptions.series
  111531. * object.
  111532. *
  111533. * 2. Options for all `timeline` series are defined in plotOptions.timeline.
  111534. *
  111535. * 3. Options for one single series are given in the series instance array. (see
  111536. * online documentation for example)
  111537. *
  111538. * You have to extend the `SeriesTimelineOptions` via an interface to allow
  111539. * custom properties: ``` declare interface SeriesTimelineOptions {
  111540. * customProperty: string; }
  111541. *
  111542. */
  111543. export interface SeriesTimelineOptions extends PlotTimelineOptions, SeriesOptions {
  111544. /**
  111545. * (Highcharts) An array of data points for the series. For the `timeline`
  111546. * series type, points can be given with three general parameters, `name`,
  111547. * `label`, and `description`:
  111548. *
  111549. * Example: (see online documentation for example) If all points
  111550. * additionally have the `x` values, and xAxis type is set to `datetime`,
  111551. * then events are laid out on a true time axis, where their placement
  111552. * reflects the actual time between them.
  111553. */
  111554. data?: Array<PointOptionsObject>;
  111555. /**
  111556. * Not available
  111557. */
  111558. dataParser?: undefined;
  111559. /**
  111560. * Not available
  111561. */
  111562. dataURL?: undefined;
  111563. /**
  111564. * Not available
  111565. */
  111566. stack?: undefined;
  111567. /**
  111568. * (Highcharts, Highstock, Highmaps, Gantt) This property is only in
  111569. * TypeScript non-optional and might be `undefined` in series objects from
  111570. * unknown sources.
  111571. */
  111572. type: "timeline";
  111573. }
  111574. /**
  111575. * (Highstock) A configuration object for the tooltip rendering of each single
  111576. * series. Properties are inherited from tooltip, but only the following
  111577. * properties can be defined on a series level.
  111578. */
  111579. export interface SeriesTooltipOptionsObject {
  111580. /**
  111581. * (Highstock) How many decimals to show for the `point.change` value when
  111582. * the `series.compare` option is set. This is overridable in each series'
  111583. * tooltip options object. The default is to preserve all decimals.
  111584. */
  111585. changeDecimals?: number;
  111586. /**
  111587. * (Highstock) The HTML of the cluster point's in the tooltip. Works only
  111588. * with marker-clusters module and analogously to pointFormat.
  111589. *
  111590. * The cluster tooltip can be also formatted using `tooltip.formatter`
  111591. * callback function and `point.isCluster` flag.
  111592. */
  111593. clusterFormat?: object;
  111594. /**
  111595. * (Highcharts, Highstock, Gantt) For series on datetime axes, the date
  111596. * format in the tooltip's header will by default be guessed based on the
  111597. * closest data points. This member gives the default string representations
  111598. * used for each unit. For an overview of the replacement codes, see
  111599. * dateFormat.
  111600. */
  111601. dateTimeLabelFormats?: Dictionary<string>;
  111602. /**
  111603. * (Highstock) Distance from point to tooltip in pixels.
  111604. */
  111605. distance?: number;
  111606. /**
  111607. * (Highstock) Whether the tooltip should follow the mouse as it moves
  111608. * across columns, pie slices and other point types with an extent. By
  111609. * default it behaves this way for pie, polygon, map, sankey and wordcloud
  111610. * series by override in the `plotOptions` for those series types.
  111611. *
  111612. * For touch moves to behave the same way, followTouchMove must be `true`
  111613. * also.
  111614. */
  111615. followPointer?: boolean;
  111616. /**
  111617. * (Highstock) Whether the tooltip should update as the finger moves on a
  111618. * touch device. If this is `true` and chart.panning is
  111619. * set,`followTouchMove` will take over one-finger touches, so the user
  111620. * needs to use two fingers for zooming and panning.
  111621. *
  111622. * Note the difference to followPointer that only defines the _position_ of
  111623. * the tooltip. If `followPointer` is false in for example a column series,
  111624. * the tooltip will show above or below the column, but as `followTouchMove`
  111625. * is true, the tooltip will jump from column to column as the user swipes
  111626. * across the plot area.
  111627. */
  111628. followTouchMove?: boolean;
  111629. /**
  111630. * (Highstock) A string to append to the tooltip format.
  111631. */
  111632. footerFormat?: string;
  111633. /**
  111634. * (Highstock) The HTML of the tooltip header line. Variables are enclosed
  111635. * by curly brackets. Available variables are `point.key`, `series.name`,
  111636. * `series.color` and other members from the `point` and `series` objects.
  111637. * The `point.key` variable contains the category name, x value or datetime
  111638. * string depending on the type of axis. For datetime axes, the `point.key`
  111639. * date format can be set using `tooltip.xDateFormat`.
  111640. */
  111641. headerFormat?: string;
  111642. /**
  111643. * (Highcharts) The format string specifying what to show for _nodes_ in
  111644. * tooltip of a diagram series, as opposed to links.
  111645. */
  111646. nodeFormat?: string;
  111647. /**
  111648. * (Highcharts) A callback for defining the format for _nodes_ in the
  111649. * chart's tooltip, as opposed to links.
  111650. */
  111651. nodeFormatter?: FormatterCallbackFunction<SankeyNodeObject>;
  111652. /**
  111653. * (Highstock) The HTML of the null point's line in the tooltip. Works
  111654. * analogously to pointFormat.
  111655. */
  111656. nullFormat?: string;
  111657. /**
  111658. * (Highstock) Callback function to format the text of the tooltip for
  111659. * visible null points. Works analogously to formatter.
  111660. */
  111661. nullFormatter?: TooltipFormatterCallbackFunction;
  111662. /**
  111663. * (Highstock) The HTML of the point's line in the tooltip. Variables are
  111664. * enclosed by curly brackets. Available variables are `point.x`, `point.y`,
  111665. * `series.name` and `series.color` and other properties on the same form.
  111666. * Furthermore, `point.y` can be extended by the `tooltip.valuePrefix` and
  111667. * `tooltip.valueSuffix` variables. This can also be overridden for each
  111668. * series, which makes it a good hook for displaying units.
  111669. *
  111670. * In styled mode, the dot is colored by a class name rather than the point
  111671. * color.
  111672. */
  111673. pointFormat?: string;
  111674. /**
  111675. * (Highstock) A callback function for formatting the HTML output for a
  111676. * single point in the tooltip. Like the `pointFormat` string, but with more
  111677. * flexibility.
  111678. */
  111679. pointFormatter?: FormatterCallbackFunction<Point>;
  111680. /**
  111681. * (Highstock) Number of decimals in indicator series.
  111682. */
  111683. valueDecimals?: number;
  111684. /**
  111685. * (Highstock) A string to prepend to each series' y value. Overridable in
  111686. * each series' tooltip options object.
  111687. */
  111688. valuePrefix?: string;
  111689. /**
  111690. * (Highstock) A string to append to each series' y value. Overridable in
  111691. * each series' tooltip options object.
  111692. */
  111693. valueSuffix?: string;
  111694. /**
  111695. * (Highcharts, Highstock, Gantt) The format for the date in the tooltip
  111696. * header if the X axis is a datetime axis. The default is a best guess
  111697. * based on the smallest distance between points in the chart.
  111698. */
  111699. xDateFormat?: string;
  111700. }
  111701. /**
  111702. * (Highcharts, Highstock, Gantt) Enable or disable the initial animation when a
  111703. * series is displayed for the `dataLabels`. The animation can also be set as a
  111704. * configuration object. Please note that this option only applies to the
  111705. * initial animation. For other animations, see chart.animation and the
  111706. * animation parameter under the API methods. The following properties are
  111707. * supported:
  111708. *
  111709. * - `defer`: The animation delay time in milliseconds.
  111710. */
  111711. export interface SeriesTreemapDataDataLabelsAnimationOptions {
  111712. /**
  111713. * (Highcharts, Highstock, Gantt) The animation delay time in milliseconds.
  111714. * Set to `0` renders dataLabel immediately. As `undefined` inherits defer
  111715. * time from the series.animation.defer.
  111716. */
  111717. defer?: number;
  111718. }
  111719. /**
  111720. * (Highcharts) Style options for the guide box. The guide box has one state by
  111721. * default, the `default` state.
  111722. */
  111723. export interface SeriesTreemapDataDragDropGuideBoxOptions {
  111724. /**
  111725. * (Highcharts) Style options for the guide box default state.
  111726. */
  111727. default?: DragDropGuideBoxOptionsObject;
  111728. }
  111729. /**
  111730. * (Highcharts) A `treemap` series. If the type option is not specified, it is
  111731. * inherited from chart.type.
  111732. *
  111733. * In TypeScript the type option must always be set.
  111734. *
  111735. * Configuration options for the series are given in three levels:
  111736. *
  111737. * 1. Options for all series in a chart are defined in the plotOptions.series
  111738. * object.
  111739. *
  111740. * 2. Options for all `treemap` series are defined in plotOptions.treemap.
  111741. *
  111742. * 3. Options for one single series are given in the series instance array. (see
  111743. * online documentation for example)
  111744. *
  111745. * You have to extend the `SeriesTreemapOptions` via an interface to allow
  111746. * custom properties: ``` declare interface SeriesTreemapOptions {
  111747. * customProperty: string; }
  111748. *
  111749. */
  111750. export interface SeriesTreemapOptions extends PlotTreemapOptions, SeriesOptions {
  111751. /**
  111752. * (Highcharts) An array of data points for the series. For the `treemap`
  111753. * series type, points can be given in the following ways:
  111754. *
  111755. * 1. An array of numerical values. In this case, the numerical values will
  111756. * be interpreted as `value` options. Example: (see online documentation for
  111757. * example)
  111758. *
  111759. * 2. An array of objects with named values. The following snippet shows
  111760. * only a few settings, see the complete options set below. If the total
  111761. * number of data points exceeds the series' turboThreshold, this option is
  111762. * not available. (see online documentation for example)
  111763. */
  111764. data?: Array<(number|null|PointOptionsObject)>;
  111765. /**
  111766. * Not available
  111767. */
  111768. dataParser?: undefined;
  111769. /**
  111770. * Not available
  111771. */
  111772. dataURL?: undefined;
  111773. /**
  111774. * Not available
  111775. */
  111776. stack?: undefined;
  111777. /**
  111778. * (Highcharts, Highstock, Highmaps, Gantt) This property is only in
  111779. * TypeScript non-optional and might be `undefined` in series objects from
  111780. * unknown sources.
  111781. */
  111782. type: "treemap";
  111783. }
  111784. /**
  111785. * (Highstock) A `TrendLine` series. If the type option is not specified, it is
  111786. * inherited from chart.type.
  111787. *
  111788. * In TypeScript the type option must always be set.
  111789. *
  111790. * Configuration options for the series are given in three levels:
  111791. *
  111792. * 1. Options for all series in a chart are defined in the plotOptions.series
  111793. * object.
  111794. *
  111795. * 2. Options for all `trendline` series are defined in plotOptions.trendline.
  111796. *
  111797. * 3. Options for one single series are given in the series instance array. (see
  111798. * online documentation for example)
  111799. *
  111800. * You have to extend the `SeriesTrendlineOptions` via an interface to allow
  111801. * custom properties: ``` declare interface SeriesTrendlineOptions {
  111802. * customProperty: string; }
  111803. *
  111804. */
  111805. export interface SeriesTrendlineOptions extends PlotTrendlineOptions, SeriesOptions {
  111806. /**
  111807. * Not available
  111808. */
  111809. dataParser?: undefined;
  111810. /**
  111811. * Not available
  111812. */
  111813. dataURL?: undefined;
  111814. /**
  111815. * (Highcharts, Highstock, Highmaps, Gantt) This property is only in
  111816. * TypeScript non-optional and might be `undefined` in series objects from
  111817. * unknown sources.
  111818. */
  111819. type: "trendline";
  111820. }
  111821. /**
  111822. * (Highstock) A `TRIX` series. If the type option is not specified, it is
  111823. * inherited from chart.type.
  111824. *
  111825. * In TypeScript the type option must always be set.
  111826. *
  111827. * Configuration options for the series are given in three levels:
  111828. *
  111829. * 1. Options for all series in a chart are defined in the plotOptions.series
  111830. * object.
  111831. *
  111832. * 2. Options for all `trix` series are defined in plotOptions.trix.
  111833. *
  111834. * 3. Options for one single series are given in the series instance array. (see
  111835. * online documentation for example)
  111836. *
  111837. * You have to extend the `SeriesTrixOptions` via an interface to allow custom
  111838. * properties: ``` declare interface SeriesTrixOptions { customProperty: string;
  111839. * }
  111840. *
  111841. */
  111842. export interface SeriesTrixOptions extends PlotTrixOptions, SeriesOptions {
  111843. /**
  111844. * Not available
  111845. */
  111846. dataParser?: undefined;
  111847. /**
  111848. * Not available
  111849. */
  111850. dataURL?: undefined;
  111851. /**
  111852. * (Highcharts, Highstock, Highmaps, Gantt) This property is only in
  111853. * TypeScript non-optional and might be `undefined` in series objects from
  111854. * unknown sources.
  111855. */
  111856. type: "trix";
  111857. }
  111858. /**
  111859. * (Highcharts) Enable or disable the initial animation when a series is
  111860. * displayed for the `dataLabels`. The animation can also be set as a
  111861. * configuration object. Please note that this option only applies to the
  111862. * initial animation. For other animations, see chart.animation and the
  111863. * animation parameter under the API methods. The following properties are
  111864. * supported:
  111865. *
  111866. * - `defer`: The animation delay time in milliseconds.
  111867. */
  111868. export interface SeriesVariablepieDataDataLabelsAnimationOptions {
  111869. /**
  111870. * (Highcharts) The animation delay time in milliseconds. Set to `0` renders
  111871. * dataLabel immediately. As `undefined` inherits defer time from the
  111872. * series.animation.defer.
  111873. */
  111874. defer?: number;
  111875. }
  111876. /**
  111877. * (Highcharts) Style options for the guide box. The guide box has one state by
  111878. * default, the `default` state.
  111879. */
  111880. export interface SeriesVariablepieDataDragDropGuideBoxOptions {
  111881. /**
  111882. * (Highcharts) Style options for the guide box default state.
  111883. */
  111884. default?: DragDropGuideBoxOptionsObject;
  111885. }
  111886. /**
  111887. * (Highcharts) A `variablepie` series. If the type option is not specified, it
  111888. * is inherited from chart.type.
  111889. *
  111890. * In TypeScript the type option must always be set.
  111891. *
  111892. * Configuration options for the series are given in three levels:
  111893. *
  111894. * 1. Options for all series in a chart are defined in the plotOptions.series
  111895. * object.
  111896. *
  111897. * 2. Options for all `variablepie` series are defined in
  111898. * plotOptions.variablepie.
  111899. *
  111900. * 3. Options for one single series are given in the series instance array. (see
  111901. * online documentation for example)
  111902. *
  111903. * You have to extend the `SeriesVariablepieOptions` via an interface to allow
  111904. * custom properties: ``` declare interface SeriesVariablepieOptions {
  111905. * customProperty: string; }
  111906. *
  111907. */
  111908. export interface SeriesVariablepieOptions extends PlotVariablepieOptions, SeriesOptions {
  111909. /**
  111910. * (Highcharts) An array of data points for the series. For the
  111911. * `variablepie` series type, points can be given in the following ways:
  111912. *
  111913. * 1. An array of arrays with 2 values. In this case, the numerical values
  111914. * will be interpreted as `y, z` options. Example: (see online documentation
  111915. * for example)
  111916. *
  111917. * 2. An array of objects with named values. The following snippet shows
  111918. * only a few settings, see the complete options set below. If the total
  111919. * number of data points exceeds the series' turboThreshold, this option is
  111920. * not available. (see online documentation for example)
  111921. */
  111922. data?: Array<([(number|string), number]|PointOptionsObject)>;
  111923. /**
  111924. * Not available
  111925. */
  111926. dataParser?: undefined;
  111927. /**
  111928. * Not available
  111929. */
  111930. dataURL?: undefined;
  111931. /**
  111932. * Not available
  111933. */
  111934. stack?: undefined;
  111935. /**
  111936. * (Highcharts, Highstock, Highmaps, Gantt) This property is only in
  111937. * TypeScript non-optional and might be `undefined` in series objects from
  111938. * unknown sources.
  111939. */
  111940. type: "variablepie";
  111941. /**
  111942. * Not available
  111943. */
  111944. xAxis?: undefined;
  111945. /**
  111946. * Not available
  111947. */
  111948. yAxis?: undefined;
  111949. }
  111950. /**
  111951. * (Highcharts, Highstock, Gantt) Enable or disable the initial animation when a
  111952. * series is displayed for the `dataLabels`. The animation can also be set as a
  111953. * configuration object. Please note that this option only applies to the
  111954. * initial animation. For other animations, see chart.animation and the
  111955. * animation parameter under the API methods. The following properties are
  111956. * supported:
  111957. *
  111958. * - `defer`: The animation delay time in milliseconds.
  111959. */
  111960. export interface SeriesVariwideDataDataLabelsAnimationOptions {
  111961. /**
  111962. * (Highcharts, Highstock, Gantt) The animation delay time in milliseconds.
  111963. * Set to `0` renders dataLabel immediately. As `undefined` inherits defer
  111964. * time from the series.animation.defer.
  111965. */
  111966. defer?: number;
  111967. }
  111968. /**
  111969. * (Highcharts) Style options for the guide box. The guide box has one state by
  111970. * default, the `default` state.
  111971. */
  111972. export interface SeriesVariwideDataDragDropGuideBoxOptions {
  111973. /**
  111974. * (Highcharts) Style options for the guide box default state.
  111975. */
  111976. default?: DragDropGuideBoxOptionsObject;
  111977. }
  111978. /**
  111979. * (Highcharts) A `variwide` series. If the type option is not specified, it is
  111980. * inherited from chart.type.
  111981. *
  111982. * In TypeScript the type option must always be set.
  111983. *
  111984. * Configuration options for the series are given in three levels:
  111985. *
  111986. * 1. Options for all series in a chart are defined in the plotOptions.series
  111987. * object.
  111988. *
  111989. * 2. Options for all `variwide` series are defined in plotOptions.variwide.
  111990. *
  111991. * 3. Options for one single series are given in the series instance array. (see
  111992. * online documentation for example)
  111993. *
  111994. * You have to extend the `SeriesVariwideOptions` via an interface to allow
  111995. * custom properties: ``` declare interface SeriesVariwideOptions {
  111996. * customProperty: string; }
  111997. *
  111998. */
  111999. export interface SeriesVariwideOptions extends PlotVariwideOptions, SeriesOptions {
  112000. /**
  112001. * (Highcharts) An array of data points for the series. For the `variwide`
  112002. * series type, points can be given in the following ways:
  112003. *
  112004. * 1. An array of arrays with 3 or 2 values. In this case, the values
  112005. * correspond to `x,y,z`. If the first value is a string, it is applied as
  112006. * the name of the point, and the `x` value is inferred. The `x` value can
  112007. * also be omitted, in which case the inner arrays should be of length 2.
  112008. * Then the `x` value is automatically calculated, either starting at 0 and
  112009. * incremented by 1, or from `pointStart` and `pointInterval` given in the
  112010. * series options. (see online documentation for example)
  112011. *
  112012. * 2. An array of objects with named values. The following snippet shows
  112013. * only a few settings, see the complete options set below. If the total
  112014. * number of data points exceeds the series' turboThreshold, this option is
  112015. * not available. (see online documentation for example)
  112016. */
  112017. data?: Array<([(number|string), number]|[(number|string), number, number]|PointOptionsObject)>;
  112018. /**
  112019. * (Highcharts, Highstock, Highmaps, Gantt) This property is only in
  112020. * TypeScript non-optional and might be `undefined` in series objects from
  112021. * unknown sources.
  112022. */
  112023. type: "variwide";
  112024. }
  112025. /**
  112026. * (Highstock) A `Volume By Price (VBP)` series. If the type option is not
  112027. * specified, it is inherited from chart.type.
  112028. *
  112029. * In TypeScript the type option must always be set.
  112030. *
  112031. * Configuration options for the series are given in three levels:
  112032. *
  112033. * 1. Options for all series in a chart are defined in the plotOptions.series
  112034. * object.
  112035. *
  112036. * 2. Options for all `vbp` series are defined in plotOptions.vbp.
  112037. *
  112038. * 3. Options for one single series are given in the series instance array. (see
  112039. * online documentation for example)
  112040. *
  112041. * You have to extend the `SeriesVbpOptions` via an interface to allow custom
  112042. * properties: ``` declare interface SeriesVbpOptions { customProperty: string;
  112043. * }
  112044. *
  112045. */
  112046. export interface SeriesVbpOptions extends PlotVbpOptions, SeriesOptions {
  112047. /**
  112048. * Not available
  112049. */
  112050. dataParser?: undefined;
  112051. /**
  112052. * Not available
  112053. */
  112054. dataURL?: undefined;
  112055. /**
  112056. * (Highcharts, Highstock, Highmaps, Gantt) This property is only in
  112057. * TypeScript non-optional and might be `undefined` in series objects from
  112058. * unknown sources.
  112059. */
  112060. type: "vbp";
  112061. }
  112062. /**
  112063. * (Highcharts, Highstock, Gantt) Enable or disable the initial animation when a
  112064. * series is displayed for the `dataLabels`. The animation can also be set as a
  112065. * configuration object. Please note that this option only applies to the
  112066. * initial animation. For other animations, see chart.animation and the
  112067. * animation parameter under the API methods. The following properties are
  112068. * supported:
  112069. *
  112070. * - `defer`: The animation delay time in milliseconds.
  112071. */
  112072. export interface SeriesVectorDataDataLabelsAnimationOptions {
  112073. /**
  112074. * (Highcharts, Highstock, Gantt) The animation delay time in milliseconds.
  112075. * Set to `0` renders dataLabel immediately. As `undefined` inherits defer
  112076. * time from the series.animation.defer.
  112077. */
  112078. defer?: number;
  112079. }
  112080. /**
  112081. * (Highcharts, Highstock) Style options for the guide box. The guide box has
  112082. * one state by default, the `default` state.
  112083. */
  112084. export interface SeriesVectorDataDragDropGuideBoxOptions {
  112085. /**
  112086. * (Highcharts, Highstock) Style options for the guide box default state.
  112087. */
  112088. default?: DragDropGuideBoxOptionsObject;
  112089. }
  112090. /**
  112091. * (Highcharts, Highstock) A `vector` series. If the type option is not
  112092. * specified, it is inherited from chart.type.
  112093. *
  112094. * In TypeScript the type option must always be set.
  112095. *
  112096. * Configuration options for the series are given in three levels:
  112097. *
  112098. * 1. Options for all series in a chart are defined in the plotOptions.series
  112099. * object.
  112100. *
  112101. * 2. Options for all `vector` series are defined in plotOptions.vector.
  112102. *
  112103. * 3. Options for one single series are given in the series instance array. (see
  112104. * online documentation for example)
  112105. *
  112106. * You have to extend the `SeriesVectorOptions` via an interface to allow custom
  112107. * properties: ``` declare interface SeriesVectorOptions { customProperty:
  112108. * string; }
  112109. *
  112110. */
  112111. export interface SeriesVectorOptions extends PlotVectorOptions, SeriesOptions {
  112112. /**
  112113. * (Highcharts, Highstock) An array of data points for the series. For the
  112114. * `vector` series type, points can be given in the following ways:
  112115. *
  112116. * 1. An array of arrays with 4 values. In this case, the values correspond
  112117. * to to `x,y,length,direction`. If the first value is a string, it is
  112118. * applied as the name of the point, and the `x` value is inferred. (see
  112119. * online documentation for example)
  112120. *
  112121. * 2. An array of objects with named values. The following snippet shows
  112122. * only a few settings, see the complete options set below. If the total
  112123. * number of data points exceeds the series' turboThreshold, this option is
  112124. * not available. (see online documentation for example)
  112125. */
  112126. data?: Array<([(number|string), number, number, number]|PointOptionsObject)>;
  112127. /**
  112128. * Not available
  112129. */
  112130. dataParser?: undefined;
  112131. /**
  112132. * Not available
  112133. */
  112134. dataURL?: undefined;
  112135. /**
  112136. * (Highcharts, Highstock, Highmaps, Gantt) This property is only in
  112137. * TypeScript non-optional and might be `undefined` in series objects from
  112138. * unknown sources.
  112139. */
  112140. type: "vector";
  112141. }
  112142. /**
  112143. * (Highcharts, Highstock, Gantt) Enable or disable the initial animation when a
  112144. * series is displayed for the `dataLabels`. The animation can also be set as a
  112145. * configuration object. Please note that this option only applies to the
  112146. * initial animation. For other animations, see chart.animation and the
  112147. * animation parameter under the API methods. The following properties are
  112148. * supported:
  112149. *
  112150. * - `defer`: The animation delay time in milliseconds.
  112151. */
  112152. export interface SeriesVennDataDataLabelsAnimationOptions {
  112153. /**
  112154. * (Highcharts, Highstock, Gantt) The animation delay time in milliseconds.
  112155. * Set to `0` renders dataLabel immediately. As `undefined` inherits defer
  112156. * time from the series.animation.defer.
  112157. */
  112158. defer?: number;
  112159. }
  112160. /**
  112161. * (Highcharts) Style options for the guide box. The guide box has one state by
  112162. * default, the `default` state.
  112163. */
  112164. export interface SeriesVennDataDragDropGuideBoxOptions {
  112165. /**
  112166. * (Highcharts) Style options for the guide box default state.
  112167. */
  112168. default?: DragDropGuideBoxOptionsObject;
  112169. }
  112170. /**
  112171. * (Highcharts) A `venn` series. If the type option is not specified, it is
  112172. * inherited from chart.type.
  112173. *
  112174. * In TypeScript the type option must always be set.
  112175. *
  112176. * Configuration options for the series are given in three levels:
  112177. *
  112178. * 1. Options for all series in a chart are defined in the plotOptions.series
  112179. * object.
  112180. *
  112181. * 2. Options for all `venn` series are defined in plotOptions.venn.
  112182. *
  112183. * 3. Options for one single series are given in the series instance array. (see
  112184. * online documentation for example)
  112185. *
  112186. * You have to extend the `SeriesVennOptions` via an interface to allow custom
  112187. * properties: ``` declare interface SeriesVennOptions { customProperty: string;
  112188. * }
  112189. *
  112190. */
  112191. export interface SeriesVennOptions extends PlotVennOptions, SeriesOptions {
  112192. /**
  112193. * (Highcharts) An array of data points for the series. For the `scatter`
  112194. * series type, points can be given in the following ways:
  112195. *
  112196. * 1. An array of numerical values. In this case, the numerical values will
  112197. * be interpreted as `y` options. The `x` values will be automatically
  112198. * calculated, either starting at 0 and incremented by 1, or from
  112199. * `pointStart` and `pointInterval` given in the series options. If the axis
  112200. * has categories, these will be used. Example: (see online documentation
  112201. * for example)
  112202. *
  112203. * 2. An array of arrays with 2 values. In this case, the values correspond
  112204. * to `x,y`. If the first value is a string, it is applied as the name of
  112205. * the point, and the `x` value is inferred. (see online documentation for
  112206. * example)
  112207. *
  112208. * 3. An array of objects with named values. The following snippet shows
  112209. * only a few settings, see the complete options set below. If the total
  112210. * number of data points exceeds the series' turboThreshold, this option is
  112211. * not available. (see online documentation for example)
  112212. */
  112213. data?: Array<PointOptionsObject>;
  112214. /**
  112215. * Not available
  112216. */
  112217. dataParser?: undefined;
  112218. /**
  112219. * Not available
  112220. */
  112221. dataURL?: undefined;
  112222. /**
  112223. * Not available
  112224. */
  112225. stack?: undefined;
  112226. /**
  112227. * Not available
  112228. */
  112229. steps?: undefined;
  112230. /**
  112231. * (Highcharts, Highstock, Highmaps, Gantt) This property is only in
  112232. * TypeScript non-optional and might be `undefined` in series objects from
  112233. * unknown sources.
  112234. */
  112235. type: "venn";
  112236. /**
  112237. * Not available
  112238. */
  112239. xAxis?: undefined;
  112240. /**
  112241. * Not available
  112242. */
  112243. yAxis?: undefined;
  112244. }
  112245. /**
  112246. * (Highstock) A `Volume Weighted Average Price (VWAP)` series. If the type
  112247. * option is not specified, it is inherited from chart.type.
  112248. *
  112249. * In TypeScript the type option must always be set.
  112250. *
  112251. * Configuration options for the series are given in three levels:
  112252. *
  112253. * 1. Options for all series in a chart are defined in the plotOptions.series
  112254. * object.
  112255. *
  112256. * 2. Options for all `vwap` series are defined in plotOptions.vwap.
  112257. *
  112258. * 3. Options for one single series are given in the series instance array. (see
  112259. * online documentation for example)
  112260. *
  112261. * You have to extend the `SeriesVwapOptions` via an interface to allow custom
  112262. * properties: ``` declare interface SeriesVwapOptions { customProperty: string;
  112263. * }
  112264. *
  112265. */
  112266. export interface SeriesVwapOptions extends PlotVwapOptions, SeriesOptions {
  112267. /**
  112268. * Not available
  112269. */
  112270. dataParser?: undefined;
  112271. /**
  112272. * Not available
  112273. */
  112274. dataURL?: undefined;
  112275. /**
  112276. * (Highcharts, Highstock, Highmaps, Gantt) This property is only in
  112277. * TypeScript non-optional and might be `undefined` in series objects from
  112278. * unknown sources.
  112279. */
  112280. type: "vwap";
  112281. }
  112282. /**
  112283. * (Highcharts, Highstock, Gantt) Enable or disable the initial animation when a
  112284. * series is displayed for the `dataLabels`. The animation can also be set as a
  112285. * configuration object. Please note that this option only applies to the
  112286. * initial animation. For other animations, see chart.animation and the
  112287. * animation parameter under the API methods. The following properties are
  112288. * supported:
  112289. *
  112290. * - `defer`: The animation delay time in milliseconds.
  112291. */
  112292. export interface SeriesWaterfallDataDataLabelsAnimationOptions {
  112293. /**
  112294. * (Highcharts, Highstock, Gantt) The animation delay time in milliseconds.
  112295. * Set to `0` renders dataLabel immediately. As `undefined` inherits defer
  112296. * time from the series.animation.defer.
  112297. */
  112298. defer?: number;
  112299. }
  112300. /**
  112301. * (Highcharts) Style options for the guide box. The guide box has one state by
  112302. * default, the `default` state.
  112303. */
  112304. export interface SeriesWaterfallDataDragDropGuideBoxOptions {
  112305. /**
  112306. * (Highcharts) Style options for the guide box default state.
  112307. */
  112308. default?: DragDropGuideBoxOptionsObject;
  112309. }
  112310. /**
  112311. * (Highcharts) A `waterfall` series. If the type option is not specified, it is
  112312. * inherited from chart.type.
  112313. *
  112314. * In TypeScript the type option must always be set.
  112315. *
  112316. * Configuration options for the series are given in three levels:
  112317. *
  112318. * 1. Options for all series in a chart are defined in the plotOptions.series
  112319. * object.
  112320. *
  112321. * 2. Options for all `waterfall` series are defined in plotOptions.waterfall.
  112322. *
  112323. * 3. Options for one single series are given in the series instance array. (see
  112324. * online documentation for example)
  112325. *
  112326. * You have to extend the `SeriesWaterfallOptions` via an interface to allow
  112327. * custom properties: ``` declare interface SeriesWaterfallOptions {
  112328. * customProperty: string; }
  112329. *
  112330. */
  112331. export interface SeriesWaterfallOptions extends PlotWaterfallOptions, SeriesOptions {
  112332. /**
  112333. * (Highcharts) An array of data points for the series. For the `waterfall`
  112334. * series type, points can be given in the following ways:
  112335. *
  112336. * 1. An array of numerical values. In this case, the numerical values will
  112337. * be interpreted as `y` options. The `x` values will be automatically
  112338. * calculated, either starting at 0 and incremented by 1, or from
  112339. * `pointStart` and `pointInterval` given in the series options. If the axis
  112340. * has categories, these will be used. Example: (see online documentation
  112341. * for example)
  112342. *
  112343. * 2. An array of arrays with 2 values. In this case, the values correspond
  112344. * to `x,y`. If the first value is a string, it is applied as the name of
  112345. * the point, and the `x` value is inferred. (see online documentation for
  112346. * example)
  112347. *
  112348. * 3. An array of objects with named values. The following snippet shows
  112349. * only a few settings, see the complete options set below. If the total
  112350. * number of data points exceeds the series' turboThreshold, this option is
  112351. * not available. (see online documentation for example)
  112352. */
  112353. data?: Array<(number|[(number|string), (number|null)]|null|PointOptionsObject)>;
  112354. /**
  112355. * Not available
  112356. */
  112357. dataParser?: undefined;
  112358. /**
  112359. * Not available
  112360. */
  112361. dataURL?: undefined;
  112362. /**
  112363. * (Highcharts, Highstock, Highmaps, Gantt) This property is only in
  112364. * TypeScript non-optional and might be `undefined` in series objects from
  112365. * unknown sources.
  112366. */
  112367. type: "waterfall";
  112368. }
  112369. /**
  112370. * (Highstock) A `Williams %R Oscillator` series. If the type option is not
  112371. * specified, it is inherited from chart.type.
  112372. *
  112373. * In TypeScript the type option must always be set.
  112374. *
  112375. * Configuration options for the series are given in three levels:
  112376. *
  112377. * 1. Options for all series in a chart are defined in the plotOptions.series
  112378. * object.
  112379. *
  112380. * 2. Options for all `williamsr` series are defined in plotOptions.williamsr.
  112381. *
  112382. * 3. Options for one single series are given in the series instance array. (see
  112383. * online documentation for example)
  112384. *
  112385. * You have to extend the `SeriesWilliamsrOptions` via an interface to allow
  112386. * custom properties: ``` declare interface SeriesWilliamsrOptions {
  112387. * customProperty: string; }
  112388. *
  112389. */
  112390. export interface SeriesWilliamsrOptions extends PlotWilliamsrOptions, SeriesOptions {
  112391. /**
  112392. * Not available
  112393. */
  112394. dataParser?: undefined;
  112395. /**
  112396. * Not available
  112397. */
  112398. dataURL?: undefined;
  112399. /**
  112400. * (Highcharts, Highstock, Highmaps, Gantt) This property is only in
  112401. * TypeScript non-optional and might be `undefined` in series objects from
  112402. * unknown sources.
  112403. */
  112404. type: "williamsr";
  112405. }
  112406. /**
  112407. * (Highcharts, Highstock, Gantt) Enable or disable the initial animation when a
  112408. * series is displayed for the `dataLabels`. The animation can also be set as a
  112409. * configuration object. Please note that this option only applies to the
  112410. * initial animation. For other animations, see chart.animation and the
  112411. * animation parameter under the API methods. The following properties are
  112412. * supported:
  112413. *
  112414. * - `defer`: The animation delay time in milliseconds.
  112415. */
  112416. export interface SeriesWindbarbDataDataLabelsAnimationOptions {
  112417. /**
  112418. * (Highcharts, Highstock, Gantt) The animation delay time in milliseconds.
  112419. * Set to `0` renders dataLabel immediately. As `undefined` inherits defer
  112420. * time from the series.animation.defer.
  112421. */
  112422. defer?: number;
  112423. }
  112424. /**
  112425. * (Highcharts, Highstock) Style options for the guide box. The guide box has
  112426. * one state by default, the `default` state.
  112427. */
  112428. export interface SeriesWindbarbDataDragDropGuideBoxOptions {
  112429. /**
  112430. * (Highcharts, Highstock) Style options for the guide box default state.
  112431. */
  112432. default?: DragDropGuideBoxOptionsObject;
  112433. }
  112434. /**
  112435. * (Highcharts, Highstock) A `windbarb` series. If the type option is not
  112436. * specified, it is inherited from chart.type.
  112437. *
  112438. * In TypeScript the type option must always be set.
  112439. *
  112440. * Configuration options for the series are given in three levels:
  112441. *
  112442. * 1. Options for all series in a chart are defined in the plotOptions.series
  112443. * object.
  112444. *
  112445. * 2. Options for all `windbarb` series are defined in plotOptions.windbarb.
  112446. *
  112447. * 3. Options for one single series are given in the series instance array. (see
  112448. * online documentation for example)
  112449. *
  112450. * You have to extend the `SeriesWindbarbOptions` via an interface to allow
  112451. * custom properties: ``` declare interface SeriesWindbarbOptions {
  112452. * customProperty: string; }
  112453. *
  112454. */
  112455. export interface SeriesWindbarbOptions extends PlotWindbarbOptions, SeriesOptions {
  112456. /**
  112457. * (Highcharts, Highstock) An array of data points for the series. For the
  112458. * `windbarb` series type, points can be given in the following ways:
  112459. *
  112460. * 1. An array of arrays with 3 values. In this case, the values correspond
  112461. * to `x,value,direction`. If the first value is a string, it is applied as
  112462. * the name of the point, and the `x` value is inferred. (see online
  112463. * documentation for example)
  112464. *
  112465. * 2. An array of objects with named values. The following snippet shows
  112466. * only a few settings, see the complete options set below. If the total
  112467. * number of data points exceeds the series' turboThreshold, this option is
  112468. * not available. (see online documentation for example)
  112469. */
  112470. data?: Array<([(number|string), number, number]|PointOptionsObject)>;
  112471. /**
  112472. * Not available
  112473. */
  112474. dataParser?: undefined;
  112475. /**
  112476. * Not available
  112477. */
  112478. dataURL?: undefined;
  112479. /**
  112480. * (Highcharts, Highstock, Highmaps, Gantt) This property is only in
  112481. * TypeScript non-optional and might be `undefined` in series objects from
  112482. * unknown sources.
  112483. */
  112484. type: "windbarb";
  112485. }
  112486. /**
  112487. * (Highstock) A `WMA` series. If the type option is not specified, it is
  112488. * inherited from chart.type.
  112489. *
  112490. * In TypeScript the type option must always be set.
  112491. *
  112492. * Configuration options for the series are given in three levels:
  112493. *
  112494. * 1. Options for all series in a chart are defined in the plotOptions.series
  112495. * object.
  112496. *
  112497. * 2. Options for all `wma` series are defined in plotOptions.wma.
  112498. *
  112499. * 3. Options for one single series are given in the series instance array. (see
  112500. * online documentation for example)
  112501. *
  112502. * You have to extend the `SeriesWmaOptions` via an interface to allow custom
  112503. * properties: ``` declare interface SeriesWmaOptions { customProperty: string;
  112504. * }
  112505. *
  112506. */
  112507. export interface SeriesWmaOptions extends PlotWmaOptions, SeriesOptions {
  112508. /**
  112509. * Not available
  112510. */
  112511. dataParser?: undefined;
  112512. /**
  112513. * Not available
  112514. */
  112515. dataURL?: undefined;
  112516. /**
  112517. * (Highcharts, Highstock, Highmaps, Gantt) This property is only in
  112518. * TypeScript non-optional and might be `undefined` in series objects from
  112519. * unknown sources.
  112520. */
  112521. type: "wma";
  112522. }
  112523. /**
  112524. * (Highcharts, Highstock, Gantt) Enable or disable the initial animation when a
  112525. * series is displayed for the `dataLabels`. The animation can also be set as a
  112526. * configuration object. Please note that this option only applies to the
  112527. * initial animation. For other animations, see chart.animation and the
  112528. * animation parameter under the API methods. The following properties are
  112529. * supported:
  112530. *
  112531. * - `defer`: The animation delay time in milliseconds.
  112532. */
  112533. export interface SeriesWordcloudDataDataLabelsAnimationOptions {
  112534. /**
  112535. * (Highcharts, Highstock, Gantt) The animation delay time in milliseconds.
  112536. * Set to `0` renders dataLabel immediately. As `undefined` inherits defer
  112537. * time from the series.animation.defer.
  112538. */
  112539. defer?: number;
  112540. }
  112541. /**
  112542. * (Highcharts) Style options for the guide box. The guide box has one state by
  112543. * default, the `default` state.
  112544. */
  112545. export interface SeriesWordcloudDataDragDropGuideBoxOptions {
  112546. /**
  112547. * (Highcharts) Style options for the guide box default state.
  112548. */
  112549. default?: DragDropGuideBoxOptionsObject;
  112550. }
  112551. /**
  112552. * (Highcharts) A `wordcloud` series. If the type option is not specified, it is
  112553. * inherited from chart.type.
  112554. *
  112555. * In TypeScript the type option must always be set.
  112556. *
  112557. * Configuration options for the series are given in three levels:
  112558. *
  112559. * 1. Options for all series in a chart are defined in the plotOptions.series
  112560. * object.
  112561. *
  112562. * 2. Options for all `wordcloud` series are defined in plotOptions.wordcloud.
  112563. *
  112564. * 3. Options for one single series are given in the series instance array. (see
  112565. * online documentation for example)
  112566. *
  112567. * You have to extend the `SeriesWordcloudOptions` via an interface to allow
  112568. * custom properties: ``` declare interface SeriesWordcloudOptions {
  112569. * customProperty: string; }
  112570. *
  112571. */
  112572. export interface SeriesWordcloudOptions extends PlotWordcloudOptions, SeriesOptions {
  112573. /**
  112574. * (Highcharts) An array of data points for the series. For the `wordcloud`
  112575. * series type, points can be given in the following ways:
  112576. *
  112577. * 1. An array of arrays with 2 values. In this case, the values correspond
  112578. * to `name,weight`. (see online documentation for example)
  112579. *
  112580. * 2. An array of objects with named values. The following snippet shows
  112581. * only a few settings, see the complete options set below. If the total
  112582. * number of data points exceeds the series' turboThreshold, this option is
  112583. * not available. (see online documentation for example)
  112584. */
  112585. data?: Array<([string, number]|PointOptionsObject)>;
  112586. /**
  112587. * (Highcharts, Highstock, Highmaps, Gantt) This property is only in
  112588. * TypeScript non-optional and might be `undefined` in series objects from
  112589. * unknown sources.
  112590. */
  112591. type: "wordcloud";
  112592. }
  112593. /**
  112594. * (Highcharts, Highstock, Gantt) Enable or disable the initial animation when a
  112595. * series is displayed for the `dataLabels`. The animation can also be set as a
  112596. * configuration object. Please note that this option only applies to the
  112597. * initial animation. For other animations, see chart.animation and the
  112598. * animation parameter under the API methods. The following properties are
  112599. * supported:
  112600. *
  112601. * - `defer`: The animation delay time in milliseconds.
  112602. */
  112603. export interface SeriesXrangeDataDataLabelsAnimationOptions {
  112604. /**
  112605. * (Highcharts, Highstock, Gantt) The animation delay time in milliseconds.
  112606. * Set to `0` renders dataLabel immediately. As `undefined` inherits defer
  112607. * time from the series.animation.defer.
  112608. */
  112609. defer?: number;
  112610. }
  112611. /**
  112612. * (Highcharts, Highstock, Gantt) Style options for the guide box. The guide box
  112613. * has one state by default, the `default` state.
  112614. */
  112615. export interface SeriesXrangeDataDragDropGuideBoxOptions {
  112616. /**
  112617. * (Highcharts, Highstock, Gantt) Style options for the guide box default
  112618. * state.
  112619. */
  112620. default?: DragDropGuideBoxOptionsObject;
  112621. }
  112622. /**
  112623. * (Highcharts, Highstock, Gantt) An `xrange` series. If the type option is not
  112624. * specified, it is inherited from chart.type.
  112625. *
  112626. * In TypeScript the type option must always be set.
  112627. *
  112628. * Configuration options for the series are given in three levels:
  112629. *
  112630. * 1. Options for all series in a chart are defined in the plotOptions.series
  112631. * object.
  112632. *
  112633. * 2. Options for all `xrange` series are defined in plotOptions.xrange.
  112634. *
  112635. * 3. Options for one single series are given in the series instance array. (see
  112636. * online documentation for example)
  112637. *
  112638. * You have to extend the `SeriesXrangeOptions` via an interface to allow custom
  112639. * properties: ``` declare interface SeriesXrangeOptions { customProperty:
  112640. * string; }
  112641. *
  112642. */
  112643. export interface SeriesXrangeOptions extends PlotXrangeOptions, SeriesOptions {
  112644. /**
  112645. * (Highcharts, Highstock, Gantt) An array of data points for the series.
  112646. * For the `xrange` series type, points can be given in the following ways:
  112647. *
  112648. * 1. An array of objects with named values. The objects are point
  112649. * configuration objects as seen below. (see online documentation for
  112650. * example)
  112651. */
  112652. data?: Array<XrangePointOptionsObject>;
  112653. /**
  112654. * Not available
  112655. */
  112656. depth?: undefined;
  112657. /**
  112658. * Not available
  112659. */
  112660. edgeColor?: undefined;
  112661. /**
  112662. * Not available
  112663. */
  112664. edgeWidth?: undefined;
  112665. /**
  112666. * (Highcharts, Highstock, Highmaps, Gantt) This property is only in
  112667. * TypeScript non-optional and might be `undefined` in series objects from
  112668. * unknown sources.
  112669. */
  112670. type: "xrange";
  112671. }
  112672. /**
  112673. * (Highstock) A `Zig Zag` series. If the type option is not specified, it is
  112674. * inherited from chart.type.
  112675. *
  112676. * In TypeScript the type option must always be set.
  112677. *
  112678. * Configuration options for the series are given in three levels:
  112679. *
  112680. * 1. Options for all series in a chart are defined in the plotOptions.series
  112681. * object.
  112682. *
  112683. * 2. Options for all `zigzag` series are defined in plotOptions.zigzag.
  112684. *
  112685. * 3. Options for one single series are given in the series instance array. (see
  112686. * online documentation for example)
  112687. *
  112688. * You have to extend the `SeriesZigzagOptions` via an interface to allow custom
  112689. * properties: ``` declare interface SeriesZigzagOptions { customProperty:
  112690. * string; }
  112691. *
  112692. */
  112693. export interface SeriesZigzagOptions extends PlotZigzagOptions, SeriesOptions {
  112694. /**
  112695. * Not available
  112696. */
  112697. dataParser?: undefined;
  112698. /**
  112699. * Not available
  112700. */
  112701. dataURL?: undefined;
  112702. /**
  112703. * (Highcharts, Highstock, Highmaps, Gantt) This property is only in
  112704. * TypeScript non-optional and might be `undefined` in series objects from
  112705. * unknown sources.
  112706. */
  112707. type: "zigzag";
  112708. }
  112709. /**
  112710. * (Highcharts, Highstock) An array defining zones within a series. Zones can be
  112711. * applied to the X axis, Y axis or Z axis for bubbles, according to the
  112712. * `zoneAxis` option. The zone definitions have to be in ascending order
  112713. * regarding to the value.
  112714. *
  112715. * In styled mode, the color zones are styled with the `.highcharts-zone-{n}`
  112716. * class, or custom classed from the `className` option (view live demo).
  112717. */
  112718. export interface SeriesZonesOptionsObject {
  112719. /**
  112720. * (Highcharts, Highstock) Styled mode only. A custom class name for the
  112721. * zone.
  112722. */
  112723. className?: string;
  112724. /**
  112725. * (Highcharts, Highstock) Defines the color of the series.
  112726. */
  112727. color?: (ColorString|GradientColorObject|PatternObject);
  112728. /**
  112729. * (Highcharts, Highstock) A name for the dash style to use for the graph.
  112730. */
  112731. dashStyle?: DashStyleValue;
  112732. /**
  112733. * (Highcharts, Highstock) Defines the fill color for the series (in area
  112734. * type series)
  112735. */
  112736. fillColor?: (ColorString|GradientColorObject|PatternObject);
  112737. /**
  112738. * (Highcharts, Highstock) The value up to where the zone extends, if
  112739. * undefined the zones stretches to the last value in the series.
  112740. */
  112741. value?: number;
  112742. }
  112743. /**
  112744. * The shadow options.
  112745. */
  112746. export interface ShadowOptionsObject {
  112747. /**
  112748. * The shadow color.
  112749. */
  112750. color?: ColorString;
  112751. /**
  112752. * The horizontal offset from the element.
  112753. */
  112754. offsetX?: number;
  112755. /**
  112756. * The vertical offset from the element.
  112757. */
  112758. offsetY?: number;
  112759. /**
  112760. * The shadow opacity.
  112761. */
  112762. opacity?: number;
  112763. /**
  112764. * The shadow width or distance from the element.
  112765. */
  112766. width?: number;
  112767. }
  112768. export interface SizeObject {
  112769. height: number;
  112770. width: number;
  112771. }
  112772. /**
  112773. * (Highcharts) Stack of data points
  112774. */
  112775. export interface StackItemObject {
  112776. /**
  112777. * Alignment settings
  112778. */
  112779. alignOptions: AlignObject;
  112780. /**
  112781. * Related axis
  112782. */
  112783. axis: Axis;
  112784. /**
  112785. * Cumulative value of the stacked data points
  112786. */
  112787. cumulative: number;
  112788. /**
  112789. * True if on the negative side
  112790. */
  112791. isNegative: boolean;
  112792. /**
  112793. * Related SVG element
  112794. */
  112795. label: SVGElement;
  112796. /**
  112797. * Related stack options
  112798. */
  112799. options: YAxisStackLabelsOptions;
  112800. /**
  112801. * Total value of the stacked data points
  112802. */
  112803. total: number;
  112804. /**
  112805. * Shared x value of the stack
  112806. */
  112807. x: number;
  112808. }
  112809. export interface StockToolsGuiDefinitionsAdvancedFibonacciOptions {
  112810. /**
  112811. * (Highstock) A predefined background symbol for the button.
  112812. */
  112813. symbol?: string;
  112814. }
  112815. export interface StockToolsGuiDefinitionsAdvancedOptions {
  112816. fibonacci?: StockToolsGuiDefinitionsAdvancedFibonacciOptions;
  112817. /**
  112818. * (Highstock) A collection of strings pointing to config options for the
  112819. * items.
  112820. */
  112821. items?: any[];
  112822. parallelChannel?: StockToolsGuiDefinitionsAdvancedParallelChannelOptions;
  112823. pitchfork?: StockToolsGuiDefinitionsAdvancedPitchforkOptions;
  112824. }
  112825. export interface StockToolsGuiDefinitionsAdvancedParallelChannelOptions {
  112826. /**
  112827. * (Highstock) A predefined background symbol for the button.
  112828. */
  112829. symbol?: string;
  112830. }
  112831. export interface StockToolsGuiDefinitionsAdvancedPitchforkOptions {
  112832. /**
  112833. * (Highstock) A predefined background symbol for the button.
  112834. */
  112835. symbol?: string;
  112836. }
  112837. export interface StockToolsGuiDefinitionsCrookedLinesCrooked3Options {
  112838. /**
  112839. * (Highstock) A predefined background symbol for the button.
  112840. */
  112841. symbol?: string;
  112842. }
  112843. export interface StockToolsGuiDefinitionsCrookedLinesCrooked5Options {
  112844. /**
  112845. * (Highstock) A predefined background symbol for the button.
  112846. */
  112847. symbol?: string;
  112848. }
  112849. export interface StockToolsGuiDefinitionsCrookedLinesElliott3Options {
  112850. /**
  112851. * (Highstock) A predefined background symbol for the button.
  112852. */
  112853. symbol?: string;
  112854. }
  112855. export interface StockToolsGuiDefinitionsCrookedLinesElliott5Options {
  112856. /**
  112857. * (Highstock) A predefined background symbol for the button.
  112858. */
  112859. symbol?: string;
  112860. }
  112861. export interface StockToolsGuiDefinitionsCrookedLinesOptions {
  112862. crooked3?: StockToolsGuiDefinitionsCrookedLinesCrooked3Options;
  112863. crooked5?: StockToolsGuiDefinitionsCrookedLinesCrooked5Options;
  112864. elliott3?: StockToolsGuiDefinitionsCrookedLinesElliott3Options;
  112865. elliott5?: StockToolsGuiDefinitionsCrookedLinesElliott5Options;
  112866. /**
  112867. * (Highstock) A collection of strings pointing to config options for the
  112868. * items.
  112869. */
  112870. items?: any[];
  112871. }
  112872. export interface StockToolsGuiDefinitionsCurrentPriceIndicatorOptions {
  112873. /**
  112874. * (Highstock) A predefined background symbol for the button.
  112875. */
  112876. symbol?: string;
  112877. }
  112878. export interface StockToolsGuiDefinitionsFlagsFlagCirclepinOptions {
  112879. /**
  112880. * (Highstock) A predefined background symbol for the button.
  112881. */
  112882. symbol?: string;
  112883. }
  112884. export interface StockToolsGuiDefinitionsFlagsFlagDiamondpinOptions {
  112885. /**
  112886. * (Highstock) A predefined background symbol for the button.
  112887. */
  112888. symbol?: string;
  112889. }
  112890. export interface StockToolsGuiDefinitionsFlagsFlagSimplepinOptions {
  112891. /**
  112892. * (Highstock) A predefined background symbol for the button.
  112893. */
  112894. symbol?: string;
  112895. }
  112896. export interface StockToolsGuiDefinitionsFlagsFlagSquarepinOptions {
  112897. /**
  112898. * (Highstock) A predefined background symbol for the button.
  112899. */
  112900. symbol?: string;
  112901. }
  112902. export interface StockToolsGuiDefinitionsFlagsOptions {
  112903. flagCirclepin?: StockToolsGuiDefinitionsFlagsFlagCirclepinOptions;
  112904. flagDiamondpin?: StockToolsGuiDefinitionsFlagsFlagDiamondpinOptions;
  112905. flagSimplepin?: StockToolsGuiDefinitionsFlagsFlagSimplepinOptions;
  112906. flagSquarepin?: StockToolsGuiDefinitionsFlagsFlagSquarepinOptions;
  112907. /**
  112908. * (Highstock) A collection of strings pointing to config options for the
  112909. * items.
  112910. */
  112911. items?: any[];
  112912. }
  112913. export interface StockToolsGuiDefinitionsFullScreenOptions {
  112914. /**
  112915. * (Highstock) A predefined background symbol for the button.
  112916. */
  112917. symbol?: string;
  112918. }
  112919. export interface StockToolsGuiDefinitionsIndicatorsOptions {
  112920. /**
  112921. * (Highstock) A predefined background symbol for the button.
  112922. */
  112923. symbol?: string;
  112924. }
  112925. export interface StockToolsGuiDefinitionsLinesArrowLineOptions {
  112926. /**
  112927. * (Highstock) A predefined background symbol for the button.
  112928. */
  112929. symbol?: string;
  112930. }
  112931. export interface StockToolsGuiDefinitionsLinesArrowRayOptions {
  112932. /**
  112933. * (Highstock) A predefined background symbol for the button.
  112934. */
  112935. symbol?: string;
  112936. }
  112937. export interface StockToolsGuiDefinitionsLinesArrowSegmentOptions {
  112938. /**
  112939. * (Highstock) A predefined background symbol for the button.
  112940. */
  112941. symbol?: string;
  112942. }
  112943. export interface StockToolsGuiDefinitionsLinesHorizontalLineOptions {
  112944. /**
  112945. * (Highstock) A predefined background symbol for the button.
  112946. */
  112947. symbol?: string;
  112948. }
  112949. export interface StockToolsGuiDefinitionsLinesLineOptions {
  112950. /**
  112951. * (Highstock) A predefined background symbol for the button.
  112952. */
  112953. symbol?: string;
  112954. }
  112955. export interface StockToolsGuiDefinitionsLinesOptions {
  112956. arrowLine?: StockToolsGuiDefinitionsLinesArrowLineOptions;
  112957. arrowRay?: StockToolsGuiDefinitionsLinesArrowRayOptions;
  112958. arrowSegment?: StockToolsGuiDefinitionsLinesArrowSegmentOptions;
  112959. horizontalLine?: StockToolsGuiDefinitionsLinesHorizontalLineOptions;
  112960. /**
  112961. * (Highstock) A collection of strings pointing to config options for the
  112962. * items.
  112963. */
  112964. items?: any[];
  112965. line?: StockToolsGuiDefinitionsLinesLineOptions;
  112966. ray?: StockToolsGuiDefinitionsLinesRayOptions;
  112967. segment?: StockToolsGuiDefinitionsLinesSegmentOptions;
  112968. verticalLine?: StockToolsGuiDefinitionsLinesVerticalLineOptions;
  112969. }
  112970. export interface StockToolsGuiDefinitionsLinesRayOptions {
  112971. /**
  112972. * (Highstock) A predefined background symbol for the button.
  112973. */
  112974. symbol?: string;
  112975. }
  112976. export interface StockToolsGuiDefinitionsLinesSegmentOptions {
  112977. /**
  112978. * (Highstock) A predefined background symbol for the button.
  112979. */
  112980. symbol?: string;
  112981. }
  112982. export interface StockToolsGuiDefinitionsLinesVerticalLineOptions {
  112983. /**
  112984. * (Highstock) A predefined background symbol for the button.
  112985. */
  112986. symbol?: string;
  112987. }
  112988. export interface StockToolsGuiDefinitionsMeasureMeasureXOptions {
  112989. /**
  112990. * (Highstock) A predefined background symbol for the button.
  112991. */
  112992. symbol?: string;
  112993. }
  112994. export interface StockToolsGuiDefinitionsMeasureMeasureXYOptions {
  112995. /**
  112996. * (Highstock) A predefined background symbol for the button.
  112997. */
  112998. symbol?: string;
  112999. }
  113000. export interface StockToolsGuiDefinitionsMeasureMeasureYOptions {
  113001. /**
  113002. * (Highstock) A predefined background symbol for the button.
  113003. */
  113004. symbol?: string;
  113005. }
  113006. export interface StockToolsGuiDefinitionsMeasureOptions {
  113007. /**
  113008. * (Highstock) A collection of strings pointing to config options for the
  113009. * items.
  113010. */
  113011. items?: any[];
  113012. measureX?: StockToolsGuiDefinitionsMeasureMeasureXOptions;
  113013. measureXY?: StockToolsGuiDefinitionsMeasureMeasureXYOptions;
  113014. measureY?: StockToolsGuiDefinitionsMeasureMeasureYOptions;
  113015. }
  113016. /**
  113017. * (Highstock) An options object of the buttons definitions. Each name refers to
  113018. * unique key from buttons array.
  113019. */
  113020. export interface StockToolsGuiDefinitionsOptions {
  113021. advanced?: StockToolsGuiDefinitionsAdvancedOptions;
  113022. crookedLines?: StockToolsGuiDefinitionsCrookedLinesOptions;
  113023. currentPriceIndicator?: StockToolsGuiDefinitionsCurrentPriceIndicatorOptions;
  113024. flags?: StockToolsGuiDefinitionsFlagsOptions;
  113025. fullScreen?: StockToolsGuiDefinitionsFullScreenOptions;
  113026. indicators?: StockToolsGuiDefinitionsIndicatorsOptions;
  113027. lines?: StockToolsGuiDefinitionsLinesOptions;
  113028. measure?: StockToolsGuiDefinitionsMeasureOptions;
  113029. saveChart?: StockToolsGuiDefinitionsSaveChartOptions;
  113030. separator?: StockToolsGuiDefinitionsSeparatorOptions;
  113031. simpleShapes?: StockToolsGuiDefinitionsSimpleShapesOptions;
  113032. toggleAnnotations?: StockToolsGuiDefinitionsToggleAnnotationsOptions;
  113033. typeChange?: StockToolsGuiDefinitionsTypeChangeOptions;
  113034. verticalLabels?: StockToolsGuiDefinitionsVerticalLabelsOptions;
  113035. zoomChange?: StockToolsGuiDefinitionsZoomChangeOptions;
  113036. }
  113037. export interface StockToolsGuiDefinitionsSaveChartOptions {
  113038. /**
  113039. * (Highstock) A predefined background symbol for the button.
  113040. */
  113041. symbol?: string;
  113042. }
  113043. export interface StockToolsGuiDefinitionsSeparatorOptions {
  113044. /**
  113045. * (Highstock) A predefined background symbol for the button.
  113046. */
  113047. symbol?: string;
  113048. }
  113049. export interface StockToolsGuiDefinitionsSimpleShapesCircleOptions {
  113050. /**
  113051. * (Highstock) A predefined background symbol for the button.
  113052. */
  113053. symbol?: string;
  113054. }
  113055. export interface StockToolsGuiDefinitionsSimpleShapesLabelOptions {
  113056. /**
  113057. * (Highstock) A predefined background symbol for the button.
  113058. */
  113059. symbol?: string;
  113060. }
  113061. export interface StockToolsGuiDefinitionsSimpleShapesOptions {
  113062. circle?: StockToolsGuiDefinitionsSimpleShapesCircleOptions;
  113063. /**
  113064. * (Highstock) A collection of strings pointing to config options for the
  113065. * items.
  113066. */
  113067. items?: any[];
  113068. label?: StockToolsGuiDefinitionsSimpleShapesLabelOptions;
  113069. rectangle?: StockToolsGuiDefinitionsSimpleShapesRectangleOptions;
  113070. }
  113071. export interface StockToolsGuiDefinitionsSimpleShapesRectangleOptions {
  113072. /**
  113073. * (Highstock) A predefined background symbol for the button.
  113074. */
  113075. symbol?: string;
  113076. }
  113077. export interface StockToolsGuiDefinitionsToggleAnnotationsOptions {
  113078. /**
  113079. * (Highstock) A predefined background symbol for the button.
  113080. */
  113081. symbol?: string;
  113082. }
  113083. export interface StockToolsGuiDefinitionsTypeChangeOptions {
  113084. /**
  113085. * (Highstock) A collection of strings pointing to config options for the
  113086. * items.
  113087. */
  113088. items?: any[];
  113089. typeCandlestick?: StockToolsGuiDefinitionsTypeChangeTypeCandlestickOptions;
  113090. typeLine?: StockToolsGuiDefinitionsTypeChangeTypeLineOptions;
  113091. typeOHLC?: StockToolsGuiDefinitionsTypeChangeTypeOHLCOptions;
  113092. }
  113093. export interface StockToolsGuiDefinitionsTypeChangeTypeCandlestickOptions {
  113094. /**
  113095. * (Highstock) A predefined background symbol for the button.
  113096. */
  113097. symbol?: string;
  113098. }
  113099. export interface StockToolsGuiDefinitionsTypeChangeTypeLineOptions {
  113100. /**
  113101. * (Highstock) A predefined background symbol for the button.
  113102. */
  113103. symbol?: string;
  113104. }
  113105. export interface StockToolsGuiDefinitionsTypeChangeTypeOHLCOptions {
  113106. /**
  113107. * (Highstock) A predefined background symbol for the button.
  113108. */
  113109. symbol?: string;
  113110. }
  113111. export interface StockToolsGuiDefinitionsVerticalLabelsOptions {
  113112. /**
  113113. * (Highstock) A collection of strings pointing to config options for the
  113114. * items.
  113115. */
  113116. items?: any[];
  113117. verticalArrow?: StockToolsGuiDefinitionsVerticalLabelsVerticalArrowOptions;
  113118. verticalCounter?: StockToolsGuiDefinitionsVerticalLabelsVerticalCounterOptions;
  113119. verticalLabel?: StockToolsGuiDefinitionsVerticalLabelsVerticalLabelOptions;
  113120. }
  113121. export interface StockToolsGuiDefinitionsVerticalLabelsVerticalArrowOptions {
  113122. /**
  113123. * (Highstock) A predefined background symbol for the button.
  113124. */
  113125. symbol?: string;
  113126. }
  113127. export interface StockToolsGuiDefinitionsVerticalLabelsVerticalCounterOptions {
  113128. /**
  113129. * (Highstock) A predefined background symbol for the button.
  113130. */
  113131. symbol?: string;
  113132. }
  113133. export interface StockToolsGuiDefinitionsVerticalLabelsVerticalLabelOptions {
  113134. /**
  113135. * (Highstock) A predefined background symbol for the button.
  113136. */
  113137. symbol?: string;
  113138. }
  113139. export interface StockToolsGuiDefinitionsZoomChangeOptions {
  113140. /**
  113141. * (Highstock) A collection of strings pointing to config options for the
  113142. * items.
  113143. */
  113144. items?: any[];
  113145. zoomX?: StockToolsGuiDefinitionsZoomChangeZoomXOptions;
  113146. zoomXY?: StockToolsGuiDefinitionsZoomChangeZoomXYOptions;
  113147. zoomY?: StockToolsGuiDefinitionsZoomChangeZoomYOptions;
  113148. }
  113149. export interface StockToolsGuiDefinitionsZoomChangeZoomXOptions {
  113150. /**
  113151. * (Highstock) A predefined background symbol for the button.
  113152. */
  113153. symbol?: string;
  113154. }
  113155. export interface StockToolsGuiDefinitionsZoomChangeZoomXYOptions {
  113156. /**
  113157. * (Highstock) A predefined background symbol for the button.
  113158. */
  113159. symbol?: string;
  113160. }
  113161. export interface StockToolsGuiDefinitionsZoomChangeZoomYOptions {
  113162. /**
  113163. * (Highstock) A predefined background symbol for the button.
  113164. */
  113165. symbol?: string;
  113166. }
  113167. /**
  113168. * (Highstock) Definitions of buttons in Stock Tools GUI.
  113169. */
  113170. export interface StockToolsGuiOptions {
  113171. /**
  113172. * (Highstock) A collection of strings pointing to config options for the
  113173. * toolbar items. Each name refers to a unique key from the definitions
  113174. * object.
  113175. */
  113176. buttons?: Array<string>;
  113177. /**
  113178. * (Highstock) A CSS class name to apply to the stocktools' div, allowing
  113179. * unique CSS styling for each chart.
  113180. */
  113181. className?: string;
  113182. /**
  113183. * (Highstock) An options object of the buttons definitions. Each name
  113184. * refers to unique key from buttons array.
  113185. */
  113186. definitions?: StockToolsGuiDefinitionsOptions;
  113187. /**
  113188. * (Highstock) Enable or disable the stockTools gui.
  113189. */
  113190. enabled?: boolean;
  113191. /**
  113192. * (Highstock) A CSS class name to apply to the container of buttons,
  113193. * allowing unique CSS styling for each chart.
  113194. */
  113195. toolbarClassName?: string;
  113196. }
  113197. /**
  113198. * (Highstock) Configure the stockTools gui strings in the chart. Requires the
  113199. * [stockTools module]() to be loaded. For a description of the module and
  113200. * information on its features, see [Highcharts StockTools]().
  113201. */
  113202. export interface StockToolsOptions {
  113203. /**
  113204. * (Highstock) Definitions of buttons in Stock Tools GUI.
  113205. */
  113206. gui?: StockToolsGuiOptions;
  113207. }
  113208. /**
  113209. * The chart subtitle. The subtitle has an `update` method that allows modifying
  113210. * the options directly or indirectly via `chart.update`.
  113211. */
  113212. export interface SubtitleObject extends SVGElement {
  113213. /**
  113214. * Modify options for the subtitle.
  113215. *
  113216. * @param subtitleOptions
  113217. * Options to modify.
  113218. *
  113219. * @param redraw
  113220. * Whether to redraw the chart after the subtitle is altered. If
  113221. * doing more operations on the chart, it is a good idea to set
  113222. * redraw to false and call Chart#redraw after.
  113223. */
  113224. update(subtitleOptions: SubtitleOptions, redraw?: boolean): void;
  113225. }
  113226. /**
  113227. * (Highcharts, Highstock, Highmaps, Gantt) The chart's subtitle. This can be
  113228. * used both to display a subtitle below the main title, and to display random
  113229. * text anywhere in the chart. The subtitle can be updated after chart
  113230. * initialization through the `Chart.setTitle` method.
  113231. */
  113232. export interface SubtitleOptions {
  113233. /**
  113234. * (Highcharts, Highstock, Highmaps, Gantt) The horizontal alignment of the
  113235. * subtitle. Can be one of "left", "center" and "right".
  113236. */
  113237. align?: AlignValue;
  113238. /**
  113239. * (Highcharts, Highstock, Highmaps, Gantt) When the subtitle is floating,
  113240. * the plot area will not move to make space for it.
  113241. */
  113242. floating?: boolean;
  113243. /**
  113244. * (Highcharts, Highstock, Highmaps, Gantt) CSS styles for the title.
  113245. *
  113246. * In styled mode, the subtitle style is given in the `.highcharts-subtitle`
  113247. * class.
  113248. */
  113249. style?: CSSObject;
  113250. /**
  113251. * (Highcharts, Highstock, Highmaps, Gantt) The subtitle of the chart.
  113252. */
  113253. text?: string;
  113254. /**
  113255. * (Highcharts, Highstock, Highmaps, Gantt) Whether to use HTML to render
  113256. * the text.
  113257. */
  113258. useHTML?: boolean;
  113259. /**
  113260. * (Highcharts, Highstock, Highmaps, Gantt) The vertical alignment of the
  113261. * title. Can be one of `"top"`, `"middle"` and `"bottom"`. When middle, the
  113262. * subtitle behaves as floating.
  113263. */
  113264. verticalAlign?: VerticalAlignValue;
  113265. /**
  113266. * (Highcharts, Highstock, Highmaps, Gantt) Adjustment made to the subtitle
  113267. * width, normally to reserve space for the exporting burger menu.
  113268. */
  113269. widthAdjust?: number;
  113270. /**
  113271. * (Highcharts, Highstock, Highmaps, Gantt) The x position of the subtitle
  113272. * relative to the alignment within `chart.spacingLeft` and
  113273. * `chart.spacingRight`.
  113274. */
  113275. x?: number;
  113276. /**
  113277. * (Highcharts, Highstock, Highmaps, Gantt) The y position of the subtitle
  113278. * relative to the alignment within `chart.spacingTop` and
  113279. * `chart.spacingBottom`. By default the subtitle is laid out below the
  113280. * title unless the title is floating.
  113281. */
  113282. y?: number;
  113283. }
  113284. /**
  113285. * An object of key-value pairs for SVG attributes. Attributes in Highcharts
  113286. * elements for the most parts correspond to SVG, but some are specific to
  113287. * Highcharts, like `zIndex`, `rotation`, `rotationOriginX`, `rotationOriginY`,
  113288. * `translateX`, `translateY`, `scaleX` and `scaleY`. SVG attributes containing
  113289. * a hyphen are _not_ camel-cased, they should be quoted to preserve the hyphen.
  113290. */
  113291. export interface SVGAttributes {
  113292. [key: string]: any;
  113293. d?: (string|SVGPathArray);
  113294. fill?: (ColorString|GradientColorObject|PatternObject);
  113295. inverted?: boolean;
  113296. matrix?: Array<number>;
  113297. rotation?: number;
  113298. rotationOriginX?: number;
  113299. rotationOriginY?: number;
  113300. scaleX?: number;
  113301. scaleY?: number;
  113302. stroke?: (ColorString|GradientColorObject|PatternObject);
  113303. style?: (string|CSSObject);
  113304. translateX?: number;
  113305. translateY?: number;
  113306. zIndex?: number;
  113307. }
  113308. /**
  113309. * An extendable collection of functions for defining symbol paths. Symbols are
  113310. * used internally for point markers, button and label borders and backgrounds,
  113311. * or custom shapes. Extendable by adding to SVGRenderer#symbols.
  113312. */
  113313. export interface SymbolDictionary {
  113314. [key: string]: (Function|undefined);
  113315. arc?: Function;
  113316. callout?: Function;
  113317. circle?: Function;
  113318. diamond?: Function;
  113319. square?: Function;
  113320. triangle?: Function;
  113321. }
  113322. /**
  113323. * Additional options, depending on the actual symbol drawn.
  113324. */
  113325. export interface SymbolOptionsObject {
  113326. /**
  113327. * The anchor X position for the `callout` symbol. This is where the chevron
  113328. * points to.
  113329. */
  113330. anchorX?: number;
  113331. /**
  113332. * The anchor Y position for the `callout` symbol. This is where the chevron
  113333. * points to.
  113334. */
  113335. anchorY?: number;
  113336. /**
  113337. * The end angle of an `arc` symbol.
  113338. */
  113339. end?: number;
  113340. /**
  113341. * Whether to draw `arc` symbol open or closed.
  113342. */
  113343. open?: boolean;
  113344. /**
  113345. * The radius of an `arc` symbol, or the border radius for the `callout`
  113346. * symbol.
  113347. */
  113348. r?: number;
  113349. /**
  113350. * The start angle of an `arc` symbol.
  113351. */
  113352. start?: number;
  113353. }
  113354. export interface TimelineDataLabelsFormatterContextObject extends PointLabelObject {
  113355. key?: string;
  113356. point: Point;
  113357. series: Series;
  113358. }
  113359. /**
  113360. * (Highcharts, Highstock, Highmaps, Gantt) Options for the series data labels,
  113361. * appearing next to each data point.
  113362. *
  113363. * Since v6.2.0, multiple data labels can be applied to each single point by
  113364. * defining them as an array of configs.
  113365. *
  113366. * In styled mode, the data labels can be styled with the
  113367. * `.highcharts-data-label-box` and `.highcharts-data-label` class names (see
  113368. * example).
  113369. */
  113370. export interface TimelineDataLabelsOptionsObject {
  113371. /**
  113372. * (Highcharts, Highstock, Highmaps, Gantt) The alignment of the data label
  113373. * compared to the point. If `right`, the right side of the label should be
  113374. * touching the point. For points with an extent, like columns, the
  113375. * alignments also dictates how to align it inside the box, as given with
  113376. * the inside option. Can be one of `left`, `center` or `right`.
  113377. */
  113378. align?: (AlignValue|null);
  113379. /**
  113380. * (Highcharts, Highstock, Highmaps, Gantt) Whether to allow data labels to
  113381. * overlap. To make the labels less sensitive for overlapping, the
  113382. * dataLabels.padding can be set to 0.
  113383. */
  113384. allowOverlap?: boolean;
  113385. /**
  113386. * (Highcharts, Highstock, Highmaps, Gantt) Whether to position data labels
  113387. * alternately. For example, if distance is set equal to `100`, then data
  113388. * labels will be positioned alternately (on both sides of the point) at a
  113389. * distance of 100px.
  113390. */
  113391. alternate?: boolean;
  113392. /**
  113393. * (Highcharts, Highstock, Highmaps, Gantt) Enable or disable the initial
  113394. * animation when a series is displayed for the `dataLabels`. The animation
  113395. * can also be set as a configuration object. Please note that this option
  113396. * only applies to the initial animation. For other animations, see
  113397. * chart.animation and the animation parameter under the API methods. The
  113398. * following properties are supported:
  113399. *
  113400. * - `defer`: The animation delay time in milliseconds.
  113401. */
  113402. animation?: (boolean|PlotTimelineDataLabelsAnimationOptions|Partial<AnimationOptionsObject>);
  113403. /**
  113404. * (Highcharts, Highstock, Highmaps, Gantt) The background color or gradient
  113405. * for the data label.
  113406. */
  113407. backgroundColor?: string;
  113408. /**
  113409. * (Highcharts, Highstock, Highmaps, Gantt) The border color for the data
  113410. * label. Defaults to `undefined`.
  113411. */
  113412. borderColor?: string;
  113413. /**
  113414. * (Highcharts, Highstock, Highmaps, Gantt) The border radius in pixels for
  113415. * the data label.
  113416. */
  113417. borderRadius?: number;
  113418. /**
  113419. * (Highcharts, Highstock, Highmaps, Gantt) The border width in pixels for
  113420. * the data label.
  113421. */
  113422. borderWidth?: number;
  113423. /**
  113424. * (Highcharts, Highstock, Highmaps, Gantt) A class name for the data label.
  113425. * Particularly in styled mode, this can be used to give each series' or
  113426. * point's data label unique styling. In addition to this option, a default
  113427. * color class name is added so that we can give the labels a contrast text
  113428. * shadow.
  113429. */
  113430. className?: string;
  113431. /**
  113432. * (Highcharts, Highstock, Highmaps, Gantt) The text color for the data
  113433. * labels. Defaults to `undefined`. For certain series types, like column or
  113434. * map, the data labels can be drawn inside the points. In this case the
  113435. * data label will be drawn with maximum contrast by default. Additionally,
  113436. * it will be given a `text-outline` style with the opposite color, to
  113437. * further increase the contrast. This can be overridden by setting the
  113438. * `text-outline` style to `none` in the `dataLabels.style` option.
  113439. */
  113440. color?: string;
  113441. /**
  113442. * (Highcharts, Highstock, Highmaps, Gantt) The color of the line connecting
  113443. * the data label to the point. The default color is the same as the point's
  113444. * color.
  113445. *
  113446. * In styled mode, the connector stroke is given in the
  113447. * `.highcharts-data-label-connector` class.
  113448. */
  113449. connectorColor?: (ColorString|GradientColorObject|PatternObject);
  113450. /**
  113451. * (Highcharts, Highstock, Highmaps, Gantt) The width of the line connecting
  113452. * the data label to the point.
  113453. *
  113454. * In styled mode, the connector stroke width is given in the
  113455. * `.highcharts-data-label-connector` class.
  113456. */
  113457. connectorWidth?: number;
  113458. /**
  113459. * (Highcharts, Highstock, Highmaps, Gantt) Whether to hide data labels that
  113460. * are outside the plot area. By default, the data label is moved inside the
  113461. * plot area according to the overflow option.
  113462. */
  113463. crop?: boolean;
  113464. /**
  113465. * (Highcharts, Highstock, Gantt) Whether to defer displaying the data
  113466. * labels until the initial series animation has finished. Setting to
  113467. * `false` renders the data label immediately. If set to `true` inherits the
  113468. * defer time set in plotOptions.series.animation.
  113469. */
  113470. defer?: boolean;
  113471. /**
  113472. * (Highcharts, Highstock, Highmaps, Gantt) A pixel value defining the
  113473. * distance between the data label and the point. Negative numbers puts the
  113474. * label on top of the point.
  113475. */
  113476. distance?: number;
  113477. /**
  113478. * (Highcharts, Highstock, Highmaps, Gantt) Enable or disable the data
  113479. * labels.
  113480. */
  113481. enabled?: boolean;
  113482. /**
  113483. * (Highcharts, Highstock, Highmaps, Gantt) A declarative filter to control
  113484. * of which data labels to display. The declarative filter is designed for
  113485. * use when callback functions are not available, like when the chart
  113486. * options require a pure JSON structure or for use with graphical editors.
  113487. * For programmatic control, use the `formatter` instead, and return
  113488. * `undefined` to disable a single data label.
  113489. */
  113490. filter?: DataLabelsFilterOptionsObject;
  113491. /**
  113492. * (Highcharts, Highstock, Highmaps, Gantt) A format string for the data
  113493. * label. Available variables are the same as for `formatter`.
  113494. */
  113495. format?: string;
  113496. /**
  113497. * (Highcharts, Highstock, Highmaps, Gantt) Callback JavaScript function to
  113498. * format the data label. Note that if a `format` is defined, the format
  113499. * takes precedence and the formatter is ignored.
  113500. */
  113501. formatter?: TimelineDataLabelsFormatterCallbackFunction;
  113502. /**
  113503. * (Highcharts, Highstock, Highmaps, Gantt) For points with an extent, like
  113504. * columns or map areas, whether to align the data label inside the box or
  113505. * to the actual value point. Defaults to `false` in most cases, `true` in
  113506. * stacked columns.
  113507. */
  113508. inside?: boolean;
  113509. /**
  113510. * (Highcharts, Highstock, Highmaps, Gantt) Format for points with the value
  113511. * of null. Works analogously to format. `nullFormat` can be applied only to
  113512. * series which support displaying null points.
  113513. */
  113514. nullFormat?: (boolean|string);
  113515. /**
  113516. * (Highcharts, Highstock, Highmaps, Gantt) Callback JavaScript function
  113517. * that defines formatting for points with the value of null. Works
  113518. * analogously to formatter. `nullPointFormatter` can be applied only to
  113519. * series which support displaying null points.
  113520. */
  113521. nullFormatter?: DataLabelsFormatterCallbackFunction;
  113522. /**
  113523. * (Highcharts, Highstock, Highmaps, Gantt) How to handle data labels that
  113524. * flow outside the plot area. The default is `"justify"`, which aligns them
  113525. * inside the plot area. For columns and bars, this means it will be moved
  113526. * inside the bar. To display data labels outside the plot area, set `crop`
  113527. * to `false` and `overflow` to `"allow"`.
  113528. */
  113529. overflow?: DataLabelsOverflowValue;
  113530. /**
  113531. * (Highcharts, Highstock, Highmaps, Gantt) When either the `borderWidth` or
  113532. * the `backgroundColor` is set, this is the padding within the box.
  113533. */
  113534. padding?: number;
  113535. /**
  113536. * (Highcharts, Highstock, Highmaps, Gantt) Aligns data labels relative to
  113537. * points. If `center` alignment is not possible, it defaults to `right`.
  113538. */
  113539. position?: AlignValue;
  113540. /**
  113541. * (Highcharts, Highstock, Highmaps, Gantt) Text rotation in degrees. Note
  113542. * that due to a more complex structure, backgrounds, borders and padding
  113543. * will be lost on a rotated data label.
  113544. */
  113545. rotation?: number;
  113546. /**
  113547. * (Highcharts, Highstock, Highmaps, Gantt) Shadow options for the data
  113548. * label.
  113549. */
  113550. shadow?: (boolean|CSSObject);
  113551. /**
  113552. * (Highcharts, Highstock, Highmaps, Gantt) The name of a symbol to use for
  113553. * the border around the label. Symbols are predefined functions on the
  113554. * Renderer object.
  113555. */
  113556. shape?: string;
  113557. /**
  113558. * (Highcharts, Highstock, Highmaps, Gantt) Styles for the label. The
  113559. * default `color` setting is `"contrast"`, which is a pseudo color that
  113560. * Highcharts picks up and applies the maximum contrast to the underlying
  113561. * point item, for example the bar in a bar chart.
  113562. *
  113563. * The `textOutline` is a pseudo property that applies an outline of the
  113564. * given width with the given color, which by default is the maximum
  113565. * contrast to the text. So a bright text color will result in a black text
  113566. * outline for maximum readability on a mixed background. In some cases,
  113567. * especially with grayscale text, the text outline doesn't work well, in
  113568. * which cases it can be disabled by setting it to `"none"`. When `useHTML`
  113569. * is true, the `textOutline` will not be picked up. In this, case, the same
  113570. * effect can be acheived through the `text-shadow` CSS property.
  113571. *
  113572. * For some series types, where each point has an extent, like for example
  113573. * tree maps, the data label may overflow the point. There are two
  113574. * strategies for handling overflow. By default, the text will wrap to
  113575. * multiple lines. The other strategy is to set `style.textOverflow` to
  113576. * `ellipsis`, which will keep the text on one line plus it will break
  113577. * inside long words.
  113578. */
  113579. style?: CSSObject;
  113580. /**
  113581. * (Highcharts, Highstock, Highmaps, Gantt) Options for a label text which
  113582. * should follow marker's shape. Border and background are disabled for a
  113583. * label that follows a path.
  113584. *
  113585. * **Note:** Only SVG-based renderer supports this option. Setting `useHTML`
  113586. * to true will disable this option.
  113587. */
  113588. textPath?: DataLabelsTextPathOptionsObject;
  113589. /**
  113590. * (Highcharts, Highstock, Highmaps, Gantt) Whether to use HTML to render
  113591. * the labels.
  113592. */
  113593. useHTML?: boolean;
  113594. /**
  113595. * (Highcharts, Highstock, Highmaps, Gantt) The vertical alignment of a data
  113596. * label. Can be one of `top`, `middle` or `bottom`. The default value
  113597. * depends on the data, for instance in a column chart, the label is above
  113598. * positive values and below negative values.
  113599. */
  113600. verticalAlign?: (VerticalAlignValue|null);
  113601. width?: number;
  113602. /**
  113603. * (Highcharts, Highstock, Highmaps, Gantt) The x position offset of the
  113604. * label relative to the point in pixels.
  113605. */
  113606. x?: number;
  113607. /**
  113608. * (Highcharts, Highstock, Highmaps, Gantt) The y position offset of the
  113609. * label relative to the point in pixels.
  113610. */
  113611. y?: number;
  113612. /**
  113613. * (Highcharts, Highstock, Highmaps, Gantt) The Z index of the data labels.
  113614. * The default Z index puts it above the series. Use a Z index of 2 to
  113615. * display it behind the series.
  113616. */
  113617. z?: number;
  113618. }
  113619. /**
  113620. * Normalized interval.
  113621. */
  113622. export interface TimeNormalizedObject {
  113623. /**
  113624. * The count.
  113625. */
  113626. count: number;
  113627. /**
  113628. * The interval in axis values (ms).
  113629. */
  113630. unitRange: number;
  113631. }
  113632. /**
  113633. * (Highcharts, Highstock, Highmaps, Gantt) Time options that can apply globally
  113634. * or to individual charts. These settings affect how `datetime` axes are laid
  113635. * out, how tooltips are formatted, how series pointIntervalUnit works and how
  113636. * the Highstock range selector handles time.
  113637. *
  113638. * The common use case is that all charts in the same Highcharts object share
  113639. * the same time settings, in which case the global settings are set using
  113640. * `setOptions`. (see online documentation for example)
  113641. *
  113642. * Since v6.0.5, the time options were moved from the `global` obect to the
  113643. * `time` object, and time options can be set on each individual chart.
  113644. */
  113645. export interface TimeOptions {
  113646. /**
  113647. * (Highcharts, Highstock, Gantt) A custom `Date` class for advanced date
  113648. * handling. For example, JDate can be hooked in to handle Jalali dates.
  113649. */
  113650. Date?: any;
  113651. /**
  113652. * (Highcharts, Highstock, Gantt) A callback to return the time zone offset
  113653. * for a given datetime. It takes the timestamp in terms of milliseconds
  113654. * since January 1 1970, and returns the timezone offset in minutes. This
  113655. * provides a hook for drawing time based charts in specific time zones
  113656. * using their local DST crossover dates, with the help of external
  113657. * libraries.
  113658. */
  113659. getTimezoneOffset?: TimezoneOffsetCallbackFunction;
  113660. /**
  113661. * (Highcharts, Highstock, Highmaps, Gantt) Allows to manually load the
  113662. * `moment.js` library from Highcharts options instead of the `window`. In
  113663. * case of loading the library from a `script` tag, this option is not
  113664. * needed, it will be loaded from there by default.
  113665. */
  113666. moment?: Function;
  113667. /**
  113668. * (Highcharts, Highstock, Gantt) Requires moment.js. If the timezone option
  113669. * is specified, it creates a default getTimezoneOffset function that looks
  113670. * up the specified timezone in moment.js. If moment.js is not included,
  113671. * this throws a Highcharts error in the console, but does not crash the
  113672. * chart.
  113673. */
  113674. timezone?: string;
  113675. /**
  113676. * (Highcharts, Highstock, Gantt) The timezone offset in minutes. Positive
  113677. * values are west, negative values are east of UTC, as in the ECMAScript
  113678. * getTimezoneOffset method. Use this to display UTC based data in a
  113679. * predefined time zone.
  113680. */
  113681. timezoneOffset?: number;
  113682. /**
  113683. * (Highcharts, Highstock, Highmaps, Gantt) Whether to use UTC time for axis
  113684. * scaling, tickmark placement and time display in `Highcharts.dateFormat`.
  113685. * Advantages of using UTC is that the time displays equally regardless of
  113686. * the user agent's time zone settings. Local time can be used when the data
  113687. * is loaded in real time or when correct Daylight Saving Time transitions
  113688. * are required.
  113689. */
  113690. useUTC?: boolean;
  113691. }
  113692. /**
  113693. * Additonal time tick information.
  113694. */
  113695. export interface TimeTicksInfoObject extends TimeNormalizedObject {
  113696. higherRanks: Array<string>;
  113697. totalRange: number;
  113698. }
  113699. /**
  113700. * The chart title. The title has an `update` method that allows modifying the
  113701. * options directly or indirectly via `chart.update`.
  113702. */
  113703. export interface TitleObject extends SVGElement {
  113704. /**
  113705. * Modify options for the title.
  113706. *
  113707. * @param titleOptions
  113708. * Options to modify.
  113709. *
  113710. * @param redraw
  113711. * Whether to redraw the chart after the title is altered. If doing
  113712. * more operations on the chart, it is a good idea to set redraw to
  113713. * false and call Chart#redraw after.
  113714. */
  113715. update(titleOptions: TitleOptions, redraw?: boolean): void;
  113716. }
  113717. /**
  113718. * (Highcharts, Highstock, Highmaps, Gantt) The chart's main title.
  113719. */
  113720. export interface TitleOptions {
  113721. /**
  113722. * (Highcharts, Highstock, Highmaps, Gantt) The horizontal alignment of the
  113723. * title. Can be one of "left", "center" and "right".
  113724. */
  113725. align?: AlignValue;
  113726. /**
  113727. * (Highcharts, Highstock, Highmaps, Gantt) When the title is floating, the
  113728. * plot area will not move to make space for it.
  113729. */
  113730. floating?: boolean;
  113731. /**
  113732. * (Highcharts, Highstock, Highmaps, Gantt) The margin between the title and
  113733. * the plot area, or if a subtitle is present, the margin between the
  113734. * subtitle and the plot area.
  113735. */
  113736. margin?: number;
  113737. /**
  113738. * (Highcharts, Highstock, Highmaps, Gantt) CSS styles for the title. Use
  113739. * this for font styling, but use `align`, `x` and `y` for text alignment.
  113740. *
  113741. * In styled mode, the title style is given in the `.highcharts-title`
  113742. * class.
  113743. */
  113744. style?: CSSObject;
  113745. /**
  113746. * (Highcharts, Highstock, Highmaps, Gantt) The title of the chart. To
  113747. * disable the title, set the `text` to `undefined`.
  113748. */
  113749. text?: string;
  113750. /**
  113751. * (Highcharts, Highstock, Highmaps, Gantt) Whether to use HTML to render
  113752. * the text.
  113753. */
  113754. useHTML?: boolean;
  113755. /**
  113756. * (Highcharts, Highstock, Highmaps, Gantt) The vertical alignment of the
  113757. * title. Can be one of `"top"`, `"middle"` and `"bottom"`. When a value is
  113758. * given, the title behaves as if floating were `true`.
  113759. */
  113760. verticalAlign?: VerticalAlignValue;
  113761. /**
  113762. * (Highcharts, Highstock, Highmaps, Gantt) Adjustment made to the title
  113763. * width, normally to reserve space for the exporting burger menu.
  113764. */
  113765. widthAdjust?: number;
  113766. /**
  113767. * (Highcharts, Highstock, Highmaps, Gantt) The x position of the title
  113768. * relative to the alignment within `chart.spacingLeft` and
  113769. * `chart.spacingRight`.
  113770. */
  113771. x?: number;
  113772. /**
  113773. * (Highcharts, Highstock, Highmaps, Gantt) The y position of the title
  113774. * relative to the alignment within chart.spacingTop and
  113775. * chart.spacingBottom. By default it depends on the font size.
  113776. */
  113777. y?: number;
  113778. }
  113779. export interface TooltipFormatterContextObject {
  113780. color: (ColorString|GradientColorObject|PatternObject);
  113781. colorIndex?: number;
  113782. key: number;
  113783. percentage?: number;
  113784. point: Point;
  113785. points?: Array<TooltipFormatterContextObject>;
  113786. series: Series;
  113787. total?: number;
  113788. x: number;
  113789. y: number;
  113790. }
  113791. /**
  113792. * (Highcharts, Highstock, Highmaps, Gantt) Options for the tooltip that appears
  113793. * when the user hovers over a series or point.
  113794. */
  113795. export interface TooltipOptions {
  113796. /**
  113797. * (Highcharts, Highstock, Highmaps, Gantt) Enable or disable animation of
  113798. * the tooltip.
  113799. */
  113800. animation?: boolean;
  113801. /**
  113802. * (Highcharts, Highstock, Highmaps, Gantt) The background color or gradient
  113803. * for the tooltip.
  113804. *
  113805. * In styled mode, the stroke width is set in the `.highcharts-tooltip-box`
  113806. * class.
  113807. */
  113808. backgroundColor?: (ColorString|GradientColorObject|PatternObject);
  113809. /**
  113810. * (Highcharts, Highstock, Highmaps, Gantt) The color of the tooltip border.
  113811. * When `undefined`, the border takes the color of the corresponding series
  113812. * or point.
  113813. */
  113814. borderColor?: (ColorString|GradientColorObject|PatternObject);
  113815. /**
  113816. * (Highcharts, Highstock, Highmaps, Gantt) The radius of the rounded border
  113817. * corners.
  113818. */
  113819. borderRadius?: number;
  113820. /**
  113821. * (Highcharts, Highstock, Highmaps, Gantt) The pixel width of the tooltip
  113822. * border.
  113823. *
  113824. * In styled mode, the stroke width is set in the `.highcharts-tooltip-box`
  113825. * class.
  113826. */
  113827. borderWidth?: number;
  113828. /**
  113829. * (Highstock) How many decimals to show for the `point.change` value when
  113830. * the `series.compare` option is set. This is overridable in each series'
  113831. * tooltip options object. The default is to preserve all decimals.
  113832. */
  113833. changeDecimals?: number;
  113834. /**
  113835. * (Highcharts, Highstock, Highmaps, Gantt) A CSS class name to apply to the
  113836. * tooltip's container div, allowing unique CSS styling for each chart.
  113837. */
  113838. className?: string;
  113839. /**
  113840. * (Highcharts, Highstock, Highmaps, Gantt) The HTML of the cluster point's
  113841. * in the tooltip. Works only with marker-clusters module and analogously to
  113842. * pointFormat.
  113843. *
  113844. * The cluster tooltip can be also formatted using `tooltip.formatter`
  113845. * callback function and `point.isCluster` flag.
  113846. */
  113847. clusterFormat?: object;
  113848. /**
  113849. * (Highcharts, Highstock, Gantt) For series on datetime axes, the date
  113850. * format in the tooltip's header will by default be guessed based on the
  113851. * closest data points. This member gives the default string representations
  113852. * used for each unit. For an overview of the replacement codes, see
  113853. * dateFormat.
  113854. */
  113855. dateTimeLabelFormats?: Dictionary<string>;
  113856. /**
  113857. * (Highcharts, Highstock, Highmaps, Gantt) Distance from point to tooltip
  113858. * in pixels.
  113859. */
  113860. distance?: number;
  113861. /**
  113862. * (Highcharts, Highstock, Highmaps, Gantt) Enable or disable the tooltip.
  113863. */
  113864. enabled?: boolean;
  113865. /**
  113866. * (Highcharts, Highstock, Highmaps, Gantt) Whether the tooltip should
  113867. * follow the mouse as it moves across columns, pie slices and other point
  113868. * types with an extent. By default it behaves this way for pie, polygon,
  113869. * map, sankey and wordcloud series by override in the `plotOptions` for
  113870. * those series types.
  113871. *
  113872. * For touch moves to behave the same way, followTouchMove must be `true`
  113873. * also.
  113874. */
  113875. followPointer?: boolean;
  113876. /**
  113877. * (Highcharts, Highstock, Highmaps, Gantt) Whether the tooltip should
  113878. * update as the finger moves on a touch device. If this is `true` and
  113879. * chart.panning is set,`followTouchMove` will take over one-finger touches,
  113880. * so the user needs to use two fingers for zooming and panning.
  113881. *
  113882. * Note the difference to followPointer that only defines the _position_ of
  113883. * the tooltip. If `followPointer` is false in for example a column series,
  113884. * the tooltip will show above or below the column, but as `followTouchMove`
  113885. * is true, the tooltip will jump from column to column as the user swipes
  113886. * across the plot area.
  113887. */
  113888. followTouchMove?: boolean;
  113889. /**
  113890. * (Highcharts, Highstock, Highmaps, Gantt) A string to append to the
  113891. * tooltip format.
  113892. */
  113893. footerFormat?: string;
  113894. /**
  113895. * (Highcharts, Highstock, Highmaps, Gantt) Callback function to format the
  113896. * text of the tooltip from scratch. In case of single or shared tooltips, a
  113897. * string should be returned. In case of split tooltips, it should return an
  113898. * array where the first item is the header, and subsequent items are mapped
  113899. * to the points. Return `false` to disable tooltip for a specific point on
  113900. * series.
  113901. *
  113902. * A subset of HTML is supported. Unless `useHTML` is true, the HTML of the
  113903. * tooltip is parsed and converted to SVG, therefore this isn't a complete
  113904. * HTML renderer. The following HTML tags are supported: `b`, `br`, `em`,
  113905. * `i`, `span`, `strong`. Spans can be styled with a `style` attribute, but
  113906. * only text-related CSS, that is shared with SVG, is handled.
  113907. *
  113908. * The available data in the formatter differ a bit depending on whether the
  113909. * tooltip is shared or split, or belongs to a single point. In a
  113910. * shared/split tooltip, all properties except `x`, which is common for all
  113911. * points, are kept in an array, `this.points`.
  113912. *
  113913. * Available data are:
  113914. *
  113915. * - **this.percentage (not shared) /** **this.points[i].percentage
  113916. * (shared)**: Stacked series and pies only. The point's percentage of the
  113917. * total.
  113918. *
  113919. * - **this.point (not shared) / this.points[i].point (shared)**: The point
  113920. * object. The point name, if defined, is available through
  113921. * `this.point.name`.
  113922. *
  113923. * - **this.points**: In a shared tooltip, this is an array containing all
  113924. * other properties for each point.
  113925. *
  113926. * - **this.series (not shared) / this.points[i].series (shared)**: The
  113927. * series object. The series name is available through `this.series.name`.
  113928. *
  113929. * - **this.total (not shared) / this.points[i].total (shared)**: Stacked
  113930. * series only. The total value at this point's x value.
  113931. *
  113932. * - **this.x**: The x value. This property is the same regardless of the
  113933. * tooltip being shared or not.
  113934. *
  113935. * - **this.y (not shared) / this.points[i].y (shared)**: The y value.
  113936. */
  113937. formatter?: TooltipFormatterCallbackFunction;
  113938. /**
  113939. * (Highcharts, Highstock, Highmaps, Gantt) The HTML of the tooltip header
  113940. * line. Variables are enclosed by curly brackets. Available variables are
  113941. * `point.key`, `series.name`, `series.color` and other members from the
  113942. * `point` and `series` objects. The `point.key` variable contains the
  113943. * category name, x value or datetime string depending on the type of axis.
  113944. * For datetime axes, the `point.key` date format can be set using
  113945. * `tooltip.xDateFormat`.
  113946. */
  113947. headerFormat?: string;
  113948. /**
  113949. * (Highcharts, Highstock, Highmaps, Gantt) The name of a symbol to use for
  113950. * the border around the tooltip header. Applies only when tooltip.split is
  113951. * enabled.
  113952. *
  113953. * Custom callbacks for symbol path generation can also be added to
  113954. * `Highcharts.SVGRenderer.prototype.symbols` the same way as for
  113955. * series.marker.symbol.
  113956. */
  113957. headerShape?: OptionsHeaderShapeValue;
  113958. /**
  113959. * (Highcharts, Highstock, Highmaps, Gantt) The number of milliseconds to
  113960. * wait until the tooltip is hidden when mouse out from a point or chart.
  113961. */
  113962. hideDelay?: number;
  113963. /**
  113964. * (Highcharts, Highstock, Highmaps, Gantt) The HTML of the null point's
  113965. * line in the tooltip. Works analogously to pointFormat.
  113966. */
  113967. nullFormat?: string;
  113968. /**
  113969. * (Highcharts, Highstock, Highmaps, Gantt) Callback function to format the
  113970. * text of the tooltip for visible null points. Works analogously to
  113971. * formatter.
  113972. */
  113973. nullFormatter?: TooltipFormatterCallbackFunction;
  113974. /**
  113975. * (Highcharts, Highstock, Highmaps, Gantt) Whether to allow the tooltip to
  113976. * render outside the chart's SVG element box. By default (`false`), the
  113977. * tooltip is rendered within the chart's SVG element, which results in the
  113978. * tooltip being aligned inside the chart area. For small charts, this may
  113979. * result in clipping or overlapping. When `true`, a separate SVG element is
  113980. * created and overlaid on the page, allowing the tooltip to be aligned
  113981. * inside the page itself.
  113982. *
  113983. * Defaults to `true` if `chart.scrollablePlotArea` is activated, otherwise
  113984. * `false`.
  113985. */
  113986. outside?: (boolean|undefined);
  113987. /**
  113988. * (Highcharts, Highstock, Highmaps, Gantt) Padding inside the tooltip, in
  113989. * pixels.
  113990. */
  113991. padding?: number;
  113992. /**
  113993. * (Highcharts, Highstock, Highmaps, Gantt) The HTML of the point's line in
  113994. * the tooltip. Variables are enclosed by curly brackets. Available
  113995. * variables are `point.x`, `point.y`, `series.name` and `series.color` and
  113996. * other properties on the same form. Furthermore, `point.y` can be extended
  113997. * by the `tooltip.valuePrefix` and `tooltip.valueSuffix` variables. This
  113998. * can also be overridden for each series, which makes it a good hook for
  113999. * displaying units.
  114000. *
  114001. * In styled mode, the dot is colored by a class name rather than the point
  114002. * color.
  114003. */
  114004. pointFormat?: string;
  114005. /**
  114006. * (Highcharts, Highstock, Highmaps, Gantt) A callback function for
  114007. * formatting the HTML output for a single point in the tooltip. Like the
  114008. * `pointFormat` string, but with more flexibility.
  114009. */
  114010. pointFormatter?: FormatterCallbackFunction<Point>;
  114011. /**
  114012. * (Highcharts, Highstock, Highmaps, Gantt) A callback function to place the
  114013. * tooltip in a default position. The callback receives three parameters:
  114014. * `labelWidth`, `labelHeight` and `point`, where point contains values for
  114015. * `plotX` and `plotY` telling where the reference point is in the plot
  114016. * area. Add `chart.plotLeft` and `chart.plotTop` to get the full
  114017. * coordinates.
  114018. *
  114019. * Since v7, when tooltip.split option is enabled, positioner is called for
  114020. * each of the boxes separately, including xAxis header. xAxis header is not
  114021. * a point, instead `point` argument contains info: `{ plotX: Number, plotY:
  114022. * Number, isHeader: Boolean }`
  114023. *
  114024. * The return should be an object containing x and y values, for example `{
  114025. * x: 100, y: 100 }`.
  114026. */
  114027. positioner?: TooltipPositionerCallbackFunction;
  114028. /**
  114029. * (Highcharts, Highstock, Highmaps, Gantt) Whether to apply a drop shadow
  114030. * to the tooltip.
  114031. */
  114032. shadow?: (boolean|ShadowOptionsObject);
  114033. /**
  114034. * (Highcharts, Highstock, Highmaps, Gantt) The name of a symbol to use for
  114035. * the border around the tooltip. Can be one of: `"callout"`, `"circle"`, or
  114036. * `"square"`. When tooltip.split option is enabled, shape is applied to all
  114037. * boxes except header, which is controlled by tooltip.headerShape.
  114038. *
  114039. * Custom callbacks for symbol path generation can also be added to
  114040. * `Highcharts.SVGRenderer.prototype.symbols` the same way as for
  114041. * series.marker.symbol.
  114042. */
  114043. shape?: TooltipShapeValue;
  114044. /**
  114045. * (Highcharts, Highstock) When the tooltip is shared, the entire plot area
  114046. * will capture mouse movement or touch events. Tooltip texts for series
  114047. * types with ordered data (not pie, scatter, flags etc) will be shown in a
  114048. * single bubble. This is recommended for single series charts and for
  114049. * tablet/mobile optimized charts.
  114050. *
  114051. * See also tooltip.split, that is better suited for charts with many
  114052. * series, especially line-type series. The `tooltip.split` option takes
  114053. * precedence over `tooltip.shared`.
  114054. */
  114055. shared?: boolean;
  114056. /**
  114057. * (Highcharts, Highstock) Proximity snap for graphs or single points. It
  114058. * defaults to 10 for mouse-powered devices and 25 for touch devices.
  114059. *
  114060. * Note that in most cases the whole plot area captures the mouse movement,
  114061. * and in these cases `tooltip.snap` doesn't make sense. This applies when
  114062. * stickyTracking is `true` (default) and when the tooltip is shared or
  114063. * split.
  114064. */
  114065. snap?: number;
  114066. /**
  114067. * (Highcharts, Highstock) Split the tooltip into one label per series, with
  114068. * the header close to the axis. This is recommended over shared tooltips
  114069. * for charts with multiple line series, generally making them easier to
  114070. * read. This option takes precedence over `tooltip.shared`.
  114071. */
  114072. split?: boolean;
  114073. /**
  114074. * (Highcharts, Highstock, Highmaps, Gantt) Prevents the tooltip from
  114075. * switching or closing, when touched or pointed.
  114076. */
  114077. stickOnContact?: boolean;
  114078. /**
  114079. * (Highcharts, Highstock, Highmaps, Gantt) CSS styles for the tooltip. The
  114080. * tooltip can also be styled through the CSS class `.highcharts-tooltip`.
  114081. *
  114082. * Note that the default `pointerEvents` style makes the tooltip ignore
  114083. * mouse events, so in order to use clickable tooltips, this value must be
  114084. * set to `auto`.
  114085. */
  114086. style?: CSSObject;
  114087. /**
  114088. * (Highcharts, Highstock, Highmaps, Gantt) Use HTML to render the contents
  114089. * of the tooltip instead of SVG. Using HTML allows advanced formatting like
  114090. * tables and images in the tooltip. It is also recommended for rtl
  114091. * languages as it works around rtl bugs in early Firefox.
  114092. */
  114093. useHTML?: boolean;
  114094. /**
  114095. * (Highcharts, Highstock, Highmaps, Gantt) How many decimals to show in
  114096. * each series' y value. This is overridable in each series' tooltip options
  114097. * object. The default is to preserve all decimals.
  114098. */
  114099. valueDecimals?: number;
  114100. /**
  114101. * (Highcharts, Highstock, Highmaps, Gantt) A string to prepend to each
  114102. * series' y value. Overridable in each series' tooltip options object.
  114103. */
  114104. valuePrefix?: string;
  114105. /**
  114106. * (Highcharts, Highstock, Highmaps, Gantt) A string to append to each
  114107. * series' y value. Overridable in each series' tooltip options object.
  114108. */
  114109. valueSuffix?: string;
  114110. /**
  114111. * (Highcharts, Highstock, Gantt) The format for the date in the tooltip
  114112. * header if the X axis is a datetime axis. The default is a best guess
  114113. * based on the smallest distance between points in the chart.
  114114. */
  114115. xDateFormat?: string;
  114116. }
  114117. /**
  114118. * Point information for positioning a tooltip.
  114119. */
  114120. export interface TooltipPositionerPointObject extends Point {
  114121. /**
  114122. * If `tooltip.split` option is enabled and positioner is called for each of
  114123. * the boxes separately, this property indicates the call on the xAxis
  114124. * header, which is not a point itself.
  114125. */
  114126. isHeader: boolean;
  114127. /**
  114128. * The reference point relative to the plot area. Add chart.plotLeft to get
  114129. * the full coordinates.
  114130. */
  114131. plotX: number;
  114132. /**
  114133. * The reference point relative to the plot area. Add chart.plotTop to get
  114134. * the full coordinates.
  114135. */
  114136. plotY: number;
  114137. }
  114138. /**
  114139. * (Highcharts, Highstock, Gantt) An array defining breaks in the axis, the
  114140. * sections defined will be left out and all the points shifted closer to each
  114141. * other.
  114142. */
  114143. export interface XAxisBreaksOptions {
  114144. /**
  114145. * (Highcharts, Highstock, Gantt) A number indicating how much space should
  114146. * be left between the start and the end of the break. The break size is
  114147. * given in axis units, so for instance on a `datetime` axis, a break size
  114148. * of 3600000 would indicate the equivalent of an hour.
  114149. */
  114150. breakSize?: number;
  114151. /**
  114152. * (Highcharts, Highstock, Gantt) The point where the break starts.
  114153. */
  114154. from?: number;
  114155. /**
  114156. * (Highcharts, Highstock, Gantt) Defines an interval after which the break
  114157. * appears again. By default the breaks do not repeat.
  114158. */
  114159. repeat?: number;
  114160. /**
  114161. * (Highcharts, Highstock, Gantt) The point where the break ends.
  114162. */
  114163. to?: number;
  114164. }
  114165. /**
  114166. * (Gantt) An object defining mouse events for the plot line. Supported
  114167. * properties are `click`, `mouseover`, `mouseout`, `mousemove`.
  114168. */
  114169. export interface XAxisCurrentDateIndicatorEventsOptions {
  114170. /**
  114171. * (Gantt) Click event on a plot band.
  114172. */
  114173. click?: EventCallbackFunction<PlotLineOrBand>;
  114174. /**
  114175. * (Gantt) Mouse move event on a plot band.
  114176. */
  114177. mousemove?: EventCallbackFunction<PlotLineOrBand>;
  114178. /**
  114179. * (Gantt) Mouse out event on the corner of a plot band.
  114180. */
  114181. mouseout?: EventCallbackFunction<PlotLineOrBand>;
  114182. /**
  114183. * (Gantt) Mouse over event on a plot band.
  114184. */
  114185. mouseover?: EventCallbackFunction<PlotLineOrBand>;
  114186. }
  114187. /**
  114188. * (Gantt) Text labels for the plot bands
  114189. */
  114190. export interface XAxisCurrentDateIndicatorLabelOptions {
  114191. /**
  114192. * (Gantt) Horizontal alignment of the label. Can be one of "left", "center"
  114193. * or "right".
  114194. */
  114195. align?: AlignValue;
  114196. /**
  114197. * (Gantt) Format of the label. This options is passed as the fist argument
  114198. * to dateFormat function.
  114199. */
  114200. format?: string;
  114201. /**
  114202. * (Gantt) Callback JavaScript function to format the label. Useful
  114203. * properties like the value of plot line or the range of plot band (`from`
  114204. * & `to` properties) can be found in `this.options` object.
  114205. */
  114206. formatter?: FormatterCallbackFunction<PlotLineOrBand>;
  114207. /**
  114208. * (Gantt) Rotation of the text label in degrees. Defaults to 0 for
  114209. * horizontal plot lines and 90 for vertical lines.
  114210. */
  114211. rotation?: number;
  114212. /**
  114213. * (Gantt) CSS styles for the text label.
  114214. *
  114215. * In styled mode, the labels are styled by the
  114216. * `.highcharts-plot-line-label` class.
  114217. */
  114218. style?: CSSObject;
  114219. /**
  114220. * (Gantt) The text itself. A subset of HTML is supported.
  114221. */
  114222. text?: string;
  114223. /**
  114224. * (Gantt) The text alignment for the label. While `align` determines where
  114225. * the texts anchor point is placed within the plot band, `textAlign`
  114226. * determines how the text is aligned against its anchor point. Possible
  114227. * values are "left", "center" and "right". Defaults to the same as the
  114228. * `align` option.
  114229. */
  114230. textAlign?: AlignValue;
  114231. /**
  114232. * (Gantt) Whether to use HTML to render the labels.
  114233. */
  114234. useHTML?: boolean;
  114235. /**
  114236. * (Gantt) Vertical alignment of the label relative to the plot line. Can be
  114237. * one of "top", "middle" or "bottom".
  114238. */
  114239. verticalAlign?: VerticalAlignValue;
  114240. /**
  114241. * (Gantt) Horizontal position relative the alignment. Default varies by
  114242. * orientation.
  114243. */
  114244. x?: number;
  114245. /**
  114246. * (Gantt) Vertical position of the text baseline relative to the alignment.
  114247. * Default varies by orientation.
  114248. */
  114249. y?: number;
  114250. }
  114251. /**
  114252. * (Highcharts, Highstock, Highmaps, Gantt) Event handlers for the axis.
  114253. */
  114254. export interface XAxisEventsOptions {
  114255. /**
  114256. * (Highcharts, Gantt) An event fired after the breaks have rendered.
  114257. */
  114258. afterBreaks?: AxisEventCallbackFunction;
  114259. /**
  114260. * (Highcharts, Highstock, Highmaps, Gantt) As opposed to the `setExtremes`
  114261. * event, this event fires after the final min and max values are computed
  114262. * and corrected for `minRange`.
  114263. *
  114264. * Fires when the minimum and maximum is set for the axis, either by calling
  114265. * the `.setExtremes()` method or by selecting an area in the chart. One
  114266. * parameter, `event`, is passed to the function, containing common event
  114267. * information.
  114268. *
  114269. * The new user set minimum and maximum values can be found by `event.min`
  114270. * and `event.max`. These reflect the axis minimum and maximum in axis
  114271. * values. The actual data extremes are found in `event.dataMin` and
  114272. * `event.dataMax`.
  114273. */
  114274. afterSetExtremes?: AxisSetExtremesEventCallbackFunction;
  114275. /**
  114276. * (Highcharts, Gantt) An event fired when a break from this axis occurs on
  114277. * a point.
  114278. */
  114279. pointBreak?: AxisPointBreakEventCallbackFunction;
  114280. /**
  114281. * (Highcharts, Highstock, Gantt) An event fired when a point falls inside a
  114282. * break from this axis.
  114283. */
  114284. pointInBreak?: AxisPointBreakEventCallbackFunction;
  114285. /**
  114286. * (Highcharts, Highstock, Highmaps, Gantt) Fires when the minimum and
  114287. * maximum is set for the axis, either by calling the `.setExtremes()`
  114288. * method or by selecting an area in the chart. One parameter, `event`, is
  114289. * passed to the function, containing common event information.
  114290. *
  114291. * The new user set minimum and maximum values can be found by `event.min`
  114292. * and `event.max`. These reflect the axis minimum and maximum in data
  114293. * values. When an axis is zoomed all the way out from the "Reset zoom"
  114294. * button, `event.min` and `event.max` are null, and the new extremes are
  114295. * set based on `this.dataMin` and `this.dataMax`.
  114296. */
  114297. setExtremes?: AxisSetExtremesEventCallbackFunction;
  114298. }
  114299. /**
  114300. * (Gantt) Set grid options for the axis labels. Requires Highcharts Gantt.
  114301. */
  114302. export interface XAxisGridOptions {
  114303. /**
  114304. * (Gantt) Set border color for the label grid lines.
  114305. */
  114306. borderColor?: ColorString;
  114307. /**
  114308. * (Gantt) Set border width of the label grid lines.
  114309. */
  114310. borderWidth?: number;
  114311. /**
  114312. * (Gantt) Set cell height for grid axis labels. By default this is
  114313. * calculated from font size. This option only applies to horizontal axes.
  114314. */
  114315. cellHeight?: number;
  114316. /**
  114317. * (Gantt) Set specific options for each column (or row for horizontal axes)
  114318. * in the grid. Each extra column/row is its own axis, and the axis options
  114319. * can be set here.
  114320. */
  114321. columns?: Array<XAxisOptions>;
  114322. /**
  114323. * (Gantt) Enable grid on the axis labels. Defaults to true for Gantt
  114324. * charts.
  114325. */
  114326. enabled?: boolean;
  114327. }
  114328. /**
  114329. * (Highcharts, Highstock, Highmaps, Gantt) The axis labels show the number or
  114330. * category for each tick.
  114331. *
  114332. * Since v8.0.0: Labels are animated in categorized x-axis with updating data if
  114333. * `tickInterval` and `step` is set to 1.
  114334. */
  114335. export interface XAxisLabelsOptions {
  114336. /**
  114337. * (Highcharts, Highstock, Highmaps, Gantt) What part of the string the
  114338. * given position is anchored to. If `left`, the left side of the string is
  114339. * at the axis position. Can be one of `"left"`, `"center"` or `"right"`.
  114340. * Defaults to an intelligent guess based on which side of the chart the
  114341. * axis is on and the rotation of the label.
  114342. */
  114343. align?: AlignValue;
  114344. /**
  114345. * (Highcharts, Highstock, Gantt) For horizontal axes, the allowed degrees
  114346. * of label rotation to prevent overlapping labels. If there is enough
  114347. * space, labels are not rotated. As the chart gets narrower, it will start
  114348. * rotating the labels -45 degrees, then remove every second label and try
  114349. * again with rotations 0 and -45 etc. Set it to `false` to disable
  114350. * rotation, which will cause the labels to word-wrap if possible.
  114351. */
  114352. autoRotation?: (false|Array<number>);
  114353. /**
  114354. * (Highcharts, Gantt) When each category width is more than this many
  114355. * pixels, we don't apply auto rotation. Instead, we lay out the axis label
  114356. * with word wrap. A lower limit makes sense when the label contains
  114357. * multiple short words that don't extend the available horizontal space for
  114358. * each label.
  114359. */
  114360. autoRotationLimit?: number;
  114361. /**
  114362. * (Highcharts, Gantt) Polar charts only. The label's pixel distance from
  114363. * the perimeter of the plot area.
  114364. */
  114365. distance?: number;
  114366. /**
  114367. * (Highcharts, Highstock, Highmaps, Gantt) Enable or disable the axis
  114368. * labels.
  114369. */
  114370. enabled?: boolean;
  114371. /**
  114372. * (Highcharts, Highstock, Highmaps, Gantt) A format string for the axis
  114373. * label. See format string for example usage.
  114374. *
  114375. * Note: The default value is not specified due to the dynamic nature of the
  114376. * default implementation.
  114377. */
  114378. format?: string;
  114379. /**
  114380. * (Highcharts, Highstock, Highmaps, Gantt) Callback JavaScript function to
  114381. * format the label. The value is given by `this.value`. Additional
  114382. * properties for `this` are `axis`, `chart`, `isFirst` and `isLast`. The
  114383. * value of the default label formatter can be retrieved by calling
  114384. * `this.axis.defaultLabelFormatter.call(this)` within the function.
  114385. *
  114386. * Defaults to: (see online documentation for example)
  114387. */
  114388. formatter?: AxisLabelsFormatterCallbackFunction;
  114389. /**
  114390. * (Gantt) The number of pixels to indent the labels per level in a treegrid
  114391. * axis.
  114392. */
  114393. indentation?: number;
  114394. /**
  114395. * (Highcharts, Highstock, Highmaps, Gantt) How to handle overflowing labels
  114396. * on horizontal axis. If set to `"allow"`, it will not be aligned at all.
  114397. * By default it `"justify"` labels inside the chart area. If there is room
  114398. * to move it, it will be aligned to the edge, else it will be removed.
  114399. */
  114400. overflow?: OptionsOverflowValue;
  114401. /**
  114402. * (Highcharts, Gantt) The pixel padding for axis labels, to ensure white
  114403. * space between them.
  114404. */
  114405. padding?: number;
  114406. /**
  114407. * (Highcharts) Defines how the labels are be repositioned according to the
  114408. * 3D chart orientation.
  114409. *
  114410. * - `'offset'`: Maintain a fixed horizontal/vertical distance from the tick
  114411. * marks, despite the chart orientation. This is the backwards compatible
  114412. * behavior, and causes skewing of X and Z axes.
  114413. *
  114414. * - `'chart'`: Preserve 3D position relative to the chart. This looks nice,
  114415. * but hard to read if the text isn't forward-facing.
  114416. *
  114417. * - `'flap'`: Rotated text along the axis to compensate for the chart
  114418. * orientation. This tries to maintain text as legible as possible on all
  114419. * orientations.
  114420. *
  114421. * - `'ortho'`: Rotated text along the axis direction so that the labels are
  114422. * orthogonal to the axis. This is very similar to `'flap'`, but prevents
  114423. * skewing the labels (X and Y scaling are still present).
  114424. */
  114425. position3d?: OptionsPosition3dValue;
  114426. /**
  114427. * (Highcharts, Gantt) Whether to reserve space for the labels. By default,
  114428. * space is reserved for the labels in these cases:
  114429. *
  114430. * * On all horizontal axes.
  114431. *
  114432. * * On vertical axes if `label.align` is `right` on a left-side axis or
  114433. * `left` on a right-side axis.
  114434. *
  114435. * * On vertical axes if `label.align` is `center`.
  114436. *
  114437. * This can be turned off when for example the labels are rendered inside
  114438. * the plot area instead of outside.
  114439. */
  114440. reserveSpace?: boolean;
  114441. /**
  114442. * (Highcharts, Highstock, Highmaps, Gantt) Rotation of the labels in
  114443. * degrees.
  114444. */
  114445. rotation?: number;
  114446. /**
  114447. * (Highcharts) If enabled, the axis labels will skewed to follow the
  114448. * perspective.
  114449. *
  114450. * This will fix overlapping labels and titles, but texts become less
  114451. * legible due to the distortion.
  114452. *
  114453. * The final appearance depends heavily on `labels.position3d`.
  114454. */
  114455. skew3d?: boolean;
  114456. /**
  114457. * (Highcharts, Highstock, Highmaps, Gantt) Horizontal axes only. The number
  114458. * of lines to spread the labels over to make room or tighter labels.
  114459. */
  114460. staggerLines?: number;
  114461. /**
  114462. * (Highcharts, Highstock, Highmaps, Gantt) To show only every _n_'th label
  114463. * on the axis, set the step to _n_. Setting the step to 2 shows every other
  114464. * label.
  114465. *
  114466. * By default, the step is calculated automatically to avoid overlap. To
  114467. * prevent this, set it to 1\. This usually only happens on a category axis,
  114468. * and is often a sign that you have chosen the wrong axis type.
  114469. *
  114470. * Read more at Axis docs => What axis should I use?
  114471. */
  114472. step?: number;
  114473. /**
  114474. * (Highcharts, Highstock, Highmaps, Gantt) CSS styles for the label. Use
  114475. * `whiteSpace: 'nowrap'` to prevent wrapping of category labels. Use
  114476. * `textOverflow: 'none'` to prevent ellipsis (dots).
  114477. *
  114478. * In styled mode, the labels are styled with the `.highcharts-axis-labels`
  114479. * class.
  114480. */
  114481. style?: CSSObject;
  114482. /**
  114483. * (Highcharts, Highstock, Highmaps, Gantt) Whether to use HTML to render
  114484. * the labels.
  114485. */
  114486. useHTML?: boolean;
  114487. /**
  114488. * (Highcharts, Highstock, Highmaps, Gantt) The x position offset of all
  114489. * labels relative to the tick positions on the axis.
  114490. */
  114491. x?: number;
  114492. /**
  114493. * (Highcharts, Highstock, Highmaps, Gantt) The y position offset of all
  114494. * labels relative to the tick positions on the axis. The default makes it
  114495. * adapt to the font size of the bottom axis.
  114496. */
  114497. y?: number;
  114498. /**
  114499. * (Highcharts, Highstock, Highmaps, Gantt) The Z index for the axis labels.
  114500. */
  114501. zIndex?: number;
  114502. }
  114503. /**
  114504. * (Highcharts, Highstock, Highmaps, Gantt) The X axis or category axis.
  114505. * Normally this is the horizontal axis, though if the chart is inverted this is
  114506. * the vertical axis. In case of multiple axes, the xAxis node is an array of
  114507. * configuration objects.
  114508. *
  114509. * See the Axis class for programmatic access to the axis.
  114510. */
  114511. export interface XAxisOptions {
  114512. /**
  114513. * (Highcharts, Highstock, Highmaps, Gantt) Accessibility options for an
  114514. * axis. Requires the accessibility module.
  114515. */
  114516. accessibility?: AxisAccessibilityOptionsObject;
  114517. /**
  114518. * (Highcharts, Highstock, Gantt) When using multiple axis, the ticks of two
  114519. * or more opposite axes will automatically be aligned by adding ticks to
  114520. * the axis or axes with the least ticks, as if `tickAmount` were specified.
  114521. *
  114522. * This can be prevented by setting `alignTicks` to false. If the grid lines
  114523. * look messy, it's a good idea to hide them for the secondary axis by
  114524. * setting `gridLineWidth` to 0.
  114525. *
  114526. * If `startOnTick` or `endOnTick` in an Axis options are set to false, then
  114527. * the `alignTicks ` will be disabled for the Axis.
  114528. *
  114529. * Disabled for logarithmic axes.
  114530. */
  114531. alignTicks?: boolean;
  114532. /**
  114533. * (Highcharts, Highstock, Highmaps, Gantt) Whether to allow decimals in
  114534. * this axis' ticks. When counting integers, like persons or hits on a web
  114535. * page, decimals should be avoided in the labels.
  114536. */
  114537. allowDecimals?: boolean;
  114538. /**
  114539. * (Highcharts, Highstock, Highmaps, Gantt) When using an alternate grid
  114540. * color, a band is painted across the plot area between every other grid
  114541. * line.
  114542. */
  114543. alternateGridColor?: ColorType;
  114544. /**
  114545. * (Highcharts) In a polar chart, this is the angle of the Y axis in
  114546. * degrees, where 0 is up and 90 is right. The angle determines the position
  114547. * of the axis line and the labels, though the coordinate system is
  114548. * unaffected. Since v8.0.0 this option is also applicable for X axis
  114549. * (inverted polar).
  114550. */
  114551. angle?: number;
  114552. /**
  114553. * (Highcharts, Highstock, Gantt) An array defining breaks in the axis, the
  114554. * sections defined will be left out and all the points shifted closer to
  114555. * each other.
  114556. */
  114557. breaks?: Array<XAxisBreaksOptions>;
  114558. /**
  114559. * (Highcharts, Gantt) If categories are present for the xAxis, names are
  114560. * used instead of numbers for that axis.
  114561. *
  114562. * Since Highcharts 3.0, categories can also be extracted by giving each
  114563. * point a name and setting axis type to `category`. However, if you have
  114564. * multiple series, best practice remains defining the `categories` array.
  114565. *
  114566. * Example: `categories: ['Apples', 'Bananas', 'Oranges']`
  114567. */
  114568. categories?: Array<string>;
  114569. /**
  114570. * (Highcharts, Highstock, Gantt) The highest allowed value for
  114571. * automatically computed axis extremes.
  114572. */
  114573. ceiling?: number;
  114574. /**
  114575. * (Highcharts, Highstock, Highmaps, Gantt) A class name that opens for
  114576. * styling the axis by CSS, especially in Highcharts styled mode. The class
  114577. * name is applied to group elements for the grid, axis elements and labels.
  114578. */
  114579. className?: string;
  114580. /**
  114581. * (Highcharts, Highstock, Highmaps, Gantt) Configure a crosshair that
  114582. * follows either the mouse pointer or the hovered point.
  114583. *
  114584. * In styled mode, the crosshairs are styled in the `.highcharts-crosshair`,
  114585. * `.highcharts-crosshair-thin` or `.highcharts-xaxis-category` classes.
  114586. */
  114587. crosshair?: (boolean|AxisCrosshairOptions);
  114588. /**
  114589. * (Gantt) Show an indicator on the axis for the current date and time. Can
  114590. * be a boolean or a configuration object similar to xAxis.plotLines.
  114591. */
  114592. currentDateIndicator?: (boolean|AxisCurrentDateIndicatorOptions);
  114593. /**
  114594. * (Highcharts, Highstock, Gantt) For a datetime axis, the scale will
  114595. * automatically adjust to the appropriate unit. This member gives the
  114596. * default string representations used for each unit. For intermediate
  114597. * values, different units may be used, for example the `day` unit can be
  114598. * used on midnight and `hour` unit be used for intermediate values on the
  114599. * same axis.
  114600. *
  114601. * For an overview of the replacement codes, see dateFormat.
  114602. *
  114603. * Defaults to: (see online documentation for example)
  114604. */
  114605. dateTimeLabelFormats?: AxisDateTimeLabelFormatsOptions;
  114606. /**
  114607. * (Highcharts, Highstock, Highmaps, Gantt) Whether to force the axis to end
  114608. * on a tick. Use this option with the `maxPadding` option to control the
  114609. * axis end.
  114610. */
  114611. endOnTick?: boolean;
  114612. /**
  114613. * (Highcharts, Highstock, Highmaps, Gantt) Event handlers for the axis.
  114614. */
  114615. events?: XAxisEventsOptions;
  114616. /**
  114617. * (Highcharts, Highstock, Gantt) The lowest allowed value for automatically
  114618. * computed axis extremes.
  114619. */
  114620. floor?: number;
  114621. /**
  114622. * (Gantt) Set grid options for the axis labels. Requires Highcharts Gantt.
  114623. */
  114624. grid?: XAxisGridOptions;
  114625. /**
  114626. * (Highcharts, Highstock, Highmaps, Gantt) Color of the grid lines
  114627. * extending the ticks across the plot area.
  114628. *
  114629. * In styled mode, the stroke is given in the `.highcharts-grid-line` class.
  114630. */
  114631. gridLineColor?: ColorType;
  114632. /**
  114633. * (Highcharts, Highstock, Highmaps, Gantt) The dash or dot style of the
  114634. * grid lines. For possible values, see this demonstration.
  114635. */
  114636. gridLineDashStyle?: DashStyleValue;
  114637. /**
  114638. * (Highcharts) Polar charts only. Whether the grid lines should draw as a
  114639. * polygon with straight lines between categories, or as circles. Can be
  114640. * either `circle` or `polygon`. Since v8.0.0 this option is also applicable
  114641. * for X axis (inverted polar).
  114642. */
  114643. gridLineInterpolation?: OptionsGridLineInterpolationValue;
  114644. /**
  114645. * (Highcharts, Highstock, Highmaps, Gantt) The width of the grid lines
  114646. * extending the ticks across the plot area.
  114647. *
  114648. * In styled mode, the stroke width is given in the `.highcharts-grid-line`
  114649. * class.
  114650. */
  114651. gridLineWidth?: number;
  114652. /**
  114653. * (Highcharts, Highstock, Gantt) The Z index of the grid lines.
  114654. */
  114655. gridZIndex?: number;
  114656. /**
  114657. * (Highcharts, Highstock) The height as the vertical axis. If it's a
  114658. * number, it is interpreted as pixels.
  114659. *
  114660. * Since Highcharts 2: If it's a percentage string, it is interpreted as
  114661. * percentages of the total plot height.
  114662. */
  114663. height?: (number|string);
  114664. /**
  114665. * (Highcharts, Highstock, Highmaps, Gantt) An id for the axis. This can be
  114666. * used after render time to get a pointer to the axis object through
  114667. * `chart.get()`.
  114668. */
  114669. id?: string;
  114670. /**
  114671. * (Highcharts, Highstock, Highmaps, Gantt) The axis labels show the number
  114672. * or category for each tick.
  114673. *
  114674. * Since v8.0.0: Labels are animated in categorized x-axis with updating
  114675. * data if `tickInterval` and `step` is set to 1.
  114676. */
  114677. labels?: XAxisLabelsOptions;
  114678. /**
  114679. * (Highcharts, Highstock) The left position as the horizontal axis. If it's
  114680. * a number, it is interpreted as pixel position relative to the chart.
  114681. *
  114682. * Since Highcharts v5.0.13: If it's a percentage string, it is interpreted
  114683. * as percentages of the plot width, offset from plot area left.
  114684. */
  114685. left?: (number|string);
  114686. /**
  114687. * (Highcharts, Highstock, Highmaps, Gantt) The color of the line marking
  114688. * the axis itself.
  114689. *
  114690. * In styled mode, the line stroke is given in the `.highcharts-axis-line`
  114691. * or `.highcharts-xaxis-line` class.
  114692. */
  114693. lineColor?: ColorType;
  114694. /**
  114695. * (Highcharts, Highstock, Highmaps, Gantt) The width of the line marking
  114696. * the axis itself.
  114697. *
  114698. * In styled mode, the stroke width is given in the `.highcharts-axis-line`
  114699. * or `.highcharts-xaxis-line` class.
  114700. */
  114701. lineWidth?: number;
  114702. /**
  114703. * (Highcharts, Highstock, Gantt) Index of another axis that this axis is
  114704. * linked to. When an axis is linked to a master axis, it will take the same
  114705. * extremes as the master, but as assigned by min or max or by setExtremes.
  114706. * It can be used to show additional info, or to ease reading the chart by
  114707. * duplicating the scales.
  114708. */
  114709. linkedTo?: number;
  114710. /**
  114711. * (Highcharts, Highstock, Highmaps, Gantt) If there are multiple axes on
  114712. * the same side of the chart, the pixel margin between the axes. Defaults
  114713. * to 0 on vertical axes, 15 on horizontal axes.
  114714. */
  114715. margin?: number;
  114716. /**
  114717. * (Highcharts, Highstock, Highmaps, Gantt) The maximum value of the axis.
  114718. * If `null`, the max value is automatically calculated.
  114719. *
  114720. * If the endOnTick option is true, the `max` value might be rounded up.
  114721. *
  114722. * If a tickAmount is set, the axis may be extended beyond the set max in
  114723. * order to reach the given number of ticks. The same may happen in a chart
  114724. * with multiple axes, determined by chart. alignTicks, where a `tickAmount`
  114725. * is applied internally.
  114726. */
  114727. max?: (number|null);
  114728. /**
  114729. * (Highcharts, Highstock, Highmaps, Gantt) Padding of the max value
  114730. * relative to the length of the axis. A padding of 0.05 will make a 100px
  114731. * axis 5px longer. This is useful when you don't want the highest data
  114732. * value to appear on the edge of the plot area. When the axis' `max` option
  114733. * is set or a max extreme is set using `axis.setExtremes()`, the maxPadding
  114734. * will be ignored.
  114735. */
  114736. maxPadding?: number;
  114737. /**
  114738. * (Highstock, Gantt) Maximum range which can be set using the navigator's
  114739. * handles. Opposite of xAxis.minRange.
  114740. */
  114741. maxRange?: number;
  114742. /**
  114743. * (Highcharts, Highstock, Highmaps, Gantt) The minimum value of the axis.
  114744. * If `null` the min value is automatically calculated.
  114745. *
  114746. * If the startOnTick option is true (default), the `min` value might be
  114747. * rounded down.
  114748. *
  114749. * The automatically calculated minimum value is also affected by floor,
  114750. * softMin, minPadding, minRange as well as series.threshold and
  114751. * series.softThreshold.
  114752. */
  114753. min?: (number|null);
  114754. /**
  114755. * (Highcharts, Highstock, Highmaps, Gantt) Color of the minor, secondary
  114756. * grid lines.
  114757. *
  114758. * In styled mode, the stroke width is given in the
  114759. * `.highcharts-minor-grid-line` class.
  114760. */
  114761. minorGridLineColor?: ColorType;
  114762. /**
  114763. * (Highcharts, Highstock, Highmaps, Gantt) The dash or dot style of the
  114764. * minor grid lines. For possible values, see this demonstration.
  114765. */
  114766. minorGridLineDashStyle?: DashStyleValue;
  114767. /**
  114768. * (Highcharts, Highstock, Highmaps, Gantt) Width of the minor, secondary
  114769. * grid lines.
  114770. *
  114771. * In styled mode, the stroke width is given in the `.highcharts-grid-line`
  114772. * class.
  114773. */
  114774. minorGridLineWidth?: number;
  114775. /**
  114776. * (Highcharts, Highstock, Highmaps, Gantt) Color for the minor tick marks.
  114777. */
  114778. minorTickColor?: ColorType;
  114779. /**
  114780. * (Highcharts, Highstock, Highmaps, Gantt) Specific tick interval in axis
  114781. * units for the minor ticks. On a linear axis, if `"auto"`, the minor tick
  114782. * interval is calculated as a fifth of the tickInterval. If `null` or
  114783. * `undefined`, minor ticks are not shown.
  114784. *
  114785. * On logarithmic axes, the unit is the power of the value. For example,
  114786. * setting the minorTickInterval to 1 puts one tick on each of 0.1, 1, 10,
  114787. * 100 etc. Setting the minorTickInterval to 0.1 produces 9 ticks between 1
  114788. * and 10, 10 and 100 etc.
  114789. *
  114790. * If user settings dictate minor ticks to become too dense, they don't make
  114791. * sense, and will be ignored to prevent performance problems.
  114792. */
  114793. minorTickInterval?: (number|string|null);
  114794. /**
  114795. * (Highcharts, Highstock, Highmaps, Gantt) The pixel length of the minor
  114796. * tick marks.
  114797. */
  114798. minorTickLength?: number;
  114799. /**
  114800. * (Highcharts, Highstock, Highmaps, Gantt) The position of the minor tick
  114801. * marks relative to the axis line. Can be one of `inside` and `outside`.
  114802. */
  114803. minorTickPosition?: OptionsMinorTickPositionValue;
  114804. /**
  114805. * (Highcharts, Highstock, Highmaps, Gantt) Enable or disable minor ticks.
  114806. * Unless minorTickInterval is set, the tick interval is calculated as a
  114807. * fifth of the `tickInterval`.
  114808. *
  114809. * On a logarithmic axis, minor ticks are laid out based on a best guess,
  114810. * attempting to enter approximately 5 minor ticks between each major tick.
  114811. *
  114812. * Prior to v6.0.0, ticks were unabled in auto layout by setting
  114813. * `minorTickInterval` to `"auto"`.
  114814. */
  114815. minorTicks?: boolean;
  114816. /**
  114817. * (Highcharts, Highstock, Highmaps, Gantt) The pixel width of the minor
  114818. * tick mark.
  114819. */
  114820. minorTickWidth?: number;
  114821. /**
  114822. * (Highcharts, Highstock, Gantt) Padding of the min value relative to the
  114823. * length of the axis. A padding of 0.05 will make a 100px axis 5px longer.
  114824. * This is useful when you don't want the lowest data value to appear on the
  114825. * edge of the plot area. When the axis' `min` option is set or a min
  114826. * extreme is set using `axis.setExtremes()`, the minPadding will be
  114827. * ignored.
  114828. */
  114829. minPadding?: number;
  114830. /**
  114831. * (Highcharts, Highstock, Highmaps, Gantt) The minimum range to display on
  114832. * this axis. The entire axis will not be allowed to span over a smaller
  114833. * interval than this. For example, for a datetime axis the main unit is
  114834. * milliseconds. If minRange is set to 3600000, you can't zoom in more than
  114835. * to one hour.
  114836. *
  114837. * The default minRange for the x axis is five times the smallest interval
  114838. * between any of the data points.
  114839. *
  114840. * On a logarithmic axis, the unit for the minimum range is the power. So a
  114841. * minRange of 1 means that the axis can be zoomed to 10-100, 100-1000,
  114842. * 1000-10000 etc.
  114843. *
  114844. * **Note**: The `minPadding`, `maxPadding`, `startOnTick` and `endOnTick`
  114845. * settings also affect how the extremes of the axis are computed.
  114846. */
  114847. minRange?: number;
  114848. /**
  114849. * (Highcharts, Highstock, Highmaps, Gantt) The minimum tick interval
  114850. * allowed in axis values. For example on zooming in on an axis with daily
  114851. * data, this can be used to prevent the axis from showing hours. Defaults
  114852. * to the closest distance between two points on the axis.
  114853. */
  114854. minTickInterval?: number;
  114855. /**
  114856. * (Highcharts, Highstock, Highmaps, Gantt) The distance in pixels from the
  114857. * plot area to the axis line. A positive offset moves the axis with it's
  114858. * line, labels and ticks away from the plot area. This is typically used
  114859. * when two or more axes are displayed on the same side of the plot. With
  114860. * multiple axes the offset is dynamically adjusted to avoid collision, this
  114861. * can be overridden by setting offset explicitly.
  114862. */
  114863. offset?: number;
  114864. /**
  114865. * (Highcharts, Highstock, Highmaps, Gantt) Whether to display the axis on
  114866. * the opposite side of the normal. The normal is on the left side for
  114867. * vertical axes and bottom for horizontal, so the opposite sides will be
  114868. * right and top respectively. This is typically used with dual or multiple
  114869. * axes.
  114870. */
  114871. opposite?: boolean;
  114872. /**
  114873. * (Highstock) In an ordinal axis, the points are equally spaced in the
  114874. * chart regardless of the actual time or x distance between them. This
  114875. * means that missing data periods (e.g. nights or weekends for a stock
  114876. * chart) will not take up space in the chart. Having `ordinal: false` will
  114877. * show any gaps created by the `gapSize` setting proportionate to their
  114878. * duration.
  114879. *
  114880. * In stock charts the X axis is ordinal by default, unless the boost module
  114881. * is used and at least one of the series' data length exceeds the
  114882. * boostThreshold.
  114883. */
  114884. ordinal?: boolean;
  114885. /**
  114886. * (Highstock) Additional range on the right side of the xAxis. Works
  114887. * similar to `xAxis.maxPadding`, but value is set in milliseconds. Can be
  114888. * set for both main `xAxis` and the navigator's `xAxis`.
  114889. */
  114890. overscroll?: number;
  114891. /**
  114892. * (Highcharts) Refers to the index in the panes array. Used for circular
  114893. * gauges and polar charts. When the option is not set then first pane will
  114894. * be used.
  114895. */
  114896. pane?: number;
  114897. /**
  114898. * (Highcharts, Highstock, Gantt) An array of colored bands stretching
  114899. * across the plot area marking an interval on the axis.
  114900. *
  114901. * In styled mode, the plot bands are styled by the `.highcharts-plot-band`
  114902. * class in addition to the `className` option.
  114903. */
  114904. plotBands?: Array<XAxisPlotBandsOptions>;
  114905. /**
  114906. * (Highcharts, Highstock, Gantt) An array of lines stretching across the
  114907. * plot area, marking a specific value on one of the axes.
  114908. *
  114909. * In styled mode, the plot lines are styled by the `.highcharts-plot-line`
  114910. * class in addition to the `className` option.
  114911. */
  114912. plotLines?: Array<XAxisPlotLinesOptions>;
  114913. /**
  114914. * (Highstock) The zoomed range to display when only defining one or none of
  114915. * `min` or `max`. For example, to show the latest month, a range of one
  114916. * month can be set.
  114917. */
  114918. range?: number;
  114919. /**
  114920. * (Highcharts, Highstock, Highmaps, Gantt) Whether to reverse the axis so
  114921. * that the highest number is closest to the origin. If the chart is
  114922. * inverted, the x axis is reversed by default.
  114923. */
  114924. reversed?: boolean;
  114925. /**
  114926. * (Highcharts, Highstock) This option determines how stacks should be
  114927. * ordered within a group. For example reversed xAxis also reverses stacks,
  114928. * so first series comes last in a group. To keep order like for
  114929. * non-reversed xAxis enable this option.
  114930. */
  114931. reversedStacks?: boolean;
  114932. /**
  114933. * (Highstock) An optional scrollbar to display on the X axis in response to
  114934. * limiting the minimum and maximum of the axis values.
  114935. *
  114936. * In styled mode, all the presentational options for the scrollbar are
  114937. * replaced by the classes `.highcharts-scrollbar-thumb`,
  114938. * `.highcharts-scrollbar-arrow`, `.highcharts-scrollbar-button`,
  114939. * `.highcharts-scrollbar-rifles` and `.highcharts-scrollbar-track`.
  114940. */
  114941. scrollbar?: XAxisScrollbarOptions;
  114942. /**
  114943. * (Highcharts, Highstock, Highmaps, Gantt) Whether to show the axis line
  114944. * and title when the axis has no data.
  114945. */
  114946. showEmpty?: boolean;
  114947. /**
  114948. * (Highcharts, Highstock, Highmaps, Gantt) Whether to show the first tick
  114949. * label.
  114950. */
  114951. showFirstLabel?: boolean;
  114952. /**
  114953. * (Highcharts, Highstock, Gantt) Whether to show the last tick label.
  114954. * Defaults to `true` on cartesian charts, and `false` on polar charts.
  114955. */
  114956. showLastLabel?: boolean;
  114957. /**
  114958. * (Highcharts, Highstock, Gantt) A soft maximum for the axis. If the series
  114959. * data maximum is less than this, the axis will stay at this maximum, but
  114960. * if the series data maximum is higher, the axis will flex to show all
  114961. * data.
  114962. */
  114963. softMax?: number;
  114964. /**
  114965. * (Highcharts, Highstock, Gantt) A soft minimum for the axis. If the series
  114966. * data minimum is greater than this, the axis will stay at this minimum,
  114967. * but if the series data minimum is lower, the axis will flex to show all
  114968. * data.
  114969. */
  114970. softMin?: number;
  114971. /**
  114972. * (Highcharts, Highstock, Gantt) For datetime axes, this decides where to
  114973. * put the tick between weeks. 0 = Sunday, 1 = Monday.
  114974. */
  114975. startOfWeek?: number;
  114976. /**
  114977. * (Highcharts, Highstock, Highmaps, Gantt) Whether to force the axis to
  114978. * start on a tick. Use this option with the `minPadding` option to control
  114979. * the axis start.
  114980. */
  114981. startOnTick?: boolean;
  114982. /**
  114983. * (Highcharts, Highstock, Gantt) The amount of ticks to draw on the axis.
  114984. * This opens up for aligning the ticks of multiple charts or panes within a
  114985. * chart. This option overrides the `tickPixelInterval` option.
  114986. *
  114987. * This option only has an effect on linear axes. Datetime, logarithmic or
  114988. * category axes are not affected.
  114989. */
  114990. tickAmount?: number;
  114991. /**
  114992. * (Highcharts, Highstock, Highmaps, Gantt) Color for the main tick marks.
  114993. *
  114994. * In styled mode, the stroke is given in the `.highcharts-tick` class.
  114995. */
  114996. tickColor?: ColorType;
  114997. /**
  114998. * (Highcharts, Highstock, Highmaps, Gantt) The interval of the tick marks
  114999. * in axis units. When `undefined`, the tick interval is computed to
  115000. * approximately follow the tickPixelInterval on linear and datetime axes.
  115001. * On categorized axes, a `undefined` tickInterval will default to 1, one
  115002. * category. Note that datetime axes are based on milliseconds, so for
  115003. * example an interval of one day is expressed as `24 * 3600 * 1000`.
  115004. *
  115005. * On logarithmic axes, the tickInterval is based on powers, so a
  115006. * tickInterval of 1 means one tick on each of 0.1, 1, 10, 100 etc. A
  115007. * tickInterval of 2 means a tick of 0.1, 10, 1000 etc. A tickInterval of
  115008. * 0.2 puts a tick on 0.1, 0.2, 0.4, 0.6, 0.8, 1, 2, 4, 6, 8, 10, 20, 40
  115009. * etc.
  115010. *
  115011. * If the tickInterval is too dense for labels to be drawn, Highcharts may
  115012. * remove ticks.
  115013. *
  115014. * If the chart has multiple axes, the alignTicks option may interfere with
  115015. * the `tickInterval` setting.
  115016. */
  115017. tickInterval?: number;
  115018. /**
  115019. * (Highcharts, Highstock, Highmaps, Gantt) The pixel length of the main
  115020. * tick marks.
  115021. */
  115022. tickLength?: number;
  115023. /**
  115024. * (Highcharts, Gantt) For categorized axes only. If `on` the tick mark is
  115025. * placed in the center of the category, if `between` the tick mark is
  115026. * placed between categories. The default is `between` if the `tickInterval`
  115027. * is 1, else `on`.
  115028. */
  115029. tickmarkPlacement?: OptionsTickmarkPlacementValue;
  115030. /**
  115031. * (Highcharts, Highstock, Highmaps, Gantt) If tickInterval is `null` this
  115032. * option sets the approximate pixel interval of the tick marks. Not
  115033. * applicable to categorized axis.
  115034. *
  115035. * The tick interval is also influenced by the minTickInterval option, that,
  115036. * by default prevents ticks from being denser than the data points.
  115037. */
  115038. tickPixelInterval?: number;
  115039. /**
  115040. * (Highcharts, Highstock, Highmaps, Gantt) The position of the major tick
  115041. * marks relative to the axis line. Can be one of `inside` and `outside`.
  115042. */
  115043. tickPosition?: OptionsTickPositionValue;
  115044. /**
  115045. * (Highcharts, Highstock, Highmaps, Gantt) A callback function returning
  115046. * array defining where the ticks are laid out on the axis. This overrides
  115047. * the default behaviour of tickPixelInterval and tickInterval. The
  115048. * automatic tick positions are accessible through `this.tickPositions` and
  115049. * can be modified by the callback.
  115050. */
  115051. tickPositioner?: AxisTickPositionerCallbackFunction;
  115052. /**
  115053. * (Highcharts, Highstock, Highmaps, Gantt) An array defining where the
  115054. * ticks are laid out on the axis. This overrides the default behaviour of
  115055. * tickPixelInterval and tickInterval.
  115056. */
  115057. tickPositions?: Array<number>;
  115058. /**
  115059. * (Highcharts, Highstock, Highmaps, Gantt) The pixel width of the major
  115060. * tick marks. Defaults to 0 on category axes, otherwise 1.
  115061. *
  115062. * In styled mode, the stroke width is given in the `.highcharts-tick`
  115063. * class, but in order for the element to be generated on category axes, the
  115064. * option must be explicitly set to 1.
  115065. */
  115066. tickWidth?: (number|undefined);
  115067. /**
  115068. * (Highcharts, Highstock, Highmaps, Gantt) The axis title, showing next to
  115069. * the axis line.
  115070. */
  115071. title?: XAxisTitleOptions;
  115072. /**
  115073. * (Highcharts, Highstock) The top position as the vertical axis. If it's a
  115074. * number, it is interpreted as pixel position relative to the chart.
  115075. *
  115076. * Since Highcharts 2: If it's a percentage string, it is interpreted as
  115077. * percentages of the plot height, offset from plot area top.
  115078. */
  115079. top?: (number|string);
  115080. /**
  115081. * (Highcharts, Gantt) The type of axis. Can be one of `linear`,
  115082. * `logarithmic`, `datetime` or `category`. In a datetime axis, the numbers
  115083. * are given in milliseconds, and tick marks are placed on appropriate
  115084. * values like full hours or days. In a category axis, the point names of
  115085. * the chart's series are used for categories, if not a categories array is
  115086. * defined.
  115087. */
  115088. type?: AxisTypeValue;
  115089. /**
  115090. * (Highcharts, Gantt) Applies only when the axis `type` is `category`. When
  115091. * `uniqueNames` is true, points are placed on the X axis according to their
  115092. * names. If the same point name is repeated in the same or another series,
  115093. * the point is placed on the same X position as other points of the same
  115094. * name. When `uniqueNames` is false, the points are laid out in increasing
  115095. * X positions regardless of their names, and the X axis category will take
  115096. * the name of the last point in each position.
  115097. */
  115098. uniqueNames?: boolean;
  115099. /**
  115100. * (Highcharts, Highstock, Gantt) Datetime axis only. An array determining
  115101. * what time intervals the ticks are allowed to fall on. Each array item is
  115102. * an array where the first value is the time unit and the second value
  115103. * another array of allowed multiples.
  115104. *
  115105. * Defaults to: (see online documentation for example)
  115106. */
  115107. units?: Array<[string, (Array<number>|null)]>;
  115108. /**
  115109. * (Highcharts, Highstock, Gantt) Whether axis, including axis title, line,
  115110. * ticks and labels, should be visible.
  115111. */
  115112. visible?: boolean;
  115113. /**
  115114. * (Highcharts, Highstock) The width as the horizontal axis. If it's a
  115115. * number, it is interpreted as pixels.
  115116. *
  115117. * Since Highcharts v5.0.13: If it's a percentage string, it is interpreted
  115118. * as percentages of the total plot width.
  115119. */
  115120. width?: (number|string);
  115121. /**
  115122. * (Highcharts, Highstock, Highmaps, Gantt) Whether to zoom axis. If
  115123. * `chart.zoomType` is set, the option allows to disable zooming on an
  115124. * individual axis.
  115125. */
  115126. zoomEnabled?: boolean;
  115127. }
  115128. /**
  115129. * (Highcharts, Highstock, Gantt) An object defining mouse events for the plot
  115130. * band. Supported properties are `click`, `mouseover`, `mouseout`, `mousemove`.
  115131. */
  115132. export interface XAxisPlotBandsEventsOptions {
  115133. /**
  115134. * (Highcharts, Highstock, Gantt) Click event on a plot band.
  115135. */
  115136. click?: EventCallbackFunction<PlotLineOrBand>;
  115137. /**
  115138. * (Highcharts, Highstock, Gantt) Mouse move event on a plot band.
  115139. */
  115140. mousemove?: EventCallbackFunction<PlotLineOrBand>;
  115141. /**
  115142. * (Highcharts, Highstock, Gantt) Mouse out event on the corner of a plot
  115143. * band.
  115144. */
  115145. mouseout?: EventCallbackFunction<PlotLineOrBand>;
  115146. /**
  115147. * (Highcharts, Highstock, Gantt) Mouse over event on a plot band.
  115148. */
  115149. mouseover?: EventCallbackFunction<PlotLineOrBand>;
  115150. }
  115151. /**
  115152. * (Highcharts, Highstock, Gantt) Text labels for the plot bands
  115153. */
  115154. export interface XAxisPlotBandsLabelOptions {
  115155. /**
  115156. * (Highcharts, Highstock, Gantt) Horizontal alignment of the label. Can be
  115157. * one of "left", "center" or "right".
  115158. */
  115159. align?: AlignValue;
  115160. /**
  115161. * (Highcharts, Highstock, Gantt) Rotation of the text label in degrees .
  115162. */
  115163. rotation?: number;
  115164. /**
  115165. * (Highcharts, Highstock, Gantt) CSS styles for the text label.
  115166. *
  115167. * In styled mode, the labels are styled by the
  115168. * `.highcharts-plot-band-label` class.
  115169. */
  115170. style?: CSSObject;
  115171. /**
  115172. * (Highcharts, Highstock, Gantt) The string text itself. A subset of HTML
  115173. * is supported.
  115174. */
  115175. text?: string;
  115176. /**
  115177. * (Highcharts, Highstock, Gantt) The text alignment for the label. While
  115178. * `align` determines where the texts anchor point is placed within the plot
  115179. * band, `textAlign` determines how the text is aligned against its anchor
  115180. * point. Possible values are "left", "center" and "right". Defaults to the
  115181. * same as the `align` option.
  115182. */
  115183. textAlign?: AlignValue;
  115184. /**
  115185. * (Highcharts, Highstock, Gantt) Whether to use HTML to render the labels.
  115186. */
  115187. useHTML?: boolean;
  115188. /**
  115189. * (Highcharts, Highstock, Gantt) Vertical alignment of the label relative
  115190. * to the plot band. Can be one of "top", "middle" or "bottom".
  115191. */
  115192. verticalAlign?: VerticalAlignValue;
  115193. /**
  115194. * (Highcharts, Highstock, Gantt) Horizontal position relative the
  115195. * alignment. Default varies by orientation.
  115196. */
  115197. x?: number;
  115198. /**
  115199. * (Highcharts, Highstock, Gantt) Vertical position of the text baseline
  115200. * relative to the alignment. Default varies by orientation.
  115201. */
  115202. y?: number;
  115203. }
  115204. /**
  115205. * (Highcharts, Highstock, Gantt) An array of colored bands stretching across
  115206. * the plot area marking an interval on the axis.
  115207. *
  115208. * In styled mode, the plot bands are styled by the `.highcharts-plot-band`
  115209. * class in addition to the `className` option.
  115210. */
  115211. export interface XAxisPlotBandsOptions {
  115212. /**
  115213. * (Highstock) Flag to decide if plotBand should be rendered across all
  115214. * panes.
  115215. */
  115216. acrossPanes?: boolean;
  115217. /**
  115218. * (Highcharts, Highstock, Gantt) Border color for the plot band. Also
  115219. * requires `borderWidth` to be set.
  115220. */
  115221. borderColor?: ColorString;
  115222. /**
  115223. * (Highcharts, Highstock, Gantt) Border width for the plot band. Also
  115224. * requires `borderColor` to be set.
  115225. */
  115226. borderWidth?: number;
  115227. /**
  115228. * (Highcharts, Highstock, Gantt) A custom class name, in addition to the
  115229. * default `highcharts-plot-band`, to apply to each individual band.
  115230. */
  115231. className?: string;
  115232. /**
  115233. * (Highcharts, Highstock, Gantt) The color of the plot band.
  115234. */
  115235. color?: (ColorString|GradientColorObject|PatternObject);
  115236. /**
  115237. * (Highcharts, Highstock, Gantt) An object defining mouse events for the
  115238. * plot band. Supported properties are `click`, `mouseover`, `mouseout`,
  115239. * `mousemove`.
  115240. */
  115241. events?: XAxisPlotBandsEventsOptions;
  115242. /**
  115243. * (Highcharts, Highstock, Gantt) The start position of the plot band in
  115244. * axis units.
  115245. */
  115246. from?: number;
  115247. /**
  115248. * (Highcharts, Highstock, Gantt) An id used for identifying the plot band
  115249. * in Axis.removePlotBand.
  115250. */
  115251. id?: string;
  115252. /**
  115253. * (Highcharts, Highstock, Gantt) Text labels for the plot bands
  115254. */
  115255. label?: XAxisPlotBandsLabelOptions;
  115256. /**
  115257. * (Highcharts, Highstock, Gantt) The end position of the plot band in axis
  115258. * units.
  115259. */
  115260. to?: number;
  115261. /**
  115262. * (Highcharts, Highstock, Gantt) The z index of the plot band within the
  115263. * chart, relative to other elements. Using the same z index as another
  115264. * element may give unpredictable results, as the last rendered element will
  115265. * be on top. Values from 0 to 20 make sense.
  115266. */
  115267. zIndex?: number;
  115268. }
  115269. /**
  115270. * (Highcharts, Highstock, Gantt) An object defining mouse events for the plot
  115271. * line. Supported properties are `click`, `mouseover`, `mouseout`, `mousemove`.
  115272. */
  115273. export interface XAxisPlotLinesEventsOptions {
  115274. /**
  115275. * (Highcharts, Highstock, Gantt) Click event on a plot band.
  115276. */
  115277. click?: EventCallbackFunction<PlotLineOrBand>;
  115278. /**
  115279. * (Highcharts, Highstock, Gantt) Mouse move event on a plot band.
  115280. */
  115281. mousemove?: EventCallbackFunction<PlotLineOrBand>;
  115282. /**
  115283. * (Highcharts, Highstock, Gantt) Mouse out event on the corner of a plot
  115284. * band.
  115285. */
  115286. mouseout?: EventCallbackFunction<PlotLineOrBand>;
  115287. /**
  115288. * (Highcharts, Highstock, Gantt) Mouse over event on a plot band.
  115289. */
  115290. mouseover?: EventCallbackFunction<PlotLineOrBand>;
  115291. }
  115292. /**
  115293. * (Highcharts, Highstock, Gantt) Text labels for the plot bands
  115294. */
  115295. export interface XAxisPlotLinesLabelOptions {
  115296. /**
  115297. * (Highcharts, Highstock, Gantt) Horizontal alignment of the label. Can be
  115298. * one of "left", "center" or "right".
  115299. */
  115300. align?: AlignValue;
  115301. /**
  115302. * (Highcharts, Highstock, Gantt) Callback JavaScript function to format the
  115303. * label. Useful properties like the value of plot line or the range of plot
  115304. * band (`from` & `to` properties) can be found in `this.options` object.
  115305. */
  115306. formatter?: FormatterCallbackFunction<PlotLineOrBand>;
  115307. /**
  115308. * (Highcharts, Highstock, Gantt) Rotation of the text label in degrees.
  115309. * Defaults to 0 for horizontal plot lines and 90 for vertical lines.
  115310. */
  115311. rotation?: number;
  115312. /**
  115313. * (Highcharts, Highstock, Gantt) CSS styles for the text label.
  115314. *
  115315. * In styled mode, the labels are styled by the
  115316. * `.highcharts-plot-line-label` class.
  115317. */
  115318. style?: CSSObject;
  115319. /**
  115320. * (Highcharts, Highstock, Gantt) The text itself. A subset of HTML is
  115321. * supported.
  115322. */
  115323. text?: string;
  115324. /**
  115325. * (Highcharts, Highstock, Gantt) The text alignment for the label. While
  115326. * `align` determines where the texts anchor point is placed within the plot
  115327. * band, `textAlign` determines how the text is aligned against its anchor
  115328. * point. Possible values are "left", "center" and "right". Defaults to the
  115329. * same as the `align` option.
  115330. */
  115331. textAlign?: AlignValue;
  115332. /**
  115333. * (Highcharts, Highstock, Gantt) Whether to use HTML to render the labels.
  115334. */
  115335. useHTML?: boolean;
  115336. /**
  115337. * (Highcharts, Highstock, Gantt) Vertical alignment of the label relative
  115338. * to the plot line. Can be one of "top", "middle" or "bottom".
  115339. */
  115340. verticalAlign?: VerticalAlignValue;
  115341. /**
  115342. * (Highcharts, Highstock, Gantt) Horizontal position relative the
  115343. * alignment. Default varies by orientation.
  115344. */
  115345. x?: number;
  115346. /**
  115347. * (Highcharts, Highstock, Gantt) Vertical position of the text baseline
  115348. * relative to the alignment. Default varies by orientation.
  115349. */
  115350. y?: number;
  115351. }
  115352. /**
  115353. * (Highcharts, Highstock, Gantt) An array of lines stretching across the plot
  115354. * area, marking a specific value on one of the axes.
  115355. *
  115356. * In styled mode, the plot lines are styled by the `.highcharts-plot-line`
  115357. * class in addition to the `className` option.
  115358. */
  115359. export interface XAxisPlotLinesOptions {
  115360. /**
  115361. * (Highstock) Flag to decide if plotLine should be rendered across all
  115362. * panes.
  115363. */
  115364. acrossPanes?: boolean;
  115365. /**
  115366. * (Highcharts, Highstock, Gantt) A custom class name, in addition to the
  115367. * default `highcharts-plot-line`, to apply to each individual line.
  115368. */
  115369. className?: string;
  115370. /**
  115371. * (Highcharts, Highstock, Gantt) The color of the line.
  115372. */
  115373. color?: ColorString;
  115374. /**
  115375. * (Highcharts, Highstock, Gantt) The dashing or dot style for the plot
  115376. * line. For possible values see this overview.
  115377. */
  115378. dashStyle?: DashStyleValue;
  115379. /**
  115380. * (Highcharts, Highstock, Gantt) An object defining mouse events for the
  115381. * plot line. Supported properties are `click`, `mouseover`, `mouseout`,
  115382. * `mousemove`.
  115383. */
  115384. events?: XAxisPlotLinesEventsOptions;
  115385. /**
  115386. * (Highcharts, Highstock, Gantt) An id used for identifying the plot line
  115387. * in Axis.removePlotLine.
  115388. */
  115389. id?: string;
  115390. /**
  115391. * (Highcharts, Highstock, Gantt) Text labels for the plot bands
  115392. */
  115393. label?: XAxisPlotLinesLabelOptions;
  115394. /**
  115395. * (Highcharts, Highstock, Gantt) The position of the line in axis units.
  115396. */
  115397. value?: number;
  115398. /**
  115399. * (Highcharts, Highstock, Gantt) The width or thickness of the plot line.
  115400. */
  115401. width?: number;
  115402. /**
  115403. * (Highcharts, Highstock, Gantt) The z index of the plot line within the
  115404. * chart.
  115405. */
  115406. zIndex?: number;
  115407. }
  115408. /**
  115409. * (Highstock) An optional scrollbar to display on the X axis in response to
  115410. * limiting the minimum and maximum of the axis values.
  115411. *
  115412. * In styled mode, all the presentational options for the scrollbar are replaced
  115413. * by the classes `.highcharts-scrollbar-thumb`, `.highcharts-scrollbar-arrow`,
  115414. * `.highcharts-scrollbar-button`, `.highcharts-scrollbar-rifles` and
  115415. * `.highcharts-scrollbar-track`.
  115416. */
  115417. export interface XAxisScrollbarOptions {
  115418. /**
  115419. * (Highstock) The background color of the scrollbar itself.
  115420. */
  115421. barBackgroundColor?: (ColorString|GradientColorObject|PatternObject);
  115422. /**
  115423. * (Highstock) The color of the scrollbar's border.
  115424. */
  115425. barBorderColor?: (ColorString|GradientColorObject|PatternObject);
  115426. /**
  115427. * (Highstock) The border rounding radius of the bar.
  115428. */
  115429. barBorderRadius?: number;
  115430. /**
  115431. * (Highstock) The width of the bar's border.
  115432. */
  115433. barBorderWidth?: number;
  115434. /**
  115435. * (Highstock) The color of the small arrow inside the scrollbar buttons.
  115436. */
  115437. buttonArrowColor?: (ColorString|GradientColorObject|PatternObject);
  115438. /**
  115439. * (Highstock) The color of scrollbar buttons.
  115440. */
  115441. buttonBackgroundColor?: (ColorString|GradientColorObject|PatternObject);
  115442. /**
  115443. * (Highstock) The color of the border of the scrollbar buttons.
  115444. */
  115445. buttonBorderColor?: (ColorString|GradientColorObject|PatternObject);
  115446. /**
  115447. * (Highstock) The corner radius of the scrollbar buttons.
  115448. */
  115449. buttonBorderRadius?: number;
  115450. /**
  115451. * (Highstock) The border width of the scrollbar buttons.
  115452. */
  115453. buttonBorderWidth?: number;
  115454. /**
  115455. * (Highstock) Enable or disable the scrollbar.
  115456. */
  115457. enabled?: boolean;
  115458. /**
  115459. * (Highstock) The height of the scrollbar. The height also applies to the
  115460. * width of the scroll arrows so that they are always squares. Defaults to
  115461. * 20 for touch devices and 14 for mouse devices.
  115462. */
  115463. height?: number;
  115464. /**
  115465. * (Highstock) Whether to redraw the main chart as the scrollbar or the
  115466. * navigator zoomed window is moved. Defaults to `true` for modern browsers
  115467. * and `false` for legacy IE browsers as well as mobile devices.
  115468. */
  115469. liveRedraw?: boolean;
  115470. /**
  115471. * (Highstock) The margin between the scrollbar and its axis when the
  115472. * scrollbar is applied directly to an axis.
  115473. */
  115474. margin?: number;
  115475. /**
  115476. * (Highstock) The minimum width of the scrollbar.
  115477. */
  115478. minWidth?: number;
  115479. /**
  115480. * (Highstock) The color of the small rifles in the middle of the scrollbar.
  115481. */
  115482. rifleColor?: (ColorString|GradientColorObject|PatternObject);
  115483. /**
  115484. * (Highstock) Whether to show or hide the scrollbar when the scrolled
  115485. * content is zoomed out to it full extent.
  115486. */
  115487. showFull?: boolean;
  115488. /**
  115489. * (Highstock) The color of the track background.
  115490. */
  115491. trackBackgroundColor?: (ColorString|GradientColorObject|PatternObject);
  115492. /**
  115493. * (Highstock) The color of the border of the scrollbar track.
  115494. */
  115495. trackBorderColor?: (ColorString|GradientColorObject|PatternObject);
  115496. /**
  115497. * (Highstock) The corner radius of the border of the scrollbar track.
  115498. */
  115499. trackBorderRadius?: number;
  115500. /**
  115501. * (Highstock) The width of the border of the scrollbar track.
  115502. */
  115503. trackBorderWidth?: number;
  115504. /**
  115505. * (Highstock) The z index of the scrollbar group.
  115506. */
  115507. zIndex?: number;
  115508. }
  115509. /**
  115510. * (Highcharts, Highstock, Highmaps, Gantt) The axis title, showing next to the
  115511. * axis line.
  115512. */
  115513. export interface XAxisTitleOptions {
  115514. /**
  115515. * (Highcharts, Highstock, Highmaps, Gantt) Alignment of the title relative
  115516. * to the axis values. Possible values are "low", "middle" or "high".
  115517. */
  115518. align?: AxisTitleAlignValue;
  115519. /**
  115520. * (Highcharts, Highstock, Highmaps, Gantt) The pixel distance between the
  115521. * axis labels or line and the title. Defaults to 0 for horizontal axes, 10
  115522. * for vertical
  115523. */
  115524. margin?: number;
  115525. /**
  115526. * (Highcharts, Highstock, Highmaps, Gantt) The distance of the axis title
  115527. * from the axis line. By default, this distance is computed from the offset
  115528. * width of the labels, the labels' distance from the axis and the title's
  115529. * margin. However when the offset option is set, it overrides all this.
  115530. */
  115531. offset?: number;
  115532. /**
  115533. * (Highcharts) Defines how the title is repositioned according to the 3D
  115534. * chart orientation.
  115535. *
  115536. * - `'offset'`: Maintain a fixed horizontal/vertical distance from the tick
  115537. * marks, despite the chart orientation. This is the backwards compatible
  115538. * behavior, and causes skewing of X and Z axes.
  115539. *
  115540. * - `'chart'`: Preserve 3D position relative to the chart. This looks nice,
  115541. * but hard to read if the text isn't forward-facing.
  115542. *
  115543. * - `'flap'`: Rotated text along the axis to compensate for the chart
  115544. * orientation. This tries to maintain text as legible as possible on all
  115545. * orientations.
  115546. *
  115547. * - `'ortho'`: Rotated text along the axis direction so that the labels are
  115548. * orthogonal to the axis. This is very similar to `'flap'`, but prevents
  115549. * skewing the labels (X and Y scaling are still present).
  115550. *
  115551. * - `undefined`: Will use the config from `labels.position3d`
  115552. */
  115553. position3d?: ("chart"|"flap"|"offset"|"ortho"|null);
  115554. /**
  115555. * (Highcharts, Highstock, Gantt) Whether to reserve space for the title
  115556. * when laying out the axis.
  115557. */
  115558. reserveSpace?: boolean;
  115559. /**
  115560. * (Highcharts, Highstock, Highmaps, Gantt) The rotation of the text in
  115561. * degrees. 0 is horizontal, 270 is vertical reading from bottom to top.
  115562. */
  115563. rotation?: number;
  115564. /**
  115565. * (Highcharts) If enabled, the axis title will skewed to follow the
  115566. * perspective.
  115567. *
  115568. * This will fix overlapping labels and titles, but texts become less
  115569. * legible due to the distortion.
  115570. *
  115571. * The final appearance depends heavily on `title.position3d`.
  115572. *
  115573. * A `null` value will use the config from `labels.skew3d`.
  115574. */
  115575. skew3d?: (boolean|null);
  115576. /**
  115577. * (Highcharts, Highstock, Highmaps, Gantt) CSS styles for the title. If the
  115578. * title text is longer than the axis length, it will wrap to multiple lines
  115579. * by default. This can be customized by setting `textOverflow: 'ellipsis'`,
  115580. * by setting a specific `width` or by setting `whiteSpace: 'nowrap'`.
  115581. *
  115582. * In styled mode, the stroke width is given in the `.highcharts-axis-title`
  115583. * class.
  115584. */
  115585. style?: CSSObject;
  115586. /**
  115587. * (Highcharts, Highstock, Highmaps, Gantt) The actual text of the axis
  115588. * title. It can contain basic HTML tags like `b`, `i` and `span` with
  115589. * style.
  115590. */
  115591. text?: (string|null);
  115592. /**
  115593. * (Highcharts, Highstock, Highmaps, Gantt) Alignment of the text, can be
  115594. * `"left"`, `"right"` or `"center"`. Default alignment depends on the
  115595. * title.align:
  115596. *
  115597. * Horizontal axes:
  115598. *
  115599. * - for `align` = `"low"`, `textAlign` is set to `left`
  115600. *
  115601. * - for `align` = `"middle"`, `textAlign` is set to `center`
  115602. *
  115603. * - for `align` = `"high"`, `textAlign` is set to `right`
  115604. *
  115605. * Vertical axes:
  115606. *
  115607. * - for `align` = `"low"` and `opposite` = `true`, `textAlign` is set to
  115608. * `right`
  115609. *
  115610. * - for `align` = `"low"` and `opposite` = `false`, `textAlign` is set to
  115611. * `left`
  115612. *
  115613. * - for `align` = `"middle"`, `textAlign` is set to `center`
  115614. *
  115615. * - for `align` = `"high"` and `opposite` = `true` `textAlign` is set to
  115616. * `left`
  115617. *
  115618. * - for `align` = `"high"` and `opposite` = `false` `textAlign` is set to
  115619. * `right`
  115620. */
  115621. textAlign?: AlignValue;
  115622. /**
  115623. * (Highcharts, Highstock, Gantt) Whether to use HTML to render the axis
  115624. * title.
  115625. */
  115626. useHTML?: boolean;
  115627. /**
  115628. * (Highcharts, Highstock, Gantt) Horizontal pixel offset of the title
  115629. * position.
  115630. */
  115631. x?: number;
  115632. /**
  115633. * (Highcharts, Highstock, Gantt) Vertical pixel offset of the title
  115634. * position.
  115635. */
  115636. y?: number;
  115637. }
  115638. /**
  115639. * (Gantt) Connect to a point. This option can be either a string, referring to
  115640. * the ID of another point, or an object, or an array of either. If the option
  115641. * is an array, each element defines a connection.
  115642. */
  115643. export interface XrangePointConnectorsOptionsObject {
  115644. /**
  115645. * (Gantt) Set the default dash style for this chart's connecting lines.
  115646. */
  115647. dashStyle?: string;
  115648. /**
  115649. * (Gantt) Marker options specific to the end markers for this chart's
  115650. * Pathfinder connectors. Overrides the generic marker options.
  115651. */
  115652. endMarker?: ConnectorsEndMarkerOptions;
  115653. /**
  115654. * (Gantt) Set the default color for this chart's Pathfinder connecting
  115655. * lines. Defaults to the color of the point being connected.
  115656. */
  115657. lineColor?: ColorString;
  115658. /**
  115659. * (Gantt) Set the default pixel width for this chart's Pathfinder
  115660. * connecting lines.
  115661. */
  115662. lineWidth?: number;
  115663. /**
  115664. * (Gantt) Marker options for this chart's Pathfinder connectors. Note that
  115665. * this option is overridden by the `startMarker` and `endMarker` options.
  115666. */
  115667. marker?: ConnectorsMarkerOptions;
  115668. /**
  115669. * (Gantt) Marker options specific to the start markers for this chart's
  115670. * Pathfinder connectors. Overrides the generic marker options.
  115671. */
  115672. startMarker?: ConnectorsStartMarkerOptions;
  115673. /**
  115674. * (Gantt) The ID of the point to connect to.
  115675. */
  115676. to?: string;
  115677. /**
  115678. * (Gantt) Set the default pathfinder algorithm to use for this chart. It is
  115679. * possible to define your own algorithms by adding them to the
  115680. * Highcharts.Pathfinder.prototype.algorithms object before the chart has
  115681. * been created.
  115682. *
  115683. * The default algorithms are as follows:
  115684. *
  115685. * `straight`: Draws a straight line between the connecting points. Does not
  115686. * avoid other points when drawing.
  115687. *
  115688. * `simpleConnect`: Finds a path between the points using right angles only.
  115689. * Takes only starting/ending points into account, and will not avoid other
  115690. * points.
  115691. *
  115692. * `fastAvoid`: Finds a path between the points using right angles only.
  115693. * Will attempt to avoid other points, but its focus is performance over
  115694. * accuracy. Works well with less dense datasets.
  115695. *
  115696. * Default value: `straight` is used as default for most series types, while
  115697. * `simpleConnect` is used as default for Gantt series, to show dependencies
  115698. * between points.
  115699. */
  115700. type?: PathfinderTypeValue;
  115701. }
  115702. /**
  115703. * (Highcharts, Highstock, Gantt) An array of data points for the series. For
  115704. * the `xrange` series type, points can be given in the following ways:
  115705. *
  115706. * 1. An array of objects with named values. The objects are point configuration
  115707. * objects as seen below. (see online documentation for example)
  115708. */
  115709. export interface XrangePointOptionsObject {
  115710. /**
  115711. * (Highcharts, Highstock, Gantt) Accessibility options for a data point.
  115712. */
  115713. accessibility?: PointAccessibilityOptionsObject;
  115714. /**
  115715. * (Highcharts, Gantt) An additional, individual class name for the data
  115716. * point's graphic representation.
  115717. */
  115718. className?: string;
  115719. /**
  115720. * (Highcharts, Highstock, Gantt) Individual color for the point. By default
  115721. * the color is pulled from the global `colors` array.
  115722. *
  115723. * In styled mode, the `color` option doesn't take effect. Instead, use
  115724. * `colorIndex`.
  115725. */
  115726. color?: (ColorString|GradientColorObject|PatternObject);
  115727. /**
  115728. * (Highcharts, Gantt) A specific color index to use for the point, so its
  115729. * graphic representations are given the class name `highcharts-color-{n}`.
  115730. * In styled mode this will change the color of the graphic. In non-styled
  115731. * mode, the color by is set by the `fill` attribute, so the change in class
  115732. * name won't have a visual effect by default.
  115733. */
  115734. colorIndex?: number;
  115735. /**
  115736. * (Gantt) Connect to a point. This option can be either a string, referring
  115737. * to the ID of another point, or an object, or an array of either. If the
  115738. * option is an array, each element defines a connection.
  115739. */
  115740. connect?: (string|XrangePointConnectorsOptionsObject|Array<(string|XrangePointConnectorsOptionsObject)>);
  115741. /**
  115742. * (Highcharts, Highstock, Gantt) A reserved subspace to store options and
  115743. * values for customized functionality. Here you can add additional data for
  115744. * your own event callbacks and formatter callbacks.
  115745. */
  115746. custom?: Dictionary<any>;
  115747. /**
  115748. * (Highcharts, Highstock, Gantt) Individual data label for each point. The
  115749. * options are the same as the ones for plotOptions.series.dataLabels.
  115750. */
  115751. dataLabels?: (DataLabelsOptions|Array<DataLabelsOptions>);
  115752. /**
  115753. * (Highcharts, Highstock, Gantt) A description of the point to add to the
  115754. * screen reader information about the point.
  115755. */
  115756. description?: string;
  115757. /**
  115758. * (Highcharts, Highstock, Gantt) Point specific options for the
  115759. * draggable-points module. Overrides options on `series.dragDrop`.
  115760. */
  115761. dragDrop?: SeriesLineDataDragDropOptions;
  115762. /**
  115763. * (Highcharts) The `id` of a series in the drilldown.series array to use
  115764. * for a drilldown for this point.
  115765. */
  115766. drilldown?: string;
  115767. /**
  115768. * (Highcharts, Highstock, Gantt) The individual point events.
  115769. */
  115770. events?: PointEventsOptionsObject;
  115771. /**
  115772. * (Highcharts, Highstock, Gantt) An id for the point. This can be used
  115773. * after render time to get a pointer to the point object through
  115774. * `chart.get()`.
  115775. */
  115776. id?: string;
  115777. /**
  115778. * (Highcharts, Highstock, Gantt) The rank for this point's data label in
  115779. * case of collision. If two data labels are about to overlap, only the one
  115780. * with the highest `labelrank` will be drawn.
  115781. */
  115782. labelrank?: number;
  115783. /**
  115784. * (Highcharts, Highstock) Options for the point markers of line-like
  115785. * series.
  115786. */
  115787. marker?: PointMarkerOptionsObject;
  115788. /**
  115789. * (Highcharts, Highstock, Gantt) The name of the point as shown in the
  115790. * legend, tooltip, dataLabels, etc.
  115791. */
  115792. name?: string;
  115793. /**
  115794. * (Highcharts, Highstock, Gantt) A partial fill for each point, typically
  115795. * used to visualize how much of a task is performed. The partial fill
  115796. * object can be set either on series or point level.
  115797. */
  115798. partialFill?: XrangePointPartialFillOptionsObject;
  115799. /**
  115800. * (Highcharts, Highstock, Gantt) Whether the data point is selected
  115801. * initially.
  115802. */
  115803. selected?: boolean;
  115804. /**
  115805. * (Highcharts, Highstock, Gantt) The starting X value of the range point.
  115806. */
  115807. x?: number;
  115808. /**
  115809. * (Highcharts, Highstock, Gantt) The ending X value of the range point.
  115810. */
  115811. x2?: number;
  115812. /**
  115813. * (Highcharts, Highstock, Gantt) The Y value of the range point.
  115814. */
  115815. y?: number;
  115816. }
  115817. /**
  115818. * (Highcharts, Highstock, Gantt) A partial fill for each point, typically used
  115819. * to visualize how much of a task is performed. The partial fill object can be
  115820. * set either on series or point level.
  115821. */
  115822. export interface XrangePointPartialFillOptionsObject {
  115823. /**
  115824. * (Highcharts, Highstock, Gantt) The amount of the X-range point to be
  115825. * filled. Values can be 0-1 and are converted to percentages in the default
  115826. * data label formatter.
  115827. */
  115828. amount?: number;
  115829. /**
  115830. * (Highcharts, Highstock, Gantt) The fill color to be used for partial
  115831. * fills. Defaults to a darker shade of the point color.
  115832. */
  115833. fill?: (ColorString|GradientColorObject|PatternObject);
  115834. }
  115835. /**
  115836. * (Highcharts, Highstock, Gantt) An array defining breaks in the axis, the
  115837. * sections defined will be left out and all the points shifted closer to each
  115838. * other.
  115839. */
  115840. export interface YAxisBreaksOptions {
  115841. /**
  115842. * (Highcharts, Highstock, Gantt) A number indicating how much space should
  115843. * be left between the start and the end of the break. The break size is
  115844. * given in axis units, so for instance on a `datetime` axis, a break size
  115845. * of 3600000 would indicate the equivalent of an hour.
  115846. */
  115847. breakSize?: number;
  115848. /**
  115849. * (Highcharts, Highstock, Gantt) The point where the break starts.
  115850. */
  115851. from?: number;
  115852. /**
  115853. * (Highcharts, Highstock, Gantt) Defines an interval after which the break
  115854. * appears again. By default the breaks do not repeat.
  115855. */
  115856. repeat?: number;
  115857. /**
  115858. * (Highcharts, Highstock, Gantt) The point where the break ends.
  115859. */
  115860. to?: number;
  115861. }
  115862. /**
  115863. * (Highcharts, Highstock, Highmaps, Gantt) Event handlers for the axis.
  115864. */
  115865. export interface YAxisEventsOptions {
  115866. /**
  115867. * (Highcharts, Gantt) An event fired after the breaks have rendered.
  115868. */
  115869. afterBreaks?: AxisEventCallbackFunction;
  115870. /**
  115871. * (Highcharts, Highstock, Highmaps, Gantt) As opposed to the `setExtremes`
  115872. * event, this event fires after the final min and max values are computed
  115873. * and corrected for `minRange`.
  115874. *
  115875. * Fires when the minimum and maximum is set for the axis, either by calling
  115876. * the `.setExtremes()` method or by selecting an area in the chart. One
  115877. * parameter, `event`, is passed to the function, containing common event
  115878. * information.
  115879. *
  115880. * The new user set minimum and maximum values can be found by `event.min`
  115881. * and `event.max`. These reflect the axis minimum and maximum in axis
  115882. * values. The actual data extremes are found in `event.dataMin` and
  115883. * `event.dataMax`.
  115884. */
  115885. afterSetExtremes?: AxisSetExtremesEventCallbackFunction;
  115886. /**
  115887. * (Highcharts, Gantt) An event fired when a break from this axis occurs on
  115888. * a point.
  115889. */
  115890. pointBreak?: AxisPointBreakEventCallbackFunction;
  115891. /**
  115892. * (Highcharts, Highstock, Gantt) An event fired when a point falls inside a
  115893. * break from this axis.
  115894. */
  115895. pointInBreak?: AxisPointBreakEventCallbackFunction;
  115896. /**
  115897. * (Highcharts, Highstock, Highmaps, Gantt) Fires when the minimum and
  115898. * maximum is set for the axis, either by calling the `.setExtremes()`
  115899. * method or by selecting an area in the chart. One parameter, `event`, is
  115900. * passed to the function, containing common event information.
  115901. *
  115902. * The new user set minimum and maximum values can be found by `event.min`
  115903. * and `event.max`. These reflect the axis minimum and maximum in data
  115904. * values. When an axis is zoomed all the way out from the "Reset zoom"
  115905. * button, `event.min` and `event.max` are null, and the new extremes are
  115906. * set based on `this.dataMin` and `this.dataMax`.
  115907. */
  115908. setExtremes?: AxisSetExtremesEventCallbackFunction;
  115909. }
  115910. /**
  115911. * (Gantt) Set grid options for the axis labels. Requires Highcharts Gantt.
  115912. */
  115913. export interface YAxisGridOptions {
  115914. /**
  115915. * (Gantt) Set border color for the label grid lines.
  115916. */
  115917. borderColor?: ColorString;
  115918. /**
  115919. * (Gantt) Set border width of the label grid lines.
  115920. */
  115921. borderWidth?: number;
  115922. /**
  115923. * (Gantt) Set cell height for grid axis labels. By default this is
  115924. * calculated from font size. This option only applies to horizontal axes.
  115925. */
  115926. cellHeight?: number;
  115927. /**
  115928. * (Gantt) Set specific options for each column (or row for horizontal axes)
  115929. * in the grid. Each extra column/row is its own axis, and the axis options
  115930. * can be set here.
  115931. */
  115932. columns?: Array<XAxisOptions>;
  115933. /**
  115934. * (Gantt) Enable grid on the axis labels. Defaults to true for Gantt
  115935. * charts.
  115936. */
  115937. enabled?: boolean;
  115938. }
  115939. /**
  115940. * (Gantt) Set options on specific levels in a tree grid axis. Takes precedence
  115941. * over labels options.
  115942. */
  115943. export interface YAxisLabelsLevelsOptions {
  115944. /**
  115945. * (Gantt) Specify the level which the options within this object applies
  115946. * to.
  115947. */
  115948. level?: number;
  115949. style?: CSSObject;
  115950. }
  115951. /**
  115952. * (Highcharts, Highstock, Highmaps, Gantt) The axis labels show the number or
  115953. * category for each tick.
  115954. *
  115955. * Since v8.0.0: Labels are animated in categorized x-axis with updating data if
  115956. * `tickInterval` and `step` is set to 1.
  115957. */
  115958. export interface YAxisLabelsOptions {
  115959. /**
  115960. * (Highcharts, Highstock, Highmaps, Gantt) What part of the string the
  115961. * given position is anchored to. Can be one of `"left"`, `"center"` or
  115962. * `"right"`. The exact position also depends on the `labels.x` setting.
  115963. *
  115964. * Angular gauges and solid gauges defaults to `"center"`. Solid gauges with
  115965. * two labels have additional option `"auto"` for automatic horizontal and
  115966. * vertical alignment.
  115967. */
  115968. align?: AlignValue;
  115969. /**
  115970. * (Highcharts, Highstock, Gantt) For horizontal axes, the allowed degrees
  115971. * of label rotation to prevent overlapping labels. If there is enough
  115972. * space, labels are not rotated. As the chart gets narrower, it will start
  115973. * rotating the labels -45 degrees, then remove every second label and try
  115974. * again with rotations 0 and -45 etc. Set it to `false` to disable
  115975. * rotation, which will cause the labels to word-wrap if possible.
  115976. */
  115977. autoRotation?: (false|Array<number>);
  115978. /**
  115979. * (Highcharts, Gantt) When each category width is more than this many
  115980. * pixels, we don't apply auto rotation. Instead, we lay out the axis label
  115981. * with word wrap. A lower limit makes sense when the label contains
  115982. * multiple short words that don't extend the available horizontal space for
  115983. * each label.
  115984. */
  115985. autoRotationLimit?: number;
  115986. /**
  115987. * (Highcharts) Angular gauges and solid gauges only. The label's pixel
  115988. * distance from the perimeter of the plot area.
  115989. *
  115990. * Since v7.1.2: If it's a percentage string, it is interpreted the same as
  115991. * series.radius, so label can be aligned under the gauge's shape.
  115992. */
  115993. distance?: (number|string);
  115994. /**
  115995. * (Highcharts, Highstock, Highmaps, Gantt) Enable or disable the axis
  115996. * labels.
  115997. */
  115998. enabled?: boolean;
  115999. /**
  116000. * (Highcharts, Highstock, Highmaps, Gantt) A format string for the axis
  116001. * label. See format string for example usage.
  116002. *
  116003. * Note: The default value is not specified due to the dynamic nature of the
  116004. * default implementation.
  116005. */
  116006. format?: string;
  116007. /**
  116008. * (Highcharts, Highstock, Highmaps, Gantt) Callback JavaScript function to
  116009. * format the label. The value is given by `this.value`. Additional
  116010. * properties for `this` are `axis`, `chart`, `isFirst` and `isLast`. The
  116011. * value of the default label formatter can be retrieved by calling
  116012. * `this.axis.defaultLabelFormatter.call(this)` within the function.
  116013. *
  116014. * Defaults to: (see online documentation for example)
  116015. */
  116016. formatter?: AxisLabelsFormatterCallbackFunction;
  116017. /**
  116018. * (Gantt) The number of pixels to indent the labels per level in a treegrid
  116019. * axis.
  116020. */
  116021. indentation?: number;
  116022. /**
  116023. * (Gantt) Set options on specific levels in a tree grid axis. Takes
  116024. * precedence over labels options.
  116025. */
  116026. levels?: Array<YAxisLabelsLevelsOptions>;
  116027. /**
  116028. * (Highcharts, Highstock, Highmaps, Gantt) How to handle overflowing labels
  116029. * on horizontal axis. If set to `"allow"`, it will not be aligned at all.
  116030. * By default it `"justify"` labels inside the chart area. If there is room
  116031. * to move it, it will be aligned to the edge, else it will be removed.
  116032. */
  116033. overflow?: OptionsOverflowValue;
  116034. /**
  116035. * (Highcharts, Gantt) The pixel padding for axis labels, to ensure white
  116036. * space between them.
  116037. */
  116038. padding?: number;
  116039. /**
  116040. * (Highcharts) Defines how the labels are be repositioned according to the
  116041. * 3D chart orientation.
  116042. *
  116043. * - `'offset'`: Maintain a fixed horizontal/vertical distance from the tick
  116044. * marks, despite the chart orientation. This is the backwards compatible
  116045. * behavior, and causes skewing of X and Z axes.
  116046. *
  116047. * - `'chart'`: Preserve 3D position relative to the chart. This looks nice,
  116048. * but hard to read if the text isn't forward-facing.
  116049. *
  116050. * - `'flap'`: Rotated text along the axis to compensate for the chart
  116051. * orientation. This tries to maintain text as legible as possible on all
  116052. * orientations.
  116053. *
  116054. * - `'ortho'`: Rotated text along the axis direction so that the labels are
  116055. * orthogonal to the axis. This is very similar to `'flap'`, but prevents
  116056. * skewing the labels (X and Y scaling are still present).
  116057. */
  116058. position3d?: OptionsPosition3dValue;
  116059. /**
  116060. * (Highcharts, Gantt) Whether to reserve space for the labels. By default,
  116061. * space is reserved for the labels in these cases:
  116062. *
  116063. * * On all horizontal axes.
  116064. *
  116065. * * On vertical axes if `label.align` is `right` on a left-side axis or
  116066. * `left` on a right-side axis.
  116067. *
  116068. * * On vertical axes if `label.align` is `center`.
  116069. *
  116070. * This can be turned off when for example the labels are rendered inside
  116071. * the plot area instead of outside.
  116072. */
  116073. reserveSpace?: boolean;
  116074. /**
  116075. * (Highcharts, Highstock, Highmaps, Gantt) Rotation of the labels in
  116076. * degrees.
  116077. */
  116078. rotation?: number;
  116079. /**
  116080. * (Highcharts) If enabled, the axis labels will skewed to follow the
  116081. * perspective.
  116082. *
  116083. * This will fix overlapping labels and titles, but texts become less
  116084. * legible due to the distortion.
  116085. *
  116086. * The final appearance depends heavily on `labels.position3d`.
  116087. */
  116088. skew3d?: boolean;
  116089. /**
  116090. * (Highcharts, Highstock, Highmaps, Gantt) Horizontal axes only. The number
  116091. * of lines to spread the labels over to make room or tighter labels.
  116092. */
  116093. staggerLines?: number;
  116094. /**
  116095. * (Highcharts, Highstock, Highmaps, Gantt) To show only every _n_'th label
  116096. * on the axis, set the step to _n_. Setting the step to 2 shows every other
  116097. * label.
  116098. *
  116099. * By default, the step is calculated automatically to avoid overlap. To
  116100. * prevent this, set it to 1\. This usually only happens on a category axis,
  116101. * and is often a sign that you have chosen the wrong axis type.
  116102. *
  116103. * Read more at Axis docs => What axis should I use?
  116104. */
  116105. step?: number;
  116106. /**
  116107. * (Highcharts, Highstock, Highmaps, Gantt) CSS styles for the label. Use
  116108. * `whiteSpace: 'nowrap'` to prevent wrapping of category labels. Use
  116109. * `textOverflow: 'none'` to prevent ellipsis (dots).
  116110. *
  116111. * In styled mode, the labels are styled with the `.highcharts-axis-labels`
  116112. * class.
  116113. */
  116114. style?: CSSObject;
  116115. /**
  116116. * (Gantt) The symbol for the collapse and expand icon in a treegrid.
  116117. */
  116118. symbol?: YAxisLabelsSymbolOptions;
  116119. /**
  116120. * (Highcharts, Highstock, Highmaps, Gantt) Whether to use HTML to render
  116121. * the labels.
  116122. */
  116123. useHTML?: boolean;
  116124. /**
  116125. * (Highcharts, Highstock, Highmaps, Gantt) The x position offset of all
  116126. * labels relative to the tick positions on the axis. Defaults to -15 for
  116127. * left axis, 15 for right axis.
  116128. */
  116129. x?: number;
  116130. /**
  116131. * (Highcharts, Highstock, Highmaps, Gantt) The y position offset of all
  116132. * labels relative to the tick positions on the axis. For polar and radial
  116133. * axis consider the use of the distance option.
  116134. */
  116135. y?: number;
  116136. /**
  116137. * (Highcharts, Highstock, Highmaps, Gantt) The Z index for the axis labels.
  116138. */
  116139. zIndex?: number;
  116140. }
  116141. /**
  116142. * (Gantt) The symbol for the collapse and expand icon in a treegrid.
  116143. */
  116144. export interface YAxisLabelsSymbolOptions {
  116145. height?: number;
  116146. padding?: number;
  116147. /**
  116148. * (Gantt) The symbol type. Points to a definition function in the
  116149. * `Highcharts.Renderer.symbols` collection.
  116150. */
  116151. type?: SymbolKeyValue;
  116152. width?: number;
  116153. x?: number;
  116154. y?: number;
  116155. }
  116156. /**
  116157. * (Highcharts, Highstock, Highmaps, Gantt) The Y axis or value axis. Normally
  116158. * this is the vertical axis, though if the chart is inverted this is the
  116159. * horizontal axis. In case of multiple axes, the yAxis node is an array of
  116160. * configuration objects.
  116161. *
  116162. * See the Axis object for programmatic access to the axis.
  116163. */
  116164. export interface YAxisOptions {
  116165. /**
  116166. * (Highcharts, Highstock, Highmaps, Gantt) Accessibility options for an
  116167. * axis. Requires the accessibility module.
  116168. */
  116169. accessibility?: AxisAccessibilityOptionsObject;
  116170. /**
  116171. * (Highcharts, Highstock, Gantt) When using multiple axis, the ticks of two
  116172. * or more opposite axes will automatically be aligned by adding ticks to
  116173. * the axis or axes with the least ticks, as if `tickAmount` were specified.
  116174. *
  116175. * This can be prevented by setting `alignTicks` to false. If the grid lines
  116176. * look messy, it's a good idea to hide them for the secondary axis by
  116177. * setting `gridLineWidth` to 0.
  116178. *
  116179. * If `startOnTick` or `endOnTick` in an Axis options are set to false, then
  116180. * the `alignTicks ` will be disabled for the Axis.
  116181. *
  116182. * Disabled for logarithmic axes.
  116183. */
  116184. alignTicks?: boolean;
  116185. /**
  116186. * (Highcharts, Highstock, Highmaps, Gantt) Whether to allow decimals in
  116187. * this axis' ticks. When counting integers, like persons or hits on a web
  116188. * page, decimals should be avoided in the labels.
  116189. */
  116190. allowDecimals?: boolean;
  116191. /**
  116192. * (Highcharts, Highstock, Highmaps, Gantt) When using an alternate grid
  116193. * color, a band is painted across the plot area between every other grid
  116194. * line.
  116195. */
  116196. alternateGridColor?: ColorType;
  116197. /**
  116198. * (Highcharts) In a polar chart, this is the angle of the Y axis in
  116199. * degrees, where 0 is up and 90 is right. The angle determines the position
  116200. * of the axis line and the labels, though the coordinate system is
  116201. * unaffected. Since v8.0.0 this option is also applicable for X axis
  116202. * (inverted polar).
  116203. */
  116204. angle?: number;
  116205. /**
  116206. * (Highcharts, Highstock, Gantt) An array defining breaks in the axis, the
  116207. * sections defined will be left out and all the points shifted closer to
  116208. * each other.
  116209. */
  116210. breaks?: Array<YAxisBreaksOptions>;
  116211. /**
  116212. * (Highcharts, Gantt) If categories are present for the xAxis, names are
  116213. * used instead of numbers for that axis.
  116214. *
  116215. * Since Highcharts 3.0, categories can also be extracted by giving each
  116216. * point a name and setting axis type to `category`. However, if you have
  116217. * multiple series, best practice remains defining the `categories` array.
  116218. *
  116219. * Example: `categories: ['Apples', 'Bananas', 'Oranges']`
  116220. */
  116221. categories?: Array<string>;
  116222. /**
  116223. * (Highcharts, Highstock, Gantt) The highest allowed value for
  116224. * automatically computed axis extremes.
  116225. */
  116226. ceiling?: number;
  116227. /**
  116228. * (Highcharts, Highstock, Highmaps, Gantt) A class name that opens for
  116229. * styling the axis by CSS, especially in Highcharts styled mode. The class
  116230. * name is applied to group elements for the grid, axis elements and labels.
  116231. */
  116232. className?: string;
  116233. /**
  116234. * (Highcharts, Highstock, Highmaps, Gantt) Configure a crosshair that
  116235. * follows either the mouse pointer or the hovered point.
  116236. *
  116237. * In styled mode, the crosshairs are styled in the `.highcharts-crosshair`,
  116238. * `.highcharts-crosshair-thin` or `.highcharts-xaxis-category` classes.
  116239. */
  116240. crosshair?: (boolean|AxisCrosshairOptions);
  116241. /**
  116242. * (Highcharts, Highstock, Gantt) For a datetime axis, the scale will
  116243. * automatically adjust to the appropriate unit. This member gives the
  116244. * default string representations used for each unit. For intermediate
  116245. * values, different units may be used, for example the `day` unit can be
  116246. * used on midnight and `hour` unit be used for intermediate values on the
  116247. * same axis.
  116248. *
  116249. * For an overview of the replacement codes, see dateFormat.
  116250. *
  116251. * Defaults to: (see online documentation for example)
  116252. */
  116253. dateTimeLabelFormats?: AxisDateTimeLabelFormatsOptions;
  116254. /**
  116255. * (Highcharts, Highstock, Highmaps, Gantt) Whether to force the axis to end
  116256. * on a tick. Use this option with the `maxPadding` option to control the
  116257. * axis end.
  116258. *
  116259. * This option is always disabled, when panning type is either `y` or `xy`.
  116260. */
  116261. endOnTick?: boolean;
  116262. /**
  116263. * (Highcharts, Highstock, Highmaps, Gantt) Event handlers for the axis.
  116264. */
  116265. events?: YAxisEventsOptions;
  116266. /**
  116267. * (Highcharts, Highstock, Gantt) The lowest allowed value for automatically
  116268. * computed axis extremes.
  116269. */
  116270. floor?: number;
  116271. /**
  116272. * (Gantt) Set grid options for the axis labels. Requires Highcharts Gantt.
  116273. */
  116274. grid?: YAxisGridOptions;
  116275. /**
  116276. * (Highcharts, Highstock, Highmaps, Gantt) Color of the grid lines
  116277. * extending the ticks across the plot area.
  116278. *
  116279. * In styled mode, the stroke is given in the `.highcharts-grid-line` class.
  116280. */
  116281. gridLineColor?: ColorType;
  116282. /**
  116283. * (Highcharts, Highstock, Highmaps, Gantt) The dash or dot style of the
  116284. * grid lines. For possible values, see this demonstration.
  116285. */
  116286. gridLineDashStyle?: DashStyleValue;
  116287. /**
  116288. * (Highcharts) Polar charts only. Whether the grid lines should draw as a
  116289. * polygon with straight lines between categories, or as circles. Can be
  116290. * either `circle` or `polygon`. Since v8.0.0 this option is also applicable
  116291. * for X axis (inverted polar).
  116292. */
  116293. gridLineInterpolation?: OptionsGridLineInterpolationValue;
  116294. /**
  116295. * (Highcharts, Highstock, Highmaps, Gantt) The width of the grid lines
  116296. * extending the ticks across the plot area.
  116297. *
  116298. * In styled mode, the stroke width is given in the `.highcharts-grid-line`
  116299. * class.
  116300. */
  116301. gridLineWidth?: number;
  116302. /**
  116303. * (Highcharts, Highstock, Gantt) The Z index of the grid lines.
  116304. */
  116305. gridZIndex?: number;
  116306. /**
  116307. * (Highcharts, Highstock) The height of the Y axis. If it's a number, it is
  116308. * interpreted as pixels.
  116309. *
  116310. * Since Highcharts 2: If it's a percentage string, it is interpreted as
  116311. * percentages of the total plot height.
  116312. */
  116313. height?: (number|string);
  116314. /**
  116315. * (Highcharts, Highstock, Highmaps, Gantt) An id for the axis. This can be
  116316. * used after render time to get a pointer to the axis object through
  116317. * `chart.get()`.
  116318. */
  116319. id?: string;
  116320. /**
  116321. * (Highcharts, Highstock, Highmaps, Gantt) The axis labels show the number
  116322. * or category for each tick.
  116323. *
  116324. * Since v8.0.0: Labels are animated in categorized x-axis with updating
  116325. * data if `tickInterval` and `step` is set to 1.
  116326. */
  116327. labels?: YAxisLabelsOptions;
  116328. /**
  116329. * (Highcharts, Highstock) The left position as the horizontal axis. If it's
  116330. * a number, it is interpreted as pixel position relative to the chart.
  116331. *
  116332. * Since Highcharts v5.0.13: If it's a percentage string, it is interpreted
  116333. * as percentages of the plot width, offset from plot area left.
  116334. */
  116335. left?: (number|string);
  116336. /**
  116337. * (Highcharts, Highstock, Highmaps, Gantt) The color of the line marking
  116338. * the axis itself.
  116339. *
  116340. * In styled mode, the line stroke is given in the `.highcharts-axis-line`
  116341. * or `.highcharts-xaxis-line` class.
  116342. */
  116343. lineColor?: ColorType;
  116344. /**
  116345. * (Highcharts, Highstock, Highmaps, Gantt) The width of the line marking
  116346. * the axis itself.
  116347. *
  116348. * In styled mode, the stroke width is given in the `.highcharts-axis-line`
  116349. * or `.highcharts-xaxis-line` class.
  116350. */
  116351. lineWidth?: number;
  116352. /**
  116353. * (Highcharts, Highstock, Gantt) Index of another axis that this axis is
  116354. * linked to. When an axis is linked to a master axis, it will take the same
  116355. * extremes as the master, but as assigned by min or max or by setExtremes.
  116356. * It can be used to show additional info, or to ease reading the chart by
  116357. * duplicating the scales.
  116358. */
  116359. linkedTo?: number;
  116360. /**
  116361. * (Highcharts, Highstock, Highmaps, Gantt) If there are multiple axes on
  116362. * the same side of the chart, the pixel margin between the axes. Defaults
  116363. * to 0 on vertical axes, 15 on horizontal axes.
  116364. */
  116365. margin?: number;
  116366. /**
  116367. * (Highcharts, Highstock, Highmaps, Gantt) The maximum value of the axis.
  116368. * If `null`, the max value is automatically calculated.
  116369. *
  116370. * If the endOnTick option is true, the `max` value might be rounded up.
  116371. *
  116372. * If a tickAmount is set, the axis may be extended beyond the set max in
  116373. * order to reach the given number of ticks. The same may happen in a chart
  116374. * with multiple axes, determined by chart. alignTicks, where a `tickAmount`
  116375. * is applied internally.
  116376. */
  116377. max?: (number|null);
  116378. /**
  116379. * (Highcharts) Solid gauge only. Unless stops are set, the color to
  116380. * represent the maximum value of the Y axis.
  116381. */
  116382. maxColor?: ColorType;
  116383. /**
  116384. * (Highstock) Maximal size of a resizable axis. Could be set as a percent
  116385. * of plot area or pixel size.
  116386. */
  116387. maxLength?: (number|string);
  116388. /**
  116389. * (Highcharts, Highstock, Gantt) Padding of the max value relative to the
  116390. * length of the axis. A padding of 0.05 will make a 100px axis 5px longer.
  116391. * This is useful when you don't want the highest data value to appear on
  116392. * the edge of the plot area. When the axis' `max` option is set or a max
  116393. * extreme is set using `axis.setExtremes()`, the maxPadding will be
  116394. * ignored.
  116395. *
  116396. * Also the `softThreshold` option takes precedence over `maxPadding`, so if
  116397. * the data is tangent to the threshold, `maxPadding` may not apply unless
  116398. * `softThreshold` is set to false.
  116399. */
  116400. maxPadding?: number;
  116401. /**
  116402. * (Highstock, Gantt) Maximum range which can be set using the navigator's
  116403. * handles. Opposite of xAxis.minRange.
  116404. */
  116405. maxRange?: number;
  116406. /**
  116407. * (Highcharts, Highstock, Highmaps, Gantt) The minimum value of the axis.
  116408. * If `null` the min value is automatically calculated.
  116409. *
  116410. * If the startOnTick option is true (default), the `min` value might be
  116411. * rounded down.
  116412. *
  116413. * The automatically calculated minimum value is also affected by floor,
  116414. * softMin, minPadding, minRange as well as series.threshold and
  116415. * series.softThreshold.
  116416. */
  116417. min?: (number|null);
  116418. /**
  116419. * (Highcharts) Solid gauge only. Unless stops are set, the color to
  116420. * represent the minimum value of the Y axis.
  116421. */
  116422. minColor?: ColorType;
  116423. /**
  116424. * (Highstock) Minimal size of a resizable axis. Could be set as a percent
  116425. * of plot area or pixel size.
  116426. */
  116427. minLength?: (number|string);
  116428. /**
  116429. * (Highcharts, Highstock, Highmaps, Gantt) Color of the minor, secondary
  116430. * grid lines.
  116431. *
  116432. * In styled mode, the stroke width is given in the
  116433. * `.highcharts-minor-grid-line` class.
  116434. */
  116435. minorGridLineColor?: ColorType;
  116436. /**
  116437. * (Highcharts, Highstock, Highmaps, Gantt) The dash or dot style of the
  116438. * minor grid lines. For possible values, see this demonstration.
  116439. */
  116440. minorGridLineDashStyle?: DashStyleValue;
  116441. /**
  116442. * (Highcharts, Highstock, Highmaps, Gantt) Width of the minor, secondary
  116443. * grid lines.
  116444. *
  116445. * In styled mode, the stroke width is given in the `.highcharts-grid-line`
  116446. * class.
  116447. */
  116448. minorGridLineWidth?: number;
  116449. /**
  116450. * (Highcharts, Highstock, Highmaps, Gantt) Color for the minor tick marks.
  116451. */
  116452. minorTickColor?: ColorType;
  116453. /**
  116454. * (Highcharts, Highstock, Highmaps, Gantt) Specific tick interval in axis
  116455. * units for the minor ticks. On a linear axis, if `"auto"`, the minor tick
  116456. * interval is calculated as a fifth of the tickInterval. If `null` or
  116457. * `undefined`, minor ticks are not shown.
  116458. *
  116459. * On logarithmic axes, the unit is the power of the value. For example,
  116460. * setting the minorTickInterval to 1 puts one tick on each of 0.1, 1, 10,
  116461. * 100 etc. Setting the minorTickInterval to 0.1 produces 9 ticks between 1
  116462. * and 10, 10 and 100 etc.
  116463. *
  116464. * If user settings dictate minor ticks to become too dense, they don't make
  116465. * sense, and will be ignored to prevent performance problems.
  116466. */
  116467. minorTickInterval?: (number|string|null);
  116468. /**
  116469. * (Highcharts, Highstock, Highmaps, Gantt) The pixel length of the minor
  116470. * tick marks.
  116471. */
  116472. minorTickLength?: number;
  116473. /**
  116474. * (Highcharts, Highstock, Highmaps, Gantt) The position of the minor tick
  116475. * marks relative to the axis line. Can be one of `inside` and `outside`.
  116476. */
  116477. minorTickPosition?: OptionsMinorTickPositionValue;
  116478. /**
  116479. * (Highcharts, Highstock, Highmaps, Gantt) Enable or disable minor ticks.
  116480. * Unless minorTickInterval is set, the tick interval is calculated as a
  116481. * fifth of the `tickInterval`.
  116482. *
  116483. * On a logarithmic axis, minor ticks are laid out based on a best guess,
  116484. * attempting to enter approximately 5 minor ticks between each major tick.
  116485. *
  116486. * Prior to v6.0.0, ticks were unabled in auto layout by setting
  116487. * `minorTickInterval` to `"auto"`.
  116488. */
  116489. minorTicks?: boolean;
  116490. /**
  116491. * (Highcharts, Highstock, Highmaps, Gantt) The pixel width of the minor
  116492. * tick mark.
  116493. */
  116494. minorTickWidth?: number;
  116495. /**
  116496. * (Highcharts, Highstock, Gantt) Padding of the min value relative to the
  116497. * length of the axis. A padding of 0.05 will make a 100px axis 5px longer.
  116498. * This is useful when you don't want the lowest data value to appear on the
  116499. * edge of the plot area. When the axis' `min` option is set or a max
  116500. * extreme is set using `axis.setExtremes()`, the maxPadding will be
  116501. * ignored.
  116502. *
  116503. * Also the `softThreshold` option takes precedence over `minPadding`, so if
  116504. * the data is tangent to the threshold, `minPadding` may not apply unless
  116505. * `softThreshold` is set to false.
  116506. */
  116507. minPadding?: number;
  116508. /**
  116509. * (Highcharts, Highstock, Highmaps, Gantt) The minimum range to display on
  116510. * this axis. The entire axis will not be allowed to span over a smaller
  116511. * interval than this. For example, for a datetime axis the main unit is
  116512. * milliseconds. If minRange is set to 3600000, you can't zoom in more than
  116513. * to one hour.
  116514. *
  116515. * The default minRange for the x axis is five times the smallest interval
  116516. * between any of the data points.
  116517. *
  116518. * On a logarithmic axis, the unit for the minimum range is the power. So a
  116519. * minRange of 1 means that the axis can be zoomed to 10-100, 100-1000,
  116520. * 1000-10000 etc.
  116521. *
  116522. * **Note**: The `minPadding`, `maxPadding`, `startOnTick` and `endOnTick`
  116523. * settings also affect how the extremes of the axis are computed.
  116524. */
  116525. minRange?: number;
  116526. /**
  116527. * (Highcharts, Highstock, Highmaps, Gantt) The minimum tick interval
  116528. * allowed in axis values. For example on zooming in on an axis with daily
  116529. * data, this can be used to prevent the axis from showing hours. Defaults
  116530. * to the closest distance between two points on the axis.
  116531. */
  116532. minTickInterval?: number;
  116533. /**
  116534. * (Highcharts, Highstock, Highmaps, Gantt) The distance in pixels from the
  116535. * plot area to the axis line. A positive offset moves the axis with it's
  116536. * line, labels and ticks away from the plot area. This is typically used
  116537. * when two or more axes are displayed on the same side of the plot. With
  116538. * multiple axes the offset is dynamically adjusted to avoid collision, this
  116539. * can be overridden by setting offset explicitly.
  116540. */
  116541. offset?: number;
  116542. /**
  116543. * (Highstock, Highcharts, Gantt) Whether to display the axis on the
  116544. * opposite side of the normal. The normal is on the left side for vertical
  116545. * axes and bottom for horizontal, so the opposite sides will be right and
  116546. * top respectively. This is typically used with dual or multiple axes.
  116547. */
  116548. opposite?: boolean;
  116549. /**
  116550. * (Highcharts) Refers to the index in the panes array. Used for circular
  116551. * gauges and polar charts. When the option is not set then first pane will
  116552. * be used.
  116553. */
  116554. pane?: number;
  116555. /**
  116556. * (Highcharts, Highstock, Gantt) An array of colored bands stretching
  116557. * across the plot area marking an interval on the axis.
  116558. *
  116559. * In styled mode, the plot bands are styled by the `.highcharts-plot-band`
  116560. * class in addition to the `className` option.
  116561. */
  116562. plotBands?: Array<YAxisPlotBandsOptions>;
  116563. /**
  116564. * (Highcharts, Highstock, Gantt) An array of lines stretching across the
  116565. * plot area, marking a specific value on one of the axes.
  116566. *
  116567. * In styled mode, the plot lines are styled by the `.highcharts-plot-line`
  116568. * class in addition to the `className` option.
  116569. */
  116570. plotLines?: Array<YAxisPlotLinesOptions>;
  116571. /**
  116572. * (Highstock) The zoomed range to display when only defining one or none of
  116573. * `min` or `max`. For example, to show the latest month, a range of one
  116574. * month can be set.
  116575. */
  116576. range?: number;
  116577. /**
  116578. * (Highstock) Options for axis resizing. It adds a thick line between panes
  116579. * which the user can drag in order to resize the panes.
  116580. */
  116581. resize?: YAxisResizeOptions;
  116582. /**
  116583. * (Highcharts, Highstock, Highmaps, Gantt) Whether to reverse the axis so
  116584. * that the highest number is closest to the origin.
  116585. */
  116586. reversed?: boolean;
  116587. /**
  116588. * (Highcharts, Highstock) If `true`, the first series in a stack will be
  116589. * drawn on top in a positive, non-reversed Y axis. If `false`, the first
  116590. * series is in the base of the stack.
  116591. */
  116592. reversedStacks?: boolean;
  116593. /**
  116594. * (Highstock) An optional scrollbar to display on the Y axis in response to
  116595. * limiting the minimum an maximum of the axis values.
  116596. *
  116597. * In styled mode, all the presentational options for the scrollbar are
  116598. * replaced by the classes `.highcharts-scrollbar-thumb`,
  116599. * `.highcharts-scrollbar-arrow`, `.highcharts-scrollbar-button`,
  116600. * `.highcharts-scrollbar-rifles` and `.highcharts-scrollbar-track`.
  116601. */
  116602. scrollbar?: YAxisScrollbarOptions;
  116603. /**
  116604. * (Highcharts, Highstock, Highmaps, Gantt) Whether to show the axis line
  116605. * and title when the axis has no data.
  116606. */
  116607. showEmpty?: boolean;
  116608. /**
  116609. * (Highcharts, Highstock, Highmaps, Gantt) Whether to show the first tick
  116610. * label.
  116611. */
  116612. showFirstLabel?: boolean;
  116613. /**
  116614. * (Highcharts, Highstock, Gantt) Whether to show the last tick label.
  116615. * Defaults to `true` on cartesian charts, and `false` on polar charts.
  116616. */
  116617. showLastLabel?: boolean;
  116618. /**
  116619. * (Highcharts, Highstock, Gantt) A soft maximum for the axis. If the series
  116620. * data maximum is less than this, the axis will stay at this maximum, but
  116621. * if the series data maximum is higher, the axis will flex to show all
  116622. * data.
  116623. *
  116624. * **Note**: The series.softThreshold option takes precedence over this
  116625. * option.
  116626. */
  116627. softMax?: number;
  116628. /**
  116629. * (Highcharts, Highstock, Gantt) A soft minimum for the axis. If the series
  116630. * data minimum is greater than this, the axis will stay at this minimum,
  116631. * but if the series data minimum is lower, the axis will flex to show all
  116632. * data.
  116633. *
  116634. * **Note**: The series.softThreshold option takes precedence over this
  116635. * option.
  116636. */
  116637. softMin?: number;
  116638. /**
  116639. * (Highcharts) The stack labels show the total value for each bar in a
  116640. * stacked column or bar chart. The label will be placed on top of positive
  116641. * columns and below negative columns. In case of an inverted column chart
  116642. * or a bar chart the label is placed to the right of positive bars and to
  116643. * the left of negative bars.
  116644. */
  116645. stackLabels?: YAxisStackLabelsOptions;
  116646. /**
  116647. * (Highcharts, Highstock, Gantt) For datetime axes, this decides where to
  116648. * put the tick between weeks. 0 = Sunday, 1 = Monday.
  116649. */
  116650. startOfWeek?: number;
  116651. /**
  116652. * (Highcharts, Highstock, Gantt) Whether to force the axis to start on a
  116653. * tick. Use this option with the `maxPadding` option to control the axis
  116654. * start.
  116655. *
  116656. * This option is always disabled, when panning type is either `y` or `xy`.
  116657. */
  116658. startOnTick?: boolean;
  116659. /**
  116660. * (Gantt) For vertical axes only. Setting the static scale ensures that
  116661. * each tick unit is translated into a fixed pixel height. For example,
  116662. * setting the static scale to 24 results in each Y axis category taking up
  116663. * 24 pixels, and the height of the chart adjusts. Adding or removing items
  116664. * will make the chart resize.
  116665. */
  116666. staticScale?: number;
  116667. /**
  116668. * (Highcharts) Solid gauge series only. Color stops for the solid gauge.
  116669. * Use this in cases where a linear gradient between a `minColor` and
  116670. * `maxColor` is not sufficient. The stops is an array of tuples, where the
  116671. * first item is a float between 0 and 1 assigning the relative position in
  116672. * the gradient, and the second item is the color.
  116673. *
  116674. * For solid gauges, the Y axis also inherits the concept of data classes
  116675. * from the Highmaps color axis.
  116676. */
  116677. stops?: Array<[number, ColorType]>;
  116678. /**
  116679. * (Highcharts, Highstock, Gantt) The amount of ticks to draw on the axis.
  116680. * This opens up for aligning the ticks of multiple charts or panes within a
  116681. * chart. This option overrides the `tickPixelInterval` option.
  116682. *
  116683. * This option only has an effect on linear axes. Datetime, logarithmic or
  116684. * category axes are not affected.
  116685. */
  116686. tickAmount?: number;
  116687. /**
  116688. * (Highcharts, Highstock, Highmaps, Gantt) Color for the main tick marks.
  116689. *
  116690. * In styled mode, the stroke is given in the `.highcharts-tick` class.
  116691. */
  116692. tickColor?: ColorType;
  116693. /**
  116694. * (Highcharts, Highstock, Highmaps, Gantt) The interval of the tick marks
  116695. * in axis units. When `undefined`, the tick interval is computed to
  116696. * approximately follow the tickPixelInterval on linear and datetime axes.
  116697. * On categorized axes, a `undefined` tickInterval will default to 1, one
  116698. * category. Note that datetime axes are based on milliseconds, so for
  116699. * example an interval of one day is expressed as `24 * 3600 * 1000`.
  116700. *
  116701. * On logarithmic axes, the tickInterval is based on powers, so a
  116702. * tickInterval of 1 means one tick on each of 0.1, 1, 10, 100 etc. A
  116703. * tickInterval of 2 means a tick of 0.1, 10, 1000 etc. A tickInterval of
  116704. * 0.2 puts a tick on 0.1, 0.2, 0.4, 0.6, 0.8, 1, 2, 4, 6, 8, 10, 20, 40
  116705. * etc.
  116706. *
  116707. * If the tickInterval is too dense for labels to be drawn, Highcharts may
  116708. * remove ticks.
  116709. *
  116710. * If the chart has multiple axes, the alignTicks option may interfere with
  116711. * the `tickInterval` setting.
  116712. */
  116713. tickInterval?: number;
  116714. /**
  116715. * (Highcharts, Highstock, Highmaps, Gantt) The pixel length of the main
  116716. * tick marks.
  116717. */
  116718. tickLength?: number;
  116719. /**
  116720. * (Highcharts, Gantt) For categorized axes only. If `on` the tick mark is
  116721. * placed in the center of the category, if `between` the tick mark is
  116722. * placed between categories. The default is `between` if the `tickInterval`
  116723. * is 1, else `on`.
  116724. */
  116725. tickmarkPlacement?: OptionsTickmarkPlacementValue;
  116726. /**
  116727. * (Highcharts, Highstock, Highmaps, Gantt) If tickInterval is `null` this
  116728. * option sets the approximate pixel interval of the tick marks. Not
  116729. * applicable to categorized axis.
  116730. *
  116731. * The tick interval is also influenced by the minTickInterval option, that,
  116732. * by default prevents ticks from being denser than the data points.
  116733. */
  116734. tickPixelInterval?: number;
  116735. /**
  116736. * (Highcharts, Highstock, Highmaps, Gantt) The position of the major tick
  116737. * marks relative to the axis line. Can be one of `inside` and `outside`.
  116738. */
  116739. tickPosition?: OptionsTickPositionValue;
  116740. /**
  116741. * (Highcharts, Highstock, Highmaps, Gantt) A callback function returning
  116742. * array defining where the ticks are laid out on the axis. This overrides
  116743. * the default behaviour of tickPixelInterval and tickInterval. The
  116744. * automatic tick positions are accessible through `this.tickPositions` and
  116745. * can be modified by the callback.
  116746. */
  116747. tickPositioner?: AxisTickPositionerCallbackFunction;
  116748. /**
  116749. * (Highcharts, Highstock, Highmaps, Gantt) An array defining where the
  116750. * ticks are laid out on the axis. This overrides the default behaviour of
  116751. * tickPixelInterval and tickInterval.
  116752. */
  116753. tickPositions?: Array<number>;
  116754. /**
  116755. * (Highcharts, Highstock, Gantt) The pixel width of the major tick marks.
  116756. */
  116757. tickWidth?: number;
  116758. /**
  116759. * (Highcharts, Highstock, Highmaps, Gantt) The axis title, showing next to
  116760. * the axis line.
  116761. */
  116762. title?: YAxisTitleOptions;
  116763. /**
  116764. * (Highcharts) Parallel coordinates only. Format that will be used for
  116765. * point.y and available in tooltip.pointFormat as `{point.formattedValue}`.
  116766. * If not set, `{point.formattedValue}` will use other options, in this
  116767. * order:
  116768. *
  116769. * 1. yAxis.labels.format will be used if set
  116770. *
  116771. * 2. If yAxis is a category, then category name will be displayed
  116772. *
  116773. * 3. If yAxis is a datetime, then value will use the same format as yAxis
  116774. * labels
  116775. *
  116776. * 4. If yAxis is linear/logarithmic type, then simple value will be used
  116777. */
  116778. tooltipValueFormat?: string;
  116779. /**
  116780. * (Highcharts, Highstock) The top position of the Y axis. If it's a number,
  116781. * it is interpreted as pixel position relative to the chart.
  116782. *
  116783. * Since Highcharts 2: If it's a percentage string, it is interpreted as
  116784. * percentages of the plot height, offset from plot area top.
  116785. */
  116786. top?: (number|string);
  116787. /**
  116788. * (Highcharts, Gantt) The type of axis. Can be one of `linear`,
  116789. * `logarithmic`, `datetime`, `category` or `treegrid`. Defaults to
  116790. * `treegrid` for Gantt charts, `linear` for other chart types.
  116791. *
  116792. * In a datetime axis, the numbers are given in milliseconds, and tick marks
  116793. * are placed on appropriate values, like full hours or days. In a category
  116794. * or treegrid axis, the point names of the chart's series are used for
  116795. * categories, if a categories array is not defined.
  116796. */
  116797. type?: AxisTypeValue;
  116798. /**
  116799. * (Highcharts, Gantt) Applies only when the axis `type` is `category`. When
  116800. * `uniqueNames` is true, points are placed on the X axis according to their
  116801. * names. If the same point name is repeated in the same or another series,
  116802. * the point is placed on the same X position as other points of the same
  116803. * name. When `uniqueNames` is false, the points are laid out in increasing
  116804. * X positions regardless of their names, and the X axis category will take
  116805. * the name of the last point in each position.
  116806. */
  116807. uniqueNames?: boolean;
  116808. /**
  116809. * (Highcharts, Highstock, Gantt) Datetime axis only. An array determining
  116810. * what time intervals the ticks are allowed to fall on. Each array item is
  116811. * an array where the first value is the time unit and the second value
  116812. * another array of allowed multiples.
  116813. *
  116814. * Defaults to: (see online documentation for example)
  116815. */
  116816. units?: Array<[string, (Array<number>|null)]>;
  116817. /**
  116818. * (Highcharts, Highstock, Gantt) Whether axis, including axis title, line,
  116819. * ticks and labels, should be visible.
  116820. */
  116821. visible?: boolean;
  116822. /**
  116823. * (Highcharts, Highstock) The width as the horizontal axis. If it's a
  116824. * number, it is interpreted as pixels.
  116825. *
  116826. * Since Highcharts v5.0.13: If it's a percentage string, it is interpreted
  116827. * as percentages of the total plot width.
  116828. */
  116829. width?: (number|string);
  116830. /**
  116831. * (Highcharts, Highstock, Highmaps, Gantt) Whether to zoom axis. If
  116832. * `chart.zoomType` is set, the option allows to disable zooming on an
  116833. * individual axis.
  116834. */
  116835. zoomEnabled?: boolean;
  116836. }
  116837. /**
  116838. * (Highcharts, Highstock, Gantt) An object defining mouse events for the plot
  116839. * band. Supported properties are `click`, `mouseover`, `mouseout`, `mousemove`.
  116840. */
  116841. export interface YAxisPlotBandsEventsOptions {
  116842. /**
  116843. * (Highcharts, Highstock, Gantt) Click event on a plot band.
  116844. */
  116845. click?: EventCallbackFunction<PlotLineOrBand>;
  116846. /**
  116847. * (Highcharts, Highstock, Gantt) Mouse move event on a plot band.
  116848. */
  116849. mousemove?: EventCallbackFunction<PlotLineOrBand>;
  116850. /**
  116851. * (Highcharts, Highstock, Gantt) Mouse out event on the corner of a plot
  116852. * band.
  116853. */
  116854. mouseout?: EventCallbackFunction<PlotLineOrBand>;
  116855. /**
  116856. * (Highcharts, Highstock, Gantt) Mouse over event on a plot band.
  116857. */
  116858. mouseover?: EventCallbackFunction<PlotLineOrBand>;
  116859. }
  116860. /**
  116861. * (Highcharts, Highstock, Gantt) Text labels for the plot bands
  116862. */
  116863. export interface YAxisPlotBandsLabelOptions {
  116864. /**
  116865. * (Highcharts, Highstock, Gantt) Horizontal alignment of the label. Can be
  116866. * one of "left", "center" or "right".
  116867. */
  116868. align?: AlignValue;
  116869. /**
  116870. * (Highcharts, Highstock, Gantt) Rotation of the text label in degrees .
  116871. */
  116872. rotation?: number;
  116873. /**
  116874. * (Highcharts, Highstock, Gantt) CSS styles for the text label.
  116875. *
  116876. * In styled mode, the labels are styled by the
  116877. * `.highcharts-plot-band-label` class.
  116878. */
  116879. style?: CSSObject;
  116880. /**
  116881. * (Highcharts, Highstock, Gantt) The string text itself. A subset of HTML
  116882. * is supported.
  116883. */
  116884. text?: string;
  116885. /**
  116886. * (Highcharts, Highstock, Gantt) The text alignment for the label. While
  116887. * `align` determines where the texts anchor point is placed within the plot
  116888. * band, `textAlign` determines how the text is aligned against its anchor
  116889. * point. Possible values are "left", "center" and "right". Defaults to the
  116890. * same as the `align` option.
  116891. */
  116892. textAlign?: AlignValue;
  116893. /**
  116894. * (Highcharts, Highstock, Gantt) Whether to use HTML to render the labels.
  116895. */
  116896. useHTML?: boolean;
  116897. /**
  116898. * (Highcharts, Highstock, Gantt) Vertical alignment of the label relative
  116899. * to the plot band. Can be one of "top", "middle" or "bottom".
  116900. */
  116901. verticalAlign?: VerticalAlignValue;
  116902. /**
  116903. * (Highcharts, Highstock, Gantt) Horizontal position relative the
  116904. * alignment. Default varies by orientation.
  116905. */
  116906. x?: number;
  116907. /**
  116908. * (Highcharts, Highstock, Gantt) Vertical position of the text baseline
  116909. * relative to the alignment. Default varies by orientation.
  116910. */
  116911. y?: number;
  116912. }
  116913. /**
  116914. * (Highcharts, Highstock, Gantt) An array of colored bands stretching across
  116915. * the plot area marking an interval on the axis.
  116916. *
  116917. * In styled mode, the plot bands are styled by the `.highcharts-plot-band`
  116918. * class in addition to the `className` option.
  116919. */
  116920. export interface YAxisPlotBandsOptions {
  116921. /**
  116922. * (Highstock) Flag to decide if plotBand should be rendered across all
  116923. * panes.
  116924. */
  116925. acrossPanes?: boolean;
  116926. /**
  116927. * (Highcharts, Highstock, Gantt) Border color for the plot band. Also
  116928. * requires `borderWidth` to be set.
  116929. */
  116930. borderColor?: ColorString;
  116931. /**
  116932. * (Highcharts, Highstock, Gantt) Border width for the plot band. Also
  116933. * requires `borderColor` to be set.
  116934. */
  116935. borderWidth?: number;
  116936. /**
  116937. * (Highcharts, Highstock, Gantt) A custom class name, in addition to the
  116938. * default `highcharts-plot-band`, to apply to each individual band.
  116939. */
  116940. className?: string;
  116941. /**
  116942. * (Highcharts, Highstock, Gantt) The color of the plot band.
  116943. */
  116944. color?: (ColorString|GradientColorObject|PatternObject);
  116945. /**
  116946. * (Highcharts, Highstock, Gantt) An object defining mouse events for the
  116947. * plot band. Supported properties are `click`, `mouseover`, `mouseout`,
  116948. * `mousemove`.
  116949. */
  116950. events?: YAxisPlotBandsEventsOptions;
  116951. /**
  116952. * (Highcharts, Highstock, Gantt) The start position of the plot band in
  116953. * axis units.
  116954. */
  116955. from?: number;
  116956. /**
  116957. * (Highcharts, Highstock, Gantt) An id used for identifying the plot band
  116958. * in Axis.removePlotBand.
  116959. */
  116960. id?: string;
  116961. /**
  116962. * (Highcharts) In a gauge chart, this option determines the inner radius of
  116963. * the plot band that stretches along the perimeter. It can be given as a
  116964. * percentage string, like `"100%"`, or as a pixel number, like `100`. By
  116965. * default, the inner radius is controlled by the thickness option.
  116966. */
  116967. innerRadius?: (number|string);
  116968. /**
  116969. * (Highcharts, Highstock, Gantt) Text labels for the plot bands
  116970. */
  116971. label?: YAxisPlotBandsLabelOptions;
  116972. /**
  116973. * (Highcharts) In a gauge chart, this option determines the outer radius of
  116974. * the plot band that stretches along the perimeter. It can be given as a
  116975. * percentage string, like `"100%"`, or as a pixel number, like `100`.
  116976. */
  116977. outerRadius?: (number|string);
  116978. /**
  116979. * (Highcharts) In a gauge chart, this option sets the width of the plot
  116980. * band stretching along the perimeter. It can be given as a percentage
  116981. * string, like `"10%"`, or as a pixel number, like `10`. The default value
  116982. * 10 is the same as the default tickLength, thus making the plot band act
  116983. * as a background for the tick markers.
  116984. */
  116985. thickness?: (number|string);
  116986. /**
  116987. * (Highcharts, Highstock, Gantt) The end position of the plot band in axis
  116988. * units.
  116989. */
  116990. to?: number;
  116991. /**
  116992. * (Highcharts, Highstock, Gantt) The z index of the plot band within the
  116993. * chart, relative to other elements. Using the same z index as another
  116994. * element may give unpredictable results, as the last rendered element will
  116995. * be on top. Values from 0 to 20 make sense.
  116996. */
  116997. zIndex?: number;
  116998. }
  116999. /**
  117000. * (Highcharts, Highstock, Gantt) An object defining mouse events for the plot
  117001. * line. Supported properties are `click`, `mouseover`, `mouseout`, `mousemove`.
  117002. */
  117003. export interface YAxisPlotLinesEventsOptions {
  117004. /**
  117005. * (Highcharts, Highstock, Gantt) Click event on a plot band.
  117006. */
  117007. click?: EventCallbackFunction<PlotLineOrBand>;
  117008. /**
  117009. * (Highcharts, Highstock, Gantt) Mouse move event on a plot band.
  117010. */
  117011. mousemove?: EventCallbackFunction<PlotLineOrBand>;
  117012. /**
  117013. * (Highcharts, Highstock, Gantt) Mouse out event on the corner of a plot
  117014. * band.
  117015. */
  117016. mouseout?: EventCallbackFunction<PlotLineOrBand>;
  117017. /**
  117018. * (Highcharts, Highstock, Gantt) Mouse over event on a plot band.
  117019. */
  117020. mouseover?: EventCallbackFunction<PlotLineOrBand>;
  117021. }
  117022. /**
  117023. * (Highcharts, Highstock, Gantt) Text labels for the plot bands
  117024. */
  117025. export interface YAxisPlotLinesLabelOptions {
  117026. /**
  117027. * (Highcharts, Highstock, Gantt) Horizontal alignment of the label. Can be
  117028. * one of "left", "center" or "right".
  117029. */
  117030. align?: AlignValue;
  117031. /**
  117032. * (Highcharts, Highstock, Gantt) Callback JavaScript function to format the
  117033. * label. Useful properties like the value of plot line or the range of plot
  117034. * band (`from` & `to` properties) can be found in `this.options` object.
  117035. */
  117036. formatter?: FormatterCallbackFunction<PlotLineOrBand>;
  117037. /**
  117038. * (Highcharts, Highstock, Gantt) Rotation of the text label in degrees.
  117039. * Defaults to 0 for horizontal plot lines and 90 for vertical lines.
  117040. */
  117041. rotation?: number;
  117042. /**
  117043. * (Highcharts, Highstock, Gantt) CSS styles for the text label.
  117044. *
  117045. * In styled mode, the labels are styled by the
  117046. * `.highcharts-plot-line-label` class.
  117047. */
  117048. style?: CSSObject;
  117049. /**
  117050. * (Highcharts, Highstock, Gantt) The text itself. A subset of HTML is
  117051. * supported.
  117052. */
  117053. text?: string;
  117054. /**
  117055. * (Highcharts, Highstock, Gantt) The text alignment for the label. While
  117056. * `align` determines where the texts anchor point is placed within the plot
  117057. * band, `textAlign` determines how the text is aligned against its anchor
  117058. * point. Possible values are "left", "center" and "right". Defaults to the
  117059. * same as the `align` option.
  117060. */
  117061. textAlign?: AlignValue;
  117062. /**
  117063. * (Highcharts, Highstock, Gantt) Whether to use HTML to render the labels.
  117064. */
  117065. useHTML?: boolean;
  117066. /**
  117067. * (Highcharts, Highstock, Gantt) Vertical alignment of the label relative
  117068. * to the plot line. Can be one of "top", "middle" or "bottom".
  117069. */
  117070. verticalAlign?: VerticalAlignValue;
  117071. /**
  117072. * (Highcharts, Highstock, Gantt) Horizontal position relative the
  117073. * alignment. Default varies by orientation.
  117074. */
  117075. x?: number;
  117076. /**
  117077. * (Highcharts, Highstock, Gantt) Vertical position of the text baseline
  117078. * relative to the alignment. Default varies by orientation.
  117079. */
  117080. y?: number;
  117081. }
  117082. /**
  117083. * (Highcharts, Highstock, Gantt) An array of lines stretching across the plot
  117084. * area, marking a specific value on one of the axes.
  117085. *
  117086. * In styled mode, the plot lines are styled by the `.highcharts-plot-line`
  117087. * class in addition to the `className` option.
  117088. */
  117089. export interface YAxisPlotLinesOptions {
  117090. /**
  117091. * (Highstock) Flag to decide if plotLine should be rendered across all
  117092. * panes.
  117093. */
  117094. acrossPanes?: boolean;
  117095. /**
  117096. * (Highcharts, Highstock, Gantt) A custom class name, in addition to the
  117097. * default `highcharts-plot-line`, to apply to each individual line.
  117098. */
  117099. className?: string;
  117100. /**
  117101. * (Highcharts, Highstock, Gantt) The color of the line.
  117102. */
  117103. color?: ColorString;
  117104. /**
  117105. * (Highcharts, Highstock, Gantt) The dashing or dot style for the plot
  117106. * line. For possible values see this overview.
  117107. */
  117108. dashStyle?: DashStyleValue;
  117109. /**
  117110. * (Highcharts, Highstock, Gantt) An object defining mouse events for the
  117111. * plot line. Supported properties are `click`, `mouseover`, `mouseout`,
  117112. * `mousemove`.
  117113. */
  117114. events?: YAxisPlotLinesEventsOptions;
  117115. /**
  117116. * (Highcharts, Highstock, Gantt) An id used for identifying the plot line
  117117. * in Axis.removePlotLine.
  117118. */
  117119. id?: string;
  117120. /**
  117121. * (Highcharts, Highstock, Gantt) Text labels for the plot bands
  117122. */
  117123. label?: YAxisPlotLinesLabelOptions;
  117124. /**
  117125. * (Highcharts, Highstock, Gantt) The position of the line in axis units.
  117126. */
  117127. value?: number;
  117128. /**
  117129. * (Highcharts, Highstock, Gantt) The width or thickness of the plot line.
  117130. */
  117131. width?: number;
  117132. /**
  117133. * (Highcharts, Highstock, Gantt) The z index of the plot line within the
  117134. * chart.
  117135. */
  117136. zIndex?: number;
  117137. }
  117138. /**
  117139. * (Highstock) Contains two arrays of axes that are controlled by control line
  117140. * of the axis.
  117141. */
  117142. export interface YAxisResizeControlledAxisOptions {
  117143. /**
  117144. * (Highstock) Array of axes that should move out of the way of resizing
  117145. * being done for the current axis. If not set, the next axis will be used.
  117146. */
  117147. next?: Array<(number|string)>;
  117148. /**
  117149. * (Highstock) Array of axes that should move with the current axis while
  117150. * resizing.
  117151. */
  117152. prev?: Array<(number|string)>;
  117153. }
  117154. /**
  117155. * (Highstock) Options for axis resizing. It adds a thick line between panes
  117156. * which the user can drag in order to resize the panes.
  117157. */
  117158. export interface YAxisResizeOptions {
  117159. /**
  117160. * (Highstock) Contains two arrays of axes that are controlled by control
  117161. * line of the axis.
  117162. */
  117163. controlledAxis?: YAxisResizeControlledAxisOptions;
  117164. /**
  117165. * (Highstock) Cursor style for the control line.
  117166. *
  117167. * In styled mode use class `highcharts-axis-resizer` instead.
  117168. */
  117169. cursor?: string;
  117170. /**
  117171. * (Highstock) Enable or disable resize by drag for the axis.
  117172. */
  117173. enabled?: boolean;
  117174. /**
  117175. * (Highstock) Color of the control line.
  117176. *
  117177. * In styled mode use class `highcharts-axis-resizer` instead.
  117178. */
  117179. lineColor?: ColorString;
  117180. /**
  117181. * (Highstock) Dash style of the control line.
  117182. *
  117183. * In styled mode use class `highcharts-axis-resizer` instead.
  117184. */
  117185. lineDashStyle?: string;
  117186. /**
  117187. * (Highstock) Width of the control line.
  117188. *
  117189. * In styled mode use class `highcharts-axis-resizer` instead.
  117190. */
  117191. lineWidth?: number;
  117192. /**
  117193. * (Highstock) Horizontal offset of the control line.
  117194. */
  117195. x?: number;
  117196. /**
  117197. * (Highstock) Vertical offset of the control line.
  117198. */
  117199. y?: number;
  117200. }
  117201. /**
  117202. * (Highstock) An optional scrollbar to display on the Y axis in response to
  117203. * limiting the minimum an maximum of the axis values.
  117204. *
  117205. * In styled mode, all the presentational options for the scrollbar are replaced
  117206. * by the classes `.highcharts-scrollbar-thumb`, `.highcharts-scrollbar-arrow`,
  117207. * `.highcharts-scrollbar-button`, `.highcharts-scrollbar-rifles` and
  117208. * `.highcharts-scrollbar-track`.
  117209. */
  117210. export interface YAxisScrollbarOptions {
  117211. /**
  117212. * (Highstock) The background color of the scrollbar itself.
  117213. */
  117214. barBackgroundColor?: (ColorString|GradientColorObject|PatternObject);
  117215. /**
  117216. * (Highstock) The color of the scrollbar's border.
  117217. */
  117218. barBorderColor?: (ColorString|GradientColorObject|PatternObject);
  117219. /**
  117220. * (Highstock) The border rounding radius of the bar.
  117221. */
  117222. barBorderRadius?: number;
  117223. /**
  117224. * (Highstock) The width of the bar's border.
  117225. */
  117226. barBorderWidth?: number;
  117227. /**
  117228. * (Highstock) The color of the small arrow inside the scrollbar buttons.
  117229. */
  117230. buttonArrowColor?: (ColorString|GradientColorObject|PatternObject);
  117231. /**
  117232. * (Highstock) The color of scrollbar buttons.
  117233. */
  117234. buttonBackgroundColor?: (ColorString|GradientColorObject|PatternObject);
  117235. /**
  117236. * (Highstock) The color of the border of the scrollbar buttons.
  117237. */
  117238. buttonBorderColor?: (ColorString|GradientColorObject|PatternObject);
  117239. /**
  117240. * (Highstock) The corner radius of the scrollbar buttons.
  117241. */
  117242. buttonBorderRadius?: number;
  117243. /**
  117244. * (Highstock) The border width of the scrollbar buttons.
  117245. */
  117246. buttonBorderWidth?: number;
  117247. /**
  117248. * (Highstock) Enable the scrollbar on the Y axis.
  117249. */
  117250. enabled?: boolean;
  117251. /**
  117252. * (Highstock) Whether to redraw the main chart as the scrollbar or the
  117253. * navigator zoomed window is moved. Defaults to `true` for modern browsers
  117254. * and `false` for legacy IE browsers as well as mobile devices.
  117255. */
  117256. liveRedraw?: boolean;
  117257. /**
  117258. * (Highstock) Pixel margin between the scrollbar and the axis elements.
  117259. */
  117260. margin?: number;
  117261. /**
  117262. * (Highstock) The minimum width of the scrollbar.
  117263. */
  117264. minWidth?: number;
  117265. /**
  117266. * (Highstock) The color of the small rifles in the middle of the scrollbar.
  117267. */
  117268. rifleColor?: (ColorString|GradientColorObject|PatternObject);
  117269. /**
  117270. * (Highstock) Whether to show the scrollbar when it is fully zoomed out at
  117271. * max range. Setting it to `false` on the Y axis makes the scrollbar stay
  117272. * hidden until the user zooms in, like common in browsers.
  117273. */
  117274. showFull?: boolean;
  117275. /**
  117276. * (Highstock) The width of a vertical scrollbar or height of a horizontal
  117277. * scrollbar. Defaults to 20 on touch devices.
  117278. */
  117279. size?: number;
  117280. /**
  117281. * (Highstock) The color of the track background.
  117282. */
  117283. trackBackgroundColor?: (ColorString|GradientColorObject|PatternObject);
  117284. /**
  117285. * (Highstock) The color of the border of the scrollbar track.
  117286. */
  117287. trackBorderColor?: (ColorString|GradientColorObject|PatternObject);
  117288. /**
  117289. * (Highstock) The corner radius of the border of the scrollbar track.
  117290. */
  117291. trackBorderRadius?: number;
  117292. /**
  117293. * (Highstock) The width of the border of the scrollbar track.
  117294. */
  117295. trackBorderWidth?: number;
  117296. /**
  117297. * (Highstock) Z index of the scrollbar elements.
  117298. */
  117299. zIndex?: number;
  117300. }
  117301. /**
  117302. * (Highcharts) Enable or disable the initial animation when a series is
  117303. * displayed for the `stackLabels`. The animation can also be set as a
  117304. * configuration object. Please note that this option only applies to the
  117305. * initial animation. For other animations, see chart.animation and the
  117306. * animation parameter under the API methods. The following properties are
  117307. * supported:
  117308. *
  117309. * - `defer`: The animation delay time in milliseconds.
  117310. */
  117311. export interface YAxisStackLabelsAnimationOptions {
  117312. /**
  117313. * (Highcharts) The animation delay time in milliseconds. Set to `0` renders
  117314. * stackLabel immediately. As `undefined` inherits defer time from the
  117315. * series.animation.defer.
  117316. */
  117317. defer?: number;
  117318. }
  117319. /**
  117320. * (Highcharts) The stack labels show the total value for each bar in a stacked
  117321. * column or bar chart. The label will be placed on top of positive columns and
  117322. * below negative columns. In case of an inverted column chart or a bar chart
  117323. * the label is placed to the right of positive bars and to the left of negative
  117324. * bars.
  117325. */
  117326. export interface YAxisStackLabelsOptions {
  117327. /**
  117328. * (Highcharts) Defines the horizontal alignment of the stack total label.
  117329. * Can be one of `"left"`, `"center"` or `"right"`. The default value is
  117330. * calculated at runtime and depends on orientation and whether the stack is
  117331. * positive or negative.
  117332. */
  117333. align?: AlignValue;
  117334. /**
  117335. * (Highcharts) Allow the stack labels to overlap.
  117336. */
  117337. allowOverlap?: boolean;
  117338. /**
  117339. * (Highcharts) Enable or disable the initial animation when a series is
  117340. * displayed for the `stackLabels`. The animation can also be set as a
  117341. * configuration object. Please note that this option only applies to the
  117342. * initial animation. For other animations, see chart.animation and the
  117343. * animation parameter under the API methods. The following properties are
  117344. * supported:
  117345. *
  117346. * - `defer`: The animation delay time in milliseconds.
  117347. */
  117348. animation?: (boolean|YAxisStackLabelsAnimationOptions|Partial<AnimationOptionsObject>);
  117349. /**
  117350. * (Highcharts) The background color or gradient for the stack label.
  117351. */
  117352. backgroundColor?: ColorType;
  117353. /**
  117354. * (Highcharts) The border color for the stack label. Defaults to
  117355. * `undefined`.
  117356. */
  117357. borderColor?: ColorType;
  117358. /**
  117359. * (Highcharts) The border radius in pixels for the stack label.
  117360. */
  117361. borderRadius?: number;
  117362. /**
  117363. * (Highcharts) The border width in pixels for the stack label.
  117364. */
  117365. borderWidth?: number;
  117366. /**
  117367. * (Highcharts) Whether to hide stack labels that are outside the plot area.
  117368. * By default, the stack label is moved inside the plot area according to
  117369. * the overflow option.
  117370. */
  117371. crop?: boolean;
  117372. /**
  117373. * (Highcharts) Enable or disable the stack total labels.
  117374. */
  117375. enabled?: boolean;
  117376. /**
  117377. * (Highcharts, Highstock) A format string for the data label. Available
  117378. * variables are the same as for `formatter`.
  117379. */
  117380. format?: string;
  117381. /**
  117382. * (Highcharts) Callback JavaScript function to format the label. The value
  117383. * is given by `this.total`.
  117384. */
  117385. formatter?: FormatterCallbackFunction<StackItemObject>;
  117386. /**
  117387. * (Highcharts) How to handle stack total labels that flow outside the plot
  117388. * area. The default is set to `"justify"`, which aligns them inside the
  117389. * plot area. For columns and bars, this means it will be moved inside the
  117390. * bar. To display stack labels outside the plot area, set `crop` to `false`
  117391. * and `overflow` to `"allow"`.
  117392. */
  117393. overflow?: DataLabelsOverflowValue;
  117394. /**
  117395. * (Highcharts) Rotation of the labels in degrees.
  117396. */
  117397. rotation?: number;
  117398. /**
  117399. * (Highcharts) CSS styles for the label.
  117400. *
  117401. * In styled mode, the styles are set in the `.highcharts-stack-label`
  117402. * class.
  117403. */
  117404. style?: CSSObject;
  117405. /**
  117406. * (Highcharts) The text alignment for the label. While `align` determines
  117407. * where the texts anchor point is placed with regards to the stack,
  117408. * `textAlign` determines how the text is aligned against its anchor point.
  117409. * Possible values are `"left"`, `"center"` and `"right"`. The default value
  117410. * is calculated at runtime and depends on orientation and whether the stack
  117411. * is positive or negative.
  117412. */
  117413. textAlign?: AlignValue;
  117414. /**
  117415. * (Highcharts, Highstock) Whether to use HTML to render the labels.
  117416. */
  117417. useHTML?: boolean;
  117418. /**
  117419. * (Highcharts) Defines the vertical alignment of the stack total label. Can
  117420. * be one of `"top"`, `"middle"` or `"bottom"`. The default value is
  117421. * calculated at runtime and depends on orientation and whether the stack is
  117422. * positive or negative.
  117423. */
  117424. verticalAlign?: VerticalAlignValue;
  117425. /**
  117426. * (Highcharts) The x position offset of the label relative to the left of
  117427. * the stacked bar. The default value is calculated at runtime and depends
  117428. * on orientation and whether the stack is positive or negative.
  117429. */
  117430. x?: number;
  117431. /**
  117432. * (Highcharts) The y position offset of the label relative to the tick
  117433. * position on the axis. The default value is calculated at runtime and
  117434. * depends on orientation and whether the stack is positive or negative.
  117435. */
  117436. y?: number;
  117437. }
  117438. /**
  117439. * (Highcharts, Highstock, Highmaps, Gantt) The axis title, showing next to the
  117440. * axis line.
  117441. */
  117442. export interface YAxisTitleOptions {
  117443. /**
  117444. * (Highcharts, Highstock, Highmaps, Gantt) Alignment of the title relative
  117445. * to the axis values. Possible values are "low", "middle" or "high".
  117446. */
  117447. align?: AxisTitleAlignValue;
  117448. /**
  117449. * (Highcharts, Highstock, Highmaps, Gantt) The pixel distance between the
  117450. * axis labels and the title. Positive values are outside the axis line,
  117451. * negative are inside.
  117452. */
  117453. margin?: number;
  117454. /**
  117455. * (Highcharts, Highstock, Highmaps, Gantt) The distance of the axis title
  117456. * from the axis line. By default, this distance is computed from the offset
  117457. * width of the labels, the labels' distance from the axis and the title's
  117458. * margin. However when the offset option is set, it overrides all this.
  117459. */
  117460. offset?: number;
  117461. /**
  117462. * (Highcharts) Defines how the title is repositioned according to the 3D
  117463. * chart orientation.
  117464. *
  117465. * - `'offset'`: Maintain a fixed horizontal/vertical distance from the tick
  117466. * marks, despite the chart orientation. This is the backwards compatible
  117467. * behavior, and causes skewing of X and Z axes.
  117468. *
  117469. * - `'chart'`: Preserve 3D position relative to the chart. This looks nice,
  117470. * but hard to read if the text isn't forward-facing.
  117471. *
  117472. * - `'flap'`: Rotated text along the axis to compensate for the chart
  117473. * orientation. This tries to maintain text as legible as possible on all
  117474. * orientations.
  117475. *
  117476. * - `'ortho'`: Rotated text along the axis direction so that the labels are
  117477. * orthogonal to the axis. This is very similar to `'flap'`, but prevents
  117478. * skewing the labels (X and Y scaling are still present).
  117479. *
  117480. * - `undefined`: Will use the config from `labels.position3d`
  117481. */
  117482. position3d?: ("chart"|"flap"|"offset"|"ortho"|null);
  117483. /**
  117484. * (Highcharts, Highstock, Gantt) Whether to reserve space for the title
  117485. * when laying out the axis.
  117486. */
  117487. reserveSpace?: boolean;
  117488. /**
  117489. * (Highcharts, Highstock, Highmaps, Gantt) The rotation of the text in
  117490. * degrees. 0 is horizontal, 270 is vertical reading from bottom to top.
  117491. */
  117492. rotation?: number;
  117493. /**
  117494. * (Highcharts) If enabled, the axis title will skewed to follow the
  117495. * perspective.
  117496. *
  117497. * This will fix overlapping labels and titles, but texts become less
  117498. * legible due to the distortion.
  117499. *
  117500. * The final appearance depends heavily on `title.position3d`.
  117501. *
  117502. * A `null` value will use the config from `labels.skew3d`.
  117503. */
  117504. skew3d?: (boolean|null);
  117505. /**
  117506. * (Highcharts, Highstock, Highmaps, Gantt) CSS styles for the title. If the
  117507. * title text is longer than the axis length, it will wrap to multiple lines
  117508. * by default. This can be customized by setting `textOverflow: 'ellipsis'`,
  117509. * by setting a specific `width` or by setting `whiteSpace: 'nowrap'`.
  117510. *
  117511. * In styled mode, the stroke width is given in the `.highcharts-axis-title`
  117512. * class.
  117513. */
  117514. style?: CSSObject;
  117515. /**
  117516. * (Highcharts, Highstock, Gantt) The actual text of the axis title.
  117517. * Horizontal texts can contain HTML, but rotated texts are painted using
  117518. * vector techniques and must be clean text. The Y axis title is disabled by
  117519. * setting the `text` option to `undefined`.
  117520. */
  117521. text?: (string|null);
  117522. /**
  117523. * (Highcharts, Highstock, Highmaps, Gantt) Alignment of the text, can be
  117524. * `"left"`, `"right"` or `"center"`. Default alignment depends on the
  117525. * title.align:
  117526. *
  117527. * Horizontal axes:
  117528. *
  117529. * - for `align` = `"low"`, `textAlign` is set to `left`
  117530. *
  117531. * - for `align` = `"middle"`, `textAlign` is set to `center`
  117532. *
  117533. * - for `align` = `"high"`, `textAlign` is set to `right`
  117534. *
  117535. * Vertical axes:
  117536. *
  117537. * - for `align` = `"low"` and `opposite` = `true`, `textAlign` is set to
  117538. * `right`
  117539. *
  117540. * - for `align` = `"low"` and `opposite` = `false`, `textAlign` is set to
  117541. * `left`
  117542. *
  117543. * - for `align` = `"middle"`, `textAlign` is set to `center`
  117544. *
  117545. * - for `align` = `"high"` and `opposite` = `true` `textAlign` is set to
  117546. * `left`
  117547. *
  117548. * - for `align` = `"high"` and `opposite` = `false` `textAlign` is set to
  117549. * `right`
  117550. */
  117551. textAlign?: AlignValue;
  117552. /**
  117553. * (Highcharts, Highstock, Gantt) Whether to use HTML to render the axis
  117554. * title.
  117555. */
  117556. useHTML?: boolean;
  117557. /**
  117558. * (Highcharts, Highstock, Gantt) Horizontal pixel offset of the title
  117559. * position.
  117560. */
  117561. x?: number;
  117562. /**
  117563. * (Highcharts, Highstock, Gantt) Vertical pixel offset of the title
  117564. * position.
  117565. */
  117566. y?: number;
  117567. }
  117568. /**
  117569. * (Gantt) An object defining mouse events for the plot line. Supported
  117570. * properties are `click`, `mouseover`, `mouseout`, `mousemove`.
  117571. */
  117572. export interface ZAxisCurrentDateIndicatorEventsOptions {
  117573. /**
  117574. * (Gantt) Click event on a plot band.
  117575. */
  117576. click?: EventCallbackFunction<PlotLineOrBand>;
  117577. /**
  117578. * (Gantt) Mouse move event on a plot band.
  117579. */
  117580. mousemove?: EventCallbackFunction<PlotLineOrBand>;
  117581. /**
  117582. * (Gantt) Mouse out event on the corner of a plot band.
  117583. */
  117584. mouseout?: EventCallbackFunction<PlotLineOrBand>;
  117585. /**
  117586. * (Gantt) Mouse over event on a plot band.
  117587. */
  117588. mouseover?: EventCallbackFunction<PlotLineOrBand>;
  117589. }
  117590. /**
  117591. * (Gantt) Text labels for the plot bands
  117592. */
  117593. export interface ZAxisCurrentDateIndicatorLabelOptions {
  117594. /**
  117595. * (Gantt) Horizontal alignment of the label. Can be one of "left", "center"
  117596. * or "right".
  117597. */
  117598. align?: AlignValue;
  117599. /**
  117600. * (Gantt) Format of the label. This options is passed as the fist argument
  117601. * to dateFormat function.
  117602. */
  117603. format?: string;
  117604. /**
  117605. * (Gantt) Callback JavaScript function to format the label. Useful
  117606. * properties like the value of plot line or the range of plot band (`from`
  117607. * & `to` properties) can be found in `this.options` object.
  117608. */
  117609. formatter?: FormatterCallbackFunction<PlotLineOrBand>;
  117610. /**
  117611. * (Gantt) Rotation of the text label in degrees. Defaults to 0 for
  117612. * horizontal plot lines and 90 for vertical lines.
  117613. */
  117614. rotation?: number;
  117615. /**
  117616. * (Gantt) CSS styles for the text label.
  117617. *
  117618. * In styled mode, the labels are styled by the
  117619. * `.highcharts-plot-line-label` class.
  117620. */
  117621. style?: CSSObject;
  117622. /**
  117623. * (Gantt) The text itself. A subset of HTML is supported.
  117624. */
  117625. text?: string;
  117626. /**
  117627. * (Gantt) The text alignment for the label. While `align` determines where
  117628. * the texts anchor point is placed within the plot band, `textAlign`
  117629. * determines how the text is aligned against its anchor point. Possible
  117630. * values are "left", "center" and "right". Defaults to the same as the
  117631. * `align` option.
  117632. */
  117633. textAlign?: AlignValue;
  117634. /**
  117635. * (Gantt) Whether to use HTML to render the labels.
  117636. */
  117637. useHTML?: boolean;
  117638. /**
  117639. * (Gantt) Vertical alignment of the label relative to the plot line. Can be
  117640. * one of "top", "middle" or "bottom".
  117641. */
  117642. verticalAlign?: VerticalAlignValue;
  117643. /**
  117644. * (Gantt) Horizontal position relative the alignment. Default varies by
  117645. * orientation.
  117646. */
  117647. x?: number;
  117648. /**
  117649. * (Gantt) Vertical position of the text baseline relative to the alignment.
  117650. * Default varies by orientation.
  117651. */
  117652. y?: number;
  117653. }
  117654. /**
  117655. * (Highcharts) Event handlers for the axis.
  117656. */
  117657. export interface ZAxisEventsOptions {
  117658. /**
  117659. * (Highcharts, Gantt) An event fired after the breaks have rendered.
  117660. */
  117661. afterBreaks?: AxisEventCallbackFunction;
  117662. /**
  117663. * (Highcharts) As opposed to the `setExtremes` event, this event fires
  117664. * after the final min and max values are computed and corrected for
  117665. * `minRange`.
  117666. *
  117667. * Fires when the minimum and maximum is set for the axis, either by calling
  117668. * the `.setExtremes()` method or by selecting an area in the chart. One
  117669. * parameter, `event`, is passed to the function, containing common event
  117670. * information.
  117671. *
  117672. * The new user set minimum and maximum values can be found by `event.min`
  117673. * and `event.max`. These reflect the axis minimum and maximum in axis
  117674. * values. The actual data extremes are found in `event.dataMin` and
  117675. * `event.dataMax`.
  117676. */
  117677. afterSetExtremes?: AxisSetExtremesEventCallbackFunction;
  117678. /**
  117679. * (Highcharts, Gantt) An event fired when a break from this axis occurs on
  117680. * a point.
  117681. */
  117682. pointBreak?: AxisPointBreakEventCallbackFunction;
  117683. /**
  117684. * (Highcharts, Highstock, Gantt) An event fired when a point falls inside a
  117685. * break from this axis.
  117686. */
  117687. pointInBreak?: AxisPointBreakEventCallbackFunction;
  117688. /**
  117689. * (Highcharts) Fires when the minimum and maximum is set for the axis,
  117690. * either by calling the `.setExtremes()` method or by selecting an area in
  117691. * the chart. One parameter, `event`, is passed to the function, containing
  117692. * common event information.
  117693. *
  117694. * The new user set minimum and maximum values can be found by `event.min`
  117695. * and `event.max`. These reflect the axis minimum and maximum in data
  117696. * values. When an axis is zoomed all the way out from the "Reset zoom"
  117697. * button, `event.min` and `event.max` are null, and the new extremes are
  117698. * set based on `this.dataMin` and `this.dataMax`.
  117699. */
  117700. setExtremes?: AxisSetExtremesEventCallbackFunction;
  117701. }
  117702. /**
  117703. * (Gantt) Set grid options for the axis labels. Requires Highcharts Gantt.
  117704. */
  117705. export interface ZAxisGridOptions {
  117706. /**
  117707. * (Gantt) Set border color for the label grid lines.
  117708. */
  117709. borderColor?: ColorString;
  117710. /**
  117711. * (Gantt) Set border width of the label grid lines.
  117712. */
  117713. borderWidth?: number;
  117714. /**
  117715. * (Gantt) Set cell height for grid axis labels. By default this is
  117716. * calculated from font size. This option only applies to horizontal axes.
  117717. */
  117718. cellHeight?: number;
  117719. /**
  117720. * (Gantt) Set specific options for each column (or row for horizontal axes)
  117721. * in the grid. Each extra column/row is its own axis, and the axis options
  117722. * can be set here.
  117723. */
  117724. columns?: Array<XAxisOptions>;
  117725. /**
  117726. * (Gantt) Enable grid on the axis labels. Defaults to true for Gantt
  117727. * charts.
  117728. */
  117729. enabled?: boolean;
  117730. }
  117731. /**
  117732. * (Highcharts) The axis labels show the number or category for each tick.
  117733. *
  117734. * Since v8.0.0: Labels are animated in categorized x-axis with updating data if
  117735. * `tickInterval` and `step` is set to 1.
  117736. */
  117737. export interface ZAxisLabelsOptions {
  117738. /**
  117739. * (Highcharts) What part of the string the given position is anchored to.
  117740. * If `left`, the left side of the string is at the axis position. Can be
  117741. * one of `"left"`, `"center"` or `"right"`. Defaults to an intelligent
  117742. * guess based on which side of the chart the axis is on and the rotation of
  117743. * the label.
  117744. */
  117745. align?: AlignValue;
  117746. /**
  117747. * (Highcharts, Highstock, Gantt) For horizontal axes, the allowed degrees
  117748. * of label rotation to prevent overlapping labels. If there is enough
  117749. * space, labels are not rotated. As the chart gets narrower, it will start
  117750. * rotating the labels -45 degrees, then remove every second label and try
  117751. * again with rotations 0 and -45 etc. Set it to `false` to disable
  117752. * rotation, which will cause the labels to word-wrap if possible.
  117753. */
  117754. autoRotation?: (false|Array<number>);
  117755. /**
  117756. * (Highcharts, Gantt) When each category width is more than this many
  117757. * pixels, we don't apply auto rotation. Instead, we lay out the axis label
  117758. * with word wrap. A lower limit makes sense when the label contains
  117759. * multiple short words that don't extend the available horizontal space for
  117760. * each label.
  117761. */
  117762. autoRotationLimit?: number;
  117763. /**
  117764. * (Highcharts, Gantt) Polar charts only. The label's pixel distance from
  117765. * the perimeter of the plot area.
  117766. */
  117767. distance?: number;
  117768. /**
  117769. * (Highcharts) Enable or disable the axis labels.
  117770. */
  117771. enabled?: boolean;
  117772. /**
  117773. * (Highcharts) A format string for the axis label. See format string for
  117774. * example usage.
  117775. *
  117776. * Note: The default value is not specified due to the dynamic nature of the
  117777. * default implementation.
  117778. */
  117779. format?: string;
  117780. /**
  117781. * (Highcharts) Callback JavaScript function to format the label. The value
  117782. * is given by `this.value`. Additional properties for `this` are `axis`,
  117783. * `chart`, `isFirst` and `isLast`. The value of the default label formatter
  117784. * can be retrieved by calling `this.axis.defaultLabelFormatter.call(this)`
  117785. * within the function.
  117786. *
  117787. * Defaults to: (see online documentation for example)
  117788. */
  117789. formatter?: AxisLabelsFormatterCallbackFunction;
  117790. /**
  117791. * (Gantt) The number of pixels to indent the labels per level in a treegrid
  117792. * axis.
  117793. */
  117794. indentation?: number;
  117795. /**
  117796. * (Highcharts) How to handle overflowing labels on horizontal axis. If set
  117797. * to `"allow"`, it will not be aligned at all. By default it `"justify"`
  117798. * labels inside the chart area. If there is room to move it, it will be
  117799. * aligned to the edge, else it will be removed.
  117800. */
  117801. overflow?: OptionsOverflowValue;
  117802. /**
  117803. * (Highcharts, Gantt) The pixel padding for axis labels, to ensure white
  117804. * space between them.
  117805. */
  117806. padding?: number;
  117807. /**
  117808. * (Highcharts) Defines how the labels are be repositioned according to the
  117809. * 3D chart orientation.
  117810. *
  117811. * - `'offset'`: Maintain a fixed horizontal/vertical distance from the tick
  117812. * marks, despite the chart orientation. This is the backwards compatible
  117813. * behavior, and causes skewing of X and Z axes.
  117814. *
  117815. * - `'chart'`: Preserve 3D position relative to the chart. This looks nice,
  117816. * but hard to read if the text isn't forward-facing.
  117817. *
  117818. * - `'flap'`: Rotated text along the axis to compensate for the chart
  117819. * orientation. This tries to maintain text as legible as possible on all
  117820. * orientations.
  117821. *
  117822. * - `'ortho'`: Rotated text along the axis direction so that the labels are
  117823. * orthogonal to the axis. This is very similar to `'flap'`, but prevents
  117824. * skewing the labels (X and Y scaling are still present).
  117825. */
  117826. position3d?: OptionsPosition3dValue;
  117827. /**
  117828. * (Highcharts, Gantt) Whether to reserve space for the labels. By default,
  117829. * space is reserved for the labels in these cases:
  117830. *
  117831. * * On all horizontal axes.
  117832. *
  117833. * * On vertical axes if `label.align` is `right` on a left-side axis or
  117834. * `left` on a right-side axis.
  117835. *
  117836. * * On vertical axes if `label.align` is `center`.
  117837. *
  117838. * This can be turned off when for example the labels are rendered inside
  117839. * the plot area instead of outside.
  117840. */
  117841. reserveSpace?: boolean;
  117842. /**
  117843. * (Highcharts) Rotation of the labels in degrees.
  117844. */
  117845. rotation?: number;
  117846. /**
  117847. * (Highcharts) If enabled, the axis labels will skewed to follow the
  117848. * perspective.
  117849. *
  117850. * This will fix overlapping labels and titles, but texts become less
  117851. * legible due to the distortion.
  117852. *
  117853. * The final appearance depends heavily on `labels.position3d`.
  117854. */
  117855. skew3d?: boolean;
  117856. /**
  117857. * (Highcharts) Horizontal axes only. The number of lines to spread the
  117858. * labels over to make room or tighter labels.
  117859. */
  117860. staggerLines?: number;
  117861. /**
  117862. * (Highcharts) To show only every _n_'th label on the axis, set the step to
  117863. * _n_. Setting the step to 2 shows every other label.
  117864. *
  117865. * By default, the step is calculated automatically to avoid overlap. To
  117866. * prevent this, set it to 1\. This usually only happens on a category axis,
  117867. * and is often a sign that you have chosen the wrong axis type.
  117868. *
  117869. * Read more at Axis docs => What axis should I use?
  117870. */
  117871. step?: number;
  117872. /**
  117873. * (Highcharts) CSS styles for the label. Use `whiteSpace: 'nowrap'` to
  117874. * prevent wrapping of category labels. Use `textOverflow: 'none'` to
  117875. * prevent ellipsis (dots).
  117876. *
  117877. * In styled mode, the labels are styled with the `.highcharts-axis-labels`
  117878. * class.
  117879. */
  117880. style?: CSSObject;
  117881. /**
  117882. * (Highcharts) Whether to use HTML to render the labels.
  117883. */
  117884. useHTML?: boolean;
  117885. /**
  117886. * (Highcharts) The x position offset of all labels relative to the tick
  117887. * positions on the axis.
  117888. */
  117889. x?: number;
  117890. /**
  117891. * (Highcharts) The y position offset of all labels relative to the tick
  117892. * positions on the axis. The default makes it adapt to the font size of the
  117893. * bottom axis.
  117894. */
  117895. y?: number;
  117896. /**
  117897. * (Highcharts) The Z index for the axis labels.
  117898. */
  117899. zIndex?: number;
  117900. }
  117901. /**
  117902. * (Highcharts) The Z axis or depth axis for 3D plots.
  117903. *
  117904. * See the Axis class for programmatic access to the axis.
  117905. */
  117906. export interface ZAxisOptions {
  117907. /**
  117908. * (Highcharts) Accessibility options for an axis. Requires the
  117909. * accessibility module.
  117910. */
  117911. accessibility?: AxisAccessibilityOptionsObject;
  117912. /**
  117913. * (Highcharts, Highstock, Gantt) When using multiple axis, the ticks of two
  117914. * or more opposite axes will automatically be aligned by adding ticks to
  117915. * the axis or axes with the least ticks, as if `tickAmount` were specified.
  117916. *
  117917. * This can be prevented by setting `alignTicks` to false. If the grid lines
  117918. * look messy, it's a good idea to hide them for the secondary axis by
  117919. * setting `gridLineWidth` to 0.
  117920. *
  117921. * If `startOnTick` or `endOnTick` in an Axis options are set to false, then
  117922. * the `alignTicks ` will be disabled for the Axis.
  117923. *
  117924. * Disabled for logarithmic axes.
  117925. */
  117926. alignTicks?: boolean;
  117927. /**
  117928. * (Highcharts) Whether to allow decimals in this axis' ticks. When counting
  117929. * integers, like persons or hits on a web page, decimals should be avoided
  117930. * in the labels.
  117931. */
  117932. allowDecimals?: boolean;
  117933. /**
  117934. * (Highcharts) When using an alternate grid color, a band is painted across
  117935. * the plot area between every other grid line.
  117936. */
  117937. alternateGridColor?: ColorType;
  117938. /**
  117939. * (Highcharts) In a polar chart, this is the angle of the Y axis in
  117940. * degrees, where 0 is up and 90 is right. The angle determines the position
  117941. * of the axis line and the labels, though the coordinate system is
  117942. * unaffected. Since v8.0.0 this option is also applicable for X axis
  117943. * (inverted polar).
  117944. */
  117945. angle?: number;
  117946. /**
  117947. * (Highcharts, Gantt) If categories are present for the xAxis, names are
  117948. * used instead of numbers for that axis.
  117949. *
  117950. * Since Highcharts 3.0, categories can also be extracted by giving each
  117951. * point a name and setting axis type to `category`. However, if you have
  117952. * multiple series, best practice remains defining the `categories` array.
  117953. *
  117954. * Example: `categories: ['Apples', 'Bananas', 'Oranges']`
  117955. */
  117956. categories?: Array<string>;
  117957. /**
  117958. * (Highcharts, Highstock, Gantt) The highest allowed value for
  117959. * automatically computed axis extremes.
  117960. */
  117961. ceiling?: number;
  117962. /**
  117963. * (Highcharts) A class name that opens for styling the axis by CSS,
  117964. * especially in Highcharts styled mode. The class name is applied to group
  117965. * elements for the grid, axis elements and labels.
  117966. */
  117967. className?: string;
  117968. /**
  117969. * (Gantt) Show an indicator on the axis for the current date and time. Can
  117970. * be a boolean or a configuration object similar to xAxis.plotLines.
  117971. */
  117972. currentDateIndicator?: (boolean|AxisCurrentDateIndicatorOptions);
  117973. /**
  117974. * (Highcharts, Highstock, Gantt) For a datetime axis, the scale will
  117975. * automatically adjust to the appropriate unit. This member gives the
  117976. * default string representations used for each unit. For intermediate
  117977. * values, different units may be used, for example the `day` unit can be
  117978. * used on midnight and `hour` unit be used for intermediate values on the
  117979. * same axis.
  117980. *
  117981. * For an overview of the replacement codes, see dateFormat.
  117982. *
  117983. * Defaults to: (see online documentation for example)
  117984. */
  117985. dateTimeLabelFormats?: AxisDateTimeLabelFormatsOptions;
  117986. /**
  117987. * (Highcharts) Whether to force the axis to end on a tick. Use this option
  117988. * with the `maxPadding` option to control the axis end.
  117989. */
  117990. endOnTick?: boolean;
  117991. /**
  117992. * (Highcharts) Event handlers for the axis.
  117993. */
  117994. events?: ZAxisEventsOptions;
  117995. /**
  117996. * (Highcharts, Highstock, Gantt) The lowest allowed value for automatically
  117997. * computed axis extremes.
  117998. */
  117999. floor?: number;
  118000. /**
  118001. * (Gantt) Set grid options for the axis labels. Requires Highcharts Gantt.
  118002. */
  118003. grid?: ZAxisGridOptions;
  118004. /**
  118005. * (Highcharts) Color of the grid lines extending the ticks across the plot
  118006. * area.
  118007. *
  118008. * In styled mode, the stroke is given in the `.highcharts-grid-line` class.
  118009. */
  118010. gridLineColor?: ColorType;
  118011. /**
  118012. * (Highcharts) The dash or dot style of the grid lines. For possible
  118013. * values, see this demonstration.
  118014. */
  118015. gridLineDashStyle?: DashStyleValue;
  118016. /**
  118017. * (Highcharts) Polar charts only. Whether the grid lines should draw as a
  118018. * polygon with straight lines between categories, or as circles. Can be
  118019. * either `circle` or `polygon`. Since v8.0.0 this option is also applicable
  118020. * for X axis (inverted polar).
  118021. */
  118022. gridLineInterpolation?: OptionsGridLineInterpolationValue;
  118023. /**
  118024. * (Highcharts) The width of the grid lines extending the ticks across the
  118025. * plot area.
  118026. *
  118027. * In styled mode, the stroke width is given in the `.highcharts-grid-line`
  118028. * class.
  118029. */
  118030. gridLineWidth?: number;
  118031. /**
  118032. * (Highcharts, Highstock, Gantt) The Z index of the grid lines.
  118033. */
  118034. gridZIndex?: number;
  118035. /**
  118036. * (Highcharts) An id for the axis. This can be used after render time to
  118037. * get a pointer to the axis object through `chart.get()`.
  118038. */
  118039. id?: string;
  118040. /**
  118041. * (Highcharts) The axis labels show the number or category for each tick.
  118042. *
  118043. * Since v8.0.0: Labels are animated in categorized x-axis with updating
  118044. * data if `tickInterval` and `step` is set to 1.
  118045. */
  118046. labels?: ZAxisLabelsOptions;
  118047. /**
  118048. * (Highcharts, Highstock, Gantt) Index of another axis that this axis is
  118049. * linked to. When an axis is linked to a master axis, it will take the same
  118050. * extremes as the master, but as assigned by min or max or by setExtremes.
  118051. * It can be used to show additional info, or to ease reading the chart by
  118052. * duplicating the scales.
  118053. */
  118054. linkedTo?: number;
  118055. /**
  118056. * (Highcharts) If there are multiple axes on the same side of the chart,
  118057. * the pixel margin between the axes. Defaults to 0 on vertical axes, 15 on
  118058. * horizontal axes.
  118059. */
  118060. margin?: number;
  118061. /**
  118062. * (Highcharts) The maximum value of the axis. If `null`, the max value is
  118063. * automatically calculated.
  118064. *
  118065. * If the endOnTick option is true, the `max` value might be rounded up.
  118066. *
  118067. * If a tickAmount is set, the axis may be extended beyond the set max in
  118068. * order to reach the given number of ticks. The same may happen in a chart
  118069. * with multiple axes, determined by chart. alignTicks, where a `tickAmount`
  118070. * is applied internally.
  118071. */
  118072. max?: (number|null);
  118073. /**
  118074. * (Highcharts) Padding of the max value relative to the length of the axis.
  118075. * A padding of 0.05 will make a 100px axis 5px longer. This is useful when
  118076. * you don't want the highest data value to appear on the edge of the plot
  118077. * area. When the axis' `max` option is set or a max extreme is set using
  118078. * `axis.setExtremes()`, the maxPadding will be ignored.
  118079. */
  118080. maxPadding?: number;
  118081. /**
  118082. * (Highstock, Gantt) Maximum range which can be set using the navigator's
  118083. * handles. Opposite of xAxis.minRange.
  118084. */
  118085. maxRange?: number;
  118086. /**
  118087. * (Highcharts) The minimum value of the axis. If `null` the min value is
  118088. * automatically calculated.
  118089. *
  118090. * If the startOnTick option is true (default), the `min` value might be
  118091. * rounded down.
  118092. *
  118093. * The automatically calculated minimum value is also affected by floor,
  118094. * softMin, minPadding, minRange as well as series.threshold and
  118095. * series.softThreshold.
  118096. */
  118097. min?: (number|null);
  118098. /**
  118099. * (Highcharts) Color of the minor, secondary grid lines.
  118100. *
  118101. * In styled mode, the stroke width is given in the
  118102. * `.highcharts-minor-grid-line` class.
  118103. */
  118104. minorGridLineColor?: ColorType;
  118105. /**
  118106. * (Highcharts) The dash or dot style of the minor grid lines. For possible
  118107. * values, see this demonstration.
  118108. */
  118109. minorGridLineDashStyle?: DashStyleValue;
  118110. /**
  118111. * (Highcharts) Width of the minor, secondary grid lines.
  118112. *
  118113. * In styled mode, the stroke width is given in the `.highcharts-grid-line`
  118114. * class.
  118115. */
  118116. minorGridLineWidth?: number;
  118117. /**
  118118. * (Highcharts) Color for the minor tick marks.
  118119. */
  118120. minorTickColor?: ColorType;
  118121. /**
  118122. * (Highcharts) Specific tick interval in axis units for the minor ticks. On
  118123. * a linear axis, if `"auto"`, the minor tick interval is calculated as a
  118124. * fifth of the tickInterval. If `null` or `undefined`, minor ticks are not
  118125. * shown.
  118126. *
  118127. * On logarithmic axes, the unit is the power of the value. For example,
  118128. * setting the minorTickInterval to 1 puts one tick on each of 0.1, 1, 10,
  118129. * 100 etc. Setting the minorTickInterval to 0.1 produces 9 ticks between 1
  118130. * and 10, 10 and 100 etc.
  118131. *
  118132. * If user settings dictate minor ticks to become too dense, they don't make
  118133. * sense, and will be ignored to prevent performance problems.
  118134. */
  118135. minorTickInterval?: (number|string|null);
  118136. /**
  118137. * (Highcharts) The pixel length of the minor tick marks.
  118138. */
  118139. minorTickLength?: number;
  118140. /**
  118141. * (Highcharts) The position of the minor tick marks relative to the axis
  118142. * line. Can be one of `inside` and `outside`.
  118143. */
  118144. minorTickPosition?: OptionsMinorTickPositionValue;
  118145. /**
  118146. * (Highcharts) Enable or disable minor ticks. Unless minorTickInterval is
  118147. * set, the tick interval is calculated as a fifth of the `tickInterval`.
  118148. *
  118149. * On a logarithmic axis, minor ticks are laid out based on a best guess,
  118150. * attempting to enter approximately 5 minor ticks between each major tick.
  118151. *
  118152. * Prior to v6.0.0, ticks were unabled in auto layout by setting
  118153. * `minorTickInterval` to `"auto"`.
  118154. */
  118155. minorTicks?: boolean;
  118156. /**
  118157. * (Highcharts) The pixel width of the minor tick mark.
  118158. */
  118159. minorTickWidth?: number;
  118160. /**
  118161. * (Highcharts, Highstock, Gantt) Padding of the min value relative to the
  118162. * length of the axis. A padding of 0.05 will make a 100px axis 5px longer.
  118163. * This is useful when you don't want the lowest data value to appear on the
  118164. * edge of the plot area. When the axis' `min` option is set or a min
  118165. * extreme is set using `axis.setExtremes()`, the minPadding will be
  118166. * ignored.
  118167. */
  118168. minPadding?: number;
  118169. /**
  118170. * (Highcharts) The minimum range to display on this axis. The entire axis
  118171. * will not be allowed to span over a smaller interval than this. For
  118172. * example, for a datetime axis the main unit is milliseconds. If minRange
  118173. * is set to 3600000, you can't zoom in more than to one hour.
  118174. *
  118175. * The default minRange for the x axis is five times the smallest interval
  118176. * between any of the data points.
  118177. *
  118178. * On a logarithmic axis, the unit for the minimum range is the power. So a
  118179. * minRange of 1 means that the axis can be zoomed to 10-100, 100-1000,
  118180. * 1000-10000 etc.
  118181. *
  118182. * **Note**: The `minPadding`, `maxPadding`, `startOnTick` and `endOnTick`
  118183. * settings also affect how the extremes of the axis are computed.
  118184. */
  118185. minRange?: number;
  118186. /**
  118187. * (Highcharts) The minimum tick interval allowed in axis values. For
  118188. * example on zooming in on an axis with daily data, this can be used to
  118189. * prevent the axis from showing hours. Defaults to the closest distance
  118190. * between two points on the axis.
  118191. */
  118192. minTickInterval?: number;
  118193. /**
  118194. * (Highcharts) The distance in pixels from the plot area to the axis line.
  118195. * A positive offset moves the axis with it's line, labels and ticks away
  118196. * from the plot area. This is typically used when two or more axes are
  118197. * displayed on the same side of the plot. With multiple axes the offset is
  118198. * dynamically adjusted to avoid collision, this can be overridden by
  118199. * setting offset explicitly.
  118200. */
  118201. offset?: number;
  118202. /**
  118203. * (Highcharts) Whether to display the axis on the opposite side of the
  118204. * normal. The normal is on the left side for vertical axes and bottom for
  118205. * horizontal, so the opposite sides will be right and top respectively.
  118206. * This is typically used with dual or multiple axes.
  118207. */
  118208. opposite?: boolean;
  118209. /**
  118210. * (Highstock) In an ordinal axis, the points are equally spaced in the
  118211. * chart regardless of the actual time or x distance between them. This
  118212. * means that missing data periods (e.g. nights or weekends for a stock
  118213. * chart) will not take up space in the chart. Having `ordinal: false` will
  118214. * show any gaps created by the `gapSize` setting proportionate to their
  118215. * duration.
  118216. *
  118217. * In stock charts the X axis is ordinal by default, unless the boost module
  118218. * is used and at least one of the series' data length exceeds the
  118219. * boostThreshold.
  118220. */
  118221. ordinal?: boolean;
  118222. /**
  118223. * (Highstock) Additional range on the right side of the xAxis. Works
  118224. * similar to `xAxis.maxPadding`, but value is set in milliseconds. Can be
  118225. * set for both main `xAxis` and the navigator's `xAxis`.
  118226. */
  118227. overscroll?: number;
  118228. /**
  118229. * (Highcharts) Refers to the index in the panes array. Used for circular
  118230. * gauges and polar charts. When the option is not set then first pane will
  118231. * be used.
  118232. */
  118233. pane?: number;
  118234. /**
  118235. * (Highcharts, Highstock, Gantt) An array of colored bands stretching
  118236. * across the plot area marking an interval on the axis.
  118237. *
  118238. * In styled mode, the plot bands are styled by the `.highcharts-plot-band`
  118239. * class in addition to the `className` option.
  118240. */
  118241. plotBands?: Array<ZAxisPlotBandsOptions>;
  118242. /**
  118243. * (Highcharts, Highstock, Gantt) An array of lines stretching across the
  118244. * plot area, marking a specific value on one of the axes.
  118245. *
  118246. * In styled mode, the plot lines are styled by the `.highcharts-plot-line`
  118247. * class in addition to the `className` option.
  118248. */
  118249. plotLines?: Array<ZAxisPlotLinesOptions>;
  118250. /**
  118251. * (Highstock) The zoomed range to display when only defining one or none of
  118252. * `min` or `max`. For example, to show the latest month, a range of one
  118253. * month can be set.
  118254. */
  118255. range?: number;
  118256. /**
  118257. * (Highcharts) Whether to reverse the axis so that the highest number is
  118258. * closest to the origin. If the chart is inverted, the x axis is reversed
  118259. * by default.
  118260. */
  118261. reversed?: boolean;
  118262. /**
  118263. * (Highcharts, Highstock) This option determines how stacks should be
  118264. * ordered within a group. For example reversed xAxis also reverses stacks,
  118265. * so first series comes last in a group. To keep order like for
  118266. * non-reversed xAxis enable this option.
  118267. */
  118268. reversedStacks?: boolean;
  118269. /**
  118270. * (Highstock) An optional scrollbar to display on the X axis in response to
  118271. * limiting the minimum and maximum of the axis values.
  118272. *
  118273. * In styled mode, all the presentational options for the scrollbar are
  118274. * replaced by the classes `.highcharts-scrollbar-thumb`,
  118275. * `.highcharts-scrollbar-arrow`, `.highcharts-scrollbar-button`,
  118276. * `.highcharts-scrollbar-rifles` and `.highcharts-scrollbar-track`.
  118277. */
  118278. scrollbar?: ZAxisScrollbarOptions;
  118279. /**
  118280. * (Highcharts) Whether to show the first tick label.
  118281. */
  118282. showFirstLabel?: boolean;
  118283. /**
  118284. * (Highcharts, Highstock, Gantt) Whether to show the last tick label.
  118285. * Defaults to `true` on cartesian charts, and `false` on polar charts.
  118286. */
  118287. showLastLabel?: boolean;
  118288. /**
  118289. * (Highcharts, Highstock, Gantt) A soft maximum for the axis. If the series
  118290. * data maximum is less than this, the axis will stay at this maximum, but
  118291. * if the series data maximum is higher, the axis will flex to show all
  118292. * data.
  118293. */
  118294. softMax?: number;
  118295. /**
  118296. * (Highcharts, Highstock, Gantt) A soft minimum for the axis. If the series
  118297. * data minimum is greater than this, the axis will stay at this minimum,
  118298. * but if the series data minimum is lower, the axis will flex to show all
  118299. * data.
  118300. */
  118301. softMin?: number;
  118302. /**
  118303. * (Highcharts, Highstock, Gantt) For datetime axes, this decides where to
  118304. * put the tick between weeks. 0 = Sunday, 1 = Monday.
  118305. */
  118306. startOfWeek?: number;
  118307. /**
  118308. * (Highcharts) Whether to force the axis to start on a tick. Use this
  118309. * option with the `minPadding` option to control the axis start.
  118310. */
  118311. startOnTick?: boolean;
  118312. /**
  118313. * (Highcharts, Highstock, Gantt) The amount of ticks to draw on the axis.
  118314. * This opens up for aligning the ticks of multiple charts or panes within a
  118315. * chart. This option overrides the `tickPixelInterval` option.
  118316. *
  118317. * This option only has an effect on linear axes. Datetime, logarithmic or
  118318. * category axes are not affected.
  118319. */
  118320. tickAmount?: number;
  118321. /**
  118322. * (Highcharts) Color for the main tick marks.
  118323. *
  118324. * In styled mode, the stroke is given in the `.highcharts-tick` class.
  118325. */
  118326. tickColor?: ColorType;
  118327. /**
  118328. * (Highcharts) The interval of the tick marks in axis units. When
  118329. * `undefined`, the tick interval is computed to approximately follow the
  118330. * tickPixelInterval on linear and datetime axes. On categorized axes, a
  118331. * `undefined` tickInterval will default to 1, one category. Note that
  118332. * datetime axes are based on milliseconds, so for example an interval of
  118333. * one day is expressed as `24 * 3600 * 1000`.
  118334. *
  118335. * On logarithmic axes, the tickInterval is based on powers, so a
  118336. * tickInterval of 1 means one tick on each of 0.1, 1, 10, 100 etc. A
  118337. * tickInterval of 2 means a tick of 0.1, 10, 1000 etc. A tickInterval of
  118338. * 0.2 puts a tick on 0.1, 0.2, 0.4, 0.6, 0.8, 1, 2, 4, 6, 8, 10, 20, 40
  118339. * etc.
  118340. *
  118341. * If the tickInterval is too dense for labels to be drawn, Highcharts may
  118342. * remove ticks.
  118343. *
  118344. * If the chart has multiple axes, the alignTicks option may interfere with
  118345. * the `tickInterval` setting.
  118346. */
  118347. tickInterval?: number;
  118348. /**
  118349. * (Highcharts) The pixel length of the main tick marks.
  118350. */
  118351. tickLength?: number;
  118352. /**
  118353. * (Highcharts, Gantt) For categorized axes only. If `on` the tick mark is
  118354. * placed in the center of the category, if `between` the tick mark is
  118355. * placed between categories. The default is `between` if the `tickInterval`
  118356. * is 1, else `on`.
  118357. */
  118358. tickmarkPlacement?: OptionsTickmarkPlacementValue;
  118359. /**
  118360. * (Highcharts) If tickInterval is `null` this option sets the approximate
  118361. * pixel interval of the tick marks. Not applicable to categorized axis.
  118362. *
  118363. * The tick interval is also influenced by the minTickInterval option, that,
  118364. * by default prevents ticks from being denser than the data points.
  118365. */
  118366. tickPixelInterval?: number;
  118367. /**
  118368. * (Highcharts) The position of the major tick marks relative to the axis
  118369. * line. Can be one of `inside` and `outside`.
  118370. */
  118371. tickPosition?: OptionsTickPositionValue;
  118372. /**
  118373. * (Highcharts) A callback function returning array defining where the ticks
  118374. * are laid out on the axis. This overrides the default behaviour of
  118375. * tickPixelInterval and tickInterval. The automatic tick positions are
  118376. * accessible through `this.tickPositions` and can be modified by the
  118377. * callback.
  118378. */
  118379. tickPositioner?: AxisTickPositionerCallbackFunction;
  118380. /**
  118381. * (Highcharts) An array defining where the ticks are laid out on the axis.
  118382. * This overrides the default behaviour of tickPixelInterval and
  118383. * tickInterval.
  118384. */
  118385. tickPositions?: Array<number>;
  118386. /**
  118387. * (Highcharts) The pixel width of the major tick marks. Defaults to 0 on
  118388. * category axes, otherwise 1.
  118389. *
  118390. * In styled mode, the stroke width is given in the `.highcharts-tick`
  118391. * class, but in order for the element to be generated on category axes, the
  118392. * option must be explicitly set to 1.
  118393. */
  118394. tickWidth?: (number|undefined);
  118395. /**
  118396. * (Highcharts) The axis title, showing next to the axis line.
  118397. */
  118398. title?: ZAxisTitleOptions;
  118399. /**
  118400. * (Highcharts, Gantt) The type of axis. Can be one of `linear`,
  118401. * `logarithmic`, `datetime` or `category`. In a datetime axis, the numbers
  118402. * are given in milliseconds, and tick marks are placed on appropriate
  118403. * values like full hours or days. In a category axis, the point names of
  118404. * the chart's series are used for categories, if not a categories array is
  118405. * defined.
  118406. */
  118407. type?: AxisTypeValue;
  118408. /**
  118409. * (Highcharts, Gantt) Applies only when the axis `type` is `category`. When
  118410. * `uniqueNames` is true, points are placed on the X axis according to their
  118411. * names. If the same point name is repeated in the same or another series,
  118412. * the point is placed on the same X position as other points of the same
  118413. * name. When `uniqueNames` is false, the points are laid out in increasing
  118414. * X positions regardless of their names, and the X axis category will take
  118415. * the name of the last point in each position.
  118416. */
  118417. uniqueNames?: boolean;
  118418. /**
  118419. * (Highcharts, Highstock, Gantt) Datetime axis only. An array determining
  118420. * what time intervals the ticks are allowed to fall on. Each array item is
  118421. * an array where the first value is the time unit and the second value
  118422. * another array of allowed multiples.
  118423. *
  118424. * Defaults to: (see online documentation for example)
  118425. */
  118426. units?: Array<[string, (Array<number>|null)]>;
  118427. /**
  118428. * (Highcharts, Highstock, Gantt) Whether axis, including axis title, line,
  118429. * ticks and labels, should be visible.
  118430. */
  118431. visible?: boolean;
  118432. /**
  118433. * (Highcharts) Whether to zoom axis. If `chart.zoomType` is set, the option
  118434. * allows to disable zooming on an individual axis.
  118435. */
  118436. zoomEnabled?: boolean;
  118437. }
  118438. /**
  118439. * (Highcharts, Highstock, Gantt) An object defining mouse events for the plot
  118440. * band. Supported properties are `click`, `mouseover`, `mouseout`, `mousemove`.
  118441. */
  118442. export interface ZAxisPlotBandsEventsOptions {
  118443. /**
  118444. * (Highcharts, Highstock, Gantt) Click event on a plot band.
  118445. */
  118446. click?: EventCallbackFunction<PlotLineOrBand>;
  118447. /**
  118448. * (Highcharts, Highstock, Gantt) Mouse move event on a plot band.
  118449. */
  118450. mousemove?: EventCallbackFunction<PlotLineOrBand>;
  118451. /**
  118452. * (Highcharts, Highstock, Gantt) Mouse out event on the corner of a plot
  118453. * band.
  118454. */
  118455. mouseout?: EventCallbackFunction<PlotLineOrBand>;
  118456. /**
  118457. * (Highcharts, Highstock, Gantt) Mouse over event on a plot band.
  118458. */
  118459. mouseover?: EventCallbackFunction<PlotLineOrBand>;
  118460. }
  118461. /**
  118462. * (Highcharts, Highstock, Gantt) Text labels for the plot bands
  118463. */
  118464. export interface ZAxisPlotBandsLabelOptions {
  118465. /**
  118466. * (Highcharts, Highstock, Gantt) Horizontal alignment of the label. Can be
  118467. * one of "left", "center" or "right".
  118468. */
  118469. align?: AlignValue;
  118470. /**
  118471. * (Highcharts, Highstock, Gantt) Rotation of the text label in degrees .
  118472. */
  118473. rotation?: number;
  118474. /**
  118475. * (Highcharts, Highstock, Gantt) CSS styles for the text label.
  118476. *
  118477. * In styled mode, the labels are styled by the
  118478. * `.highcharts-plot-band-label` class.
  118479. */
  118480. style?: CSSObject;
  118481. /**
  118482. * (Highcharts, Highstock, Gantt) The string text itself. A subset of HTML
  118483. * is supported.
  118484. */
  118485. text?: string;
  118486. /**
  118487. * (Highcharts, Highstock, Gantt) The text alignment for the label. While
  118488. * `align` determines where the texts anchor point is placed within the plot
  118489. * band, `textAlign` determines how the text is aligned against its anchor
  118490. * point. Possible values are "left", "center" and "right". Defaults to the
  118491. * same as the `align` option.
  118492. */
  118493. textAlign?: AlignValue;
  118494. /**
  118495. * (Highcharts, Highstock, Gantt) Whether to use HTML to render the labels.
  118496. */
  118497. useHTML?: boolean;
  118498. /**
  118499. * (Highcharts, Highstock, Gantt) Vertical alignment of the label relative
  118500. * to the plot band. Can be one of "top", "middle" or "bottom".
  118501. */
  118502. verticalAlign?: VerticalAlignValue;
  118503. /**
  118504. * (Highcharts, Highstock, Gantt) Horizontal position relative the
  118505. * alignment. Default varies by orientation.
  118506. */
  118507. x?: number;
  118508. /**
  118509. * (Highcharts, Highstock, Gantt) Vertical position of the text baseline
  118510. * relative to the alignment. Default varies by orientation.
  118511. */
  118512. y?: number;
  118513. }
  118514. /**
  118515. * (Highcharts, Highstock, Gantt) An array of colored bands stretching across
  118516. * the plot area marking an interval on the axis.
  118517. *
  118518. * In styled mode, the plot bands are styled by the `.highcharts-plot-band`
  118519. * class in addition to the `className` option.
  118520. */
  118521. export interface ZAxisPlotBandsOptions {
  118522. /**
  118523. * (Highstock) Flag to decide if plotBand should be rendered across all
  118524. * panes.
  118525. */
  118526. acrossPanes?: boolean;
  118527. /**
  118528. * (Highcharts, Highstock, Gantt) Border color for the plot band. Also
  118529. * requires `borderWidth` to be set.
  118530. */
  118531. borderColor?: ColorString;
  118532. /**
  118533. * (Highcharts, Highstock, Gantt) Border width for the plot band. Also
  118534. * requires `borderColor` to be set.
  118535. */
  118536. borderWidth?: number;
  118537. /**
  118538. * (Highcharts, Highstock, Gantt) A custom class name, in addition to the
  118539. * default `highcharts-plot-band`, to apply to each individual band.
  118540. */
  118541. className?: string;
  118542. /**
  118543. * (Highcharts, Highstock, Gantt) The color of the plot band.
  118544. */
  118545. color?: (ColorString|GradientColorObject|PatternObject);
  118546. /**
  118547. * (Highcharts, Highstock, Gantt) An object defining mouse events for the
  118548. * plot band. Supported properties are `click`, `mouseover`, `mouseout`,
  118549. * `mousemove`.
  118550. */
  118551. events?: ZAxisPlotBandsEventsOptions;
  118552. /**
  118553. * (Highcharts, Highstock, Gantt) The start position of the plot band in
  118554. * axis units.
  118555. */
  118556. from?: number;
  118557. /**
  118558. * (Highcharts, Highstock, Gantt) An id used for identifying the plot band
  118559. * in Axis.removePlotBand.
  118560. */
  118561. id?: string;
  118562. /**
  118563. * (Highcharts, Highstock, Gantt) Text labels for the plot bands
  118564. */
  118565. label?: ZAxisPlotBandsLabelOptions;
  118566. /**
  118567. * (Highcharts, Highstock, Gantt) The end position of the plot band in axis
  118568. * units.
  118569. */
  118570. to?: number;
  118571. /**
  118572. * (Highcharts, Highstock, Gantt) The z index of the plot band within the
  118573. * chart, relative to other elements. Using the same z index as another
  118574. * element may give unpredictable results, as the last rendered element will
  118575. * be on top. Values from 0 to 20 make sense.
  118576. */
  118577. zIndex?: number;
  118578. }
  118579. /**
  118580. * (Highcharts, Highstock, Gantt) An object defining mouse events for the plot
  118581. * line. Supported properties are `click`, `mouseover`, `mouseout`, `mousemove`.
  118582. */
  118583. export interface ZAxisPlotLinesEventsOptions {
  118584. /**
  118585. * (Highcharts, Highstock, Gantt) Click event on a plot band.
  118586. */
  118587. click?: EventCallbackFunction<PlotLineOrBand>;
  118588. /**
  118589. * (Highcharts, Highstock, Gantt) Mouse move event on a plot band.
  118590. */
  118591. mousemove?: EventCallbackFunction<PlotLineOrBand>;
  118592. /**
  118593. * (Highcharts, Highstock, Gantt) Mouse out event on the corner of a plot
  118594. * band.
  118595. */
  118596. mouseout?: EventCallbackFunction<PlotLineOrBand>;
  118597. /**
  118598. * (Highcharts, Highstock, Gantt) Mouse over event on a plot band.
  118599. */
  118600. mouseover?: EventCallbackFunction<PlotLineOrBand>;
  118601. }
  118602. /**
  118603. * (Highcharts, Highstock, Gantt) Text labels for the plot bands
  118604. */
  118605. export interface ZAxisPlotLinesLabelOptions {
  118606. /**
  118607. * (Highcharts, Highstock, Gantt) Horizontal alignment of the label. Can be
  118608. * one of "left", "center" or "right".
  118609. */
  118610. align?: AlignValue;
  118611. /**
  118612. * (Highcharts, Highstock, Gantt) Callback JavaScript function to format the
  118613. * label. Useful properties like the value of plot line or the range of plot
  118614. * band (`from` & `to` properties) can be found in `this.options` object.
  118615. */
  118616. formatter?: FormatterCallbackFunction<PlotLineOrBand>;
  118617. /**
  118618. * (Highcharts, Highstock, Gantt) Rotation of the text label in degrees.
  118619. * Defaults to 0 for horizontal plot lines and 90 for vertical lines.
  118620. */
  118621. rotation?: number;
  118622. /**
  118623. * (Highcharts, Highstock, Gantt) CSS styles for the text label.
  118624. *
  118625. * In styled mode, the labels are styled by the
  118626. * `.highcharts-plot-line-label` class.
  118627. */
  118628. style?: CSSObject;
  118629. /**
  118630. * (Highcharts, Highstock, Gantt) The text itself. A subset of HTML is
  118631. * supported.
  118632. */
  118633. text?: string;
  118634. /**
  118635. * (Highcharts, Highstock, Gantt) The text alignment for the label. While
  118636. * `align` determines where the texts anchor point is placed within the plot
  118637. * band, `textAlign` determines how the text is aligned against its anchor
  118638. * point. Possible values are "left", "center" and "right". Defaults to the
  118639. * same as the `align` option.
  118640. */
  118641. textAlign?: AlignValue;
  118642. /**
  118643. * (Highcharts, Highstock, Gantt) Whether to use HTML to render the labels.
  118644. */
  118645. useHTML?: boolean;
  118646. /**
  118647. * (Highcharts, Highstock, Gantt) Vertical alignment of the label relative
  118648. * to the plot line. Can be one of "top", "middle" or "bottom".
  118649. */
  118650. verticalAlign?: VerticalAlignValue;
  118651. /**
  118652. * (Highcharts, Highstock, Gantt) Horizontal position relative the
  118653. * alignment. Default varies by orientation.
  118654. */
  118655. x?: number;
  118656. /**
  118657. * (Highcharts, Highstock, Gantt) Vertical position of the text baseline
  118658. * relative to the alignment. Default varies by orientation.
  118659. */
  118660. y?: number;
  118661. }
  118662. /**
  118663. * (Highcharts, Highstock, Gantt) An array of lines stretching across the plot
  118664. * area, marking a specific value on one of the axes.
  118665. *
  118666. * In styled mode, the plot lines are styled by the `.highcharts-plot-line`
  118667. * class in addition to the `className` option.
  118668. */
  118669. export interface ZAxisPlotLinesOptions {
  118670. /**
  118671. * (Highstock) Flag to decide if plotLine should be rendered across all
  118672. * panes.
  118673. */
  118674. acrossPanes?: boolean;
  118675. /**
  118676. * (Highcharts, Highstock, Gantt) A custom class name, in addition to the
  118677. * default `highcharts-plot-line`, to apply to each individual line.
  118678. */
  118679. className?: string;
  118680. /**
  118681. * (Highcharts, Highstock, Gantt) The color of the line.
  118682. */
  118683. color?: ColorString;
  118684. /**
  118685. * (Highcharts, Highstock, Gantt) The dashing or dot style for the plot
  118686. * line. For possible values see this overview.
  118687. */
  118688. dashStyle?: DashStyleValue;
  118689. /**
  118690. * (Highcharts, Highstock, Gantt) An object defining mouse events for the
  118691. * plot line. Supported properties are `click`, `mouseover`, `mouseout`,
  118692. * `mousemove`.
  118693. */
  118694. events?: ZAxisPlotLinesEventsOptions;
  118695. /**
  118696. * (Highcharts, Highstock, Gantt) An id used for identifying the plot line
  118697. * in Axis.removePlotLine.
  118698. */
  118699. id?: string;
  118700. /**
  118701. * (Highcharts, Highstock, Gantt) Text labels for the plot bands
  118702. */
  118703. label?: ZAxisPlotLinesLabelOptions;
  118704. /**
  118705. * (Highcharts, Highstock, Gantt) The position of the line in axis units.
  118706. */
  118707. value?: number;
  118708. /**
  118709. * (Highcharts, Highstock, Gantt) The width or thickness of the plot line.
  118710. */
  118711. width?: number;
  118712. /**
  118713. * (Highcharts, Highstock, Gantt) The z index of the plot line within the
  118714. * chart.
  118715. */
  118716. zIndex?: number;
  118717. }
  118718. /**
  118719. * (Highstock) An optional scrollbar to display on the X axis in response to
  118720. * limiting the minimum and maximum of the axis values.
  118721. *
  118722. * In styled mode, all the presentational options for the scrollbar are replaced
  118723. * by the classes `.highcharts-scrollbar-thumb`, `.highcharts-scrollbar-arrow`,
  118724. * `.highcharts-scrollbar-button`, `.highcharts-scrollbar-rifles` and
  118725. * `.highcharts-scrollbar-track`.
  118726. */
  118727. export interface ZAxisScrollbarOptions {
  118728. /**
  118729. * (Highstock) The background color of the scrollbar itself.
  118730. */
  118731. barBackgroundColor?: (ColorString|GradientColorObject|PatternObject);
  118732. /**
  118733. * (Highstock) The color of the scrollbar's border.
  118734. */
  118735. barBorderColor?: (ColorString|GradientColorObject|PatternObject);
  118736. /**
  118737. * (Highstock) The border rounding radius of the bar.
  118738. */
  118739. barBorderRadius?: number;
  118740. /**
  118741. * (Highstock) The width of the bar's border.
  118742. */
  118743. barBorderWidth?: number;
  118744. /**
  118745. * (Highstock) The color of the small arrow inside the scrollbar buttons.
  118746. */
  118747. buttonArrowColor?: (ColorString|GradientColorObject|PatternObject);
  118748. /**
  118749. * (Highstock) The color of scrollbar buttons.
  118750. */
  118751. buttonBackgroundColor?: (ColorString|GradientColorObject|PatternObject);
  118752. /**
  118753. * (Highstock) The color of the border of the scrollbar buttons.
  118754. */
  118755. buttonBorderColor?: (ColorString|GradientColorObject|PatternObject);
  118756. /**
  118757. * (Highstock) The corner radius of the scrollbar buttons.
  118758. */
  118759. buttonBorderRadius?: number;
  118760. /**
  118761. * (Highstock) The border width of the scrollbar buttons.
  118762. */
  118763. buttonBorderWidth?: number;
  118764. /**
  118765. * (Highstock) Enable or disable the scrollbar.
  118766. */
  118767. enabled?: boolean;
  118768. /**
  118769. * (Highstock) The height of the scrollbar. The height also applies to the
  118770. * width of the scroll arrows so that they are always squares. Defaults to
  118771. * 20 for touch devices and 14 for mouse devices.
  118772. */
  118773. height?: number;
  118774. /**
  118775. * (Highstock) Whether to redraw the main chart as the scrollbar or the
  118776. * navigator zoomed window is moved. Defaults to `true` for modern browsers
  118777. * and `false` for legacy IE browsers as well as mobile devices.
  118778. */
  118779. liveRedraw?: boolean;
  118780. /**
  118781. * (Highstock) The margin between the scrollbar and its axis when the
  118782. * scrollbar is applied directly to an axis.
  118783. */
  118784. margin?: number;
  118785. /**
  118786. * (Highstock) The minimum width of the scrollbar.
  118787. */
  118788. minWidth?: number;
  118789. /**
  118790. * (Highstock) The color of the small rifles in the middle of the scrollbar.
  118791. */
  118792. rifleColor?: (ColorString|GradientColorObject|PatternObject);
  118793. /**
  118794. * (Highstock) Whether to show or hide the scrollbar when the scrolled
  118795. * content is zoomed out to it full extent.
  118796. */
  118797. showFull?: boolean;
  118798. /**
  118799. * (Highstock) The color of the track background.
  118800. */
  118801. trackBackgroundColor?: (ColorString|GradientColorObject|PatternObject);
  118802. /**
  118803. * (Highstock) The color of the border of the scrollbar track.
  118804. */
  118805. trackBorderColor?: (ColorString|GradientColorObject|PatternObject);
  118806. /**
  118807. * (Highstock) The corner radius of the border of the scrollbar track.
  118808. */
  118809. trackBorderRadius?: number;
  118810. /**
  118811. * (Highstock) The width of the border of the scrollbar track.
  118812. */
  118813. trackBorderWidth?: number;
  118814. /**
  118815. * (Highstock) The z index of the scrollbar group.
  118816. */
  118817. zIndex?: number;
  118818. }
  118819. /**
  118820. * (Highcharts) The axis title, showing next to the axis line.
  118821. */
  118822. export interface ZAxisTitleOptions {
  118823. /**
  118824. * (Highcharts) Alignment of the title relative to the axis values. Possible
  118825. * values are "low", "middle" or "high".
  118826. */
  118827. align?: AxisTitleAlignValue;
  118828. /**
  118829. * (Highcharts) The pixel distance between the axis labels or line and the
  118830. * title. Defaults to 0 for horizontal axes, 10 for vertical
  118831. */
  118832. margin?: number;
  118833. /**
  118834. * (Highcharts) The distance of the axis title from the axis line. By
  118835. * default, this distance is computed from the offset width of the labels,
  118836. * the labels' distance from the axis and the title's margin. However when
  118837. * the offset option is set, it overrides all this.
  118838. */
  118839. offset?: number;
  118840. /**
  118841. * (Highcharts) Defines how the title is repositioned according to the 3D
  118842. * chart orientation.
  118843. *
  118844. * - `'offset'`: Maintain a fixed horizontal/vertical distance from the tick
  118845. * marks, despite the chart orientation. This is the backwards compatible
  118846. * behavior, and causes skewing of X and Z axes.
  118847. *
  118848. * - `'chart'`: Preserve 3D position relative to the chart. This looks nice,
  118849. * but hard to read if the text isn't forward-facing.
  118850. *
  118851. * - `'flap'`: Rotated text along the axis to compensate for the chart
  118852. * orientation. This tries to maintain text as legible as possible on all
  118853. * orientations.
  118854. *
  118855. * - `'ortho'`: Rotated text along the axis direction so that the labels are
  118856. * orthogonal to the axis. This is very similar to `'flap'`, but prevents
  118857. * skewing the labels (X and Y scaling are still present).
  118858. *
  118859. * - `undefined`: Will use the config from `labels.position3d`
  118860. */
  118861. position3d?: ("chart"|"flap"|"offset"|"ortho"|null);
  118862. /**
  118863. * (Highcharts, Highstock, Gantt) Whether to reserve space for the title
  118864. * when laying out the axis.
  118865. */
  118866. reserveSpace?: boolean;
  118867. /**
  118868. * (Highcharts) The rotation of the text in degrees. 0 is horizontal, 270 is
  118869. * vertical reading from bottom to top.
  118870. */
  118871. rotation?: number;
  118872. /**
  118873. * (Highcharts) If enabled, the axis title will skewed to follow the
  118874. * perspective.
  118875. *
  118876. * This will fix overlapping labels and titles, but texts become less
  118877. * legible due to the distortion.
  118878. *
  118879. * The final appearance depends heavily on `title.position3d`.
  118880. *
  118881. * A `null` value will use the config from `labels.skew3d`.
  118882. */
  118883. skew3d?: (boolean|null);
  118884. /**
  118885. * (Highcharts) CSS styles for the title. If the title text is longer than
  118886. * the axis length, it will wrap to multiple lines by default. This can be
  118887. * customized by setting `textOverflow: 'ellipsis'`, by setting a specific
  118888. * `width` or by setting `whiteSpace: 'nowrap'`.
  118889. *
  118890. * In styled mode, the stroke width is given in the `.highcharts-axis-title`
  118891. * class.
  118892. */
  118893. style?: CSSObject;
  118894. /**
  118895. * (Highcharts) The actual text of the axis title. It can contain basic HTML
  118896. * tags like `b`, `i` and `span` with style.
  118897. */
  118898. text?: (string|null);
  118899. /**
  118900. * (Highcharts) Alignment of the text, can be `"left"`, `"right"` or
  118901. * `"center"`. Default alignment depends on the title.align:
  118902. *
  118903. * Horizontal axes:
  118904. *
  118905. * - for `align` = `"low"`, `textAlign` is set to `left`
  118906. *
  118907. * - for `align` = `"middle"`, `textAlign` is set to `center`
  118908. *
  118909. * - for `align` = `"high"`, `textAlign` is set to `right`
  118910. *
  118911. * Vertical axes:
  118912. *
  118913. * - for `align` = `"low"` and `opposite` = `true`, `textAlign` is set to
  118914. * `right`
  118915. *
  118916. * - for `align` = `"low"` and `opposite` = `false`, `textAlign` is set to
  118917. * `left`
  118918. *
  118919. * - for `align` = `"middle"`, `textAlign` is set to `center`
  118920. *
  118921. * - for `align` = `"high"` and `opposite` = `true` `textAlign` is set to
  118922. * `left`
  118923. *
  118924. * - for `align` = `"high"` and `opposite` = `false` `textAlign` is set to
  118925. * `right`
  118926. */
  118927. textAlign?: AlignValue;
  118928. /**
  118929. * (Highcharts, Highstock, Gantt) Whether to use HTML to render the axis
  118930. * title.
  118931. */
  118932. useHTML?: boolean;
  118933. /**
  118934. * (Highcharts, Highstock, Gantt) Horizontal pixel offset of the title
  118935. * position.
  118936. */
  118937. x?: number;
  118938. /**
  118939. * (Highcharts, Highstock, Gantt) Vertical pixel offset of the title
  118940. * position.
  118941. */
  118942. y?: number;
  118943. }
  118944. /**
  118945. * An annotation class which serves as a container for items like labels or
  118946. * shapes. Created items are positioned on the chart either by linking them to
  118947. * existing points or created mock points
  118948. */
  118949. export class Annotation {
  118950. /**
  118951. * An annotation class which serves as a container for items like labels or
  118952. * shapes. Created items are positioned on the chart either by linking them
  118953. * to existing points or created mock points
  118954. *
  118955. * @param chart
  118956. * a chart instance
  118957. *
  118958. * @param userOptions
  118959. * the options object
  118960. */
  118961. constructor(chart: Chart, userOptions: AnnotationsOptions);
  118962. /**
  118963. * The group svg element.
  118964. */
  118965. group: SVGElement;
  118966. /**
  118967. * The group svg element of the annotation's labels.
  118968. */
  118969. labelsGroup: SVGElement;
  118970. /**
  118971. * The options for the annotations.
  118972. */
  118973. options: AnnotationsOptions;
  118974. /**
  118975. * The group svg element of the annotation's shapes.
  118976. */
  118977. shapesGroup: SVGElement;
  118978. /**
  118979. * The user options for the annotations.
  118980. */
  118981. userOptions: AnnotationsOptions;
  118982. /**
  118983. * Updates an annotation.
  118984. *
  118985. * @param userOptions
  118986. * New user options for the annotation.
  118987. */
  118988. update(userOptions: Partial<AnnotationsOptions>): void;
  118989. }
  118990. /**
  118991. * A control point class which is a connection between controllable transform
  118992. * methods and a user actions.
  118993. */
  118994. export class AnnotationControlPoint {
  118995. /**
  118996. * A control point class which is a connection between controllable
  118997. * transform methods and a user actions.
  118998. *
  118999. * @param chart
  119000. * A chart instance.
  119001. *
  119002. * @param target
  119003. * A controllable instance which is a target for a control point.
  119004. *
  119005. * @param options
  119006. * An options object.
  119007. *
  119008. * @param index
  119009. * Point index.
  119010. */
  119011. constructor(chart: Chart, target: AnnotationControllable, options: AnnotationControlPointOptionsObject, index?: number);
  119012. /**
  119013. * Set the visibility of the control point.
  119014. *
  119015. * @param visible
  119016. * Visibility of the control point.
  119017. */
  119018. setVisibility(visible: boolean): void;
  119019. /**
  119020. * Update the control point.
  119021. *
  119022. * @param userOptions
  119023. * New options for the control point.
  119024. */
  119025. update(userOptions: Partial<AnnotationControlPointOptionsObject>): void;
  119026. }
  119027. /**
  119028. * The AST class represents an abstract syntax tree of HTML or SVG content. It
  119029. * can take HTML as an argument, parse it, optionally transform it to SVG, then
  119030. * perform sanitation before inserting it into the DOM.
  119031. */
  119032. export class AST {
  119033. /**
  119034. * The list of allowed references for referring attributes like `href` and
  119035. * `src`. Attribute values will only be allowed if they start with one of
  119036. * these strings.
  119037. */
  119038. static allowedReferences: any;
  119039. /**
  119040. * The list of allowed SVG or HTML tags, used for sanitizing potentially
  119041. * harmful content from the chart configuration before adding to the DOM.
  119042. */
  119043. static allowedTags: any;
  119044. /**
  119045. * The AST class represents an abstract syntax tree of HTML or SVG content.
  119046. * It can take HTML as an argument, parse it, optionally transform it to
  119047. * SVG, then perform sanitation before inserting it into the DOM.
  119048. *
  119049. * @param source
  119050. * Either an HTML string or an ASTNode list to populate the tree
  119051. */
  119052. constructor(source: (string|Array<ASTNode>));
  119053. /**
  119054. * Add the tree defined as a hierarchical JS structure to the DOM
  119055. *
  119056. * @param parent
  119057. * The node where it should be added
  119058. *
  119059. * @return The inserted node.
  119060. */
  119061. addToDOM(parent: (HTMLDOMElement|SVGDOMElement)): (HTMLDOMElement|SVGDOMElement);
  119062. /**
  119063. * Filter an object of SVG or HTML attributes against the allow list.
  119064. *
  119065. * @param attributes
  119066. * The attributes to filter
  119067. *
  119068. * @return The filtered attributes
  119069. */
  119070. filterUserAttributes(attributes: SVGAttributes): SVGAttributes;
  119071. /**
  119072. * Utility function to set html content for an element by passing in a
  119073. * markup string. The markup is safely parsed by the AST class to avoid XSS
  119074. * vulnerabilities. This function should be used instead of setting
  119075. * `innerHTML` in all cases where the content is not fully trusted.
  119076. *
  119077. * @param el
  119078. * The node to set content of
  119079. *
  119080. * @param html
  119081. * The markup string
  119082. */
  119083. setElementHTML(el: (HTMLDOMElement|SVGDOMElement), html: string): void;
  119084. }
  119085. /**
  119086. * Create a new axis object. Called internally when instanciating a new chart or
  119087. * adding axes by Highcharts.Chart#addAxis.
  119088. *
  119089. * A chart can have from 0 axes (pie chart) to multiples. In a normal, single
  119090. * series cartesian chart, there is one X axis and one Y axis.
  119091. *
  119092. * The X axis or axes are referenced by Highcharts.Chart.xAxis, which is an
  119093. * array of Axis objects. If there is only one axis, it can be referenced
  119094. * through `chart.xAxis[0]`, and multiple axes have increasing indices. The same
  119095. * pattern goes for Y axes.
  119096. *
  119097. * If you need to get the axes from a series object, use the `series.xAxis` and
  119098. * `series.yAxis` properties. These are not arrays, as one series can only be
  119099. * associated to one X and one Y axis.
  119100. *
  119101. * A third way to reference the axis programmatically is by `id`. Add an `id` in
  119102. * the axis configuration options, and get the axis by Highcharts.Chart#get.
  119103. *
  119104. * Configuration options for the axes are given in options.xAxis and
  119105. * options.yAxis.
  119106. */
  119107. export class Axis {
  119108. /**
  119109. * Create a new axis object. Called internally when instanciating a new
  119110. * chart or adding axes by Highcharts.Chart#addAxis.
  119111. *
  119112. * A chart can have from 0 axes (pie chart) to multiples. In a normal,
  119113. * single series cartesian chart, there is one X axis and one Y axis.
  119114. *
  119115. * The X axis or axes are referenced by Highcharts.Chart.xAxis, which is an
  119116. * array of Axis objects. If there is only one axis, it can be referenced
  119117. * through `chart.xAxis[0]`, and multiple axes have increasing indices. The
  119118. * same pattern goes for Y axes.
  119119. *
  119120. * If you need to get the axes from a series object, use the `series.xAxis`
  119121. * and `series.yAxis` properties. These are not arrays, as one series can
  119122. * only be associated to one X and one Y axis.
  119123. *
  119124. * A third way to reference the axis programmatically is by `id`. Add an
  119125. * `id` in the axis configuration options, and get the axis by
  119126. * Highcharts.Chart#get.
  119127. *
  119128. * Configuration options for the axes are given in options.xAxis and
  119129. * options.yAxis.
  119130. *
  119131. * @param chart
  119132. * The Chart instance to apply the axis on.
  119133. *
  119134. * @param userOptions
  119135. * Axis options.
  119136. */
  119137. constructor(chart: Chart, userOptions: AxisOptions);
  119138. /**
  119139. * If categories are present for the axis, names are used instead of numbers
  119140. * for that axis.
  119141. *
  119142. * Since Highcharts 3.0, categories can also be extracted by giving each
  119143. * point a name and setting axis type to `category`. However, if you have
  119144. * multiple series, best practice remains defining the `categories` array.
  119145. */
  119146. readonly categories: Array<string>;
  119147. /**
  119148. * The Chart that the axis belongs to.
  119149. */
  119150. chart: Chart;
  119151. /**
  119152. * The collection where the axis belongs, for example `xAxis`, `yAxis` or
  119153. * `colorAxis`. Corresponds to properties on Chart, for example Chart.xAxis.
  119154. */
  119155. coll: string;
  119156. /**
  119157. * The processed crosshair options.
  119158. */
  119159. crosshair: (boolean|AxisCrosshairOptions);
  119160. /**
  119161. * Whether the axis is horizontal.
  119162. */
  119163. horiz?: boolean;
  119164. /**
  119165. * Whether the axis is the x-axis.
  119166. */
  119167. isXAxis?: boolean;
  119168. /**
  119169. * The maximum value of the axis. In a logarithmic axis, this is the
  119170. * logarithm of the real value, and the real value can be obtained from
  119171. * Axis#getExtremes.
  119172. */
  119173. max: (number|null);
  119174. /**
  119175. * The minimum value of the axis. In a logarithmic axis, this is the
  119176. * logarithm of the real value, and the real value can be obtained from
  119177. * Axis#getExtremes.
  119178. */
  119179. min: (number|null);
  119180. /**
  119181. * List of minor ticks mapped by position on the axis.
  119182. */
  119183. minorTicks: Dictionary<Tick>;
  119184. /**
  119185. * Current options for the axis after merge of defaults and user's options.
  119186. */
  119187. options: AxisOptions;
  119188. /**
  119189. * Whether the axis is reversed. Based on the `axis.reversed`, option, but
  119190. * inverted charts have reversed xAxis by default.
  119191. */
  119192. reversed: boolean;
  119193. /**
  119194. * All series associated to the axis.
  119195. */
  119196. series: Array<Series>;
  119197. /**
  119198. * The side on which the axis is rendered. 0 is top, 1 is right, 2 is bottom
  119199. * and 3 is left.
  119200. */
  119201. side: number;
  119202. /**
  119203. * Contains the current positions that are laid out on the axis. The
  119204. * positions are numbers in terms of axis values. In a category axis they
  119205. * are integers, in a datetime axis they are also integers, but designating
  119206. * milliseconds.
  119207. *
  119208. * This property is read only - for modifying the tick positions, use the
  119209. * `tickPositioner` callback or [axis.tickPositions(
  119210. * https://api.highcharts.com/highcharts/xAxis.tickPositions) option
  119211. * instead.
  119212. */
  119213. tickPositions?: AxisTickPositionsArray;
  119214. /**
  119215. * List of major ticks mapped by postition on axis.
  119216. */
  119217. ticks: Dictionary<Tick>;
  119218. /**
  119219. * User's options for this axis without defaults.
  119220. */
  119221. userOptions: AxisOptions;
  119222. /**
  119223. * Add a plot band after render time.
  119224. *
  119225. * @param options
  119226. * A configuration object for the plot band, as defined in
  119227. * xAxis.plotBands.
  119228. *
  119229. * @return The added plot band.
  119230. */
  119231. addPlotBand(options: AxisPlotBandsOptions): (PlotLineOrBand|undefined);
  119232. /**
  119233. * Add a plot line after render time.
  119234. *
  119235. * @param options
  119236. * A configuration object for the plot line, as defined in
  119237. * xAxis.plotLines.
  119238. *
  119239. * @return The added plot line.
  119240. */
  119241. addPlotLine(options: AxisPlotLinesOptions): (PlotLineOrBand|undefined);
  119242. /**
  119243. * Adds the title defined in axis.options.title.
  119244. *
  119245. * @param display
  119246. * Whether or not to display the title.
  119247. */
  119248. addTitle(display?: boolean): void;
  119249. /**
  119250. * The default label formatter. The context is a special config object for
  119251. * the label. In apps, use the labels.formatter instead, except when a
  119252. * modification is needed.
  119253. *
  119254. * @param this
  119255. * Formatter context of axis label.
  119256. *
  119257. * @return The formatted label content.
  119258. */
  119259. defaultLabelFormatter(this: (AxisLabelsFormatterContextObject<number>|AxisLabelsFormatterContextObject<string>)): string;
  119260. /**
  119261. * Internal function to draw a crosshair.
  119262. *
  119263. * @param e
  119264. * The event arguments from the modified pointer event, extended with
  119265. * `chartX` and `chartY`
  119266. *
  119267. * @param point
  119268. * The Point object if the crosshair snaps to points.
  119269. *
  119270. * @fires Highcharts.Axis#afterDrawCrosshair
  119271. * @fires Highcharts.Axis#drawCrosshair
  119272. */
  119273. drawCrosshair(e?: PointerEventObject, point?: Point): void;
  119274. /**
  119275. * Get the current extremes for the axis.
  119276. *
  119277. * @return An object containing extremes information.
  119278. */
  119279. getExtremes(): ExtremesObject;
  119280. /**
  119281. * Internal function to get the tick positions of a linear axis to round
  119282. * values like whole tens or every five.
  119283. *
  119284. * @param tickInterval
  119285. * The normalized tick interval.
  119286. *
  119287. * @param min
  119288. * Axis minimum.
  119289. *
  119290. * @param max
  119291. * Axis maximum.
  119292. *
  119293. * @return An array of axis values where ticks should be placed.
  119294. */
  119295. getLinearTickPositions(tickInterval: number, min: number, max: number): Array<number>;
  119296. /**
  119297. * Internal function to get the path for the axis line. Extended for polar
  119298. * charts.
  119299. *
  119300. * @param lineWidth
  119301. * The line width in pixels.
  119302. *
  119303. * @return The SVG path definition in array form.
  119304. */
  119305. getLinePath(lineWidth: number): SVGPathArray;
  119306. /**
  119307. * Resolve the new minorTicks/minorTickInterval options into the legacy
  119308. * loosely typed minorTickInterval option.
  119309. */
  119310. getMinorTickInterval(): ("auto"|number|null);
  119311. /**
  119312. * Internal function to return the minor tick positions. For logarithmic
  119313. * axes, the same logic as for major ticks is reused.
  119314. *
  119315. * @return An array of axis values where ticks should be placed.
  119316. */
  119317. getMinorTickPositions(): Array<number>;
  119318. /**
  119319. * Internal function to create the SVG path definition for a plot band.
  119320. *
  119321. * @param from
  119322. * The axis value to start from.
  119323. *
  119324. * @param to
  119325. * The axis value to end on.
  119326. *
  119327. * @param options
  119328. * The plotBand or plotLine configuration object.
  119329. *
  119330. * @return The SVG path definition in array form.
  119331. */
  119332. getPlotBandPath(from: number, to: number, options: (AxisPlotBandsOptions|AxisPlotLinesOptions)): SVGPathArray;
  119333. /**
  119334. * Create the path for a plot line that goes from the given value on this
  119335. * axis, across the plot to the opposite side. Also used internally for grid
  119336. * lines and crosshairs.
  119337. *
  119338. * @param options
  119339. * Options for the path.
  119340. *
  119341. * @return The SVG path definition for the plot line.
  119342. */
  119343. getPlotLinePath(options: AxisPlotLinePathOptionsObject): (SVGPathArray|null);
  119344. /**
  119345. * Get the zero plane either based on zero or on the min or max value. Used
  119346. * in bar and area plots.
  119347. *
  119348. * @param threshold
  119349. * The threshold in axis values.
  119350. *
  119351. * @return The translated threshold position in terms of pixels, and
  119352. * corrected to stay within the axis bounds.
  119353. */
  119354. getThreshold(threshold: number): (number|undefined);
  119355. /**
  119356. * Return true if the axis has associated data.
  119357. *
  119358. * @return True if the axis has associated visible series and those series
  119359. * have either valid data points or explicit `min` and `max`
  119360. * settings.
  119361. */
  119362. hasData(): boolean;
  119363. /**
  119364. * Hide the crosshair if visible.
  119365. */
  119366. hideCrosshair(): void;
  119367. /**
  119368. * Overrideable function to initialize the axis.
  119369. *
  119370. * @param chart
  119371. * The Chart instance to apply the axis on.
  119372. *
  119373. * @param userOptions
  119374. * Axis options.
  119375. *
  119376. * @fires Highcharts.Axis#afterInit
  119377. * @fires Highcharts.Axis#init
  119378. */
  119379. init(chart: Chart, userOptions: AxisOptions): void;
  119380. /**
  119381. * Remove the axis from the chart.
  119382. *
  119383. * @param redraw
  119384. * Whether to redraw the chart following the remove.
  119385. */
  119386. remove(redraw?: boolean): void;
  119387. /**
  119388. * Remove a plot band by its id.
  119389. *
  119390. * @param id
  119391. * The plot band's `id` as given in the original configuration object
  119392. * or in the `addPlotBand` option.
  119393. */
  119394. removePlotBand(id: string): void;
  119395. /**
  119396. * Remove a plot line by its id.
  119397. *
  119398. * @param id
  119399. * The plot line's `id` as given in the original configuration object
  119400. * or in the `addPlotLine` option.
  119401. */
  119402. removePlotLine(id: string): void;
  119403. /**
  119404. * Render the axis line. Called internally when rendering and redrawing the
  119405. * axis.
  119406. */
  119407. renderLine(): void;
  119408. /**
  119409. * Render a minor tick into the given position. If a minor tick already
  119410. * exists in this position, move it.
  119411. *
  119412. * @param pos
  119413. * The position in axis values.
  119414. */
  119415. renderMinorTick(pos: number): void;
  119416. /**
  119417. * Render a major tick into the given position. If a tick already exists in
  119418. * this position, move it.
  119419. *
  119420. * @param pos
  119421. * The position in axis values.
  119422. *
  119423. * @param i
  119424. * The tick index.
  119425. */
  119426. renderTick(pos: number, i: number): void;
  119427. /**
  119428. * Set new axis categories and optionally redraw.
  119429. *
  119430. * @param categories
  119431. * The new categories.
  119432. *
  119433. * @param redraw
  119434. * Whether to redraw the chart.
  119435. */
  119436. setCategories(categories: Array<string>, redraw?: boolean): void;
  119437. /**
  119438. * Set the minimum and maximum of the axes after render time. If the
  119439. * `startOnTick` and `endOnTick` options are true, the minimum and maximum
  119440. * values are rounded off to the nearest tick. To prevent this, these
  119441. * options can be set to false before calling setExtremes. Also, setExtremes
  119442. * will not allow a range lower than the `minRange` option, which by default
  119443. * is the range of five points.
  119444. *
  119445. * @param newMin
  119446. * The new minimum value.
  119447. *
  119448. * @param newMax
  119449. * The new maximum value.
  119450. *
  119451. * @param redraw
  119452. * Whether to redraw the chart or wait for an explicit call to
  119453. * Highcharts.Chart#redraw
  119454. *
  119455. * @param animation
  119456. * Enable or modify animations.
  119457. *
  119458. * @param eventArguments
  119459. * Arguments to be accessed in event handler.
  119460. *
  119461. * @fires Highcharts.Axis#setExtremes
  119462. */
  119463. setExtremes(newMin?: number, newMax?: number, redraw?: boolean, animation?: (boolean|Partial<AnimationOptionsObject>), eventArguments?: any): void;
  119464. /**
  119465. * Update the axis title by options after render time.
  119466. *
  119467. * @param titleOptions
  119468. * The additional title options.
  119469. *
  119470. * @param redraw
  119471. * Whether to redraw the chart after setting the title.
  119472. */
  119473. setTitle(titleOptions: AxisTitleOptions, redraw?: boolean): void;
  119474. /**
  119475. * Translate a value in terms of axis units into pixels within the chart.
  119476. *
  119477. * @param value
  119478. * A value in terms of axis units.
  119479. *
  119480. * @param paneCoordinates
  119481. * Whether to return the pixel coordinate relative to the chart or
  119482. * just the axis/pane itself.
  119483. *
  119484. * @return Pixel position of the value on the chart or axis.
  119485. */
  119486. toPixels(value: number, paneCoordinates: boolean): number;
  119487. /**
  119488. * Translate a pixel position along the axis to a value in terms of axis
  119489. * units.
  119490. *
  119491. * @param pixel
  119492. * The pixel value coordinate.
  119493. *
  119494. * @param paneCoordinates
  119495. * Whether the input pixel is relative to the chart or just the
  119496. * axis/pane itself.
  119497. *
  119498. * @return The axis value.
  119499. */
  119500. toValue(pixel: number, paneCoordinates?: boolean): number;
  119501. /**
  119502. * Update an axis object with a new set of options. The options are merged
  119503. * with the existing options, so only new or altered options need to be
  119504. * specified.
  119505. *
  119506. * @param options
  119507. * The new options that will be merged in with existing options on
  119508. * the axis.
  119509. *
  119510. * @param redraw
  119511. * Whether to redraw the chart after the axis is altered. If doing
  119512. * more operations on the chart, it is a good idea to set redraw to
  119513. * false and call Chart#redraw after.
  119514. */
  119515. update(options: AxisOptions, redraw?: boolean): void;
  119516. }
  119517. /**
  119518. * The Chart class. The recommended constructor is Highcharts#chart.
  119519. */
  119520. export class Chart {
  119521. /**
  119522. * The Chart class. The recommended constructor is Highcharts#chart.
  119523. *
  119524. * @param options
  119525. * The chart options structure.
  119526. *
  119527. * @param callback
  119528. * Function to run when the chart has loaded and and all external
  119529. * images are loaded. Defining a chart.events.load handler is
  119530. * equivalent.
  119531. */
  119532. constructor(options: Options, callback?: ChartCallbackFunction);
  119533. /**
  119534. * The Chart class. The recommended constructor is Highcharts#chart.
  119535. *
  119536. * @param renderTo
  119537. * The DOM element to render to, or its id.
  119538. *
  119539. * @param options
  119540. * The chart options structure.
  119541. *
  119542. * @param callback
  119543. * Function to run when the chart has loaded and and all external
  119544. * images are loaded. Defining a chart.events.load handler is
  119545. * equivalent.
  119546. */
  119547. constructor(renderTo: (string|HTMLDOMElement), options: Options, callback?: ChartCallbackFunction);
  119548. /**
  119549. * All the axes in the chart.
  119550. */
  119551. axes: Array<Axis>;
  119552. /**
  119553. * The current pixel height of the chart.
  119554. */
  119555. chartHeight: number;
  119556. /**
  119557. * The current pixel width of the chart.
  119558. */
  119559. chartWidth: number;
  119560. /**
  119561. * The containing HTML element of the chart. The container is dynamically
  119562. * inserted into the element given as the `renderTo` parameter in the
  119563. * Highcharts#chart constructor.
  119564. */
  119565. container: HTMLDOMElement;
  119566. /**
  119567. * The chart's credits label. The label has an `update` method that allows
  119568. * setting new options as per the credits options set.
  119569. */
  119570. credits: SVGElement;
  119571. /**
  119572. * Contains the original hovered point.
  119573. */
  119574. hoverPoint: (Point|null);
  119575. /**
  119576. * Contains all hovered points.
  119577. */
  119578. hoverPoints: (Array<Point>|null);
  119579. /**
  119580. * Contains the original hovered series.
  119581. */
  119582. hoverSeries: (Series|null);
  119583. /**
  119584. * Index position of the chart in the Highcharts#charts property.
  119585. */
  119586. readonly index: number;
  119587. /**
  119588. * The flag is set to `true` if a series of the chart is inverted.
  119589. */
  119590. inverted?: boolean;
  119591. /**
  119592. * The overview of the chart's series.
  119593. */
  119594. legend: Legend;
  119595. /**
  119596. * Callback function to override the default function that formats all the
  119597. * numbers in the chart. Returns a string with the formatted number.
  119598. */
  119599. numberFormatter: NumberFormatterCallbackFunction;
  119600. /**
  119601. * The options structure for the chart after merging #defaultOptions and
  119602. * #userOptions. It contains members for the sub elements like series,
  119603. * legend, tooltip etc.
  119604. */
  119605. options: Options;
  119606. /**
  119607. * The current height of the plot area in pixels.
  119608. */
  119609. plotHeight: number;
  119610. /**
  119611. * The current left position of the plot area in pixels.
  119612. */
  119613. plotLeft: number;
  119614. /**
  119615. * The current top position of the plot area in pixels.
  119616. */
  119617. plotTop: number;
  119618. /**
  119619. * The current width of the plot area in pixels.
  119620. */
  119621. plotWidth: number;
  119622. /**
  119623. * The Pointer that keeps track of mouse and touch interaction.
  119624. */
  119625. pointer: Pointer;
  119626. /**
  119627. * The renderer instance of the chart. Each chart instance has only one
  119628. * associated renderer.
  119629. */
  119630. renderer: SVGRenderer;
  119631. /**
  119632. * All the current series in the chart.
  119633. */
  119634. series: Array<Series>;
  119635. /**
  119636. * Whether the chart is in styled mode, meaning all presentatinoal
  119637. * attributes are avoided.
  119638. */
  119639. styledMode: boolean;
  119640. /**
  119641. * The chart subtitle. The subtitle has an `update` method that allows
  119642. * modifying the options directly or indirectly via `chart.update`.
  119643. */
  119644. subtitle: SubtitleObject;
  119645. /**
  119646. * The `Time` object associated with the chart. Since v6.0.5, time settings
  119647. * can be applied individually for each chart. If no individual settings
  119648. * apply, the `Time` object is shared by all instances.
  119649. */
  119650. time: Time;
  119651. /**
  119652. * The chart title. The title has an `update` method that allows modifying
  119653. * the options directly or indirectly via `chart.update`.
  119654. */
  119655. title: TitleObject;
  119656. /**
  119657. * Tooltip object for points of series.
  119658. */
  119659. tooltip: Tooltip;
  119660. /**
  119661. * The original options given to the constructor or a chart factory like
  119662. * Highcharts.chart and Highcharts.stockChart.
  119663. */
  119664. userOptions: Options;
  119665. /**
  119666. * A collection of the X axes in the chart.
  119667. */
  119668. xAxis: Array<Axis>;
  119669. /**
  119670. * A collection of the Y axes in the chart.
  119671. */
  119672. yAxis: Array<Axis>;
  119673. /**
  119674. * Add an axis to the chart after render time. Note that this method should
  119675. * never be used when adding data synchronously at chart render time, as it
  119676. * adds expense to the calculations and rendering. When adding data at the
  119677. * same time as the chart is initialized, add the axis as a configuration
  119678. * option instead.
  119679. *
  119680. * @param options
  119681. * The axis options.
  119682. *
  119683. * @param isX
  119684. * Whether it is an X axis or a value axis.
  119685. *
  119686. * @param redraw
  119687. * Whether to redraw the chart after adding.
  119688. *
  119689. * @param animation
  119690. * Whether and how to apply animation in the redraw.
  119691. *
  119692. * @return The newly generated Axis object.
  119693. */
  119694. addAxis(options: AxisOptions, isX?: boolean, redraw?: boolean, animation?: (boolean|Partial<AnimationOptionsObject>)): Axis;
  119695. /**
  119696. * Add a color axis to the chart after render time. Note that this method
  119697. * should never be used when adding data synchronously at chart render time,
  119698. * as it adds expense to the calculations and rendering. When adding data at
  119699. * the same time as the chart is initialized, add the axis as a
  119700. * configuration option instead.
  119701. *
  119702. * @param options
  119703. * The axis options.
  119704. *
  119705. * @param redraw
  119706. * Whether to redraw the chart after adding.
  119707. *
  119708. * @param animation
  119709. * Whether and how to apply animation in the redraw.
  119710. *
  119711. * @return The newly generated Axis object.
  119712. */
  119713. addColorAxis(options: ColorAxisOptions, redraw?: boolean, animation?: (boolean|Partial<AnimationOptionsObject>)): ColorAxis;
  119714. /**
  119715. * Set a new credits label for the chart.
  119716. *
  119717. * @param credits
  119718. * A configuration object for the new credits.
  119719. */
  119720. addCredits(credits?: CreditsOptions): void;
  119721. /**
  119722. * Add a series to the chart after render time. Note that this method should
  119723. * never be used when adding data synchronously at chart render time, as it
  119724. * adds expense to the calculations and rendering. When adding data at the
  119725. * same time as the chart is initialized, add the series as a configuration
  119726. * option instead. With multiple axes, the `offset` is dynamically adjusted.
  119727. *
  119728. * @param options
  119729. * The config options for the series.
  119730. *
  119731. * @param redraw
  119732. * Whether to redraw the chart after adding.
  119733. *
  119734. * @param animation
  119735. * Whether to apply animation, and optionally animation
  119736. * configuration.
  119737. *
  119738. * @return The newly created series object.
  119739. *
  119740. * @fires Highcharts.Chart#addSeries
  119741. * @fires Highcharts.Chart#afterAddSeries
  119742. */
  119743. addSeries(options: SeriesOptionsType, redraw?: boolean, animation?: (boolean|Partial<AnimationOptionsObject>)): Series;
  119744. /**
  119745. * Remove the chart and purge memory. This method is called internally
  119746. * before adding a second chart into the same container, as well as on
  119747. * window unload to prevent leaks.
  119748. *
  119749. * @fires Highcharts.Chart#destroy
  119750. */
  119751. destroy(): void;
  119752. /**
  119753. * Get an axis, series or point object by `id` as given in the configuration
  119754. * options. Returns `undefined` if no item is found.
  119755. *
  119756. * @param id
  119757. * The id as given in the configuration options.
  119758. *
  119759. * @return The retrieved item.
  119760. */
  119761. get(id: string): (Axis|Point|Series|undefined);
  119762. /**
  119763. * Returns an array of all currently selected points in the chart. Points
  119764. * can be selected by clicking or programmatically by the
  119765. * Highcharts.Point#select function.
  119766. *
  119767. * @return The currently selected points.
  119768. */
  119769. getSelectedPoints(): Array<Point>;
  119770. /**
  119771. * Returns an array of all currently selected series in the chart. Series
  119772. * can be selected either programmatically by the Highcharts.Series#select
  119773. * function or by checking the checkbox next to the legend item if
  119774. * series.showCheckBox is true.
  119775. *
  119776. * @return The currently selected series.
  119777. */
  119778. getSelectedSeries(): Array<Series>;
  119779. /**
  119780. * Hide the loading layer.
  119781. */
  119782. hideLoading(): void;
  119783. /**
  119784. * Overridable function that initializes the chart. The constructor's
  119785. * arguments are passed on directly.
  119786. *
  119787. * @param userOptions
  119788. * Custom options.
  119789. *
  119790. * @param callback
  119791. * Function to run when the chart has loaded and and all external
  119792. * images are loaded.
  119793. *
  119794. * @fires Highcharts.Chart#init
  119795. * @fires Highcharts.Chart#afterInit
  119796. */
  119797. init(userOptions: Options, callback?: Function): void;
  119798. /**
  119799. * Check whether a given point is within the plot area.
  119800. *
  119801. * @param plotX
  119802. * Pixel x relative to the plot area.
  119803. *
  119804. * @param plotY
  119805. * Pixel y relative to the plot area.
  119806. *
  119807. * @param inverted
  119808. * Whether the chart is inverted.
  119809. *
  119810. * @return Returns true if the given point is inside the plot area.
  119811. */
  119812. isInsidePlot(plotX: number, plotY: number, inverted?: boolean): boolean;
  119813. /**
  119814. * Redraw the chart after changes have been done to the data, axis extremes
  119815. * chart size or chart elements. All methods for updating axes, series or
  119816. * points have a parameter for redrawing the chart. This is `true` by
  119817. * default. But in many cases you want to do more than one operation on the
  119818. * chart before redrawing, for example add a number of points. In those
  119819. * cases it is a waste of resources to redraw the chart for each new point
  119820. * added. So you add the points and call `chart.redraw()` after.
  119821. *
  119822. * @param animation
  119823. * If or how to apply animation to the redraw.
  119824. *
  119825. * @fires Highcharts.Chart#afterSetExtremes
  119826. * @fires Highcharts.Chart#beforeRedraw
  119827. * @fires Highcharts.Chart#predraw
  119828. * @fires Highcharts.Chart#redraw
  119829. * @fires Highcharts.Chart#render
  119830. * @fires Highcharts.Chart#updatedData
  119831. */
  119832. redraw(animation?: (boolean|Partial<AnimationOptionsObject>)): void;
  119833. /**
  119834. * Reflows the chart to its container. By default, the chart reflows
  119835. * automatically to its container following a `window.resize` event, as per
  119836. * the chart.reflow option. However, there are no reliable events for div
  119837. * resize, so if the container is resized without a window resize event,
  119838. * this must be called explicitly.
  119839. *
  119840. * @param e
  119841. * Event arguments. Used primarily when the function is called
  119842. * internally as a response to window resize.
  119843. */
  119844. reflow(e?: Event): void;
  119845. /**
  119846. * Set the caption options. This can also be done from Chart#update.
  119847. *
  119848. * @param options
  119849. * New caption options. The caption text itself is set by the
  119850. * `options.text` property.
  119851. */
  119852. setCaption(options: CaptionOptions): void;
  119853. /**
  119854. * Set the chart container's class name, in addition to
  119855. * `highcharts-container`.
  119856. *
  119857. * @param className
  119858. * The additional class name.
  119859. */
  119860. setClassName(className?: string): void;
  119861. /**
  119862. * Resize the chart to a given width and height. In order to set the width
  119863. * only, the height argument may be skipped. To set the height only, pass
  119864. * `undefined` for the width.
  119865. *
  119866. * @param width
  119867. * The new pixel width of the chart. Since v4.2.6, the argument can
  119868. * be `undefined` in order to preserve the current value (when
  119869. * setting height only), or `null` to adapt to the width of the
  119870. * containing element.
  119871. *
  119872. * @param height
  119873. * The new pixel height of the chart. Since v4.2.6, the argument can
  119874. * be `undefined` in order to preserve the current value, or `null`
  119875. * in order to adapt to the height of the containing element.
  119876. *
  119877. * @param animation
  119878. * Whether and how to apply animation.
  119879. *
  119880. * @fires Highcharts.Chart#endResize
  119881. * @fires Highcharts.Chart#resize
  119882. */
  119883. setSize(width?: (number|null), height?: (number|null), animation?: (boolean|Partial<AnimationOptionsObject>)): void;
  119884. /**
  119885. * Shortcut to set the subtitle options. This can also be done from
  119886. * Chart#update or Chart#setTitle.
  119887. *
  119888. * @param options
  119889. * New subtitle options. The subtitle text itself is set by the
  119890. * `options.text` property.
  119891. */
  119892. setSubtitle(options: SubtitleOptions): void;
  119893. /**
  119894. * Set a new title or subtitle for the chart.
  119895. *
  119896. * @param titleOptions
  119897. * New title options. The title text itself is set by the
  119898. * `titleOptions.text` property.
  119899. *
  119900. * @param subtitleOptions
  119901. * New subtitle options. The subtitle text itself is set by the
  119902. * `subtitleOptions.text` property.
  119903. *
  119904. * @param redraw
  119905. * Whether to redraw the chart or wait for a later call to
  119906. * `chart.redraw()`.
  119907. */
  119908. setTitle(titleOptions?: TitleOptions, subtitleOptions?: SubtitleOptions, redraw?: boolean): void;
  119909. /**
  119910. * Dim the chart and show a loading text or symbol. Options for the loading
  119911. * screen are defined in the loading options.
  119912. *
  119913. * @param str
  119914. * An optional text to show in the loading label instead of the
  119915. * default one. The default text is set in lang.loading.
  119916. */
  119917. showLoading(str?: string): void;
  119918. /**
  119919. * Display the zoom button, so users can reset zoom to the default view
  119920. * settings.
  119921. *
  119922. * @fires Highcharts.Chart#afterShowResetZoom
  119923. * @fires Highcharts.Chart#beforeShowResetZoom
  119924. */
  119925. showResetZoom(): void;
  119926. /**
  119927. * A generic function to update any element of the chart. Elements can be
  119928. * enabled and disabled, moved, re-styled, re-formatted etc.
  119929. *
  119930. * A special case is configuration objects that take arrays, for example
  119931. * xAxis, yAxis or series. For these collections, an `id` option is used to
  119932. * map the new option set to an existing object. If an existing object of
  119933. * the same id is not found, the corresponding item is updated. So for
  119934. * example, running `chart.update` with a series item without an id, will
  119935. * cause the existing chart's series with the same index in the series array
  119936. * to be updated. When the `oneToOne` parameter is true, `chart.update` will
  119937. * also take care of adding and removing items from the collection. Read
  119938. * more under the parameter description below.
  119939. *
  119940. * Note that when changing series data, `chart.update` may mutate the passed
  119941. * data options.
  119942. *
  119943. * See also the responsive option set. Switching between `responsive.rules`
  119944. * basically runs `chart.update` under the hood.
  119945. *
  119946. * @param options
  119947. * A configuration object for the new chart options.
  119948. *
  119949. * @param redraw
  119950. * Whether to redraw the chart.
  119951. *
  119952. * @param oneToOne
  119953. * When `true`, the `series`, `xAxis`, `yAxis` and `annotations`
  119954. * collections will be updated one to one, and items will be either
  119955. * added or removed to match the new updated options. For example, if
  119956. * the chart has two series and we call `chart.update` with a
  119957. * configuration containing three series, one will be added. If we
  119958. * call `chart.update` with one series, one will be removed. Setting
  119959. * an empty `series` array will remove all series, but leaving out
  119960. * the`series` property will leave all series untouched. If the
  119961. * series have id's, the new series options will be matched by id,
  119962. * and the remaining ones removed.
  119963. *
  119964. * @param animation
  119965. * Whether to apply animation, and optionally animation
  119966. * configuration.
  119967. *
  119968. * @fires Highcharts.Chart#update
  119969. * @fires Highcharts.Chart#afterUpdate
  119970. */
  119971. update(options: Options, redraw?: boolean, oneToOne?: boolean, animation?: (boolean|Partial<AnimationOptionsObject>)): void;
  119972. /**
  119973. * Zoom the chart out after a user has zoomed in. See also Axis.setExtremes.
  119974. *
  119975. * @fires Highcharts.Chart#selection
  119976. */
  119977. zoomOut(): void;
  119978. }
  119979. /**
  119980. * Handle color operations. Some object methods are chainable.
  119981. */
  119982. export class Color {
  119983. /**
  119984. * Creates a color instance out of a color string or object.
  119985. *
  119986. * @param input
  119987. * The input color in either rbga or hex format.
  119988. *
  119989. * @return Color instance.
  119990. */
  119991. static parse(input: ColorType): Color;
  119992. /**
  119993. * Handle color operations. Some object methods are chainable.
  119994. *
  119995. * @param input
  119996. * The input color in either rbga or hex format
  119997. */
  119998. constructor(input: ColorType);
  119999. /**
  120000. * Brighten the color instance.
  120001. *
  120002. * @param alpha
  120003. * The alpha value.
  120004. *
  120005. * @return This color with modifications.
  120006. */
  120007. brighten(alpha: number): Color;
  120008. /**
  120009. * Return the color or gradient stops in the specified format
  120010. *
  120011. * @param format
  120012. * Possible values are 'a', 'rgb', 'rgba' (default).
  120013. *
  120014. * @return This color as a string or gradient stops.
  120015. */
  120016. get(format?: string): ColorType;
  120017. /**
  120018. * Set the color's opacity to a given alpha value.
  120019. *
  120020. * @param alpha
  120021. * Opacity between 0 and 1.
  120022. *
  120023. * @return Color with modifications.
  120024. */
  120025. setOpacity(alpha: number): Color;
  120026. /**
  120027. * Return an intermediate color between two colors.
  120028. *
  120029. * @param to
  120030. * The color object to tween to.
  120031. *
  120032. * @param pos
  120033. * The intermediate position, where 0 is the from color (current
  120034. * color item), and 1 is the `to` color.
  120035. *
  120036. * @return The intermediate color in rgba notation.
  120037. */
  120038. tweenTo(to: Color, pos: number): ColorString;
  120039. }
  120040. /**
  120041. * The ColorAxis object for inclusion in gradient legends.
  120042. */
  120043. export class ColorAxis {
  120044. /**
  120045. * The ColorAxis object for inclusion in gradient legends.
  120046. *
  120047. * @param chart
  120048. * The related chart of the color axis.
  120049. *
  120050. * @param userOptions
  120051. * The color axis options for initialization.
  120052. */
  120053. constructor(chart: Chart, userOptions: ColorAxisOptions);
  120054. }
  120055. /**
  120056. * The overview of the chart's series. The legend object is instanciated
  120057. * internally in the chart constructor, and is available from the `chart.legend`
  120058. * property. Each chart has only one legend.
  120059. */
  120060. export class Legend {
  120061. /**
  120062. * The overview of the chart's series. The legend object is instanciated
  120063. * internally in the chart constructor, and is available from the
  120064. * `chart.legend` property. Each chart has only one legend.
  120065. *
  120066. * @param chart
  120067. * The chart instance.
  120068. *
  120069. * @param options
  120070. * Legend options.
  120071. */
  120072. constructor(chart: Chart, options: LegendOptions);
  120073. /**
  120074. * All items for the legend, which is an array of series for most series and
  120075. * an array of points for pie series and its derivatives.
  120076. */
  120077. readonly allItems: Array<(Point|Series)>;
  120078. /**
  120079. * SVG element of the legend box.
  120080. */
  120081. readonly box: SVGElement;
  120082. /**
  120083. * Chart of this legend.
  120084. */
  120085. readonly chart: Chart;
  120086. /**
  120087. * SVG group of the legend.
  120088. */
  120089. readonly group: SVGElement;
  120090. /**
  120091. * Legend options.
  120092. */
  120093. readonly options: LegendOptions;
  120094. /**
  120095. * SVG element of the legend title.
  120096. */
  120097. readonly title: SVGElement;
  120098. /**
  120099. * Set the legend item text.
  120100. *
  120101. * @param item
  120102. * The item for which to update the text in the legend.
  120103. */
  120104. setText(item: (Point|Series)): void;
  120105. /**
  120106. * Update the legend with new options. Equivalent to running `chart.update`
  120107. * with a legend configuration option.
  120108. *
  120109. * @param options
  120110. * Legend options.
  120111. *
  120112. * @param redraw
  120113. * Whether to redraw the chart after the axis is altered. If doing
  120114. * more operations on the chart, it is a good idea to set redraw to
  120115. * false and call Chart#redraw after. Whether to redraw the chart.
  120116. *
  120117. * @fires Highcharts.Legends#afterUpdate
  120118. */
  120119. update(options: LegendOptions, redraw?: boolean): void;
  120120. }
  120121. /**
  120122. * The object wrapper for plot lines and plot bands
  120123. */
  120124. export class PlotLineOrBand {
  120125. /**
  120126. * The object wrapper for plot lines and plot bands
  120127. */
  120128. constructor(axis: Axis, options?: (AxisPlotBandsOptions|AxisPlotLinesOptions));
  120129. /**
  120130. * SVG element of the label.
  120131. */
  120132. label: SVGElement;
  120133. /**
  120134. * SVG element of the plot line or band.
  120135. */
  120136. svgElement: SVGElement;
  120137. /**
  120138. * Remove the plot line or band.
  120139. */
  120140. destroy(): void;
  120141. }
  120142. /**
  120143. * The Point object. The point objects are generated from the `series.data`
  120144. * configuration objects or raw numbers. They can be accessed from the
  120145. * `Series.points` array. Other ways to instantiate points are through
  120146. * Highcharts.Series#addPoint or Highcharts.Series#setData.
  120147. */
  120148. export class Point {
  120149. /**
  120150. * For categorized axes this property holds the category name for the point.
  120151. * For other axes it holds the X value.
  120152. */
  120153. category: string;
  120154. /**
  120155. * The point's current color.
  120156. */
  120157. color?: (ColorString|GradientColorObject|PatternObject);
  120158. /**
  120159. * The point's current color index, used in styled mode instead of `color`.
  120160. * The color index is inserted in class names used for styling.
  120161. */
  120162. colorIndex: number;
  120163. /**
  120164. * (Highstock) Highstock only. If a point object is created by data
  120165. * grouping, it doesn't reflect actual points in the raw data. In this case,
  120166. * the `dataGroup` property holds information that points back to the raw
  120167. * data.
  120168. *
  120169. * - `dataGroup.start` is the index of the first raw data point in the
  120170. * group.
  120171. *
  120172. * - `dataGroup.length` is the amount of points in the group.
  120173. */
  120174. dataGroup?: DataGroupingInfoObject;
  120175. /**
  120176. * Contains the point's index in the `Series.points` array.
  120177. */
  120178. readonly index: number;
  120179. /**
  120180. * The name of the point. The name can be given as the first position of the
  120181. * point configuration array, or as a `name` property in the configuration:
  120182. */
  120183. name: string;
  120184. /**
  120185. * The point's options as applied in the initial configuration, or extended
  120186. * through `Point.update`.
  120187. *
  120188. * In TypeScript you have to extend `PointOptionsObject` via an additional
  120189. * interface to allow custom data options: (see online documentation for
  120190. * example)
  120191. */
  120192. options: PointOptionsObject;
  120193. /**
  120194. * The percentage for points in a stacked series or pies.
  120195. */
  120196. percentage?: number;
  120197. /**
  120198. * Whether the point is selected or not.
  120199. */
  120200. selected: boolean;
  120201. /**
  120202. * The series object associated with the point.
  120203. */
  120204. series: Series;
  120205. /**
  120206. * Pie series only. Whether to display a slice offset from the center.
  120207. */
  120208. sliced?: boolean;
  120209. /**
  120210. * The total of values in either a stack for stacked series, or a pie in a
  120211. * pie series.
  120212. */
  120213. total?: number;
  120214. /**
  120215. * For certain series types, like pie charts, where individual points can be
  120216. * shown or hidden.
  120217. */
  120218. visible: boolean;
  120219. /**
  120220. * The x value of the point.
  120221. */
  120222. x: number;
  120223. /**
  120224. * The y value of the point.
  120225. */
  120226. y?: number;
  120227. /**
  120228. * Get the CSS class names for individual points. Used internally where the
  120229. * returned value is set on every point.
  120230. *
  120231. * @return The class names.
  120232. */
  120233. getClassName(): string;
  120234. /**
  120235. * Return the configuration hash needed for the data label and tooltip
  120236. * formatters.
  120237. *
  120238. * @return Abstract object used in formatters and formats.
  120239. */
  120240. getLabelConfig(): PointLabelObject;
  120241. /**
  120242. * In a series with `zones`, return the zone that the point belongs to.
  120243. *
  120244. * @return The zone item.
  120245. */
  120246. getZone(): SeriesZonesOptionsObject;
  120247. /**
  120248. * Get the path definition for the halo, which is usually a shadow-like
  120249. * circle around the currently hovered point.
  120250. *
  120251. * @param size
  120252. * The radius of the circular halo.
  120253. *
  120254. * @return The path definition.
  120255. */
  120256. haloPath(size: number): SVGPathArray;
  120257. /**
  120258. * Initialize the point. Called internally based on the `series.data`
  120259. * option.
  120260. *
  120261. * @param series
  120262. * The series object containing this point.
  120263. *
  120264. * @param options
  120265. * The data in either number, array or object format.
  120266. *
  120267. * @param x
  120268. * Optionally, the X value of the point.
  120269. *
  120270. * @return The Point instance.
  120271. *
  120272. * @fires Highcharts.Point#afterInit
  120273. */
  120274. init(series: Series, options: PointOptionsType, x?: number): Point;
  120275. /**
  120276. * Runs on mouse out from the point. Called internally from mouse and touch
  120277. * events.
  120278. *
  120279. * @fires Highcharts.Point#mouseOut
  120280. */
  120281. onMouseOut(): void;
  120282. /**
  120283. * Runs on mouse over the point. Called internally from mouse and touch
  120284. * events.
  120285. *
  120286. * @param e
  120287. * The event arguments.
  120288. */
  120289. onMouseOver(e?: PointerEventObject): void;
  120290. /**
  120291. * Transform number or array configs into objects. Also called for object
  120292. * configs. Used internally to unify the different configuration formats for
  120293. * points. For example, a simple number `10` in a line series will be
  120294. * transformed to `{ y: 10 }`, and an array config like `[1, 10]` in a
  120295. * scatter series will be transformed to `{ x: 1, y: 10 }`.
  120296. *
  120297. * @param options
  120298. * The input option.
  120299. *
  120300. * @return Transformed options.
  120301. */
  120302. optionsToObject(options: PointOptionsType): Dictionary<any>;
  120303. /**
  120304. * Remove a point and optionally redraw the series and if necessary the axes
  120305. *
  120306. * @param redraw
  120307. * Whether to redraw the chart or wait for an explicit call. When
  120308. * doing more operations on the chart, for example running
  120309. * `point.remove()` in a loop, it is best practice to set `redraw` to
  120310. * false and call `chart.redraw()` after.
  120311. *
  120312. * @param animation
  120313. * Whether to apply animation, and optionally animation
  120314. * configuration.
  120315. */
  120316. remove(redraw?: boolean, animation?: (boolean|Partial<AnimationOptionsObject>)): void;
  120317. /**
  120318. * Toggle the selection status of a point.
  120319. *
  120320. * @param selected
  120321. * When `true`, the point is selected. When `false`, the point is
  120322. * unselected. When `null` or `undefined`, the selection state is
  120323. * toggled.
  120324. *
  120325. * @param accumulate
  120326. * When `true`, the selection is added to other selected points. When
  120327. * `false`, other selected points are deselected. Internally in
  120328. * Highcharts, when allowPointSelect is `true`, selected points are
  120329. * accumulated on Control, Shift or Cmd clicking the point.
  120330. *
  120331. * @fires Highcharts.Point#select
  120332. * @fires Highcharts.Point#unselect
  120333. */
  120334. select(selected?: boolean, accumulate?: boolean): void;
  120335. /**
  120336. * Set a value in an object, on the property defined by key. The key
  120337. * supports nested properties using dot notation. The function modifies the
  120338. * input object and does not make a copy.
  120339. *
  120340. * @param object
  120341. * The object to set the value on.
  120342. *
  120343. * @param value
  120344. * The value to set.
  120345. *
  120346. * @param key
  120347. * Key to the property to set.
  120348. *
  120349. * @return The modified object.
  120350. */
  120351. setNestedProperty<T>(object: T, value: any, key: string): T;
  120352. /**
  120353. * Set the point's state.
  120354. *
  120355. * @param state
  120356. * The new state, can be one of `'hover'`, `'select'`, `'inactive'`,
  120357. * or `''` (an empty string), `'normal'` or `undefined` to set to
  120358. * normal state.
  120359. *
  120360. * @param move
  120361. * State for animation.
  120362. *
  120363. * @fires Highcharts.Point#afterSetState
  120364. */
  120365. setState(state?: (""|PointStateValue), move?: boolean): void;
  120366. /**
  120367. * Extendable method for formatting each point's tooltip line.
  120368. *
  120369. * @param pointFormat
  120370. * The point format.
  120371. *
  120372. * @return A string to be concatenated in to the common tooltip text.
  120373. */
  120374. tooltipFormatter(pointFormat: string): string;
  120375. /**
  120376. * Update point with new options (typically x/y data) and optionally redraw
  120377. * the series.
  120378. *
  120379. * @param options
  120380. * The point options. Point options are handled as described under
  120381. * the `series.type.data` item for each series type. For example for
  120382. * a line series, if options is a single number, the point will be
  120383. * given that number as the marin y value. If it is an array, it will
  120384. * be interpreted as x and y values respectively. If it is an object,
  120385. * advanced options are applied.
  120386. *
  120387. * @param redraw
  120388. * Whether to redraw the chart after the point is updated. If doing
  120389. * more operations on the chart, it is best practice to set `redraw`
  120390. * to false and call `chart.redraw()` after.
  120391. *
  120392. * @param animation
  120393. * Whether to apply animation, and optionally animation
  120394. * configuration.
  120395. *
  120396. * @fires Highcharts.Point#update
  120397. */
  120398. update(options: PointOptionsType, redraw?: boolean, animation?: (boolean|Partial<AnimationOptionsObject>)): void;
  120399. }
  120400. /**
  120401. * The mouse and touch tracker object. Each Chart item has one assosiated
  120402. * Pointer item that can be accessed from the Chart.pointer property.
  120403. */
  120404. export class Pointer {
  120405. /**
  120406. * The mouse and touch tracker object. Each Chart item has one assosiated
  120407. * Pointer item that can be accessed from the Chart.pointer property.
  120408. *
  120409. * @param chart
  120410. * The chart instance.
  120411. *
  120412. * @param options
  120413. * The root options object. The pointer uses options from the chart
  120414. * and tooltip structures.
  120415. */
  120416. constructor(chart: Chart, options: Options);
  120417. /**
  120418. * Destroys the Pointer object and disconnects DOM events.
  120419. */
  120420. destroy(): void;
  120421. /**
  120422. * Finds the closest point to a set of coordinates, using the k-d-tree
  120423. * algorithm.
  120424. *
  120425. * @param series
  120426. * All the series to search in.
  120427. *
  120428. * @param shared
  120429. * Whether it is a shared tooltip or not.
  120430. *
  120431. * @param e
  120432. * The pointer event object, containing chart coordinates of the
  120433. * pointer.
  120434. *
  120435. * @return The point closest to given coordinates.
  120436. */
  120437. findNearestKDPoint(series: Array<Series>, shared: (boolean|undefined), e: PointerEventObject): (Point|undefined);
  120438. /**
  120439. * Return the cached chartPosition if it is available on the Pointer,
  120440. * otherwise find it. Running offset is quite expensive, so it should be
  120441. * avoided when we know the chart hasn't moved.
  120442. *
  120443. * @return The offset of the chart container within the page
  120444. */
  120445. getChartPosition(): ChartPositionObject;
  120446. /**
  120447. * Get the click position in terms of axis values.
  120448. *
  120449. * @param e
  120450. * Pointer event, extended with `chartX` and `chartY` properties.
  120451. */
  120452. getCoordinates(e: PointerEventObject): PointerAxisCoordinatesObject;
  120453. /**
  120454. * Utility to detect whether an element has, or has a parent with, a
  120455. * specificclass name. Used on detection of tracker objects and on deciding
  120456. * whether hovering the tooltip should cause the active series to mouse out.
  120457. *
  120458. * @param element
  120459. * The element to investigate.
  120460. *
  120461. * @param className
  120462. * The class name to look for.
  120463. *
  120464. * @return True if either the element or one of its parents has the given
  120465. * class name.
  120466. */
  120467. inClass(element: (HTMLDOMElement|SVGDOMElement), className: string): (boolean|undefined);
  120468. /**
  120469. * Takes a browser event object and extends it with custom Highcharts
  120470. * properties `chartX` and `chartY` in order to work on the internal
  120471. * coordinate system.
  120472. *
  120473. * @param e
  120474. * Event object in standard browsers.
  120475. *
  120476. * @param chartPosition
  120477. * Additional chart offset.
  120478. *
  120479. * @return A browser event with extended properties `chartX` and `chartY`.
  120480. */
  120481. normalize(e: (MouseEvent|PointerEvent|TouchEvent), chartPosition?: OffsetObject): PointerEventObject;
  120482. /**
  120483. * Reset the tracking by hiding the tooltip, the hover series state and the
  120484. * hover point
  120485. *
  120486. * @param allowMove
  120487. * Instead of destroying the tooltip altogether, allow moving it if
  120488. * possible.
  120489. */
  120490. reset(allowMove?: boolean, delay?: number): void;
  120491. }
  120492. /**
  120493. * This is the base series prototype that all other series types inherit from. A
  120494. * new series is initialized either through the series option structure, or
  120495. * after the chart is initialized, through Highcharts.Chart#addSeries.
  120496. *
  120497. * The object can be accessed in a number of ways. All series and point event
  120498. * handlers give a reference to the `series` object. The chart object has a
  120499. * series property that is a collection of all the chart's series. The point
  120500. * objects and axis objects also have the same reference.
  120501. *
  120502. * Another way to reference the series programmatically is by `id`. Add an id in
  120503. * the series configuration options, and get the series object by
  120504. * Highcharts.Chart#get.
  120505. *
  120506. * Configuration options for the series are given in three levels. Options for
  120507. * all series in a chart are given in the plotOptions.series object. Then
  120508. * options for all series of a specific type are given in the plotOptions of
  120509. * that type, for example `plotOptions.line`. Next, options for one single
  120510. * series are given in the series array, or as arguments to `chart.addSeries`.
  120511. *
  120512. * The data in the series is stored in various arrays.
  120513. *
  120514. * - First, `series.options.data` contains all the original config options for
  120515. * each point whether added by options or methods like `series.addPoint`.
  120516. *
  120517. * - Next, `series.data` contains those values converted to points, but in case
  120518. * the series data length exceeds the `cropThreshold`, or if the data is
  120519. * grouped, `series.data` doesn't contain all the points. It only contains the
  120520. * points that have been created on demand.
  120521. *
  120522. * - Then there's `series.points` that contains all currently visible point
  120523. * objects. In case of cropping, the cropped-away points are not part of this
  120524. * array. The `series.points` array starts at `series.cropStart` compared to
  120525. * `series.data` and `series.options.data`. If however the series data is
  120526. * grouped, these can't be correlated one to one.
  120527. *
  120528. * - `series.xData` and `series.processedXData` contain clean x values,
  120529. * equivalent to `series.data` and `series.points`.
  120530. *
  120531. * - `series.yData` and `series.processedYData` contain clean y values,
  120532. * equivalent to `series.data` and `series.points`.
  120533. */
  120534. export class Series {
  120535. /**
  120536. * This is the base series prototype that all other series types inherit
  120537. * from. A new series is initialized either through the series option
  120538. * structure, or after the chart is initialized, through
  120539. * Highcharts.Chart#addSeries.
  120540. *
  120541. * The object can be accessed in a number of ways. All series and point
  120542. * event handlers give a reference to the `series` object. The chart object
  120543. * has a series property that is a collection of all the chart's series. The
  120544. * point objects and axis objects also have the same reference.
  120545. *
  120546. * Another way to reference the series programmatically is by `id`. Add an
  120547. * id in the series configuration options, and get the series object by
  120548. * Highcharts.Chart#get.
  120549. *
  120550. * Configuration options for the series are given in three levels. Options
  120551. * for all series in a chart are given in the plotOptions.series object.
  120552. * Then options for all series of a specific type are given in the
  120553. * plotOptions of that type, for example `plotOptions.line`. Next, options
  120554. * for one single series are given in the series array, or as arguments to
  120555. * `chart.addSeries`.
  120556. *
  120557. * The data in the series is stored in various arrays.
  120558. *
  120559. * - First, `series.options.data` contains all the original config options
  120560. * for each point whether added by options or methods like
  120561. * `series.addPoint`.
  120562. *
  120563. * - Next, `series.data` contains those values converted to points, but in
  120564. * case the series data length exceeds the `cropThreshold`, or if the data
  120565. * is grouped, `series.data` doesn't contain all the points. It only
  120566. * contains the points that have been created on demand.
  120567. *
  120568. * - Then there's `series.points` that contains all currently visible point
  120569. * objects. In case of cropping, the cropped-away points are not part of
  120570. * this array. The `series.points` array starts at `series.cropStart`
  120571. * compared to `series.data` and `series.options.data`. If however the
  120572. * series data is grouped, these can't be correlated one to one.
  120573. *
  120574. * - `series.xData` and `series.processedXData` contain clean x values,
  120575. * equivalent to `series.data` and `series.points`.
  120576. *
  120577. * - `series.yData` and `series.processedYData` contain clean y values,
  120578. * equivalent to `series.data` and `series.points`.
  120579. *
  120580. * @param chart
  120581. * The chart instance.
  120582. *
  120583. * @param options
  120584. * The series options.
  120585. */
  120586. constructor(chart: Chart, options: (object|SeriesOptionsType));
  120587. /**
  120588. * SVG element of area-based charts. Can be used for styling purposes. If
  120589. * zones are configured, this element will be hidden and replaced by
  120590. * multiple zone areas, accessible via `series['zone-area-x']` (where x is a
  120591. * number, starting with 0).
  120592. */
  120593. area?: SVGElement;
  120594. /**
  120595. * Read only. The chart that the series belongs to.
  120596. */
  120597. chart: Chart;
  120598. /**
  120599. * Read only. An array containing those values converted to points. In case
  120600. * the series data length exceeds the `cropThreshold`, or if the data is
  120601. * grouped, `series.data` doesn't contain all the points. Also, in case a
  120602. * series is hidden, the `data` array may be empty. To access raw values,
  120603. * `series.options.data` will always be up to date. `Series.data` only
  120604. * contains the points that have been created on demand. To modify the data,
  120605. * use Highcharts.Series#setData or Highcharts.Point#update.
  120606. */
  120607. data: Array<Point>;
  120608. /**
  120609. * Contains the maximum value of the series' data point. Some series types
  120610. * like `networkgraph` do not support this property as they lack a
  120611. * `y`-value.
  120612. */
  120613. readonly dataMax?: number;
  120614. /**
  120615. * Contains the minimum value of the series' data point. Some series types
  120616. * like `networkgraph` do not support this property as they lack a
  120617. * `y`-value.
  120618. */
  120619. readonly dataMin?: number;
  120620. /**
  120621. * SVG element of line-based charts. Can be used for styling purposes. If
  120622. * zones are configured, this element will be hidden and replaced by
  120623. * multiple zone lines, accessible via `series['zone-graph-x']` (where x is
  120624. * a number, starting with 0).
  120625. */
  120626. graph?: SVGElement;
  120627. /**
  120628. * Contains the series' index in the `Chart.series` array.
  120629. */
  120630. readonly index: number;
  120631. /**
  120632. * The series name as given in the options. Defaults to "Series {n}".
  120633. */
  120634. name: string;
  120635. /**
  120636. * Read only. The series' current options. To update, use Series#update.
  120637. */
  120638. options: SeriesOptionsType;
  120639. /**
  120640. * An array containing all currently visible point objects. In case of
  120641. * cropping, the cropped-away points are not part of this array. The
  120642. * `series.points` array starts at `series.cropStart` compared to
  120643. * `series.data` and `series.options.data`. If however the series data is
  120644. * grouped, these can't be correlated one to one. To modify the data, use
  120645. * Highcharts.Series#setData or Highcharts.Point#update.
  120646. */
  120647. points: Array<Point>;
  120648. /**
  120649. * Read only. The series' selected state as set by Highcharts.Series#select.
  120650. */
  120651. selected: boolean;
  120652. /**
  120653. * Read only. The series' type, like "line", "area", "column" etc. The type
  120654. * in the series options anc can be altered using Series#update.
  120655. */
  120656. type: string;
  120657. /**
  120658. * Contains series options by the user without defaults.
  120659. */
  120660. userOptions: SeriesOptionsType;
  120661. /**
  120662. * Read only. The series' visibility state as set by Series#show,
  120663. * Series#hide, or in the initial configuration.
  120664. */
  120665. visible: boolean;
  120666. /**
  120667. * Read only. The unique xAxis object associated with the series.
  120668. */
  120669. xAxis: Axis;
  120670. /**
  120671. * Read only. The unique yAxis object associated with the series.
  120672. */
  120673. yAxis: Axis;
  120674. /**
  120675. * Add a point to the series after render time. The point can be added at
  120676. * the end, or by giving it an X value, to the start or in the middle of the
  120677. * series.
  120678. *
  120679. * @param options
  120680. * The point options. If options is a single number, a point with
  120681. * that y value is appended to the series. If it is an array, it will
  120682. * be interpreted as x and y values respectively. If it is an object,
  120683. * advanced options as outlined under `series.data` are applied.
  120684. *
  120685. * @param redraw
  120686. * Whether to redraw the chart after the point is added. When adding
  120687. * more than one point, it is highly recommended that the redraw
  120688. * option be set to false, and instead Chart#redraw is explicitly
  120689. * called after the adding of points is finished. Otherwise, the
  120690. * chart will redraw after adding each point.
  120691. *
  120692. * @param shift
  120693. * If true, a point is shifted off the start of the series as one is
  120694. * appended to the end.
  120695. *
  120696. * @param animation
  120697. * Whether to apply animation, and optionally animation
  120698. * configuration.
  120699. *
  120700. * @param withEvent
  120701. * Used internally, whether to fire the series `addPoint` event.
  120702. *
  120703. * @fires Highcharts.Series#addPoint
  120704. */
  120705. addPoint(options: PointOptionsType, redraw?: boolean, shift?: boolean, animation?: (boolean|Partial<AnimationOptionsObject>), withEvent?: boolean): void;
  120706. /**
  120707. * Animate in the series. Called internally twice. First with the `init`
  120708. * parameter set to true, which sets up the initial state of the animation.
  120709. * Then when ready, it is called with the `init` parameter undefined, in
  120710. * order to perform the actual animation. After the second run, the function
  120711. * is removed.
  120712. *
  120713. * @param init
  120714. * Initialize the animation.
  120715. */
  120716. animate(init?: boolean): void;
  120717. /**
  120718. * Draw the graph. Called internally when rendering line-like series types.
  120719. * The first time it generates the `series.graph` item and optionally other
  120720. * series-wide items like `series.area` for area charts. On subsequent calls
  120721. * these items are updated with new positions and attributes.
  120722. */
  120723. drawGraph(): void;
  120724. /**
  120725. * Draw the markers for line-like series types, and columns or other
  120726. * graphical representation for Point objects for other series types. The
  120727. * resulting element is typically stored as Point.graphic, and is created on
  120728. * the first call and updated and moved on subsequent calls.
  120729. */
  120730. drawPoints(): void;
  120731. /**
  120732. * Return series name in "Series {Number}" format or the one defined by a
  120733. * user. This method can be simply overridden as series name format can vary
  120734. * (e.g. technical indicators).
  120735. *
  120736. * @return The series name.
  120737. */
  120738. getName(): string;
  120739. /**
  120740. * Get the translation and scale for the plot area of this series.
  120741. */
  120742. getPlotBox(): SeriesPlotBoxObject;
  120743. /**
  120744. * Return the series points with null points filtered out.
  120745. *
  120746. * @param points
  120747. * The points to inspect, defaults to Series.points.
  120748. *
  120749. * @param insideOnly
  120750. * Whether to inspect only the points that are inside the visible
  120751. * view.
  120752. *
  120753. * @param allowNull
  120754. * Whether to allow null points to pass as valid points.
  120755. *
  120756. * @return The valid points.
  120757. */
  120758. getValidPoints(points?: Array<Point>, insideOnly?: boolean, allowNull?: boolean): Array<Point>;
  120759. /**
  120760. * Hide the series if visible. If the chart.ignoreHiddenSeries option is
  120761. * true, the chart is redrawn without this series.
  120762. *
  120763. * @fires Highcharts.Series#hide
  120764. */
  120765. hide(): void;
  120766. /**
  120767. * Check whether the series item is itself or inherits from a certain series
  120768. * type.
  120769. *
  120770. * @param type
  120771. * The type of series to check for, can be either featured or custom
  120772. * series types. For example `column`, `pie`, `ohlc` etc.
  120773. *
  120774. * @return True if this item is or inherits from the given type.
  120775. */
  120776. is(type: string): boolean;
  120777. /**
  120778. * Get non-presentational attributes for a point. Used internally for both
  120779. * styled mode and classic. Can be overridden for different series types.
  120780. *
  120781. * @param point
  120782. * The Point to inspect.
  120783. *
  120784. * @param state
  120785. * The state, can be either `hover`, `select` or undefined.
  120786. *
  120787. * @return A hash containing those attributes that are not settable from
  120788. * CSS.
  120789. */
  120790. markerAttribs(point: Point, state?: string): SVGAttributes;
  120791. /**
  120792. * Runs on mouse out of the series graphical items.
  120793. *
  120794. * @fires Highcharts.Series#mouseOut
  120795. */
  120796. onMouseOut(): void;
  120797. /**
  120798. * Runs on mouse over the series graphical items.
  120799. *
  120800. * @fires Highcharts.Series#mouseOver
  120801. */
  120802. onMouseOver(): void;
  120803. /**
  120804. * Remove a series and optionally redraw the chart.
  120805. *
  120806. * @param redraw
  120807. * Whether to redraw the chart or wait for an explicit call to
  120808. * Highcharts.Chart#redraw.
  120809. *
  120810. * @param animation
  120811. * Whether to apply animation, and optionally animation
  120812. * configuration.
  120813. *
  120814. * @param withEvent
  120815. * Used internally, whether to fire the series `remove` event.
  120816. *
  120817. * @fires Highcharts.Series#remove
  120818. */
  120819. remove(redraw?: boolean, animation?: (boolean|Partial<AnimationOptionsObject>), withEvent?: boolean): void;
  120820. /**
  120821. * Remove a point from the series. Unlike the Highcharts.Point#remove
  120822. * method, this can also be done on a point that is not instanciated because
  120823. * it is outside the view or subject to Highstock data grouping.
  120824. *
  120825. * @param i
  120826. * The index of the point in the data array.
  120827. *
  120828. * @param redraw
  120829. * Whether to redraw the chart after the point is added. When
  120830. * removing more than one point, it is highly recommended that the
  120831. * `redraw` option be set to `false`, and instead
  120832. * Highcharts.Chart#redraw is explicitly called after the adding of
  120833. * points is finished.
  120834. *
  120835. * @param animation
  120836. * Whether and optionally how the series should be animated.
  120837. *
  120838. * @fires Highcharts.Point#remove
  120839. */
  120840. removePoint(i: number, redraw?: boolean, animation?: (boolean|Partial<AnimationOptionsObject>)): void;
  120841. /**
  120842. * Render the graph and markers. Called internally when first rendering and
  120843. * later when redrawing the chart. This function can be extended in plugins,
  120844. * but normally shouldn't be called directly.
  120845. *
  120846. * @fires Highcharts.Series#afterRender
  120847. */
  120848. render(): void;
  120849. /**
  120850. * Select or unselect the series. This means its selected property is set,
  120851. * the checkbox in the legend is toggled and when selected, the series is
  120852. * returned by the Highcharts.Chart#getSelectedSeries function.
  120853. *
  120854. * @param selected
  120855. * True to select the series, false to unselect. If undefined, the
  120856. * selection state is toggled.
  120857. *
  120858. * @fires Highcharts.Series#select
  120859. * @fires Highcharts.Series#unselect
  120860. */
  120861. select(selected?: boolean): void;
  120862. /**
  120863. * Apply a new set of data to the series and optionally redraw it. The new
  120864. * data array is passed by reference (except in case of `updatePoints`), and
  120865. * may later be mutated when updating the chart data.
  120866. *
  120867. * Note the difference in behaviour when setting the same amount of points,
  120868. * or a different amount of points, as handled by the `updatePoints`
  120869. * parameter.
  120870. *
  120871. * @param data
  120872. * Takes an array of data in the same format as described under
  120873. * `series.{type}.data` for the given series type, for example a line
  120874. * series would take data in the form described under
  120875. * series.line.data.
  120876. *
  120877. * @param redraw
  120878. * Whether to redraw the chart after the series is altered. If doing
  120879. * more operations on the chart, it is a good idea to set redraw to
  120880. * false and call Chart#redraw after.
  120881. *
  120882. * @param animation
  120883. * When the updated data is the same length as the existing data,
  120884. * points will be updated by default, and animation visualizes how
  120885. * the points are changed. Set false to disable animation, or a
  120886. * configuration object to set duration or easing.
  120887. *
  120888. * @param updatePoints
  120889. * When this is true, points will be updated instead of replaced
  120890. * whenever possible. This occurs a) when the updated data is the
  120891. * same length as the existing data, b) when points are matched by
  120892. * their id's, or c) when points can be matched by X values. This
  120893. * allows updating with animation and performs better. In this case,
  120894. * the original array is not passed by reference. Set `false` to
  120895. * prevent.
  120896. */
  120897. setData(data: Array<PointOptionsType>, redraw?: boolean, animation?: (boolean|Partial<AnimationOptionsObject>), updatePoints?: boolean): void;
  120898. /**
  120899. * Set the state of the series. Called internally on mouse interaction
  120900. * operations, but it can also be called directly to visually highlight a
  120901. * series.
  120902. *
  120903. * @param state
  120904. * The new state, can be either `'hover'`, `'inactive'`, `'select'`,
  120905. * or `''` (an empty string), `'normal'` or `undefined` to set to
  120906. * normal state.
  120907. *
  120908. * @param inherit
  120909. * Determines if state should be inherited by points too.
  120910. */
  120911. setState(state?: (""|SeriesStateValue), inherit?: boolean): void;
  120912. /**
  120913. * Show or hide the series.
  120914. *
  120915. * @param visible
  120916. * True to show the series, false to hide. If undefined, the
  120917. * visibility is toggled.
  120918. *
  120919. * @param redraw
  120920. * Whether to redraw the chart after the series is altered. If doing
  120921. * more operations on the chart, it is a good idea to set redraw to
  120922. * false and call chart.redraw() after.
  120923. *
  120924. * @fires Highcharts.Series#hide
  120925. * @fires Highcharts.Series#show
  120926. */
  120927. setVisible(visible?: boolean, redraw?: boolean): void;
  120928. /**
  120929. * Show the series if hidden.
  120930. *
  120931. * @fires Highcharts.Series#show
  120932. */
  120933. show(): void;
  120934. /**
  120935. * Translate data points from raw data values to chart specific positioning
  120936. * data needed later in the `drawPoints` and `drawGraph` functions. This
  120937. * function can be overridden in plugins and custom series type
  120938. * implementations.
  120939. *
  120940. * @fires Highcharts.Series#events:translate
  120941. */
  120942. translate(): void;
  120943. /**
  120944. * Update the series with a new set of options. For a clean and precise
  120945. * handling of new options, all methods and elements from the series are
  120946. * removed, and it is initialized from scratch. Therefore, this method is
  120947. * more performance expensive than some other utility methods like
  120948. * Series#setData or Series#setVisible.
  120949. *
  120950. * Note that `Series.update` may mutate the passed `data` options.
  120951. *
  120952. * @param options
  120953. * New options that will be merged with the series' existing options.
  120954. *
  120955. * @param redraw
  120956. * Whether to redraw the chart after the series is altered. If doing
  120957. * more operations on the chart, it is a good idea to set redraw to
  120958. * false and call Chart#redraw after.
  120959. *
  120960. * @fires Highcharts.Series#update
  120961. * @fires Highcharts.Series#afterUpdate
  120962. */
  120963. update(options: SeriesOptionsType, redraw?: boolean): void;
  120964. }
  120965. /**
  120966. * The SVGElement prototype is a JavaScript wrapper for SVG elements used in the
  120967. * rendering layer of Highcharts. Combined with the Highcharts.SVGRenderer
  120968. * object, these prototypes allow freeform annotation in the charts or even in
  120969. * HTML pages without instanciating a chart. The SVGElement can also wrap HTML
  120970. * labels, when `text` or `label` elements are created with the `useHTML`
  120971. * parameter.
  120972. *
  120973. * The SVGElement instances are created through factory functions on the
  120974. * Highcharts.SVGRenderer object, like rect, path, text, label, g and more.
  120975. */
  120976. export class SVGElement {
  120977. /**
  120978. * The primary DOM node. Each `SVGElement` instance wraps a main DOM node,
  120979. * but may also represent more nodes.
  120980. */
  120981. element: (HTMLDOMElement|SVGDOMElement);
  120982. /**
  120983. * The renderer that the SVGElement belongs to.
  120984. */
  120985. renderer: SVGRenderer;
  120986. /**
  120987. * Add the element to the DOM. All elements must be added this way.
  120988. *
  120989. * @param parent
  120990. * The parent item to add it to. If undefined, the element is added
  120991. * to the Highcharts.SVGRenderer.box.
  120992. *
  120993. * @return Returns the SVGElement for chaining.
  120994. */
  120995. add(parent?: SVGElement): SVGElement;
  120996. /**
  120997. * Add a class name to an element.
  120998. *
  120999. * @param className
  121000. * The new class name to add.
  121001. *
  121002. * @param replace
  121003. * When true, the existing class name(s) will be overwritten with the
  121004. * new one. When false, the new one is added.
  121005. *
  121006. * @return Return the SVG element for chainability.
  121007. */
  121008. addClass(className: string, replace?: boolean): SVGElement;
  121009. /**
  121010. * Align the element relative to the chart or another box.
  121011. *
  121012. * @param alignOptions
  121013. * The alignment options. The function can be called without this
  121014. * parameter in order to re-align an element after the box has been
  121015. * updated.
  121016. *
  121017. * @param alignByTranslate
  121018. * Align element by translation.
  121019. *
  121020. * @param box
  121021. * The box to align to, needs a width and height. When the box is a
  121022. * string, it refers to an object in the Renderer. For example, when
  121023. * box is `spacingBox`, it refers to `Renderer.spacingBox` which
  121024. * holds `width`, `height`, `x` and `y` properties.
  121025. *
  121026. * @return Returns the SVGElement for chaining.
  121027. */
  121028. align(alignOptions?: AlignObject, alignByTranslate?: boolean, box?: (string|BBoxObject)): SVGElement;
  121029. /**
  121030. * Animate to given attributes or CSS properties.
  121031. *
  121032. * @param params
  121033. * SVG attributes or CSS to animate.
  121034. *
  121035. * @param options
  121036. * Animation options.
  121037. *
  121038. * @param complete
  121039. * Function to perform at the end of animation.
  121040. *
  121041. * @return Returns the SVGElement for chaining.
  121042. */
  121043. animate(params: SVGAttributes, options?: (boolean|Partial<AnimationOptionsObject>), complete?: Function): SVGElement;
  121044. attr(key: string): (number|string);
  121045. /**
  121046. * Apply native and custom attributes to the SVG elements.
  121047. *
  121048. * In order to set the rotation center for rotation, set x and y to 0 and
  121049. * use `translateX` and `translateY` attributes to position the element
  121050. * instead.
  121051. *
  121052. * Attributes frequently used in Highcharts are `fill`, `stroke`,
  121053. * `stroke-width`.
  121054. *
  121055. * @param hash
  121056. * The native and custom SVG attributes.
  121057. *
  121058. * @param val
  121059. * If the type of the first argument is `string`, the second can be a
  121060. * value, which will serve as a single attribute setter. If the first
  121061. * argument is a string and the second is undefined, the function
  121062. * serves as a getter and the current value of the property is
  121063. * returned.
  121064. *
  121065. * @param complete
  121066. * A callback function to execute after setting the attributes. This
  121067. * makes the function compliant and interchangeable with the
  121068. * SVGElement#animate function.
  121069. *
  121070. * @param continueAnimation
  121071. * Used internally when `.attr` is called as part of an animation
  121072. * step. Otherwise, calling `.attr` for an attribute will stop
  121073. * animation for that attribute.
  121074. *
  121075. * @return If used as a setter, it returns the current Highcharts.SVGElement
  121076. * so the calls can be chained. If used as a getter, the current
  121077. * value of the attribute is returned.
  121078. */
  121079. attr(hash?: (string|SVGAttributes), val?: (number|string|SVGPathArray), complete?: Function, continueAnimation?: boolean): SVGElement;
  121080. /**
  121081. * Apply a clipping rectangle to this element.
  121082. *
  121083. * @param clipRect
  121084. * The clipping rectangle. If skipped, the current clip is removed.
  121085. *
  121086. * @return Returns the SVG element to allow chaining.
  121087. */
  121088. clip(clipRect?: ClipRectElement): SVGElement;
  121089. /**
  121090. * Calculate the coordinates needed for drawing a rectangle crisply and
  121091. * return the calculated attributes.
  121092. *
  121093. * @param rect
  121094. * Rectangle to crisp.
  121095. *
  121096. * @param strokeWidth
  121097. * The stroke width to consider when computing crisp positioning. It
  121098. * can also be set directly on the rect parameter.
  121099. *
  121100. * @return The modified rectangle arguments.
  121101. */
  121102. crisp(rect: RectangleObject, strokeWidth?: number): RectangleObject;
  121103. /**
  121104. * Set styles for the element. In addition to CSS styles supported by native
  121105. * SVG and HTML elements, there are also some custom made for Highcharts,
  121106. * like `width`, `ellipsis` and `textOverflow` for SVG text elements.
  121107. *
  121108. * @param styles
  121109. * The new CSS styles.
  121110. *
  121111. * @return Return the SVG element for chaining.
  121112. */
  121113. css(styles: CSSObject): SVGElement;
  121114. /**
  121115. * Destroy the element and element wrapper and clear up the DOM and event
  121116. * hooks.
  121117. */
  121118. destroy(): void;
  121119. /**
  121120. * Fade out an element by animating its opacity down to 0, and hide it on
  121121. * complete. Used internally for the tooltip.
  121122. *
  121123. * @param duration
  121124. * The fade duration in milliseconds.
  121125. */
  121126. fadeOut(duration?: number): void;
  121127. /**
  121128. * Get the bounding box (width, height, x and y) for the element. Generally
  121129. * used to get rendered text size. Since this is called a lot in charts, the
  121130. * results are cached based on text properties, in order to save DOM
  121131. * traffic. The returned bounding box includes the rotation, so for example
  121132. * a single text line of rotation 90 will report a greater height, and a
  121133. * width corresponding to the line-height.
  121134. *
  121135. * @param reload
  121136. * Skip the cache and get the updated DOM bouding box.
  121137. *
  121138. * @param rot
  121139. * Override the element's rotation. This is internally used on axis
  121140. * labels with a value of 0 to find out what the bounding box would
  121141. * be have been if it were not rotated.
  121142. *
  121143. * @return The bounding box with `x`, `y`, `width` and `height` properties.
  121144. */
  121145. getBBox(reload?: boolean, rot?: number): BBoxObject;
  121146. /**
  121147. * Get the computed style. Only in styled mode.
  121148. *
  121149. * @param prop
  121150. * The property name to check for.
  121151. *
  121152. * @return The current computed value.
  121153. */
  121154. getStyle(prop: string): string;
  121155. /**
  121156. * Check if an element has the given class name.
  121157. *
  121158. * @param className
  121159. * The class name to check for.
  121160. *
  121161. * @return Whether the class name is found.
  121162. */
  121163. hasClass(className: string): boolean;
  121164. /**
  121165. * Hide the element, similar to setting the `visibility` attribute to
  121166. * `hidden`.
  121167. *
  121168. * @param hideByTranslation
  121169. * The flag to determine if element should be hidden by moving out of
  121170. * the viewport. Used for example for dataLabels.
  121171. *
  121172. * @return Returns the SVGElement for chaining.
  121173. */
  121174. hide(hideByTranslation?: boolean): SVGElement;
  121175. /**
  121176. * Initialize the SVG element. This function only exists to make the
  121177. * initialization process overridable. It should not be called directly.
  121178. *
  121179. * @param renderer
  121180. * The SVGRenderer instance to initialize to.
  121181. *
  121182. * @param nodeName
  121183. * The SVG node name.
  121184. */
  121185. init(renderer: SVGRenderer, nodeName: string): void;
  121186. /**
  121187. * Invert a group, rotate and flip. This is used internally on inverted
  121188. * charts, where the points and graphs are drawn as if not inverted, then
  121189. * the series group elements are inverted.
  121190. *
  121191. * @param inverted
  121192. * Whether to invert or not. An inverted shape can be un-inverted by
  121193. * setting it to false.
  121194. *
  121195. * @return Return the SVGElement for chaining.
  121196. */
  121197. invert(inverted: boolean): SVGElement;
  121198. /**
  121199. * Add an event listener. This is a simple setter that replaces all other
  121200. * events of the same type, opposed to the Highcharts#addEvent function.
  121201. *
  121202. * @param eventType
  121203. * The event type. If the type is `click`, Highcharts will internally
  121204. * translate it to a `touchstart` event on touch devices, to prevent
  121205. * the browser from waiting for a click event from firing.
  121206. *
  121207. * @param handler
  121208. * The handler callback.
  121209. *
  121210. * @return The SVGElement for chaining.
  121211. */
  121212. on(eventType: string, handler: Function): SVGElement;
  121213. /**
  121214. * Remove a class name from the element.
  121215. *
  121216. * @param className
  121217. * The class name to remove.
  121218. *
  121219. * @return Returns the SVG element for chainability.
  121220. */
  121221. removeClass(className: (string|RegExp)): SVGElement;
  121222. /**
  121223. * Set the coordinates needed to draw a consistent radial gradient across a
  121224. * shape regardless of positioning inside the chart. Used on pie slices to
  121225. * make all the slices have the same radial reference point.
  121226. *
  121227. * @param coordinates
  121228. * The center reference. The format is `[centerX, centerY, diameter]`
  121229. * in pixels.
  121230. *
  121231. * @return Returns the SVGElement for chaining.
  121232. */
  121233. setRadialReference(coordinates: Array<number>): SVGElement;
  121234. /**
  121235. * Add a shadow to the element. Must be called after the element is added to
  121236. * the DOM. In styled mode, this method is not used, instead use `defs` and
  121237. * filters.
  121238. *
  121239. * @param shadowOptions
  121240. * The shadow options. If `true`, the default options are applied. If
  121241. * `false`, the current shadow will be removed.
  121242. *
  121243. * @param group
  121244. * The SVG group element where the shadows will be applied. The
  121245. * default is to add it to the same parent as the current element.
  121246. * Internally, this is ised for pie slices, where all the shadows are
  121247. * added to an element behind all the slices.
  121248. *
  121249. * @param cutOff
  121250. * Used internally for column shadows.
  121251. *
  121252. * @return Returns the SVGElement for chaining.
  121253. */
  121254. shadow(shadowOptions?: (boolean|ShadowOptionsObject), group?: SVGElement, cutOff?: boolean): SVGElement;
  121255. /**
  121256. * Show the element after it has been hidden.
  121257. *
  121258. * @param inherit
  121259. * Set the visibility attribute to `inherit` rather than `visible`.
  121260. * The difference is that an element with `visibility="visible"` will
  121261. * be visible even if the parent is hidden.
  121262. *
  121263. * @return Returns the SVGElement for chaining.
  121264. */
  121265. show(inherit?: boolean): SVGElement;
  121266. /**
  121267. * Get the computed stroke width in pixel values. This is used extensively
  121268. * when drawing shapes to ensure the shapes are rendered crisp and
  121269. * positioned correctly relative to each other. Using `shape-rendering:
  121270. * crispEdges` leaves us less control over positioning, for example when we
  121271. * want to stack columns next to each other, or position things
  121272. * pixel-perfectly within the plot box.
  121273. *
  121274. * The common pattern when placing a shape is:
  121275. *
  121276. * - Create the SVGElement and add it to the DOM. In styled mode, it will
  121277. * now receive a stroke width from the style sheet. In classic mode we will
  121278. * add the `stroke-width` attribute.
  121279. *
  121280. * - Read the computed `elem.strokeWidth()`.
  121281. *
  121282. * - Place it based on the stroke width.
  121283. *
  121284. * @return The stroke width in pixels. Even if the given stroke widtch (in
  121285. * CSS or by attributes) is based on `em` or other units, the pixel
  121286. * size is returned.
  121287. */
  121288. strokeWidth(): number;
  121289. /**
  121290. * Bring the element to the front. Alternatively, a new zIndex can be set.
  121291. *
  121292. * @return Returns the SVGElement for chaining.
  121293. */
  121294. toFront(): SVGElement;
  121295. /**
  121296. * Move an object and its children by x and y values.
  121297. *
  121298. * @param x
  121299. * The x value.
  121300. *
  121301. * @param y
  121302. * The y value.
  121303. */
  121304. translate(x: number, y: number): SVGElement;
  121305. }
  121306. /**
  121307. * Allows direct access to the Highcharts rendering layer in order to draw
  121308. * primitive shapes like circles, rectangles, paths or text directly on a chart,
  121309. * or independent from any chart. The SVGRenderer represents a wrapper object
  121310. * for SVG in modern browsers. Through the VMLRenderer, part of the `oldie.js`
  121311. * module, it also brings vector graphics to IE <= 8.
  121312. *
  121313. * An existing chart's renderer can be accessed through Chart.renderer. The
  121314. * renderer can also be used completely decoupled from a chart.
  121315. */
  121316. export class SVGRenderer {
  121317. /**
  121318. * Allows direct access to the Highcharts rendering layer in order to draw
  121319. * primitive shapes like circles, rectangles, paths or text directly on a
  121320. * chart, or independent from any chart. The SVGRenderer represents a
  121321. * wrapper object for SVG in modern browsers. Through the VMLRenderer, part
  121322. * of the `oldie.js` module, it also brings vector graphics to IE <= 8.
  121323. *
  121324. * An existing chart's renderer can be accessed through Chart.renderer. The
  121325. * renderer can also be used completely decoupled from a chart.
  121326. *
  121327. * @param container
  121328. * Where to put the SVG in the web page.
  121329. *
  121330. * @param width
  121331. * The width of the SVG.
  121332. *
  121333. * @param height
  121334. * The height of the SVG.
  121335. *
  121336. * @param style
  121337. * The box style, if not in styleMode
  121338. *
  121339. * @param forExport
  121340. * Whether the rendered content is intended for export.
  121341. *
  121342. * @param allowHTML
  121343. * Whether the renderer is allowed to include HTML text, which will
  121344. * be projected on top of the SVG.
  121345. *
  121346. * @param styledMode
  121347. * Whether the renderer belongs to a chart that is in styled mode. If
  121348. * it does, it will avoid setting presentational attributes in some
  121349. * cases, but not when set explicitly through `.attr` and `.css` etc.
  121350. */
  121351. constructor(container: HTMLDOMElement, width: number, height: number, style?: CSSObject, forExport?: boolean, allowHTML?: boolean, styledMode?: boolean);
  121352. /**
  121353. * The root `svg` node of the renderer.
  121354. */
  121355. box: SVGDOMElement;
  121356. /**
  121357. * The wrapper for the root `svg` node of the renderer.
  121358. */
  121359. boxWrapper: SVGElement;
  121360. /**
  121361. * A pointer to the `defs` node of the root SVG.
  121362. */
  121363. defs: SVGElement;
  121364. /**
  121365. * A pointer to the renderer's associated Element class. The VMLRenderer
  121366. * will have a pointer to VMLElement here.
  121367. */
  121368. Element: SVGElement;
  121369. /**
  121370. * A collection of characters mapped to HTML entities. When `useHTML` on an
  121371. * element is true, these entities will be rendered correctly by HTML. In
  121372. * the SVG pseudo-HTML, they need to be unescaped back to simple characters,
  121373. * so for example `&lt;` will render as `<`.
  121374. */
  121375. escapes: Dictionary<string>;
  121376. /**
  121377. * An extendable collection of functions for defining symbol paths.
  121378. */
  121379. symbols: SymbolDictionary;
  121380. /**
  121381. * Draw and return an arc. Overloaded function that takes arguments object.
  121382. *
  121383. * @param attribs
  121384. * Initial SVG attributes.
  121385. *
  121386. * @return The generated wrapper element.
  121387. */
  121388. arc(attribs: SVGAttributes): SVGElement;
  121389. /**
  121390. * Draw and return an arc.
  121391. *
  121392. * @param x
  121393. * Center X position.
  121394. *
  121395. * @param y
  121396. * Center Y position.
  121397. *
  121398. * @param r
  121399. * The outer radius' of the arc.
  121400. *
  121401. * @param innerR
  121402. * Inner radius like used in donut charts.
  121403. *
  121404. * @param start
  121405. * The starting angle of the arc in radians, where 0 is to the right
  121406. * and `-Math.PI/2` is up.
  121407. *
  121408. * @param end
  121409. * The ending angle of the arc in radians, where 0 is to the right
  121410. * and `-Math.PI/2` is up.
  121411. *
  121412. * @return The generated wrapper element.
  121413. */
  121414. arc(x?: number, y?: number, r?: number, innerR?: number, start?: number, end?: number): SVGElement;
  121415. /**
  121416. * Create a button with preset states.
  121417. *
  121418. * @param text
  121419. * The text or HTML to draw.
  121420. *
  121421. * @param x
  121422. * The x position of the button's left side.
  121423. *
  121424. * @param y
  121425. * The y position of the button's top side.
  121426. *
  121427. * @param callback
  121428. * The function to execute on button click or touch.
  121429. *
  121430. * @param theme
  121431. * SVG attributes for the normal state.
  121432. *
  121433. * @param hoverState
  121434. * SVG attributes for the hover state.
  121435. *
  121436. * @param pressedState
  121437. * SVG attributes for the pressed state.
  121438. *
  121439. * @param disabledState
  121440. * SVG attributes for the disabled state.
  121441. *
  121442. * @param shape
  121443. * The shape type.
  121444. *
  121445. * @param useHTML
  121446. * Wether to use HTML to render the label.
  121447. *
  121448. * @return The button element.
  121449. */
  121450. button(text: string, x: number, y: number, callback: EventCallbackFunction<SVGElement>, theme?: SVGAttributes, hoverState?: SVGAttributes, pressedState?: SVGAttributes,
  121451. disabledState?: SVGAttributes, shape?: SymbolKeyValue, useHTML?: boolean): SVGElement;
  121452. /**
  121453. * Draw a circle, wraps the SVG `circle` element.
  121454. *
  121455. * @param attribs
  121456. * The initial attributes.
  121457. *
  121458. * @return The generated wrapper element.
  121459. */
  121460. circle(attribs?: SVGAttributes): SVGElement;
  121461. /**
  121462. * Draw a circle, wraps the SVG `circle` element.
  121463. *
  121464. * @param x
  121465. * The center x position.
  121466. *
  121467. * @param y
  121468. * The center y position.
  121469. *
  121470. * @param r
  121471. * The radius.
  121472. *
  121473. * @return The generated wrapper element.
  121474. */
  121475. circle(x?: number, y?: number, r?: number): SVGElement;
  121476. /**
  121477. * Define a clipping rectangle. The clipping rectangle is later applied to
  121478. * SVGElement objects through the SVGElement#clip function.
  121479. *
  121480. * @return A clipping rectangle.
  121481. */
  121482. clipRect(x?: number, y?: number, width?: number, height?: number): ClipRectElement;
  121483. /**
  121484. * Create a wrapper for an SVG element. Serves as a factory for SVGElement,
  121485. * but this function is itself mostly called from primitive factories like
  121486. * SVGRenderer#path, SVGRenderer#rect or SVGRenderer#text.
  121487. *
  121488. * @param nodeName
  121489. * The node name, for example `rect`, `g` etc.
  121490. *
  121491. * @return The generated SVGElement.
  121492. */
  121493. createElement(nodeName: string): SVGElement;
  121494. /**
  121495. * Make a straight line crisper by not spilling out to neighbour pixels.
  121496. *
  121497. * @param points
  121498. * The original points on the format `[['M', 0, 0], ['L', 100, 0]]`.
  121499. *
  121500. * @param width
  121501. * The width of the line.
  121502. *
  121503. * @param roundingFunction
  121504. * The rounding function name on the `Math` object, can be one of
  121505. * `round`, `floor` or `ceil`.
  121506. *
  121507. * @return The original points array, but modified to render crisply.
  121508. */
  121509. crispLine(points: SVGPathArray, width: number, roundingFunction: string): SVGPathArray;
  121510. /**
  121511. * General method for adding a definition to the SVG `defs` tag. Can be used
  121512. * for gradients, fills, filters etc. Styled mode only. A hook for adding
  121513. * general definitions to the SVG's defs tag. Definitions can be referenced
  121514. * from the CSS by its `id`. Read more in gradients, shadows and patterns.
  121515. * Styled mode only.
  121516. *
  121517. * @param def
  121518. * A serialized form of an SVG definition, including children.
  121519. *
  121520. * @return The inserted node.
  121521. */
  121522. definition(def: ASTNode): SVGElement;
  121523. /**
  121524. * Destroys the renderer and its allocated members.
  121525. */
  121526. destroy(): null;
  121527. /**
  121528. * Dummy function for plugins, called every time the renderer is updated.
  121529. * Prior to Highcharts 5, this was used for the canvg renderer.
  121530. */
  121531. draw(): void;
  121532. /**
  121533. * Utility to return the baseline offset and total line height from the font
  121534. * size.
  121535. *
  121536. * @param fontSize
  121537. * The current font size to inspect. If not given, the font size will
  121538. * be found from the DOM element.
  121539. *
  121540. * @param elem
  121541. * The element to inspect for a current font size.
  121542. *
  121543. * @return The font metrics.
  121544. */
  121545. fontMetrics(fontSize?: (number|string), elem?: (SVGDOMElement|SVGElement)): FontMetricsObject;
  121546. /**
  121547. * Create and return an svg group element. Child Highcharts.SVGElement
  121548. * objects are added to the group by using the group as the first parameter
  121549. * in add().
  121550. *
  121551. * @param name
  121552. * The group will be given a class name of `highcharts-{name}`. This
  121553. * can be used for styling and scripting.
  121554. *
  121555. * @return The generated wrapper element.
  121556. */
  121557. g(name?: string): SVGElement;
  121558. /**
  121559. * Returns white for dark colors and black for bright colors.
  121560. *
  121561. * @param rgba
  121562. * The color to get the contrast for.
  121563. *
  121564. * @return The contrast color, either `#000000` or `#FFFFFF`.
  121565. */
  121566. getContrast(rgba: ColorString): ColorString;
  121567. /**
  121568. * Display an image.
  121569. *
  121570. * @param src
  121571. * The image source.
  121572. *
  121573. * @param x
  121574. * The X position.
  121575. *
  121576. * @param y
  121577. * The Y position.
  121578. *
  121579. * @param width
  121580. * The image width. If omitted, it defaults to the image file width.
  121581. *
  121582. * @param height
  121583. * The image height. If omitted it defaults to the image file height.
  121584. *
  121585. * @param onload
  121586. * Event handler for image load.
  121587. *
  121588. * @return The generated wrapper element.
  121589. */
  121590. image(src: string, x?: number, y?: number, width?: number, height?: number, onload?: Function): SVGElement;
  121591. /**
  121592. * Initialize the SVGRenderer. Overridable initializer function that takes
  121593. * the same parameters as the constructor.
  121594. *
  121595. * @param container
  121596. * Where to put the SVG in the web page.
  121597. *
  121598. * @param width
  121599. * The width of the SVG.
  121600. *
  121601. * @param height
  121602. * The height of the SVG.
  121603. *
  121604. * @param style
  121605. * The box style, if not in styleMode
  121606. *
  121607. * @param forExport
  121608. * Whether the rendered content is intended for export.
  121609. *
  121610. * @param allowHTML
  121611. * Whether the renderer is allowed to include HTML text, which will
  121612. * be projected on top of the SVG.
  121613. *
  121614. * @param styledMode
  121615. * Whether the renderer belongs to a chart that is in styled mode. If
  121616. * it does, it will avoid setting presentational attributes in some
  121617. * cases, but not when set explicitly through `.attr` and `.css` etc.
  121618. */
  121619. init(container: HTMLDOMElement, width: number, height: number, style?: CSSObject, forExport?: boolean, allowHTML?: boolean, styledMode?: boolean): void;
  121620. /**
  121621. * Detect whether the renderer is hidden. This happens when one of the
  121622. * parent elements has `display: none`. Used internally to detect when we
  121623. * needto render preliminarily in another div to get the text bounding boxes
  121624. * right.
  121625. *
  121626. * @return True if it is hidden.
  121627. */
  121628. isHidden(): boolean;
  121629. /**
  121630. * Draw a label, which is an extended text element with support for border
  121631. * and background. Highcharts creates a `g` element with a text and a `path`
  121632. * or `rect` inside, to make it behave somewhat like a HTML div. Border and
  121633. * background are set through `stroke`, `stroke-width` and `fill` attributes
  121634. * using the attr method. To update the text after render, run `label.attr({
  121635. * text: 'New text' })`.
  121636. *
  121637. * @param str
  121638. * The initial text string or (subset) HTML to render.
  121639. *
  121640. * @param x
  121641. * The x position of the label's left side.
  121642. *
  121643. * @param y
  121644. * The y position of the label's top side or baseline, depending on
  121645. * the `baseline` parameter.
  121646. *
  121647. * @param shape
  121648. * The shape of the label's border/background, if any. Defaults to
  121649. * `rect`. Other possible values are `callout` or other shapes
  121650. * defined in Highcharts.SVGRenderer#symbols.
  121651. *
  121652. * @param anchorX
  121653. * In case the `shape` has a pointer, like a flag, this is the
  121654. * coordinates it should be pinned to.
  121655. *
  121656. * @param anchorY
  121657. * In case the `shape` has a pointer, like a flag, this is the
  121658. * coordinates it should be pinned to.
  121659. *
  121660. * @param useHTML
  121661. * Wether to use HTML to render the label.
  121662. *
  121663. * @param baseline
  121664. * Whether to position the label relative to the text baseline, like
  121665. * renderer.text, or to the upper border of the rectangle.
  121666. *
  121667. * @param className
  121668. * Class name for the group.
  121669. *
  121670. * @return The generated label.
  121671. */
  121672. label(str: string, x: number, y?: number, shape?: string, anchorX?: number, anchorY?: number, useHTML?: boolean, baseline?: boolean, className?: string): SVGElement;
  121673. /**
  121674. * Draw a path, wraps the SVG `path` element.
  121675. *
  121676. * @param path
  121677. * An SVG path definition in array form.
  121678. *
  121679. * @return The generated wrapper element.
  121680. */
  121681. path(path?: SVGPathArray): SVGElement;
  121682. /**
  121683. * Draw a path, wraps the SVG `path` element.
  121684. *
  121685. * @param attribs
  121686. * The initial attributes.
  121687. *
  121688. * @return The generated wrapper element.
  121689. */
  121690. path(attribs?: SVGAttributes): SVGElement;
  121691. /**
  121692. * Draw and return a rectangle.
  121693. *
  121694. * @param attributes
  121695. * General SVG attributes for the rectangle.
  121696. *
  121697. * @return The generated wrapper element.
  121698. */
  121699. rect(attributes?: SVGAttributes): SVGElement;
  121700. /**
  121701. * Draw and return a rectangle.
  121702. *
  121703. * @param x
  121704. * Left position.
  121705. *
  121706. * @param y
  121707. * Top position.
  121708. *
  121709. * @param width
  121710. * Width of the rectangle.
  121711. *
  121712. * @param height
  121713. * Height of the rectangle.
  121714. *
  121715. * @param r
  121716. * Border corner radius.
  121717. *
  121718. * @param strokeWidth
  121719. * A stroke width can be supplied to allow crisp drawing.
  121720. *
  121721. * @return The generated wrapper element.
  121722. */
  121723. rect(x?: number, y?: number, width?: number, height?: number, r?: number, strokeWidth?: number): SVGElement;
  121724. /**
  121725. * Resize the SVGRenderer#box and re-align all aligned child elements.
  121726. *
  121727. * @param width
  121728. * The new pixel width.
  121729. *
  121730. * @param height
  121731. * The new pixel height.
  121732. *
  121733. * @param animate
  121734. * Whether and how to animate.
  121735. */
  121736. setSize(width: number, height: number, animate?: (boolean|Partial<AnimationOptionsObject>)): void;
  121737. /**
  121738. * Apply the global style on the renderer, mixed with the default styles.
  121739. *
  121740. * @param style
  121741. * CSS to apply.
  121742. */
  121743. setStyle(style: CSSObject): void;
  121744. /**
  121745. * Draw a symbol out of pre-defined shape paths from SVGRenderer#symbols. It
  121746. * is used in Highcharts for point makers, which cake a `symbol` option, and
  121747. * label and button backgrounds like in the tooltip and stock flags.
  121748. *
  121749. * @param symbol
  121750. * The symbol name.
  121751. *
  121752. * @param x
  121753. * The X coordinate for the top left position.
  121754. *
  121755. * @param y
  121756. * The Y coordinate for the top left position.
  121757. *
  121758. * @param width
  121759. * The pixel width.
  121760. *
  121761. * @param height
  121762. * The pixel height.
  121763. *
  121764. * @param options
  121765. * Additional options, depending on the actual symbol drawn.
  121766. */
  121767. symbol(symbol: string, x?: number, y?: number, width?: number, height?: number, options?: SymbolOptionsObject): SVGElement;
  121768. /**
  121769. * Draw text. The text can contain a subset of HTML, like spans and anchors
  121770. * and some basic text styling of these. For more advanced features like
  121771. * border and background, use Highcharts.SVGRenderer#label instead. To
  121772. * update the text after render, run `text.attr({ text: 'New text' })`.
  121773. *
  121774. * @param str
  121775. * The text of (subset) HTML to draw.
  121776. *
  121777. * @param x
  121778. * The x position of the text's lower left corner.
  121779. *
  121780. * @param y
  121781. * The y position of the text's lower left corner.
  121782. *
  121783. * @param useHTML
  121784. * Use HTML to render the text.
  121785. *
  121786. * @return The text object.
  121787. */
  121788. text(str?: string, x?: number, y?: number, useHTML?: boolean): SVGElement;
  121789. }
  121790. /**
  121791. * The Tick class.
  121792. */
  121793. export class Tick {
  121794. /**
  121795. * The Tick class.
  121796. *
  121797. * @param axis
  121798. * The axis of the tick.
  121799. *
  121800. * @param pos
  121801. * The position of the tick on the axis in terms of axis values.
  121802. *
  121803. * @param type
  121804. * The type of tick, either 'minor' or an empty string
  121805. *
  121806. * @param noLabel
  121807. * Whether to disable the label or not. Defaults to false.
  121808. *
  121809. * @param parameters
  121810. * Optional parameters for the tick.
  121811. */
  121812. constructor(axis: Axis, pos: number, type?: string, noLabel?: boolean, parameters?: object);
  121813. /**
  121814. * The related axis of the tick.
  121815. */
  121816. axis: Axis;
  121817. /**
  121818. * The rendered grid line of the tick.
  121819. */
  121820. gridLine?: SVGElement;
  121821. /**
  121822. * True if the tick is the first one on the axis.
  121823. */
  121824. readonly isFirst?: boolean;
  121825. /**
  121826. * True if the tick is the last one on the axis.
  121827. */
  121828. readonly isLast?: boolean;
  121829. /**
  121830. * The rendered text label of the tick.
  121831. */
  121832. label?: SVGElement;
  121833. /**
  121834. * The rendered mark of the tick.
  121835. */
  121836. mark?: SVGElement;
  121837. /**
  121838. * The logical position of the tick on the axis in terms of axis values.
  121839. */
  121840. pos: number;
  121841. /**
  121842. * The mark offset of the tick on the axis. Usually `undefined`, numeric for
  121843. * grid axes.
  121844. */
  121845. tickmarkOffset?: number;
  121846. /**
  121847. * The tick type, which can be `"minor"`, or an empty string.
  121848. */
  121849. type: string;
  121850. }
  121851. /**
  121852. * The Time class. Time settings are applied in general for each page using
  121853. * `Highcharts.setOptions`, or individually for each Chart item through the time
  121854. * options set.
  121855. *
  121856. * The Time object is available from Highcharts.Chart#time, which refers to
  121857. * `Highcharts.time` if no individual time settings are applied.
  121858. */
  121859. export class Time {
  121860. /**
  121861. * The Time class. Time settings are applied in general for each page using
  121862. * `Highcharts.setOptions`, or individually for each Chart item through the
  121863. * time options set.
  121864. *
  121865. * The Time object is available from Highcharts.Chart#time, which refers to
  121866. * `Highcharts.time` if no individual time settings are applied.
  121867. *
  121868. * @param options
  121869. * Time options as defined in chart.options.time.
  121870. */
  121871. constructor(options: TimeOptions);
  121872. /**
  121873. * Formats a JavaScript date timestamp (milliseconds since Jan 1st 1970)
  121874. * into a human readable date string. The available format keys are listed
  121875. * below. Additional formats can be given in the Highcharts.dateFormats
  121876. * hook.
  121877. *
  121878. * Supported format keys:
  121879. *
  121880. * - `%a`: Short weekday, like 'Mon'
  121881. *
  121882. * - `%A`: Long weekday, like 'Monday'
  121883. *
  121884. * - `%d`: Two digit day of the month, 01 to 31
  121885. *
  121886. * - `%e`: Day of the month, 1 through 31
  121887. *
  121888. * - `%w`: Day of the week, 0 through 6
  121889. *
  121890. * - `%b`: Short month, like 'Jan'
  121891. *
  121892. * - `%B`: Long month, like 'January'
  121893. *
  121894. * - `%m`: Two digit month number, 01 through 12
  121895. *
  121896. * - `%y`: Two digits year, like 09 for 2009
  121897. *
  121898. * - `%Y`: Four digits year, like 2009
  121899. *
  121900. * - `%H`: Two digits hours in 24h format, 00 through 23
  121901. *
  121902. * - `%k`: Hours in 24h format, 0 through 23
  121903. *
  121904. * - `%I`: Two digits hours in 12h format, 00 through 11
  121905. *
  121906. * - `%l`: Hours in 12h format, 1 through 12
  121907. *
  121908. * - `%M`: Two digits minutes, 00 through 59
  121909. *
  121910. * - `%p`: Upper case AM or PM
  121911. *
  121912. * - `%P`: Lower case AM or PM
  121913. *
  121914. * - `%S`: Two digits seconds, 00 through 59
  121915. *
  121916. * - `%L`: Milliseconds (naming from Ruby)
  121917. *
  121918. * @param format
  121919. * The desired format where various time representations are prefixed
  121920. * with %.
  121921. *
  121922. * @param timestamp
  121923. * The JavaScript timestamp.
  121924. *
  121925. * @param capitalize
  121926. * Upper case first letter in the return.
  121927. *
  121928. * @return The formatted date.
  121929. */
  121930. dateFormat(format: string, timestamp?: number, capitalize?: boolean): string;
  121931. /**
  121932. * Get the value of a date object in given units, and subject to the Time
  121933. * object's current timezone settings. This function corresponds directly to
  121934. * JavaScripts `Date.getXXX / Date.getUTCXXX`, so instead of calling
  121935. * `date.getHours()` or `date.getUTCHours()` we will call
  121936. * `time.get('Hours')`.
  121937. *
  121938. * @return The given time unit
  121939. */
  121940. get(unit: TimeUnitValue, date: Date): number;
  121941. /**
  121942. * Return an array with time positions distributed on round time values
  121943. * right and right after min and max. Used in datetime axes as well as for
  121944. * grouping data on a datetime axis.
  121945. *
  121946. * @param normalizedInterval
  121947. * The interval in axis values (ms) and the count
  121948. *
  121949. * @param min
  121950. * The minimum in axis values
  121951. *
  121952. * @param max
  121953. * The maximum in axis values
  121954. */
  121955. getTimeTicks(normalizedInterval: TimeNormalizedObject, min?: number, max?: number, startOfWeek?: number): AxisTickPositionsArray;
  121956. /**
  121957. * Get the time zone offset based on the current timezone information as set
  121958. * in the global options.
  121959. *
  121960. * @param timestamp
  121961. * The JavaScript timestamp to inspect.
  121962. *
  121963. * @return The timezone offset in minutes compared to UTC.
  121964. */
  121965. getTimezoneOffset(timestamp: number): number;
  121966. /**
  121967. * Make a time and returns milliseconds. Interprets the inputs as UTC time,
  121968. * local time or a specific timezone time depending on the current time
  121969. * settings.
  121970. *
  121971. * @param year
  121972. * The year
  121973. *
  121974. * @param month
  121975. * The month. Zero-based, so January is 0.
  121976. *
  121977. * @param date
  121978. * The day of the month
  121979. *
  121980. * @param hours
  121981. * The hour of the day, 0-23.
  121982. *
  121983. * @param minutes
  121984. * The minutes
  121985. *
  121986. * @param seconds
  121987. * The seconds
  121988. *
  121989. * @return The time in milliseconds since January 1st 1970.
  121990. */
  121991. makeTime(year: number, month: number, date?: number, hours?: number, minutes?: number, seconds?: number): number;
  121992. /**
  121993. * Set the value of a date object in given units, and subject to the Time
  121994. * object's current timezone settings. This function corresponds directly to
  121995. * JavaScripts `Date.setXXX / Date.setUTCXXX`, so instead of calling
  121996. * `date.setHours(0)` or `date.setUTCHours(0)` we will call
  121997. * `time.set('Hours', 0)`.
  121998. *
  121999. * @return The epoch milliseconds of the updated date
  122000. */
  122001. set(unit: TimeUnitValue, date: Date, value: number): number;
  122002. }
  122003. /**
  122004. * Tooltip of a chart.
  122005. */
  122006. export class Tooltip {
  122007. /**
  122008. * Tooltip of a chart.
  122009. *
  122010. * @param chart
  122011. * The chart instance.
  122012. *
  122013. * @param options
  122014. * Tooltip options.
  122015. */
  122016. constructor(chart: Chart, options: TooltipOptions);
  122017. /**
  122018. * Chart of the tooltip.
  122019. */
  122020. readonly chart: Chart;
  122021. /**
  122022. * Reference to the tooltip's container, when [Highcharts.Tooltip#outside]
  122023. * is set to true, otherwise it's undefined.
  122024. */
  122025. container?: HTMLDOMElement;
  122026. /**
  122027. * Used tooltip options.
  122028. */
  122029. readonly options: TooltipOptions;
  122030. /**
  122031. * Whether to allow the tooltip to render outside the chart's SVG element
  122032. * box. By default (false), the tooltip is rendered within the chart's SVG
  122033. * element, which results in the tooltip being aligned inside the chart
  122034. * area.
  122035. */
  122036. readonly outside: boolean;
  122037. /**
  122038. * Reference to the tooltip's renderer, when [Highcharts.Tooltip#outside] is
  122039. * set to true, otherwise it's undefined.
  122040. */
  122041. renderer?: SVGRenderer;
  122042. /**
  122043. * When the tooltip is shared, the entire plot area will capture mouse
  122044. * movement or touch events.
  122045. */
  122046. readonly shared?: boolean;
  122047. /**
  122048. * True, if the tooltip is split into one label per series, with the header
  122049. * close to the axis.
  122050. */
  122051. readonly split?: boolean;
  122052. /**
  122053. * In case no user defined formatter is given, this will be used. Note that
  122054. * the context here is an object holding point, series, x, y etc.
  122055. */
  122056. defaultFormatter(tooltip: Tooltip): Array<string>;
  122057. /**
  122058. * Removes and destroys the tooltip and its elements.
  122059. */
  122060. destroy(): void;
  122061. /**
  122062. * Creates the Tooltip label element if it does not exist, then returns it.
  122063. */
  122064. getLabel(): SVGElement;
  122065. /**
  122066. * Hides the tooltip with a fade out animation.
  122067. *
  122068. * @param delay
  122069. * The fade out in milliseconds. If no value is provided the value of
  122070. * the tooltip.hideDelay option is used. A value of 0 disables the
  122071. * fade out animation.
  122072. */
  122073. hide(delay?: number): void;
  122074. /**
  122075. * Refresh the tooltip's text and position.
  122076. *
  122077. * @param pointOrPoints
  122078. * Either a point or an array of points.
  122079. *
  122080. * @param mouseEvent
  122081. * Mouse event, that is responsible for the refresh and should be
  122082. * used for the tooltip update.
  122083. */
  122084. refresh(pointOrPoints: (Point|Array<Point>), mouseEvent?: PointerEventObject): void;
  122085. /**
  122086. * Updates the tooltip with the provided tooltip options.
  122087. *
  122088. * @param options
  122089. * The tooltip options to update.
  122090. */
  122091. update(options: TooltipOptions): void;
  122092. }
  122093. /**
  122094. * An array containing the current chart objects in the page. A chart's position
  122095. * in the array is preserved throughout the page's lifetime. When a chart is
  122096. * destroyed, the array item becomes `undefined`.
  122097. */
  122098. export let charts: Array<(Chart|undefined)>;
  122099. /**
  122100. * A hook for defining additional date format specifiers. New specifiers are
  122101. * defined as key-value pairs by using the specifier as key, and a function
  122102. * which takes the timestamp as value. This function returns the formatted
  122103. * portion of the date.
  122104. */
  122105. export let dateFormats: Dictionary<TimeFormatCallbackFunction>;
  122106. /**
  122107. * Global default settings.
  122108. */
  122109. export let defaultOptions: Options;
  122110. /**
  122111. * Theme options that should get applied to the chart. In module mode it might
  122112. * not be possible to change this property because of read-only restrictions,
  122113. * instead use Highcharts.setOptions.
  122114. */
  122115. export let theme: Options;
  122116. /**
  122117. * Global `Time` object with default options. Since v6.0.5, time settings can be
  122118. * applied individually for each chart. If no individual settings apply, this
  122119. * `Time` object is shared by all instances.
  122120. */
  122121. export let time: Time;
  122122. /**
  122123. * Add an event listener.
  122124. *
  122125. * @param el
  122126. * The element or object to add a listener to. It can be a
  122127. * HTMLDOMElement, an SVGElement or any other object.
  122128. *
  122129. * @param type
  122130. * The event type.
  122131. *
  122132. * @param fn
  122133. * The function callback to execute when the event is fired.
  122134. *
  122135. * @param options
  122136. * Options for adding the event.
  122137. *
  122138. * @return A callback function to remove the added event.
  122139. */
  122140. export function addEvent<T>(el: (T|Class<T>), type: string, fn: (Function|EventCallbackFunction<T>), options?: EventOptionsObject): Function;
  122141. /**
  122142. * The global animate method, which uses Fx to create individual animators.
  122143. *
  122144. * @param el
  122145. * The element to animate.
  122146. *
  122147. * @param params
  122148. * An object containing key-value pairs of the properties to animate.
  122149. * Supports numeric as pixel-based CSS properties for HTML objects and
  122150. * attributes for SVGElements.
  122151. *
  122152. * @param opt
  122153. * Animation options.
  122154. */
  122155. export function animate(el: (HTMLDOMElement|SVGElement), params: (CSSObject|SVGAttributes), opt?: Partial<AnimationOptionsObject>): void;
  122156. /**
  122157. * Get the animation in object form, where a disabled animation is always
  122158. * returned as `{ duration: 0 }`.
  122159. *
  122160. * @param animation
  122161. * An animation setting. Can be an object with duration, complete and
  122162. * easing properties, or a boolean to enable or disable.
  122163. *
  122164. * @return An object with at least a duration property.
  122165. */
  122166. export function animObject(animation?: (boolean|AnimationOptionsObject)): AnimationOptionsObject;
  122167. /**
  122168. * Non-recursive method to find the lowest member of an array. `Math.max` raises
  122169. * a maximum call stack size exceeded error in Chrome when trying to apply more
  122170. * than 150.000 points. This method is slightly slower, but safe.
  122171. *
  122172. * @param data
  122173. * An array of numbers.
  122174. *
  122175. * @return The highest number.
  122176. */
  122177. export function arrayMax(data: Array<any>): number;
  122178. /**
  122179. * Non-recursive method to find the lowest member of an array. `Math.min` raises
  122180. * a maximum call stack size exceeded error in Chrome when trying to apply more
  122181. * than 150.000 points. This method is slightly slower, but safe.
  122182. *
  122183. * @param data
  122184. * An array of numbers.
  122185. *
  122186. * @return The lowest number.
  122187. */
  122188. export function arrayMin(data: Array<any>): number;
  122189. /**
  122190. * Set or get an attribute or an object of attributes. To use as a setter, pass
  122191. * a key and a value, or let the second argument be a collection of keys and
  122192. * values. To use as a getter, pass only a string as the second argument.
  122193. *
  122194. * @param elem
  122195. * The DOM element to receive the attribute(s).
  122196. *
  122197. * @param prop
  122198. * The property or an object of key-value pairs.
  122199. *
  122200. * @param value
  122201. * The value if a single property is set.
  122202. *
  122203. * @return When used as a getter, return the value.
  122204. */
  122205. export function attr(elem: (HTMLDOMElement|SVGDOMElement), prop?: (string|HTMLAttributes|SVGAttributes), value?: (number|string)): (string|null|undefined);
  122206. /**
  122207. * Factory function for basic charts.
  122208. *
  122209. * @param options
  122210. * The chart options structure.
  122211. *
  122212. * @param callback
  122213. * Function to run when the chart has loaded and and all external images
  122214. * are loaded. Defining a chart.events.load handler is equivalent.
  122215. *
  122216. * @return Returns the Chart object.
  122217. */
  122218. export function chart(options: Options, callback?: ChartCallbackFunction): Chart;
  122219. /**
  122220. * Factory function for basic charts.
  122221. *
  122222. * @param renderTo
  122223. * The DOM element to render to, or its id.
  122224. *
  122225. * @param options
  122226. * The chart options structure.
  122227. *
  122228. * @param callback
  122229. * Function to run when the chart has loaded and and all external images
  122230. * are loaded. Defining a chart.events.load handler is equivalent.
  122231. *
  122232. * @return Returns the Chart object.
  122233. */
  122234. export function chart(renderTo: (string|HTMLDOMElement), options: Options, callback?: ChartCallbackFunction): Chart;
  122235. /**
  122236. * Internal clear timeout. The function checks that the `id` was not removed
  122237. * (e.g. by `chart.destroy()`). For the details see issue .7901.
  122238. *
  122239. * @param id
  122240. * Id of a timeout.
  122241. */
  122242. export function clearTimeout(id: number): void;
  122243. /**
  122244. * Creates a color instance out of a color string.
  122245. *
  122246. * @param input
  122247. * The input color in either rbga or hex format
  122248. *
  122249. * @return Color instance
  122250. */
  122251. export function color(input: ColorType): Color;
  122252. /**
  122253. * Fix JS round off float errors.
  122254. *
  122255. * @param num
  122256. * A float number to fix.
  122257. *
  122258. * @param prec
  122259. * The precision.
  122260. *
  122261. * @return The corrected float number.
  122262. */
  122263. export function correctFloat(num: number, prec?: number): number;
  122264. /**
  122265. * Utility function to create an HTML element with attributes and styles.
  122266. *
  122267. * @param tag
  122268. * The HTML tag.
  122269. *
  122270. * @param attribs
  122271. * Attributes as an object of key-value pairs.
  122272. *
  122273. * @param styles
  122274. * Styles as an object of key-value pairs.
  122275. *
  122276. * @param parent
  122277. * The parent HTML object.
  122278. *
  122279. * @param nopad
  122280. * If true, remove all padding, border and margin.
  122281. *
  122282. * @return The created DOM element.
  122283. */
  122284. export function createElement(tag: string, attribs?: HTMLAttributes, styles?: CSSObject, parent?: HTMLDOMElement, nopad?: boolean): HTMLDOMElement;
  122285. /**
  122286. * Set CSS on a given element.
  122287. *
  122288. * @param el
  122289. * An HTML DOM element.
  122290. *
  122291. * @param styles
  122292. * Style object with camel case property names.
  122293. */
  122294. export function css(el: (HTMLDOMElement|SVGDOMElement), styles: CSSObject): void;
  122295. /**
  122296. * Formats a JavaScript date timestamp (milliseconds since Jan 1st 1970) into a
  122297. * human readable date string. The format is a subset of the formats for PHP's
  122298. * strftime function. Additional formats can be given in the
  122299. * Highcharts.dateFormats hook.
  122300. *
  122301. * Since v6.0.5, all internal dates are formatted through the
  122302. * Highcharts.Chart#time instance to respect chart-level time settings. The
  122303. * `Highcharts.dateFormat` function only reflects global time settings set with
  122304. * `setOptions`.
  122305. *
  122306. * Supported format keys:
  122307. *
  122308. * - `%a`: Short weekday, like 'Mon'
  122309. *
  122310. * - `%A`: Long weekday, like 'Monday'
  122311. *
  122312. * - `%d`: Two digit day of the month, 01 to 31
  122313. *
  122314. * - `%e`: Day of the month, 1 through 31
  122315. *
  122316. * - `%w`: Day of the week, 0 through 6
  122317. *
  122318. * - `%b`: Short month, like 'Jan'
  122319. *
  122320. * - `%B`: Long month, like 'January'
  122321. *
  122322. * - `%m`: Two digit month number, 01 through 12
  122323. *
  122324. * - `%y`: Two digits year, like 09 for 2009
  122325. *
  122326. * - `%Y`: Four digits year, like 2009
  122327. *
  122328. * - `%H`: Two digits hours in 24h format, 00 through 23
  122329. *
  122330. * - `%k`: Hours in 24h format, 0 through 23
  122331. *
  122332. * - `%I`: Two digits hours in 12h format, 00 through 11
  122333. *
  122334. * - `%l`: Hours in 12h format, 1 through 12
  122335. *
  122336. * - `%M`: Two digits minutes, 00 through 59
  122337. *
  122338. * - `%p`: Upper case AM or PM
  122339. *
  122340. * - `%P`: Lower case AM or PM
  122341. *
  122342. * - `%S`: Two digits seconds, 00 through 59
  122343. *
  122344. * - `%L`: Milliseconds (naming from Ruby)
  122345. *
  122346. * @param format
  122347. * The desired format where various time representations are prefixed
  122348. * with `%`.
  122349. *
  122350. * @param timestamp
  122351. * The JavaScript timestamp.
  122352. *
  122353. * @param capitalize
  122354. * Upper case first letter in the return.
  122355. *
  122356. * @return The formatted date.
  122357. */
  122358. export function dateFormat(format: string, timestamp: number, capitalize?: boolean): string;
  122359. /**
  122360. * Check if an object is null or undefined.
  122361. *
  122362. * @param obj
  122363. * The object to check.
  122364. *
  122365. * @return False if the object is null or undefined, otherwise true.
  122366. */
  122367. export function defined(obj: any): boolean;
  122368. /**
  122369. * Utility method that destroys any SVGElement instances that are properties on
  122370. * the given object. It loops all properties and invokes destroy if there is a
  122371. * destroy method. The property is then delete.
  122372. *
  122373. * @param obj
  122374. * The object to destroy properties on.
  122375. *
  122376. * @param except
  122377. * Exception, do not destroy this property, only delete it.
  122378. */
  122379. export function destroyObjectProperties(obj: any, except?: any): void;
  122380. /**
  122381. * Discard a HTML element by moving it to the bin and delete.
  122382. *
  122383. * @param element
  122384. * The HTML node to discard.
  122385. */
  122386. export function discardElement(element: HTMLDOMElement): void;
  122387. /**
  122388. * Iterate over an array.
  122389. *
  122390. * @param arr
  122391. * The array to iterate over.
  122392. *
  122393. * @param fn
  122394. * The iterator callback. It passes three arguments:
  122395. *
  122396. * - `item`: The array item.
  122397. *
  122398. * - `index`: The item's index in the array.
  122399. *
  122400. * - `arr`: The array that each is being applied to.
  122401. *
  122402. * @param ctx
  122403. * The context.
  122404. */
  122405. export function each(arr: Array<any>, fn: Function, ctx?: any): void;
  122406. /**
  122407. * Remove the last occurence of an item from an array.
  122408. *
  122409. * @param arr
  122410. * The array.
  122411. *
  122412. * @param item
  122413. * The item to remove.
  122414. */
  122415. export function erase(arr: Array<any>, item: any): void;
  122416. /**
  122417. * Provide error messages for debugging, with links to online explanation. This
  122418. * function can be overridden to provide custom error handling.
  122419. *
  122420. * @param code
  122421. * The error code. See errors.xml for available codes. If it is a string,
  122422. * the error message is printed directly in the console.
  122423. *
  122424. * @param stop
  122425. * Whether to throw an error or just log a warning in the console.
  122426. *
  122427. * @param chart
  122428. * Reference to the chart that causes the error. Used in 'debugger'
  122429. * module to display errors directly on the chart. Important note: This
  122430. * argument is undefined for errors that lack access to the Chart
  122431. * instance.
  122432. *
  122433. * @param params
  122434. * Additional parameters for the generated message.
  122435. */
  122436. export function error(code: (number|string), stop?: boolean, chart?: Chart, params?: Dictionary<string>): void;
  122437. /**
  122438. * Utility function to extend an object with the members of another.
  122439. *
  122440. * @param a
  122441. * The object to be extended.
  122442. *
  122443. * @param b
  122444. * The object to add to the first one.
  122445. *
  122446. * @return Object a, the original object.
  122447. */
  122448. export function extend<T>(a: (T|undefined), b: object): T;
  122449. /**
  122450. * Extend a prototyped class by new members.
  122451. *
  122452. * @param parent
  122453. * The parent prototype to inherit.
  122454. *
  122455. * @param members
  122456. * A collection of prototype members to add or override compared to the
  122457. * parent prototype.
  122458. *
  122459. * @return A new prototype.
  122460. */
  122461. export function extendClass<T>(parent: Class<T>, members: Dictionary<any>): Class<T>;
  122462. /**
  122463. * Return the value of the first element in the array that satisfies the
  122464. * provided testing function.
  122465. *
  122466. * @param arr
  122467. * The array to test.
  122468. *
  122469. * @param callback
  122470. * The callback function. The function receives the item as the first
  122471. * argument. Return `true` if this item satisfies the condition.
  122472. *
  122473. * @return The value of the element.
  122474. */
  122475. export function find<T>(arr: Array<T>, callback: Function): (T|undefined);
  122476. /**
  122477. * Fire an event that was registered with Highcharts#addEvent.
  122478. *
  122479. * @param el
  122480. * The object to fire the event on. It can be a HTMLDOMElement, an
  122481. * SVGElement or any other object.
  122482. *
  122483. * @param type
  122484. * The type of event.
  122485. *
  122486. * @param eventArguments
  122487. * Custom event arguments that are passed on as an argument to the event
  122488. * handler.
  122489. *
  122490. * @param defaultFunction
  122491. * The default function to execute if the other listeners haven't
  122492. * returned false.
  122493. */
  122494. export function fireEvent<T>(el: T, type: string, eventArguments?: (Event|Dictionary<any>), defaultFunction?: (Function|EventCallbackFunction<T>)): void;
  122495. /**
  122496. * Format a string according to a subset of the rules of Python's String.format
  122497. * method.
  122498. *
  122499. * @param str
  122500. * The string to format.
  122501. *
  122502. * @param ctx
  122503. * The context, a collection of key-value pairs where each key is
  122504. * replaced by its value.
  122505. *
  122506. * @param chart
  122507. * A `Chart` instance used to get numberFormatter and time.
  122508. *
  122509. * @return The formatted string.
  122510. */
  122511. export function format(str: string, ctx: Record<string, any>, chart?: Chart): string;
  122512. /**
  122513. * Get the defer as a number value from series animation options.
  122514. *
  122515. * @param chart
  122516. * The chart instance.
  122517. *
  122518. * @param animation
  122519. * An animation setting. Can be an object with duration, complete and
  122520. * easing properties, or a boolean to enable or disable.
  122521. *
  122522. * @param series
  122523. * Series to defer animation.
  122524. *
  122525. * @return The numeric value.
  122526. */
  122527. export function getDeferredAnimation(chart: Chart, animation: (boolean|AnimationOptionsObject), series?: Series): number;
  122528. /**
  122529. * Get the magnitude of a number.
  122530. *
  122531. * @param num
  122532. * The number.
  122533. *
  122534. * @return The magnitude, where 1-9 are magnitude 1, 10-99 magnitude 2 etc.
  122535. */
  122536. export function getMagnitude(num: number): number;
  122537. /**
  122538. * Get the updated default options. Until 3.0.7, merely exposing defaultOptions
  122539. * for outside modules wasn't enough because the setOptions method created a new
  122540. * object.
  122541. */
  122542. export function getOptions(): Options;
  122543. /**
  122544. * Get the computed CSS value for given element and property, only for numerical
  122545. * properties. For width and height, the dimension of the inner box (excluding
  122546. * padding) is returned. Used for fitting the chart within the container.
  122547. *
  122548. * @param el
  122549. * An HTML element.
  122550. *
  122551. * @param prop
  122552. * The property name.
  122553. *
  122554. * @param toInt
  122555. * Parse to integer.
  122556. *
  122557. * @return The numeric value.
  122558. */
  122559. export function getStyle(el: HTMLDOMElement, prop: string, toInt?: boolean): (number|string);
  122560. /**
  122561. * Filter an array by a callback.
  122562. *
  122563. * @param arr
  122564. * The array to filter.
  122565. *
  122566. * @param callback
  122567. * The callback function. The function receives the item as the first
  122568. * argument. Return `true` if the item is to be preserved.
  122569. *
  122570. * @return A new, filtered array.
  122571. */
  122572. export function grep(arr: Array<any>, callback: Function): Array<any>;
  122573. /**
  122574. * Search for an item in an array.
  122575. *
  122576. * @param item
  122577. * The item to search for.
  122578. *
  122579. * @param arr
  122580. * The array or node collection to search in.
  122581. *
  122582. * @param fromIndex
  122583. * The index to start searching from.
  122584. *
  122585. * @return The index within the array, or -1 if not found.
  122586. */
  122587. export function inArray(item: any, arr: Array<any>, fromIndex?: number): number;
  122588. /**
  122589. * Utility function to check if an item is an array.
  122590. *
  122591. * @param obj
  122592. * The item to check.
  122593. *
  122594. * @return True if the argument is an array.
  122595. */
  122596. export function isArray(obj: any): boolean;
  122597. /**
  122598. * Utility function to check if an Object is a class.
  122599. *
  122600. * @param obj
  122601. * The item to check.
  122602. *
  122603. * @return True if the argument is a class.
  122604. */
  122605. export function isClass(obj: (object|undefined)): boolean;
  122606. /**
  122607. * Utility function to check if an Object is a HTML Element.
  122608. *
  122609. * @param obj
  122610. * The item to check.
  122611. *
  122612. * @return True if the argument is a HTML Element.
  122613. */
  122614. export function isDOMElement(obj: any): boolean;
  122615. /**
  122616. * Utility function to check if an item is a number and it is finite (not NaN,
  122617. * Infinity or -Infinity).
  122618. *
  122619. * @param n
  122620. * The item to check.
  122621. *
  122622. * @return True if the item is a finite number
  122623. */
  122624. export function isNumber(n: any): boolean;
  122625. /**
  122626. * Utility function to check if an item is of type object.
  122627. *
  122628. * @param obj
  122629. * The item to check.
  122630. *
  122631. * @param strict
  122632. * Also checks that the object is not an array.
  122633. *
  122634. * @return True if the argument is an object.
  122635. */
  122636. export function isObject(obj: any, strict?: boolean): boolean;
  122637. /**
  122638. * Utility function to check for string type.
  122639. *
  122640. * @param s
  122641. * The item to check.
  122642. *
  122643. * @return True if the argument is a string.
  122644. */
  122645. export function isString(s: any): boolean;
  122646. /**
  122647. * Returns an array of a given object's own properties.
  122648. *
  122649. * @param obj
  122650. * The object of which the properties are to be returned.
  122651. *
  122652. * @return An array of strings that represents all the properties.
  122653. */
  122654. export function keys(obj: any): Array<string>;
  122655. /**
  122656. * Map an array by a callback.
  122657. *
  122658. * @param arr
  122659. * The array to map.
  122660. *
  122661. * @param fn
  122662. * The callback function. Return the new value for the new array.
  122663. *
  122664. * @return A new array item with modified items.
  122665. */
  122666. export function map(arr: Array<any>, fn: Function): Array<any>;
  122667. /**
  122668. * Utility function to deep merge two or more objects and return a third object.
  122669. * The merge function can also be used with a single object argument to create a
  122670. * deep copy of an object.
  122671. *
  122672. * @param a
  122673. * The first object to extend. When only this is given, the function
  122674. * returns a deep copy.
  122675. *
  122676. * @param n
  122677. * An object to merge into the previous one.
  122678. *
  122679. * @return The merged object. If the first argument is true, the return is the
  122680. * same as the second argument.
  122681. */
  122682. export function merge<T>(a: (T|undefined), ...n: Array<(object|undefined)>): T;
  122683. /**
  122684. * Utility function to deep merge two or more objects and return a third object.
  122685. * If the first argument is true, the contents of the second object is copied
  122686. * into the first object. The merge function can also be used with a single
  122687. * object argument to create a deep copy of an object.
  122688. *
  122689. * @param extend
  122690. * Whether to extend the left-side object (a) or return a whole new
  122691. * object.
  122692. *
  122693. * @param a
  122694. * The first object to extend. When only this is given, the function
  122695. * returns a deep copy.
  122696. *
  122697. * @param n
  122698. * An object to merge into the previous one.
  122699. *
  122700. * @return The merged object. If the first argument is true, the return is the
  122701. * same as the second argument.
  122702. */
  122703. export function merge<T>(extend: boolean, a: (T|undefined), ...n: Array<(object|undefined)>): T;
  122704. /**
  122705. * Take an interval and normalize it to multiples of round numbers.
  122706. *
  122707. * @param interval
  122708. * The raw, un-rounded interval.
  122709. *
  122710. * @param multiples
  122711. * Allowed multiples.
  122712. *
  122713. * @param magnitude
  122714. * The magnitude of the number.
  122715. *
  122716. * @param allowDecimals
  122717. * Whether to allow decimals.
  122718. *
  122719. * @param hasTickAmount
  122720. * If it has tickAmount, avoid landing on tick intervals lower than
  122721. * original.
  122722. *
  122723. * @return The normalized interval.
  122724. */
  122725. export function normalizeTickInterval(interval: number, multiples?: Array<any>, magnitude?: number, allowDecimals?: boolean, hasTickAmount?: boolean): number;
  122726. /**
  122727. * Format a number and return a string based on input settings.
  122728. *
  122729. * @param number
  122730. * The input number to format.
  122731. *
  122732. * @param decimals
  122733. * The amount of decimals. A value of -1 preserves the amount in the
  122734. * input number.
  122735. *
  122736. * @param decimalPoint
  122737. * The decimal point, defaults to the one given in the lang options, or a
  122738. * dot.
  122739. *
  122740. * @param thousandsSep
  122741. * The thousands separator, defaults to the one given in the lang
  122742. * options, or a space character.
  122743. *
  122744. * @return The formatted number.
  122745. */
  122746. export function numberFormat(number: number, decimals: number, decimalPoint?: string, thousandsSep?: string): string;
  122747. /**
  122748. * Iterate over object key pairs in an object.
  122749. *
  122750. * @param obj
  122751. * The object to iterate over.
  122752. *
  122753. * @param fn
  122754. * The iterator callback. It passes three arguments:
  122755. *
  122756. * * value - The property value.
  122757. *
  122758. * * key - The property key.
  122759. *
  122760. * * obj - The object that objectEach is being applied to.
  122761. *
  122762. * @param ctx
  122763. * The context.
  122764. */
  122765. export function objectEach<T>(obj: any, fn: ObjectEachCallbackFunction<T>, ctx?: T): void;
  122766. /**
  122767. * Get the element's offset position, corrected for `overflow: auto`.
  122768. *
  122769. * @param el
  122770. * The DOM element.
  122771. *
  122772. * @return An object containing `left` and `top` properties for the position in
  122773. * the page.
  122774. */
  122775. export function offset(el: Element): OffsetObject;
  122776. /**
  122777. * Left-pad a string to a given length by adding a character repetetively.
  122778. *
  122779. * @param number
  122780. * The input string or number.
  122781. *
  122782. * @param length
  122783. * The desired string length.
  122784. *
  122785. * @param padder
  122786. * The character to pad with.
  122787. *
  122788. * @return The padded string.
  122789. */
  122790. export function pad(number: number, length?: number, padder?: string): string;
  122791. /**
  122792. * Return the first value that is not null or undefined.
  122793. *
  122794. * @param items
  122795. * Variable number of arguments to inspect.
  122796. *
  122797. * @return The value of the first argument that is not null or undefined.
  122798. */
  122799. export function pick<T>(...items: Array<(T|null|undefined)>): T;
  122800. /**
  122801. * Reduce an array to a single value.
  122802. *
  122803. * @param arr
  122804. * The array to reduce.
  122805. *
  122806. * @param fn
  122807. * The callback function. Return the reduced value. Receives 4 arguments:
  122808. * Accumulated/reduced value, current value, current array index, and the
  122809. * array.
  122810. *
  122811. * @param initialValue
  122812. * The initial value of the accumulator.
  122813. *
  122814. * @return The reduced value.
  122815. */
  122816. export function reduce(arr: Array<any>, fn: Function, initialValue: any): any;
  122817. /**
  122818. * Return a length based on either the integer value, or a percentage of a base.
  122819. *
  122820. * @param value
  122821. * A percentage string or a number.
  122822. *
  122823. * @param base
  122824. * The full length that represents 100%.
  122825. *
  122826. * @param offset
  122827. * A pixel offset to apply for percentage values. Used internally in axis
  122828. * positioning.
  122829. *
  122830. * @return The computed length.
  122831. */
  122832. export function relativeLength(value: RelativeSize, base: number, offset?: number): number;
  122833. /**
  122834. * Remove an event that was added with Highcharts#addEvent.
  122835. *
  122836. * @param el
  122837. * The element to remove events on.
  122838. *
  122839. * @param type
  122840. * The type of events to remove. If undefined, all events are removed
  122841. * from the element.
  122842. *
  122843. * @param fn
  122844. * The specific callback to remove. If undefined, all events that match
  122845. * the element and optionally the type are removed.
  122846. */
  122847. export function removeEvent<T>(el: (T|Class<T>), type?: string, fn?: EventCallbackFunction<T>): void;
  122848. /**
  122849. * Old factory to create new series prototypes.
  122850. *
  122851. * @param type
  122852. * The series type name.
  122853. *
  122854. * @param parent
  122855. * The parent series type name. Use `line` to inherit from the basic
  122856. * Series object.
  122857. *
  122858. * @param options
  122859. * The additional default options that are merged with the parent's
  122860. * options.
  122861. *
  122862. * @param props
  122863. * The properties (functions and primitives) to set on the new prototype.
  122864. *
  122865. * @param pointProps
  122866. * Members for a series-specific extension of the Point prototype if
  122867. * needed.
  122868. *
  122869. * @return The newly created prototype as extended from Series or its
  122870. * derivatives.
  122871. */
  122872. export function seriesType(type: string, parent: string, options: (SeriesOptionsType|Dictionary<any>), props?: Dictionary<any>, pointProps?: Dictionary<any>): Series;
  122873. /**
  122874. * Set the global animation to either a given value, or fall back to the given
  122875. * chart's animation option.
  122876. *
  122877. * @param animation
  122878. * The animation object.
  122879. *
  122880. * @param chart
  122881. * The chart instance.
  122882. */
  122883. export function setAnimation(animation: (boolean|Partial<AnimationOptionsObject>|undefined), chart: Chart): void;
  122884. /**
  122885. * Merge the default options with custom options and return the new options
  122886. * structure. Commonly used for defining reusable templates.
  122887. *
  122888. * @param options
  122889. * The new custom chart options.
  122890. *
  122891. * @return Updated options.
  122892. */
  122893. export function setOptions(options: Options): Options;
  122894. /**
  122895. * Test whether at least one element in the array passes the test implemented by
  122896. * the provided function.
  122897. *
  122898. * @param arr
  122899. * The array to test
  122900. *
  122901. * @param fn
  122902. * The function to run on each item. Return truty to pass the test.
  122903. * Receives arguments `currentValue`, `index` and `array`.
  122904. *
  122905. * @param ctx
  122906. * The context.
  122907. */
  122908. export function some(arr: Array<any>, fn: Function, ctx: any): boolean;
  122909. /**
  122910. * Check if an element is an array, and if not, make it into an array.
  122911. *
  122912. * @param obj
  122913. * The object to splat.
  122914. *
  122915. * @return The produced or original array.
  122916. */
  122917. export function splat(obj: any): any[];
  122918. /**
  122919. * Sort an object array and keep the order of equal items. The ECMAScript
  122920. * standard does not specify the behaviour when items are equal.
  122921. *
  122922. * @param arr
  122923. * The array to sort.
  122924. *
  122925. * @param sortFunction
  122926. * The function to sort it with, like with regular Array.prototype.sort.
  122927. */
  122928. export function stableSort(arr: Array<any>, sortFunction: Function): void;
  122929. /**
  122930. * Stop running animation.
  122931. *
  122932. * @param el
  122933. * The SVGElement to stop animation on.
  122934. *
  122935. * @param prop
  122936. * The property to stop animating. If given, the stop method will stop a
  122937. * single property from animating, while others continue.
  122938. */
  122939. export function stop(el: SVGElement, prop?: string): void;
  122940. /**
  122941. * Set a timeout if the delay is given, otherwise perform the function
  122942. * synchronously.
  122943. *
  122944. * @param fn
  122945. * The function callback.
  122946. *
  122947. * @param delay
  122948. * Delay in milliseconds.
  122949. *
  122950. * @param context
  122951. * An optional context to send to the function callback.
  122952. *
  122953. * @return An identifier for the timeout that can later be cleared with
  122954. * Highcharts.clearTimeout. Returns -1 if there is no timeout.
  122955. */
  122956. export function syncTimeout(fn: Function, delay: number, context?: any): number;
  122957. /**
  122958. * Get a unique key for using in internal element id's and pointers. The key is
  122959. * composed of a random hash specific to this Highcharts instance, and a
  122960. * counter.
  122961. *
  122962. * @return A unique key.
  122963. */
  122964. export function uniqueKey(): string;
  122965. /**
  122966. * Activates a serial mode for element IDs provided by Highcharts.uniqueKey.
  122967. * This mode can be used in automated tests, where a simple comparison of two
  122968. * rendered SVG graphics is needed.
  122969. *
  122970. * **Note:** This is only for testing purposes and will break functionality in
  122971. * webpages with multiple charts.
  122972. *
  122973. * @param mode
  122974. * Changes the state of serial mode.
  122975. *
  122976. * @return State of the serial mode.
  122977. */
  122978. export function useSerialIds(mode?: boolean): (boolean|undefined);
  122979. /**
  122980. * Wrap a method with extended functionality, preserving the original function.
  122981. *
  122982. * @param obj
  122983. * The context object that the method belongs to. In real cases, this is
  122984. * often a prototype.
  122985. *
  122986. * @param method
  122987. * The name of the method to extend.
  122988. *
  122989. * @param func
  122990. * A wrapper function callback. This function is called with the same
  122991. * arguments as the original function, except that the original function
  122992. * is unshifted and passed as the first argument.
  122993. */
  122994. export function wrap(obj: any, method: string, func: WrapProceedFunction): void;
  122995. declare global {
  122996. /**
  122997. * Highcharts-extended JQuery.
  122998. */
  122999. interface JQuery {
  123000. /**
  123001. * Helper function to return the chart of the current JQuery selector
  123002. * element.
  123003. *
  123004. * @param className
  123005. * Name of the factory class in the Highcharts namespace.
  123006. *
  123007. * @param options
  123008. * The chart options structure.
  123009. *
  123010. * @param callback
  123011. * Function to run when the chart has loaded and and all external
  123012. * images are loaded. Defining a chart.events.load handler is
  123013. * equivalent.
  123014. *
  123015. * @return The current JQuery selector.
  123016. */
  123017. highcharts(className?: (string|'Chart'|'Map'|'StockChart'), options?: Options, callback?: ChartCallbackFunction): JQuery;
  123018. }
  123019. }
  123020. export as namespace Highcharts;