12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788899091929394959697989910010110210310410510610710810911011111211311411511611711811912012112212312412512612712812913013113213313413513613713813914014114214314414514614714814915015115215315415515615715815916016116216316416516616716816917017117217317417517617717817918018118218318418518618718818919019119219319419519619719819920020120220320420520620720820921021121221321421521621721821922022122222322422522622722822923023123223323423523623723823924024124224324424524624724824925025125225325425525625725825926026126226326426526626726826927027127227327427527627727827928028128228328428528628728828929029129229329429529629729829930030130230330430530630730830931031131231331431531631731831932032132232332432532632732832933033133233333433533633733833934034134234334434534634734834935035135235335435535635735835936036136236336436536636736836937037137237337437537637737837938038138238338438538638738838939039139239339439539639739839940040140240340440540640740840941041141241341441541641741841942042142242342442542642742842943043143243343443543643743843944044144244344444544644744844945045145245345445545645745845946046146246346446546646746846947047147247347447547647747847948048148248348448548648748848949049149249349449549649749849950050150250350450550650750850951051151251351451551651751851952052152252352452552652752852953053153253353453553653753853954054154254354454554654754854955055155255355455555655755855956056156256356456556656756856957057157257357457557657757857958058158258358458558658758858959059159259359459559659759859960060160260360460560660760860961061161261361461561661761861962062162262362462562662762862963063163263363463563663763863964064164264364464564664764864965065165265365465565665765865966066166266366466566666766866967067167267367467567667767867968068168268368468568668768868969069169269369469569669769869970070170270370470570670770870971071171271371471571671771871972072172272372472572672772872973073173273373473573673773873974074174274374474574674774874975075175275375475575675775875976076176276376476576676776876977077177277377477577677777877978078178278378478578678778878979079179279379479579679779879980080180280380480580680780880981081181281381481581681781881982082182282382482582682782882983083183283383483583683783883984084184284384484584684784884985085185285385485585685785885986086186286386486586686786886987087187287387487587687787887988088188288388488588688788888989089189289389489589689789889990090190290390490590690790890991091191291391491591691791891992092192292392492592692792892993093193293393493593693793893994094194294394494594694794894995095195295395495595695795895996096196296396496596696796896997097197297397497597697797897998098198298398498598698798898999099199299399499599699799899910001001100210031004100510061007100810091010101110121013101410151016101710181019102010211022102310241025102610271028102910301031103210331034103510361037103810391040104110421043104410451046104710481049105010511052105310541055105610571058105910601061106210631064106510661067106810691070107110721073107410751076107710781079108010811082108310841085108610871088108910901091109210931094109510961097109810991100110111021103110411051106110711081109111011111112111311141115111611171118111911201121112211231124112511261127112811291130113111321133113411351136113711381139114011411142114311441145114611471148114911501151115211531154115511561157115811591160116111621163116411651166116711681169117011711172117311741175117611771178117911801181118211831184118511861187118811891190119111921193119411951196119711981199120012011202120312041205120612071208120912101211121212131214121512161217121812191220122112221223122412251226122712281229123012311232123312341235123612371238123912401241124212431244124512461247124812491250125112521253125412551256125712581259126012611262126312641265126612671268126912701271127212731274127512761277127812791280128112821283128412851286128712881289129012911292129312941295129612971298129913001301130213031304130513061307130813091310131113121313131413151316131713181319132013211322132313241325132613271328132913301331133213331334133513361337133813391340134113421343134413451346134713481349135013511352135313541355135613571358135913601361136213631364136513661367136813691370137113721373137413751376137713781379138013811382138313841385138613871388138913901391139213931394139513961397139813991400140114021403140414051406140714081409141014111412141314141415141614171418141914201421142214231424142514261427142814291430143114321433143414351436143714381439144014411442144314441445144614471448144914501451145214531454145514561457145814591460146114621463146414651466146714681469147014711472147314741475147614771478147914801481148214831484148514861487148814891490149114921493149414951496149714981499150015011502150315041505150615071508150915101511151215131514151515161517151815191520152115221523152415251526152715281529153015311532153315341535153615371538153915401541154215431544154515461547154815491550155115521553155415551556155715581559156015611562156315641565156615671568156915701571157215731574157515761577157815791580158115821583158415851586158715881589159015911592159315941595159615971598159916001601160216031604160516061607160816091610161116121613161416151616161716181619162016211622162316241625162616271628162916301631163216331634163516361637163816391640164116421643164416451646164716481649165016511652165316541655165616571658165916601661166216631664166516661667166816691670167116721673167416751676167716781679168016811682168316841685168616871688168916901691169216931694169516961697169816991700170117021703170417051706170717081709171017111712171317141715171617171718171917201721172217231724172517261727172817291730173117321733173417351736173717381739174017411742174317441745174617471748174917501751175217531754175517561757175817591760176117621763176417651766176717681769177017711772177317741775177617771778177917801781178217831784178517861787178817891790179117921793179417951796179717981799180018011802180318041805180618071808180918101811181218131814181518161817181818191820182118221823182418251826182718281829183018311832183318341835183618371838183918401841184218431844184518461847184818491850185118521853185418551856185718581859186018611862186318641865186618671868186918701871187218731874187518761877187818791880188118821883188418851886188718881889189018911892189318941895189618971898189919001901190219031904190519061907190819091910191119121913191419151916191719181919192019211922192319241925192619271928192919301931193219331934193519361937193819391940194119421943194419451946194719481949195019511952195319541955195619571958195919601961196219631964196519661967196819691970197119721973197419751976197719781979198019811982198319841985198619871988198919901991199219931994199519961997199819992000200120022003200420052006200720082009201020112012201320142015201620172018201920202021202220232024202520262027202820292030203120322033203420352036203720382039204020412042204320442045204620472048204920502051205220532054205520562057205820592060206120622063206420652066206720682069207020712072207320742075207620772078207920802081208220832084208520862087208820892090209120922093209420952096209720982099210021012102210321042105210621072108210921102111211221132114211521162117211821192120212121222123212421252126212721282129213021312132213321342135213621372138213921402141214221432144214521462147214821492150215121522153215421552156215721582159216021612162216321642165216621672168216921702171217221732174217521762177217821792180218121822183218421852186218721882189219021912192219321942195219621972198219922002201220222032204220522062207220822092210221122122213221422152216221722182219222022212222222322242225222622272228222922302231223222332234223522362237223822392240224122422243224422452246224722482249225022512252225322542255225622572258225922602261226222632264226522662267226822692270227122722273227422752276227722782279228022812282228322842285228622872288228922902291229222932294229522962297229822992300230123022303230423052306230723082309231023112312231323142315231623172318231923202321232223232324232523262327232823292330233123322333233423352336233723382339234023412342234323442345234623472348234923502351235223532354235523562357235823592360236123622363236423652366236723682369237023712372237323742375237623772378237923802381238223832384238523862387238823892390239123922393239423952396239723982399240024012402240324042405240624072408240924102411241224132414241524162417241824192420242124222423242424252426242724282429243024312432243324342435243624372438243924402441244224432444244524462447244824492450245124522453245424552456245724582459246024612462246324642465246624672468246924702471247224732474247524762477247824792480248124822483248424852486248724882489249024912492249324942495249624972498249925002501250225032504250525062507250825092510251125122513251425152516251725182519252025212522252325242525252625272528252925302531253225332534253525362537253825392540254125422543254425452546254725482549255025512552255325542555255625572558255925602561256225632564256525662567256825692570257125722573257425752576257725782579258025812582258325842585258625872588258925902591259225932594259525962597259825992600260126022603260426052606260726082609261026112612261326142615261626172618261926202621262226232624262526262627262826292630263126322633263426352636263726382639264026412642264326442645264626472648264926502651265226532654265526562657265826592660266126622663266426652666266726682669267026712672267326742675267626772678267926802681268226832684268526862687268826892690269126922693269426952696269726982699270027012702270327042705270627072708270927102711271227132714271527162717271827192720272127222723272427252726272727282729273027312732273327342735273627372738273927402741274227432744274527462747274827492750275127522753275427552756275727582759276027612762276327642765276627672768276927702771277227732774277527762777277827792780278127822783278427852786278727882789279027912792279327942795279627972798279928002801280228032804280528062807280828092810281128122813281428152816281728182819282028212822282328242825282628272828282928302831283228332834283528362837283828392840284128422843284428452846284728482849285028512852285328542855285628572858285928602861286228632864286528662867286828692870287128722873287428752876287728782879288028812882288328842885288628872888288928902891289228932894289528962897289828992900290129022903290429052906290729082909291029112912291329142915291629172918291929202921292229232924292529262927292829292930293129322933293429352936293729382939294029412942294329442945294629472948294929502951295229532954295529562957295829592960296129622963296429652966296729682969297029712972297329742975297629772978297929802981298229832984298529862987298829892990299129922993299429952996299729982999300030013002300330043005300630073008300930103011301230133014301530163017301830193020302130223023302430253026302730283029303030313032303330343035303630373038303930403041304230433044304530463047304830493050305130523053305430553056305730583059306030613062306330643065306630673068306930703071307230733074307530763077307830793080308130823083308430853086308730883089309030913092309330943095309630973098309931003101310231033104310531063107310831093110311131123113311431153116311731183119312031213122312331243125312631273128312931303131313231333134313531363137313831393140314131423143314431453146314731483149315031513152315331543155315631573158315931603161316231633164316531663167316831693170317131723173317431753176317731783179318031813182318331843185318631873188318931903191319231933194319531963197319831993200320132023203320432053206320732083209321032113212321332143215321632173218321932203221322232233224322532263227322832293230323132323233323432353236323732383239324032413242324332443245324632473248324932503251325232533254325532563257325832593260326132623263326432653266326732683269327032713272327332743275327632773278327932803281328232833284328532863287328832893290329132923293329432953296329732983299330033013302330333043305330633073308330933103311331233133314331533163317331833193320332133223323332433253326332733283329333033313332333333343335333633373338333933403341334233433344334533463347334833493350335133523353335433553356335733583359336033613362336333643365336633673368336933703371337233733374337533763377337833793380338133823383338433853386338733883389339033913392339333943395339633973398339934003401340234033404340534063407340834093410341134123413341434153416341734183419342034213422342334243425342634273428342934303431343234333434343534363437343834393440344134423443344434453446344734483449345034513452345334543455345634573458345934603461346234633464346534663467346834693470347134723473347434753476347734783479348034813482348334843485348634873488348934903491349234933494349534963497349834993500350135023503350435053506350735083509351035113512351335143515351635173518351935203521352235233524352535263527352835293530353135323533353435353536353735383539354035413542354335443545354635473548354935503551355235533554355535563557355835593560356135623563356435653566356735683569357035713572357335743575357635773578357935803581358235833584358535863587358835893590359135923593359435953596359735983599360036013602360336043605360636073608360936103611361236133614361536163617361836193620362136223623362436253626362736283629363036313632363336343635363636373638363936403641364236433644364536463647364836493650365136523653365436553656365736583659366036613662366336643665366636673668366936703671367236733674367536763677367836793680368136823683368436853686368736883689369036913692369336943695369636973698369937003701370237033704370537063707370837093710371137123713371437153716371737183719372037213722372337243725372637273728372937303731373237333734373537363737373837393740374137423743374437453746374737483749375037513752375337543755375637573758375937603761376237633764376537663767376837693770377137723773377437753776377737783779378037813782378337843785378637873788378937903791379237933794379537963797379837993800380138023803380438053806380738083809381038113812381338143815381638173818381938203821382238233824382538263827382838293830383138323833383438353836383738383839384038413842384338443845384638473848384938503851385238533854385538563857385838593860386138623863386438653866386738683869387038713872387338743875387638773878387938803881388238833884388538863887388838893890389138923893389438953896389738983899390039013902390339043905390639073908390939103911391239133914391539163917391839193920392139223923392439253926392739283929393039313932393339343935393639373938393939403941394239433944394539463947394839493950395139523953395439553956395739583959396039613962396339643965396639673968396939703971397239733974397539763977397839793980398139823983398439853986398739883989399039913992399339943995399639973998399940004001400240034004400540064007400840094010401140124013401440154016401740184019402040214022402340244025402640274028402940304031403240334034403540364037403840394040404140424043404440454046404740484049405040514052405340544055405640574058405940604061406240634064406540664067406840694070407140724073407440754076407740784079408040814082408340844085408640874088408940904091409240934094409540964097409840994100410141024103410441054106410741084109411041114112411341144115411641174118411941204121412241234124412541264127412841294130413141324133413441354136413741384139414041414142414341444145414641474148414941504151415241534154415541564157415841594160416141624163416441654166416741684169417041714172417341744175417641774178417941804181418241834184418541864187418841894190419141924193419441954196419741984199420042014202420342044205420642074208420942104211421242134214421542164217421842194220422142224223422442254226422742284229423042314232423342344235423642374238423942404241424242434244424542464247424842494250425142524253425442554256425742584259426042614262426342644265426642674268426942704271427242734274427542764277427842794280428142824283428442854286428742884289429042914292429342944295429642974298429943004301430243034304430543064307430843094310431143124313431443154316431743184319432043214322432343244325432643274328432943304331433243334334433543364337433843394340434143424343434443454346434743484349435043514352435343544355435643574358435943604361436243634364436543664367436843694370437143724373437443754376437743784379438043814382438343844385438643874388438943904391439243934394439543964397439843994400440144024403440444054406440744084409441044114412441344144415441644174418441944204421442244234424442544264427442844294430443144324433443444354436443744384439444044414442444344444445444644474448444944504451445244534454445544564457445844594460446144624463446444654466446744684469447044714472447344744475447644774478447944804481448244834484448544864487448844894490449144924493449444954496449744984499450045014502450345044505450645074508450945104511451245134514451545164517451845194520452145224523452445254526452745284529453045314532453345344535453645374538453945404541454245434544454545464547454845494550455145524553455445554556455745584559456045614562456345644565456645674568456945704571457245734574457545764577457845794580458145824583458445854586458745884589459045914592459345944595459645974598459946004601460246034604460546064607460846094610461146124613461446154616461746184619462046214622462346244625462646274628462946304631463246334634463546364637463846394640464146424643464446454646464746484649465046514652465346544655465646574658465946604661466246634664466546664667466846694670467146724673467446754676467746784679468046814682468346844685468646874688468946904691469246934694469546964697469846994700470147024703470447054706470747084709471047114712471347144715471647174718471947204721472247234724472547264727472847294730473147324733473447354736473747384739474047414742474347444745474647474748474947504751475247534754475547564757475847594760476147624763476447654766476747684769477047714772477347744775477647774778477947804781478247834784478547864787478847894790479147924793479447954796479747984799480048014802480348044805480648074808480948104811481248134814481548164817481848194820482148224823482448254826482748284829483048314832483348344835483648374838483948404841484248434844484548464847484848494850485148524853485448554856485748584859486048614862486348644865486648674868486948704871487248734874487548764877487848794880488148824883488448854886488748884889489048914892489348944895489648974898489949004901490249034904490549064907490849094910491149124913491449154916491749184919492049214922492349244925492649274928492949304931493249334934493549364937493849394940494149424943494449454946494749484949495049514952495349544955495649574958495949604961496249634964496549664967496849694970497149724973497449754976497749784979498049814982498349844985498649874988498949904991499249934994499549964997499849995000500150025003500450055006500750085009501050115012501350145015501650175018501950205021502250235024502550265027502850295030503150325033503450355036503750385039504050415042504350445045504650475048504950505051505250535054505550565057505850595060506150625063506450655066506750685069507050715072507350745075507650775078507950805081508250835084508550865087508850895090509150925093509450955096509750985099510051015102510351045105510651075108510951105111511251135114511551165117511851195120512151225123512451255126512751285129513051315132513351345135513651375138513951405141514251435144514551465147514851495150515151525153515451555156515751585159516051615162516351645165516651675168516951705171517251735174517551765177517851795180518151825183518451855186518751885189519051915192519351945195519651975198519952005201520252035204520552065207520852095210521152125213521452155216521752185219522052215222522352245225522652275228522952305231523252335234523552365237523852395240524152425243524452455246524752485249525052515252525352545255525652575258525952605261526252635264526552665267526852695270527152725273527452755276527752785279528052815282528352845285528652875288528952905291529252935294529552965297529852995300530153025303530453055306530753085309531053115312531353145315531653175318531953205321532253235324532553265327532853295330533153325333533453355336533753385339534053415342534353445345534653475348534953505351535253535354535553565357535853595360536153625363536453655366536753685369537053715372537353745375537653775378537953805381538253835384538553865387538853895390539153925393539453955396539753985399540054015402540354045405540654075408540954105411541254135414541554165417541854195420542154225423542454255426542754285429543054315432543354345435543654375438543954405441544254435444544554465447544854495450545154525453545454555456545754585459546054615462546354645465546654675468546954705471547254735474547554765477547854795480548154825483548454855486548754885489549054915492549354945495549654975498549955005501550255035504550555065507550855095510551155125513551455155516551755185519552055215522552355245525552655275528552955305531553255335534553555365537553855395540554155425543554455455546554755485549555055515552555355545555555655575558555955605561556255635564556555665567556855695570557155725573557455755576557755785579558055815582558355845585558655875588558955905591559255935594559555965597559855995600560156025603560456055606560756085609561056115612561356145615561656175618561956205621562256235624562556265627562856295630563156325633563456355636563756385639564056415642564356445645564656475648564956505651565256535654565556565657565856595660566156625663566456655666566756685669567056715672567356745675567656775678567956805681568256835684568556865687568856895690569156925693569456955696569756985699570057015702570357045705570657075708570957105711571257135714571557165717571857195720572157225723572457255726572757285729573057315732573357345735573657375738573957405741574257435744574557465747574857495750575157525753575457555756575757585759576057615762576357645765576657675768576957705771577257735774577557765777577857795780578157825783578457855786578757885789579057915792579357945795579657975798579958005801580258035804580558065807580858095810581158125813581458155816581758185819582058215822582358245825582658275828582958305831583258335834583558365837583858395840584158425843584458455846584758485849585058515852585358545855585658575858585958605861586258635864586558665867586858695870587158725873587458755876587758785879588058815882 |
- /**
- * @license Highcharts JS v9.1.1 (2021-06-04)
- *
- * Annotations module
- *
- * (c) 2009-2021 Torstein Honsi
- *
- * License: www.highcharts.com/license
- */
- 'use strict';
- (function (factory) {
- if (typeof module === 'object' && module.exports) {
- factory['default'] = factory;
- module.exports = factory;
- } else if (typeof define === 'function' && define.amd) {
- define('highcharts/modules/annotations', ['highcharts'], function (Highcharts) {
- factory(Highcharts);
- factory.Highcharts = Highcharts;
- return factory;
- });
- } else {
- factory(typeof Highcharts !== 'undefined' ? Highcharts : undefined);
- }
- }(function (Highcharts) {
- var _modules = Highcharts ? Highcharts._modules : {};
- function _registerModule(obj, path, args, fn) {
- if (!obj.hasOwnProperty(path)) {
- obj[path] = fn.apply(null, args);
- }
- }
- _registerModule(_modules, 'Extensions/Annotations/Mixins/EventEmitterMixin.js', [_modules['Core/Globals.js'], _modules['Core/Utilities.js']], function (H, U) {
- /* *
- *
- * !!!!!!! SOURCE GETS TRANSPILED BY TYPESCRIPT. EDIT TS FILE ONLY. !!!!!!!
- *
- * */
- var addEvent = U.addEvent,
- fireEvent = U.fireEvent,
- objectEach = U.objectEach,
- pick = U.pick,
- removeEvent = U.removeEvent;
- /* eslint-disable valid-jsdoc */
- /**
- * It provides methods for:
- * - adding and handling DOM events and a drag event,
- * - mapping a mouse move event to the distance between two following events.
- * The units of the distance are specific to a transformation,
- * e.g. for rotation they are radians, for scaling they are scale factors.
- *
- * @private
- * @mixin
- * @memberOf Annotation
- */
- var eventEmitterMixin = {
- /**
- * Add emitter events.
- */
- addEvents: function () {
- var emitter = this,
- addMouseDownEvent = function (element) {
- addEvent(element,
- H.isTouchDevice ? 'touchstart' : 'mousedown',
- function (e) {
- emitter.onMouseDown(e);
- }, { passive: false });
- };
- addMouseDownEvent(this.graphic.element);
- (emitter.labels || []).forEach(function (label) {
- if (label.options.useHTML && label.graphic.text) {
- // Mousedown event bound to HTML element (#13070).
- addMouseDownEvent(label.graphic.text.element);
- }
- });
- objectEach(emitter.options.events, function (event, type) {
- var eventHandler = function (e) {
- if (type !== 'click' || !emitter.cancelClick) {
- event.call(emitter,
- emitter.chart.pointer.normalize(e),
- emitter.target);
- }
- };
- if ((emitter.nonDOMEvents || []).indexOf(type) === -1) {
- emitter.graphic.on(type, eventHandler);
- }
- else {
- addEvent(emitter, type, eventHandler, { passive: false });
- }
- });
- if (emitter.options.draggable) {
- addEvent(emitter, 'drag', emitter.onDrag);
- if (!emitter.graphic.renderer.styledMode) {
- var cssPointer_1 = {
- cursor: {
- x: 'ew-resize',
- y: 'ns-resize',
- xy: 'move'
- }[emitter.options.draggable]
- };
- emitter.graphic.css(cssPointer_1);
- (emitter.labels || []).forEach(function (label) {
- if (label.options.useHTML && label.graphic.text) {
- label.graphic.text.css(cssPointer_1);
- }
- });
- }
- }
- if (!emitter.isUpdating) {
- fireEvent(emitter, 'add');
- }
- },
- /**
- * Remove emitter document events.
- */
- removeDocEvents: function () {
- if (this.removeDrag) {
- this.removeDrag = this.removeDrag();
- }
- if (this.removeMouseUp) {
- this.removeMouseUp = this.removeMouseUp();
- }
- },
- /**
- * Mouse down handler.
- */
- onMouseDown: function (e) {
- var emitter = this,
- pointer = emitter.chart.pointer,
- prevChartX,
- prevChartY;
- if (e.preventDefault) {
- e.preventDefault();
- }
- // On right click, do nothing:
- if (e.button === 2) {
- return;
- }
- e = pointer.normalize(e);
- prevChartX = e.chartX;
- prevChartY = e.chartY;
- emitter.cancelClick = false;
- emitter.chart.hasDraggedAnnotation = true;
- emitter.removeDrag = addEvent(H.doc, H.isTouchDevice ? 'touchmove' : 'mousemove', function (e) {
- emitter.hasDragged = true;
- e = pointer.normalize(e);
- e.prevChartX = prevChartX;
- e.prevChartY = prevChartY;
- fireEvent(emitter, 'drag', e);
- prevChartX = e.chartX;
- prevChartY = e.chartY;
- }, H.isTouchDevice ? { passive: false } : void 0);
- emitter.removeMouseUp = addEvent(H.doc, H.isTouchDevice ? 'touchend' : 'mouseup', function (e) {
- emitter.cancelClick = emitter.hasDragged;
- emitter.hasDragged = false;
- emitter.chart.hasDraggedAnnotation = false;
- // ControlPoints vs Annotation:
- fireEvent(pick(emitter.target, emitter), 'afterUpdate');
- emitter.onMouseUp(e);
- }, H.isTouchDevice ? { passive: false } : void 0);
- },
- /**
- * Mouse up handler.
- */
- onMouseUp: function (_e) {
- var chart = this.chart,
- annotation = this.target || this,
- annotationsOptions = chart.options.annotations,
- index = chart.annotations.indexOf(annotation);
- this.removeDocEvents();
- annotationsOptions[index] = annotation.options;
- },
- /**
- * Drag and drop event. All basic annotations should share this
- * capability as well as the extended ones.
- */
- onDrag: function (e) {
- if (this.chart.isInsidePlot(e.chartX - this.chart.plotLeft, e.chartY - this.chart.plotTop, {
- visiblePlotOnly: true
- })) {
- var translation_1 = this.mouseMoveToTranslation(e);
- if (this.options.draggable === 'x') {
- translation_1.y = 0;
- }
- if (this.options.draggable === 'y') {
- translation_1.x = 0;
- }
- if (this.points.length) {
- this.translate(translation_1.x, translation_1.y);
- }
- else {
- this.shapes.forEach(function (shape) {
- shape.translate(translation_1.x, translation_1.y);
- });
- this.labels.forEach(function (label) {
- label.translate(translation_1.x, translation_1.y);
- });
- }
- this.redraw(false);
- }
- },
- /**
- * Map mouse move event to the radians.
- */
- mouseMoveToRadians: function (e, cx, cy) {
- var prevDy = e.prevChartY - cy,
- prevDx = e.prevChartX - cx,
- dy = e.chartY - cy,
- dx = e.chartX - cx,
- temp;
- if (this.chart.inverted) {
- temp = prevDx;
- prevDx = prevDy;
- prevDy = temp;
- temp = dx;
- dx = dy;
- dy = temp;
- }
- return Math.atan2(dy, dx) - Math.atan2(prevDy, prevDx);
- },
- /**
- * Map mouse move event to the distance between two following events.
- */
- mouseMoveToTranslation: function (e) {
- var dx = e.chartX - e.prevChartX,
- dy = e.chartY - e.prevChartY,
- temp;
- if (this.chart.inverted) {
- temp = dy;
- dy = dx;
- dx = temp;
- }
- return {
- x: dx,
- y: dy
- };
- },
- /**
- * Map mouse move to the scale factors.
- *
- * @param {Object} e event
- * @param {number} cx center x
- * @param {number} cy center y
- **/
- mouseMoveToScale: function (e, cx, cy) {
- var prevDx = e.prevChartX - cx,
- prevDy = e.prevChartY - cy,
- dx = e.chartX - cx,
- dy = e.chartY - cy,
- sx = (dx || 1) / (prevDx || 1),
- sy = (dy || 1) / (prevDy || 1),
- temp;
- if (this.chart.inverted) {
- temp = sy;
- sy = sx;
- sx = temp;
- }
- return {
- x: sx,
- y: sy
- };
- },
- /**
- * Destroy the event emitter.
- */
- destroy: function () {
- this.removeDocEvents();
- removeEvent(this);
- this.hcEvents = null;
- }
- };
- return eventEmitterMixin;
- });
- _registerModule(_modules, 'Extensions/Annotations/ControlPoint.js', [_modules['Core/Utilities.js'], _modules['Extensions/Annotations/Mixins/EventEmitterMixin.js']], function (U, eventEmitterMixin) {
- /* *
- *
- * !!!!!!! SOURCE GETS TRANSPILED BY TYPESCRIPT. EDIT TS FILE ONLY. !!!!!!!
- *
- * */
- /**
- * Callback to modify annotation's possitioner controls.
- *
- * @callback Highcharts.AnnotationControlPointPositionerFunction
- * @param {Highcharts.AnnotationControlPoint} this
- * @param {Highcharts.AnnotationControllable} target
- * @return {Highcharts.PositionObject}
- */
- var extend = U.extend,
- merge = U.merge,
- pick = U.pick;
- /* eslint-disable no-invalid-this, valid-jsdoc */
- /**
- * A control point class which is a connection between controllable
- * transform methods and a user actions.
- *
- * @requires modules/annotations
- *
- * @class
- * @name Highcharts.AnnotationControlPoint
- *
- * @hideconstructor
- *
- * @param {Highcharts.Chart} chart
- * A chart instance.
- *
- * @param {Highcharts.AnnotationControllable} target
- * A controllable instance which is a target for a control point.
- *
- * @param {Highcharts.AnnotationControlPointOptionsObject} options
- * An options object.
- *
- * @param {number} [index]
- * Point index.
- */
- var ControlPoint = /** @class */ (function () {
- function ControlPoint(chart, target, options, index) {
- /**
- *
- * Properties
- *
- */
- this.addEvents = eventEmitterMixin.addEvents;
- this.graphic = void 0;
- this.mouseMoveToRadians = eventEmitterMixin.mouseMoveToRadians;
- this.mouseMoveToScale = eventEmitterMixin.mouseMoveToScale;
- this.mouseMoveToTranslation = eventEmitterMixin.mouseMoveToTranslation;
- this.onDrag = eventEmitterMixin.onDrag;
- this.onMouseDown = eventEmitterMixin.onMouseDown;
- this.onMouseUp = eventEmitterMixin.onMouseUp;
- this.removeDocEvents = eventEmitterMixin.removeDocEvents;
- /**
- *
- * Functions
- *
- */
- /**
- * List of events for `anntation.options.events` that should not be
- * added to `annotation.graphic` but to the `annotation`.
- * @private
- * @name Highcharts.AnnotationControlPoint#nonDOMEvents
- * @type {Array<string>}
- */
- this.nonDOMEvents = ['drag'];
- this.chart = chart;
- this.target = target;
- this.options = options;
- this.index = pick(options.index, index);
- }
- /**
- * Set the visibility of the control point.
- *
- * @function Highcharts.AnnotationControlPoint#setVisibility
- *
- * @param {boolean} visible
- * Visibility of the control point.
- *
- * @return {void}
- */
- ControlPoint.prototype.setVisibility = function (visible) {
- this.graphic.attr('visibility', visible ? 'visible' : 'hidden');
- this.options.visible = visible;
- };
- /**
- * Render the control point.
- * @private
- */
- ControlPoint.prototype.render = function () {
- var chart = this.chart,
- options = this.options;
- this.graphic = chart.renderer
- .symbol(options.symbol, 0, 0, options.width, options.height)
- .add(chart.controlPointsGroup)
- .css(options.style);
- this.setVisibility(options.visible);
- // npm test -- --tests "highcharts/annotations-advanced/*"
- this.addEvents();
- };
- /**
- * Redraw the control point.
- * @private
- * @param {boolean} [animation]
- */
- ControlPoint.prototype.redraw = function (animation) {
- this.graphic[animation ? 'animate' : 'attr'](this.options.positioner.call(this, this.target));
- };
- /**
- * Destroy the control point.
- * @private
- */
- ControlPoint.prototype.destroy = function () {
- eventEmitterMixin.destroy.call(this);
- if (this.graphic) {
- this.graphic = this.graphic.destroy();
- }
- this.chart = null;
- this.target = null;
- this.options = null;
- };
- /**
- * Update the control point.
- *
- * @function Highcharts.AnnotationControlPoint#update
- *
- * @param {Partial<Highcharts.AnnotationControlPointOptionsObject>} userOptions
- * New options for the control point.
- *
- * @return {void}
- */
- ControlPoint.prototype.update = function (userOptions) {
- var chart = this.chart,
- target = this.target,
- index = this.index,
- options = merge(true,
- this.options,
- userOptions);
- this.destroy();
- this.constructor(chart, target, options, index);
- this.render(chart.controlPointsGroup);
- this.redraw();
- };
- return ControlPoint;
- }());
- return ControlPoint;
- });
- _registerModule(_modules, 'Extensions/Annotations/MockPoint.js', [_modules['Core/Series/Series.js'], _modules['Core/Utilities.js'], _modules['Core/Axis/Axis.js']], function (Series, U, Axis) {
- /* *
- *
- * !!!!!!! SOURCE GETS TRANSPILED BY TYPESCRIPT. EDIT TS FILE ONLY. !!!!!!!
- *
- * */
- /**
- * @private
- * @interface Highcharts.AnnotationMockLabelOptionsObject
- */ /**
- * Point instance of the point.
- * @name Highcharts.AnnotationMockLabelOptionsObject#point
- * @type {Highcharts.AnnotationMockPoint}
- */ /**
- * X value translated to x axis scale.
- * @name Highcharts.AnnotationMockLabelOptionsObject#x
- * @type {number|null}
- */ /**
- * Y value translated to y axis scale.
- * @name Highcharts.AnnotationMockLabelOptionsObject#y
- * @type {number|null}
- */
- /**
- * A mock series instance imitating a real series from a real point.
- * @private
- * @interface Highcharts.AnnotationMockSeries
- */ /**
- * Whether a series is visible.
- * @name Highcharts.AnnotationMockSeries#visible
- * @type {boolean}
- */ /**
- * A chart instance.
- * @name Highcharts.AnnotationMockSeries#chart
- * @type {Highcharts.Chart}
- */ /**
- * @name Highcharts.AnnotationMockSeries#getPlotBox
- * @type {Function}
- */
- /**
- * Indicates if this is a mock point for an annotation.
- * @name Highcharts.Point#mock
- * @type {boolean|undefined}
- */
- var defined = U.defined,
- extend = U.extend,
- fireEvent = U.fireEvent;
- /* eslint-disable no-invalid-this, valid-jsdoc */
- /**
- * A trimmed point object which imitates {@link Highchart.Point} class. It is
- * created when there is a need of pointing to some chart's position using axis
- * values or pixel values
- *
- * @requires modules/annotations
- *
- * @private
- * @class
- * @name Highcharts.AnnotationMockPoint
- *
- * @hideconstructor
- *
- * @param {Highcharts.Chart} chart
- * The chart instance.
- *
- * @param {Highcharts.AnnotationControllable|null} target
- * The related controllable.
- *
- * @param {Highcharts.AnnotationMockPointOptionsObject|Function} options
- * The options object.
- */
- var MockPoint = /** @class */ (function () {
- function MockPoint(chart, target, options) {
- this.isInside = void 0;
- this.negative = void 0;
- this.plotX = void 0;
- this.plotY = void 0;
- this.ttBelow = void 0;
- this.x = void 0;
- this.y = void 0;
- /* *
- *
- * Functions
- *
- * */
- /**
- * A flag indicating that a point is not the real one.
- *
- * @type {boolean}
- * @default true
- */
- this.mock = true;
- /**
- * A mock series instance imitating a real series from a real point.
- *
- * @name Annotation.AnnotationMockPoint#series
- * @type {Highcharts.AnnotationMockSeries}
- */
- this.series = {
- visible: true,
- chart: chart,
- getPlotBox: Series.prototype.getPlotBox
- };
- /**
- * @name Annotation.AnnotationMockPoint#target
- * @type {Highcharts.AnnotationControllable|null}
- */
- this.target = target || null;
- /**
- * Options for the mock point.
- *
- * @name Annotation.AnnotationMockPoint#options
- * @type {Highcharts.AnnotationsMockPointOptionsObject}
- */
- this.options = options;
- /**
- * If an xAxis is set it represents the point's value in terms of the
- * xAxis.
- *
- * @name Annotation.AnnotationMockPoint#x
- * @type {number|undefined}
- */
- /**
- * If an yAxis is set it represents the point's value in terms of the
- * yAxis.
- *
- * @name Annotation.AnnotationMockPoint#y
- * @type {number|undefined}
- */
- /**
- * It represents the point's pixel x coordinate relative to its plot
- * box.
- *
- * @name Annotation.AnnotationMockPoint#plotX
- * @type {number|undefined}
- */
- /**
- * It represents the point's pixel y position relative to its plot box.
- *
- * @name Annotation.AnnotationMockPoint#plotY
- * @type {number|undefined}
- */
- /**
- * Whether the point is inside the plot box.
- *
- * @name Annotation.AnnotationMockPoint#isInside
- * @type {boolean|undefined}
- */
- this.applyOptions(this.getOptions());
- }
- /**
- * Create a mock point from a real Highcharts point.
- *
- * @private
- * @static
- *
- * @param {Highcharts.Point} point
- *
- * @return {Highcharts.AnnotationMockPoint}
- * A mock point instance.
- */
- MockPoint.fromPoint = function (point) {
- return new MockPoint(point.series.chart, null, {
- x: point.x,
- y: point.y,
- xAxis: point.series.xAxis,
- yAxis: point.series.yAxis
- });
- };
- /**
- * Get the pixel position from the point like object.
- *
- * @private
- * @static
- *
- * @param {Highcharts.AnnotationPointType} point
- *
- * @param {boolean} [paneCoordinates]
- * whether the pixel position should be relative
- *
- * @return {Highcharts.PositionObject} pixel position
- */
- MockPoint.pointToPixels = function (point, paneCoordinates) {
- var series = point.series,
- chart = series.chart,
- x = point.plotX,
- y = point.plotY,
- plotBox;
- if (chart.inverted) {
- if (point.mock) {
- x = point.plotY;
- y = point.plotX;
- }
- else {
- x = chart.plotWidth - point.plotY;
- y = chart.plotHeight - point.plotX;
- }
- }
- if (series && !paneCoordinates) {
- plotBox = series.getPlotBox();
- x += plotBox.translateX;
- y += plotBox.translateY;
- }
- return {
- x: x,
- y: y
- };
- };
- /**
- * Get fresh mock point options from the point like object.
- *
- * @private
- * @static
- *
- * @param {Highcharts.AnnotationPointType} point
- *
- * @return {Highcharts.AnnotationMockPointOptionsObject}
- * A mock point's options.
- */
- MockPoint.pointToOptions = function (point) {
- return {
- x: point.x,
- y: point.y,
- xAxis: point.series.xAxis,
- yAxis: point.series.yAxis
- };
- };
- /**
- * Check if the point has dynamic options.
- * @private
- * @return {boolean}
- * A positive flag if the point has dynamic options.
- */
- MockPoint.prototype.hasDynamicOptions = function () {
- return typeof this.options === 'function';
- };
- /**
- * Get the point's options.
- * @private
- * @return {Highcharts.AnnotationMockPointOptionsObject}
- * The mock point's options.
- */
- MockPoint.prototype.getOptions = function () {
- return this.hasDynamicOptions() ?
- this.options(this.target) :
- this.options;
- };
- /**
- * Apply options for the point.
- * @private
- * @param {Highcharts.AnnotationMockPointOptionsObject} options
- */
- MockPoint.prototype.applyOptions = function (options) {
- this.command = options.command;
- this.setAxis(options, 'x');
- this.setAxis(options, 'y');
- this.refresh();
- };
- /**
- * Set x or y axis.
- * @private
- * @param {Highcharts.AnnotationMockPointOptionsObject} options
- * @param {string} xOrY
- * 'x' or 'y' string literal
- */
- MockPoint.prototype.setAxis = function (options, xOrY) {
- var axisName = (xOrY + 'Axis'),
- axisOptions = options[axisName],
- chart = this.series.chart;
- this.series[axisName] =
- axisOptions instanceof Axis ?
- axisOptions :
- defined(axisOptions) ?
- (chart[axisName][axisOptions] ||
- chart.get(axisOptions)) :
- null;
- };
- /**
- * Transform the mock point to an anchor (relative position on the chart).
- * @private
- * @return {Array<number>}
- * A quadruple of numbers which denotes x, y, width and height of the box
- **/
- MockPoint.prototype.toAnchor = function () {
- var anchor = [this.plotX,
- this.plotY, 0, 0];
- if (this.series.chart.inverted) {
- anchor[0] = this.plotY;
- anchor[1] = this.plotX;
- }
- return anchor;
- };
- /**
- * Returns a label config object - the same as
- * Highcharts.Point.prototype.getLabelConfig
- * @private
- * @return {Highcharts.AnnotationMockLabelOptionsObject} the point's label config
- */
- MockPoint.prototype.getLabelConfig = function () {
- return {
- x: this.x,
- y: this.y,
- point: this
- };
- };
- /**
- * Check if the point is inside its pane.
- * @private
- * @return {boolean} A flag indicating whether the point is inside the pane.
- */
- MockPoint.prototype.isInsidePlot = function () {
- var plotX = this.plotX,
- plotY = this.plotY,
- xAxis = this.series.xAxis,
- yAxis = this.series.yAxis,
- e = {
- x: plotX,
- y: plotY,
- isInsidePlot: true
- };
- if (xAxis) {
- e.isInsidePlot = defined(plotX) && plotX >= 0 && plotX <= xAxis.len;
- }
- if (yAxis) {
- e.isInsidePlot =
- e.isInsidePlot &&
- defined(plotY) &&
- plotY >= 0 && plotY <= yAxis.len;
- }
- fireEvent(this.series.chart, 'afterIsInsidePlot', e);
- return e.isInsidePlot;
- };
- /**
- * Refresh point values and coordinates based on its options.
- * @private
- */
- MockPoint.prototype.refresh = function () {
- var series = this.series,
- xAxis = series.xAxis,
- yAxis = series.yAxis,
- options = this.getOptions();
- if (xAxis) {
- this.x = options.x;
- this.plotX = xAxis.toPixels(options.x, true);
- }
- else {
- this.x = null;
- this.plotX = options.x;
- }
- if (yAxis) {
- this.y = options.y;
- this.plotY = yAxis.toPixels(options.y, true);
- }
- else {
- this.y = null;
- this.plotY = options.y;
- }
- this.isInside = this.isInsidePlot();
- };
- /**
- * Translate the point.
- *
- * @private
- *
- * @param {number|undefined} cx
- * Origin x transformation.
- *
- * @param {number|undefined} cy
- * Origin y transformation.
- *
- * @param {number} dx
- * Translation for x coordinate.
- *
- * @param {number} dy
- * Translation for y coordinate.
- **/
- MockPoint.prototype.translate = function (_cx, _cy, dx, dy) {
- if (!this.hasDynamicOptions()) {
- this.plotX += dx;
- this.plotY += dy;
- this.refreshOptions();
- }
- };
- /**
- * Scale the point.
- *
- * @private
- *
- * @param {number} cx
- * Origin x transformation.
- *
- * @param {number} cy
- * Origin y transformation.
- *
- * @param {number} sx
- * Scale factor x.
- *
- * @param {number} sy
- * Scale factor y.
- */
- MockPoint.prototype.scale = function (cx, cy, sx, sy) {
- if (!this.hasDynamicOptions()) {
- var x = this.plotX * sx,
- y = this.plotY * sy,
- tx = (1 - sx) * cx,
- ty = (1 - sy) * cy;
- this.plotX = tx + x;
- this.plotY = ty + y;
- this.refreshOptions();
- }
- };
- /**
- * Rotate the point.
- * @private
- * @param {number} cx origin x rotation
- * @param {number} cy origin y rotation
- * @param {number} radians
- */
- MockPoint.prototype.rotate = function (cx, cy, radians) {
- if (!this.hasDynamicOptions()) {
- var cos = Math.cos(radians),
- sin = Math.sin(radians),
- x = this.plotX,
- y = this.plotY,
- tx = void 0,
- ty = void 0;
- x -= cx;
- y -= cy;
- tx = x * cos - y * sin;
- ty = x * sin + y * cos;
- this.plotX = tx + cx;
- this.plotY = ty + cy;
- this.refreshOptions();
- }
- };
- /**
- * Refresh point options based on its plot coordinates.
- * @private
- */
- MockPoint.prototype.refreshOptions = function () {
- var series = this.series,
- xAxis = series.xAxis,
- yAxis = series.yAxis;
- this.x = this.options.x = xAxis ?
- this.options.x = xAxis.toValue(this.plotX, true) :
- this.plotX;
- this.y = this.options.y = yAxis ?
- yAxis.toValue(this.plotY, true) :
- this.plotY;
- };
- return MockPoint;
- }());
- return MockPoint;
- });
- _registerModule(_modules, 'Extensions/Annotations/Mixins/ControllableMixin.js', [_modules['Extensions/Annotations/ControlPoint.js'], _modules['Extensions/Annotations/MockPoint.js'], _modules['Core/Tooltip.js'], _modules['Core/Utilities.js']], function (ControlPoint, MockPoint, Tooltip, U) {
- /* *
- *
- * !!!!!!! SOURCE GETS TRANSPILED BY TYPESCRIPT. EDIT TS FILE ONLY. !!!!!!!
- *
- * */
- var isObject = U.isObject,
- isString = U.isString,
- merge = U.merge,
- splat = U.splat;
- /**
- * An object which denots a controllable's anchor positions - relative and
- * absolute.
- *
- * @private
- * @interface Highcharts.AnnotationAnchorObject
- */ /**
- * Relative to the plot area position
- * @name Highcharts.AnnotationAnchorObject#relativePosition
- * @type {Highcharts.BBoxObject}
- */ /**
- * Absolute position
- * @name Highcharts.AnnotationAnchorObject#absolutePosition
- * @type {Highcharts.BBoxObject}
- */
- /**
- * @interface Highcharts.AnnotationControllable
- */ /**
- * @name Highcharts.AnnotationControllable#annotation
- * @type {Highcharts.Annotation}
- */ /**
- * @name Highcharts.AnnotationControllable#chart
- * @type {Highcharts.Chart}
- */ /**
- * @name Highcharts.AnnotationControllable#collection
- * @type {string}
- */ /**
- * @private
- * @name Highcharts.AnnotationControllable#controlPoints
- * @type {Array<Highcharts.AnnotationControlPoint>}
- */ /**
- * @name Highcharts.AnnotationControllable#points
- * @type {Array<Highcharts.Point>}
- */
- /* eslint-disable no-invalid-this, valid-jsdoc */
- /**
- * It provides methods for handling points, control points
- * and points transformations.
- *
- * @private
- * @mixin
- * @name Highcharts.AnnotationControllableMixin
- */
- var controllableMixin = {
- /**
- * Init the controllable
- */
- init: function (annotation,
- options,
- index) {
- this.annotation = annotation;
- this.chart = annotation.chart;
- this.options = options;
- this.points = [];
- this.controlPoints = [];
- this.index = index;
- this.linkPoints();
- this.addControlPoints();
- },
- /**
- * Redirect attr usage on the controllable graphic element.
- */
- attr: function () {
- this.graphic.attr.apply(this.graphic, arguments);
- },
- /**
- * Get the controllable's points options.
- *
- * @return {Array<Highcharts.PointOptionsObject>}
- * An array of points' options.
- */
- getPointsOptions: function () {
- var options = this.options;
- return (options.points || (options.point && splat(options.point)));
- },
- /**
- * Utility function for mapping item's options
- * to element's attribute
- *
- * @param {Highcharts.AnnotationsLabelsOptions|Highcharts.AnnotationsShapesOptions} options
- *
- * @return {Highcharts.SVGAttributes}
- * Mapped options.
- */
- attrsFromOptions: function (options) {
- var map = this.constructor.attrsMap,
- attrs = {},
- key,
- mappedKey,
- styledMode = this.chart.styledMode;
- for (key in options) { // eslint-disable-line guard-for-in
- mappedKey = map[key];
- if (mappedKey &&
- (!styledMode ||
- ['fill', 'stroke', 'stroke-width']
- .indexOf(mappedKey) === -1)) {
- attrs[mappedKey] = options[key];
- }
- }
- return attrs;
- },
- /**
- * Returns object which denotes anchor position - relative and absolute.
- *
- * @param {Highcharts.AnnotationPointType} point
- * A point like object.
- *
- * @return {Highcharts.AnnotationAnchorObject} a controllable anchor
- */
- anchor: function (point) {
- var plotBox = point.series.getPlotBox(),
- chart = point.series.chart,
- box = point.mock ?
- point.toAnchor() :
- Tooltip.prototype.getAnchor.call({
- chart: point.series.chart
- },
- point),
- anchor = {
- x: box[0] + (this.options.x || 0),
- y: box[1] + (this.options.y || 0),
- height: box[2] || 0,
- width: box[3] || 0
- };
- return {
- relativePosition: anchor,
- absolutePosition: merge(anchor, {
- x: anchor.x + (point.mock ? plotBox.translateX : chart.plotLeft),
- y: anchor.y + (point.mock ? plotBox.translateY : chart.plotTop)
- })
- };
- },
- /**
- * Map point's options to a point-like object.
- *
- * @param {string|Function|Highcharts.AnnotationMockPointOptionsObject|Highcharts.AnnotationPointType} pointOptions
- * Point's options.
- *
- * @param {Highcharts.AnnotationPointType} point
- * A point-like instance.
- *
- * @return {Highcharts.AnnotationPointType|null}
- * if the point is found/set returns this point, otherwise null
- */
- point: function (pointOptions, point) {
- if (pointOptions && pointOptions.series) {
- return pointOptions;
- }
- if (!point || point.series === null) {
- if (isObject(pointOptions)) {
- point = new MockPoint(this.chart, this, pointOptions);
- }
- else if (isString(pointOptions)) {
- point = this.chart.get(pointOptions) || null;
- }
- else if (typeof pointOptions === 'function') {
- var pointConfig = pointOptions.call(point,
- this);
- point = pointConfig.series ?
- pointConfig :
- new MockPoint(this.chart, this, pointOptions);
- }
- }
- return point;
- },
- /**
- * Find point-like objects based on points options.
- *
- * @return {Array<Annotation.PointLike>} an array of point-like objects
- */
- linkPoints: function () {
- var pointsOptions = this.getPointsOptions(),
- points = this.points,
- len = (pointsOptions && pointsOptions.length) || 0,
- i,
- point;
- for (i = 0; i < len; i++) {
- point = this.point(pointsOptions[i], points[i]);
- if (!point) {
- points.length = 0;
- return;
- }
- if (point.mock) {
- point.refresh();
- }
- points[i] = point;
- }
- return points;
- },
- /**
- * Add control points to a controllable.
- */
- addControlPoints: function () {
- var controlPointsOptions = this.options.controlPoints;
- (controlPointsOptions || []).forEach(function (controlPointOptions, i) {
- var options = merge(this.options.controlPointOptions,
- controlPointOptions);
- if (!options.index) {
- options.index = i;
- }
- controlPointsOptions[i] = options;
- this.controlPoints.push(new ControlPoint(this.chart, this, options));
- }, this);
- },
- /**
- * Check if a controllable should be rendered/redrawn.
- *
- * @return {boolean}
- * Whether a controllable should be drawn.
- */
- shouldBeDrawn: function () {
- return Boolean(this.points.length);
- },
- /**
- * Render a controllable.
- */
- render: function (_parentGroup) {
- this.controlPoints.forEach(function (controlPoint) {
- controlPoint.render();
- });
- },
- /**
- * Redraw a controllable.
- *
- * @param {boolean} [animation]
- */
- redraw: function (animation) {
- this.controlPoints.forEach(function (controlPoint) {
- controlPoint.redraw(animation);
- });
- },
- /**
- * Transform a controllable with a specific transformation.
- *
- * @param {string} transformation a transformation name
- * @param {number|null} cx origin x transformation
- * @param {number|null} cy origin y transformation
- * @param {number} p1 param for the transformation
- * @param {number} [p2] param for the transformation
- */
- transform: function (transformation, cx, cy, p1, p2) {
- if (this.chart.inverted) {
- var temp = cx;
- cx = cy;
- cy = temp;
- }
- this.points.forEach(function (point, i) {
- this.transformPoint(transformation, cx, cy, p1, p2, i);
- }, this);
- },
- /**
- * Transform a point with a specific transformation
- * If a transformed point is a real point it is replaced with
- * the mock point.
- *
- * @param {string} transformation a transformation name
- * @param {number|null} cx origin x transformation
- * @param {number|null} cy origin y transformation
- * @param {number} p1 param for the transformation
- * @param {number|undefined} p2 param for the transformation
- * @param {number} i index of the point
- */
- transformPoint: function (transformation, cx, cy, p1, p2, i) {
- var point = this.points[i];
- if (!point.mock) {
- point = this.points[i] = MockPoint.fromPoint(point);
- }
- point[transformation](cx, cy, p1, p2);
- },
- /**
- * Translate a controllable.
- *
- * @param {number} dx translation for x coordinate
- * @param {number} dy translation for y coordinate
- **/
- translate: function (dx, dy) {
- this.transform('translate', null, null, dx, dy);
- },
- /**
- * Translate a specific point within a controllable.
- *
- * @param {number} dx translation for x coordinate
- * @param {number} dy translation for y coordinate
- * @param {number} i index of the point
- **/
- translatePoint: function (dx, dy, i) {
- this.transformPoint('translate', null, null, dx, dy, i);
- },
- /**
- * Translate shape within controllable item.
- * Replaces `controllable.translate` method.
- *
- * @param {number} dx translation for x coordinate
- * @param {number} dy translation for y coordinate
- */
- translateShape: function (dx, dy) {
- var chart = this.annotation.chart,
- // Annotation.options
- shapeOptions = this.annotation.userOptions,
- // Chart.options.annotations
- annotationIndex = chart.annotations.indexOf(this.annotation),
- chartOptions = chart.options.annotations[annotationIndex];
- this.translatePoint(dx, dy, 0);
- // Options stored in:
- // - chart (for exporting)
- // - current config (for redraws)
- chartOptions[this.collection][this.index].point = this.options.point;
- shapeOptions[this.collection][this.index].point = this.options.point;
- },
- /**
- * Rotate a controllable.
- *
- * @param {number} cx origin x rotation
- * @param {number} cy origin y rotation
- * @param {number} radians
- **/
- rotate: function (cx, cy, radians) {
- this.transform('rotate', cx, cy, radians);
- },
- /**
- * Scale a controllable.
- *
- * @param {number} cx origin x rotation
- * @param {number} cy origin y rotation
- * @param {number} sx scale factor x
- * @param {number} sy scale factor y
- */
- scale: function (cx, cy, sx, sy) {
- this.transform('scale', cx, cy, sx, sy);
- },
- /**
- * Set control points' visibility.
- *
- * @param {boolean} visible
- */
- setControlPointsVisibility: function (visible) {
- this.controlPoints.forEach(function (controlPoint) {
- controlPoint.setVisibility(visible);
- });
- },
- /**
- * Destroy a controllable.
- */
- destroy: function () {
- if (this.graphic) {
- this.graphic = this.graphic.destroy();
- }
- if (this.tracker) {
- this.tracker = this.tracker.destroy();
- }
- this.controlPoints.forEach(function (controlPoint) {
- controlPoint.destroy();
- });
- this.chart = null;
- this.points = null;
- this.controlPoints = null;
- this.options = null;
- if (this.annotation) {
- this.annotation = null;
- }
- },
- /**
- * Update a controllable.
- *
- * @param {Object} newOptions
- */
- update: function (newOptions) {
- var annotation = this.annotation,
- options = merge(true,
- this.options,
- newOptions),
- parentGroup = this.graphic.parentGroup;
- this.destroy();
- this.constructor(annotation, options, this.index);
- this.render(parentGroup);
- this.redraw();
- }
- };
- return controllableMixin;
- });
- _registerModule(_modules, 'Extensions/Annotations/Mixins/MarkerMixin.js', [_modules['Core/Chart/Chart.js'], _modules['Core/Renderer/SVG/SVGRenderer.js'], _modules['Core/Utilities.js']], function (Chart, SVGRenderer, U) {
- /* *
- *
- * !!!!!!! SOURCE GETS TRANSPILED BY TYPESCRIPT. EDIT TS FILE ONLY. !!!!!!!
- *
- * */
- var addEvent = U.addEvent,
- defined = U.defined,
- merge = U.merge,
- uniqueKey = U.uniqueKey;
- /**
- * Options for configuring markers for annotations.
- *
- * An example of the arrow marker:
- * <pre>
- * {
- * arrow: {
- * id: 'arrow',
- * tagName: 'marker',
- * refY: 5,
- * refX: 5,
- * markerWidth: 10,
- * markerHeight: 10,
- * children: [{
- * tagName: 'path',
- * attrs: {
- * d: 'M 0 0 L 10 5 L 0 10 Z',
- * 'stroke-width': 0
- * }
- * }]
- * }
- * }
- * </pre>
- *
- * @sample highcharts/annotations/custom-markers/
- * Define a custom marker for annotations
- *
- * @sample highcharts/css/annotations-markers/
- * Define markers in a styled mode
- *
- * @type {Highcharts.Dictionary<Highcharts.ASTNode>}
- * @since 6.0.0
- * @optionparent defs
- */
- var defaultMarkers = {
- /**
- * @type {Highcharts.ASTNode}
- */
- arrow: {
- tagName: 'marker',
- attributes: {
- id: 'arrow',
- refY: 5,
- refX: 9,
- markerWidth: 10,
- markerHeight: 10
- },
- /**
- * @type {Array<Highcharts.DefsOptions>}
- */
- children: [{
- tagName: 'path',
- attributes: {
- d: 'M 0 0 L 10 5 L 0 10 Z',
- 'stroke-width': 0
- }
- }]
- },
- /**
- * @type {Highcharts.ASTNode}
- */
- 'reverse-arrow': {
- tagName: 'marker',
- attributes: {
- id: 'reverse-arrow',
- refY: 5,
- refX: 1,
- markerWidth: 10,
- markerHeight: 10
- },
- children: [{
- tagName: 'path',
- attributes: {
- // reverse triangle (used as an arrow)
- d: 'M 0 5 L 10 0 L 10 10 Z',
- 'stroke-width': 0
- }
- }]
- }
- };
- SVGRenderer.prototype.addMarker = function (id, markerOptions) {
- var options = { attributes: { id: id } };
- var attrs = {
- stroke: markerOptions.color || 'none',
- fill: markerOptions.color || 'rgba(0, 0, 0, 0.75)'
- };
- options.children = (markerOptions.children &&
- markerOptions.children.map(function (child) {
- return merge(attrs, child);
- }));
- var ast = merge(true, {
- attributes: {
- markerWidth: 20,
- markerHeight: 20,
- refX: 0,
- refY: 0,
- orient: 'auto'
- }
- },
- markerOptions,
- options);
- var marker = this.definition(ast);
- marker.id = id;
- return marker;
- };
- /* eslint-disable no-invalid-this, valid-jsdoc */
- /**
- * @private
- */
- function createMarkerSetter(markerType) {
- return function (value) {
- this.attr(markerType, 'url(#' + value + ')');
- };
- }
- /**
- * @private
- * @mixin
- * @name Highcharts.AnnotaitonMarkerMixin
- */
- var markerMixin = {
- markerEndSetter: createMarkerSetter('marker-end'),
- markerStartSetter: createMarkerSetter('marker-start'),
- /**
- * Set markers.
- * @private
- * @param {Highcharts.AnnotationControllablePath} item
- */
- setItemMarkers: function (item) {
- var itemOptions = item.options,
- chart = item.chart,
- defs = chart.options.defs,
- fill = itemOptions.fill,
- color = defined(fill) && fill !== 'none' ?
- fill :
- itemOptions.stroke,
- setMarker = function (markerType) {
- var markerId = itemOptions[markerType],
- def,
- predefinedMarker,
- key,
- marker;
- if (markerId) {
- for (key in defs) { // eslint-disable-line guard-for-in
- def = defs[key];
- if ((markerId === (def.attributes && def.attributes.id) ||
- // Legacy, for
- // unit-tests/annotations/annotations-shapes
- markerId === def.id) &&
- def.tagName === 'marker') {
- predefinedMarker = def;
- break;
- }
- }
- if (predefinedMarker) {
- marker = item[markerType] = chart.renderer
- .addMarker((itemOptions.id || uniqueKey()) + '-' +
- markerId, merge(predefinedMarker, { color: color }));
- item.attr(markerType, marker.getAttribute('id'));
- }
- }
- };
- ['markerStart', 'markerEnd'].forEach(setMarker);
- }
- };
- addEvent(Chart, 'afterGetContainer', function () {
- this.options.defs = merge(defaultMarkers, this.options.defs || {});
- // objectEach(this.options.defs, function (def): void {
- // const attributes = def.attributes;
- // if (
- // def.tagName === 'marker' &&
- // attributes &&
- // attributes.id &&
- // attributes.display !== 'none'
- // ) {
- // this.renderer.addMarker(attributes.id, def);
- // }
- // }, this);
- });
- return markerMixin;
- });
- _registerModule(_modules, 'Extensions/Annotations/Controllables/ControllablePath.js', [_modules['Extensions/Annotations/Mixins/ControllableMixin.js'], _modules['Core/Globals.js'], _modules['Extensions/Annotations/Mixins/MarkerMixin.js'], _modules['Core/Utilities.js']], function (ControllableMixin, H, MarkerMixin, U) {
- /* *
- *
- * !!!!!!! SOURCE GETS TRANSPILED BY TYPESCRIPT. EDIT TS FILE ONLY. !!!!!!!
- *
- * */
- var extend = U.extend;
- // See TRACKER_FILL in highcharts.src.js
- var TRACKER_FILL = 'rgba(192,192,192,' + (H.svg ? 0.0001 : 0.002) + ')';
- /* eslint-disable no-invalid-this, valid-jsdoc */
- /**
- * A controllable path class.
- *
- * @requires modules/annotations
- *
- * @private
- * @class
- * @name Highcharts.AnnotationControllablePath
- *
- * @param {Highcharts.Annotation}
- * Related annotation.
- *
- * @param {Highcharts.AnnotationsShapeOptions} options
- * A path's options object.
- *
- * @param {number} index
- * Index of the path.
- */
- var ControllablePath = /** @class */ (function () {
- /* *
- *
- * Constructors
- *
- * */
- function ControllablePath(annotation, options, index) {
- /* *
- *
- * Properties
- *
- * */
- this.addControlPoints = ControllableMixin.addControlPoints;
- this.anchor = ControllableMixin.anchor;
- this.attr = ControllableMixin.attr;
- this.attrsFromOptions = ControllableMixin.attrsFromOptions;
- this.destroy = ControllableMixin.destroy;
- this.getPointsOptions = ControllableMixin.getPointsOptions;
- this.init = ControllableMixin.init;
- this.linkPoints = ControllableMixin.linkPoints;
- this.point = ControllableMixin.point;
- this.rotate = ControllableMixin.rotate;
- this.scale = ControllableMixin.scale;
- this.setControlPointsVisibility = ControllableMixin.setControlPointsVisibility;
- this.setMarkers = MarkerMixin.setItemMarkers;
- this.transform = ControllableMixin.transform;
- this.transformPoint = ControllableMixin.transformPoint;
- this.translate = ControllableMixin.translate;
- this.translatePoint = ControllableMixin.translatePoint;
- this.translateShape = ControllableMixin.translateShape;
- this.update = ControllableMixin.update;
- /**
- * @type 'path'
- */
- this.type = 'path';
- this.init(annotation, options, index);
- this.collection = 'shapes';
- }
- /* *
- *
- * Functions
- *
- * */
- /**
- * Map the controllable path to 'd' path attribute.
- *
- * @return {Highcharts.SVGPathArray|null}
- * A path's d attribute.
- */
- ControllablePath.prototype.toD = function () {
- var dOption = this.options.d;
- if (dOption) {
- return typeof dOption === 'function' ?
- dOption.call(this) :
- dOption;
- }
- var points = this.points,
- len = points.length,
- showPath = len,
- point = points[0],
- position = showPath && this.anchor(point).absolutePosition,
- pointIndex = 0,
- command,
- d = [];
- if (position) {
- d.push(['M', position.x, position.y]);
- while (++pointIndex < len && showPath) {
- point = points[pointIndex];
- command = point.command || 'L';
- position = this.anchor(point).absolutePosition;
- if (command === 'M') {
- d.push([command, position.x, position.y]);
- }
- else if (command === 'L') {
- d.push([command, position.x, position.y]);
- }
- else if (command === 'Z') {
- d.push([command]);
- }
- showPath = point.series.visible;
- }
- }
- return showPath ?
- this.chart.renderer.crispLine(d, this.graphic.strokeWidth()) :
- null;
- };
- ControllablePath.prototype.shouldBeDrawn = function () {
- return (ControllableMixin.shouldBeDrawn.call(this) || Boolean(this.options.d));
- };
- ControllablePath.prototype.render = function (parent) {
- var options = this.options,
- attrs = this.attrsFromOptions(options);
- this.graphic = this.annotation.chart.renderer
- .path([['M', 0, 0]])
- .attr(attrs)
- .add(parent);
- if (options.className) {
- this.graphic.addClass(options.className);
- }
- this.tracker = this.annotation.chart.renderer
- .path([['M', 0, 0]])
- .addClass('highcharts-tracker-line')
- .attr({
- zIndex: 2
- })
- .add(parent);
- if (!this.annotation.chart.styledMode) {
- this.tracker.attr({
- 'stroke-linejoin': 'round',
- stroke: TRACKER_FILL,
- fill: TRACKER_FILL,
- 'stroke-width': this.graphic.strokeWidth() +
- options.snap * 2
- });
- }
- ControllableMixin.render.call(this);
- extend(this.graphic, {
- markerStartSetter: MarkerMixin.markerStartSetter,
- markerEndSetter: MarkerMixin.markerEndSetter
- });
- this.setMarkers(this);
- };
- ControllablePath.prototype.redraw = function (animation) {
- var d = this.toD(),
- action = animation ? 'animate' : 'attr';
- if (d) {
- this.graphic[action]({ d: d });
- this.tracker[action]({ d: d });
- }
- else {
- this.graphic.attr({ d: 'M 0 ' + -9e9 });
- this.tracker.attr({ d: 'M 0 ' + -9e9 });
- }
- this.graphic.placed = this.tracker.placed = Boolean(d);
- ControllableMixin.redraw.call(this, animation);
- };
- /* *
- *
- * Static Properties
- *
- * */
- /**
- * A map object which allows to map options attributes to element attributes
- *
- * @name Highcharts.AnnotationControllablePath.attrsMap
- * @type {Highcharts.Dictionary<string>}
- */
- ControllablePath.attrsMap = {
- dashStyle: 'dashstyle',
- strokeWidth: 'stroke-width',
- stroke: 'stroke',
- fill: 'fill',
- zIndex: 'zIndex'
- };
- return ControllablePath;
- }());
- return ControllablePath;
- });
- _registerModule(_modules, 'Extensions/Annotations/Controllables/ControllableRect.js', [_modules['Extensions/Annotations/Mixins/ControllableMixin.js'], _modules['Extensions/Annotations/Controllables/ControllablePath.js'], _modules['Core/Utilities.js']], function (ControllableMixin, ControllablePath, U) {
- /* *
- *
- * !!!!!!! SOURCE GETS TRANSPILED BY TYPESCRIPT. EDIT TS FILE ONLY. !!!!!!!
- *
- * */
- var merge = U.merge;
- /**
- * @typedef {Annotation.ControllablePath.AttrsMap}
- * Annotation.ControllableRect.AttrsMap
- * @property {string} width=width
- * @property {string} height=height
- */
- /* eslint-disable no-invalid-this, valid-jsdoc */
- /**
- * A controllable rect class.
- *
- * @requires modules/annotations
- *
- * @private
- * @class
- * @name Highcharts.AnnotationControllableRect
- *
- * @param {Highcharts.Annotation} annotation
- * An annotation instance.
- *
- * @param {Highcharts.AnnotationsShapeOptions} options
- * A rect's options.
- *
- * @param {number} index
- * Index of the rectangle
- */
- var ControllableRect = /** @class */ (function () {
- /* *
- *
- * Constructors
- *
- * */
- function ControllableRect(annotation, options, index) {
- /* *
- *
- * Properties
- *
- * */
- this.addControlPoints = ControllableMixin.addControlPoints;
- this.anchor = ControllableMixin.anchor;
- this.attr = ControllableMixin.attr;
- this.attrsFromOptions = ControllableMixin.attrsFromOptions;
- this.destroy = ControllableMixin.destroy;
- this.getPointsOptions = ControllableMixin.getPointsOptions;
- this.init = ControllableMixin.init;
- this.linkPoints = ControllableMixin.linkPoints;
- this.point = ControllableMixin.point;
- this.rotate = ControllableMixin.rotate;
- this.scale = ControllableMixin.scale;
- this.setControlPointsVisibility = ControllableMixin.setControlPointsVisibility;
- this.shouldBeDrawn = ControllableMixin.shouldBeDrawn;
- this.transform = ControllableMixin.transform;
- this.transformPoint = ControllableMixin.transformPoint;
- this.translatePoint = ControllableMixin.translatePoint;
- this.translateShape = ControllableMixin.translateShape;
- this.update = ControllableMixin.update;
- /**
- * @type 'rect'
- */
- this.type = 'rect';
- this.translate = ControllableMixin.translateShape;
- this.init(annotation, options, index);
- this.collection = 'shapes';
- }
- /* *
- *
- * Functions
- *
- * */
- ControllableRect.prototype.render = function (parent) {
- var attrs = this.attrsFromOptions(this.options);
- this.graphic = this.annotation.chart.renderer
- .rect(0, -9e9, 0, 0)
- .attr(attrs)
- .add(parent);
- ControllableMixin.render.call(this);
- };
- ControllableRect.prototype.redraw = function (animation) {
- var position = this.anchor(this.points[0]).absolutePosition;
- if (position) {
- this.graphic[animation ? 'animate' : 'attr']({
- x: position.x,
- y: position.y,
- width: this.options.width,
- height: this.options.height
- });
- }
- else {
- this.attr({
- x: 0,
- y: -9e9
- });
- }
- this.graphic.placed = Boolean(position);
- ControllableMixin.redraw.call(this, animation);
- };
- /* *
- *
- * Static Properties
- *
- * */
- /**
- * A map object which allows to map options attributes to element attributes
- *
- * @type {Annotation.ControllableRect.AttrsMap}
- */
- ControllableRect.attrsMap = merge(ControllablePath.attrsMap, {
- width: 'width',
- height: 'height'
- });
- return ControllableRect;
- }());
- return ControllableRect;
- });
- _registerModule(_modules, 'Extensions/Annotations/Controllables/ControllableCircle.js', [_modules['Extensions/Annotations/Mixins/ControllableMixin.js'], _modules['Extensions/Annotations/Controllables/ControllablePath.js'], _modules['Core/Utilities.js']], function (ControllableMixin, ControllablePath, U) {
- /* *
- *
- * !!!!!!! SOURCE GETS TRANSPILED BY TYPESCRIPT. EDIT TS FILE ONLY. !!!!!!!
- *
- * */
- var merge = U.merge;
- /* eslint-disable no-invalid-this, valid-jsdoc */
- /**
- * A controllable circle class.
- *
- * @requires modules/annotations
- *
- * @private
- * @class
- * @name Highcharts.AnnotationControllableCircle
- *
- * @param {Highcharts.Annotation} annotation an annotation instance
- * @param {Highcharts.AnnotationsShapeOptions} options a shape's options
- * @param {number} index of the circle
- */
- var ControllableCircle = /** @class */ (function () {
- /* *
- *
- * Constructors
- *
- * */
- function ControllableCircle(annotation, options, index) {
- /* *
- *
- * Properties
- *
- * */
- this.addControlPoints = ControllableMixin.addControlPoints;
- this.anchor = ControllableMixin.anchor;
- this.attr = ControllableMixin.attr;
- this.attrsFromOptions = ControllableMixin.attrsFromOptions;
- this.destroy = ControllableMixin.destroy;
- this.getPointsOptions = ControllableMixin.getPointsOptions;
- this.init = ControllableMixin.init;
- this.linkPoints = ControllableMixin.linkPoints;
- this.point = ControllableMixin.point;
- this.rotate = ControllableMixin.rotate;
- this.scale = ControllableMixin.scale;
- this.setControlPointsVisibility = ControllableMixin.setControlPointsVisibility;
- this.shouldBeDrawn = ControllableMixin.shouldBeDrawn;
- this.transform = ControllableMixin.transform;
- this.transformPoint = ControllableMixin.transformPoint;
- this.translatePoint = ControllableMixin.translatePoint;
- this.translateShape = ControllableMixin.translateShape;
- this.update = ControllableMixin.update;
- /**
- * @type 'circle'
- */
- this.type = 'circle';
- this.translate = ControllableMixin.translateShape;
- this.init(annotation, options, index);
- this.collection = 'shapes';
- }
- /* *
- *
- * Functions
- *
- * */
- ControllableCircle.prototype.render = function (parent) {
- var attrs = this.attrsFromOptions(this.options);
- this.graphic = this.annotation.chart.renderer
- .circle(0, -9e9, 0)
- .attr(attrs)
- .add(parent);
- ControllableMixin.render.call(this);
- };
- ControllableCircle.prototype.redraw = function (animation) {
- var position = this.anchor(this.points[0]).absolutePosition;
- if (position) {
- this.graphic[animation ? 'animate' : 'attr']({
- x: position.x,
- y: position.y,
- r: this.options.r
- });
- }
- else {
- this.graphic.attr({
- x: 0,
- y: -9e9
- });
- }
- this.graphic.placed = Boolean(position);
- ControllableMixin.redraw.call(this, animation);
- };
- /**
- * Set the radius.
- *
- * @param {number} r a radius to be set
- */
- ControllableCircle.prototype.setRadius = function (r) {
- this.options.r = r;
- };
- /* *
- *
- * Static Properties
- *
- * */
- /**
- * A map object which allows to map options attributes to element
- * attributes.
- *
- * @name Highcharts.AnnotationControllableCircle.attrsMap
- * @type {Highcharts.Dictionary<string>}
- */
- ControllableCircle.attrsMap = merge(ControllablePath.attrsMap, { r: 'r' });
- return ControllableCircle;
- }());
- return ControllableCircle;
- });
- _registerModule(_modules, 'Extensions/Annotations/Controllables/ControllableLabel.js', [_modules['Extensions/Annotations/Mixins/ControllableMixin.js'], _modules['Core/FormatUtilities.js'], _modules['Extensions/Annotations/MockPoint.js'], _modules['Core/Renderer/SVG/SVGRenderer.js'], _modules['Core/Tooltip.js'], _modules['Core/Utilities.js']], function (ControllableMixin, F, MockPoint, SVGRenderer, Tooltip, U) {
- /* *
- *
- * !!!!!!! SOURCE GETS TRANSPILED BY TYPESCRIPT. EDIT TS FILE ONLY. !!!!!!!
- *
- * */
- /* *
- *
- * Imports
- *
- * */
- var format = F.format;
- var symbols = SVGRenderer.prototype.symbols;
- var extend = U.extend,
- isNumber = U.isNumber,
- pick = U.pick;
- /* eslint-disable no-invalid-this, valid-jsdoc */
- /**
- * A controllable label class.
- *
- * @requires modules/annotations
- *
- * @private
- * @class
- * @name Highcharts.AnnotationControllableLabel
- *
- * @param {Highcharts.Annotation} annotation
- * An annotation instance.
- * @param {Highcharts.AnnotationsLabelOptions} options
- * A label's options.
- * @param {number} index
- * Index of the label.
- */
- var ControllableLabel = /** @class */ (function () {
- /* *
- *
- * Constructors
- *
- * */
- function ControllableLabel(annotation, options, index) {
- /* *
- *
- * Properties
- *
- * */
- this.addControlPoints = ControllableMixin.addControlPoints;
- this.attr = ControllableMixin.attr;
- this.attrsFromOptions = ControllableMixin.attrsFromOptions;
- this.destroy = ControllableMixin.destroy;
- this.getPointsOptions = ControllableMixin.getPointsOptions;
- this.init = ControllableMixin.init;
- this.linkPoints = ControllableMixin.linkPoints;
- this.point = ControllableMixin.point;
- this.rotate = ControllableMixin.rotate;
- this.scale = ControllableMixin.scale;
- this.setControlPointsVisibility = ControllableMixin.setControlPointsVisibility;
- this.shouldBeDrawn = ControllableMixin.shouldBeDrawn;
- this.transform = ControllableMixin.transform;
- this.transformPoint = ControllableMixin.transformPoint;
- this.translateShape = ControllableMixin.translateShape;
- this.update = ControllableMixin.update;
- this.init(annotation, options, index);
- this.collection = 'labels';
- }
- /* *
- *
- * Static Functions
- *
- * */
- /**
- * Returns new aligned position based alignment options and box to align to.
- * It is almost a one-to-one copy from SVGElement.prototype.align
- * except it does not use and mutate an element
- *
- * @param {Highcharts.AnnotationAlignObject} alignOptions
- *
- * @param {Highcharts.BBoxObject} box
- *
- * @return {Highcharts.PositionObject}
- * Aligned position.
- */
- ControllableLabel.alignedPosition = function (alignOptions, box) {
- var align = alignOptions.align,
- vAlign = alignOptions.verticalAlign;
- var x = (box.x || 0) + (alignOptions.x || 0),
- y = (box.y || 0) + (alignOptions.y || 0),
- alignFactor,
- vAlignFactor;
- if (align === 'right') {
- alignFactor = 1;
- }
- else if (align === 'center') {
- alignFactor = 2;
- }
- if (alignFactor) {
- x += (box.width - (alignOptions.width || 0)) / alignFactor;
- }
- if (vAlign === 'bottom') {
- vAlignFactor = 1;
- }
- else if (vAlign === 'middle') {
- vAlignFactor = 2;
- }
- if (vAlignFactor) {
- y += (box.height - (alignOptions.height || 0)) / vAlignFactor;
- }
- return {
- x: Math.round(x),
- y: Math.round(y)
- };
- };
- /**
- * Returns new alignment options for a label if the label is outside the
- * plot area. It is almost a one-to-one copy from
- * Series.prototype.justifyDataLabel except it does not mutate the label and
- * it works with absolute instead of relative position.
- */
- ControllableLabel.justifiedOptions = function (chart, label, alignOptions, alignAttr) {
- var align = alignOptions.align,
- verticalAlign = alignOptions.verticalAlign,
- padding = label.box ? 0 : (label.padding || 0),
- bBox = label.getBBox(),
- //
- options = {
- align: align,
- verticalAlign: verticalAlign,
- x: alignOptions.x,
- y: alignOptions.y,
- width: label.width,
- height: label.height
- },
- //
- x = (alignAttr.x || 0) - chart.plotLeft,
- y = (alignAttr.y || 0) - chart.plotTop;
- var off;
- // Off left
- off = x + padding;
- if (off < 0) {
- if (align === 'right') {
- options.align = 'left';
- }
- else {
- options.x = (options.x || 0) - off;
- }
- }
- // Off right
- off = x + bBox.width - padding;
- if (off > chart.plotWidth) {
- if (align === 'left') {
- options.align = 'right';
- }
- else {
- options.x = (options.x || 0) + chart.plotWidth - off;
- }
- }
- // Off top
- off = y + padding;
- if (off < 0) {
- if (verticalAlign === 'bottom') {
- options.verticalAlign = 'top';
- }
- else {
- options.y = (options.y || 0) - off;
- }
- }
- // Off bottom
- off = y + bBox.height - padding;
- if (off > chart.plotHeight) {
- if (verticalAlign === 'top') {
- options.verticalAlign = 'bottom';
- }
- else {
- options.y = (options.y || 0) + chart.plotHeight - off;
- }
- }
- return options;
- };
- /* *
- *
- * Functions
- *
- * */
- /**
- * Translate the point of the label by deltaX and deltaY translations.
- * The point is the label's anchor.
- *
- * @param {number} dx translation for x coordinate
- * @param {number} dy translation for y coordinate
- */
- ControllableLabel.prototype.translatePoint = function (dx, dy) {
- ControllableMixin.translatePoint.call(this, dx, dy, 0);
- };
- /**
- * Translate x and y position relative to the label's anchor.
- *
- * @param {number} dx translation for x coordinate
- * @param {number} dy translation for y coordinate
- */
- ControllableLabel.prototype.translate = function (dx, dy) {
- var chart = this.annotation.chart,
- // Annotation.options
- labelOptions = this.annotation.userOptions,
- // Chart.options.annotations
- annotationIndex = chart.annotations.indexOf(this.annotation),
- chartAnnotations = chart.options.annotations,
- chartOptions = chartAnnotations[annotationIndex];
- if (chart.inverted) {
- var temp = dx;
- dx = dy;
- dy = temp;
- }
- // Local options:
- this.options.x += dx;
- this.options.y += dy;
- // Options stored in chart:
- chartOptions[this.collection][this.index].x = this.options.x;
- chartOptions[this.collection][this.index].y = this.options.y;
- labelOptions[this.collection][this.index].x = this.options.x;
- labelOptions[this.collection][this.index].y = this.options.y;
- };
- ControllableLabel.prototype.render = function (parent) {
- var options = this.options,
- attrs = this.attrsFromOptions(options),
- style = options.style;
- this.graphic = this.annotation.chart.renderer
- .label('', 0, -9999, // #10055
- options.shape, null, null, options.useHTML, null, 'annotation-label')
- .attr(attrs)
- .add(parent);
- if (!this.annotation.chart.styledMode) {
- if (style.color === 'contrast') {
- style.color = this.annotation.chart.renderer.getContrast(ControllableLabel.shapesWithoutBackground.indexOf(options.shape) > -1 ? '#FFFFFF' : options.backgroundColor);
- }
- this.graphic
- .css(options.style)
- .shadow(options.shadow);
- }
- if (options.className) {
- this.graphic.addClass(options.className);
- }
- this.graphic.labelrank = options.labelrank;
- ControllableMixin.render.call(this);
- };
- ControllableLabel.prototype.redraw = function (animation) {
- var options = this.options,
- text = this.text || options.format || options.text,
- label = this.graphic,
- point = this.points[0];
- label.attr({
- text: text ?
- format(text, point.getLabelConfig(), this.annotation.chart) :
- options.formatter.call(point, this)
- });
- var anchor = this.anchor(point);
- var attrs = this.position(anchor);
- if (attrs) {
- label.alignAttr = attrs;
- attrs.anchorX = anchor.absolutePosition.x;
- attrs.anchorY = anchor.absolutePosition.y;
- label[animation ? 'animate' : 'attr'](attrs);
- }
- else {
- label.attr({
- x: 0,
- y: -9999 // #10055
- });
- }
- label.placed = !!attrs;
- ControllableMixin.redraw.call(this, animation);
- };
- /**
- * All basic shapes don't support alignTo() method except label.
- * For a controllable label, we need to subtract translation from
- * options.
- */
- ControllableLabel.prototype.anchor = function (_point) {
- var anchor = ControllableMixin.anchor.apply(this,
- arguments),
- x = this.options.x || 0,
- y = this.options.y || 0;
- anchor.absolutePosition.x -= x;
- anchor.absolutePosition.y -= y;
- anchor.relativePosition.x -= x;
- anchor.relativePosition.y -= y;
- return anchor;
- };
- /**
- * Returns the label position relative to its anchor.
- *
- * @param {Highcharts.AnnotationAnchorObject} anchor
- *
- * @return {Highcharts.PositionObject|null}
- */
- ControllableLabel.prototype.position = function (anchor) {
- var item = this.graphic,
- chart = this.annotation.chart,
- point = this.points[0],
- itemOptions = this.options,
- anchorAbsolutePosition = anchor.absolutePosition,
- anchorRelativePosition = anchor.relativePosition;
- var itemPosition,
- alignTo,
- itemPosRelativeX,
- itemPosRelativeY,
- showItem = point.series.visible &&
- MockPoint.prototype.isInsidePlot.call(point);
- var _a = item.width,
- width = _a === void 0 ? 0 : _a,
- _b = item.height,
- height = _b === void 0 ? 0 : _b;
- if (showItem) {
- if (itemOptions.distance) {
- itemPosition = Tooltip.prototype.getPosition.call({
- chart: chart,
- distance: pick(itemOptions.distance, 16)
- }, width, height, {
- plotX: anchorRelativePosition.x,
- plotY: anchorRelativePosition.y,
- negative: point.negative,
- ttBelow: point.ttBelow,
- h: (anchorRelativePosition.height || anchorRelativePosition.width)
- });
- }
- else if (itemOptions.positioner) {
- itemPosition = itemOptions.positioner.call(this);
- }
- else {
- alignTo = {
- x: anchorAbsolutePosition.x,
- y: anchorAbsolutePosition.y,
- width: 0,
- height: 0
- };
- itemPosition = ControllableLabel.alignedPosition(extend(itemOptions, {
- width: width,
- height: height
- }), alignTo);
- if (this.options.overflow === 'justify') {
- itemPosition = ControllableLabel.alignedPosition(ControllableLabel.justifiedOptions(chart, item, itemOptions, itemPosition), alignTo);
- }
- }
- if (itemOptions.crop) {
- itemPosRelativeX = itemPosition.x - chart.plotLeft;
- itemPosRelativeY = itemPosition.y - chart.plotTop;
- showItem =
- chart.isInsidePlot(itemPosRelativeX, itemPosRelativeY) &&
- chart.isInsidePlot(itemPosRelativeX + width, itemPosRelativeY + height);
- }
- }
- return showItem ? itemPosition : null;
- };
- /* *
- *
- * Static Properties
- *
- * */
- /**
- * A map object which allows to map options attributes to element attributes
- *
- * @type {Highcharts.Dictionary<string>}
- */
- ControllableLabel.attrsMap = {
- backgroundColor: 'fill',
- borderColor: 'stroke',
- borderWidth: 'stroke-width',
- zIndex: 'zIndex',
- borderRadius: 'r',
- padding: 'padding'
- };
- /**
- * Shapes which do not have background - the object is used for proper
- * setting of the contrast color.
- *
- * @type {Array<string>}
- */
- ControllableLabel.shapesWithoutBackground = ['connector'];
- return ControllableLabel;
- }());
- /**
- * General symbol definition for labels with connector
- * @private
- */
- symbols.connector = function (x, y, w, h, options) {
- var anchorX = options && options.anchorX,
- anchorY = options && options.anchorY;
- var path,
- yOffset,
- lateral = w / 2;
- if (isNumber(anchorX) && isNumber(anchorY)) {
- path = [['M', anchorX, anchorY]];
- // Prefer 45 deg connectors
- yOffset = y - anchorY;
- if (yOffset < 0) {
- yOffset = -h - yOffset;
- }
- if (yOffset < w) {
- lateral = anchorX < x + (w / 2) ? yOffset : w - yOffset;
- }
- // Anchor below label
- if (anchorY > y + h) {
- path.push(['L', x + lateral, y + h]);
- // Anchor above label
- }
- else if (anchorY < y) {
- path.push(['L', x + lateral, y]);
- // Anchor left of label
- }
- else if (anchorX < x) {
- path.push(['L', x, y + h / 2]);
- // Anchor right of label
- }
- else if (anchorX > x + w) {
- path.push(['L', x + w, y + h / 2]);
- }
- }
- return path || [];
- };
- return ControllableLabel;
- });
- _registerModule(_modules, 'Extensions/Annotations/Controllables/ControllableImage.js', [_modules['Extensions/Annotations/Controllables/ControllableLabel.js'], _modules['Extensions/Annotations/Mixins/ControllableMixin.js']], function (ControllableLabel, ControllableMixin) {
- /* *
- *
- * !!!!!!! SOURCE GETS TRANSPILED BY TYPESCRIPT. EDIT TS FILE ONLY. !!!!!!!
- *
- * */
- /* eslint-disable no-invalid-this, valid-jsdoc */
- /**
- * A controllable image class.
- *
- * @requires modules/annotations
- *
- * @private
- * @class
- * @name Highcharts.AnnotationControllableImage
- *
- * @param {Highcharts.Annotation} annotation
- * An annotation instance.
- *
- * @param {Highcharts.AnnotationsShapeOptions} options
- * A controllable's options.
- *
- * @param {number} index
- * Index of the image.
- */
- var ControllableImage = /** @class */ (function () {
- /* *
- *
- * Constructors
- *
- * */
- function ControllableImage(annotation, options, index) {
- /* *
- *
- * Properties
- *
- * */
- this.addControlPoints = ControllableMixin.addControlPoints;
- this.anchor = ControllableMixin.anchor;
- this.attr = ControllableMixin.attr;
- this.attrsFromOptions = ControllableMixin.attrsFromOptions;
- this.destroy = ControllableMixin.destroy;
- this.getPointsOptions = ControllableMixin.getPointsOptions;
- this.init = ControllableMixin.init;
- this.linkPoints = ControllableMixin.linkPoints;
- this.point = ControllableMixin.point;
- this.rotate = ControllableMixin.rotate;
- this.scale = ControllableMixin.scale;
- this.setControlPointsVisibility = ControllableMixin.setControlPointsVisibility;
- this.shouldBeDrawn = ControllableMixin.shouldBeDrawn;
- this.transform = ControllableMixin.transform;
- this.transformPoint = ControllableMixin.transformPoint;
- this.translatePoint = ControllableMixin.translatePoint;
- this.translateShape = ControllableMixin.translateShape;
- this.update = ControllableMixin.update;
- /**
- * @type 'image'
- */
- this.type = 'image';
- this.translate = ControllableMixin.translateShape;
- this.init(annotation, options, index);
- this.collection = 'shapes';
- }
- ControllableImage.prototype.render = function (parent) {
- var attrs = this.attrsFromOptions(this.options),
- options = this.options;
- this.graphic = this.annotation.chart.renderer
- .image(options.src, 0, -9e9, options.width, options.height)
- .attr(attrs)
- .add(parent);
- this.graphic.width = options.width;
- this.graphic.height = options.height;
- ControllableMixin.render.call(this);
- };
- ControllableImage.prototype.redraw = function (animation) {
- var anchor = this.anchor(this.points[0]),
- position = ControllableLabel.prototype.position.call(this,
- anchor);
- if (position) {
- this.graphic[animation ? 'animate' : 'attr']({
- x: position.x,
- y: position.y
- });
- }
- else {
- this.graphic.attr({
- x: 0,
- y: -9e9
- });
- }
- this.graphic.placed = Boolean(position);
- ControllableMixin.redraw.call(this, animation);
- };
- /* *
- *
- * Static Properties
- *
- * */
- /**
- * A map object which allows to map options attributes to element attributes
- *
- * @name Highcharts.AnnotationControllableImage.attrsMap
- * @type {Highcharts.Dictionary<string>}
- */
- ControllableImage.attrsMap = {
- width: 'width',
- height: 'height',
- zIndex: 'zIndex'
- };
- return ControllableImage;
- }());
- return ControllableImage;
- });
- _registerModule(_modules, 'Extensions/Annotations/Annotations.js', [_modules['Core/Animation/AnimationUtilities.js'], _modules['Core/Chart/Chart.js'], _modules['Extensions/Annotations/Mixins/ControllableMixin.js'], _modules['Extensions/Annotations/Controllables/ControllableRect.js'], _modules['Extensions/Annotations/Controllables/ControllableCircle.js'], _modules['Extensions/Annotations/Controllables/ControllablePath.js'], _modules['Extensions/Annotations/Controllables/ControllableImage.js'], _modules['Extensions/Annotations/Controllables/ControllableLabel.js'], _modules['Extensions/Annotations/ControlPoint.js'], _modules['Extensions/Annotations/Mixins/EventEmitterMixin.js'], _modules['Core/Globals.js'], _modules['Extensions/Annotations/MockPoint.js'], _modules['Core/Pointer.js'], _modules['Core/Utilities.js'], _modules['Core/Color/Palette.js']], function (A, Chart, ControllableMixin, ControllableRect, ControllableCircle, ControllablePath, ControllableImage, ControllableLabel, ControlPoint, EventEmitterMixin, H, MockPoint, Pointer, U, palette) {
- /* *
- *
- * (c) 2009-2021 Highsoft, Black Label
- *
- * License: www.highcharts.com/license
- *
- * !!!!!!! SOURCE GETS TRANSPILED BY TYPESCRIPT. EDIT TS FILE ONLY. !!!!!!!
- *
- * */
- var getDeferredAnimation = A.getDeferredAnimation;
- var chartProto = Chart.prototype;
- var addEvent = U.addEvent,
- defined = U.defined,
- destroyObjectProperties = U.destroyObjectProperties,
- erase = U.erase,
- extend = U.extend,
- find = U.find,
- fireEvent = U.fireEvent,
- merge = U.merge,
- pick = U.pick,
- splat = U.splat,
- wrap = U.wrap;
- /* *********************************************************************
- *
- * ANNOTATION
- *
- ******************************************************************** */
- /**
- * Possible directions for draggable annotations. An empty string (`''`)
- * makes the annotation undraggable.
- *
- * @typedef {''|'x'|'xy'|'y'} Highcharts.AnnotationDraggableValue
- */
- /**
- * @private
- * @typedef {
- * Highcharts.AnnotationControllableCircle|
- * Highcharts.AnnotationControllableImage|
- * Highcharts.AnnotationControllablePath|
- * Highcharts.AnnotationControllableRect
- * }
- * Highcharts.AnnotationShapeType
- * @requires modules/annotations
- */
- /**
- * @private
- * @typedef {
- * Highcharts.AnnotationControllableLabel
- * }
- * Highcharts.AnnotationLabelType
- * @requires modules/annotations
- */
- /**
- * A point-like object, a mock point or a point used in series.
- * @private
- * @typedef {Highcharts.AnnotationMockPoint|Highcharts.Point} Highcharts.AnnotationPointType
- * @requires modules/annotations
- */
- /* eslint-disable no-invalid-this, valid-jsdoc */
- /**
- * An annotation class which serves as a container for items like labels or
- * shapes. Created items are positioned on the chart either by linking them to
- * existing points or created mock points
- *
- * @class
- * @name Highcharts.Annotation
- *
- * @param {Highcharts.Chart} chart a chart instance
- * @param {Highcharts.AnnotationsOptions} userOptions the options object
- */
- var Annotation = /** @class */ (function () {
- /* *
- *
- * Constructors
- *
- * */
- function Annotation(chart, userOptions) {
- /* *
- *
- * Properties
- *
- * */
- this.annotation = void 0;
- this.coll = 'annotations';
- this.collection = void 0;
- this.animationConfig = void 0;
- this.graphic = void 0;
- this.group = void 0;
- this.labelCollector = void 0;
- this.labelsGroup = void 0;
- this.shapesGroup = void 0;
- var labelsAndShapes;
- /**
- * The chart that the annotation belongs to.
- *
- * @type {Highcharts.Chart}
- */
- this.chart = chart;
- /**
- * The array of points which defines the annotation.
- *
- * @type {Array<Highcharts.Point>}
- */
- this.points = [];
- /**
- * The array of control points.
- *
- * @private
- * @name Highcharts.Annotation#controlPoints
- * @type {Array<Annotation.ControlPoint>}
- */
- this.controlPoints = [];
- this.coll = 'annotations';
- /**
- * The array of labels which belong to the annotation.
- *
- * @private
- * @name Highcharts.Annotation#labels
- * @type {Array<Highcharts.AnnotationLabelType>}
- */
- this.labels = [];
- /**
- * The array of shapes which belong to the annotation.
- *
- * @private
- * @name Highcharts.Annotation#shapes
- * @type {Array<Highcharts.AnnotationShapeType>}
- */
- this.shapes = [];
- /**
- * The options for the annotations.
- *
- * @name Highcharts.Annotation#options
- * @type {Highcharts.AnnotationsOptions}
- */
- this.options = merge(this.defaultOptions, userOptions);
- /**
- * The user options for the annotations.
- *
- * @name Highcharts.Annotation#userOptions
- * @type {Highcharts.AnnotationsOptions}
- */
- this.userOptions = userOptions;
- // Handle labels and shapes - those are arrays
- // Merging does not work with arrays (stores reference)
- labelsAndShapes = this.getLabelsAndShapesOptions(this.options, userOptions);
- this.options.labels = labelsAndShapes.labels;
- this.options.shapes = labelsAndShapes.shapes;
- /**
- * The callback that reports to the overlapping-labels module which
- * labels it should account for.
- * @private
- * @name Highcharts.Annotation#labelCollector
- * @type {Function}
- */
- /**
- * The group svg element.
- *
- * @name Highcharts.Annotation#group
- * @type {Highcharts.SVGElement}
- */
- /**
- * The group svg element of the annotation's shapes.
- *
- * @name Highcharts.Annotation#shapesGroup
- * @type {Highcharts.SVGElement}
- */
- /**
- * The group svg element of the annotation's labels.
- *
- * @name Highcharts.Annotation#labelsGroup
- * @type {Highcharts.SVGElement}
- */
- this.init(chart, this.options);
- }
- /**
- * Initialize the annotation.
- * @private
- */
- Annotation.prototype.init = function () {
- var chart = this.chart,
- animOptions = this.options.animation;
- this.linkPoints();
- this.addControlPoints();
- this.addShapes();
- this.addLabels();
- this.setLabelCollector();
- this.animationConfig = getDeferredAnimation(chart, animOptions);
- };
- Annotation.prototype.getLabelsAndShapesOptions = function (baseOptions, newOptions) {
- var mergedOptions = {};
- ['labels', 'shapes'].forEach(function (name) {
- if (baseOptions[name]) {
- mergedOptions[name] = splat(newOptions[name]).map(function (basicOptions, i) {
- return merge(baseOptions[name][i], basicOptions);
- });
- }
- });
- return mergedOptions;
- };
- Annotation.prototype.addShapes = function () {
- (this.options.shapes || []).forEach(function (shapeOptions, i) {
- var shape = this.initShape(shapeOptions,
- i);
- merge(true, this.options.shapes[i], shape.options);
- }, this);
- };
- Annotation.prototype.addLabels = function () {
- (this.options.labels || []).forEach(function (labelsOptions, i) {
- var labels = this.initLabel(labelsOptions,
- i);
- merge(true, this.options.labels[i], labels.options);
- }, this);
- };
- Annotation.prototype.addClipPaths = function () {
- this.setClipAxes();
- if (this.clipXAxis && this.clipYAxis) {
- this.clipRect = this.chart.renderer.clipRect(this.getClipBox());
- }
- };
- Annotation.prototype.setClipAxes = function () {
- var xAxes = this.chart.xAxis,
- yAxes = this.chart.yAxis,
- linkedAxes = (this.options.labels || [])
- .concat(this.options.shapes || [])
- .reduce(function (axes,
- labelOrShape) {
- return [
- xAxes[labelOrShape &&
- labelOrShape.point &&
- labelOrShape.point.xAxis] || axes[0],
- yAxes[labelOrShape &&
- labelOrShape.point &&
- labelOrShape.point.yAxis] || axes[1]
- ];
- }, []);
- this.clipXAxis = linkedAxes[0];
- this.clipYAxis = linkedAxes[1];
- };
- Annotation.prototype.getClipBox = function () {
- if (this.clipXAxis && this.clipYAxis) {
- return {
- x: this.clipXAxis.left,
- y: this.clipYAxis.top,
- width: this.clipXAxis.width,
- height: this.clipYAxis.height
- };
- }
- };
- Annotation.prototype.setLabelCollector = function () {
- var annotation = this;
- annotation.labelCollector = function () {
- return annotation.labels.reduce(function (labels, label) {
- if (!label.options.allowOverlap) {
- labels.push(label.graphic);
- }
- return labels;
- }, []);
- };
- annotation.chart.labelCollectors.push(annotation.labelCollector);
- };
- /**
- * Set an annotation options.
- * @private
- * @param {Highcharts.AnnotationsOptions} - user options for an annotation
- */
- Annotation.prototype.setOptions = function (userOptions) {
- this.options = merge(this.defaultOptions, userOptions);
- };
- Annotation.prototype.redraw = function (animation) {
- this.linkPoints();
- if (!this.graphic) {
- this.render();
- }
- if (this.clipRect) {
- this.clipRect.animate(this.getClipBox());
- }
- this.redrawItems(this.shapes, animation);
- this.redrawItems(this.labels, animation);
- ControllableMixin.redraw.call(this, animation);
- };
- /**
- * @private
- * @param {Array<Highcharts.AnnotationControllable>} items
- * @param {boolean} [animation]
- */
- Annotation.prototype.redrawItems = function (items, animation) {
- var i = items.length;
- // needs a backward loop
- // labels/shapes array might be modified
- // due to destruction of the item
- while (i--) {
- this.redrawItem(items[i], animation);
- }
- };
- /**
- * @private
- * @param {Array<Highcharts.AnnotationControllable>} items
- */
- Annotation.prototype.renderItems = function (items) {
- var i = items.length;
- while (i--) {
- this.renderItem(items[i]);
- }
- };
- Annotation.prototype.render = function () {
- var renderer = this.chart.renderer;
- this.graphic = renderer
- .g('annotation')
- .attr({
- opacity: 0,
- zIndex: this.options.zIndex,
- visibility: this.options.visible ?
- 'visible' :
- 'hidden'
- })
- .add();
- this.shapesGroup = renderer
- .g('annotation-shapes')
- .add(this.graphic)
- .clip(this.chart.plotBoxClip);
- this.labelsGroup = renderer
- .g('annotation-labels')
- .attr({
- // hideOverlappingLabels requires translation
- translateX: 0,
- translateY: 0
- })
- .add(this.graphic);
- this.addClipPaths();
- if (this.clipRect) {
- this.graphic.clip(this.clipRect);
- }
- // Render shapes and labels before adding events (#13070).
- this.renderItems(this.shapes);
- this.renderItems(this.labels);
- this.addEvents();
- ControllableMixin.render.call(this);
- };
- /**
- * Set the annotation's visibility.
- * @private
- * @param {boolean} [visible]
- * Whether to show or hide an annotation. If the param is omitted, the
- * annotation's visibility is toggled.
- */
- Annotation.prototype.setVisibility = function (visible) {
- var options = this.options,
- visibility = pick(visible, !options.visible);
- this.graphic.attr('visibility', visibility ? 'visible' : 'hidden');
- if (!visibility) {
- this.setControlPointsVisibility(false);
- }
- options.visible = visibility;
- };
- Annotation.prototype.setControlPointsVisibility = function (visible) {
- var setItemControlPointsVisibility = function (item) {
- item.setControlPointsVisibility(visible);
- };
- ControllableMixin.setControlPointsVisibility.call(this, visible);
- this.shapes.forEach(setItemControlPointsVisibility);
- this.labels.forEach(setItemControlPointsVisibility);
- };
- /**
- * Destroy the annotation. This function does not touch the chart
- * that the annotation belongs to (all annotations are kept in
- * the chart.annotations array) - it is recommended to use
- * {@link Highcharts.Chart#removeAnnotation} instead.
- * @private
- */
- Annotation.prototype.destroy = function () {
- var chart = this.chart,
- destroyItem = function (item) {
- item.destroy();
- };
- this.labels.forEach(destroyItem);
- this.shapes.forEach(destroyItem);
- this.clipXAxis = null;
- this.clipYAxis = null;
- erase(chart.labelCollectors, this.labelCollector);
- EventEmitterMixin.destroy.call(this);
- ControllableMixin.destroy.call(this);
- destroyObjectProperties(this, chart);
- };
- /**
- * See {@link Highcharts.Chart#removeAnnotation}.
- * @private
- */
- Annotation.prototype.remove = function () {
- // Let chart.update() remove annoations on demand
- return this.chart.removeAnnotation(this);
- };
- /**
- * Updates an annotation.
- *
- * @function Highcharts.Annotation#update
- *
- * @param {Partial<Highcharts.AnnotationsOptions>} userOptions
- * New user options for the annotation.
- *
- * @return {void}
- */
- Annotation.prototype.update = function (userOptions, redraw) {
- var chart = this.chart,
- labelsAndShapes = this.getLabelsAndShapesOptions(this.userOptions,
- userOptions),
- userOptionsIndex = chart.annotations.indexOf(this),
- options = merge(true,
- this.userOptions,
- userOptions);
- options.labels = labelsAndShapes.labels;
- options.shapes = labelsAndShapes.shapes;
- this.destroy();
- this.constructor(chart, options);
- // Update options in chart options, used in exporting (#9767):
- chart.options.annotations[userOptionsIndex] = options;
- this.isUpdating = true;
- if (pick(redraw, true)) {
- chart.redraw();
- }
- fireEvent(this, 'afterUpdate');
- this.isUpdating = false;
- };
- /* *************************************************************
- * ITEM SECTION
- * Contains methods for handling a single item in an annotation
- **************************************************************** */
- /**
- * Initialisation of a single shape
- * @private
- * @param {Object} shapeOptions - a confg object for a single shape
- */
- Annotation.prototype.initShape = function (shapeOptions, index) {
- var options = merge(this.options.shapeOptions, {
- controlPointOptions: this.options.controlPointOptions
- },
- shapeOptions),
- shape = new Annotation.shapesMap[options.type](this,
- options,
- index);
- shape.itemType = 'shape';
- this.shapes.push(shape);
- return shape;
- };
- /**
- * Initialisation of a single label
- * @private
- */
- Annotation.prototype.initLabel = function (labelOptions, index) {
- var options = merge(this.options.labelOptions, {
- controlPointOptions: this.options.controlPointOptions
- },
- labelOptions),
- label = new ControllableLabel(this,
- options,
- index);
- label.itemType = 'label';
- this.labels.push(label);
- return label;
- };
- /**
- * Redraw a single item.
- * @private
- * @param {Annotation.Label|Annotation.Shape} item
- * @param {boolean} [animation]
- */
- Annotation.prototype.redrawItem = function (item, animation) {
- item.linkPoints();
- if (!item.shouldBeDrawn()) {
- this.destroyItem(item);
- }
- else {
- if (!item.graphic) {
- this.renderItem(item);
- }
- item.redraw(pick(animation, true) && item.graphic.placed);
- if (item.points.length) {
- this.adjustVisibility(item);
- }
- }
- };
- /**
- * Hide or show annotaiton attached to points.
- * @private
- * @param {Annotation.Label|Annotation.Shape} item
- */
- Annotation.prototype.adjustVisibility = function (item) {
- var hasVisiblePoints = false,
- label = item.graphic;
- item.points.forEach(function (point) {
- if (point.series.visible !== false &&
- point.visible !== false) {
- hasVisiblePoints = true;
- }
- });
- if (!hasVisiblePoints) {
- label.hide();
- }
- else if (label.visibility === 'hidden') {
- label.show();
- }
- };
- /**
- * Destroy a single item.
- * @private
- * @param {Annotation.Label|Annotation.Shape} item
- */
- Annotation.prototype.destroyItem = function (item) {
- // erase from shapes or labels array
- erase(this[item.itemType + 's'], item);
- item.destroy();
- };
- /**
- * @private
- */
- Annotation.prototype.renderItem = function (item) {
- item.render(item.itemType === 'label' ?
- this.labelsGroup :
- this.shapesGroup);
- };
- /**
- * @private
- */
- Annotation.ControlPoint = ControlPoint;
- /**
- * @private
- */
- Annotation.MockPoint = MockPoint;
- /**
- * An object uses for mapping between a shape type and a constructor.
- * To add a new shape type extend this object with type name as a key
- * and a constructor as its value.
- */
- Annotation.shapesMap = {
- 'rect': ControllableRect,
- 'circle': ControllableCircle,
- 'path': ControllablePath,
- 'image': ControllableImage
- };
- /**
- * @private
- */
- Annotation.types = {};
- return Annotation;
- }());
- merge(true, Annotation.prototype, ControllableMixin, EventEmitterMixin,
- // restore original Annotation implementation after mixin overwrite
- merge(Annotation.prototype,
- /** @lends Highcharts.Annotation# */
- {
- /**
- * List of events for `annotation.options.events` that should not be
- * added to `annotation.graphic` but to the `annotation`.
- *
- * @private
- * @type {Array<string>}
- */
- nonDOMEvents: ['add', 'afterUpdate', 'drag', 'remove'],
- /**
- * A basic type of an annotation. It allows to add custom labels
- * or shapes. The items can be tied to points, axis coordinates
- * or chart pixel coordinates.
- *
- * @sample highcharts/annotations/basic/
- * Basic annotations
- * @sample highcharts/demo/annotations/
- * Advanced annotations
- * @sample highcharts/css/annotations
- * Styled mode
- * @sample highcharts/annotations-advanced/controllable
- * Controllable items
- * @sample {highstock} stock/annotations/fibonacci-retracements
- * Custom annotation, Fibonacci retracement
- *
- * @type {Array<*>}
- * @since 6.0.0
- * @requires modules/annotations
- * @optionparent annotations
- *
- * @private
- */
- defaultOptions: {
- /**
- * Sets an ID for an annotation. Can be user later when
- * removing an annotation in [Chart#removeAnnotation(id)](
- * /class-reference/Highcharts.Chart#removeAnnotation) method.
- *
- * @type {number|string}
- * @apioption annotations.id
- */
- /**
- * Whether the annotation is visible.
- *
- * @sample highcharts/annotations/visible/
- * Set annotation visibility
- */
- visible: true,
- /**
- * Enable or disable the initial animation when a series is
- * displayed for the `annotation`. The animation can also be set
- * as a configuration object. Please note that this option only
- * applies to the initial animation.
- * For other animations, see [chart.animation](#chart.animation)
- * and the animation parameter under the API methods.
- * The following properties are supported:
- *
- * - `defer`: The animation delay time in milliseconds.
- *
- * @sample {highcharts} highcharts/annotations/defer/
- * Animation defer settings
- * @type {boolean|Partial<Highcharts.AnimationOptionsObject>}
- * @since 8.2.0
- * @apioption annotations.animation
- */
- animation: {},
- /**
- * The animation delay time in milliseconds.
- * Set to `0` renders annotation immediately.
- * As `undefined` inherits defer time from the [series.animation.defer](#plotOptions.series.animation.defer).
- *
- * @type {number}
- * @since 8.2.0
- * @apioption annotations.animation.defer
- */
- /**
- * Allow an annotation to be draggable by a user. Possible
- * values are `'x'`, `'xy'`, `'y'` and `''` (disabled).
- *
- * @sample highcharts/annotations/draggable/
- * Annotations draggable: 'xy'
- *
- * @type {Highcharts.AnnotationDraggableValue}
- */
- draggable: 'xy',
- /**
- * Options for annotation's labels. Each label inherits options
- * from the labelOptions object. An option from the labelOptions
- * can be overwritten by config for a specific label.
- *
- * @requires modules/annotations
- */
- labelOptions: {
- /**
- * The alignment of the annotation's label. If right,
- * the right side of the label should be touching the point.
- *
- * @sample highcharts/annotations/label-position/
- * Set labels position
- *
- * @type {Highcharts.AlignValue}
- */
- align: 'center',
- /**
- * Whether to allow the annotation's labels to overlap.
- * To make the labels less sensitive for overlapping,
- * the can be set to 0.
- *
- * @sample highcharts/annotations/tooltip-like/
- * Hide overlapping labels
- */
- allowOverlap: false,
- /**
- * The background color or gradient for the annotation's
- * label.
- *
- * @sample highcharts/annotations/label-presentation/
- * Set labels graphic options
- *
- * @type {Highcharts.ColorString|Highcharts.GradientColorObject|Highcharts.PatternObject}
- */
- backgroundColor: 'rgba(0, 0, 0, 0.75)',
- /**
- * The border color for the annotation's label.
- *
- * @sample highcharts/annotations/label-presentation/
- * Set labels graphic options
- *
- * @type {Highcharts.ColorString}
- */
- borderColor: palette.neutralColor100,
- /**
- * The border radius in pixels for the annotaiton's label.
- *
- * @sample highcharts/annotations/label-presentation/
- * Set labels graphic options
- */
- borderRadius: 3,
- /**
- * The border width in pixels for the annotation's label
- *
- * @sample highcharts/annotations/label-presentation/
- * Set labels graphic options
- */
- borderWidth: 1,
- /**
- * A class name for styling by CSS.
- *
- * @sample highcharts/css/annotations
- * Styled mode annotations
- *
- * @since 6.0.5
- */
- className: 'highcharts-no-tooltip',
- /**
- * Whether to hide the annotation's label
- * that is outside the plot area.
- *
- * @sample highcharts/annotations/label-crop-overflow/
- * Crop or justify labels
- */
- crop: false,
- /**
- * The label's pixel distance from the point.
- *
- * @sample highcharts/annotations/label-position/
- * Set labels position
- *
- * @type {number}
- * @apioption annotations.labelOptions.distance
- */
- /**
- * A
- * [format](https://www.highcharts.com/docs/chart-concepts/labels-and-string-formatting)
- * string for the data label.
- *
- * @see [plotOptions.series.dataLabels.format](plotOptions.series.dataLabels.format.html)
- *
- * @sample highcharts/annotations/label-text/
- * Set labels text
- *
- * @type {string}
- * @apioption annotations.labelOptions.format
- */
- /**
- * Alias for the format option.
- *
- * @see [format](annotations.labelOptions.format.html)
- *
- * @sample highcharts/annotations/label-text/
- * Set labels text
- *
- * @type {string}
- * @apioption annotations.labelOptions.text
- */
- /**
- * Callback JavaScript function to format the annotation's
- * label. Note that if a `format` or `text` are defined,
- * the format or text take precedence and the formatter is
- * ignored. `This` refers to a point object.
- *
- * @sample highcharts/annotations/label-text/
- * Set labels text
- *
- * @type {Highcharts.FormatterCallbackFunction<Highcharts.Point>}
- * @default function () { return defined(this.y) ? this.y : 'Annotation label'; }
- */
- formatter: function () {
- return defined(this.y) ? this.y : 'Annotation label';
- },
- /**
- * Whether the annotation is visible in the exported data
- * table.
- *
- * @sample highcharts/annotations/include-in-data-export/
- * Do not include in the data export
- *
- * @since 8.2.0
- * @requires modules/export-data
- */
- includeInDataExport: true,
- /**
- * How to handle the annotation's label that flow outside
- * the plot area. The justify option aligns the label inside
- * the plot area.
- *
- * @sample highcharts/annotations/label-crop-overflow/
- * Crop or justify labels
- *
- * @validvalue ["allow", "justify"]
- */
- overflow: 'justify',
- /**
- * When either the borderWidth or the backgroundColor is
- * set, this is the padding within the box.
- *
- * @sample highcharts/annotations/label-presentation/
- * Set labels graphic options
- */
- padding: 5,
- /**
- * The shadow of the box. The shadow can be an object
- * configuration containing `color`, `offsetX`, `offsetY`,
- * `opacity` and `width`.
- *
- * @sample highcharts/annotations/label-presentation/
- * Set labels graphic options
- *
- * @type {boolean|Highcharts.ShadowOptionsObject}
- */
- shadow: false,
- /**
- * The name of a symbol to use for the border around the
- * label. Symbols are predefined functions on the Renderer
- * object.
- *
- * @sample highcharts/annotations/shapes/
- * Available shapes for labels
- */
- shape: 'callout',
- /**
- * Styles for the annotation's label.
- *
- * @see [plotOptions.series.dataLabels.style](plotOptions.series.dataLabels.style.html)
- *
- * @sample highcharts/annotations/label-presentation/
- * Set labels graphic options
- *
- * @type {Highcharts.CSSObject}
- */
- style: {
- /** @ignore */
- fontSize: '11px',
- /** @ignore */
- fontWeight: 'normal',
- /** @ignore */
- color: 'contrast'
- },
- /**
- * Whether to [use HTML](https://www.highcharts.com/docs/chart-concepts/labels-and-string-formatting#html)
- * to render the annotation's label.
- */
- useHTML: false,
- /**
- * The vertical alignment of the annotation's label.
- *
- * @sample highcharts/annotations/label-position/
- * Set labels position
- *
- * @type {Highcharts.VerticalAlignValue}
- */
- verticalAlign: 'bottom',
- /**
- * The x position offset of the label relative to the point.
- * Note that if a `distance` is defined, the distance takes
- * precedence over `x` and `y` options.
- *
- * @sample highcharts/annotations/label-position/
- * Set labels position
- */
- x: 0,
- /**
- * The y position offset of the label relative to the point.
- * Note that if a `distance` is defined, the distance takes
- * precedence over `x` and `y` options.
- *
- * @sample highcharts/annotations/label-position/
- * Set labels position
- */
- y: -16
- },
- /**
- * An array of labels for the annotation. For options that apply
- * to multiple labels, they can be added to the
- * [labelOptions](annotations.labelOptions.html).
- *
- * @type {Array<*>}
- * @extends annotations.labelOptions
- * @apioption annotations.labels
- */
- /**
- * This option defines the point to which the label will be
- * connected. It can be either the point which exists in the
- * series - it is referenced by the point's id - or a new point
- * with defined x, y properties and optionally axes.
- *
- * @sample highcharts/annotations/mock-point/
- * Attach annotation to a mock point
- *
- * @declare Highcharts.AnnotationMockPointOptionsObject
- * @type {string|*}
- * @requires modules/annotations
- * @apioption annotations.labels.point
- */
- /**
- * The x position of the point. Units can be either in axis
- * or chart pixel coordinates.
- *
- * @type {number}
- * @apioption annotations.labels.point.x
- */
- /**
- * The y position of the point. Units can be either in axis
- * or chart pixel coordinates.
- *
- * @type {number}
- * @apioption annotations.labels.point.y
- */
- /**
- * This number defines which xAxis the point is connected to.
- * It refers to either the axis id or the index of the axis in
- * the xAxis array. If the option is not configured or the axis
- * is not found the point's x coordinate refers to the chart
- * pixels.
- *
- * @type {number|string|null}
- * @apioption annotations.labels.point.xAxis
- */
- /**
- * This number defines which yAxis the point is connected to.
- * It refers to either the axis id or the index of the axis in
- * the yAxis array. If the option is not configured or the axis
- * is not found the point's y coordinate refers to the chart
- * pixels.
- *
- * @type {number|string|null}
- * @apioption annotations.labels.point.yAxis
- */
- /**
- * An array of shapes for the annotation. For options that apply
- * to multiple shapes, then can be added to the
- * [shapeOptions](annotations.shapeOptions.html).
- *
- * @type {Array<*>}
- * @extends annotations.shapeOptions
- * @apioption annotations.shapes
- */
- /**
- * This option defines the point to which the shape will be
- * connected. It can be either the point which exists in the
- * series - it is referenced by the point's id - or a new point
- * with defined x, y properties and optionally axes.
- *
- * @declare Highcharts.AnnotationMockPointOptionsObject
- * @type {string|Highcharts.AnnotationMockPointOptionsObject}
- * @extends annotations.labels.point
- * @apioption annotations.shapes.point
- */
- /**
- * An array of points for the shape. This option is available
- * for shapes which can use multiple points such as path. A
- * point can be either a point object or a point's id.
- *
- * @see [annotations.shapes.point](annotations.shapes.point.html)
- *
- * @declare Highcharts.AnnotationMockPointOptionsObject
- * @type {Array<string|*>}
- * @extends annotations.labels.point
- * @apioption annotations.shapes.points
- */
- /**
- * The URL for an image to use as the annotation shape. Note,
- * type has to be set to `'image'`.
- *
- * @see [annotations.shapes.type](annotations.shapes.type)
- * @sample highcharts/annotations/shape-src/
- * Define a marker image url for annotations
- *
- * @type {string}
- * @apioption annotations.shapes.src
- */
- /**
- * Id of the marker which will be drawn at the final vertex of
- * the path. Custom markers can be defined in defs property.
- *
- * @see [defs.markers](defs.markers.html)
- *
- * @sample highcharts/annotations/custom-markers/
- * Define a custom marker for annotations
- *
- * @type {string}
- * @apioption annotations.shapes.markerEnd
- */
- /**
- * Id of the marker which will be drawn at the first vertex of
- * the path. Custom markers can be defined in defs property.
- *
- * @see [defs.markers](defs.markers.html)
- *
- * @sample {highcharts} highcharts/annotations/custom-markers/
- * Define a custom marker for annotations
- *
- * @type {string}
- * @apioption annotations.shapes.markerStart
- */
- /**
- * Options for annotation's shapes. Each shape inherits options
- * from the shapeOptions object. An option from the shapeOptions
- * can be overwritten by config for a specific shape.
- *
- * @requires modules/annotations
- */
- shapeOptions: {
- /**
- * The width of the shape.
- *
- * @sample highcharts/annotations/shape/
- * Basic shape annotation
- *
- * @type {number}
- * @apioption annotations.shapeOptions.width
- **/
- /**
- * The height of the shape.
- *
- * @sample highcharts/annotations/shape/
- * Basic shape annotation
- *
- * @type {number}
- * @apioption annotations.shapeOptions.height
- */
- /**
- * The type of the shape, e.g. circle or rectangle.
- *
- * @sample highcharts/annotations/shape/
- * Basic shape annotation
- *
- * @type {string}
- * @default rect
- * @apioption annotations.shapeOptions.type
- */
- /**
- * The URL for an image to use as the annotation shape.
- * Note, type has to be set to `'image'`.
- *
- * @see [annotations.shapeOptions.type](annotations.shapeOptions.type)
- * @sample highcharts/annotations/shape-src/
- * Define a marker image url for annotations
- *
- * @type {string}
- * @apioption annotations.shapeOptions.src
- */
- /**
- * Name of the dash style to use for the shape's stroke.
- *
- * @sample {highcharts} highcharts/plotoptions/series-dashstyle-all/
- * Possible values demonstrated
- *
- * @type {Highcharts.DashStyleValue}
- * @apioption annotations.shapeOptions.dashStyle
- */
- /**
- * The color of the shape's stroke.
- *
- * @sample highcharts/annotations/shape/
- * Basic shape annotation
- *
- * @type {Highcharts.ColorString}
- */
- stroke: 'rgba(0, 0, 0, 0.75)',
- /**
- * The pixel stroke width of the shape.
- *
- * @sample highcharts/annotations/shape/
- * Basic shape annotation
- */
- strokeWidth: 1,
- /**
- * The color of the shape's fill.
- *
- * @sample highcharts/annotations/shape/
- * Basic shape annotation
- *
- * @type {Highcharts.ColorString|Highcharts.GradientColorObject|Highcharts.PatternObject}
- */
- fill: 'rgba(0, 0, 0, 0.75)',
- /**
- * The radius of the shape.
- *
- * @sample highcharts/annotations/shape/
- * Basic shape annotation
- */
- r: 0,
- /**
- * Defines additional snapping area around an annotation
- * making this annotation to focus. Defined in pixels.
- */
- snap: 2
- },
- /**
- * Options for annotation's control points. Each control point
- * inherits options from controlPointOptions object.
- * Options from the controlPointOptions can be overwritten
- * by options in a specific control point.
- *
- * @declare Highcharts.AnnotationControlPointOptionsObject
- * @requires modules/annotations
- * @apioption annotations.controlPointOptions
- */
- controlPointOptions: {
- /**
- * @type {Highcharts.AnnotationControlPointPositionerFunction}
- * @apioption annotations.controlPointOptions.positioner
- */
- symbol: 'circle',
- width: 10,
- height: 10,
- style: {
- stroke: palette.neutralColor100,
- 'stroke-width': 2,
- fill: palette.backgroundColor
- },
- visible: false,
- events: {}
- },
- /**
- * Event callback when annotation is added to the chart.
- *
- * @type {Highcharts.EventCallbackFunction<Highcharts.Annotation>}
- * @since 7.1.0
- * @apioption annotations.events.add
- */
- /**
- * Event callback when annotation is updated (e.g. drag and
- * droppped or resized by control points).
- *
- * @type {Highcharts.EventCallbackFunction<Highcharts.Annotation>}
- * @since 7.1.0
- * @apioption annotations.events.afterUpdate
- */
- /**
- * Event callback when annotation is removed from the chart.
- *
- * @type {Highcharts.EventCallbackFunction<Highcharts.Annotation>}
- * @since 7.1.0
- * @apioption annotations.events.remove
- */
- /**
- * Events available in annotations.
- *
- * @requires modules/annotations
- */
- events: {},
- /**
- * The Z index of the annotation.
- */
- zIndex: 6
- }
- }));
- H.extendAnnotation = function (Constructor, BaseConstructor, prototype, defaultOptions) {
- BaseConstructor = BaseConstructor || Annotation;
- extend(Constructor.prototype, merge(BaseConstructor.prototype, prototype));
- Constructor.prototype.defaultOptions = merge(Constructor.prototype.defaultOptions, defaultOptions || {});
- };
- /* *********************************************************************
- *
- * EXTENDING CHART PROTOTYPE
- *
- ******************************************************************** */
- extend(chartProto, /** @lends Highcharts.Chart# */ {
- initAnnotation: function (userOptions) {
- var Constructor = Annotation.types[userOptions.type] || Annotation,
- annotation = new Constructor(this,
- userOptions);
- this.annotations.push(annotation);
- return annotation;
- },
- /**
- * Add an annotation to the chart after render time.
- *
- * @param {Highcharts.AnnotationsOptions} options
- * The annotation options for the new, detailed annotation.
- * @param {boolean} [redraw]
- *
- * @return {Highcharts.Annotation} - The newly generated annotation.
- */
- addAnnotation: function (userOptions, redraw) {
- var annotation = this.initAnnotation(userOptions);
- this.options.annotations.push(annotation.options);
- if (pick(redraw, true)) {
- annotation.redraw();
- annotation.graphic.attr({
- opacity: 1
- });
- }
- return annotation;
- },
- /**
- * Remove an annotation from the chart.
- *
- * @param {number|string|Highcharts.Annotation} idOrAnnotation
- * The annotation's id or direct annotation object.
- */
- removeAnnotation: function (idOrAnnotation) {
- var annotations = this.annotations,
- annotation = idOrAnnotation.coll === 'annotations' ?
- idOrAnnotation :
- find(annotations,
- function (annotation) {
- return annotation.options.id === idOrAnnotation;
- });
- if (annotation) {
- fireEvent(annotation, 'remove');
- erase(this.options.annotations, annotation.options);
- erase(annotations, annotation);
- annotation.destroy();
- }
- },
- drawAnnotations: function () {
- this.plotBoxClip.attr(this.plotBox);
- this.annotations.forEach(function (annotation) {
- annotation.redraw();
- annotation.graphic.animate({
- opacity: 1
- }, annotation.animationConfig);
- });
- }
- });
- // Let chart.update() update annotations
- chartProto.collectionsWithUpdate.push('annotations');
- // Let chart.update() create annoations on demand
- chartProto.collectionsWithInit.annotations = [chartProto.addAnnotation];
- // Create lookups initially
- addEvent(Chart, 'afterInit', function () {
- this.annotations = [];
- if (!this.options.annotations) {
- this.options.annotations = [];
- }
- });
- chartProto.callbacks.push(function (chart) {
- chart.plotBoxClip = this.renderer.clipRect(this.plotBox);
- chart.controlPointsGroup = chart.renderer
- .g('control-points')
- .attr({ zIndex: 99 })
- .clip(chart.plotBoxClip)
- .add();
- chart.options.annotations.forEach(function (annotationOptions, i) {
- if (
- // Verify that it has not been previously added in a responsive rule
- !chart.annotations.some(function (annotation) {
- return annotation.options === annotationOptions;
- })) {
- var annotation = chart.initAnnotation(annotationOptions);
- chart.options.annotations[i] = annotation.options;
- }
- });
- chart.drawAnnotations();
- addEvent(chart, 'redraw', chart.drawAnnotations);
- addEvent(chart, 'destroy', function () {
- chart.plotBoxClip.destroy();
- chart.controlPointsGroup.destroy();
- });
- addEvent(chart, 'exportData', function (event) {
- var annotations = chart.annotations,
- csvColumnHeaderFormatter = ((this.options.exporting &&
- this.options.exporting.csv) ||
- {}).columnHeaderFormatter,
- // If second row doesn't have xValues
- // then it is a title row thus multiple level header is in use.
- multiLevelHeaders = !event.dataRows[1].xValues,
- annotationHeader = (chart.options.lang &&
- chart.options.lang.exportData &&
- chart.options.lang.exportData.annotationHeader),
- columnHeaderFormatter = function (index) {
- var s;
- if (csvColumnHeaderFormatter) {
- s = csvColumnHeaderFormatter(index);
- if (s !== false) {
- return s;
- }
- }
- s = annotationHeader + ' ' + index;
- if (multiLevelHeaders) {
- return {
- columnTitle: s,
- topLevelColumnTitle: s
- };
- }
- return s;
- }, startRowLength = event.dataRows[0].length, annotationSeparator = (chart.options.exporting &&
- chart.options.exporting.csv &&
- chart.options.exporting.csv.annotations &&
- chart.options.exporting.csv.annotations.itemDelimiter), joinAnnotations = (chart.options.exporting &&
- chart.options.exporting.csv &&
- chart.options.exporting.csv.annotations &&
- chart.options.exporting.csv.annotations.join);
- annotations.forEach(function (annotation) {
- if (annotation.options.labelOptions.includeInDataExport) {
- annotation.labels.forEach(function (label) {
- if (label.options.text) {
- var annotationText_1 = label.options.text;
- label.points.forEach(function (points) {
- var annotationX = points.x,
- xAxisIndex = points.series.xAxis ?
- points.series.xAxis.options.index :
- -1;
- var wasAdded = false;
- // Annotation not connected to any xAxis -
- // add new row.
- if (xAxisIndex === -1) {
- var n = event.dataRows[0].length,
- newRow = new Array(n);
- for (var i = 0; i < n; ++i) {
- newRow[i] = '';
- }
- newRow.push(annotationText_1);
- newRow.xValues = [];
- newRow.xValues[xAxisIndex] = annotationX;
- event.dataRows.push(newRow);
- wasAdded = true;
- }
- // Annotation placed on a exported data point
- // - add new column
- if (!wasAdded) {
- event.dataRows.forEach(function (row, rowIndex) {
- if (!wasAdded &&
- row.xValues &&
- xAxisIndex !== void 0 &&
- annotationX === row.xValues[xAxisIndex]) {
- if (joinAnnotations &&
- row.length > startRowLength) {
- row[row.length - 1] +=
- annotationSeparator + annotationText_1;
- }
- else {
- row.push(annotationText_1);
- }
- wasAdded = true;
- }
- });
- }
- // Annotation not placed on any exported data point,
- // but connected to the xAxis - add new row
- if (!wasAdded) {
- var n = event.dataRows[0].length,
- newRow = new Array(n);
- for (var i = 0; i < n; ++i) {
- newRow[i] = '';
- }
- newRow[0] = annotationX;
- newRow.push(annotationText_1);
- newRow.xValues = [];
- if (xAxisIndex !== void 0) {
- newRow.xValues[xAxisIndex] = annotationX;
- }
- event.dataRows.push(newRow);
- }
- });
- }
- });
- }
- });
- var maxRowLen = 0;
- event.dataRows.forEach(function (row) {
- maxRowLen = Math.max(maxRowLen, row.length);
- });
- var newRows = maxRowLen - event.dataRows[0].length;
- for (var i = 0; i < newRows; i++) {
- var header = columnHeaderFormatter(i + 1);
- if (multiLevelHeaders) {
- event.dataRows[0].push(header.topLevelColumnTitle);
- event.dataRows[1].push(header.columnTitle);
- }
- else {
- event.dataRows[0].push(header);
- }
- }
- });
- });
- wrap(Pointer.prototype, 'onContainerMouseDown', function (proceed) {
- if (!this.chart.hasDraggedAnnotation) {
- proceed.apply(this, Array.prototype.slice.call(arguments, 1));
- }
- });
- H.Annotation = Annotation;
- return Annotation;
- });
- _registerModule(_modules, 'Mixins/Navigation.js', [], function () {
- /**
- *
- * (c) 2010-2021 Paweł Fus
- *
- * License: www.highcharts.com/license
- *
- * !!!!!!! SOURCE GETS TRANSPILED BY TYPESCRIPT. EDIT TS FILE ONLY. !!!!!!!
- *
- * */
- var chartNavigation = {
- /**
- * Initializes `chart.navigation` object which delegates `update()` methods
- * to all other common classes (used in exporting and navigationBindings).
- *
- * @private
- * @param {Highcharts.Chart} chart
- * The chart instance.
- * @return {void}
- */
- initUpdate: function (chart) {
- if (!chart.navigation) {
- chart.navigation = {
- updates: [],
- update: function (options,
- redraw) {
- this.updates.forEach(function (updateConfig) {
- updateConfig.update.call(updateConfig.context,
- options,
- redraw);
- });
- }
- };
- }
- },
- /**
- * Registers an `update()` method in the `chart.navigation` object.
- *
- * @private
- * @param {Highcharts.ChartNavigationUpdateFunction} update
- * The `update()` method that will be called in `chart.update()`.
- * @param {Highcharts.Chart} chart
- * The chart instance. `update()` will use that as a context
- * (`this`).
- * @return {void}
- */
- addUpdate: function (update, chart) {
- if (!chart.navigation) {
- this.initUpdate(chart);
- }
- chart.navigation.updates.push({
- update: update,
- context: chart
- });
- }
- };
- return chartNavigation;
- });
- _registerModule(_modules, 'Extensions/Annotations/NavigationBindings.js', [_modules['Extensions/Annotations/Annotations.js'], _modules['Core/Chart/Chart.js'], _modules['Mixins/Navigation.js'], _modules['Core/FormatUtilities.js'], _modules['Core/Globals.js'], _modules['Core/DefaultOptions.js'], _modules['Core/Utilities.js']], function (Annotation, Chart, chartNavigationMixin, F, H, D, U) {
- /* *
- *
- * (c) 2009-2021 Highsoft, Black Label
- *
- * License: www.highcharts.com/license
- *
- * !!!!!!! SOURCE GETS TRANSPILED BY TYPESCRIPT. EDIT TS FILE ONLY. !!!!!!!
- *
- * */
- var format = F.format;
- var setOptions = D.setOptions;
- var addEvent = U.addEvent,
- attr = U.attr,
- fireEvent = U.fireEvent,
- isArray = U.isArray,
- isFunction = U.isFunction,
- isNumber = U.isNumber,
- isObject = U.isObject,
- merge = U.merge,
- objectEach = U.objectEach,
- pick = U.pick;
- /**
- * A config object for navigation bindings in annotations.
- *
- * @interface Highcharts.NavigationBindingsOptionsObject
- */ /**
- * ClassName of the element for a binding.
- * @name Highcharts.NavigationBindingsOptionsObject#className
- * @type {string|undefined}
- */ /**
- * Last event to be fired after last step event.
- * @name Highcharts.NavigationBindingsOptionsObject#end
- * @type {Function|undefined}
- */ /**
- * Initial event, fired on a button click.
- * @name Highcharts.NavigationBindingsOptionsObject#init
- * @type {Function|undefined}
- */ /**
- * Event fired on first click on a chart.
- * @name Highcharts.NavigationBindingsOptionsObject#start
- * @type {Function|undefined}
- */ /**
- * Last event to be fired after last step event. Array of step events to be
- * called sequentially after each user click.
- * @name Highcharts.NavigationBindingsOptionsObject#steps
- * @type {Array<Function>|undefined}
- */
- var doc = H.doc,
- win = H.win,
- PREFIX = 'highcharts-';
- /* eslint-disable no-invalid-this, valid-jsdoc */
- /**
- * IE 9-11 polyfill for Element.closest():
- * @private
- */
- function closestPolyfill(el, s) {
- var ElementProto = win.Element.prototype,
- elementMatches = ElementProto.matches ||
- ElementProto.msMatchesSelector ||
- ElementProto.webkitMatchesSelector,
- ret = null;
- if (ElementProto.closest) {
- ret = ElementProto.closest.call(el, s);
- }
- else {
- do {
- if (elementMatches.call(el, s)) {
- return el;
- }
- el = el.parentElement || el.parentNode;
- } while (el !== null && el.nodeType === 1);
- }
- return ret;
- }
- /**
- * @private
- * @interface bindingsUtils
- */
- var bindingsUtils = {
- /**
- * Get field type according to value
- *
- * @private
- * @function Highcharts.NavigationBindingsUtilsObject.getFieldType
- *
- * @param {'boolean'|'number'|'string'} value
- * Atomic type (one of: string,
- number,
- boolean)
- *
- * @return {'checkbox'|'number'|'text'}
- * Field type (one of: text,
- number,
- checkbox)
- */
- getFieldType: function (value) {
- return {
- 'string': 'text',
- 'number': 'number',
- 'boolean': 'checkbox'
- }[typeof value];
- },
- /**
- * Update size of background (rect) in some annotations: Measure, Simple
- * Rect.
- *
- * @private
- * @function Highcharts.NavigationBindingsUtilsObject.updateRectSize
- *
- * @param {Highcharts.PointerEventObject} event
- * Normalized browser event
- *
- * @param {Highcharts.Annotation} annotation
- * Annotation to be updated
- */
- updateRectSize: function (event, annotation) {
- var chart = annotation.chart,
- options = annotation.options.typeOptions,
- coords = chart.pointer.getCoordinates(event),
- coordsX = chart.navigationBindings.utils.getAssignedAxis(coords.xAxis),
- coordsY = chart.navigationBindings.utils.getAssignedAxis(coords.yAxis),
- width,
- height;
- if (coordsX && coordsY) {
- width = coordsX.value - options.point.x;
- height = options.point.y - coordsY.value;
- annotation.update({
- typeOptions: {
- background: {
- width: chart.inverted ? height : width,
- height: chart.inverted ? width : height
- }
- }
- });
- }
- },
- /**
- * Returns the first xAxis or yAxis that was clicked with its value.
- *
- * @private
- * @function Highcharts.NavigationBindingsUtilsObject#getAssignedAxis
- *
- * @param {Array<Highcharts.PointerAxisCoordinateObject>} coords
- * All the chart's x or y axes with a current pointer's axis value.
- *
- * @return {Highcharts.PointerAxisCoordinateObject}
- * Object with a first found axis and its value that pointer
- * is currently pointing.
- */
- getAssignedAxis: function (coords) {
- return coords.filter(function (coord) {
- var axisMin = coord.axis.min,
- axisMax = coord.axis.max,
- // Correct axis edges when axis has series
- // with pointRange (like column)
- minPointOffset = pick(coord.axis.minPointOffset, 0);
- return isNumber(axisMin) && isNumber(axisMax) &&
- coord.value >= (axisMin - minPointOffset) &&
- coord.value <= (axisMax + minPointOffset) &&
- // don't count navigator axis
- !coord.axis.options.isInternal;
- })[0]; // If the axes overlap, return the first axis that was found.
- }
- };
- /**
- * @private
- */
- var NavigationBindings = /** @class */ (function () {
- /* *
- *
- * Constructors
- *
- * */
- function NavigationBindings(chart, options) {
- this.boundClassNames = void 0;
- this.selectedButton = void 0;
- this.chart = chart;
- this.options = options;
- this.eventsToUnbind = [];
- this.container = doc.getElementsByClassName(this.options.bindingsClassName || '');
- }
- // Private properties added by bindings:
- // Active (selected) annotation that is editted through popup/forms
- // activeAnnotation: Annotation
- // Holder for current step, used on mouse move to update bound object
- // mouseMoveEvent: function () {}
- // Next event in `step` array to be called on chart's click
- // nextEvent: function () {}
- // Index in the `step` array of the current event
- // stepIndex: 0
- // Flag to determine if current binding has steps
- // steps: true|false
- // Bindings holder for all events
- // selectedButton: {}
- // Holder for user options, returned from `start` event, and passed on to
- // `step`'s' and `end`.
- // currentUserDetails: {}
- /* *
- *
- * Functions
- *
- * */
- /**
- * Initi all events conencted to NavigationBindings.
- *
- * @private
- * @function Highcharts.NavigationBindings#initEvents
- */
- NavigationBindings.prototype.initEvents = function () {
- var navigation = this,
- chart = navigation.chart,
- bindingsContainer = navigation.container,
- options = navigation.options;
- // Shorthand object for getting events for buttons:
- navigation.boundClassNames = {};
- objectEach((options.bindings || {}), function (value) {
- navigation.boundClassNames[value.className] = value;
- });
- // Handle multiple containers with the same class names:
- [].forEach.call(bindingsContainer, function (subContainer) {
- navigation.eventsToUnbind.push(addEvent(subContainer, 'click', function (event) {
- var bindings = navigation.getButtonEvents(subContainer,
- event);
- if (bindings && bindings.button.className.indexOf('highcharts-disabled-btn') === -1) {
- navigation.bindingsButtonClick(bindings.button, bindings.events, event);
- }
- }));
- });
- objectEach(options.events || {}, function (callback, eventName) {
- if (isFunction(callback)) {
- navigation.eventsToUnbind.push(addEvent(navigation, eventName, callback, { passive: false }));
- }
- });
- navigation.eventsToUnbind.push(addEvent(chart.container, 'click', function (e) {
- if (!chart.cancelClick &&
- chart.isInsidePlot(e.chartX - chart.plotLeft, e.chartY - chart.plotTop, {
- visiblePlotOnly: true
- })) {
- navigation.bindingsChartClick(this, e);
- }
- }));
- navigation.eventsToUnbind.push(addEvent(chart.container, H.isTouchDevice ? 'touchmove' : 'mousemove', function (e) {
- navigation.bindingsContainerMouseMove(this, e);
- }, H.isTouchDevice ? { passive: false } : void 0));
- };
- /**
- * Common chart.update() delegation, shared between bindings and exporting.
- *
- * @private
- * @function Highcharts.NavigationBindings#initUpdate
- */
- NavigationBindings.prototype.initUpdate = function () {
- var navigation = this;
- chartNavigationMixin.addUpdate(function (options) {
- navigation.update(options);
- }, this.chart);
- };
- /**
- * Hook for click on a button, method selcts/unselects buttons,
- * then calls `bindings.init` callback.
- *
- * @private
- * @function Highcharts.NavigationBindings#bindingsButtonClick
- *
- * @param {Highcharts.HTMLDOMElement} [button]
- * Clicked button
- *
- * @param {object} events
- * Events passed down from bindings (`init`, `start`, `step`, `end`)
- *
- * @param {Highcharts.PointerEventObject} clickEvent
- * Browser's click event
- */
- NavigationBindings.prototype.bindingsButtonClick = function (button, events, clickEvent) {
- var navigation = this,
- chart = navigation.chart;
- if (navigation.selectedButtonElement) {
- fireEvent(navigation, 'deselectButton', { button: navigation.selectedButtonElement });
- if (navigation.nextEvent) {
- // Remove in-progress annotations adders:
- if (navigation.currentUserDetails &&
- navigation.currentUserDetails.coll === 'annotations') {
- chart.removeAnnotation(navigation.currentUserDetails);
- }
- navigation.mouseMoveEvent = navigation.nextEvent = false;
- }
- }
- navigation.selectedButton = events;
- navigation.selectedButtonElement = button;
- fireEvent(navigation, 'selectButton', { button: button });
- // Call "init" event, for example to open modal window
- if (events.init) {
- events.init.call(navigation, button, clickEvent);
- }
- if (events.start || events.steps) {
- chart.renderer.boxWrapper.addClass(PREFIX + 'draw-mode');
- }
- };
- /**
- * Hook for click on a chart, first click on a chart calls `start` event,
- * then on all subsequent clicks iterate over `steps` array.
- * When finished, calls `end` event.
- *
- * @private
- * @function Highcharts.NavigationBindings#bindingsChartClick
- *
- * @param {Highcharts.Chart} chart
- * Chart that click was performed on.
- *
- * @param {Highcharts.PointerEventObject} clickEvent
- * Browser's click event.
- */
- NavigationBindings.prototype.bindingsChartClick = function (chart, clickEvent) {
- chart = this.chart;
- var navigation = this,
- selectedButton = navigation.selectedButton,
- svgContainer = chart.renderer.boxWrapper;
- // Click outside popups, should close them and deselect the annotation
- if (navigation.activeAnnotation &&
- !clickEvent.activeAnnotation &&
- // Element could be removed in the child action, e.g. button
- clickEvent.target.parentNode &&
- // TO DO: Polyfill for IE11?
- !closestPolyfill(clickEvent.target, '.' + PREFIX + 'popup')) {
- fireEvent(navigation, 'closePopup');
- }
- if (!selectedButton || !selectedButton.start) {
- return;
- }
- if (!navigation.nextEvent) {
- // Call init method:
- navigation.currentUserDetails = selectedButton.start.call(navigation, clickEvent);
- // If steps exists (e.g. Annotations), bind them:
- if (navigation.currentUserDetails && selectedButton.steps) {
- navigation.stepIndex = 0;
- navigation.steps = true;
- navigation.mouseMoveEvent = navigation.nextEvent =
- selectedButton.steps[navigation.stepIndex];
- }
- else {
- fireEvent(navigation, 'deselectButton', { button: navigation.selectedButtonElement });
- svgContainer.removeClass(PREFIX + 'draw-mode');
- navigation.steps = false;
- navigation.selectedButton = null;
- // First click is also the last one:
- if (selectedButton.end) {
- selectedButton.end.call(navigation, clickEvent, navigation.currentUserDetails);
- }
- }
- }
- else {
- navigation.nextEvent(clickEvent, navigation.currentUserDetails);
- if (navigation.steps) {
- navigation.stepIndex++;
- if (selectedButton.steps[navigation.stepIndex]) {
- // If we have more steps, bind them one by one:
- navigation.mouseMoveEvent = navigation.nextEvent =
- selectedButton.steps[navigation.stepIndex];
- }
- else {
- fireEvent(navigation, 'deselectButton', { button: navigation.selectedButtonElement });
- svgContainer.removeClass(PREFIX + 'draw-mode');
- // That was the last step, call end():
- if (selectedButton.end) {
- selectedButton.end.call(navigation, clickEvent, navigation.currentUserDetails);
- }
- navigation.nextEvent = false;
- navigation.mouseMoveEvent = false;
- navigation.selectedButton = null;
- }
- }
- }
- };
- /**
- * Hook for mouse move on a chart's container. It calls current step.
- *
- * @private
- * @function Highcharts.NavigationBindings#bindingsContainerMouseMove
- *
- * @param {Highcharts.HTMLDOMElement} container
- * Chart's container.
- *
- * @param {global.Event} moveEvent
- * Browser's move event.
- */
- NavigationBindings.prototype.bindingsContainerMouseMove = function (_container, moveEvent) {
- if (this.mouseMoveEvent) {
- this.mouseMoveEvent(moveEvent, this.currentUserDetails);
- }
- };
- /**
- * Translate fields (e.g. `params.period` or `marker.styles.color`) to
- * Highcharts options object (e.g. `{ params: { period } }`).
- *
- * @private
- * @function Highcharts.NavigationBindings#fieldsToOptions<T>
- *
- * @param {Highcharts.Dictionary<string>} fields
- * Fields from popup form.
- *
- * @param {T} config
- * Default config to be modified.
- *
- * @return {T}
- * Modified config
- */
- NavigationBindings.prototype.fieldsToOptions = function (fields, config) {
- objectEach(fields, function (value, field) {
- var parsedValue = parseFloat(value),
- path = field.split('.'),
- parent = config,
- pathLength = path.length - 1;
- // If it's a number (not "format" options), parse it:
- if (isNumber(parsedValue) &&
- !value.match(/px/g) &&
- !field.match(/format/g)) {
- value = parsedValue;
- }
- // Remove empty strings or values like 0
- if (value !== '' && value !== 'undefined') {
- path.forEach(function (name, index) {
- var nextName = pick(path[index + 1], '');
- if (pathLength === index) {
- // Last index, put value:
- parent[name] = value;
- }
- else if (!parent[name]) {
- // Create middle property:
- parent[name] = nextName.match(/\d/g) ? [] : {};
- parent = parent[name];
- }
- else {
- // Jump into next property
- parent = parent[name];
- }
- });
- }
- });
- return config;
- };
- /**
- * Shorthand method to deselect an annotation.
- *
- * @function Highcharts.NavigationBindings#deselectAnnotation
- */
- NavigationBindings.prototype.deselectAnnotation = function () {
- if (this.activeAnnotation) {
- this.activeAnnotation.setControlPointsVisibility(false);
- this.activeAnnotation = false;
- }
- };
- /**
- * Generates API config for popup in the same format as options for
- * Annotation object.
- *
- * @function Highcharts.NavigationBindings#annotationToFields
- *
- * @param {Highcharts.Annotation} annotation
- * Annotations object
- *
- * @return {Highcharts.Dictionary<string>}
- * Annotation options to be displayed in popup box
- */
- NavigationBindings.prototype.annotationToFields = function (annotation) {
- var options = annotation.options,
- editables = NavigationBindings.annotationsEditable,
- nestedEditables = editables.nestedOptions,
- getFieldType = this.utils.getFieldType,
- type = pick(options.type,
- options.shapes && options.shapes[0] &&
- options.shapes[0].type,
- options.labels && options.labels[0] &&
- options.labels[0].itemType, 'label'),
- nonEditables = NavigationBindings.annotationsNonEditable[options.langKey] || [],
- visualOptions = {
- langKey: options.langKey,
- type: type
- };
- /**
- * Nested options traversing. Method goes down to the options and copies
- * allowed options (with values) to new object, which is last parameter:
- * "parent".
- *
- * @private
- *
- * @param {*} option
- * Atomic type or object/array
- *
- * @param {string} key
- * Option name, for example "visible" or "x", "y"
- *
- * @param {object} parentEditables
- * Editables from NavigationBindings.annotationsEditable
- *
- * @param {object} parent
- * Where new options will be assigned
- */
- function traverse(option, key, parentEditables, parent) {
- var nextParent;
- if (parentEditables &&
- option &&
- nonEditables.indexOf(key) === -1 &&
- ((parentEditables.indexOf &&
- parentEditables.indexOf(key)) >= 0 ||
- parentEditables[key] || // nested array
- parentEditables === true // simple array
- )) {
- // Roots:
- if (isArray(option)) {
- parent[key] = [];
- option.forEach(function (arrayOption, i) {
- if (!isObject(arrayOption)) {
- // Simple arrays, e.g. [String, Number, Boolean]
- traverse(arrayOption, 0, nestedEditables[key], parent[key]);
- }
- else {
- // Advanced arrays, e.g. [Object, Object]
- parent[key][i] = {};
- objectEach(arrayOption, function (nestedOption, nestedKey) {
- traverse(nestedOption, nestedKey, nestedEditables[key], parent[key][i]);
- });
- }
- });
- }
- else if (isObject(option)) {
- nextParent = {};
- if (isArray(parent)) {
- parent.push(nextParent);
- nextParent[key] = {};
- nextParent = nextParent[key];
- }
- else {
- parent[key] = nextParent;
- }
- objectEach(option, function (nestedOption, nestedKey) {
- traverse(nestedOption, nestedKey, key === 0 ? parentEditables : nestedEditables[key], nextParent);
- });
- }
- else {
- // Leaf:
- if (key === 'format') {
- parent[key] = [
- format(option, annotation.labels[0].points[0]).toString(),
- 'text'
- ];
- }
- else if (isArray(parent)) {
- parent.push([option, getFieldType(option)]);
- }
- else {
- parent[key] = [option, getFieldType(option)];
- }
- }
- }
- }
- objectEach(options, function (option, key) {
- if (key === 'typeOptions') {
- visualOptions[key] = {};
- objectEach(options[key], function (typeOption, typeKey) {
- traverse(typeOption, typeKey, nestedEditables, visualOptions[key], true);
- });
- }
- else {
- traverse(option, key, editables[type], visualOptions);
- }
- });
- return visualOptions;
- };
- /**
- * Get all class names for all parents in the element. Iterates until finds
- * main container.
- *
- * @function Highcharts.NavigationBindings#getClickedClassNames
- *
- * @param {Highcharts.HTMLDOMElement}
- * Container that event is bound to.
- *
- * @param {global.Event} event
- * Browser's event.
- *
- * @return {Array<Array<string, Highcharts.HTMLDOMElement>>}
- * Array of class names with corresponding elements
- */
- NavigationBindings.prototype.getClickedClassNames = function (container, event) {
- var element = event.target,
- classNames = [],
- elemClassName;
- while (element) {
- elemClassName = attr(element, 'class');
- if (elemClassName) {
- classNames = classNames.concat(elemClassName
- .split(' ')
- .map(function (name) {
- return [
- name,
- element
- ];
- }));
- }
- element = element.parentNode;
- if (element === container) {
- return classNames;
- }
- }
- return classNames;
- };
- /**
- * Get events bound to a button. It's a custom event delegation to find all
- * events connected to the element.
- *
- * @private
- * @function Highcharts.NavigationBindings#getButtonEvents
- *
- * @param {Highcharts.HTMLDOMElement} container
- * Container that event is bound to.
- *
- * @param {global.Event} event
- * Browser's event.
- *
- * @return {object}
- * Object with events (init, start, steps, and end)
- */
- NavigationBindings.prototype.getButtonEvents = function (container, event) {
- var navigation = this,
- classNames = this.getClickedClassNames(container,
- event),
- bindings;
- classNames.forEach(function (className) {
- if (navigation.boundClassNames[className[0]] && !bindings) {
- bindings = {
- events: navigation.boundClassNames[className[0]],
- button: className[1]
- };
- }
- });
- return bindings;
- };
- /**
- * Bindings are just events, so the whole update process is simply
- * removing old events and adding new ones.
- *
- * @private
- * @function Highcharts.NavigationBindings#update
- */
- NavigationBindings.prototype.update = function (options) {
- this.options = merge(true, this.options, options);
- this.removeEvents();
- this.initEvents();
- };
- /**
- * Remove all events created in the navigation.
- *
- * @private
- * @function Highcharts.NavigationBindings#removeEvents
- */
- NavigationBindings.prototype.removeEvents = function () {
- this.eventsToUnbind.forEach(function (unbinder) {
- unbinder();
- });
- };
- NavigationBindings.prototype.destroy = function () {
- this.removeEvents();
- };
- /* *
- *
- * Static Properties
- *
- * */
- // Define which options from annotations should show up in edit box:
- NavigationBindings.annotationsEditable = {
- // `typeOptions` are always available
- // Nested and shared options:
- nestedOptions: {
- labelOptions: ['style', 'format', 'backgroundColor'],
- labels: ['style'],
- label: ['style'],
- style: ['fontSize', 'color'],
- background: ['fill', 'strokeWidth', 'stroke'],
- innerBackground: ['fill', 'strokeWidth', 'stroke'],
- outerBackground: ['fill', 'strokeWidth', 'stroke'],
- shapeOptions: ['fill', 'strokeWidth', 'stroke'],
- shapes: ['fill', 'strokeWidth', 'stroke'],
- line: ['strokeWidth', 'stroke'],
- backgroundColors: [true],
- connector: ['fill', 'strokeWidth', 'stroke'],
- crosshairX: ['strokeWidth', 'stroke'],
- crosshairY: ['strokeWidth', 'stroke']
- },
- // Simple shapes:
- circle: ['shapes'],
- verticalLine: [],
- label: ['labelOptions'],
- // Measure
- measure: ['background', 'crosshairY', 'crosshairX'],
- // Others:
- fibonacci: [],
- tunnel: ['background', 'line', 'height'],
- pitchfork: ['innerBackground', 'outerBackground'],
- rect: ['shapes'],
- // Crooked lines, elliots, arrows etc:
- crookedLine: [],
- basicAnnotation: ['shapes', 'labelOptions']
- };
- // Define non editable fields per annotation, for example Rectangle inherits
- // options from Measure, but crosshairs are not available
- NavigationBindings.annotationsNonEditable = {
- rectangle: ['crosshairX', 'crosshairY', 'label']
- };
- return NavigationBindings;
- }());
- /**
- * General utils for bindings
- *
- * @private
- * @name Highcharts.NavigationBindings.utils
- * @type {bindingsUtils}
- */
- NavigationBindings.prototype.utils = bindingsUtils;
- Chart.prototype.initNavigationBindings = function () {
- var chart = this,
- options = chart.options;
- if (options && options.navigation && options.navigation.bindings) {
- chart.navigationBindings = new NavigationBindings(chart, options.navigation);
- chart.navigationBindings.initEvents();
- chart.navigationBindings.initUpdate();
- }
- };
- addEvent(Chart, 'load', function () {
- this.initNavigationBindings();
- });
- addEvent(Chart, 'destroy', function () {
- if (this.navigationBindings) {
- this.navigationBindings.destroy();
- }
- });
- addEvent(NavigationBindings, 'deselectButton', function () {
- this.selectedButtonElement = null;
- });
- addEvent(Annotation, 'remove', function () {
- if (this.chart.navigationBindings) {
- this.chart.navigationBindings.deselectAnnotation();
- }
- });
- /**
- * Show edit-annotation form:
- * @private
- */
- function selectableAnnotation(annotationType) {
- var originalClick = annotationType.prototype.defaultOptions.events &&
- annotationType.prototype.defaultOptions.events.click;
- /**
- * @private
- */
- function selectAndShowPopup(eventArguments) {
- var annotation = this,
- navigation = annotation.chart.navigationBindings,
- prevAnnotation = navigation.activeAnnotation;
- if (originalClick) {
- originalClick.call(annotation, eventArguments);
- }
- if (prevAnnotation !== annotation) {
- // Select current:
- navigation.deselectAnnotation();
- navigation.activeAnnotation = annotation;
- annotation.setControlPointsVisibility(true);
- fireEvent(navigation, 'showPopup', {
- annotation: annotation,
- formType: 'annotation-toolbar',
- options: navigation.annotationToFields(annotation),
- onSubmit: function (data) {
- var config = {},
- typeOptions;
- if (data.actionType === 'remove') {
- navigation.activeAnnotation = false;
- navigation.chart.removeAnnotation(annotation);
- }
- else {
- navigation.fieldsToOptions(data.fields, config);
- navigation.deselectAnnotation();
- typeOptions = config.typeOptions;
- if (annotation.options.type === 'measure') {
- // Manually disable crooshars according to
- // stroke width of the shape:
- typeOptions.crosshairY.enabled =
- typeOptions.crosshairY.strokeWidth !== 0;
- typeOptions.crosshairX.enabled =
- typeOptions.crosshairX.strokeWidth !== 0;
- }
- annotation.update(config);
- }
- }
- });
- }
- else {
- // Deselect current:
- fireEvent(navigation, 'closePopup');
- }
- // Let bubble event to chart.click:
- eventArguments.activeAnnotation = true;
- }
- merge(true, annotationType.prototype.defaultOptions.events, {
- click: selectAndShowPopup
- });
- }
- if (H.Annotation) {
- // Basic shapes:
- selectableAnnotation(Annotation);
- // Advanced annotations:
- objectEach(Annotation.types, function (annotationType) {
- selectableAnnotation(annotationType);
- });
- }
- setOptions({
- /**
- * @optionparent lang
- *
- * @private
- */
- lang: {
- /**
- * Configure the Popup strings in the chart. Requires the
- * `annotations.js` or `annotations-advanced.src.js` module to be
- * loaded.
- *
- * @since 7.0.0
- * @product highcharts highstock
- */
- navigation: {
- /**
- * Translations for all field names used in popup.
- *
- * @product highcharts highstock
- */
- popup: {
- simpleShapes: 'Simple shapes',
- lines: 'Lines',
- circle: 'Circle',
- rectangle: 'Rectangle',
- label: 'Label',
- shapeOptions: 'Shape options',
- typeOptions: 'Details',
- fill: 'Fill',
- format: 'Text',
- strokeWidth: 'Line width',
- stroke: 'Line color',
- title: 'Title',
- name: 'Name',
- labelOptions: 'Label options',
- labels: 'Labels',
- backgroundColor: 'Background color',
- backgroundColors: 'Background colors',
- borderColor: 'Border color',
- borderRadius: 'Border radius',
- borderWidth: 'Border width',
- style: 'Style',
- padding: 'Padding',
- fontSize: 'Font size',
- color: 'Color',
- height: 'Height',
- shapes: 'Shape options'
- }
- }
- },
- /**
- * @optionparent navigation
- * @product highcharts highstock
- *
- * @private
- */
- navigation: {
- /**
- * A CSS class name where all bindings will be attached to. Multiple
- * charts on the same page should have separate class names to prevent
- * duplicating events.
- *
- * Default value of versions < 7.0.4 `highcharts-bindings-wrapper`
- *
- * @since 7.0.0
- * @type {string}
- */
- bindingsClassName: 'highcharts-bindings-container',
- /**
- * Bindings definitions for custom HTML buttons. Each binding implements
- * simple event-driven interface:
- *
- * - `className`: classname used to bind event to
- *
- * - `init`: initial event, fired on button click
- *
- * - `start`: fired on first click on a chart
- *
- * - `steps`: array of sequential events fired one after another on each
- * of users clicks
- *
- * - `end`: last event to be called after last step event
- *
- * @type {Highcharts.Dictionary<Highcharts.NavigationBindingsOptionsObject>|*}
- * @sample stock/stocktools/stocktools-thresholds
- * Custom bindings in Highcharts Stock
- * @since 7.0.0
- * @product highcharts highstock
- */
- bindings: {
- /**
- * A circle annotation bindings. Includes `start` and one event in
- * `steps` array.
- *
- * @type {Highcharts.NavigationBindingsOptionsObject}
- * @default {"className": "highcharts-circle-annotation", "start": function() {}, "steps": [function() {}], "annotationsOptions": {}}
- */
- circleAnnotation: {
- /** @ignore-option */
- className: 'highcharts-circle-annotation',
- /** @ignore-option */
- start: function (e) {
- var coords = this.chart.pointer.getCoordinates(e),
- coordsX = this.utils.getAssignedAxis(coords.xAxis),
- coordsY = this.utils.getAssignedAxis(coords.yAxis),
- navigation = this.chart.options.navigation;
- // Exit if clicked out of axes area
- if (!coordsX || !coordsY) {
- return;
- }
- return this.chart.addAnnotation(merge({
- langKey: 'circle',
- type: 'basicAnnotation',
- shapes: [{
- type: 'circle',
- point: {
- x: coordsX.value,
- y: coordsY.value,
- xAxis: coordsX.axis.options.index,
- yAxis: coordsY.axis.options.index
- },
- r: 5
- }]
- }, navigation
- .annotationsOptions, navigation
- .bindings
- .circleAnnotation
- .annotationsOptions));
- },
- /** @ignore-option */
- steps: [
- function (e, annotation) {
- var mockPointOpts = annotation.options.shapes[0]
- .point,
- inverted = this.chart.inverted,
- x,
- y,
- distance;
- if (isNumber(mockPointOpts.xAxis) &&
- isNumber(mockPointOpts.yAxis)) {
- x = this.chart.xAxis[mockPointOpts.xAxis]
- .toPixels(mockPointOpts.x);
- y = this.chart.yAxis[mockPointOpts.yAxis]
- .toPixels(mockPointOpts.y);
- distance = Math.max(Math.sqrt(Math.pow(inverted ? y - e.chartX : x - e.chartX, 2) +
- Math.pow(inverted ? x - e.chartY : y - e.chartY, 2)), 5);
- }
- annotation.update({
- shapes: [{
- r: distance
- }]
- });
- }
- ]
- },
- /**
- * A rectangle annotation bindings. Includes `start` and one event
- * in `steps` array.
- *
- * @type {Highcharts.NavigationBindingsOptionsObject}
- * @default {"className": "highcharts-rectangle-annotation", "start": function() {}, "steps": [function() {}], "annotationsOptions": {}}
- */
- rectangleAnnotation: {
- /** @ignore-option */
- className: 'highcharts-rectangle-annotation',
- /** @ignore-option */
- start: function (e) {
- var coords = this.chart.pointer.getCoordinates(e),
- coordsX = this.utils.getAssignedAxis(coords.xAxis),
- coordsY = this.utils.getAssignedAxis(coords.yAxis);
- // Exit if clicked out of axes area
- if (!coordsX || !coordsY) {
- return;
- }
- var x = coordsX.value,
- y = coordsY.value,
- xAxis = coordsX.axis.options.index,
- yAxis = coordsY.axis.options.index,
- navigation = this.chart.options.navigation;
- return this.chart.addAnnotation(merge({
- langKey: 'rectangle',
- type: 'basicAnnotation',
- shapes: [{
- type: 'path',
- points: [
- { xAxis: xAxis, yAxis: yAxis, x: x, y: y },
- { xAxis: xAxis, yAxis: yAxis, x: x, y: y },
- { xAxis: xAxis, yAxis: yAxis, x: x, y: y },
- { xAxis: xAxis, yAxis: yAxis, x: x, y: y }
- ]
- }]
- }, navigation
- .annotationsOptions, navigation
- .bindings
- .rectangleAnnotation
- .annotationsOptions));
- },
- /** @ignore-option */
- steps: [
- function (e, annotation) {
- var points = annotation.options.shapes[0].points,
- coords = this.chart.pointer.getCoordinates(e),
- coordsX = this.utils.getAssignedAxis(coords.xAxis),
- coordsY = this.utils.getAssignedAxis(coords.yAxis),
- x,
- y;
- if (coordsX && coordsY) {
- x = coordsX.value;
- y = coordsY.value;
- // Top right point
- points[1].x = x;
- // Bottom right point (cursor position)
- points[2].x = x;
- points[2].y = y;
- // Bottom left
- points[3].y = y;
- annotation.update({
- shapes: [{
- points: points
- }]
- });
- }
- }
- ]
- },
- /**
- * A label annotation bindings. Includes `start` event only.
- *
- * @type {Highcharts.NavigationBindingsOptionsObject}
- * @default {"className": "highcharts-label-annotation", "start": function() {}, "steps": [function() {}], "annotationsOptions": {}}
- */
- labelAnnotation: {
- /** @ignore-option */
- className: 'highcharts-label-annotation',
- /** @ignore-option */
- start: function (e) {
- var coords = this.chart.pointer.getCoordinates(e),
- coordsX = this.utils.getAssignedAxis(coords.xAxis),
- coordsY = this.utils.getAssignedAxis(coords.yAxis),
- navigation = this.chart.options.navigation;
- // Exit if clicked out of axes area
- if (!coordsX || !coordsY) {
- return;
- }
- return this.chart.addAnnotation(merge({
- langKey: 'label',
- type: 'basicAnnotation',
- labelOptions: {
- format: '{y:.2f}'
- },
- labels: [{
- point: {
- xAxis: coordsX.axis.options.index,
- yAxis: coordsY.axis.options.index,
- x: coordsX.value,
- y: coordsY.value
- },
- overflow: 'none',
- crop: true
- }]
- }, navigation
- .annotationsOptions, navigation
- .bindings
- .labelAnnotation
- .annotationsOptions));
- }
- }
- },
- /**
- * Path where Highcharts will look for icons. Change this to use icons
- * from a different server.
- *
- * @type {string}
- * @default https://code.highcharts.com/9.1.1/gfx/stock-icons/
- * @since 7.1.3
- * @apioption navigation.iconsURL
- */
- /**
- * A `showPopup` event. Fired when selecting for example an annotation.
- *
- * @type {Function}
- * @apioption navigation.events.showPopup
- */
- /**
- * A `closePopup` event. Fired when Popup should be hidden, for example
- * when clicking on an annotation again.
- *
- * @type {Function}
- * @apioption navigation.events.closePopup
- */
- /**
- * Event fired on a button click.
- *
- * @type {Function}
- * @sample highcharts/annotations/gui/
- * Change icon in a dropddown on event
- * @sample highcharts/annotations/gui-buttons/
- * Change button class on event
- * @apioption navigation.events.selectButton
- */
- /**
- * Event fired when button state should change, for example after
- * adding an annotation.
- *
- * @type {Function}
- * @sample highcharts/annotations/gui/
- * Change icon in a dropddown on event
- * @sample highcharts/annotations/gui-buttons/
- * Change button class on event
- * @apioption navigation.events.deselectButton
- */
- /**
- * Events to communicate between Stock Tools and custom GUI.
- *
- * @since 7.0.0
- * @product highcharts highstock
- * @optionparent navigation.events
- */
- events: {},
- /**
- * Additional options to be merged into all annotations.
- *
- * @sample stock/stocktools/navigation-annotation-options
- * Set red color of all line annotations
- *
- * @type {Highcharts.AnnotationsOptions}
- * @extends annotations
- * @exclude crookedLine, elliottWave, fibonacci, infinityLine,
- * measure, pitchfork, tunnel, verticalLine, basicAnnotation
- * @apioption navigation.annotationsOptions
- */
- annotationsOptions: {
- animation: {
- defer: 0
- }
- }
- }
- });
- addEvent(Chart, 'render', function () {
- var chart = this,
- navigationBindings = chart.navigationBindings,
- disabledClassName = 'highcharts-disabled-btn';
- if (chart && navigationBindings) {
- // Check if the buttons should be enabled/disabled based on
- // visible series.
- var buttonsEnabled_1 = false;
- chart.series.forEach(function (series) {
- if (!series.options.isInternal && series.visible) {
- buttonsEnabled_1 = true;
- }
- });
- objectEach(navigationBindings.boundClassNames, function (value, key) {
- if (chart.navigationBindings &&
- chart.navigationBindings.container &&
- chart.navigationBindings.container[0]) {
- // Get the HTML element coresponding to the
- // className taken from StockToolsBindings.
- var buttonNode = chart.navigationBindings.container[0].querySelectorAll('.' + key);
- if (buttonNode) {
- if (value.noDataState === 'normal') {
- buttonNode.forEach(function (button) {
- // If button has noDataState: 'normal',
- // and has disabledClassName,
- // remove this className.
- if (button.className.indexOf(disabledClassName) !== -1) {
- button.classList.remove(disabledClassName);
- }
- });
- }
- else if (!buttonsEnabled_1) {
- buttonNode.forEach(function (button) {
- if (button.className.indexOf(disabledClassName) === -1) {
- button.className += ' ' + disabledClassName;
- }
- });
- }
- else {
- buttonNode.forEach(function (button) {
- // Enable all buttons by deleting the className.
- if (button.className.indexOf(disabledClassName) !== -1) {
- button.classList.remove(disabledClassName);
- }
- });
- }
- }
- }
- });
- }
- });
- addEvent(NavigationBindings, 'closePopup', function () {
- this.deselectAnnotation();
- });
- return NavigationBindings;
- });
- _registerModule(_modules, 'Extensions/Annotations/Popup.js', [_modules['Core/Globals.js'], _modules['Extensions/Annotations/NavigationBindings.js'], _modules['Core/DefaultOptions.js'], _modules['Core/Pointer.js'], _modules['Core/Utilities.js']], function (H, NavigationBindings, D, Pointer, U) {
- /* *
- *
- * Popup generator for Stock tools
- *
- * (c) 2009-2021 Sebastian Bochan
- *
- * License: www.highcharts.com/license
- *
- * !!!!!!! SOURCE GETS TRANSPILED BY TYPESCRIPT. EDIT TS FILE ONLY. !!!!!!!
- *
- * */
- var doc = H.doc,
- isFirefox = H.isFirefox;
- var getOptions = D.getOptions;
- var addEvent = U.addEvent,
- createElement = U.createElement,
- defined = U.defined,
- fireEvent = U.fireEvent,
- isArray = U.isArray,
- isObject = U.isObject,
- isString = U.isString,
- objectEach = U.objectEach,
- pick = U.pick,
- stableSort = U.stableSort,
- wrap = U.wrap;
- var indexFilter = /\d/g, PREFIX = 'highcharts-', DIV = 'div', INPUT = 'input', LABEL = 'label', BUTTON = 'button', SELECT = 'select', OPTION = 'option', SPAN = 'span', UL = 'ul', LI = 'li', H3 = 'h3';
- /* eslint-disable no-invalid-this, valid-jsdoc */
- // onContainerMouseDown blocks internal popup events, due to e.preventDefault.
- // Related issue #4606
- wrap(Pointer.prototype, 'onContainerMouseDown', function (proceed, e) {
- var popupClass = e.target && e.target.className;
- // elements is not in popup
- if (!(isString(popupClass) &&
- popupClass.indexOf(PREFIX + 'popup-field') >= 0)) {
- proceed.apply(this, Array.prototype.slice.call(arguments, 1));
- }
- });
- H.Popup = function (parentDiv, iconsURL, chart) {
- this.init(parentDiv, iconsURL, chart);
- };
- H.Popup.prototype = {
- /**
- * Initialize the popup. Create base div and add close button.
- * @private
- * @param {Highcharts.HTMLDOMElement} parentDiv
- * Container where popup should be placed
- * @param {string} iconsURL
- * Icon URL
- */
- init: function (parentDiv, iconsURL, chart) {
- this.chart = chart;
- // create popup div
- this.container = createElement(DIV, {
- className: PREFIX + 'popup highcharts-no-tooltip'
- }, null, parentDiv);
- this.lang = this.getLangpack();
- this.iconsURL = iconsURL;
- // add close button
- this.addCloseBtn();
- },
- /**
- * Create HTML element and attach click event (close popup).
- * @private
- */
- addCloseBtn: function () {
- var _self = this,
- closeBtn;
- var iconsURL = this.iconsURL;
- // create close popup btn
- closeBtn = createElement(DIV, {
- className: PREFIX + 'popup-close'
- }, null, this.container);
- closeBtn.style['background-image'] = 'url(' +
- (iconsURL.match(/png|svg|jpeg|jpg|gif/ig) ?
- iconsURL : iconsURL + 'close.svg') + ')';
- ['click', 'touchstart'].forEach(function (eventName) {
- addEvent(closeBtn, eventName, function () {
- if (_self.chart) {
- fireEvent(_self.chart.navigationBindings, 'closePopup');
- }
- else {
- _self.closePopup();
- }
- });
- });
- },
- /**
- * Create two columns (divs) in HTML.
- * @private
- * @param {Highcharts.HTMLDOMElement} container
- * Container of columns
- * @return {Highcharts.Dictionary<Highcharts.HTMLDOMElement>}
- * Reference to two HTML columns (lhsCol, rhsCol)
- */
- addColsContainer: function (container) {
- var rhsCol,
- lhsCol;
- // left column
- lhsCol = createElement(DIV, {
- className: PREFIX + 'popup-lhs-col'
- }, null, container);
- // right column
- rhsCol = createElement(DIV, {
- className: PREFIX + 'popup-rhs-col'
- }, null, container);
- // wrapper content
- createElement(DIV, {
- className: PREFIX + 'popup-rhs-col-wrapper'
- }, null, rhsCol);
- return {
- lhsCol: lhsCol,
- rhsCol: rhsCol
- };
- },
- /**
- * Create input with label.
- * @private
- * @param {string} option
- * Chain of fields i.e params.styles.fontSize
- * @param {string} type
- * Indicator type
- * @param {Highhcharts.HTMLDOMElement}
- * Container where elements should be added
- * @param {string} value
- * Default value of input i.e period value is 14, extracted from
- * defaultOptions (ADD mode) or series options (EDIT mode)
- */
- addInput: function (option, type, parentDiv, value) {
- var optionParamList = option.split('.'), optionName = optionParamList[optionParamList.length - 1], lang = this.lang, inputName = PREFIX + type + '-' + optionName;
- if (!inputName.match(indexFilter)) {
- // add label
- createElement(LABEL, {
- htmlFor: inputName
- }, void 0, parentDiv).appendChild(doc.createTextNode(lang[optionName] || optionName));
- }
- // add input
- createElement(INPUT, {
- name: inputName,
- value: value[0],
- type: value[1],
- className: PREFIX + 'popup-field'
- }, void 0, parentDiv).setAttribute(PREFIX + 'data-name', option);
- },
- /**
- * Create button.
- * @private
- * @param {Highcharts.HTMLDOMElement} parentDiv
- * Container where elements should be added
- * @param {string} label
- * Text placed as button label
- * @param {string} type
- * add | edit | remove
- * @param {Function} callback
- * On click callback
- * @param {Highcharts.HTMLDOMElement} fieldsDiv
- * Container where inputs are generated
- * @return {Highcharts.HTMLDOMElement}
- * HTML button
- */
- addButton: function (parentDiv, label, type, callback, fieldsDiv) {
- var _self = this,
- closePopup = this.closePopup,
- getFields = this.getFields,
- button;
- button = createElement(BUTTON, void 0, void 0, parentDiv);
- button.appendChild(doc.createTextNode(label));
- ['click', 'touchstart'].forEach(function (eventName) {
- addEvent(button, eventName, function () {
- closePopup.call(_self);
- return callback(getFields(fieldsDiv, type));
- });
- });
- return button;
- },
- /**
- * Get values from all inputs and create JSON.
- * @private
- * @param {Highcharts.HTMLDOMElement} - container where inputs are created
- * @param {string} - add | edit | remove
- * @return {Highcharts.PopupFieldsObject} - fields
- */
- getFields: function (parentDiv, type) {
- var inputList = parentDiv.querySelectorAll('input'), optionSeries = '#' + PREFIX + 'select-series > option:checked', optionVolume = '#' + PREFIX + 'select-volume > option:checked', linkedTo = parentDiv.querySelectorAll(optionSeries)[0], volumeTo = parentDiv.querySelectorAll(optionVolume)[0], seriesId, param, fieldsOutput;
- fieldsOutput = {
- actionType: type,
- linkedTo: linkedTo && linkedTo.getAttribute('value'),
- fields: {}
- };
- [].forEach.call(inputList, function (input) {
- param = input.getAttribute(PREFIX + 'data-name');
- seriesId = input.getAttribute(PREFIX + 'data-series-id');
- // params
- if (seriesId) {
- fieldsOutput.seriesId = input.value;
- }
- else if (param) {
- fieldsOutput.fields[param] = input.value;
- }
- else {
- // type like sma / ema
- fieldsOutput.type = input.value;
- }
- });
- if (volumeTo) {
- fieldsOutput.fields['params.volumeSeriesID'] = volumeTo.getAttribute('value');
- }
- return fieldsOutput;
- },
- /**
- * Reset content of the current popup and show.
- * @private
- */
- showPopup: function () {
- var popupDiv = this.container,
- toolbarClass = PREFIX + 'annotation-toolbar',
- popupCloseBtn = popupDiv
- .querySelectorAll('.' + PREFIX + 'popup-close')[0];
- // reset content
- popupDiv.innerHTML = '';
- // reset toolbar styles if exists
- if (popupDiv.className.indexOf(toolbarClass) >= 0) {
- popupDiv.classList.remove(toolbarClass);
- // reset toolbar inline styles
- popupDiv.removeAttribute('style');
- }
- // add close button
- popupDiv.appendChild(popupCloseBtn);
- popupDiv.style.display = 'block';
- },
- /**
- * Hide popup.
- * @private
- */
- closePopup: function () {
- var container = pick(this.popup && this.popup.container,
- this.container);
- container.style.display = 'none';
- },
- /**
- * Create content and show popup.
- * @private
- * @param {string} - type of popup i.e indicators
- * @param {Highcharts.Chart} - chart
- * @param {Highcharts.AnnotationsOptions} - options
- * @param {Function} - on click callback
- */
- showForm: function (type, chart, options, callback) {
- if (!chart) {
- return;
- }
- this.popup = chart.navigationBindings.popup;
- // show blank popup
- this.showPopup();
- // indicator form
- if (type === 'indicators') {
- this.indicators.addForm.call(this, chart, options, callback);
- }
- // annotation small toolbar
- if (type === 'annotation-toolbar') {
- this.annotations.addToolbar.call(this, chart, options, callback);
- }
- // annotation edit form
- if (type === 'annotation-edit') {
- this.annotations.addForm.call(this, chart, options, callback);
- }
- // flags form - add / edit
- if (type === 'flag') {
- this.annotations.addForm.call(this, chart, options, callback, true);
- }
- },
- /**
- * Return lang definitions for popup.
- * @private
- * @return {Highcharts.Dictionary<string>} - elements translations.
- */
- getLangpack: function () {
- return getOptions().lang.navigation.popup;
- },
- annotations: {
- /**
- * Create annotation simple form. It contains two buttons
- * (edit / remove) and text label.
- * @private
- * @param {Highcharts.Chart} - chart
- * @param {Highcharts.AnnotationsOptions} - options
- * @param {Function} - on click callback
- */
- addToolbar: function (chart, options, callback) {
- var _self = this,
- lang = this.lang,
- popupDiv = this.popup.container,
- showForm = this.showForm,
- toolbarClass = PREFIX + 'annotation-toolbar',
- button;
- // set small size
- if (popupDiv.className.indexOf(toolbarClass) === -1) {
- popupDiv.className += ' ' + toolbarClass;
- }
- // set position
- if (chart) {
- popupDiv.style.top = chart.plotTop + 10 + 'px';
- }
- // create label
- createElement(SPAN, void 0, void 0, popupDiv).appendChild(doc.createTextNode(pick(
- // Advanced annotations:
- lang[options.langKey] || options.langKey,
- // Basic shapes:
- options.shapes && options.shapes[0].type)));
- // add buttons
- button = this.addButton(popupDiv, lang.removeButton || 'remove', 'remove', callback, popupDiv);
- button.className += ' ' + PREFIX + 'annotation-remove-button';
- button.style['background-image'] = 'url(' +
- this.iconsURL + 'destroy.svg)';
- button = this.addButton(popupDiv, lang.editButton || 'edit', 'edit', function () {
- showForm.call(_self, 'annotation-edit', chart, options, callback);
- }, popupDiv);
- button.className += ' ' + PREFIX + 'annotation-edit-button';
- button.style['background-image'] = 'url(' +
- this.iconsURL + 'edit.svg)';
- },
- /**
- * Create annotation simple form.
- * It contains fields with param names.
- * @private
- * @param {Highcharts.Chart} chart
- * Chart
- * @param {Object} options
- * Options
- * @param {Function} callback
- * On click callback
- * @param {boolean} [isInit]
- * If it is a form declared for init annotation
- */
- addForm: function (chart, options, callback, isInit) {
- var popupDiv = this.popup.container,
- lang = this.lang,
- bottomRow,
- lhsCol;
- if (!chart) {
- return;
- }
- // create title of annotations
- lhsCol = createElement('h2', {
- className: PREFIX + 'popup-main-title'
- }, void 0, popupDiv);
- lhsCol.appendChild(doc.createTextNode(lang[options.langKey] || options.langKey || ''));
- // left column
- lhsCol = createElement(DIV, {
- className: PREFIX + 'popup-lhs-col ' + PREFIX + 'popup-lhs-full'
- }, null, popupDiv);
- bottomRow = createElement(DIV, {
- className: PREFIX + 'popup-bottom-row'
- }, null, popupDiv);
- this.annotations.addFormFields.call(this, lhsCol, chart, '', options, [], true);
- this.addButton(bottomRow, isInit ?
- (lang.addButton || 'add') :
- (lang.saveButton || 'save'), isInit ? 'add' : 'save', callback, popupDiv);
- },
- /**
- * Create annotation's form fields.
- * @private
- * @param {Highcharts.HTMLDOMElement} parentDiv
- * Div where inputs are placed
- * @param {Highcharts.Chart} chart
- * Chart
- * @param {string} parentNode
- * Name of parent to create chain of names
- * @param {Highcharts.AnnotationsOptions} options
- * Options
- * @param {Array<unknown>} storage
- * Array where all items are stored
- * @param {boolean} [isRoot]
- * Recursive flag for root
- */
- addFormFields: function (parentDiv, chart, parentNode, options, storage, isRoot) {
- var _self = this,
- addFormFields = this.annotations.addFormFields,
- addInput = this.addInput,
- lang = this.lang,
- parentFullName,
- titleName;
- if (!chart) {
- return;
- }
- objectEach(options, function (value, option) {
- // create name like params.styles.fontSize
- parentFullName = parentNode !== '' ?
- parentNode + '.' + option : option;
- if (isObject(value)) {
- if (
- // value is object of options
- !isArray(value) ||
- // array of objects with params. i.e labels in Fibonacci
- (isArray(value) && isObject(value[0]))) {
- titleName = lang[option] || option;
- if (!titleName.match(indexFilter)) {
- storage.push([
- true,
- titleName,
- parentDiv
- ]);
- }
- addFormFields.call(_self, parentDiv, chart, parentFullName, value, storage, false);
- }
- else {
- storage.push([
- _self,
- parentFullName,
- 'annotation',
- parentDiv,
- value
- ]);
- }
- }
- });
- if (isRoot) {
- stableSort(storage, function (a) {
- return a[1].match(/format/g) ? -1 : 1;
- });
- if (isFirefox) {
- storage.reverse(); // (#14691)
- }
- storage.forEach(function (genInput) {
- if (genInput[0] === true) {
- createElement(SPAN, {
- className: PREFIX + 'annotation-title'
- }, void 0, genInput[2]).appendChild(doc.createTextNode(genInput[1]));
- }
- else {
- addInput.apply(genInput[0], genInput.splice(1));
- }
- });
- }
- }
- },
- indicators: {
- /**
- * Create indicator's form. It contains two tabs (ADD and EDIT) with
- * content.
- * @private
- */
- addForm: function (chart, _options, callback) {
- var tabsContainers,
- indicators = this.indicators,
- lang = this.lang,
- buttonParentDiv;
- if (!chart) {
- return;
- }
- // add tabs
- this.tabs.init.call(this, chart);
- // get all tabs content divs
- tabsContainers = this.popup.container
- .querySelectorAll('.' + PREFIX + 'tab-item-content');
- // ADD tab
- this.addColsContainer(tabsContainers[0]);
- indicators.addIndicatorList.call(this, chart, tabsContainers[0], 'add');
- buttonParentDiv = tabsContainers[0]
- .querySelectorAll('.' + PREFIX + 'popup-rhs-col')[0];
- this.addButton(buttonParentDiv, lang.addButton || 'add', 'add', callback, buttonParentDiv);
- // EDIT tab
- this.addColsContainer(tabsContainers[1]);
- indicators.addIndicatorList.call(this, chart, tabsContainers[1], 'edit');
- buttonParentDiv = tabsContainers[1]
- .querySelectorAll('.' + PREFIX + 'popup-rhs-col')[0];
- this.addButton(buttonParentDiv, lang.saveButton || 'save', 'edit', callback, buttonParentDiv);
- this.addButton(buttonParentDiv, lang.removeButton || 'remove', 'remove', callback, buttonParentDiv);
- },
- /**
- * Create HTML list of all indicators (ADD mode) or added indicators
- * (EDIT mode).
- * @private
- */
- addIndicatorList: function (chart, parentDiv, listType) {
- var _self = this, lhsCol = parentDiv.querySelectorAll('.' + PREFIX + 'popup-lhs-col')[0], rhsCol = parentDiv.querySelectorAll('.' + PREFIX + 'popup-rhs-col')[0], isEdit = listType === 'edit', series = (isEdit ?
- chart.series : // EDIT mode
- chart.options.plotOptions // ADD mode
- ), addFormFields = this.indicators.addFormFields, rhsColWrapper, indicatorList, item;
- if (!chart) {
- return;
- }
- // create wrapper for list
- indicatorList = createElement(UL, {
- className: PREFIX + 'indicator-list'
- }, null, lhsCol);
- rhsColWrapper = rhsCol
- .querySelectorAll('.' + PREFIX + 'popup-rhs-col-wrapper')[0];
- objectEach(series, function (serie, value) {
- var seriesOptions = serie.options;
- if (serie.params ||
- seriesOptions && seriesOptions.params) {
- var indicatorNameType_1 = _self.indicators.getNameType(serie,
- value),
- indicatorType_1 = indicatorNameType_1.type;
- item = createElement(LI, {
- className: PREFIX + 'indicator-list'
- }, void 0, indicatorList);
- item.appendChild(doc.createTextNode(indicatorNameType_1.name));
- ['click', 'touchstart'].forEach(function (eventName) {
- addEvent(item, eventName, function () {
- addFormFields.call(_self, chart, isEdit ? serie : series[indicatorType_1], indicatorNameType_1.type, rhsColWrapper);
- // add hidden input with series.id
- if (isEdit && serie.options) {
- createElement(INPUT, {
- type: 'hidden',
- name: PREFIX + 'id-' + indicatorType_1,
- value: serie.options.id
- }, null, rhsColWrapper)
- .setAttribute(PREFIX + 'data-series-id', serie.options.id);
- }
- });
- });
- }
- });
- // select first item from the list
- if (indicatorList.childNodes.length > 0) {
- indicatorList.childNodes[0].click();
- }
- },
- /**
- * Extract full name and type of requested indicator.
- * @private
- * @param {Highcharts.Series} series
- * Series which name is needed. (EDIT mode - defaultOptions.series, ADD
- * mode - indicator series).
- * @param {string} - indicator type like: sma, ema, etc.
- * @return {Object} - series name and type like: sma, ema, etc.
- */
- getNameType: function (series, type) {
- var options = series.options,
- seriesTypes = H.seriesTypes,
- // add mode
- seriesName = seriesTypes[type] &&
- seriesTypes[type].prototype.nameBase || type.toUpperCase(),
- seriesType = type;
- // edit
- if (options && options.type) {
- seriesType = series.options.type;
- seriesName = series.name;
- }
- return {
- name: seriesName,
- type: seriesType
- };
- },
- /**
- * List all series with unique ID. Its mandatory for indicators to set
- * correct linking.
- * @private
- * @param {string} type
- * Indicator type like: sma, ema, etc.
- * @param {string} optionName
- * Type of select i.e series or volume.
- * @param {Highcharts.Chart} chart
- * Chart
- * @param {Highcharts.HTMLDOMElement} parentDiv
- * Element where created HTML list is added
- * @param {string} selectedOption
- * optional param for default value in dropdown
- */
- listAllSeries: function (type, optionName, chart, parentDiv, selectedOption) {
- var selectName = PREFIX + optionName + '-type-' + type,
- lang = this.lang,
- selectBox,
- seriesOptions;
- if (!chart) {
- return;
- }
- createElement(LABEL, {
- htmlFor: selectName
- }, null, parentDiv).appendChild(doc.createTextNode(lang[optionName] || optionName));
- // select type
- selectBox = createElement(SELECT, {
- name: selectName,
- className: PREFIX + 'popup-field'
- }, null, parentDiv);
- selectBox.setAttribute('id', PREFIX + 'select-' + optionName);
- // list all series which have id - mandatory for creating indicator
- chart.series.forEach(function (serie) {
- seriesOptions = serie.options;
- if (!seriesOptions.params &&
- seriesOptions.id &&
- seriesOptions.id !== PREFIX + 'navigator-series') {
- createElement(OPTION, {
- value: seriesOptions.id
- }, null, selectBox).appendChild(doc.createTextNode(seriesOptions.name || seriesOptions.id));
- }
- });
- if (defined(selectedOption)) {
- selectBox.value = selectedOption;
- }
- },
- /**
- * Create typical inputs for chosen indicator. Fields are extracted from
- * defaultOptions (ADD mode) or current indicator (ADD mode). Two extra
- * fields are added:
- * - hidden input - contains indicator type (required for callback)
- * - select - list of series which can be linked with indicator
- * @private
- * @param {Highcharts.Chart} chart
- * Chart
- * @param {Highcharts.Series} series
- * Indicator
- * @param {string} seriesType
- * Indicator type like: sma, ema, etc.
- * @param {Highcharts.HTMLDOMElement} rhsColWrapper
- * Element where created HTML list is added
- */
- addFormFields: function (chart, series, seriesType, rhsColWrapper) {
- var fields = series.params || series.options.params,
- getNameType = this.indicators.getNameType;
- // reset current content
- rhsColWrapper.innerHTML = '';
- // create title (indicator name in the right column)
- createElement(H3, {
- className: PREFIX + 'indicator-title'
- }, void 0, rhsColWrapper).appendChild(doc.createTextNode(getNameType(series, seriesType).name));
- // input type
- createElement(INPUT, {
- type: 'hidden',
- name: PREFIX + 'type-' + seriesType,
- value: seriesType
- }, null, rhsColWrapper);
- // list all series with id
- this.indicators.listAllSeries.call(this, seriesType, 'series', chart, rhsColWrapper, series.linkedParent && fields.volumeSeriesID);
- if (fields.volumeSeriesID) {
- this.indicators.listAllSeries.call(this, seriesType, 'volume', chart, rhsColWrapper, series.linkedParent && series.linkedParent.options.id);
- }
- // add param fields
- this.indicators.addParamInputs.call(this, chart, 'params', fields, seriesType, rhsColWrapper);
- },
- /**
- * Recurent function which lists all fields, from params object and
- * create them as inputs. Each input has unique `data-name` attribute,
- * which keeps chain of fields i.e params.styles.fontSize.
- * @private
- * @param {Highcharts.Chart} chart
- * Chart
- * @param {string} parentNode
- * Name of parent to create chain of names
- * @param {Highcharts.PopupFieldsDictionary<string>} fields
- * Params which are based for input create
- * @param {string} type
- * Indicator type like: sma, ema, etc.
- * @param {Highcharts.HTMLDOMElement} parentDiv
- * Element where created HTML list is added
- */
- addParamInputs: function (chart, parentNode, fields, type, parentDiv) {
- var _self = this,
- addParamInputs = this.indicators.addParamInputs,
- addInput = this.addInput,
- parentFullName;
- if (!chart) {
- return;
- }
- objectEach(fields, function (value, fieldName) {
- // create name like params.styles.fontSize
- parentFullName = parentNode + '.' + fieldName;
- if (value !== void 0) { // skip if field is unnecessary, #15362
- if (isObject(value)) {
- addParamInputs.call(_self, chart, parentFullName, value, type, parentDiv);
- }
- else if (
- // skip volume field which is created by addFormFields
- parentFullName !== 'params.volumeSeriesID') {
- addInput.call(_self, parentFullName, type, parentDiv, [value, 'text'] // all inputs are text type
- );
- }
- }
- });
- },
- /**
- * Get amount of indicators added to chart.
- * @private
- * @return {number} - Amount of indicators
- */
- getAmount: function () {
- var series = this.series,
- counter = 0;
- series.forEach(function (serie) {
- var seriesOptions = serie.options;
- if (serie.params ||
- seriesOptions && seriesOptions.params) {
- counter++;
- }
- });
- return counter;
- }
- },
- tabs: {
- /**
- * Init tabs. Create tab menu items, tabs containers
- * @private
- * @param {Highcharts.Chart} chart
- * Reference to current chart
- */
- init: function (chart) {
- var tabs = this.tabs,
- indicatorsCount = this.indicators.getAmount.call(chart),
- firstTab; // run by default
- if (!chart) {
- return;
- }
- // create menu items
- firstTab = tabs.addMenuItem.call(this, 'add');
- tabs.addMenuItem.call(this, 'edit', indicatorsCount);
- // create tabs containers
- tabs.addContentItem.call(this, 'add');
- tabs.addContentItem.call(this, 'edit');
- tabs.switchTabs.call(this, indicatorsCount);
- // activate first tab
- tabs.selectTab.call(this, firstTab, 0);
- },
- /**
- * Create tab menu item
- * @private
- * @param {string} tabName
- * `add` or `edit`
- * @param {number} [disableTab]
- * Disable tab when 0
- * @return {Highcharts.HTMLDOMElement}
- * Created HTML tab-menu element
- */
- addMenuItem: function (tabName, disableTab) {
- var popupDiv = this.popup.container,
- className = PREFIX + 'tab-item',
- lang = this.lang,
- menuItem;
- if (disableTab === 0) {
- className += ' ' + PREFIX + 'tab-disabled';
- }
- // tab 1
- menuItem = createElement(SPAN, {
- className: className
- }, void 0, popupDiv);
- menuItem.appendChild(doc.createTextNode(lang[tabName + 'Button'] || tabName));
- menuItem.setAttribute(PREFIX + 'data-tab-type', tabName);
- return menuItem;
- },
- /**
- * Create tab content
- * @private
- * @return {HTMLDOMElement} - created HTML tab-content element
- */
- addContentItem: function () {
- var popupDiv = this.popup.container;
- return createElement(DIV, {
- className: PREFIX + 'tab-item-content ' + PREFIX + 'no-mousewheel' // #12100
- }, null, popupDiv);
- },
- /**
- * Add click event to each tab
- * @private
- * @param {number} disableTab
- * Disable tab when 0
- */
- switchTabs: function (disableTab) {
- var _self = this,
- popupDiv = this.popup.container,
- tabs = popupDiv.querySelectorAll('.' + PREFIX + 'tab-item'),
- dataParam;
- tabs.forEach(function (tab, i) {
- dataParam = tab.getAttribute(PREFIX + 'data-tab-type');
- if (dataParam === 'edit' && disableTab === 0) {
- return;
- }
- ['click', 'touchstart'].forEach(function (eventName) {
- addEvent(tab, eventName, function () {
- // reset class on other elements
- _self.tabs.deselectAll.call(_self);
- _self.tabs.selectTab.call(_self, this, i);
- });
- });
- });
- },
- /**
- * Set tab as visible
- * @private
- * @param {globals.Element} - current tab
- * @param {number} - Index of tab in menu
- */
- selectTab: function (tab, index) {
- var allTabs = this.popup.container
- .querySelectorAll('.' + PREFIX + 'tab-item-content');
- tab.className += ' ' + PREFIX + 'tab-item-active';
- allTabs[index].className += ' ' + PREFIX + 'tab-item-show';
- },
- /**
- * Set all tabs as invisible.
- * @private
- */
- deselectAll: function () {
- var popupDiv = this.popup.container,
- tabs = popupDiv
- .querySelectorAll('.' + PREFIX + 'tab-item'),
- tabsContent = popupDiv
- .querySelectorAll('.' + PREFIX + 'tab-item-content'),
- i;
- for (i = 0; i < tabs.length; i++) {
- tabs[i].classList.remove(PREFIX + 'tab-item-active');
- tabsContent[i].classList.remove(PREFIX + 'tab-item-show');
- }
- }
- }
- };
- addEvent(NavigationBindings, 'showPopup', function (config) {
- if (!this.popup) {
- // Add popup to main container
- this.popup = new H.Popup(this.chart.container, (this.chart.options.navigation.iconsURL ||
- (this.chart.options.stockTools &&
- this.chart.options.stockTools.gui.iconsURL) ||
- 'https://code.highcharts.com/9.1.1/gfx/stock-icons/'), this.chart);
- }
- this.popup.showForm(config.formType, this.chart, config.options, config.onSubmit);
- });
- addEvent(NavigationBindings, 'closePopup', function () {
- if (this.popup) {
- this.popup.closePopup();
- }
- });
- return H.Popup;
- });
- _registerModule(_modules, 'masters/modules/annotations.src.js', [], function () {
- });
- }));
|